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