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