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