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 <net/devlink.h>
23 #include <net/switchdev.h>
27 struct fixed_phy_status;
29 enum dsa_tag_protocol {
30 DSA_TAG_PROTO_NONE = 0,
35 DSA_TAG_PROTO_LAN9303,
38 DSA_TAG_PROTO_TRAILER,
39 DSA_TAG_LAST, /* MUST BE LAST */
42 #define DSA_MAX_SWITCHES 4
43 #define DSA_MAX_PORTS 12
45 #define DSA_RTABLE_NONE -1
47 struct dsa_chip_data {
49 * How to access the switch configuration registers.
51 struct device *host_dev;
55 * Reference to network devices
57 struct device *netdev[DSA_MAX_PORTS];
59 /* set to size of eeprom if supported by the switch */
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
66 struct device_node *of_node;
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.
75 char *port_names[DSA_MAX_PORTS];
76 struct device_node *port_dn[DSA_MAX_PORTS];
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.
83 s8 rtable[DSA_MAX_SWITCHES];
86 struct dsa_platform_data {
88 * Reference to a Linux network interface that connects
89 * to the root switch chip of the tree.
91 struct device *netdev;
92 struct net_device *of_netdev;
95 * Info structs describing each of the switch chips
96 * connected via this network interface.
99 struct dsa_chip_data *chip;
104 struct dsa_switch_tree {
105 struct list_head list;
107 /* Notifier chain for switch-wide events */
108 struct raw_notifier_head nh;
110 /* Tree identifier */
113 /* Number of switches attached to this tree */
114 struct kref refcount;
116 /* Has this tree been applied to the hardware? */
120 * Configuration data for the platform device that owns
121 * this dsa switch tree instance.
123 struct dsa_platform_data *pd;
125 /* Copy of tag_ops->rcv for faster access in hot path */
126 struct sk_buff * (*rcv)(struct sk_buff *skb,
127 struct net_device *dev,
128 struct packet_type *pt,
129 struct net_device *orig_dev);
132 * The switch port to which the CPU is attached.
134 struct dsa_port *cpu_dp;
137 * Data for the individual switch chips.
139 struct dsa_switch *ds[DSA_MAX_SWITCHES];
142 * Tagging protocol operations for adding and removing an
145 const struct dsa_device_ops *tag_ops;
148 /* TC matchall action types, only mirroring for now */
149 enum dsa_port_mall_action_type {
150 DSA_PORT_MALL_MIRROR,
153 /* TC mirroring entry */
154 struct dsa_mall_mirror_tc_entry {
159 /* TC matchall entry */
160 struct dsa_mall_tc_entry {
161 struct list_head list;
162 unsigned long cookie;
163 enum dsa_port_mall_action_type type;
165 struct dsa_mall_mirror_tc_entry mirror;
171 struct dsa_switch *ds;
174 struct dsa_port *cpu_dp;
175 struct net_device *netdev;
176 struct device_node *dn;
177 unsigned int ageing_time;
179 struct net_device *bridge_dev;
180 struct devlink_port devlink_port;
182 * Original copy of the master netdev ethtool_ops
184 struct ethtool_ops ethtool_ops;
185 const struct ethtool_ops *orig_ethtool_ops;
192 * Parent switch tree, and switch index.
194 struct dsa_switch_tree *dst;
197 /* Listener for switch fabric events */
198 struct notifier_block nb;
201 * Give the switch driver somewhere to hang its private data
207 * Configuration data for this switch.
209 struct dsa_chip_data *cd;
212 * The switch operations.
214 const struct dsa_switch_ops *ops;
217 * An array of which element [a] indicates which port on this
218 * switch should be used to send packets to that are destined
219 * for switch a. Can be NULL if there is only one switch chip.
221 s8 rtable[DSA_MAX_SWITCHES];
224 * Slave mii_bus and devices for the individual ports.
228 u32 enabled_port_mask;
230 struct mii_bus *slave_mii_bus;
232 /* Ageing Time limits in msecs */
233 unsigned int ageing_time_min;
234 unsigned int ageing_time_max;
236 /* devlink used to represent this switch device */
237 struct devlink *devlink;
239 /* Dynamically allocated ports, keep last */
241 struct dsa_port ports[];
244 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
246 return !!(ds->cpu_port_mask & (1 << p));
249 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
251 return !!((ds->dsa_port_mask) & (1 << p));
254 static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
256 return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
259 static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
261 return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev;
264 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
266 struct dsa_switch_tree *dst = ds->dst;
269 * If this is the root switch (i.e. the switch that connects
270 * to the CPU), return the cpu port number on this switch.
271 * Else return the (DSA) port number that connects to the
272 * switch that is one hop closer to the cpu.
274 if (dst->cpu_dp->ds == ds)
275 return dst->cpu_dp->index;
277 return ds->rtable[dst->cpu_dp->ds->index];
280 struct dsa_switch_ops {
284 const char *(*probe)(struct device *dsa_dev,
285 struct device *host_dev, int sw_addr,
288 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
290 int (*setup)(struct dsa_switch *ds);
291 int (*set_addr)(struct dsa_switch *ds, u8 *addr);
292 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
295 * Access to the switch's PHY registers.
297 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
298 int (*phy_write)(struct dsa_switch *ds, int port,
299 int regnum, u16 val);
302 * Link state adjustment (called from libphy)
304 void (*adjust_link)(struct dsa_switch *ds, int port,
305 struct phy_device *phydev);
306 void (*fixed_link_update)(struct dsa_switch *ds, int port,
307 struct fixed_phy_status *st);
310 * ethtool hardware statistics.
312 void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
313 void (*get_ethtool_stats)(struct dsa_switch *ds,
314 int port, uint64_t *data);
315 int (*get_sset_count)(struct dsa_switch *ds);
318 * ethtool Wake-on-LAN
320 void (*get_wol)(struct dsa_switch *ds, int port,
321 struct ethtool_wolinfo *w);
322 int (*set_wol)(struct dsa_switch *ds, int port,
323 struct ethtool_wolinfo *w);
328 int (*suspend)(struct dsa_switch *ds);
329 int (*resume)(struct dsa_switch *ds);
332 * Port enable/disable
334 int (*port_enable)(struct dsa_switch *ds, int port,
335 struct phy_device *phy);
336 void (*port_disable)(struct dsa_switch *ds, int port,
337 struct phy_device *phy);
342 int (*set_eee)(struct dsa_switch *ds, int port,
343 struct phy_device *phydev,
344 struct ethtool_eee *e);
345 int (*get_eee)(struct dsa_switch *ds, int port,
346 struct ethtool_eee *e);
349 int (*get_eeprom_len)(struct dsa_switch *ds);
350 int (*get_eeprom)(struct dsa_switch *ds,
351 struct ethtool_eeprom *eeprom, u8 *data);
352 int (*set_eeprom)(struct dsa_switch *ds,
353 struct ethtool_eeprom *eeprom, u8 *data);
358 int (*get_regs_len)(struct dsa_switch *ds, int port);
359 void (*get_regs)(struct dsa_switch *ds, int port,
360 struct ethtool_regs *regs, void *p);
365 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
366 int (*port_bridge_join)(struct dsa_switch *ds, int port,
367 struct net_device *bridge);
368 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
369 struct net_device *bridge);
370 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
372 void (*port_fast_age)(struct dsa_switch *ds, int port);
377 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
378 bool vlan_filtering);
379 int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
380 const struct switchdev_obj_port_vlan *vlan,
381 struct switchdev_trans *trans);
382 void (*port_vlan_add)(struct dsa_switch *ds, int port,
383 const struct switchdev_obj_port_vlan *vlan,
384 struct switchdev_trans *trans);
385 int (*port_vlan_del)(struct dsa_switch *ds, int port,
386 const struct switchdev_obj_port_vlan *vlan);
387 int (*port_vlan_dump)(struct dsa_switch *ds, int port,
388 struct switchdev_obj_port_vlan *vlan,
389 switchdev_obj_dump_cb_t *cb);
392 * Forwarding database
394 int (*port_fdb_prepare)(struct dsa_switch *ds, int port,
395 const struct switchdev_obj_port_fdb *fdb,
396 struct switchdev_trans *trans);
397 void (*port_fdb_add)(struct dsa_switch *ds, int port,
398 const struct switchdev_obj_port_fdb *fdb,
399 struct switchdev_trans *trans);
400 int (*port_fdb_del)(struct dsa_switch *ds, int port,
401 const struct switchdev_obj_port_fdb *fdb);
402 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
403 struct switchdev_obj_port_fdb *fdb,
404 switchdev_obj_dump_cb_t *cb);
409 int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
410 const struct switchdev_obj_port_mdb *mdb,
411 struct switchdev_trans *trans);
412 void (*port_mdb_add)(struct dsa_switch *ds, int port,
413 const struct switchdev_obj_port_mdb *mdb,
414 struct switchdev_trans *trans);
415 int (*port_mdb_del)(struct dsa_switch *ds, int port,
416 const struct switchdev_obj_port_mdb *mdb);
417 int (*port_mdb_dump)(struct dsa_switch *ds, int port,
418 struct switchdev_obj_port_mdb *mdb,
419 switchdev_obj_dump_cb_t *cb);
424 int (*get_rxnfc)(struct dsa_switch *ds, int port,
425 struct ethtool_rxnfc *nfc, u32 *rule_locs);
426 int (*set_rxnfc)(struct dsa_switch *ds, int port,
427 struct ethtool_rxnfc *nfc);
432 int (*port_mirror_add)(struct dsa_switch *ds, int port,
433 struct dsa_mall_mirror_tc_entry *mirror,
435 void (*port_mirror_del)(struct dsa_switch *ds, int port,
436 struct dsa_mall_mirror_tc_entry *mirror);
439 * Cross-chip operations
441 int (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
442 int port, struct net_device *br);
443 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
444 int port, struct net_device *br);
447 struct dsa_switch_driver {
448 struct list_head list;
449 const struct dsa_switch_ops *ops;
452 /* Legacy driver registration */
453 void register_switch_driver(struct dsa_switch_driver *type);
454 void unregister_switch_driver(struct dsa_switch_driver *type);
455 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
457 struct net_device *dsa_dev_to_net_device(struct device *dev);
459 /* Keep inline for faster access in hot path */
460 static inline bool netdev_uses_dsa(struct net_device *dev)
462 #if IS_ENABLED(CONFIG_NET_DSA)
463 return dev->dsa_ptr && dev->dsa_ptr->rcv;
468 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
469 void dsa_unregister_switch(struct dsa_switch *ds);
470 int dsa_register_switch(struct dsa_switch *ds);
471 #ifdef CONFIG_PM_SLEEP
472 int dsa_switch_suspend(struct dsa_switch *ds);
473 int dsa_switch_resume(struct dsa_switch *ds);
475 static inline int dsa_switch_suspend(struct dsa_switch *ds)
479 static inline int dsa_switch_resume(struct dsa_switch *ds)
483 #endif /* CONFIG_PM_SLEEP */