1 /* 2 * B53 common definitions 3 * 4 * Copyright (C) 2011-2013 Jonas Gorski <jogo@openwrt.org> 5 * 6 * Permission to use, copy, modify, and/or distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #ifndef __B53_PRIV_H 20 #define __B53_PRIV_H 21 22 #include <linux/kernel.h> 23 #include <linux/mutex.h> 24 #include <linux/phylink.h> 25 #include <linux/etherdevice.h> 26 #include <net/dsa.h> 27 28 #include "b53_regs.h" 29 30 struct b53_device; 31 struct net_device; 32 33 struct b53_io_ops { 34 int (*read8)(struct b53_device *dev, u8 page, u8 reg, u8 *value); 35 int (*read16)(struct b53_device *dev, u8 page, u8 reg, u16 *value); 36 int (*read32)(struct b53_device *dev, u8 page, u8 reg, u32 *value); 37 int (*read48)(struct b53_device *dev, u8 page, u8 reg, u64 *value); 38 int (*read64)(struct b53_device *dev, u8 page, u8 reg, u64 *value); 39 int (*write8)(struct b53_device *dev, u8 page, u8 reg, u8 value); 40 int (*write16)(struct b53_device *dev, u8 page, u8 reg, u16 value); 41 int (*write32)(struct b53_device *dev, u8 page, u8 reg, u32 value); 42 int (*write48)(struct b53_device *dev, u8 page, u8 reg, u64 value); 43 int (*write64)(struct b53_device *dev, u8 page, u8 reg, u64 value); 44 int (*phy_read16)(struct b53_device *dev, int addr, int reg, u16 *value); 45 int (*phy_write16)(struct b53_device *dev, int addr, int reg, u16 value); 46 int (*irq_enable)(struct b53_device *dev, int port); 47 void (*irq_disable)(struct b53_device *dev, int port); 48 void (*phylink_get_caps)(struct b53_device *dev, int port, 49 struct phylink_config *config); 50 struct phylink_pcs *(*phylink_mac_select_pcs)(struct b53_device *dev, 51 int port, 52 phy_interface_t interface); 53 u8 (*serdes_map_lane)(struct b53_device *dev, int port); 54 void (*serdes_link_set)(struct b53_device *dev, int port, 55 unsigned int mode, phy_interface_t interface, 56 bool link_up); 57 }; 58 59 #define B53_INVALID_LANE 0xff 60 61 enum { 62 BCM4908_DEVICE_ID = 0x4908, 63 BCM5325_DEVICE_ID = 0x25, 64 BCM5365_DEVICE_ID = 0x65, 65 BCM5389_DEVICE_ID = 0x89, 66 BCM5395_DEVICE_ID = 0x95, 67 BCM5397_DEVICE_ID = 0x97, 68 BCM5398_DEVICE_ID = 0x98, 69 BCM53101_DEVICE_ID = 0x53101, 70 BCM53115_DEVICE_ID = 0x53115, 71 BCM53125_DEVICE_ID = 0x53125, 72 BCM53128_DEVICE_ID = 0x53128, 73 BCM63XX_DEVICE_ID = 0x6300, 74 BCM63268_DEVICE_ID = 0x63268, 75 BCM53010_DEVICE_ID = 0x53010, 76 BCM53011_DEVICE_ID = 0x53011, 77 BCM53012_DEVICE_ID = 0x53012, 78 BCM53018_DEVICE_ID = 0x53018, 79 BCM53019_DEVICE_ID = 0x53019, 80 BCM58XX_DEVICE_ID = 0x5800, 81 BCM583XX_DEVICE_ID = 0x58300, 82 BCM7445_DEVICE_ID = 0x7445, 83 BCM7278_DEVICE_ID = 0x7278, 84 BCM53134_DEVICE_ID = 0x5075, 85 }; 86 87 struct b53_pcs { 88 struct phylink_pcs pcs; 89 struct b53_device *dev; 90 u8 lane; 91 }; 92 93 #define B53_N_PORTS 9 94 #define B53_N_PORTS_25 6 95 #define B53_N_PCS 2 96 97 struct b53_port { 98 u16 vlan_ctl_mask; 99 u16 pvid; 100 struct ethtool_keee eee; 101 }; 102 103 struct b53_vlan { 104 u16 members; 105 u16 untag; 106 bool valid; 107 }; 108 109 struct b53_device { 110 struct dsa_switch *ds; 111 struct b53_platform_data *pdata; 112 const char *name; 113 114 struct mutex reg_mutex; 115 struct mutex stats_mutex; 116 struct mutex arl_mutex; 117 const struct b53_io_ops *ops; 118 119 /* chip specific data */ 120 u32 chip_id; 121 u8 core_rev; 122 u8 vta_regs[3]; 123 u8 duplex_reg; 124 u8 jumbo_pm_reg; 125 u8 jumbo_size_reg; 126 int reset_gpio; 127 u8 num_arl_bins; 128 u16 num_arl_buckets; 129 enum dsa_tag_protocol tag_protocol; 130 131 /* used ports mask */ 132 u16 enabled_ports; 133 unsigned int imp_port; 134 135 /* connect specific data */ 136 u8 current_page; 137 struct device *dev; 138 u8 serdes_lane; 139 140 /* Master MDIO bus we got probed from */ 141 struct mii_bus *bus; 142 143 void *priv; 144 145 /* run time configuration */ 146 bool enable_jumbo; 147 148 unsigned int num_vlans; 149 struct b53_vlan *vlans; 150 bool vlan_enabled; 151 bool vlan_filtering; 152 unsigned int num_ports; 153 struct b53_port *ports; 154 155 struct b53_pcs pcs[B53_N_PCS]; 156 }; 157 158 #define b53_for_each_port(dev, i) \ 159 for (i = 0; i < B53_N_PORTS; i++) \ 160 if (dev->enabled_ports & BIT(i)) 161 162 163 static inline int is5325(struct b53_device *dev) 164 { 165 return dev->chip_id == BCM5325_DEVICE_ID; 166 } 167 168 static inline int is5365(struct b53_device *dev) 169 { 170 #ifdef CONFIG_BCM47XX 171 return dev->chip_id == BCM5365_DEVICE_ID; 172 #else 173 return 0; 174 #endif 175 } 176 177 static inline int is5397_98(struct b53_device *dev) 178 { 179 return dev->chip_id == BCM5397_DEVICE_ID || 180 dev->chip_id == BCM5398_DEVICE_ID; 181 } 182 183 static inline int is539x(struct b53_device *dev) 184 { 185 return dev->chip_id == BCM5395_DEVICE_ID || 186 dev->chip_id == BCM5397_DEVICE_ID || 187 dev->chip_id == BCM5398_DEVICE_ID; 188 } 189 190 static inline int is531x5(struct b53_device *dev) 191 { 192 return dev->chip_id == BCM53115_DEVICE_ID || 193 dev->chip_id == BCM53125_DEVICE_ID || 194 dev->chip_id == BCM53101_DEVICE_ID || 195 dev->chip_id == BCM53128_DEVICE_ID || 196 dev->chip_id == BCM53134_DEVICE_ID; 197 } 198 199 static inline int is63xx(struct b53_device *dev) 200 { 201 return dev->chip_id == BCM63XX_DEVICE_ID || 202 dev->chip_id == BCM63268_DEVICE_ID; 203 } 204 205 static inline int is63268(struct b53_device *dev) 206 { 207 return dev->chip_id == BCM63268_DEVICE_ID; 208 } 209 210 static inline int is5301x(struct b53_device *dev) 211 { 212 return dev->chip_id == BCM53010_DEVICE_ID || 213 dev->chip_id == BCM53011_DEVICE_ID || 214 dev->chip_id == BCM53012_DEVICE_ID || 215 dev->chip_id == BCM53018_DEVICE_ID || 216 dev->chip_id == BCM53019_DEVICE_ID; 217 } 218 219 static inline int is58xx(struct b53_device *dev) 220 { 221 return dev->chip_id == BCM58XX_DEVICE_ID || 222 dev->chip_id == BCM583XX_DEVICE_ID || 223 dev->chip_id == BCM7445_DEVICE_ID || 224 dev->chip_id == BCM7278_DEVICE_ID || 225 dev->chip_id == BCM53134_DEVICE_ID; 226 } 227 228 #define B53_63XX_RGMII0 4 229 #define B53_CPU_PORT_25 5 230 #define B53_CPU_PORT 8 231 232 static inline unsigned int b53_max_arl_entries(struct b53_device *dev) 233 { 234 return dev->num_arl_buckets * dev->num_arl_bins; 235 } 236 237 struct b53_device *b53_switch_alloc(struct device *base, 238 const struct b53_io_ops *ops, 239 void *priv); 240 241 int b53_switch_detect(struct b53_device *dev); 242 243 int b53_switch_register(struct b53_device *dev); 244 245 static inline void b53_switch_remove(struct b53_device *dev) 246 { 247 dsa_unregister_switch(dev->ds); 248 } 249 250 static inline void b53_switch_shutdown(struct b53_device *dev) 251 { 252 dsa_switch_shutdown(dev->ds); 253 } 254 255 #define b53_build_op(type_op_size, val_type) \ 256 static inline int b53_##type_op_size(struct b53_device *dev, u8 page, \ 257 u8 reg, val_type val) \ 258 { \ 259 int ret; \ 260 \ 261 mutex_lock(&dev->reg_mutex); \ 262 ret = dev->ops->type_op_size(dev, page, reg, val); \ 263 mutex_unlock(&dev->reg_mutex); \ 264 \ 265 return ret; \ 266 } 267 268 b53_build_op(read8, u8 *); 269 b53_build_op(read16, u16 *); 270 b53_build_op(read32, u32 *); 271 b53_build_op(read48, u64 *); 272 b53_build_op(read64, u64 *); 273 274 b53_build_op(write8, u8); 275 b53_build_op(write16, u16); 276 b53_build_op(write32, u32); 277 b53_build_op(write48, u64); 278 b53_build_op(write64, u64); 279 280 struct b53_arl_entry { 281 u16 port; 282 u8 mac[ETH_ALEN]; 283 u16 vid; 284 u8 is_valid:1; 285 u8 is_age:1; 286 u8 is_static:1; 287 }; 288 289 static inline void b53_arl_to_entry(struct b53_arl_entry *ent, 290 u64 mac_vid, u32 fwd_entry) 291 { 292 memset(ent, 0, sizeof(*ent)); 293 ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK; 294 ent->is_valid = !!(fwd_entry & ARLTBL_VALID); 295 ent->is_age = !!(fwd_entry & ARLTBL_AGE); 296 ent->is_static = !!(fwd_entry & ARLTBL_STATIC); 297 u64_to_ether_addr(mac_vid, ent->mac); 298 ent->vid = mac_vid >> ARLTBL_VID_S; 299 } 300 301 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry, 302 const struct b53_arl_entry *ent) 303 { 304 *mac_vid = ether_addr_to_u64(ent->mac); 305 *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S; 306 *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK; 307 if (ent->is_valid) 308 *fwd_entry |= ARLTBL_VALID; 309 if (ent->is_static) 310 *fwd_entry |= ARLTBL_STATIC; 311 if (ent->is_age) 312 *fwd_entry |= ARLTBL_AGE; 313 } 314 315 #ifdef CONFIG_BCM47XX 316 317 #include <linux/bcm47xx_nvram.h> 318 #include <bcm47xx_board.h> 319 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 320 { 321 enum bcm47xx_board board = bcm47xx_board_get(); 322 323 switch (board) { 324 case BCM47XX_BOARD_LINKSYS_WRT300NV11: 325 case BCM47XX_BOARD_LINKSYS_WRT310NV1: 326 return 8; 327 default: 328 return bcm47xx_nvram_gpio_pin("robo_reset"); 329 } 330 } 331 #else 332 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 333 { 334 return -ENOENT; 335 } 336 #endif 337 338 /* Exported functions towards other drivers */ 339 void b53_imp_vlan_setup(struct dsa_switch *ds, int cpu_port); 340 int b53_configure_vlan(struct dsa_switch *ds); 341 void b53_get_strings(struct dsa_switch *ds, int port, u32 stringset, 342 uint8_t *data); 343 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data); 344 int b53_get_sset_count(struct dsa_switch *ds, int port, int sset); 345 void b53_get_ethtool_phy_stats(struct dsa_switch *ds, int port, uint64_t *data); 346 int b53_set_ageing_time(struct dsa_switch *ds, unsigned int msecs); 347 int b53_br_join(struct dsa_switch *ds, int port, struct dsa_bridge bridge, 348 bool *tx_fwd_offload, struct netlink_ext_ack *extack); 349 void b53_br_leave(struct dsa_switch *ds, int port, struct dsa_bridge bridge); 350 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state); 351 void b53_br_fast_age(struct dsa_switch *ds, int port); 352 int b53_br_flags_pre(struct dsa_switch *ds, int port, 353 struct switchdev_brport_flags flags, 354 struct netlink_ext_ack *extack); 355 int b53_br_flags(struct dsa_switch *ds, int port, 356 struct switchdev_brport_flags flags, 357 struct netlink_ext_ack *extack); 358 int b53_setup_devlink_resources(struct dsa_switch *ds); 359 void b53_port_event(struct dsa_switch *ds, int port); 360 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering, 361 struct netlink_ext_ack *extack); 362 int b53_vlan_add(struct dsa_switch *ds, int port, 363 const struct switchdev_obj_port_vlan *vlan, 364 struct netlink_ext_ack *extack); 365 int b53_vlan_del(struct dsa_switch *ds, int port, 366 const struct switchdev_obj_port_vlan *vlan); 367 int b53_fdb_add(struct dsa_switch *ds, int port, 368 const unsigned char *addr, u16 vid, 369 struct dsa_db db); 370 int b53_fdb_del(struct dsa_switch *ds, int port, 371 const unsigned char *addr, u16 vid, 372 struct dsa_db db); 373 int b53_fdb_dump(struct dsa_switch *ds, int port, 374 dsa_fdb_dump_cb_t *cb, void *data); 375 int b53_mdb_add(struct dsa_switch *ds, int port, 376 const struct switchdev_obj_port_mdb *mdb, 377 struct dsa_db db); 378 int b53_mdb_del(struct dsa_switch *ds, int port, 379 const struct switchdev_obj_port_mdb *mdb, 380 struct dsa_db db); 381 int b53_mirror_add(struct dsa_switch *ds, int port, 382 struct dsa_mall_mirror_tc_entry *mirror, bool ingress, 383 struct netlink_ext_ack *extack); 384 enum dsa_tag_protocol b53_get_tag_protocol(struct dsa_switch *ds, int port, 385 enum dsa_tag_protocol mprot); 386 void b53_mirror_del(struct dsa_switch *ds, int port, 387 struct dsa_mall_mirror_tc_entry *mirror); 388 int b53_setup_port(struct dsa_switch *ds, int port); 389 int b53_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy); 390 void b53_disable_port(struct dsa_switch *ds, int port); 391 void b53_brcm_hdr_setup(struct dsa_switch *ds, int port); 392 int b53_eee_init(struct dsa_switch *ds, int port, struct phy_device *phy); 393 bool b53_support_eee(struct dsa_switch *ds, int port); 394 int b53_set_mac_eee(struct dsa_switch *ds, int port, struct ethtool_keee *e); 395 396 #endif 397