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 cpu_port; 127 128 /* connect specific data */ 129 u8 current_page; 130 struct device *dev; 131 u8 serdes_lane; 132 133 /* Master MDIO bus we got probed from */ 134 struct mii_bus *bus; 135 136 void *priv; 137 138 /* run time configuration */ 139 bool enable_jumbo; 140 141 unsigned int num_vlans; 142 struct b53_vlan *vlans; 143 bool vlan_enabled; 144 unsigned int num_ports; 145 struct b53_port *ports; 146 }; 147 148 #define b53_for_each_port(dev, i) \ 149 for (i = 0; i < B53_N_PORTS; i++) \ 150 if (dev->enabled_ports & BIT(i)) 151 152 153 static inline int is5325(struct b53_device *dev) 154 { 155 return dev->chip_id == BCM5325_DEVICE_ID; 156 } 157 158 static inline int is5365(struct b53_device *dev) 159 { 160 #ifdef CONFIG_BCM47XX 161 return dev->chip_id == BCM5365_DEVICE_ID; 162 #else 163 return 0; 164 #endif 165 } 166 167 static inline int is5397_98(struct b53_device *dev) 168 { 169 return dev->chip_id == BCM5397_DEVICE_ID || 170 dev->chip_id == BCM5398_DEVICE_ID; 171 } 172 173 static inline int is539x(struct b53_device *dev) 174 { 175 return dev->chip_id == BCM5395_DEVICE_ID || 176 dev->chip_id == BCM5397_DEVICE_ID || 177 dev->chip_id == BCM5398_DEVICE_ID; 178 } 179 180 static inline int is531x5(struct b53_device *dev) 181 { 182 return dev->chip_id == BCM53115_DEVICE_ID || 183 dev->chip_id == BCM53125_DEVICE_ID || 184 dev->chip_id == BCM53128_DEVICE_ID; 185 } 186 187 static inline int is63xx(struct b53_device *dev) 188 { 189 #ifdef CONFIG_BCM63XX 190 return dev->chip_id == BCM63XX_DEVICE_ID; 191 #else 192 return 0; 193 #endif 194 } 195 196 static inline int is5301x(struct b53_device *dev) 197 { 198 return dev->chip_id == BCM53010_DEVICE_ID || 199 dev->chip_id == BCM53011_DEVICE_ID || 200 dev->chip_id == BCM53012_DEVICE_ID || 201 dev->chip_id == BCM53018_DEVICE_ID || 202 dev->chip_id == BCM53019_DEVICE_ID; 203 } 204 205 static inline int is58xx(struct b53_device *dev) 206 { 207 return dev->chip_id == BCM58XX_DEVICE_ID || 208 dev->chip_id == BCM583XX_DEVICE_ID || 209 dev->chip_id == BCM7445_DEVICE_ID || 210 dev->chip_id == BCM7278_DEVICE_ID; 211 } 212 213 #define B53_CPU_PORT_25 5 214 #define B53_CPU_PORT 8 215 216 static inline unsigned int b53_max_arl_entries(struct b53_device *dev) 217 { 218 return dev->num_arl_buckets * dev->num_arl_bins; 219 } 220 221 struct b53_device *b53_switch_alloc(struct device *base, 222 const struct b53_io_ops *ops, 223 void *priv); 224 225 int b53_switch_detect(struct b53_device *dev); 226 227 int b53_switch_register(struct b53_device *dev); 228 229 static inline void b53_switch_remove(struct b53_device *dev) 230 { 231 dsa_unregister_switch(dev->ds); 232 } 233 234 #define b53_build_op(type_op_size, val_type) \ 235 static inline int b53_##type_op_size(struct b53_device *dev, u8 page, \ 236 u8 reg, val_type val) \ 237 { \ 238 int ret; \ 239 \ 240 mutex_lock(&dev->reg_mutex); \ 241 ret = dev->ops->type_op_size(dev, page, reg, val); \ 242 mutex_unlock(&dev->reg_mutex); \ 243 \ 244 return ret; \ 245 } 246 247 b53_build_op(read8, u8 *); 248 b53_build_op(read16, u16 *); 249 b53_build_op(read32, u32 *); 250 b53_build_op(read48, u64 *); 251 b53_build_op(read64, u64 *); 252 253 b53_build_op(write8, u8); 254 b53_build_op(write16, u16); 255 b53_build_op(write32, u32); 256 b53_build_op(write48, u64); 257 b53_build_op(write64, u64); 258 259 struct b53_arl_entry { 260 u16 port; 261 u8 mac[ETH_ALEN]; 262 u16 vid; 263 u8 is_valid:1; 264 u8 is_age:1; 265 u8 is_static:1; 266 }; 267 268 static inline void b53_arl_to_entry(struct b53_arl_entry *ent, 269 u64 mac_vid, u32 fwd_entry) 270 { 271 memset(ent, 0, sizeof(*ent)); 272 ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK; 273 ent->is_valid = !!(fwd_entry & ARLTBL_VALID); 274 ent->is_age = !!(fwd_entry & ARLTBL_AGE); 275 ent->is_static = !!(fwd_entry & ARLTBL_STATIC); 276 u64_to_ether_addr(mac_vid, ent->mac); 277 ent->vid = mac_vid >> ARLTBL_VID_S; 278 } 279 280 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry, 281 const struct b53_arl_entry *ent) 282 { 283 *mac_vid = ether_addr_to_u64(ent->mac); 284 *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S; 285 *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK; 286 if (ent->is_valid) 287 *fwd_entry |= ARLTBL_VALID; 288 if (ent->is_static) 289 *fwd_entry |= ARLTBL_STATIC; 290 if (ent->is_age) 291 *fwd_entry |= ARLTBL_AGE; 292 } 293 294 #ifdef CONFIG_BCM47XX 295 296 #include <linux/bcm47xx_nvram.h> 297 #include <bcm47xx_board.h> 298 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 299 { 300 enum bcm47xx_board board = bcm47xx_board_get(); 301 302 switch (board) { 303 case BCM47XX_BOARD_LINKSYS_WRT300NV11: 304 case BCM47XX_BOARD_LINKSYS_WRT310NV1: 305 return 8; 306 default: 307 return bcm47xx_nvram_gpio_pin("robo_reset"); 308 } 309 } 310 #else 311 static inline int b53_switch_get_reset_gpio(struct b53_device *dev) 312 { 313 return -ENOENT; 314 } 315 #endif 316 317 /* Exported functions towards other drivers */ 318 void b53_imp_vlan_setup(struct dsa_switch *ds, int cpu_port); 319 int b53_configure_vlan(struct dsa_switch *ds); 320 void b53_get_strings(struct dsa_switch *ds, int port, u32 stringset, 321 uint8_t *data); 322 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data); 323 int b53_get_sset_count(struct dsa_switch *ds, int port, int sset); 324 void b53_get_ethtool_phy_stats(struct dsa_switch *ds, int port, uint64_t *data); 325 int b53_br_join(struct dsa_switch *ds, int port, struct net_device *bridge); 326 void b53_br_leave(struct dsa_switch *ds, int port, struct net_device *bridge); 327 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state); 328 void b53_br_fast_age(struct dsa_switch *ds, int port); 329 int b53_br_flags_pre(struct dsa_switch *ds, int port, 330 struct switchdev_brport_flags flags, 331 struct netlink_ext_ack *extack); 332 int b53_br_flags(struct dsa_switch *ds, int port, 333 struct switchdev_brport_flags flags, 334 struct netlink_ext_ack *extack); 335 int b53_set_mrouter(struct dsa_switch *ds, int port, bool mrouter, 336 struct netlink_ext_ack *extack); 337 int b53_setup_devlink_resources(struct dsa_switch *ds); 338 void b53_port_event(struct dsa_switch *ds, int port); 339 void b53_phylink_validate(struct dsa_switch *ds, int port, 340 unsigned long *supported, 341 struct phylink_link_state *state); 342 int b53_phylink_mac_link_state(struct dsa_switch *ds, int port, 343 struct phylink_link_state *state); 344 void b53_phylink_mac_config(struct dsa_switch *ds, int port, 345 unsigned int mode, 346 const struct phylink_link_state *state); 347 void b53_phylink_mac_an_restart(struct dsa_switch *ds, int port); 348 void b53_phylink_mac_link_down(struct dsa_switch *ds, int port, 349 unsigned int mode, 350 phy_interface_t interface); 351 void b53_phylink_mac_link_up(struct dsa_switch *ds, int port, 352 unsigned int mode, 353 phy_interface_t interface, 354 struct phy_device *phydev, 355 int speed, int duplex, 356 bool tx_pause, bool rx_pause); 357 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering, 358 struct netlink_ext_ack *extack); 359 int b53_vlan_add(struct dsa_switch *ds, int port, 360 const struct switchdev_obj_port_vlan *vlan, 361 struct netlink_ext_ack *extack); 362 int b53_vlan_del(struct dsa_switch *ds, int port, 363 const struct switchdev_obj_port_vlan *vlan); 364 int b53_fdb_add(struct dsa_switch *ds, int port, 365 const unsigned char *addr, u16 vid); 366 int b53_fdb_del(struct dsa_switch *ds, int port, 367 const unsigned char *addr, u16 vid); 368 int b53_fdb_dump(struct dsa_switch *ds, int port, 369 dsa_fdb_dump_cb_t *cb, void *data); 370 int b53_mdb_add(struct dsa_switch *ds, int port, 371 const struct switchdev_obj_port_mdb *mdb); 372 int b53_mdb_del(struct dsa_switch *ds, int port, 373 const struct switchdev_obj_port_mdb *mdb); 374 int b53_mirror_add(struct dsa_switch *ds, int port, 375 struct dsa_mall_mirror_tc_entry *mirror, bool ingress); 376 enum dsa_tag_protocol b53_get_tag_protocol(struct dsa_switch *ds, int port, 377 enum dsa_tag_protocol mprot); 378 void b53_mirror_del(struct dsa_switch *ds, int port, 379 struct dsa_mall_mirror_tc_entry *mirror); 380 int b53_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy); 381 void b53_disable_port(struct dsa_switch *ds, int port); 382 void b53_brcm_hdr_setup(struct dsa_switch *ds, int port); 383 void b53_eee_enable_set(struct dsa_switch *ds, int port, bool enable); 384 int b53_eee_init(struct dsa_switch *ds, int port, struct phy_device *phy); 385 int b53_get_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e); 386 int b53_set_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e); 387 388 #endif 389