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