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