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 struct device_node *dn;
200 unsigned int ageing_time;
201 u8 stp_state;
202 struct net_device *bridge_dev;
203 struct devlink_port devlink_port;
204 struct phylink *pl;
205 /*
206 * Original copy of the master netdev ethtool_ops
207 */
208 const struct ethtool_ops *orig_ethtool_ops;
209 };
210
211 struct dsa_switch {
212 struct device *dev;
213
214 /*
215 * Parent switch tree, and switch index.
216 */
217 struct dsa_switch_tree *dst;
218 unsigned int index;
219
220 /* Listener for switch fabric events */
221 struct notifier_block nb;
222
223 /*
224 * Give the switch driver somewhere to hang its private data
225 * structure.
226 */
227 void *priv;
228
229 /*
230 * Configuration data for this switch.
231 */
232 struct dsa_chip_data *cd;
233
234 /*
235 * The switch operations.
236 */
237 const struct dsa_switch_ops *ops;
238
239 /*
240 * An array of which element [a] indicates which port on this
241 * switch should be used to send packets to that are destined
242 * for switch a. Can be NULL if there is only one switch chip.
243 */
244 s8 rtable[DSA_MAX_SWITCHES];
245
246 /*
247 * Slave mii_bus and devices for the individual ports.
248 */
249 u32 phys_mii_mask;
250 struct mii_bus *slave_mii_bus;
251
252 /* Ageing Time limits in msecs */
253 unsigned int ageing_time_min;
254 unsigned int ageing_time_max;
255
256 /* devlink used to represent this switch device */
257 struct devlink *devlink;
258
259 /* Number of switch port queues */
260 unsigned int num_tx_queues;
261
262 unsigned long *bitmap;
263 unsigned long _bitmap;
264
265 /* Dynamically allocated ports, keep last */
266 size_t num_ports;
267 struct dsa_port ports[];
268 };
269
dsa_to_port(struct dsa_switch * ds,int p)270 static inline const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
271 {
272 return &ds->ports[p];
273 }
274
dsa_is_unused_port(struct dsa_switch * ds,int p)275 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
276 {
277 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
278 }
279
dsa_is_cpu_port(struct dsa_switch * ds,int p)280 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
281 {
282 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
283 }
284
dsa_is_dsa_port(struct dsa_switch * ds,int p)285 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
286 {
287 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
288 }
289
dsa_is_user_port(struct dsa_switch * ds,int p)290 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
291 {
292 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
293 }
294
dsa_user_ports(struct dsa_switch * ds)295 static inline u32 dsa_user_ports(struct dsa_switch *ds)
296 {
297 u32 mask = 0;
298 int p;
299
300 for (p = 0; p < ds->num_ports; p++)
301 if (dsa_is_user_port(ds, p))
302 mask |= BIT(p);
303
304 return mask;
305 }
306
307 /* Return the local port used to reach an arbitrary switch port */
dsa_towards_port(struct dsa_switch * ds,int device,int port)308 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
309 int port)
310 {
311 if (device == ds->index)
312 return port;
313 else
314 return ds->rtable[device];
315 }
316
317 /* Return the local port used to reach the dedicated CPU port */
dsa_upstream_port(struct dsa_switch * ds,int port)318 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
319 {
320 const struct dsa_port *dp = dsa_to_port(ds, port);
321 const struct dsa_port *cpu_dp = dp->cpu_dp;
322
323 if (!cpu_dp)
324 return port;
325
326 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
327 }
328
329 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
330 bool is_static, void *data);
331 struct dsa_switch_ops {
332 #if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
333 /*
334 * Legacy probing.
335 */
336 const char *(*probe)(struct device *dsa_dev,
337 struct device *host_dev, int sw_addr,
338 void **priv);
339 #endif
340
341 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
342 int port);
343
344 int (*setup)(struct dsa_switch *ds);
345 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
346
347 /*
348 * Access to the switch's PHY registers.
349 */
350 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
351 int (*phy_write)(struct dsa_switch *ds, int port,
352 int regnum, u16 val);
353
354 /*
355 * Link state adjustment (called from libphy)
356 */
357 void (*adjust_link)(struct dsa_switch *ds, int port,
358 struct phy_device *phydev);
359 void (*fixed_link_update)(struct dsa_switch *ds, int port,
360 struct fixed_phy_status *st);
361
362 /*
363 * PHYLINK integration
364 */
365 void (*phylink_validate)(struct dsa_switch *ds, int port,
366 unsigned long *supported,
367 struct phylink_link_state *state);
368 int (*phylink_mac_link_state)(struct dsa_switch *ds, int port,
369 struct phylink_link_state *state);
370 void (*phylink_mac_config)(struct dsa_switch *ds, int port,
371 unsigned int mode,
372 const struct phylink_link_state *state);
373 void (*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
374 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
375 unsigned int mode,
376 phy_interface_t interface);
377 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
378 unsigned int mode,
379 phy_interface_t interface,
380 struct phy_device *phydev);
381 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
382 struct phylink_link_state *state);
383 /*
384 * ethtool hardware statistics.
385 */
386 void (*get_strings)(struct dsa_switch *ds, int port,
387 u32 stringset, uint8_t *data);
388 void (*get_ethtool_stats)(struct dsa_switch *ds,
389 int port, uint64_t *data);
390 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
391 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
392 int port, uint64_t *data);
393
394 /*
395 * ethtool Wake-on-LAN
396 */
397 void (*get_wol)(struct dsa_switch *ds, int port,
398 struct ethtool_wolinfo *w);
399 int (*set_wol)(struct dsa_switch *ds, int port,
400 struct ethtool_wolinfo *w);
401
402 /*
403 * ethtool timestamp info
404 */
405 int (*get_ts_info)(struct dsa_switch *ds, int port,
406 struct ethtool_ts_info *ts);
407
408 /*
409 * Suspend and resume
410 */
411 int (*suspend)(struct dsa_switch *ds);
412 int (*resume)(struct dsa_switch *ds);
413
414 /*
415 * Port enable/disable
416 */
417 int (*port_enable)(struct dsa_switch *ds, int port,
418 struct phy_device *phy);
419 void (*port_disable)(struct dsa_switch *ds, int port,
420 struct phy_device *phy);
421
422 /*
423 * Port's MAC EEE settings
424 */
425 int (*set_mac_eee)(struct dsa_switch *ds, int port,
426 struct ethtool_eee *e);
427 int (*get_mac_eee)(struct dsa_switch *ds, int port,
428 struct ethtool_eee *e);
429
430 /* EEPROM access */
431 int (*get_eeprom_len)(struct dsa_switch *ds);
432 int (*get_eeprom)(struct dsa_switch *ds,
433 struct ethtool_eeprom *eeprom, u8 *data);
434 int (*set_eeprom)(struct dsa_switch *ds,
435 struct ethtool_eeprom *eeprom, u8 *data);
436
437 /*
438 * Register access.
439 */
440 int (*get_regs_len)(struct dsa_switch *ds, int port);
441 void (*get_regs)(struct dsa_switch *ds, int port,
442 struct ethtool_regs *regs, void *p);
443
444 /*
445 * Bridge integration
446 */
447 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
448 int (*port_bridge_join)(struct dsa_switch *ds, int port,
449 struct net_device *bridge);
450 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
451 struct net_device *bridge);
452 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
453 u8 state);
454 void (*port_fast_age)(struct dsa_switch *ds, int port);
455
456 /*
457 * VLAN support
458 */
459 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
460 bool vlan_filtering);
461 int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
462 const struct switchdev_obj_port_vlan *vlan);
463 void (*port_vlan_add)(struct dsa_switch *ds, int port,
464 const struct switchdev_obj_port_vlan *vlan);
465 int (*port_vlan_del)(struct dsa_switch *ds, int port,
466 const struct switchdev_obj_port_vlan *vlan);
467 /*
468 * Forwarding database
469 */
470 int (*port_fdb_add)(struct dsa_switch *ds, int port,
471 const unsigned char *addr, u16 vid);
472 int (*port_fdb_del)(struct dsa_switch *ds, int port,
473 const unsigned char *addr, u16 vid);
474 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
475 dsa_fdb_dump_cb_t *cb, void *data);
476
477 /*
478 * Multicast database
479 */
480 int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
481 const struct switchdev_obj_port_mdb *mdb);
482 void (*port_mdb_add)(struct dsa_switch *ds, int port,
483 const struct switchdev_obj_port_mdb *mdb);
484 int (*port_mdb_del)(struct dsa_switch *ds, int port,
485 const struct switchdev_obj_port_mdb *mdb);
486 /*
487 * RXNFC
488 */
489 int (*get_rxnfc)(struct dsa_switch *ds, int port,
490 struct ethtool_rxnfc *nfc, u32 *rule_locs);
491 int (*set_rxnfc)(struct dsa_switch *ds, int port,
492 struct ethtool_rxnfc *nfc);
493
494 /*
495 * TC integration
496 */
497 int (*port_mirror_add)(struct dsa_switch *ds, int port,
498 struct dsa_mall_mirror_tc_entry *mirror,
499 bool ingress);
500 void (*port_mirror_del)(struct dsa_switch *ds, int port,
501 struct dsa_mall_mirror_tc_entry *mirror);
502
503 /*
504 * Cross-chip operations
505 */
506 int (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
507 int port, struct net_device *br);
508 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
509 int port, struct net_device *br);
510
511 /*
512 * PTP functionality
513 */
514 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
515 struct ifreq *ifr);
516 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
517 struct ifreq *ifr);
518 bool (*port_txtstamp)(struct dsa_switch *ds, int port,
519 struct sk_buff *clone, unsigned int type);
520 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
521 struct sk_buff *skb, unsigned int type);
522 };
523
524 struct dsa_switch_driver {
525 struct list_head list;
526 const struct dsa_switch_ops *ops;
527 };
528
529 #if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
530 /* Legacy driver registration */
531 void register_switch_driver(struct dsa_switch_driver *type);
532 void unregister_switch_driver(struct dsa_switch_driver *type);
533 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
534
535 #else
register_switch_driver(struct dsa_switch_driver * type)536 static inline void register_switch_driver(struct dsa_switch_driver *type) { }
unregister_switch_driver(struct dsa_switch_driver * type)537 static inline void unregister_switch_driver(struct dsa_switch_driver *type) { }
dsa_host_dev_to_mii_bus(struct device * dev)538 static inline struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
539 {
540 return NULL;
541 }
542 #endif
543 struct net_device *dsa_dev_to_net_device(struct device *dev);
544
545 /* Keep inline for faster access in hot path */
netdev_uses_dsa(struct net_device * dev)546 static inline bool netdev_uses_dsa(struct net_device *dev)
547 {
548 #if IS_ENABLED(CONFIG_NET_DSA)
549 return dev->dsa_ptr && dev->dsa_ptr->rcv;
550 #endif
551 return false;
552 }
553
554 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
555 void dsa_unregister_switch(struct dsa_switch *ds);
556 int dsa_register_switch(struct dsa_switch *ds);
557 #ifdef CONFIG_PM_SLEEP
558 int dsa_switch_suspend(struct dsa_switch *ds);
559 int dsa_switch_resume(struct dsa_switch *ds);
560 #else
dsa_switch_suspend(struct dsa_switch * ds)561 static inline int dsa_switch_suspend(struct dsa_switch *ds)
562 {
563 return 0;
564 }
dsa_switch_resume(struct dsa_switch * ds)565 static inline int dsa_switch_resume(struct dsa_switch *ds)
566 {
567 return 0;
568 }
569 #endif /* CONFIG_PM_SLEEP */
570
571 enum dsa_notifier_type {
572 DSA_PORT_REGISTER,
573 DSA_PORT_UNREGISTER,
574 };
575
576 struct dsa_notifier_info {
577 struct net_device *dev;
578 };
579
580 struct dsa_notifier_register_info {
581 struct dsa_notifier_info info; /* must be first */
582 struct net_device *master;
583 unsigned int port_number;
584 unsigned int switch_number;
585 };
586
587 static inline struct net_device *
dsa_notifier_info_to_dev(const struct dsa_notifier_info * info)588 dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
589 {
590 return info->dev;
591 }
592
593 #if IS_ENABLED(CONFIG_NET_DSA)
594 int register_dsa_notifier(struct notifier_block *nb);
595 int unregister_dsa_notifier(struct notifier_block *nb);
596 int call_dsa_notifiers(unsigned long val, struct net_device *dev,
597 struct dsa_notifier_info *info);
598 #else
register_dsa_notifier(struct notifier_block * nb)599 static inline int register_dsa_notifier(struct notifier_block *nb)
600 {
601 return 0;
602 }
603
unregister_dsa_notifier(struct notifier_block * nb)604 static inline int unregister_dsa_notifier(struct notifier_block *nb)
605 {
606 return 0;
607 }
608
call_dsa_notifiers(unsigned long val,struct net_device * dev,struct dsa_notifier_info * info)609 static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
610 struct dsa_notifier_info *info)
611 {
612 return NOTIFY_DONE;
613 }
614 #endif
615
616 /* Broadcom tag specific helpers to insert and extract queue/port number */
617 #define BRCM_TAG_SET_PORT_QUEUE(p, q) ((p) << 8 | q)
618 #define BRCM_TAG_GET_PORT(v) ((v) >> 8)
619 #define BRCM_TAG_GET_QUEUE(v) ((v) & 0xff)
620
621
622 int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data);
623 int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data);
624 int dsa_port_get_phy_sset_count(struct dsa_port *dp);
625 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
626
627 #endif
628
