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/of_gpio.h>
20 #include <linux/phy.h>
21 #include <linux/phy_fixed.h>
22 #include <linux/ethtool.h>
24 enum dsa_tag_protocol
{
25 DSA_TAG_PROTO_NONE
= 0,
27 DSA_TAG_PROTO_TRAILER
,
32 #define DSA_MAX_SWITCHES 4
33 #define DSA_MAX_PORTS 12
35 struct dsa_chip_data
{
37 * How to access the switch configuration registers.
39 struct device
*host_dev
;
42 /* set to size of eeprom if supported by the switch */
45 /* Device tree node pointer for this specific switch chip
46 * used during switch setup in case additional properties
47 * and resources needs to be used
49 struct device_node
*of_node
;
52 * The names of the switch's ports. Use "cpu" to
53 * designate the switch port that the cpu is connected to,
54 * "dsa" to indicate that this port is a DSA link to
55 * another switch, NULL to indicate the port is unused,
56 * or any other string to indicate this is a physical port.
58 char *port_names
[DSA_MAX_PORTS
];
59 struct device_node
*port_dn
[DSA_MAX_PORTS
];
62 * An array (with nr_chips elements) of which element [a]
63 * indicates which port on this switch should be used to
64 * send packets to that are destined for switch a. Can be
65 * NULL if there is only one switch chip.
70 * A switch may have a GPIO line tied to its reset pin. Parse
71 * this from the device tree, and use it before performing
74 struct gpio_desc
*reset
;
77 struct dsa_platform_data
{
79 * Reference to a Linux network interface that connects
80 * to the root switch chip of the tree.
82 struct device
*netdev
;
83 struct net_device
*of_netdev
;
86 * Info structs describing each of the switch chips
87 * connected via this network interface.
90 struct dsa_chip_data
*chip
;
95 struct dsa_switch_tree
{
97 * Configuration data for the platform device that owns
98 * this dsa switch tree instance.
100 struct dsa_platform_data
*pd
;
103 * Reference to network device to use, and which tagging
106 struct net_device
*master_netdev
;
107 int (*rcv
)(struct sk_buff
*skb
,
108 struct net_device
*dev
,
109 struct packet_type
*pt
,
110 struct net_device
*orig_dev
);
111 enum dsa_tag_protocol tag_protocol
;
114 * The switch and port to which the CPU is attached.
120 * Data for the individual switch chips.
122 struct dsa_switch
*ds
[DSA_MAX_SWITCHES
];
127 * Parent switch tree, and switch index.
129 struct dsa_switch_tree
*dst
;
133 * Give the switch driver somewhere to hang its private data
139 * Tagging protocol understood by this switch
141 enum dsa_tag_protocol tag_protocol
;
144 * Configuration data for this switch.
146 struct dsa_chip_data
*pd
;
149 * The used switch driver.
151 struct dsa_switch_driver
*drv
;
154 * Reference to host device to use.
156 struct device
*master_dev
;
158 #ifdef CONFIG_NET_DSA_HWMON
160 * Hardware monitoring information
162 char hwmon_name
[IFNAMSIZ
+ 8];
163 struct device
*hwmon_dev
;
167 * Slave mii_bus and devices for the individual ports.
170 u32 enabled_port_mask
;
172 struct mii_bus
*slave_mii_bus
;
173 struct net_device
*ports
[DSA_MAX_PORTS
];
176 static inline bool dsa_is_cpu_port(struct dsa_switch
*ds
, int p
)
178 return !!(ds
->index
== ds
->dst
->cpu_switch
&& p
== ds
->dst
->cpu_port
);
181 static inline bool dsa_is_dsa_port(struct dsa_switch
*ds
, int p
)
183 return !!((ds
->dsa_port_mask
) & (1 << p
));
186 static inline bool dsa_is_port_initialized(struct dsa_switch
*ds
, int p
)
188 return ds
->enabled_port_mask
& (1 << p
) && ds
->ports
[p
];
191 static inline u8
dsa_upstream_port(struct dsa_switch
*ds
)
193 struct dsa_switch_tree
*dst
= ds
->dst
;
196 * If this is the root switch (i.e. the switch that connects
197 * to the CPU), return the cpu port number on this switch.
198 * Else return the (DSA) port number that connects to the
199 * switch that is one hop closer to the cpu.
201 if (dst
->cpu_switch
== ds
->index
)
202 return dst
->cpu_port
;
204 return ds
->pd
->rtable
[dst
->cpu_switch
];
207 struct switchdev_trans
;
208 struct switchdev_obj
;
209 struct switchdev_obj_port_fdb
;
210 struct switchdev_obj_port_vlan
;
212 struct dsa_switch_driver
{
213 struct list_head list
;
215 enum dsa_tag_protocol tag_protocol
;
220 char *(*probe
)(struct device
*dsa_dev
, struct device
*host_dev
,
221 int sw_addr
, void **priv
);
222 int (*setup
)(struct dsa_switch
*ds
);
223 int (*set_addr
)(struct dsa_switch
*ds
, u8
*addr
);
224 u32 (*get_phy_flags
)(struct dsa_switch
*ds
, int port
);
227 * Access to the switch's PHY registers.
229 int (*phy_read
)(struct dsa_switch
*ds
, int port
, int regnum
);
230 int (*phy_write
)(struct dsa_switch
*ds
, int port
,
231 int regnum
, u16 val
);
234 * Link state adjustment (called from libphy)
236 void (*adjust_link
)(struct dsa_switch
*ds
, int port
,
237 struct phy_device
*phydev
);
238 void (*fixed_link_update
)(struct dsa_switch
*ds
, int port
,
239 struct fixed_phy_status
*st
);
242 * ethtool hardware statistics.
244 void (*get_strings
)(struct dsa_switch
*ds
, int port
, uint8_t *data
);
245 void (*get_ethtool_stats
)(struct dsa_switch
*ds
,
246 int port
, uint64_t *data
);
247 int (*get_sset_count
)(struct dsa_switch
*ds
);
250 * ethtool Wake-on-LAN
252 void (*get_wol
)(struct dsa_switch
*ds
, int port
,
253 struct ethtool_wolinfo
*w
);
254 int (*set_wol
)(struct dsa_switch
*ds
, int port
,
255 struct ethtool_wolinfo
*w
);
260 int (*suspend
)(struct dsa_switch
*ds
);
261 int (*resume
)(struct dsa_switch
*ds
);
264 * Port enable/disable
266 int (*port_enable
)(struct dsa_switch
*ds
, int port
,
267 struct phy_device
*phy
);
268 void (*port_disable
)(struct dsa_switch
*ds
, int port
,
269 struct phy_device
*phy
);
274 int (*set_eee
)(struct dsa_switch
*ds
, int port
,
275 struct phy_device
*phydev
,
276 struct ethtool_eee
*e
);
277 int (*get_eee
)(struct dsa_switch
*ds
, int port
,
278 struct ethtool_eee
*e
);
280 #ifdef CONFIG_NET_DSA_HWMON
281 /* Hardware monitoring */
282 int (*get_temp
)(struct dsa_switch
*ds
, int *temp
);
283 int (*get_temp_limit
)(struct dsa_switch
*ds
, int *temp
);
284 int (*set_temp_limit
)(struct dsa_switch
*ds
, int temp
);
285 int (*get_temp_alarm
)(struct dsa_switch
*ds
, bool *alarm
);
289 int (*get_eeprom_len
)(struct dsa_switch
*ds
);
290 int (*get_eeprom
)(struct dsa_switch
*ds
,
291 struct ethtool_eeprom
*eeprom
, u8
*data
);
292 int (*set_eeprom
)(struct dsa_switch
*ds
,
293 struct ethtool_eeprom
*eeprom
, u8
*data
);
298 int (*get_regs_len
)(struct dsa_switch
*ds
, int port
);
299 void (*get_regs
)(struct dsa_switch
*ds
, int port
,
300 struct ethtool_regs
*regs
, void *p
);
305 int (*port_bridge_join
)(struct dsa_switch
*ds
, int port
,
306 struct net_device
*bridge
);
307 void (*port_bridge_leave
)(struct dsa_switch
*ds
, int port
);
308 void (*port_stp_state_set
)(struct dsa_switch
*ds
, int port
,
314 int (*port_vlan_filtering
)(struct dsa_switch
*ds
, int port
,
315 bool vlan_filtering
);
316 int (*port_vlan_prepare
)(struct dsa_switch
*ds
, int port
,
317 const struct switchdev_obj_port_vlan
*vlan
,
318 struct switchdev_trans
*trans
);
319 void (*port_vlan_add
)(struct dsa_switch
*ds
, int port
,
320 const struct switchdev_obj_port_vlan
*vlan
,
321 struct switchdev_trans
*trans
);
322 int (*port_vlan_del
)(struct dsa_switch
*ds
, int port
,
323 const struct switchdev_obj_port_vlan
*vlan
);
324 int (*port_vlan_dump
)(struct dsa_switch
*ds
, int port
,
325 struct switchdev_obj_port_vlan
*vlan
,
326 int (*cb
)(struct switchdev_obj
*obj
));
329 * Forwarding database
331 int (*port_fdb_prepare
)(struct dsa_switch
*ds
, int port
,
332 const struct switchdev_obj_port_fdb
*fdb
,
333 struct switchdev_trans
*trans
);
334 void (*port_fdb_add
)(struct dsa_switch
*ds
, int port
,
335 const struct switchdev_obj_port_fdb
*fdb
,
336 struct switchdev_trans
*trans
);
337 int (*port_fdb_del
)(struct dsa_switch
*ds
, int port
,
338 const struct switchdev_obj_port_fdb
*fdb
);
339 int (*port_fdb_dump
)(struct dsa_switch
*ds
, int port
,
340 struct switchdev_obj_port_fdb
*fdb
,
341 int (*cb
)(struct switchdev_obj
*obj
));
344 void register_switch_driver(struct dsa_switch_driver
*type
);
345 void unregister_switch_driver(struct dsa_switch_driver
*type
);
346 struct mii_bus
*dsa_host_dev_to_mii_bus(struct device
*dev
);
348 static inline void *ds_to_priv(struct dsa_switch
*ds
)
353 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree
*dst
)
355 return dst
->rcv
!= NULL
;