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 (*phy_enable)(struct b53_device *dev, int port); 49 void (*phy_disable)(struct b53_device *dev, int port); 50 void (*phylink_get_caps)(struct b53_device *dev, int port, 51 struct phylink_config *config); 52 struct phylink_pcs *(*phylink_mac_select_pcs)(struct b53_device *dev, 53 int port, 54 phy_interface_t interface); 55 u8 (*serdes_map_lane)(struct b53_device *dev, int port); 56 void (*serdes_link_set)(struct b53_device *dev, int port, 57 unsigned int mode, phy_interface_t interface, 58 bool link_up); 59 }; 60 61 struct b53_arl_entry; 62 63 struct b53_arl_ops { 64 void (*arl_read_entry)(struct b53_device *dev, 65 struct b53_arl_entry *ent, u8 idx); 66 void (*arl_write_entry)(struct b53_device *dev, 67 const struct b53_arl_entry *ent, u8 idx); 68 void (*arl_search_read)(struct b53_device *dev, u8 idx, 69 struct b53_arl_entry *ent); 70 }; 71 72 #define B53_INVALID_LANE 0xff 73 74 enum { 75 BCM4908_DEVICE_ID = 0x4908, 76 BCM5325_DEVICE_ID = 0x25, 77 BCM5365_DEVICE_ID = 0x65, 78 BCM5389_DEVICE_ID = 0x89, 79 BCM5395_DEVICE_ID = 0x95, 80 BCM5397_DEVICE_ID = 0x97, 81 BCM5398_DEVICE_ID = 0x98, 82 BCM53101_DEVICE_ID = 0x53101, 83 BCM53115_DEVICE_ID = 0x53115, 84 BCM53125_DEVICE_ID = 0x53125, 85 BCM53128_DEVICE_ID = 0x53128, 86 BCM63XX_DEVICE_ID = 0x6300, 87 BCM6318_DEVICE_ID = 0x6318, 88 BCM6328_DEVICE_ID = 0x6328, 89 BCM6362_DEVICE_ID = 0x6362, 90 BCM6368_DEVICE_ID = 0x6368, 91 BCM63268_DEVICE_ID = 0x63268, 92 BCM53010_DEVICE_ID = 0x53010, 93 BCM53011_DEVICE_ID = 0x53011, 94 BCM53012_DEVICE_ID = 0x53012, 95 BCM53018_DEVICE_ID = 0x53018, 96 BCM53019_DEVICE_ID = 0x53019, 97 BCM58XX_DEVICE_ID = 0x5800, 98 BCM583XX_DEVICE_ID = 0x58300, 99 BCM7445_DEVICE_ID = 0x7445, 100 BCM7278_DEVICE_ID = 0x7278, 101 BCM53134_DEVICE_ID = 0x5075, 102 }; 103 104 enum b53_variant_id { 105 B53_VARIANT_NONE = 0, 106 B53_VARIANT_5325E, 107 B53_VARIANT_5325M, 108 }; 109 110 struct b53_pcs { 111 struct phylink_pcs pcs; 112 struct b53_device *dev; 113 u8 lane; 114 }; 115 116 #define B53_N_PORTS 9 117 #define B53_N_PORTS_25 6 118 #define B53_N_PCS 2 119 120 struct b53_port { 121 u16 vlan_ctl_mask; 122 u16 pvid; 123 struct ethtool_keee eee; 124 }; 125 126 struct b53_vlan { 127 u16 members; 128 u16 untag; 129 bool valid; 130 }; 131 132 struct b53_device { 133 struct dsa_switch *ds; 134 struct b53_platform_data *pdata; 135 const char *name; 136 137 struct mutex reg_mutex; 138 struct mutex stats_mutex; 139 struct mutex arl_mutex; 140 const struct b53_io_ops *ops; 141 const struct b53_arl_ops *arl_ops; 142 143 /* chip specific data */ 144 u32 chip_id; 145 enum b53_variant_id variant_id; 146 u8 core_rev; 147 u8 vta_regs[3]; 148 u8 duplex_reg; 149 u8 jumbo_pm_reg; 150 u8 jumbo_size_reg; 151 int reset_gpio; 152 u8 num_arl_bins; 153 u16 num_arl_buckets; 154 enum dsa_tag_protocol tag_protocol; 155 156 /* used ports mask */ 157 u16 enabled_ports; 158 unsigned int imp_port; 159 160 /* connect specific data */ 161 u8 current_page; 162 struct device *dev; 163 u8 serdes_lane; 164 165 /* Master MDIO bus we got probed from */ 166 struct mii_bus *bus; 167 168 void *priv; 169 170 /* run time configuration */ 171 bool enable_jumbo; 172 173 unsigned int num_vlans; 174 struct b53_vlan *vlans; 175 bool vlan_enabled; 176 bool vlan_filtering; 177 unsigned int num_ports; 178 struct b53_port *ports; 179 180 struct b53_pcs pcs[B53_N_PCS]; 181 }; 182 183 #define b53_for_each_port(dev, i) \ 184 for (i = 0; i < B53_N_PORTS; i++) \ 185 if (dev->enabled_ports & BIT(i)) 186 187 188 static inline int is5325(struct b53_device *dev) 189 { 190 return dev->chip_id == BCM5325_DEVICE_ID; 191 } 192 193 static inline int is5325e(struct b53_device *dev) 194 { 195 return is5325(dev) && 196 dev->variant_id == B53_VARIANT_5325E; 197 } 198 199 static inline int is5325m(struct b53_device *dev) 200 { 201 return is5325(dev) && 202 dev->variant_id == B53_VARIANT_5325M; 203 } 204 205 static inline int is5365(struct b53_device *dev) 206 { 207 #ifdef CONFIG_BCM47XX 208 return dev->chip_id == BCM5365_DEVICE_ID; 209 #else 210 return 0; 211 #endif 212 } 213 214 static inline int is5397_98(struct b53_device *dev) 215 { 216 return dev->chip_id == BCM5397_DEVICE_ID || 217 dev->chip_id == BCM5398_DEVICE_ID; 218 } 219 220 static inline int is539x(struct b53_device *dev) 221 { 222 return dev->chip_id == BCM5395_DEVICE_ID || 223 dev->chip_id == BCM5397_DEVICE_ID || 224 dev->chip_id == BCM5398_DEVICE_ID; 225 } 226 227 static inline int is531x5(struct b53_device *dev) 228 { 229 return dev->chip_id == BCM53115_DEVICE_ID || 230 dev->chip_id == BCM53125_DEVICE_ID || 231 dev->chip_id == BCM53101_DEVICE_ID || 232 dev->chip_id == BCM53128_DEVICE_ID || 233 dev->chip_id == BCM53134_DEVICE_ID; 234 } 235 236 static inline int is63xx(struct b53_device *dev) 237 { 238 return dev->chip_id == BCM63XX_DEVICE_ID || 239 dev->chip_id == BCM6318_DEVICE_ID || 240 dev->chip_id == BCM6328_DEVICE_ID || 241 dev->chip_id == BCM6362_DEVICE_ID || 242 dev->chip_id == BCM6368_DEVICE_ID || 243 dev->chip_id == BCM63268_DEVICE_ID; 244 } 245 246 static inline int is6318_268(struct b53_device *dev) 247 { 248 return dev->chip_id == BCM6318_DEVICE_ID || 249 dev->chip_id == BCM63268_DEVICE_ID; 250 } 251 252 static inline int is5301x(struct b53_device *dev) 253 { 254 return dev->chip_id == BCM53010_DEVICE_ID || 255 dev->chip_id == BCM53011_DEVICE_ID || 256 dev->chip_id == BCM53012_DEVICE_ID || 257 dev->chip_id == BCM53018_DEVICE_ID || 258 dev->chip_id == BCM53019_DEVICE_ID; 259 } 260 261 static inline int is58xx(struct b53_device *dev) 262 { 263 return dev->chip_id == BCM58XX_DEVICE_ID || 264 dev->chip_id == BCM583XX_DEVICE_ID || 265 dev->chip_id == BCM7445_DEVICE_ID || 266 dev->chip_id == BCM7278_DEVICE_ID || 267 dev->chip_id == BCM53134_DEVICE_ID; 268 } 269 270 #define B53_63XX_RGMII0 4 271 #define B53_CPU_PORT_25 5 272 #define B53_CPU_PORT 8 273 274 static inline unsigned int b53_max_arl_entries(struct b53_device *dev) 275 { 276 return dev->num_arl_buckets * dev->num_arl_bins; 277 } 278 279 struct b53_device *b53_switch_alloc(struct device *base, 280 const struct b53_io_ops *ops, 281 void *priv); 282 283 int b53_switch_detect(struct b53_device *dev); 284 285 int b53_switch_register(struct b53_device *dev); 286 287 static inline void b53_switch_remove(struct b53_device *dev) 288 { 289 dsa_unregister_switch(dev->ds); 290 } 291 292 static inline void b53_switch_shutdown(struct b53_device *dev) 293 { 294 dsa_switch_shutdown(dev->ds); 295 } 296 297 #define b53_build_op(type_op_size, val_type) \ 298 static inline int b53_##type_op_size(struct b53_device *dev, u8 page, \ 299 u8 reg, val_type val) \ 300 { \ 301 int ret; \ 302 \ 303 mutex_lock(&dev->reg_mutex); \ 304 ret = dev->ops->type_op_size(dev, page, reg, val); \ 305 mutex_unlock(&dev->reg_mutex); \ 306 \ 307 return ret; \ 308 } 309 310 b53_build_op(read8, u8 *); 311 b53_build_op(read16, u16 *); 312 b53_build_op(read32, u32 *); 313 b53_build_op(read48, u64 *); 314 b53_build_op(read64, u64 *); 315 316 b53_build_op(write8, u8); 317 b53_build_op(write16, u16); 318 b53_build_op(write32, u32); 319 b53_build_op(write48, u64); 320 b53_build_op(write64, u64); 321 322 struct b53_arl_entry { 323 u16 port; 324 u8 mac[ETH_ALEN]; 325 u16 vid; 326 u8 is_valid:1; 327 u8 is_age:1; 328 u8 is_static:1; 329 }; 330 331 static inline void b53_arl_to_entry(struct b53_arl_entry *ent, 332 u64 mac_vid, u32 fwd_entry) 333 { 334 memset(ent, 0, sizeof(*ent)); 335 ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK; 336 ent->is_valid = !!(fwd_entry & ARLTBL_VALID); 337 ent->is_age = !!(fwd_entry & ARLTBL_AGE); 338 ent->is_static = !!(fwd_entry & ARLTBL_STATIC); 339 u64_to_ether_addr(mac_vid, ent->mac); 340 ent->vid = mac_vid >> ARLTBL_VID_S; 341 } 342 343 static inline void b53_arl_to_entry_25(struct b53_arl_entry *ent, 344 u64 mac_vid, u8 vid_entry) 345 { 346 memset(ent, 0, sizeof(*ent)); 347 ent->is_valid = !!(mac_vid & ARLTBL_VALID_25); 348 ent->is_age = !!(mac_vid & ARLTBL_AGE_25); 349 ent->is_static = !!(mac_vid & ARLTBL_STATIC_25); 350 u64_to_ether_addr(mac_vid, ent->mac); 351 ent->port = (mac_vid & ARLTBL_DATA_PORT_ID_MASK_25) >> 352 ARLTBL_DATA_PORT_ID_S_25; 353 if (is_unicast_ether_addr(ent->mac) && ent->port == B53_CPU_PORT) 354 ent->port = B53_CPU_PORT_25; 355 ent->vid = vid_entry; 356 } 357 358 static inline void b53_arl_to_entry_89(struct b53_arl_entry *ent, 359 u64 mac_vid, u16 fwd_entry) 360 { 361 memset(ent, 0, sizeof(*ent)); 362 ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK_89; 363 ent->is_valid = !!(fwd_entry & ARLTBL_VALID_89); 364 ent->is_age = !!(fwd_entry & ARLTBL_AGE_89); 365 ent->is_static = !!(fwd_entry & ARLTBL_STATIC_89); 366 u64_to_ether_addr(mac_vid, ent->mac); 367 ent->vid = mac_vid >> ARLTBL_VID_S; 368 } 369 370 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry, 371 const struct b53_arl_entry *ent) 372 { 373 *mac_vid = ether_addr_to_u64(ent->mac); 374 *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S; 375 *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK; 376 if (ent->is_valid) 377 *fwd_entry |= ARLTBL_VALID; 378 if (ent->is_static) 379 *fwd_entry |= ARLTBL_STATIC; 380 if (ent->is_age) 381 *fwd_entry |= ARLTBL_AGE; 382 } 383 384 static inline void b53_arl_from_entry_25(u64 *mac_vid, u8 *vid_entry, 385 const struct b53_arl_entry *ent) 386 { 387 *mac_vid = ether_addr_to_u64(ent->mac); 388 if (is_unicast_ether_addr(ent->mac) && ent->port == B53_CPU_PORT_25) 389 *mac_vid |= (u64)B53_CPU_PORT << ARLTBL_DATA_PORT_ID_S_25; 390 else 391 *mac_vid |= ((u64)ent->port << ARLTBL_DATA_PORT_ID_S_25) & 392 ARLTBL_DATA_PORT_ID_MASK_25; 393 if (ent->is_valid) 394 *mac_vid |= ARLTBL_VALID_25; 395 if (ent->is_static) 396 *mac_vid |= ARLTBL_STATIC_25; 397 if (ent->is_age) 398 *mac_vid |= ARLTBL_AGE_25; 399 *vid_entry = ent->vid; 400 } 401 402 static inline void b53_arl_from_entry_89(u64 *mac_vid, u32 *fwd_entry, 403 const struct b53_arl_entry *ent) 404 { 405 *mac_vid = ether_addr_to_u64(ent->mac); 406 *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S; 407 *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK_89; 408 if (ent->is_valid) 409 *fwd_entry |= ARLTBL_VALID_89; 410 if (ent->is_static) 411 *fwd_entry |= ARLTBL_STATIC_89; 412 if (ent->is_age) 413 *fwd_entry |= ARLTBL_AGE_89; 414 } 415 416 static inline void b53_arl_search_to_entry_25(struct b53_arl_entry *ent, 417 u64 mac_vid, u8 ext) 418 { 419 memset(ent, 0, sizeof(*ent)); 420 ent->is_valid = !!(mac_vid & ARLTBL_VALID_25); 421 ent->is_age = !!(mac_vid & ARLTBL_AGE_25); 422 ent->is_static = !!(mac_vid & ARLTBL_STATIC_25); 423 u64_to_ether_addr(mac_vid, ent->mac); 424 ent->vid = (mac_vid & ARL_SRCH_RSLT_VID_MASK_25) >> 425 ARL_SRCH_RSLT_VID_S_25; 426 ent->port = (mac_vid & ARL_SRCH_RSLT_PORT_ID_MASK_25) >> 427 ARL_SRCH_RSLT_PORT_ID_S_25; 428 if (is_multicast_ether_addr(ent->mac) && (ext & ARL_SRCH_RSLT_EXT_MC_MII)) 429 ent->port |= BIT(B53_CPU_PORT_25); 430 else if (!is_multicast_ether_addr(ent->mac) && ent->port == B53_CPU_PORT) 431 ent->port = B53_CPU_PORT_25; 432 } 433 434 static inline void b53_arl_search_to_entry_63xx(struct b53_arl_entry *ent, 435 u64 mac_vid, u16 fwd_entry) 436 { 437 memset(ent, 0, sizeof(*ent)); 438 u64_to_ether_addr(mac_vid, ent->mac); 439 ent->vid = mac_vid >> ARLTBL_VID_S; 440 441 ent->port = fwd_entry & ARL_SRST_PORT_ID_MASK_63XX; 442 ent->port >>= 1; 443 444 ent->is_age = !!(fwd_entry & ARL_SRST_AGE_63XX); 445 ent->is_static = !!(fwd_entry & ARL_SRST_STATIC_63XX); 446 ent->is_valid = 1; 447 } 448 449 static inline void b53_arl_read_entry(struct b53_device *dev, 450 struct b53_arl_entry *ent, u8 idx) 451 { 452 dev->arl_ops->arl_read_entry(dev, ent, idx); 453 } 454 455 static inline void b53_arl_write_entry(struct b53_device *dev, 456 const struct b53_arl_entry *ent, u8 idx) 457 { 458 dev->arl_ops->arl_write_entry(dev, ent, idx); 459 } 460 461 static inline void b53_arl_search_read(struct b53_device *dev, u8 idx, 462 struct b53_arl_entry *ent) 463 { 464 dev->arl_ops->arl_search_read(dev, idx, ent); 465 } 466 467 #ifdef CONFIG_BCM47XX 468 469 #include <linux/bcm47xx_nvram.h> 470 #include <bcm47xx_board.h> 471 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 472 { 473 enum bcm47xx_board board = bcm47xx_board_get(); 474 475 switch (board) { 476 case BCM47XX_BOARD_LINKSYS_WRT300NV11: 477 case BCM47XX_BOARD_LINKSYS_WRT310NV1: 478 return 8; 479 default: 480 return bcm47xx_nvram_gpio_pin("robo_reset"); 481 } 482 } 483 #else 484 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 485 { 486 return -ENOENT; 487 } 488 #endif 489 490 /* Exported functions towards other drivers */ 491 void b53_imp_vlan_setup(struct dsa_switch *ds, int cpu_port); 492 int b53_configure_vlan(struct dsa_switch *ds); 493 void b53_get_strings(struct dsa_switch *ds, int port, u32 stringset, 494 uint8_t *data); 495 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data); 496 int b53_get_sset_count(struct dsa_switch *ds, int port, int sset); 497 void b53_get_ethtool_phy_stats(struct dsa_switch *ds, int port, uint64_t *data); 498 int b53_set_ageing_time(struct dsa_switch *ds, unsigned int msecs); 499 int b53_br_join(struct dsa_switch *ds, int port, struct dsa_bridge bridge, 500 bool *tx_fwd_offload, struct netlink_ext_ack *extack); 501 void b53_br_leave(struct dsa_switch *ds, int port, struct dsa_bridge bridge); 502 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state); 503 void b53_br_fast_age(struct dsa_switch *ds, int port); 504 int b53_br_flags_pre(struct dsa_switch *ds, int port, 505 struct switchdev_brport_flags flags, 506 struct netlink_ext_ack *extack); 507 int b53_br_flags(struct dsa_switch *ds, int port, 508 struct switchdev_brport_flags flags, 509 struct netlink_ext_ack *extack); 510 int b53_setup_devlink_resources(struct dsa_switch *ds); 511 void b53_port_event(struct dsa_switch *ds, int port); 512 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering, 513 struct netlink_ext_ack *extack); 514 int b53_vlan_add(struct dsa_switch *ds, int port, 515 const struct switchdev_obj_port_vlan *vlan, 516 struct netlink_ext_ack *extack); 517 int b53_vlan_del(struct dsa_switch *ds, int port, 518 const struct switchdev_obj_port_vlan *vlan); 519 int b53_fdb_add(struct dsa_switch *ds, int port, 520 const unsigned char *addr, u16 vid, 521 struct dsa_db db); 522 int b53_fdb_del(struct dsa_switch *ds, int port, 523 const unsigned char *addr, u16 vid, 524 struct dsa_db db); 525 int b53_fdb_dump(struct dsa_switch *ds, int port, 526 dsa_fdb_dump_cb_t *cb, void *data); 527 int b53_mdb_add(struct dsa_switch *ds, int port, 528 const struct switchdev_obj_port_mdb *mdb, 529 struct dsa_db db); 530 int b53_mdb_del(struct dsa_switch *ds, int port, 531 const struct switchdev_obj_port_mdb *mdb, 532 struct dsa_db db); 533 int b53_mirror_add(struct dsa_switch *ds, int port, 534 struct dsa_mall_mirror_tc_entry *mirror, bool ingress, 535 struct netlink_ext_ack *extack); 536 enum dsa_tag_protocol b53_get_tag_protocol(struct dsa_switch *ds, int port, 537 enum dsa_tag_protocol mprot); 538 void b53_mirror_del(struct dsa_switch *ds, int port, 539 struct dsa_mall_mirror_tc_entry *mirror); 540 int b53_setup_port(struct dsa_switch *ds, int port); 541 int b53_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy); 542 void b53_disable_port(struct dsa_switch *ds, int port); 543 void b53_brcm_hdr_setup(struct dsa_switch *ds, int port); 544 int b53_eee_init(struct dsa_switch *ds, int port, struct phy_device *phy); 545 bool b53_support_eee(struct dsa_switch *ds, int port); 546 int b53_set_mac_eee(struct dsa_switch *ds, int port, struct ethtool_keee *e); 547 548 #endif 549