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