xref: /openbmc/linux/include/net/dsa.h (revision 5a244f48)
1 /*
2  * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
3  * Copyright (c) 2008-2009 Marvell Semiconductor
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  */
10 
11 #ifndef __LINUX_NET_DSA_H
12 #define __LINUX_NET_DSA_H
13 
14 #include <linux/if.h>
15 #include <linux/if_ether.h>
16 #include <linux/list.h>
17 #include <linux/notifier.h>
18 #include <linux/timer.h>
19 #include <linux/workqueue.h>
20 #include <linux/of.h>
21 #include <linux/ethtool.h>
22 #include <net/devlink.h>
23 #include <net/switchdev.h>
24 
25 struct tc_action;
26 struct phy_device;
27 struct fixed_phy_status;
28 
29 enum dsa_tag_protocol {
30 	DSA_TAG_PROTO_NONE = 0,
31 	DSA_TAG_PROTO_BRCM,
32 	DSA_TAG_PROTO_DSA,
33 	DSA_TAG_PROTO_EDSA,
34 	DSA_TAG_PROTO_KSZ,
35 	DSA_TAG_PROTO_LAN9303,
36 	DSA_TAG_PROTO_MTK,
37 	DSA_TAG_PROTO_QCA,
38 	DSA_TAG_PROTO_TRAILER,
39 	DSA_TAG_LAST,		/* MUST BE LAST */
40 };
41 
42 #define DSA_MAX_SWITCHES	4
43 #define DSA_MAX_PORTS		12
44 
45 #define DSA_RTABLE_NONE		-1
46 
47 struct dsa_chip_data {
48 	/*
49 	 * How to access the switch configuration registers.
50 	 */
51 	struct device	*host_dev;
52 	int		sw_addr;
53 
54 	/*
55 	 * Reference to network devices
56 	 */
57 	struct device	*netdev[DSA_MAX_PORTS];
58 
59 	/* set to size of eeprom if supported by the switch */
60 	int		eeprom_len;
61 
62 	/* Device tree node pointer for this specific switch chip
63 	 * used during switch setup in case additional properties
64 	 * and resources needs to be used
65 	 */
66 	struct device_node *of_node;
67 
68 	/*
69 	 * The names of the switch's ports.  Use "cpu" to
70 	 * designate the switch port that the cpu is connected to,
71 	 * "dsa" to indicate that this port is a DSA link to
72 	 * another switch, NULL to indicate the port is unused,
73 	 * or any other string to indicate this is a physical port.
74 	 */
75 	char		*port_names[DSA_MAX_PORTS];
76 	struct device_node *port_dn[DSA_MAX_PORTS];
77 
78 	/*
79 	 * An array of which element [a] indicates which port on this
80 	 * switch should be used to send packets to that are destined
81 	 * for switch a. Can be NULL if there is only one switch chip.
82 	 */
83 	s8		rtable[DSA_MAX_SWITCHES];
84 };
85 
86 struct dsa_platform_data {
87 	/*
88 	 * Reference to a Linux network interface that connects
89 	 * to the root switch chip of the tree.
90 	 */
91 	struct device	*netdev;
92 	struct net_device *of_netdev;
93 
94 	/*
95 	 * Info structs describing each of the switch chips
96 	 * connected via this network interface.
97 	 */
98 	int		nr_chips;
99 	struct dsa_chip_data	*chip;
100 };
101 
102 struct packet_type;
103 
104 struct dsa_device_ops {
105 	struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
106 	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
107 			       struct packet_type *pt);
108 	int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
109 			    int *offset);
110 };
111 
112 struct dsa_switch_tree {
113 	struct list_head	list;
114 
115 	/* Notifier chain for switch-wide events */
116 	struct raw_notifier_head	nh;
117 
118 	/* Tree identifier */
119 	u32 tree;
120 
121 	/* Number of switches attached to this tree */
122 	struct kref refcount;
123 
124 	/* Has this tree been applied to the hardware? */
125 	bool applied;
126 
127 	/*
128 	 * Configuration data for the platform device that owns
129 	 * this dsa switch tree instance.
130 	 */
131 	struct dsa_platform_data	*pd;
132 
133 	/* Copy of tag_ops->rcv for faster access in hot path */
134 	struct sk_buff *	(*rcv)(struct sk_buff *skb,
135 				       struct net_device *dev,
136 				       struct packet_type *pt);
137 
138 	/*
139 	 * The switch port to which the CPU is attached.
140 	 */
141 	struct dsa_port		*cpu_dp;
142 
143 	/*
144 	 * Data for the individual switch chips.
145 	 */
146 	struct dsa_switch	*ds[DSA_MAX_SWITCHES];
147 
148 	/*
149 	 * Tagging protocol operations for adding and removing an
150 	 * encapsulation tag.
151 	 */
152 	const struct dsa_device_ops *tag_ops;
153 };
154 
155 /* TC matchall action types, only mirroring for now */
156 enum dsa_port_mall_action_type {
157 	DSA_PORT_MALL_MIRROR,
158 };
159 
160 /* TC mirroring entry */
161 struct dsa_mall_mirror_tc_entry {
162 	u8 to_local_port;
163 	bool ingress;
164 };
165 
166 /* TC matchall entry */
167 struct dsa_mall_tc_entry {
168 	struct list_head list;
169 	unsigned long cookie;
170 	enum dsa_port_mall_action_type type;
171 	union {
172 		struct dsa_mall_mirror_tc_entry mirror;
173 	};
174 };
175 
176 
177 struct dsa_port {
178 	struct dsa_switch	*ds;
179 	unsigned int		index;
180 	const char		*name;
181 	struct dsa_port		*cpu_dp;
182 	struct net_device	*netdev;
183 	struct device_node	*dn;
184 	unsigned int		ageing_time;
185 	u8			stp_state;
186 	struct net_device	*bridge_dev;
187 	struct devlink_port	devlink_port;
188 	/*
189 	 * Original copy of the master netdev ethtool_ops
190 	 */
191 	struct ethtool_ops	ethtool_ops;
192 	const struct ethtool_ops *orig_ethtool_ops;
193 };
194 
195 struct dsa_switch {
196 	struct device *dev;
197 
198 	/*
199 	 * Parent switch tree, and switch index.
200 	 */
201 	struct dsa_switch_tree	*dst;
202 	int			index;
203 
204 	/* Listener for switch fabric events */
205 	struct notifier_block	nb;
206 
207 	/*
208 	 * Give the switch driver somewhere to hang its private data
209 	 * structure.
210 	 */
211 	void *priv;
212 
213 	/*
214 	 * Configuration data for this switch.
215 	 */
216 	struct dsa_chip_data	*cd;
217 
218 	/*
219 	 * The switch operations.
220 	 */
221 	const struct dsa_switch_ops	*ops;
222 
223 	/*
224 	 * An array of which element [a] indicates which port on this
225 	 * switch should be used to send packets to that are destined
226 	 * for switch a. Can be NULL if there is only one switch chip.
227 	 */
228 	s8		rtable[DSA_MAX_SWITCHES];
229 
230 	/*
231 	 * Slave mii_bus and devices for the individual ports.
232 	 */
233 	u32			dsa_port_mask;
234 	u32			cpu_port_mask;
235 	u32			enabled_port_mask;
236 	u32			phys_mii_mask;
237 	struct mii_bus		*slave_mii_bus;
238 
239 	/* Ageing Time limits in msecs */
240 	unsigned int ageing_time_min;
241 	unsigned int ageing_time_max;
242 
243 	/* devlink used to represent this switch device */
244 	struct devlink		*devlink;
245 
246 	/* Number of switch port queues */
247 	unsigned int		num_tx_queues;
248 
249 	/* Dynamically allocated ports, keep last */
250 	size_t num_ports;
251 	struct dsa_port ports[];
252 };
253 
254 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
255 {
256 	return !!(ds->cpu_port_mask & (1 << p));
257 }
258 
259 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
260 {
261 	return !!((ds->dsa_port_mask) & (1 << p));
262 }
263 
264 static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
265 {
266 	return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
267 }
268 
269 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
270 {
271 	struct dsa_switch_tree *dst = ds->dst;
272 
273 	/*
274 	 * If this is the root switch (i.e. the switch that connects
275 	 * to the CPU), return the cpu port number on this switch.
276 	 * Else return the (DSA) port number that connects to the
277 	 * switch that is one hop closer to the cpu.
278 	 */
279 	if (dst->cpu_dp->ds == ds)
280 		return dst->cpu_dp->index;
281 	else
282 		return ds->rtable[dst->cpu_dp->ds->index];
283 }
284 
285 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
286 			      bool is_static, void *data);
287 struct dsa_switch_ops {
288 	/*
289 	 * Legacy probing.
290 	 */
291 	const char	*(*probe)(struct device *dsa_dev,
292 				  struct device *host_dev, int sw_addr,
293 				  void **priv);
294 
295 	enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
296 
297 	int	(*setup)(struct dsa_switch *ds);
298 	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
299 	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
300 
301 	/*
302 	 * Access to the switch's PHY registers.
303 	 */
304 	int	(*phy_read)(struct dsa_switch *ds, int port, int regnum);
305 	int	(*phy_write)(struct dsa_switch *ds, int port,
306 			     int regnum, u16 val);
307 
308 	/*
309 	 * Link state adjustment (called from libphy)
310 	 */
311 	void	(*adjust_link)(struct dsa_switch *ds, int port,
312 				struct phy_device *phydev);
313 	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
314 				struct fixed_phy_status *st);
315 
316 	/*
317 	 * ethtool hardware statistics.
318 	 */
319 	void	(*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
320 	void	(*get_ethtool_stats)(struct dsa_switch *ds,
321 				     int port, uint64_t *data);
322 	int	(*get_sset_count)(struct dsa_switch *ds);
323 
324 	/*
325 	 * ethtool Wake-on-LAN
326 	 */
327 	void	(*get_wol)(struct dsa_switch *ds, int port,
328 			   struct ethtool_wolinfo *w);
329 	int	(*set_wol)(struct dsa_switch *ds, int port,
330 			   struct ethtool_wolinfo *w);
331 
332 	/*
333 	 * Suspend and resume
334 	 */
335 	int	(*suspend)(struct dsa_switch *ds);
336 	int	(*resume)(struct dsa_switch *ds);
337 
338 	/*
339 	 * Port enable/disable
340 	 */
341 	int	(*port_enable)(struct dsa_switch *ds, int port,
342 			       struct phy_device *phy);
343 	void	(*port_disable)(struct dsa_switch *ds, int port,
344 				struct phy_device *phy);
345 
346 	/*
347 	 * Port's MAC EEE settings
348 	 */
349 	int	(*set_mac_eee)(struct dsa_switch *ds, int port,
350 			       struct ethtool_eee *e);
351 	int	(*get_mac_eee)(struct dsa_switch *ds, int port,
352 			       struct ethtool_eee *e);
353 
354 	/* EEPROM access */
355 	int	(*get_eeprom_len)(struct dsa_switch *ds);
356 	int	(*get_eeprom)(struct dsa_switch *ds,
357 			      struct ethtool_eeprom *eeprom, u8 *data);
358 	int	(*set_eeprom)(struct dsa_switch *ds,
359 			      struct ethtool_eeprom *eeprom, u8 *data);
360 
361 	/*
362 	 * Register access.
363 	 */
364 	int	(*get_regs_len)(struct dsa_switch *ds, int port);
365 	void	(*get_regs)(struct dsa_switch *ds, int port,
366 			    struct ethtool_regs *regs, void *p);
367 
368 	/*
369 	 * Bridge integration
370 	 */
371 	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
372 	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
373 				    struct net_device *bridge);
374 	void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
375 				     struct net_device *bridge);
376 	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
377 				      u8 state);
378 	void	(*port_fast_age)(struct dsa_switch *ds, int port);
379 
380 	/*
381 	 * VLAN support
382 	 */
383 	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
384 				       bool vlan_filtering);
385 	int	(*port_vlan_prepare)(struct dsa_switch *ds, int port,
386 				     const struct switchdev_obj_port_vlan *vlan,
387 				     struct switchdev_trans *trans);
388 	void	(*port_vlan_add)(struct dsa_switch *ds, int port,
389 				 const struct switchdev_obj_port_vlan *vlan,
390 				 struct switchdev_trans *trans);
391 	int	(*port_vlan_del)(struct dsa_switch *ds, int port,
392 				 const struct switchdev_obj_port_vlan *vlan);
393 	/*
394 	 * Forwarding database
395 	 */
396 	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
397 				const unsigned char *addr, u16 vid);
398 	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
399 				const unsigned char *addr, u16 vid);
400 	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
401 				 dsa_fdb_dump_cb_t *cb, void *data);
402 
403 	/*
404 	 * Multicast database
405 	 */
406 	int	(*port_mdb_prepare)(struct dsa_switch *ds, int port,
407 				    const struct switchdev_obj_port_mdb *mdb,
408 				    struct switchdev_trans *trans);
409 	void	(*port_mdb_add)(struct dsa_switch *ds, int port,
410 				const struct switchdev_obj_port_mdb *mdb,
411 				struct switchdev_trans *trans);
412 	int	(*port_mdb_del)(struct dsa_switch *ds, int port,
413 				const struct switchdev_obj_port_mdb *mdb);
414 	/*
415 	 * RXNFC
416 	 */
417 	int	(*get_rxnfc)(struct dsa_switch *ds, int port,
418 			     struct ethtool_rxnfc *nfc, u32 *rule_locs);
419 	int	(*set_rxnfc)(struct dsa_switch *ds, int port,
420 			     struct ethtool_rxnfc *nfc);
421 
422 	/*
423 	 * TC integration
424 	 */
425 	int	(*port_mirror_add)(struct dsa_switch *ds, int port,
426 				   struct dsa_mall_mirror_tc_entry *mirror,
427 				   bool ingress);
428 	void	(*port_mirror_del)(struct dsa_switch *ds, int port,
429 				   struct dsa_mall_mirror_tc_entry *mirror);
430 
431 	/*
432 	 * Cross-chip operations
433 	 */
434 	int	(*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
435 					 int port, struct net_device *br);
436 	void	(*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
437 					  int port, struct net_device *br);
438 };
439 
440 struct dsa_switch_driver {
441 	struct list_head	list;
442 	const struct dsa_switch_ops *ops;
443 };
444 
445 /* Legacy driver registration */
446 void register_switch_driver(struct dsa_switch_driver *type);
447 void unregister_switch_driver(struct dsa_switch_driver *type);
448 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
449 
450 struct net_device *dsa_dev_to_net_device(struct device *dev);
451 
452 /* Keep inline for faster access in hot path */
453 static inline bool netdev_uses_dsa(struct net_device *dev)
454 {
455 #if IS_ENABLED(CONFIG_NET_DSA)
456 	return dev->dsa_ptr && dev->dsa_ptr->rcv;
457 #endif
458 	return false;
459 }
460 
461 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
462 void dsa_unregister_switch(struct dsa_switch *ds);
463 int dsa_register_switch(struct dsa_switch *ds);
464 #ifdef CONFIG_PM_SLEEP
465 int dsa_switch_suspend(struct dsa_switch *ds);
466 int dsa_switch_resume(struct dsa_switch *ds);
467 #else
468 static inline int dsa_switch_suspend(struct dsa_switch *ds)
469 {
470 	return 0;
471 }
472 static inline int dsa_switch_resume(struct dsa_switch *ds)
473 {
474 	return 0;
475 }
476 #endif /* CONFIG_PM_SLEEP */
477 
478 #endif
479