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 <linux/net_tstamp.h>
23 #include <linux/phy.h>
24 #include <net/devlink.h>
25 #include <net/switchdev.h>
26 
27 struct tc_action;
28 struct phy_device;
29 struct fixed_phy_status;
30 struct phylink_link_state;
31 
32 enum dsa_tag_protocol {
33 	DSA_TAG_PROTO_NONE = 0,
34 	DSA_TAG_PROTO_BRCM,
35 	DSA_TAG_PROTO_BRCM_PREPEND,
36 	DSA_TAG_PROTO_DSA,
37 	DSA_TAG_PROTO_EDSA,
38 	DSA_TAG_PROTO_KSZ,
39 	DSA_TAG_PROTO_LAN9303,
40 	DSA_TAG_PROTO_MTK,
41 	DSA_TAG_PROTO_QCA,
42 	DSA_TAG_PROTO_TRAILER,
43 	DSA_TAG_LAST,		/* MUST BE LAST */
44 };
45 
46 #define DSA_MAX_SWITCHES	4
47 #define DSA_MAX_PORTS		12
48 
49 #define DSA_RTABLE_NONE		-1
50 
51 struct dsa_chip_data {
52 	/*
53 	 * How to access the switch configuration registers.
54 	 */
55 	struct device	*host_dev;
56 	int		sw_addr;
57 
58 	/*
59 	 * Reference to network devices
60 	 */
61 	struct device	*netdev[DSA_MAX_PORTS];
62 
63 	/* set to size of eeprom if supported by the switch */
64 	int		eeprom_len;
65 
66 	/* Device tree node pointer for this specific switch chip
67 	 * used during switch setup in case additional properties
68 	 * and resources needs to be used
69 	 */
70 	struct device_node *of_node;
71 
72 	/*
73 	 * The names of the switch's ports.  Use "cpu" to
74 	 * designate the switch port that the cpu is connected to,
75 	 * "dsa" to indicate that this port is a DSA link to
76 	 * another switch, NULL to indicate the port is unused,
77 	 * or any other string to indicate this is a physical port.
78 	 */
79 	char		*port_names[DSA_MAX_PORTS];
80 	struct device_node *port_dn[DSA_MAX_PORTS];
81 
82 	/*
83 	 * An array of which element [a] indicates which port on this
84 	 * switch should be used to send packets to that are destined
85 	 * for switch a. Can be NULL if there is only one switch chip.
86 	 */
87 	s8		rtable[DSA_MAX_SWITCHES];
88 };
89 
90 struct dsa_platform_data {
91 	/*
92 	 * Reference to a Linux network interface that connects
93 	 * to the root switch chip of the tree.
94 	 */
95 	struct device	*netdev;
96 	struct net_device *of_netdev;
97 
98 	/*
99 	 * Info structs describing each of the switch chips
100 	 * connected via this network interface.
101 	 */
102 	int		nr_chips;
103 	struct dsa_chip_data	*chip;
104 };
105 
106 struct packet_type;
107 struct dsa_switch;
108 
109 struct dsa_device_ops {
110 	struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
111 	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
112 			       struct packet_type *pt);
113 	int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
114 			    int *offset);
115 };
116 
117 struct dsa_switch_tree {
118 	struct list_head	list;
119 
120 	/* Notifier chain for switch-wide events */
121 	struct raw_notifier_head	nh;
122 
123 	/* Tree identifier */
124 	unsigned int index;
125 
126 	/* Number of switches attached to this tree */
127 	struct kref refcount;
128 
129 	/* Has this tree been applied to the hardware? */
130 	bool setup;
131 
132 	/*
133 	 * Configuration data for the platform device that owns
134 	 * this dsa switch tree instance.
135 	 */
136 	struct dsa_platform_data	*pd;
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 /* TC matchall action types, only mirroring for now */
150 enum dsa_port_mall_action_type {
151 	DSA_PORT_MALL_MIRROR,
152 };
153 
154 /* TC mirroring entry */
155 struct dsa_mall_mirror_tc_entry {
156 	u8 to_local_port;
157 	bool ingress;
158 };
159 
160 /* TC matchall entry */
161 struct dsa_mall_tc_entry {
162 	struct list_head list;
163 	unsigned long cookie;
164 	enum dsa_port_mall_action_type type;
165 	union {
166 		struct dsa_mall_mirror_tc_entry mirror;
167 	};
168 };
169 
170 
171 struct dsa_port {
172 	/* A CPU port is physically connected to a master device.
173 	 * A user port exposed to userspace has a slave device.
174 	 */
175 	union {
176 		struct net_device *master;
177 		struct net_device *slave;
178 	};
179 
180 	/* CPU port tagging operations used by master or slave devices */
181 	const struct dsa_device_ops *tag_ops;
182 
183 	/* Copies for faster access in master receive hot path */
184 	struct dsa_switch_tree *dst;
185 	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
186 			       struct packet_type *pt);
187 
188 	enum {
189 		DSA_PORT_TYPE_UNUSED = 0,
190 		DSA_PORT_TYPE_CPU,
191 		DSA_PORT_TYPE_DSA,
192 		DSA_PORT_TYPE_USER,
193 	} type;
194 
195 	struct dsa_switch	*ds;
196 	unsigned int		index;
197 	const char		*name;
198 	const struct dsa_port	*cpu_dp;
199 	const char		*mac;
200 	struct device_node	*dn;
201 	unsigned int		ageing_time;
202 	u8			stp_state;
203 	struct net_device	*bridge_dev;
204 	struct devlink_port	devlink_port;
205 	struct phylink		*pl;
206 	/*
207 	 * Original copy of the master netdev ethtool_ops
208 	 */
209 	const struct ethtool_ops *orig_ethtool_ops;
210 };
211 
212 struct dsa_switch {
213 	struct device *dev;
214 
215 	/*
216 	 * Parent switch tree, and switch index.
217 	 */
218 	struct dsa_switch_tree	*dst;
219 	unsigned int		index;
220 
221 	/* Listener for switch fabric events */
222 	struct notifier_block	nb;
223 
224 	/*
225 	 * Give the switch driver somewhere to hang its private data
226 	 * structure.
227 	 */
228 	void *priv;
229 
230 	/*
231 	 * Configuration data for this switch.
232 	 */
233 	struct dsa_chip_data	*cd;
234 
235 	/*
236 	 * The switch operations.
237 	 */
238 	const struct dsa_switch_ops	*ops;
239 
240 	/*
241 	 * An array of which element [a] indicates which port on this
242 	 * switch should be used to send packets to that are destined
243 	 * for switch a. Can be NULL if there is only one switch chip.
244 	 */
245 	s8		rtable[DSA_MAX_SWITCHES];
246 
247 	/*
248 	 * Slave mii_bus and devices for the individual ports.
249 	 */
250 	u32			phys_mii_mask;
251 	struct mii_bus		*slave_mii_bus;
252 
253 	/* Ageing Time limits in msecs */
254 	unsigned int ageing_time_min;
255 	unsigned int ageing_time_max;
256 
257 	/* devlink used to represent this switch device */
258 	struct devlink		*devlink;
259 
260 	/* Number of switch port queues */
261 	unsigned int		num_tx_queues;
262 
263 	unsigned long		*bitmap;
264 	unsigned long		_bitmap;
265 
266 	/* Dynamically allocated ports, keep last */
267 	size_t num_ports;
268 	struct dsa_port ports[];
269 };
270 
dsa_to_port(struct dsa_switch * ds,int p)271 static inline const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
272 {
273 	return &ds->ports[p];
274 }
275 
dsa_is_unused_port(struct dsa_switch * ds,int p)276 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
277 {
278 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
279 }
280 
dsa_is_cpu_port(struct dsa_switch * ds,int p)281 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
282 {
283 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
284 }
285 
dsa_is_dsa_port(struct dsa_switch * ds,int p)286 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
287 {
288 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
289 }
290 
dsa_is_user_port(struct dsa_switch * ds,int p)291 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
292 {
293 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
294 }
295 
dsa_user_ports(struct dsa_switch * ds)296 static inline u32 dsa_user_ports(struct dsa_switch *ds)
297 {
298 	u32 mask = 0;
299 	int p;
300 
301 	for (p = 0; p < ds->num_ports; p++)
302 		if (dsa_is_user_port(ds, p))
303 			mask |= BIT(p);
304 
305 	return mask;
306 }
307 
308 /* Return the local port used to reach an arbitrary switch port */
dsa_towards_port(struct dsa_switch * ds,int device,int port)309 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
310 					    int port)
311 {
312 	if (device == ds->index)
313 		return port;
314 	else
315 		return ds->rtable[device];
316 }
317 
318 /* Return the local port used to reach the dedicated CPU port */
dsa_upstream_port(struct dsa_switch * ds,int port)319 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
320 {
321 	const struct dsa_port *dp = dsa_to_port(ds, port);
322 	const struct dsa_port *cpu_dp = dp->cpu_dp;
323 
324 	if (!cpu_dp)
325 		return port;
326 
327 	return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
328 }
329 
330 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
331 			      bool is_static, void *data);
332 struct dsa_switch_ops {
333 #if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
334 	/*
335 	 * Legacy probing.
336 	 */
337 	const char	*(*probe)(struct device *dsa_dev,
338 				  struct device *host_dev, int sw_addr,
339 				  void **priv);
340 #endif
341 
342 	enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
343 						  int port);
344 
345 	int	(*setup)(struct dsa_switch *ds);
346 	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
347 
348 	/*
349 	 * Access to the switch's PHY registers.
350 	 */
351 	int	(*phy_read)(struct dsa_switch *ds, int port, int regnum);
352 	int	(*phy_write)(struct dsa_switch *ds, int port,
353 			     int regnum, u16 val);
354 
355 	/*
356 	 * Link state adjustment (called from libphy)
357 	 */
358 	void	(*adjust_link)(struct dsa_switch *ds, int port,
359 				struct phy_device *phydev);
360 	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
361 				struct fixed_phy_status *st);
362 
363 	/*
364 	 * PHYLINK integration
365 	 */
366 	void	(*phylink_validate)(struct dsa_switch *ds, int port,
367 				    unsigned long *supported,
368 				    struct phylink_link_state *state);
369 	int	(*phylink_mac_link_state)(struct dsa_switch *ds, int port,
370 					  struct phylink_link_state *state);
371 	void	(*phylink_mac_config)(struct dsa_switch *ds, int port,
372 				      unsigned int mode,
373 				      const struct phylink_link_state *state);
374 	void	(*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
375 	void	(*phylink_mac_link_down)(struct dsa_switch *ds, int port,
376 					 unsigned int mode,
377 					 phy_interface_t interface);
378 	void	(*phylink_mac_link_up)(struct dsa_switch *ds, int port,
379 				       unsigned int mode,
380 				       phy_interface_t interface,
381 				       struct phy_device *phydev);
382 	void	(*phylink_fixed_state)(struct dsa_switch *ds, int port,
383 				       struct phylink_link_state *state);
384 	/*
385 	 * ethtool hardware statistics.
386 	 */
387 	void	(*get_strings)(struct dsa_switch *ds, int port,
388 			       u32 stringset, uint8_t *data);
389 	void	(*get_ethtool_stats)(struct dsa_switch *ds,
390 				     int port, uint64_t *data);
391 	int	(*get_sset_count)(struct dsa_switch *ds, int port, int sset);
392 	void	(*get_ethtool_phy_stats)(struct dsa_switch *ds,
393 					 int port, uint64_t *data);
394 
395 	/*
396 	 * ethtool Wake-on-LAN
397 	 */
398 	void	(*get_wol)(struct dsa_switch *ds, int port,
399 			   struct ethtool_wolinfo *w);
400 	int	(*set_wol)(struct dsa_switch *ds, int port,
401 			   struct ethtool_wolinfo *w);
402 
403 	/*
404 	 * ethtool timestamp info
405 	 */
406 	int	(*get_ts_info)(struct dsa_switch *ds, int port,
407 			       struct ethtool_ts_info *ts);
408 
409 	/*
410 	 * Suspend and resume
411 	 */
412 	int	(*suspend)(struct dsa_switch *ds);
413 	int	(*resume)(struct dsa_switch *ds);
414 
415 	/*
416 	 * Port enable/disable
417 	 */
418 	int	(*port_enable)(struct dsa_switch *ds, int port,
419 			       struct phy_device *phy);
420 	void	(*port_disable)(struct dsa_switch *ds, int port,
421 				struct phy_device *phy);
422 
423 	/*
424 	 * Port's MAC EEE settings
425 	 */
426 	int	(*set_mac_eee)(struct dsa_switch *ds, int port,
427 			       struct ethtool_eee *e);
428 	int	(*get_mac_eee)(struct dsa_switch *ds, int port,
429 			       struct ethtool_eee *e);
430 
431 	/* EEPROM access */
432 	int	(*get_eeprom_len)(struct dsa_switch *ds);
433 	int	(*get_eeprom)(struct dsa_switch *ds,
434 			      struct ethtool_eeprom *eeprom, u8 *data);
435 	int	(*set_eeprom)(struct dsa_switch *ds,
436 			      struct ethtool_eeprom *eeprom, u8 *data);
437 
438 	/*
439 	 * Register access.
440 	 */
441 	int	(*get_regs_len)(struct dsa_switch *ds, int port);
442 	void	(*get_regs)(struct dsa_switch *ds, int port,
443 			    struct ethtool_regs *regs, void *p);
444 
445 	/*
446 	 * Bridge integration
447 	 */
448 	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
449 	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
450 				    struct net_device *bridge);
451 	void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
452 				     struct net_device *bridge);
453 	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
454 				      u8 state);
455 	void	(*port_fast_age)(struct dsa_switch *ds, int port);
456 
457 	/*
458 	 * VLAN support
459 	 */
460 	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
461 				       bool vlan_filtering);
462 	int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
463 				 const struct switchdev_obj_port_vlan *vlan);
464 	void (*port_vlan_add)(struct dsa_switch *ds, int port,
465 			      const struct switchdev_obj_port_vlan *vlan);
466 	int	(*port_vlan_del)(struct dsa_switch *ds, int port,
467 				 const struct switchdev_obj_port_vlan *vlan);
468 	/*
469 	 * Forwarding database
470 	 */
471 	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
472 				const unsigned char *addr, u16 vid);
473 	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
474 				const unsigned char *addr, u16 vid);
475 	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
476 				 dsa_fdb_dump_cb_t *cb, void *data);
477 
478 	/*
479 	 * Multicast database
480 	 */
481 	int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
482 				const struct switchdev_obj_port_mdb *mdb);
483 	void (*port_mdb_add)(struct dsa_switch *ds, int port,
484 			     const struct switchdev_obj_port_mdb *mdb);
485 	int	(*port_mdb_del)(struct dsa_switch *ds, int port,
486 				const struct switchdev_obj_port_mdb *mdb);
487 	/*
488 	 * RXNFC
489 	 */
490 	int	(*get_rxnfc)(struct dsa_switch *ds, int port,
491 			     struct ethtool_rxnfc *nfc, u32 *rule_locs);
492 	int	(*set_rxnfc)(struct dsa_switch *ds, int port,
493 			     struct ethtool_rxnfc *nfc);
494 
495 	/*
496 	 * TC integration
497 	 */
498 	int	(*port_mirror_add)(struct dsa_switch *ds, int port,
499 				   struct dsa_mall_mirror_tc_entry *mirror,
500 				   bool ingress);
501 	void	(*port_mirror_del)(struct dsa_switch *ds, int port,
502 				   struct dsa_mall_mirror_tc_entry *mirror);
503 
504 	/*
505 	 * Cross-chip operations
506 	 */
507 	int	(*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
508 					 int port, struct net_device *br);
509 	void	(*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
510 					  int port, struct net_device *br);
511 
512 	/*
513 	 * PTP functionality
514 	 */
515 	int	(*port_hwtstamp_get)(struct dsa_switch *ds, int port,
516 				     struct ifreq *ifr);
517 	int	(*port_hwtstamp_set)(struct dsa_switch *ds, int port,
518 				     struct ifreq *ifr);
519 	bool	(*port_txtstamp)(struct dsa_switch *ds, int port,
520 				 struct sk_buff *clone, unsigned int type);
521 	bool	(*port_rxtstamp)(struct dsa_switch *ds, int port,
522 				 struct sk_buff *skb, unsigned int type);
523 };
524 
525 struct dsa_switch_driver {
526 	struct list_head	list;
527 	const struct dsa_switch_ops *ops;
528 };
529 
530 #if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
531 /* Legacy driver registration */
532 void register_switch_driver(struct dsa_switch_driver *type);
533 void unregister_switch_driver(struct dsa_switch_driver *type);
534 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
535 
536 #else
register_switch_driver(struct dsa_switch_driver * type)537 static inline void register_switch_driver(struct dsa_switch_driver *type) { }
unregister_switch_driver(struct dsa_switch_driver * type)538 static inline void unregister_switch_driver(struct dsa_switch_driver *type) { }
dsa_host_dev_to_mii_bus(struct device * dev)539 static inline struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
540 {
541 	return NULL;
542 }
543 #endif
544 struct net_device *dsa_dev_to_net_device(struct device *dev);
545 
546 /* Keep inline for faster access in hot path */
netdev_uses_dsa(struct net_device * dev)547 static inline bool netdev_uses_dsa(struct net_device *dev)
548 {
549 #if IS_ENABLED(CONFIG_NET_DSA)
550 	return dev->dsa_ptr && dev->dsa_ptr->rcv;
551 #endif
552 	return false;
553 }
554 
555 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
556 void dsa_unregister_switch(struct dsa_switch *ds);
557 int dsa_register_switch(struct dsa_switch *ds);
558 #ifdef CONFIG_PM_SLEEP
559 int dsa_switch_suspend(struct dsa_switch *ds);
560 int dsa_switch_resume(struct dsa_switch *ds);
561 #else
dsa_switch_suspend(struct dsa_switch * ds)562 static inline int dsa_switch_suspend(struct dsa_switch *ds)
563 {
564 	return 0;
565 }
dsa_switch_resume(struct dsa_switch * ds)566 static inline int dsa_switch_resume(struct dsa_switch *ds)
567 {
568 	return 0;
569 }
570 #endif /* CONFIG_PM_SLEEP */
571 
572 enum dsa_notifier_type {
573 	DSA_PORT_REGISTER,
574 	DSA_PORT_UNREGISTER,
575 };
576 
577 struct dsa_notifier_info {
578 	struct net_device *dev;
579 };
580 
581 struct dsa_notifier_register_info {
582 	struct dsa_notifier_info info;	/* must be first */
583 	struct net_device *master;
584 	unsigned int port_number;
585 	unsigned int switch_number;
586 };
587 
588 static inline struct net_device *
dsa_notifier_info_to_dev(const struct dsa_notifier_info * info)589 dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
590 {
591 	return info->dev;
592 }
593 
594 #if IS_ENABLED(CONFIG_NET_DSA)
595 int register_dsa_notifier(struct notifier_block *nb);
596 int unregister_dsa_notifier(struct notifier_block *nb);
597 int call_dsa_notifiers(unsigned long val, struct net_device *dev,
598 		       struct dsa_notifier_info *info);
599 #else
register_dsa_notifier(struct notifier_block * nb)600 static inline int register_dsa_notifier(struct notifier_block *nb)
601 {
602 	return 0;
603 }
604 
unregister_dsa_notifier(struct notifier_block * nb)605 static inline int unregister_dsa_notifier(struct notifier_block *nb)
606 {
607 	return 0;
608 }
609 
call_dsa_notifiers(unsigned long val,struct net_device * dev,struct dsa_notifier_info * info)610 static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
611 				     struct dsa_notifier_info *info)
612 {
613 	return NOTIFY_DONE;
614 }
615 #endif
616 
617 /* Broadcom tag specific helpers to insert and extract queue/port number */
618 #define BRCM_TAG_SET_PORT_QUEUE(p, q)	((p) << 8 | q)
619 #define BRCM_TAG_GET_PORT(v)		((v) >> 8)
620 #define BRCM_TAG_GET_QUEUE(v)		((v) & 0xff)
621 
622 
623 int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data);
624 int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data);
625 int dsa_port_get_phy_sset_count(struct dsa_port *dp);
626 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
627 
628 #endif
629