xref: /linux/include/net/dsa.h (revision 6793abb4e8491b1d673ccfd09e1a73d1ff8b9386)
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_ether.h>
15 #include <linux/list.h>
16 #include <linux/timer.h>
17 #include <linux/workqueue.h>
18 #include <linux/of.h>
19 #include <linux/phy.h>
20 #include <linux/phy_fixed.h>
21 #include <linux/ethtool.h>
22 
23 enum dsa_tag_protocol {
24 	DSA_TAG_PROTO_NONE = 0,
25 	DSA_TAG_PROTO_DSA,
26 	DSA_TAG_PROTO_TRAILER,
27 	DSA_TAG_PROTO_EDSA,
28 	DSA_TAG_PROTO_BRCM,
29 };
30 
31 #define DSA_MAX_SWITCHES	4
32 #define DSA_MAX_PORTS		12
33 
34 struct dsa_chip_data {
35 	/*
36 	 * How to access the switch configuration registers.
37 	 */
38 	struct device	*host_dev;
39 	int		sw_addr;
40 
41 	/* set to size of eeprom if supported by the switch */
42 	int		eeprom_len;
43 
44 	/* Device tree node pointer for this specific switch chip
45 	 * used during switch setup in case additional properties
46 	 * and resources needs to be used
47 	 */
48 	struct device_node *of_node;
49 
50 	/*
51 	 * The names of the switch's ports.  Use "cpu" to
52 	 * designate the switch port that the cpu is connected to,
53 	 * "dsa" to indicate that this port is a DSA link to
54 	 * another switch, NULL to indicate the port is unused,
55 	 * or any other string to indicate this is a physical port.
56 	 */
57 	char		*port_names[DSA_MAX_PORTS];
58 	struct device_node *port_dn[DSA_MAX_PORTS];
59 
60 	/*
61 	 * An array (with nr_chips elements) of which element [a]
62 	 * indicates which port on this switch should be used to
63 	 * send packets to that are destined for switch a.  Can be
64 	 * NULL if there is only one switch chip.
65 	 */
66 	s8		*rtable;
67 };
68 
69 struct dsa_platform_data {
70 	/*
71 	 * Reference to a Linux network interface that connects
72 	 * to the root switch chip of the tree.
73 	 */
74 	struct device	*netdev;
75 
76 	/*
77 	 * Info structs describing each of the switch chips
78 	 * connected via this network interface.
79 	 */
80 	int		nr_chips;
81 	struct dsa_chip_data	*chip;
82 };
83 
84 struct packet_type;
85 
86 struct dsa_switch_tree {
87 	/*
88 	 * Configuration data for the platform device that owns
89 	 * this dsa switch tree instance.
90 	 */
91 	struct dsa_platform_data	*pd;
92 
93 	/*
94 	 * Reference to network device to use, and which tagging
95 	 * protocol to use.
96 	 */
97 	struct net_device	*master_netdev;
98 	int			(*rcv)(struct sk_buff *skb,
99 				       struct net_device *dev,
100 				       struct packet_type *pt,
101 				       struct net_device *orig_dev);
102 	enum dsa_tag_protocol	tag_protocol;
103 
104 	/*
105 	 * The switch and port to which the CPU is attached.
106 	 */
107 	s8			cpu_switch;
108 	s8			cpu_port;
109 
110 	/*
111 	 * Link state polling.
112 	 */
113 	int			link_poll_needed;
114 	struct work_struct	link_poll_work;
115 	struct timer_list	link_poll_timer;
116 
117 	/*
118 	 * Data for the individual switch chips.
119 	 */
120 	struct dsa_switch	*ds[DSA_MAX_SWITCHES];
121 };
122 
123 struct dsa_switch {
124 	/*
125 	 * Parent switch tree, and switch index.
126 	 */
127 	struct dsa_switch_tree	*dst;
128 	int			index;
129 
130 	/*
131 	 * Configuration data for this switch.
132 	 */
133 	struct dsa_chip_data	*pd;
134 
135 	/*
136 	 * The used switch driver.
137 	 */
138 	struct dsa_switch_driver	*drv;
139 
140 	/*
141 	 * Reference to host device to use.
142 	 */
143 	struct device		*master_dev;
144 
145 #ifdef CONFIG_NET_DSA_HWMON
146 	/*
147 	 * Hardware monitoring information
148 	 */
149 	char			hwmon_name[IFNAMSIZ + 8];
150 	struct device		*hwmon_dev;
151 #endif
152 
153 	/*
154 	 * Slave mii_bus and devices for the individual ports.
155 	 */
156 	u32			dsa_port_mask;
157 	u32			phys_port_mask;
158 	u32			phys_mii_mask;
159 	struct mii_bus		*slave_mii_bus;
160 	struct net_device	*ports[DSA_MAX_PORTS];
161 };
162 
163 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
164 {
165 	return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
166 }
167 
168 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
169 {
170 	struct dsa_switch_tree *dst = ds->dst;
171 
172 	/*
173 	 * If this is the root switch (i.e. the switch that connects
174 	 * to the CPU), return the cpu port number on this switch.
175 	 * Else return the (DSA) port number that connects to the
176 	 * switch that is one hop closer to the cpu.
177 	 */
178 	if (dst->cpu_switch == ds->index)
179 		return dst->cpu_port;
180 	else
181 		return ds->pd->rtable[dst->cpu_switch];
182 }
183 
184 struct dsa_switch_driver {
185 	struct list_head	list;
186 
187 	enum dsa_tag_protocol	tag_protocol;
188 	int			priv_size;
189 
190 	/*
191 	 * Probing and setup.
192 	 */
193 	char	*(*probe)(struct device *host_dev, int sw_addr);
194 	int	(*setup)(struct dsa_switch *ds);
195 	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
196 	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
197 
198 	/*
199 	 * Access to the switch's PHY registers.
200 	 */
201 	int	(*phy_read)(struct dsa_switch *ds, int port, int regnum);
202 	int	(*phy_write)(struct dsa_switch *ds, int port,
203 			     int regnum, u16 val);
204 
205 	/*
206 	 * Link state polling and IRQ handling.
207 	 */
208 	void	(*poll_link)(struct dsa_switch *ds);
209 
210 	/*
211 	 * Link state adjustment (called from libphy)
212 	 */
213 	void	(*adjust_link)(struct dsa_switch *ds, int port,
214 				struct phy_device *phydev);
215 	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
216 				struct fixed_phy_status *st);
217 
218 	/*
219 	 * ethtool hardware statistics.
220 	 */
221 	void	(*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
222 	void	(*get_ethtool_stats)(struct dsa_switch *ds,
223 				     int port, uint64_t *data);
224 	int	(*get_sset_count)(struct dsa_switch *ds);
225 
226 	/*
227 	 * ethtool Wake-on-LAN
228 	 */
229 	void	(*get_wol)(struct dsa_switch *ds, int port,
230 			   struct ethtool_wolinfo *w);
231 	int	(*set_wol)(struct dsa_switch *ds, int port,
232 			   struct ethtool_wolinfo *w);
233 
234 	/*
235 	 * Suspend and resume
236 	 */
237 	int	(*suspend)(struct dsa_switch *ds);
238 	int	(*resume)(struct dsa_switch *ds);
239 
240 	/*
241 	 * Port enable/disable
242 	 */
243 	int	(*port_enable)(struct dsa_switch *ds, int port,
244 			       struct phy_device *phy);
245 	void	(*port_disable)(struct dsa_switch *ds, int port,
246 				struct phy_device *phy);
247 
248 	/*
249 	 * EEE setttings
250 	 */
251 	int	(*set_eee)(struct dsa_switch *ds, int port,
252 			   struct phy_device *phydev,
253 			   struct ethtool_eee *e);
254 	int	(*get_eee)(struct dsa_switch *ds, int port,
255 			   struct ethtool_eee *e);
256 
257 #ifdef CONFIG_NET_DSA_HWMON
258 	/* Hardware monitoring */
259 	int	(*get_temp)(struct dsa_switch *ds, int *temp);
260 	int	(*get_temp_limit)(struct dsa_switch *ds, int *temp);
261 	int	(*set_temp_limit)(struct dsa_switch *ds, int temp);
262 	int	(*get_temp_alarm)(struct dsa_switch *ds, bool *alarm);
263 #endif
264 
265 	/* EEPROM access */
266 	int	(*get_eeprom_len)(struct dsa_switch *ds);
267 	int	(*get_eeprom)(struct dsa_switch *ds,
268 			      struct ethtool_eeprom *eeprom, u8 *data);
269 	int	(*set_eeprom)(struct dsa_switch *ds,
270 			      struct ethtool_eeprom *eeprom, u8 *data);
271 };
272 
273 void register_switch_driver(struct dsa_switch_driver *type);
274 void unregister_switch_driver(struct dsa_switch_driver *type);
275 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
276 
277 static inline void *ds_to_priv(struct dsa_switch *ds)
278 {
279 	return (void *)(ds + 1);
280 }
281 
282 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
283 {
284 	return dst->rcv != NULL;
285 }
286 #endif
287