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