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/phy.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 struct phylink_link_state; 33 34 struct b53_io_ops { 35 int (*read8)(struct b53_device *dev, u8 page, u8 reg, u8 *value); 36 int (*read16)(struct b53_device *dev, u8 page, u8 reg, u16 *value); 37 int (*read32)(struct b53_device *dev, u8 page, u8 reg, u32 *value); 38 int (*read48)(struct b53_device *dev, u8 page, u8 reg, u64 *value); 39 int (*read64)(struct b53_device *dev, u8 page, u8 reg, u64 *value); 40 int (*write8)(struct b53_device *dev, u8 page, u8 reg, u8 value); 41 int (*write16)(struct b53_device *dev, u8 page, u8 reg, u16 value); 42 int (*write32)(struct b53_device *dev, u8 page, u8 reg, u32 value); 43 int (*write48)(struct b53_device *dev, u8 page, u8 reg, u64 value); 44 int (*write64)(struct b53_device *dev, u8 page, u8 reg, u64 value); 45 int (*phy_read16)(struct b53_device *dev, int addr, int reg, u16 *value); 46 int (*phy_write16)(struct b53_device *dev, int addr, int reg, u16 value); 47 int (*irq_enable)(struct b53_device *dev, int port); 48 void (*irq_disable)(struct b53_device *dev, int port); 49 u8 (*serdes_map_lane)(struct b53_device *dev, int port); 50 int (*serdes_link_state)(struct b53_device *dev, int port, 51 struct phylink_link_state *state); 52 void (*serdes_config)(struct b53_device *dev, int port, 53 unsigned int mode, 54 const struct phylink_link_state *state); 55 void (*serdes_an_restart)(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 void (*serdes_phylink_validate)(struct b53_device *dev, int port, 60 unsigned long *supported, 61 struct phylink_link_state *state); 62 }; 63 64 #define B53_INVALID_LANE 0xff 65 66 enum { 67 BCM4908_DEVICE_ID = 0x4908, 68 BCM5325_DEVICE_ID = 0x25, 69 BCM5365_DEVICE_ID = 0x65, 70 BCM5389_DEVICE_ID = 0x89, 71 BCM5395_DEVICE_ID = 0x95, 72 BCM5397_DEVICE_ID = 0x97, 73 BCM5398_DEVICE_ID = 0x98, 74 BCM53115_DEVICE_ID = 0x53115, 75 BCM53125_DEVICE_ID = 0x53125, 76 BCM53128_DEVICE_ID = 0x53128, 77 BCM63XX_DEVICE_ID = 0x6300, 78 BCM53010_DEVICE_ID = 0x53010, 79 BCM53011_DEVICE_ID = 0x53011, 80 BCM53012_DEVICE_ID = 0x53012, 81 BCM53018_DEVICE_ID = 0x53018, 82 BCM53019_DEVICE_ID = 0x53019, 83 BCM58XX_DEVICE_ID = 0x5800, 84 BCM583XX_DEVICE_ID = 0x58300, 85 BCM7445_DEVICE_ID = 0x7445, 86 BCM7278_DEVICE_ID = 0x7278, 87 }; 88 89 #define B53_N_PORTS 9 90 #define B53_N_PORTS_25 6 91 92 struct b53_port { 93 u16 vlan_ctl_mask; 94 struct ethtool_eee eee; 95 }; 96 97 struct b53_vlan { 98 u16 members; 99 u16 untag; 100 bool valid; 101 }; 102 103 struct b53_device { 104 struct dsa_switch *ds; 105 struct b53_platform_data *pdata; 106 const char *name; 107 108 struct mutex reg_mutex; 109 struct mutex stats_mutex; 110 const struct b53_io_ops *ops; 111 112 /* chip specific data */ 113 u32 chip_id; 114 u8 core_rev; 115 u8 vta_regs[3]; 116 u8 duplex_reg; 117 u8 jumbo_pm_reg; 118 u8 jumbo_size_reg; 119 int reset_gpio; 120 u8 num_arl_bins; 121 u16 num_arl_buckets; 122 enum dsa_tag_protocol tag_protocol; 123 124 /* used ports mask */ 125 u16 enabled_ports; 126 unsigned int imp_port; 127 unsigned int cpu_port; 128 129 /* connect specific data */ 130 u8 current_page; 131 struct device *dev; 132 u8 serdes_lane; 133 134 /* Master MDIO bus we got probed from */ 135 struct mii_bus *bus; 136 137 void *priv; 138 139 /* run time configuration */ 140 bool enable_jumbo; 141 142 unsigned int num_vlans; 143 struct b53_vlan *vlans; 144 bool vlan_enabled; 145 unsigned int num_ports; 146 struct b53_port *ports; 147 }; 148 149 #define b53_for_each_port(dev, i) \ 150 for (i = 0; i < B53_N_PORTS; i++) \ 151 if (dev->enabled_ports & BIT(i)) 152 153 154 static inline int is5325(struct b53_device *dev) 155 { 156 return dev->chip_id == BCM5325_DEVICE_ID; 157 } 158 159 static inline int is5365(struct b53_device *dev) 160 { 161 #ifdef CONFIG_BCM47XX 162 return dev->chip_id == BCM5365_DEVICE_ID; 163 #else 164 return 0; 165 #endif 166 } 167 168 static inline int is5397_98(struct b53_device *dev) 169 { 170 return dev->chip_id == BCM5397_DEVICE_ID || 171 dev->chip_id == BCM5398_DEVICE_ID; 172 } 173 174 static inline int is539x(struct b53_device *dev) 175 { 176 return dev->chip_id == BCM5395_DEVICE_ID || 177 dev->chip_id == BCM5397_DEVICE_ID || 178 dev->chip_id == BCM5398_DEVICE_ID; 179 } 180 181 static inline int is531x5(struct b53_device *dev) 182 { 183 return dev->chip_id == BCM53115_DEVICE_ID || 184 dev->chip_id == BCM53125_DEVICE_ID || 185 dev->chip_id == BCM53128_DEVICE_ID; 186 } 187 188 static inline int is63xx(struct b53_device *dev) 189 { 190 return dev->chip_id == BCM63XX_DEVICE_ID; 191 } 192 193 static inline int is5301x(struct b53_device *dev) 194 { 195 return dev->chip_id == BCM53010_DEVICE_ID || 196 dev->chip_id == BCM53011_DEVICE_ID || 197 dev->chip_id == BCM53012_DEVICE_ID || 198 dev->chip_id == BCM53018_DEVICE_ID || 199 dev->chip_id == BCM53019_DEVICE_ID; 200 } 201 202 static inline int is58xx(struct b53_device *dev) 203 { 204 return dev->chip_id == BCM58XX_DEVICE_ID || 205 dev->chip_id == BCM583XX_DEVICE_ID || 206 dev->chip_id == BCM7445_DEVICE_ID || 207 dev->chip_id == BCM7278_DEVICE_ID; 208 } 209 210 #define B53_CPU_PORT_25 5 211 #define B53_CPU_PORT 8 212 213 static inline unsigned int b53_max_arl_entries(struct b53_device *dev) 214 { 215 return dev->num_arl_buckets * dev->num_arl_bins; 216 } 217 218 struct b53_device *b53_switch_alloc(struct device *base, 219 const struct b53_io_ops *ops, 220 void *priv); 221 222 int b53_switch_detect(struct b53_device *dev); 223 224 int b53_switch_register(struct b53_device *dev); 225 226 static inline void b53_switch_remove(struct b53_device *dev) 227 { 228 dsa_unregister_switch(dev->ds); 229 } 230 231 #define b53_build_op(type_op_size, val_type) \ 232 static inline int b53_##type_op_size(struct b53_device *dev, u8 page, \ 233 u8 reg, val_type val) \ 234 { \ 235 int ret; \ 236 \ 237 mutex_lock(&dev->reg_mutex); \ 238 ret = dev->ops->type_op_size(dev, page, reg, val); \ 239 mutex_unlock(&dev->reg_mutex); \ 240 \ 241 return ret; \ 242 } 243 244 b53_build_op(read8, u8 *); 245 b53_build_op(read16, u16 *); 246 b53_build_op(read32, u32 *); 247 b53_build_op(read48, u64 *); 248 b53_build_op(read64, u64 *); 249 250 b53_build_op(write8, u8); 251 b53_build_op(write16, u16); 252 b53_build_op(write32, u32); 253 b53_build_op(write48, u64); 254 b53_build_op(write64, u64); 255 256 struct b53_arl_entry { 257 u16 port; 258 u8 mac[ETH_ALEN]; 259 u16 vid; 260 u8 is_valid:1; 261 u8 is_age:1; 262 u8 is_static:1; 263 }; 264 265 static inline void b53_arl_to_entry(struct b53_arl_entry *ent, 266 u64 mac_vid, u32 fwd_entry) 267 { 268 memset(ent, 0, sizeof(*ent)); 269 ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK; 270 ent->is_valid = !!(fwd_entry & ARLTBL_VALID); 271 ent->is_age = !!(fwd_entry & ARLTBL_AGE); 272 ent->is_static = !!(fwd_entry & ARLTBL_STATIC); 273 u64_to_ether_addr(mac_vid, ent->mac); 274 ent->vid = mac_vid >> ARLTBL_VID_S; 275 } 276 277 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry, 278 const struct b53_arl_entry *ent) 279 { 280 *mac_vid = ether_addr_to_u64(ent->mac); 281 *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S; 282 *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK; 283 if (ent->is_valid) 284 *fwd_entry |= ARLTBL_VALID; 285 if (ent->is_static) 286 *fwd_entry |= ARLTBL_STATIC; 287 if (ent->is_age) 288 *fwd_entry |= ARLTBL_AGE; 289 } 290 291 #ifdef CONFIG_BCM47XX 292 293 #include <linux/bcm47xx_nvram.h> 294 #include <bcm47xx_board.h> 295 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 296 { 297 enum bcm47xx_board board = bcm47xx_board_get(); 298 299 switch (board) { 300 case BCM47XX_BOARD_LINKSYS_WRT300NV11: 301 case BCM47XX_BOARD_LINKSYS_WRT310NV1: 302 return 8; 303 default: 304 return bcm47xx_nvram_gpio_pin("robo_reset"); 305 } 306 } 307 #else 308 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 309 { 310 return -ENOENT; 311 } 312 #endif 313 314 /* Exported functions towards other drivers */ 315 void b53_imp_vlan_setup(struct dsa_switch *ds, int cpu_port); 316 int b53_configure_vlan(struct dsa_switch *ds); 317 void b53_get_strings(struct dsa_switch *ds, int port, u32 stringset, 318 uint8_t *data); 319 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data); 320 int b53_get_sset_count(struct dsa_switch *ds, int port, int sset); 321 void b53_get_ethtool_phy_stats(struct dsa_switch *ds, int port, uint64_t *data); 322 int b53_br_join(struct dsa_switch *ds, int port, struct net_device *bridge); 323 void b53_br_leave(struct dsa_switch *ds, int port, struct net_device *bridge); 324 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state); 325 void b53_br_fast_age(struct dsa_switch *ds, int port); 326 int b53_br_flags_pre(struct dsa_switch *ds, int port, 327 struct switchdev_brport_flags flags, 328 struct netlink_ext_ack *extack); 329 int b53_br_flags(struct dsa_switch *ds, int port, 330 struct switchdev_brport_flags flags, 331 struct netlink_ext_ack *extack); 332 int b53_setup_devlink_resources(struct dsa_switch *ds); 333 void b53_port_event(struct dsa_switch *ds, int port); 334 void b53_phylink_validate(struct dsa_switch *ds, int port, 335 unsigned long *supported, 336 struct phylink_link_state *state); 337 int b53_phylink_mac_link_state(struct dsa_switch *ds, int port, 338 struct phylink_link_state *state); 339 void b53_phylink_mac_config(struct dsa_switch *ds, int port, 340 unsigned int mode, 341 const struct phylink_link_state *state); 342 void b53_phylink_mac_an_restart(struct dsa_switch *ds, int port); 343 void b53_phylink_mac_link_down(struct dsa_switch *ds, int port, 344 unsigned int mode, 345 phy_interface_t interface); 346 void b53_phylink_mac_link_up(struct dsa_switch *ds, int port, 347 unsigned int mode, 348 phy_interface_t interface, 349 struct phy_device *phydev, 350 int speed, int duplex, 351 bool tx_pause, bool rx_pause); 352 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering, 353 struct netlink_ext_ack *extack); 354 int b53_vlan_add(struct dsa_switch *ds, int port, 355 const struct switchdev_obj_port_vlan *vlan, 356 struct netlink_ext_ack *extack); 357 int b53_vlan_del(struct dsa_switch *ds, int port, 358 const struct switchdev_obj_port_vlan *vlan); 359 int b53_fdb_add(struct dsa_switch *ds, int port, 360 const unsigned char *addr, u16 vid); 361 int b53_fdb_del(struct dsa_switch *ds, int port, 362 const unsigned char *addr, u16 vid); 363 int b53_fdb_dump(struct dsa_switch *ds, int port, 364 dsa_fdb_dump_cb_t *cb, void *data); 365 int b53_mdb_add(struct dsa_switch *ds, int port, 366 const struct switchdev_obj_port_mdb *mdb); 367 int b53_mdb_del(struct dsa_switch *ds, int port, 368 const struct switchdev_obj_port_mdb *mdb); 369 int b53_mirror_add(struct dsa_switch *ds, int port, 370 struct dsa_mall_mirror_tc_entry *mirror, bool ingress); 371 enum dsa_tag_protocol b53_get_tag_protocol(struct dsa_switch *ds, int port, 372 enum dsa_tag_protocol mprot); 373 void b53_mirror_del(struct dsa_switch *ds, int port, 374 struct dsa_mall_mirror_tc_entry *mirror); 375 int b53_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy); 376 void b53_disable_port(struct dsa_switch *ds, int port); 377 void b53_brcm_hdr_setup(struct dsa_switch *ds, int port); 378 void b53_eee_enable_set(struct dsa_switch *ds, int port, bool enable); 379 int b53_eee_init(struct dsa_switch *ds, int port, struct phy_device *phy); 380 int b53_get_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e); 381 int b53_set_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e); 382 383 #endif 384