2 * B53 common definitions
4 * Copyright (C) 2011-2013 Jonas Gorski <jogo@openwrt.org>
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.
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.
22 #include <linux/kernel.h>
23 #include <linux/mutex.h>
24 #include <linux/phy.h>
25 #include <linux/etherdevice.h>
32 struct phylink_link_state;
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,
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,
59 void (*serdes_phylink_validate)(struct b53_device *dev, int port,
60 unsigned long *supported,
61 struct phylink_link_state *state);
64 #define B53_INVALID_LANE 0xff
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,
90 #define B53_N_PORTS_25 6
94 struct ethtool_eee eee;
104 struct dsa_switch *ds;
105 struct b53_platform_data *pdata;
108 struct mutex reg_mutex;
109 struct mutex stats_mutex;
110 const struct b53_io_ops *ops;
112 /* chip specific data */
122 enum dsa_tag_protocol tag_protocol;
124 /* used ports mask */
126 unsigned int cpu_port;
128 /* connect specific data */
133 /* Master MDIO bus we got probed from */
138 /* run time configuration */
141 unsigned int num_vlans;
142 struct b53_vlan *vlans;
144 unsigned int num_ports;
145 struct b53_port *ports;
148 #define b53_for_each_port(dev, i) \
149 for (i = 0; i < B53_N_PORTS; i++) \
150 if (dev->enabled_ports & BIT(i))
153 static inline int is5325(struct b53_device *dev)
155 return dev->chip_id == BCM5325_DEVICE_ID;
158 static inline int is5365(struct b53_device *dev)
160 #ifdef CONFIG_BCM47XX
161 return dev->chip_id == BCM5365_DEVICE_ID;
167 static inline int is5397_98(struct b53_device *dev)
169 return dev->chip_id == BCM5397_DEVICE_ID ||
170 dev->chip_id == BCM5398_DEVICE_ID;
173 static inline int is539x(struct b53_device *dev)
175 return dev->chip_id == BCM5395_DEVICE_ID ||
176 dev->chip_id == BCM5397_DEVICE_ID ||
177 dev->chip_id == BCM5398_DEVICE_ID;
180 static inline int is531x5(struct b53_device *dev)
182 return dev->chip_id == BCM53115_DEVICE_ID ||
183 dev->chip_id == BCM53125_DEVICE_ID ||
184 dev->chip_id == BCM53128_DEVICE_ID;
187 static inline int is63xx(struct b53_device *dev)
189 return dev->chip_id == BCM63XX_DEVICE_ID;
192 static inline int is5301x(struct b53_device *dev)
194 return dev->chip_id == BCM53010_DEVICE_ID ||
195 dev->chip_id == BCM53011_DEVICE_ID ||
196 dev->chip_id == BCM53012_DEVICE_ID ||
197 dev->chip_id == BCM53018_DEVICE_ID ||
198 dev->chip_id == BCM53019_DEVICE_ID;
201 static inline int is58xx(struct b53_device *dev)
203 return dev->chip_id == BCM58XX_DEVICE_ID ||
204 dev->chip_id == BCM583XX_DEVICE_ID ||
205 dev->chip_id == BCM7445_DEVICE_ID ||
206 dev->chip_id == BCM7278_DEVICE_ID;
209 #define B53_CPU_PORT_25 5
210 #define B53_CPU_PORT 8
212 static inline unsigned int b53_max_arl_entries(struct b53_device *dev)
214 return dev->num_arl_buckets * dev->num_arl_bins;
217 struct b53_device *b53_switch_alloc(struct device *base,
218 const struct b53_io_ops *ops,
221 int b53_switch_detect(struct b53_device *dev);
223 int b53_switch_register(struct b53_device *dev);
225 static inline void b53_switch_remove(struct b53_device *dev)
227 dsa_unregister_switch(dev->ds);
230 #define b53_build_op(type_op_size, val_type) \
231 static inline int b53_##type_op_size(struct b53_device *dev, u8 page, \
232 u8 reg, val_type val) \
236 mutex_lock(&dev->reg_mutex); \
237 ret = dev->ops->type_op_size(dev, page, reg, val); \
238 mutex_unlock(&dev->reg_mutex); \
243 b53_build_op(read8, u8 *);
244 b53_build_op(read16, u16 *);
245 b53_build_op(read32, u32 *);
246 b53_build_op(read48, u64 *);
247 b53_build_op(read64, u64 *);
249 b53_build_op(write8, u8);
250 b53_build_op(write16, u16);
251 b53_build_op(write32, u32);
252 b53_build_op(write48, u64);
253 b53_build_op(write64, u64);
255 struct b53_arl_entry {
264 static inline void b53_arl_to_entry(struct b53_arl_entry *ent,
265 u64 mac_vid, u32 fwd_entry)
267 memset(ent, 0, sizeof(*ent));
268 ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK;
269 ent->is_valid = !!(fwd_entry & ARLTBL_VALID);
270 ent->is_age = !!(fwd_entry & ARLTBL_AGE);
271 ent->is_static = !!(fwd_entry & ARLTBL_STATIC);
272 u64_to_ether_addr(mac_vid, ent->mac);
273 ent->vid = mac_vid >> ARLTBL_VID_S;
276 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry,
277 const struct b53_arl_entry *ent)
279 *mac_vid = ether_addr_to_u64(ent->mac);
280 *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S;
281 *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK;
283 *fwd_entry |= ARLTBL_VALID;
285 *fwd_entry |= ARLTBL_STATIC;
287 *fwd_entry |= ARLTBL_AGE;
290 #ifdef CONFIG_BCM47XX
292 #include <linux/bcm47xx_nvram.h>
293 #include <bcm47xx_board.h>
294 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
296 enum bcm47xx_board board = bcm47xx_board_get();
299 case BCM47XX_BOARD_LINKSYS_WRT300NV11:
300 case BCM47XX_BOARD_LINKSYS_WRT310NV1:
303 return bcm47xx_nvram_gpio_pin("robo_reset");
307 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
313 /* Exported functions towards other drivers */
314 void b53_imp_vlan_setup(struct dsa_switch *ds, int cpu_port);
315 int b53_configure_vlan(struct dsa_switch *ds);
316 void b53_get_strings(struct dsa_switch *ds, int port, u32 stringset,
318 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data);
319 int b53_get_sset_count(struct dsa_switch *ds, int port, int sset);
320 void b53_get_ethtool_phy_stats(struct dsa_switch *ds, int port, uint64_t *data);
321 int b53_br_join(struct dsa_switch *ds, int port, struct net_device *bridge);
322 void b53_br_leave(struct dsa_switch *ds, int port, struct net_device *bridge);
323 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state);
324 void b53_br_fast_age(struct dsa_switch *ds, int port);
325 int b53_br_flags_pre(struct dsa_switch *ds, int port,
326 struct switchdev_brport_flags flags,
327 struct netlink_ext_ack *extack);
328 int b53_br_flags(struct dsa_switch *ds, int port,
329 struct switchdev_brport_flags flags,
330 struct netlink_ext_ack *extack);
331 int b53_set_mrouter(struct dsa_switch *ds, int port, bool mrouter,
332 struct netlink_ext_ack *extack);
333 int b53_setup_devlink_resources(struct dsa_switch *ds);
334 void b53_port_event(struct dsa_switch *ds, int port);
335 void b53_phylink_validate(struct dsa_switch *ds, int port,
336 unsigned long *supported,
337 struct phylink_link_state *state);
338 int b53_phylink_mac_link_state(struct dsa_switch *ds, int port,
339 struct phylink_link_state *state);
340 void b53_phylink_mac_config(struct dsa_switch *ds, int port,
342 const struct phylink_link_state *state);
343 void b53_phylink_mac_an_restart(struct dsa_switch *ds, int port);
344 void b53_phylink_mac_link_down(struct dsa_switch *ds, int port,
346 phy_interface_t interface);
347 void b53_phylink_mac_link_up(struct dsa_switch *ds, int port,
349 phy_interface_t interface,
350 struct phy_device *phydev,
351 int speed, int duplex,
352 bool tx_pause, bool rx_pause);
353 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering,
354 struct netlink_ext_ack *extack);
355 int b53_vlan_add(struct dsa_switch *ds, int port,
356 const struct switchdev_obj_port_vlan *vlan,
357 struct netlink_ext_ack *extack);
358 int b53_vlan_del(struct dsa_switch *ds, int port,
359 const struct switchdev_obj_port_vlan *vlan);
360 int b53_fdb_add(struct dsa_switch *ds, int port,
361 const unsigned char *addr, u16 vid);
362 int b53_fdb_del(struct dsa_switch *ds, int port,
363 const unsigned char *addr, u16 vid);
364 int b53_fdb_dump(struct dsa_switch *ds, int port,
365 dsa_fdb_dump_cb_t *cb, void *data);
366 int b53_mdb_add(struct dsa_switch *ds, int port,
367 const struct switchdev_obj_port_mdb *mdb);
368 int b53_mdb_del(struct dsa_switch *ds, int port,
369 const struct switchdev_obj_port_mdb *mdb);
370 int b53_mirror_add(struct dsa_switch *ds, int port,
371 struct dsa_mall_mirror_tc_entry *mirror, bool ingress);
372 enum dsa_tag_protocol b53_get_tag_protocol(struct dsa_switch *ds, int port,
373 enum dsa_tag_protocol mprot);
374 void b53_mirror_del(struct dsa_switch *ds, int port,
375 struct dsa_mall_mirror_tc_entry *mirror);
376 int b53_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy);
377 void b53_disable_port(struct dsa_switch *ds, int port);
378 void b53_brcm_hdr_setup(struct dsa_switch *ds, int port);
379 void b53_eee_enable_set(struct dsa_switch *ds, int port, bool enable);
380 int b53_eee_init(struct dsa_switch *ds, int port, struct phy_device *phy);
381 int b53_get_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e);
382 int b53_set_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e);