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