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
14 #include <linux/if_ether.h>
15 #include <linux/list.h>
16 #include <linux/timer.h>
17 #include <linux/workqueue.h>
19 #include <linux/phy.h>
20 #include <linux/phy_fixed.h>
21 #include <linux/ethtool.h>
23 enum dsa_tag_protocol {
24 DSA_TAG_PROTO_NONE = 0,
26 DSA_TAG_PROTO_TRAILER,
30 DSA_TAG_LAST, /* MUST BE LAST */
33 #define DSA_MAX_SWITCHES 4
34 #define DSA_MAX_PORTS 12
36 #define DSA_RTABLE_NONE -1
38 struct dsa_chip_data {
40 * How to access the switch configuration registers.
42 struct device *host_dev;
45 /* set to size of eeprom if supported by the switch */
48 /* Device tree node pointer for this specific switch chip
49 * used during switch setup in case additional properties
50 * and resources needs to be used
52 struct device_node *of_node;
55 * The names of the switch's ports. Use "cpu" to
56 * designate the switch port that the cpu is connected to,
57 * "dsa" to indicate that this port is a DSA link to
58 * another switch, NULL to indicate the port is unused,
59 * or any other string to indicate this is a physical port.
61 char *port_names[DSA_MAX_PORTS];
62 struct device_node *port_dn[DSA_MAX_PORTS];
65 * An array of which element [a] indicates which port on this
66 * switch should be used to send packets to that are destined
67 * for switch a. Can be NULL if there is only one switch chip.
69 s8 rtable[DSA_MAX_SWITCHES];
72 struct dsa_platform_data {
74 * Reference to a Linux network interface that connects
75 * to the root switch chip of the tree.
77 struct device *netdev;
78 struct net_device *of_netdev;
81 * Info structs describing each of the switch chips
82 * connected via this network interface.
85 struct dsa_chip_data *chip;
90 struct dsa_switch_tree {
91 struct list_head list;
96 /* Number of switches attached to this tree */
99 /* Has this tree been applied to the hardware? */
103 * Configuration data for the platform device that owns
104 * this dsa switch tree instance.
106 struct dsa_platform_data *pd;
109 * Reference to network device to use, and which tagging
112 struct net_device *master_netdev;
113 int (*rcv)(struct sk_buff *skb,
114 struct net_device *dev,
115 struct packet_type *pt,
116 struct net_device *orig_dev);
119 * Original copy of the master netdev ethtool_ops
121 struct ethtool_ops master_ethtool_ops;
122 const struct ethtool_ops *master_orig_ethtool_ops;
125 * The switch and port to which the CPU is attached.
127 struct dsa_switch *cpu_switch;
131 * Data for the individual switch chips.
133 struct dsa_switch *ds[DSA_MAX_SWITCHES];
136 * Tagging protocol operations for adding and removing an
139 const struct dsa_device_ops *tag_ops;
143 struct net_device *netdev;
144 struct device_node *dn;
145 unsigned int ageing_time;
153 * Parent switch tree, and switch index.
155 struct dsa_switch_tree *dst;
159 * Give the switch driver somewhere to hang its private data
165 * Configuration data for this switch.
167 struct dsa_chip_data *cd;
170 * The switch operations.
172 const struct dsa_switch_ops *ops;
175 * An array of which element [a] indicates which port on this
176 * switch should be used to send packets to that are destined
177 * for switch a. Can be NULL if there is only one switch chip.
179 s8 rtable[DSA_MAX_SWITCHES];
181 #ifdef CONFIG_NET_DSA_HWMON
183 * Hardware monitoring information
185 char hwmon_name[IFNAMSIZ + 8];
186 struct device *hwmon_dev;
190 * The lower device this switch uses to talk to the host
192 struct net_device *master_netdev;
195 * Slave mii_bus and devices for the individual ports.
199 u32 enabled_port_mask;
201 struct dsa_port ports[DSA_MAX_PORTS];
202 struct mii_bus *slave_mii_bus;
205 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
207 return !!(ds == ds->dst->cpu_switch && p == ds->dst->cpu_port);
210 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
212 return !!((ds->dsa_port_mask) & (1 << p));
215 static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
217 return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev;
220 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
222 struct dsa_switch_tree *dst = ds->dst;
225 * If this is the root switch (i.e. the switch that connects
226 * to the CPU), return the cpu port number on this switch.
227 * Else return the (DSA) port number that connects to the
228 * switch that is one hop closer to the cpu.
230 if (dst->cpu_switch == ds)
231 return dst->cpu_port;
233 return ds->rtable[dst->cpu_switch->index];
236 struct switchdev_trans;
237 struct switchdev_obj;
238 struct switchdev_obj_port_fdb;
239 struct switchdev_obj_port_mdb;
240 struct switchdev_obj_port_vlan;
242 struct dsa_switch_ops {
246 const char *(*probe)(struct device *dsa_dev,
247 struct device *host_dev, int sw_addr,
250 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
252 int (*setup)(struct dsa_switch *ds);
253 int (*set_addr)(struct dsa_switch *ds, u8 *addr);
254 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
257 * Access to the switch's PHY registers.
259 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
260 int (*phy_write)(struct dsa_switch *ds, int port,
261 int regnum, u16 val);
264 * Link state adjustment (called from libphy)
266 void (*adjust_link)(struct dsa_switch *ds, int port,
267 struct phy_device *phydev);
268 void (*fixed_link_update)(struct dsa_switch *ds, int port,
269 struct fixed_phy_status *st);
272 * ethtool hardware statistics.
274 void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
275 void (*get_ethtool_stats)(struct dsa_switch *ds,
276 int port, uint64_t *data);
277 int (*get_sset_count)(struct dsa_switch *ds);
280 * ethtool Wake-on-LAN
282 void (*get_wol)(struct dsa_switch *ds, int port,
283 struct ethtool_wolinfo *w);
284 int (*set_wol)(struct dsa_switch *ds, int port,
285 struct ethtool_wolinfo *w);
290 int (*suspend)(struct dsa_switch *ds);
291 int (*resume)(struct dsa_switch *ds);
294 * Port enable/disable
296 int (*port_enable)(struct dsa_switch *ds, int port,
297 struct phy_device *phy);
298 void (*port_disable)(struct dsa_switch *ds, int port,
299 struct phy_device *phy);
304 int (*set_eee)(struct dsa_switch *ds, int port,
305 struct phy_device *phydev,
306 struct ethtool_eee *e);
307 int (*get_eee)(struct dsa_switch *ds, int port,
308 struct ethtool_eee *e);
311 int (*get_eeprom_len)(struct dsa_switch *ds);
312 int (*get_eeprom)(struct dsa_switch *ds,
313 struct ethtool_eeprom *eeprom, u8 *data);
314 int (*set_eeprom)(struct dsa_switch *ds,
315 struct ethtool_eeprom *eeprom, u8 *data);
320 int (*get_regs_len)(struct dsa_switch *ds, int port);
321 void (*get_regs)(struct dsa_switch *ds, int port,
322 struct ethtool_regs *regs, void *p);
327 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
328 int (*port_bridge_join)(struct dsa_switch *ds, int port,
329 struct net_device *bridge);
330 void (*port_bridge_leave)(struct dsa_switch *ds, int port);
331 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
333 void (*port_fast_age)(struct dsa_switch *ds, int port);
338 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
339 bool vlan_filtering);
340 int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
341 const struct switchdev_obj_port_vlan *vlan,
342 struct switchdev_trans *trans);
343 void (*port_vlan_add)(struct dsa_switch *ds, int port,
344 const struct switchdev_obj_port_vlan *vlan,
345 struct switchdev_trans *trans);
346 int (*port_vlan_del)(struct dsa_switch *ds, int port,
347 const struct switchdev_obj_port_vlan *vlan);
348 int (*port_vlan_dump)(struct dsa_switch *ds, int port,
349 struct switchdev_obj_port_vlan *vlan,
350 int (*cb)(struct switchdev_obj *obj));
353 * Forwarding database
355 int (*port_fdb_prepare)(struct dsa_switch *ds, int port,
356 const struct switchdev_obj_port_fdb *fdb,
357 struct switchdev_trans *trans);
358 void (*port_fdb_add)(struct dsa_switch *ds, int port,
359 const struct switchdev_obj_port_fdb *fdb,
360 struct switchdev_trans *trans);
361 int (*port_fdb_del)(struct dsa_switch *ds, int port,
362 const struct switchdev_obj_port_fdb *fdb);
363 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
364 struct switchdev_obj_port_fdb *fdb,
365 int (*cb)(struct switchdev_obj *obj));
370 int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
371 const struct switchdev_obj_port_mdb *mdb,
372 struct switchdev_trans *trans);
373 void (*port_mdb_add)(struct dsa_switch *ds, int port,
374 const struct switchdev_obj_port_mdb *mdb,
375 struct switchdev_trans *trans);
376 int (*port_mdb_del)(struct dsa_switch *ds, int port,
377 const struct switchdev_obj_port_mdb *mdb);
378 int (*port_mdb_dump)(struct dsa_switch *ds, int port,
379 struct switchdev_obj_port_mdb *mdb,
380 int (*cb)(struct switchdev_obj *obj));
383 struct dsa_switch_driver {
384 struct list_head list;
385 const struct dsa_switch_ops *ops;
388 void register_switch_driver(struct dsa_switch_driver *type);
389 void unregister_switch_driver(struct dsa_switch_driver *type);
390 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
392 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
394 return dst->rcv != NULL;
397 void dsa_unregister_switch(struct dsa_switch *ds);
398 int dsa_register_switch(struct dsa_switch *ds, struct device_node *np);
399 #ifdef CONFIG_PM_SLEEP
400 int dsa_switch_suspend(struct dsa_switch *ds);
401 int dsa_switch_resume(struct dsa_switch *ds);
403 static inline int dsa_switch_suspend(struct dsa_switch *ds)
407 static inline int dsa_switch_resume(struct dsa_switch *ds)
411 #endif /* CONFIG_PM_SLEEP */