2 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
3 * Copyright (c) 2008-2009 Marvell Semiconductor
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.
11 #ifndef __LINUX_NET_DSA_H
12 #define __LINUX_NET_DSA_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>
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>
29 struct fixed_phy_status;
30 struct phylink_link_state;
32 enum dsa_tag_protocol {
33 DSA_TAG_PROTO_NONE = 0,
35 DSA_TAG_PROTO_BRCM_PREPEND,
39 DSA_TAG_PROTO_LAN9303,
42 DSA_TAG_PROTO_TRAILER,
43 DSA_TAG_LAST, /* MUST BE LAST */
46 #define DSA_MAX_SWITCHES 4
47 #define DSA_MAX_PORTS 12
49 #define DSA_RTABLE_NONE -1
51 struct dsa_chip_data {
53 * How to access the switch configuration registers.
55 struct device *host_dev;
59 * Reference to network devices
61 struct device *netdev[DSA_MAX_PORTS];
63 /* set to size of eeprom if supported by the switch */
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
70 struct device_node *of_node;
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.
79 char *port_names[DSA_MAX_PORTS];
80 struct device_node *port_dn[DSA_MAX_PORTS];
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.
87 s8 rtable[DSA_MAX_SWITCHES];
90 struct dsa_platform_data {
92 * Reference to a Linux network interface that connects
93 * to the root switch chip of the tree.
95 struct device *netdev;
96 struct net_device *of_netdev;
99 * Info structs describing each of the switch chips
100 * connected via this network interface.
103 struct dsa_chip_data *chip;
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,
117 struct dsa_switch_tree {
118 struct list_head list;
120 /* Notifier chain for switch-wide events */
121 struct raw_notifier_head nh;
123 /* Tree identifier */
126 /* Number of switches attached to this tree */
127 struct kref refcount;
129 /* Has this tree been applied to the hardware? */
133 * Configuration data for the platform device that owns
134 * this dsa switch tree instance.
136 struct dsa_platform_data *pd;
139 * The switch port to which the CPU is attached.
141 struct dsa_port *cpu_dp;
144 * Data for the individual switch chips.
146 struct dsa_switch *ds[DSA_MAX_SWITCHES];
149 /* TC matchall action types, only mirroring for now */
150 enum dsa_port_mall_action_type {
151 DSA_PORT_MALL_MIRROR,
154 /* TC mirroring entry */
155 struct dsa_mall_mirror_tc_entry {
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;
166 struct dsa_mall_mirror_tc_entry mirror;
172 /* A CPU port is physically connected to a master device.
173 * A user port exposed to userspace has a slave device.
176 struct net_device *master;
177 struct net_device *slave;
180 /* CPU port tagging operations used by master or slave devices */
181 const struct dsa_device_ops *tag_ops;
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);
189 DSA_PORT_TYPE_UNUSED = 0,
195 struct dsa_switch *ds;
198 const struct dsa_port *cpu_dp;
200 struct device_node *dn;
201 unsigned int ageing_time;
203 struct net_device *bridge_dev;
204 struct devlink_port devlink_port;
207 * Original copy of the master netdev ethtool_ops
209 const struct ethtool_ops *orig_ethtool_ops;
216 * Parent switch tree, and switch index.
218 struct dsa_switch_tree *dst;
221 /* Listener for switch fabric events */
222 struct notifier_block nb;
225 * Give the switch driver somewhere to hang its private data
231 * Configuration data for this switch.
233 struct dsa_chip_data *cd;
236 * The switch operations.
238 const struct dsa_switch_ops *ops;
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.
245 s8 rtable[DSA_MAX_SWITCHES];
248 * Slave mii_bus and devices for the individual ports.
251 struct mii_bus *slave_mii_bus;
253 /* Ageing Time limits in msecs */
254 unsigned int ageing_time_min;
255 unsigned int ageing_time_max;
257 /* devlink used to represent this switch device */
258 struct devlink *devlink;
260 /* Number of switch port queues */
261 unsigned int num_tx_queues;
263 unsigned long *bitmap;
264 unsigned long _bitmap;
266 /* Dynamically allocated ports, keep last */
268 struct dsa_port ports[];
271 static inline const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
273 return &ds->ports[p];
276 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
278 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
281 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
283 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
286 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
288 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
291 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
293 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
296 static inline u32 dsa_user_ports(struct dsa_switch *ds)
301 for (p = 0; p < ds->num_ports; p++)
302 if (dsa_is_user_port(ds, p))
308 /* Return the local port used to reach an arbitrary switch port */
309 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
312 if (device == ds->index)
315 return ds->rtable[device];
318 /* Return the local port used to reach the dedicated CPU port */
319 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
321 const struct dsa_port *dp = dsa_to_port(ds, port);
322 const struct dsa_port *cpu_dp = dp->cpu_dp;
327 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
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)
337 const char *(*probe)(struct device *dsa_dev,
338 struct device *host_dev, int sw_addr,
342 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
345 int (*setup)(struct dsa_switch *ds);
346 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
349 * Access to the switch's PHY registers.
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);
356 * Link state adjustment (called from libphy)
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);
364 * PHYLINK integration
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,
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,
377 phy_interface_t interface);
378 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
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);
385 * ethtool hardware statistics.
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);
396 * ethtool Wake-on-LAN
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);
404 * ethtool timestamp info
406 int (*get_ts_info)(struct dsa_switch *ds, int port,
407 struct ethtool_ts_info *ts);
412 int (*suspend)(struct dsa_switch *ds);
413 int (*resume)(struct dsa_switch *ds);
416 * Port enable/disable
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);
424 * Port's MAC EEE settings
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);
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);
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);
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,
455 void (*port_fast_age)(struct dsa_switch *ds, int port);
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);
469 * Forwarding database
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);
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);
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);
498 int (*port_mirror_add)(struct dsa_switch *ds, int port,
499 struct dsa_mall_mirror_tc_entry *mirror,
501 void (*port_mirror_del)(struct dsa_switch *ds, int port,
502 struct dsa_mall_mirror_tc_entry *mirror);
505 * Cross-chip operations
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);
515 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
517 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
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);
525 struct dsa_switch_driver {
526 struct list_head list;
527 const struct dsa_switch_ops *ops;
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);
537 static inline void register_switch_driver(struct dsa_switch_driver *type) { }
538 static inline void unregister_switch_driver(struct dsa_switch_driver *type) { }
539 static inline struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
544 struct net_device *dsa_dev_to_net_device(struct device *dev);
546 /* Keep inline for faster access in hot path */
547 static inline bool netdev_uses_dsa(struct net_device *dev)
549 #if IS_ENABLED(CONFIG_NET_DSA)
550 return dev->dsa_ptr && dev->dsa_ptr->rcv;
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);
562 static inline int dsa_switch_suspend(struct dsa_switch *ds)
566 static inline int dsa_switch_resume(struct dsa_switch *ds)
570 #endif /* CONFIG_PM_SLEEP */
572 enum dsa_notifier_type {
577 struct dsa_notifier_info {
578 struct net_device *dev;
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;
588 static inline struct net_device *
589 dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
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);
600 static inline int register_dsa_notifier(struct notifier_block *nb)
605 static inline int unregister_dsa_notifier(struct notifier_block *nb)
610 static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
611 struct dsa_notifier_info *info)
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)
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);