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