]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/dsa.h
net: dsa: Encapsulate legacy switch drivers into dsa_switch_driver
[mirror_ubuntu-bionic-kernel.git] / include / net / dsa.h
CommitLineData
91da11f8
LB
1/*
2 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
e84665c9 3 * Copyright (c) 2008-2009 Marvell Semiconductor
91da11f8
LB
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
ea1f51be 14#include <linux/if_ether.h>
c8f0b869 15#include <linux/list.h>
cf50dcc2
BH
16#include <linux/timer.h>
17#include <linux/workqueue.h>
fa981d9a 18#include <linux/of.h>
ec9436ba 19#include <linux/phy.h>
ce31b31c 20#include <linux/phy_fixed.h>
a2820543 21#include <linux/ethtool.h>
cf50dcc2 22
ac7a04c3
FF
23enum 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,
cafdc45c 29 DSA_TAG_PROTO_QCA,
39a7f2a4 30 DSA_TAG_LAST, /* MUST BE LAST */
ac7a04c3 31};
5037d532 32
e84665c9
LB
33#define DSA_MAX_SWITCHES 4
34#define DSA_MAX_PORTS 12
35
d390238c
VD
36#define DSA_RTABLE_NONE -1
37
e84665c9
LB
38struct dsa_chip_data {
39 /*
40 * How to access the switch configuration registers.
41 */
b4d2394d 42 struct device *host_dev;
e84665c9
LB
43 int sw_addr;
44
6793abb4
GR
45 /* set to size of eeprom if supported by the switch */
46 int eeprom_len;
47
fa981d9a
FF
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
51 */
52 struct device_node *of_node;
53
e84665c9
LB
54 /*
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.
60 */
61 char *port_names[DSA_MAX_PORTS];
bd47497a 62 struct device_node *port_dn[DSA_MAX_PORTS];
e84665c9
LB
63
64 /*
4a7704ff
AL
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.
e84665c9 68 */
4a7704ff 69 s8 rtable[DSA_MAX_SWITCHES];
e84665c9 70};
91da11f8
LB
71
72struct dsa_platform_data {
73 /*
74 * Reference to a Linux network interface that connects
e84665c9 75 * to the root switch chip of the tree.
91da11f8
LB
76 */
77 struct device *netdev;
769a0202 78 struct net_device *of_netdev;
91da11f8
LB
79
80 /*
e84665c9
LB
81 * Info structs describing each of the switch chips
82 * connected via this network interface.
91da11f8 83 */
e84665c9
LB
84 int nr_chips;
85 struct dsa_chip_data *chip;
91da11f8
LB
86};
87
5075314e 88struct packet_type;
3e8a72d1 89
cf50dcc2 90struct dsa_switch_tree {
83c0afae
AL
91 struct list_head list;
92
93 /* Tree identifier */
94 u32 tree;
95
96 /* Number of switches attached to this tree */
97 struct kref refcount;
98
99 /* Has this tree been applied to the hardware? */
100 bool applied;
101
cf50dcc2
BH
102 /*
103 * Configuration data for the platform device that owns
104 * this dsa switch tree instance.
105 */
106 struct dsa_platform_data *pd;
107
108 /*
109 * Reference to network device to use, and which tagging
110 * protocol to use.
111 */
112 struct net_device *master_netdev;
5075314e
AD
113 int (*rcv)(struct sk_buff *skb,
114 struct net_device *dev,
115 struct packet_type *pt,
116 struct net_device *orig_dev);
cf50dcc2 117
badf3ada
FF
118 /*
119 * Original copy of the master netdev ethtool_ops
120 */
121 struct ethtool_ops master_ethtool_ops;
0c73c523 122 const struct ethtool_ops *master_orig_ethtool_ops;
badf3ada 123
cf50dcc2
BH
124 /*
125 * The switch and port to which the CPU is attached.
126 */
127 s8 cpu_switch;
128 s8 cpu_port;
129
cf50dcc2
BH
130 /*
131 * Data for the individual switch chips.
132 */
133 struct dsa_switch *ds[DSA_MAX_SWITCHES];
39a7f2a4
AL
134
135 /*
136 * Tagging protocol operations for adding and removing an
137 * encapsulation tag.
138 */
139 const struct dsa_device_ops *tag_ops;
cf50dcc2
BH
140};
141
c8b09808
AL
142struct dsa_port {
143 struct net_device *netdev;
189b0d93 144 struct device_node *dn;
34a79f63 145 unsigned int ageing_time;
732f794c 146 u8 stp_state;
c8b09808
AL
147};
148
c8f0b869 149struct dsa_switch {
c33063d6
AL
150 struct device *dev;
151
c8f0b869
BH
152 /*
153 * Parent switch tree, and switch index.
154 */
155 struct dsa_switch_tree *dst;
156 int index;
157
7543a6d5
AL
158 /*
159 * Give the switch driver somewhere to hang its private data
160 * structure.
161 */
162 void *priv;
163
c8f0b869
BH
164 /*
165 * Configuration data for this switch.
166 */
ff04955c 167 struct dsa_chip_data *cd;
c8f0b869
BH
168
169 /*
9d490b4e 170 * The switch operations.
c8f0b869 171 */
9d490b4e 172 struct dsa_switch_ops *ops;
c8f0b869 173
66472fc0
AL
174 /*
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.
178 */
179 s8 rtable[DSA_MAX_SWITCHES];
180
51579c3f
GR
181#ifdef CONFIG_NET_DSA_HWMON
182 /*
183 * Hardware monitoring information
184 */
185 char hwmon_name[IFNAMSIZ + 8];
186 struct device *hwmon_dev;
187#endif
188
83c0afae
AL
189 /*
190 * The lower device this switch uses to talk to the host
191 */
192 struct net_device *master_netdev;
193
c8f0b869
BH
194 /*
195 * Slave mii_bus and devices for the individual ports.
196 */
197 u32 dsa_port_mask;
83c0afae 198 u32 cpu_port_mask;
74c3e2a5 199 u32 enabled_port_mask;
0d8bcdd3 200 u32 phys_mii_mask;
c8b09808 201 struct dsa_port ports[DSA_MAX_PORTS];
c8f0b869 202 struct mii_bus *slave_mii_bus;
c8f0b869
BH
203};
204
205static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
206{
207 return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
208}
209
60045cbf
AL
210static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
211{
212 return !!((ds->dsa_port_mask) & (1 << p));
213}
214
d79d2107
GR
215static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
216{
c8b09808 217 return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev;
d79d2107
GR
218}
219
c8f0b869
BH
220static inline u8 dsa_upstream_port(struct dsa_switch *ds)
221{
222 struct dsa_switch_tree *dst = ds->dst;
223
224 /*
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.
229 */
230 if (dst->cpu_switch == ds->index)
231 return dst->cpu_port;
232 else
66472fc0 233 return ds->rtable[dst->cpu_switch];
c8f0b869
BH
234}
235
146a3206 236struct switchdev_trans;
ea70ba98 237struct switchdev_obj;
146a3206 238struct switchdev_obj_port_fdb;
8df30255 239struct switchdev_obj_port_mdb;
76e398a6 240struct switchdev_obj_port_vlan;
146a3206 241
9d490b4e 242struct dsa_switch_ops {
c8f0b869
BH
243 /*
244 * Probing and setup.
245 */
0209d144
VD
246 const char *(*probe)(struct device *dsa_dev,
247 struct device *host_dev, int sw_addr,
248 void **priv);
7b314362
AL
249
250 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
251
c8f0b869
BH
252 int (*setup)(struct dsa_switch *ds);
253 int (*set_addr)(struct dsa_switch *ds, u8 *addr);
6819563e 254 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
c8f0b869
BH
255
256 /*
257 * Access to the switch's PHY registers.
258 */
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);
262
ec9436ba
FF
263 /*
264 * Link state adjustment (called from libphy)
265 */
266 void (*adjust_link)(struct dsa_switch *ds, int port,
267 struct phy_device *phydev);
ce31b31c
FF
268 void (*fixed_link_update)(struct dsa_switch *ds, int port,
269 struct fixed_phy_status *st);
ec9436ba 270
c8f0b869
BH
271 /*
272 * ethtool hardware statistics.
273 */
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);
24462549 278
19e57c4e
FF
279 /*
280 * ethtool Wake-on-LAN
281 */
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);
286
24462549
FF
287 /*
288 * Suspend and resume
289 */
290 int (*suspend)(struct dsa_switch *ds);
291 int (*resume)(struct dsa_switch *ds);
b2f2af21
FF
292
293 /*
294 * Port enable/disable
295 */
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);
7905288f
FF
300
301 /*
302 * EEE setttings
303 */
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);
51579c3f
GR
309
310#ifdef CONFIG_NET_DSA_HWMON
311 /* Hardware monitoring */
312 int (*get_temp)(struct dsa_switch *ds, int *temp);
313 int (*get_temp_limit)(struct dsa_switch *ds, int *temp);
314 int (*set_temp_limit)(struct dsa_switch *ds, int temp);
315 int (*get_temp_alarm)(struct dsa_switch *ds, bool *alarm);
316#endif
6793abb4
GR
317
318 /* EEPROM access */
319 int (*get_eeprom_len)(struct dsa_switch *ds);
320 int (*get_eeprom)(struct dsa_switch *ds,
321 struct ethtool_eeprom *eeprom, u8 *data);
322 int (*set_eeprom)(struct dsa_switch *ds,
323 struct ethtool_eeprom *eeprom, u8 *data);
3d762a0f
GR
324
325 /*
326 * Register access.
327 */
328 int (*get_regs_len)(struct dsa_switch *ds, int port);
329 void (*get_regs)(struct dsa_switch *ds, int port,
330 struct ethtool_regs *regs, void *p);
b73adef6
FF
331
332 /*
333 * Bridge integration
334 */
34a79f63 335 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
71327a4e 336 int (*port_bridge_join)(struct dsa_switch *ds, int port,
a6692754 337 struct net_device *bridge);
16bfa702 338 void (*port_bridge_leave)(struct dsa_switch *ds, int port);
43c44a9f
VD
339 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
340 u8 state);
732f794c 341 void (*port_fast_age)(struct dsa_switch *ds, int port);
2a778e1b 342
11149536
VD
343 /*
344 * VLAN support
345 */
fb2dabad
VD
346 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
347 bool vlan_filtering);
76e398a6
VD
348 int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
349 const struct switchdev_obj_port_vlan *vlan,
350 struct switchdev_trans *trans);
4d5770b3 351 void (*port_vlan_add)(struct dsa_switch *ds, int port,
76e398a6
VD
352 const struct switchdev_obj_port_vlan *vlan,
353 struct switchdev_trans *trans);
354 int (*port_vlan_del)(struct dsa_switch *ds, int port,
355 const struct switchdev_obj_port_vlan *vlan);
65aebfc0
VD
356 int (*port_vlan_dump)(struct dsa_switch *ds, int port,
357 struct switchdev_obj_port_vlan *vlan,
358 int (*cb)(struct switchdev_obj *obj));
11149536 359
2a778e1b
VD
360 /*
361 * Forwarding database
362 */
146a3206
VD
363 int (*port_fdb_prepare)(struct dsa_switch *ds, int port,
364 const struct switchdev_obj_port_fdb *fdb,
365 struct switchdev_trans *trans);
8497aa61 366 void (*port_fdb_add)(struct dsa_switch *ds, int port,
1f36faf2
VD
367 const struct switchdev_obj_port_fdb *fdb,
368 struct switchdev_trans *trans);
2a778e1b 369 int (*port_fdb_del)(struct dsa_switch *ds, int port,
8057b3e7 370 const struct switchdev_obj_port_fdb *fdb);
ea70ba98
VD
371 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
372 struct switchdev_obj_port_fdb *fdb,
373 int (*cb)(struct switchdev_obj *obj));
8df30255
VD
374
375 /*
376 * Multicast database
377 */
378 int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
379 const struct switchdev_obj_port_mdb *mdb,
380 struct switchdev_trans *trans);
381 void (*port_mdb_add)(struct dsa_switch *ds, int port,
382 const struct switchdev_obj_port_mdb *mdb,
383 struct switchdev_trans *trans);
384 int (*port_mdb_del)(struct dsa_switch *ds, int port,
385 const struct switchdev_obj_port_mdb *mdb);
386 int (*port_mdb_dump)(struct dsa_switch *ds, int port,
387 struct switchdev_obj_port_mdb *mdb,
388 int (*cb)(struct switchdev_obj *obj));
c8f0b869
BH
389};
390
ab3d408d
FF
391struct dsa_switch_driver {
392 struct list_head list;
393 struct dsa_switch_ops *ops;
394};
395
396void register_switch_driver(struct dsa_switch_driver *type);
397void unregister_switch_driver(struct dsa_switch_driver *type);
b4d2394d 398struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
c8f0b869 399
5aed85ce
FF
400static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
401{
5075314e 402 return dst->rcv != NULL;
5aed85ce 403}
83c0afae
AL
404
405void dsa_unregister_switch(struct dsa_switch *ds);
406int dsa_register_switch(struct dsa_switch *ds, struct device_node *np);
ea825e70
FF
407#ifdef CONFIG_PM_SLEEP
408int dsa_switch_suspend(struct dsa_switch *ds);
409int dsa_switch_resume(struct dsa_switch *ds);
410#else
411static inline int dsa_switch_suspend(struct dsa_switch *ds)
412{
413 return 0;
414}
415static inline int dsa_switch_resume(struct dsa_switch *ds)
416{
417 return 0;
418}
419#endif /* CONFIG_PM_SLEEP */
420
91da11f8 421#endif