Linux Audio

Check our new training course

Loading...
v3.1
 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#define DSA_MAX_SWITCHES	4
15#define DSA_MAX_PORTS		12
16
17struct dsa_chip_data {
18	/*
19	 * How to access the switch configuration registers.
20	 */
21	struct device	*mii_bus;
22	int		sw_addr;
23
 
 
 
 
 
 
 
 
 
24	/*
25	 * The names of the switch's ports.  Use "cpu" to
26	 * designate the switch port that the cpu is connected to,
27	 * "dsa" to indicate that this port is a DSA link to
28	 * another switch, NULL to indicate the port is unused,
29	 * or any other string to indicate this is a physical port.
30	 */
31	char		*port_names[DSA_MAX_PORTS];
 
32
33	/*
34	 * An array (with nr_chips elements) of which element [a]
35	 * indicates which port on this switch should be used to
36	 * send packets to that are destined for switch a.  Can be
37	 * NULL if there is only one switch chip.
38	 */
39	s8		*rtable;
 
 
 
 
 
 
 
40};
41
42struct dsa_platform_data {
43	/*
44	 * Reference to a Linux network interface that connects
45	 * to the root switch chip of the tree.
46	 */
47	struct device	*netdev;
 
48
49	/*
50	 * Info structs describing each of the switch chips
51	 * connected via this network interface.
52	 */
53	int		nr_chips;
54	struct dsa_chip_data	*chip;
55};
56
57extern bool dsa_uses_dsa_tags(void *dsa_ptr);
58extern bool dsa_uses_trailer_tags(void *dsa_ptr);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
59
 
 
 
 
60
 
 
 
 
61#endif
v4.6
  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/of_gpio.h>
 20#include <linux/phy.h>
 21#include <linux/phy_fixed.h>
 22#include <linux/ethtool.h>
 23
 24enum dsa_tag_protocol {
 25	DSA_TAG_PROTO_NONE = 0,
 26	DSA_TAG_PROTO_DSA,
 27	DSA_TAG_PROTO_TRAILER,
 28	DSA_TAG_PROTO_EDSA,
 29	DSA_TAG_PROTO_BRCM,
 30};
 31
 32#define DSA_MAX_SWITCHES	4
 33#define DSA_MAX_PORTS		12
 34
 35struct dsa_chip_data {
 36	/*
 37	 * How to access the switch configuration registers.
 38	 */
 39	struct device	*host_dev;
 40	int		sw_addr;
 41
 42	/* set to size of eeprom if supported by the switch */
 43	int		eeprom_len;
 44
 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
 48	 */
 49	struct device_node *of_node;
 50
 51	/*
 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.
 57	 */
 58	char		*port_names[DSA_MAX_PORTS];
 59	struct device_node *port_dn[DSA_MAX_PORTS];
 60
 61	/*
 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.
 66	 */
 67	s8		*rtable;
 68
 69	/*
 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
 72	 * switch soft reset.
 73	 */
 74	struct gpio_desc *reset;
 75};
 76
 77struct dsa_platform_data {
 78	/*
 79	 * Reference to a Linux network interface that connects
 80	 * to the root switch chip of the tree.
 81	 */
 82	struct device	*netdev;
 83	struct net_device *of_netdev;
 84
 85	/*
 86	 * Info structs describing each of the switch chips
 87	 * connected via this network interface.
 88	 */
 89	int		nr_chips;
 90	struct dsa_chip_data	*chip;
 91};
 92
 93struct packet_type;
 94
 95struct dsa_switch_tree {
 96	/*
 97	 * Configuration data for the platform device that owns
 98	 * this dsa switch tree instance.
 99	 */
100	struct dsa_platform_data	*pd;
101
102	/*
103	 * Reference to network device to use, and which tagging
104	 * protocol to use.
105	 */
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;
112
113	/*
114	 * The switch and port to which the CPU is attached.
115	 */
116	s8			cpu_switch;
117	s8			cpu_port;
118
119	/*
120	 * Data for the individual switch chips.
121	 */
122	struct dsa_switch	*ds[DSA_MAX_SWITCHES];
123};
124
125struct dsa_switch {
126	/*
127	 * Parent switch tree, and switch index.
128	 */
129	struct dsa_switch_tree	*dst;
130	int			index;
131
132	/*
133	 * Tagging protocol understood by this switch
134	 */
135	enum dsa_tag_protocol	tag_protocol;
136
137	/*
138	 * Configuration data for this switch.
139	 */
140	struct dsa_chip_data	*pd;
141
142	/*
143	 * The used switch driver.
144	 */
145	struct dsa_switch_driver	*drv;
146
147	/*
148	 * Reference to host device to use.
149	 */
150	struct device		*master_dev;
151
152#ifdef CONFIG_NET_DSA_HWMON
153	/*
154	 * Hardware monitoring information
155	 */
156	char			hwmon_name[IFNAMSIZ + 8];
157	struct device		*hwmon_dev;
158#endif
159
160	/*
161	 * Slave mii_bus and devices for the individual ports.
162	 */
163	u32			dsa_port_mask;
164	u32			phys_port_mask;
165	u32			phys_mii_mask;
166	struct mii_bus		*slave_mii_bus;
167	struct net_device	*ports[DSA_MAX_PORTS];
168};
169
170static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
171{
172	return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
173}
174
175static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
176{
177	return !!((ds->dsa_port_mask) & (1 << p));
178}
179
180static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
181{
182	return ds->phys_port_mask & (1 << p) && ds->ports[p];
183}
184
185static inline u8 dsa_upstream_port(struct dsa_switch *ds)
186{
187	struct dsa_switch_tree *dst = ds->dst;
188
189	/*
190	 * If this is the root switch (i.e. the switch that connects
191	 * to the CPU), return the cpu port number on this switch.
192	 * Else return the (DSA) port number that connects to the
193	 * switch that is one hop closer to the cpu.
194	 */
195	if (dst->cpu_switch == ds->index)
196		return dst->cpu_port;
197	else
198		return ds->pd->rtable[dst->cpu_switch];
199}
200
201struct switchdev_trans;
202struct switchdev_obj;
203struct switchdev_obj_port_fdb;
204struct switchdev_obj_port_vlan;
205
206struct dsa_switch_driver {
207	struct list_head	list;
208
209	enum dsa_tag_protocol	tag_protocol;
210	int			priv_size;
211
212	/*
213	 * Probing and setup.
214	 */
215	char	*(*probe)(struct device *host_dev, int sw_addr);
216	int	(*setup)(struct dsa_switch *ds);
217	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
218	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
219
220	/*
221	 * Access to the switch's PHY registers.
222	 */
223	int	(*phy_read)(struct dsa_switch *ds, int port, int regnum);
224	int	(*phy_write)(struct dsa_switch *ds, int port,
225			     int regnum, u16 val);
226
227	/*
228	 * Link state adjustment (called from libphy)
229	 */
230	void	(*adjust_link)(struct dsa_switch *ds, int port,
231				struct phy_device *phydev);
232	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
233				struct fixed_phy_status *st);
234
235	/*
236	 * ethtool hardware statistics.
237	 */
238	void	(*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
239	void	(*get_ethtool_stats)(struct dsa_switch *ds,
240				     int port, uint64_t *data);
241	int	(*get_sset_count)(struct dsa_switch *ds);
242
243	/*
244	 * ethtool Wake-on-LAN
245	 */
246	void	(*get_wol)(struct dsa_switch *ds, int port,
247			   struct ethtool_wolinfo *w);
248	int	(*set_wol)(struct dsa_switch *ds, int port,
249			   struct ethtool_wolinfo *w);
250
251	/*
252	 * Suspend and resume
253	 */
254	int	(*suspend)(struct dsa_switch *ds);
255	int	(*resume)(struct dsa_switch *ds);
256
257	/*
258	 * Port enable/disable
259	 */
260	int	(*port_enable)(struct dsa_switch *ds, int port,
261			       struct phy_device *phy);
262	void	(*port_disable)(struct dsa_switch *ds, int port,
263				struct phy_device *phy);
264
265	/*
266	 * EEE setttings
267	 */
268	int	(*set_eee)(struct dsa_switch *ds, int port,
269			   struct phy_device *phydev,
270			   struct ethtool_eee *e);
271	int	(*get_eee)(struct dsa_switch *ds, int port,
272			   struct ethtool_eee *e);
273
274#ifdef CONFIG_NET_DSA_HWMON
275	/* Hardware monitoring */
276	int	(*get_temp)(struct dsa_switch *ds, int *temp);
277	int	(*get_temp_limit)(struct dsa_switch *ds, int *temp);
278	int	(*set_temp_limit)(struct dsa_switch *ds, int temp);
279	int	(*get_temp_alarm)(struct dsa_switch *ds, bool *alarm);
280#endif
281
282	/* EEPROM access */
283	int	(*get_eeprom_len)(struct dsa_switch *ds);
284	int	(*get_eeprom)(struct dsa_switch *ds,
285			      struct ethtool_eeprom *eeprom, u8 *data);
286	int	(*set_eeprom)(struct dsa_switch *ds,
287			      struct ethtool_eeprom *eeprom, u8 *data);
288
289	/*
290	 * Register access.
291	 */
292	int	(*get_regs_len)(struct dsa_switch *ds, int port);
293	void	(*get_regs)(struct dsa_switch *ds, int port,
294			    struct ethtool_regs *regs, void *p);
295
296	/*
297	 * Bridge integration
298	 */
299	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
300				    struct net_device *bridge);
301	void	(*port_bridge_leave)(struct dsa_switch *ds, int port);
302	int	(*port_stp_update)(struct dsa_switch *ds, int port,
303				   u8 state);
304
305	/*
306	 * VLAN support
307	 */
308	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
309				       bool vlan_filtering);
310	int	(*port_vlan_prepare)(struct dsa_switch *ds, int port,
311				     const struct switchdev_obj_port_vlan *vlan,
312				     struct switchdev_trans *trans);
313	int	(*port_vlan_add)(struct dsa_switch *ds, int port,
314				 const struct switchdev_obj_port_vlan *vlan,
315				 struct switchdev_trans *trans);
316	int	(*port_vlan_del)(struct dsa_switch *ds, int port,
317				 const struct switchdev_obj_port_vlan *vlan);
318	int	(*port_vlan_dump)(struct dsa_switch *ds, int port,
319				  struct switchdev_obj_port_vlan *vlan,
320				  int (*cb)(struct switchdev_obj *obj));
321
322	/*
323	 * Forwarding database
324	 */
325	int	(*port_fdb_prepare)(struct dsa_switch *ds, int port,
326				    const struct switchdev_obj_port_fdb *fdb,
327				    struct switchdev_trans *trans);
328	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
329				const struct switchdev_obj_port_fdb *fdb,
330				struct switchdev_trans *trans);
331	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
332				const struct switchdev_obj_port_fdb *fdb);
333	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
334				 struct switchdev_obj_port_fdb *fdb,
335				 int (*cb)(struct switchdev_obj *obj));
336};
337
338void register_switch_driver(struct dsa_switch_driver *type);
339void unregister_switch_driver(struct dsa_switch_driver *type);
340struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
341
342static inline void *ds_to_priv(struct dsa_switch *ds)
343{
344	return (void *)(ds + 1);
345}
346
347static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
348{
349	return dst->rcv != NULL;
350}
351#endif