]>
Commit | Line | Data |
---|---|---|
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 |
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, | |
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 |
38 | struct 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 | |
72 | struct 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 | 88 | struct packet_type; |
3e8a72d1 | 89 | |
cf50dcc2 | 90 | struct 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 | */ | |
b22de490 | 127 | struct dsa_switch *cpu_switch; |
cf50dcc2 BH |
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 | 142 | struct dsa_port { |
818be848 VD |
143 | struct dsa_switch *ds; |
144 | unsigned int index; | |
c8b09808 | 145 | struct net_device *netdev; |
189b0d93 | 146 | struct device_node *dn; |
34a79f63 | 147 | unsigned int ageing_time; |
732f794c | 148 | u8 stp_state; |
a5e9a02e | 149 | struct net_device *bridge_dev; |
c8b09808 AL |
150 | }; |
151 | ||
c8f0b869 | 152 | struct dsa_switch { |
c33063d6 AL |
153 | struct device *dev; |
154 | ||
c8f0b869 BH |
155 | /* |
156 | * Parent switch tree, and switch index. | |
157 | */ | |
158 | struct dsa_switch_tree *dst; | |
159 | int index; | |
160 | ||
7543a6d5 AL |
161 | /* |
162 | * Give the switch driver somewhere to hang its private data | |
163 | * structure. | |
164 | */ | |
165 | void *priv; | |
166 | ||
c8f0b869 BH |
167 | /* |
168 | * Configuration data for this switch. | |
169 | */ | |
ff04955c | 170 | struct dsa_chip_data *cd; |
c8f0b869 BH |
171 | |
172 | /* | |
9d490b4e | 173 | * The switch operations. |
c8f0b869 | 174 | */ |
a82f67af | 175 | const struct dsa_switch_ops *ops; |
c8f0b869 | 176 | |
66472fc0 AL |
177 | /* |
178 | * An array of which element [a] indicates which port on this | |
179 | * switch should be used to send packets to that are destined | |
180 | * for switch a. Can be NULL if there is only one switch chip. | |
181 | */ | |
182 | s8 rtable[DSA_MAX_SWITCHES]; | |
183 | ||
83c0afae AL |
184 | /* |
185 | * The lower device this switch uses to talk to the host | |
186 | */ | |
187 | struct net_device *master_netdev; | |
188 | ||
c8f0b869 BH |
189 | /* |
190 | * Slave mii_bus and devices for the individual ports. | |
191 | */ | |
192 | u32 dsa_port_mask; | |
83c0afae | 193 | u32 cpu_port_mask; |
74c3e2a5 | 194 | u32 enabled_port_mask; |
0d8bcdd3 | 195 | u32 phys_mii_mask; |
c8f0b869 | 196 | struct mii_bus *slave_mii_bus; |
a0c02161 VD |
197 | |
198 | /* Dynamically allocated ports, keep last */ | |
199 | size_t num_ports; | |
200 | struct dsa_port ports[]; | |
c8f0b869 BH |
201 | }; |
202 | ||
203 | static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p) | |
204 | { | |
b22de490 | 205 | return !!(ds == ds->dst->cpu_switch && p == ds->dst->cpu_port); |
c8f0b869 BH |
206 | } |
207 | ||
60045cbf AL |
208 | static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p) |
209 | { | |
210 | return !!((ds->dsa_port_mask) & (1 << p)); | |
211 | } | |
212 | ||
d79d2107 GR |
213 | static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p) |
214 | { | |
c8b09808 | 215 | return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev; |
d79d2107 GR |
216 | } |
217 | ||
c8f0b869 BH |
218 | static inline u8 dsa_upstream_port(struct dsa_switch *ds) |
219 | { | |
220 | struct dsa_switch_tree *dst = ds->dst; | |
221 | ||
222 | /* | |
223 | * If this is the root switch (i.e. the switch that connects | |
224 | * to the CPU), return the cpu port number on this switch. | |
225 | * Else return the (DSA) port number that connects to the | |
226 | * switch that is one hop closer to the cpu. | |
227 | */ | |
b22de490 | 228 | if (dst->cpu_switch == ds) |
c8f0b869 BH |
229 | return dst->cpu_port; |
230 | else | |
b22de490 | 231 | return ds->rtable[dst->cpu_switch->index]; |
c8f0b869 BH |
232 | } |
233 | ||
146a3206 | 234 | struct switchdev_trans; |
ea70ba98 | 235 | struct switchdev_obj; |
146a3206 | 236 | struct switchdev_obj_port_fdb; |
8df30255 | 237 | struct switchdev_obj_port_mdb; |
76e398a6 | 238 | struct switchdev_obj_port_vlan; |
146a3206 | 239 | |
9d490b4e | 240 | struct dsa_switch_ops { |
c8f0b869 BH |
241 | /* |
242 | * Probing and setup. | |
243 | */ | |
0209d144 VD |
244 | const char *(*probe)(struct device *dsa_dev, |
245 | struct device *host_dev, int sw_addr, | |
246 | void **priv); | |
7b314362 AL |
247 | |
248 | enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds); | |
249 | ||
c8f0b869 BH |
250 | int (*setup)(struct dsa_switch *ds); |
251 | int (*set_addr)(struct dsa_switch *ds, u8 *addr); | |
6819563e | 252 | u32 (*get_phy_flags)(struct dsa_switch *ds, int port); |
c8f0b869 BH |
253 | |
254 | /* | |
255 | * Access to the switch's PHY registers. | |
256 | */ | |
257 | int (*phy_read)(struct dsa_switch *ds, int port, int regnum); | |
258 | int (*phy_write)(struct dsa_switch *ds, int port, | |
259 | int regnum, u16 val); | |
260 | ||
ec9436ba FF |
261 | /* |
262 | * Link state adjustment (called from libphy) | |
263 | */ | |
264 | void (*adjust_link)(struct dsa_switch *ds, int port, | |
265 | struct phy_device *phydev); | |
ce31b31c FF |
266 | void (*fixed_link_update)(struct dsa_switch *ds, int port, |
267 | struct fixed_phy_status *st); | |
ec9436ba | 268 | |
c8f0b869 BH |
269 | /* |
270 | * ethtool hardware statistics. | |
271 | */ | |
272 | void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data); | |
273 | void (*get_ethtool_stats)(struct dsa_switch *ds, | |
274 | int port, uint64_t *data); | |
275 | int (*get_sset_count)(struct dsa_switch *ds); | |
24462549 | 276 | |
19e57c4e FF |
277 | /* |
278 | * ethtool Wake-on-LAN | |
279 | */ | |
280 | void (*get_wol)(struct dsa_switch *ds, int port, | |
281 | struct ethtool_wolinfo *w); | |
282 | int (*set_wol)(struct dsa_switch *ds, int port, | |
283 | struct ethtool_wolinfo *w); | |
284 | ||
24462549 FF |
285 | /* |
286 | * Suspend and resume | |
287 | */ | |
288 | int (*suspend)(struct dsa_switch *ds); | |
289 | int (*resume)(struct dsa_switch *ds); | |
b2f2af21 FF |
290 | |
291 | /* | |
292 | * Port enable/disable | |
293 | */ | |
294 | int (*port_enable)(struct dsa_switch *ds, int port, | |
295 | struct phy_device *phy); | |
296 | void (*port_disable)(struct dsa_switch *ds, int port, | |
297 | struct phy_device *phy); | |
7905288f FF |
298 | |
299 | /* | |
300 | * EEE setttings | |
301 | */ | |
302 | int (*set_eee)(struct dsa_switch *ds, int port, | |
303 | struct phy_device *phydev, | |
304 | struct ethtool_eee *e); | |
305 | int (*get_eee)(struct dsa_switch *ds, int port, | |
306 | struct ethtool_eee *e); | |
51579c3f | 307 | |
6793abb4 GR |
308 | /* EEPROM access */ |
309 | int (*get_eeprom_len)(struct dsa_switch *ds); | |
310 | int (*get_eeprom)(struct dsa_switch *ds, | |
311 | struct ethtool_eeprom *eeprom, u8 *data); | |
312 | int (*set_eeprom)(struct dsa_switch *ds, | |
313 | struct ethtool_eeprom *eeprom, u8 *data); | |
3d762a0f GR |
314 | |
315 | /* | |
316 | * Register access. | |
317 | */ | |
318 | int (*get_regs_len)(struct dsa_switch *ds, int port); | |
319 | void (*get_regs)(struct dsa_switch *ds, int port, | |
320 | struct ethtool_regs *regs, void *p); | |
b73adef6 FF |
321 | |
322 | /* | |
323 | * Bridge integration | |
324 | */ | |
34a79f63 | 325 | int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs); |
71327a4e | 326 | int (*port_bridge_join)(struct dsa_switch *ds, int port, |
a6692754 | 327 | struct net_device *bridge); |
16bfa702 | 328 | void (*port_bridge_leave)(struct dsa_switch *ds, int port); |
43c44a9f VD |
329 | void (*port_stp_state_set)(struct dsa_switch *ds, int port, |
330 | u8 state); | |
732f794c | 331 | void (*port_fast_age)(struct dsa_switch *ds, int port); |
2a778e1b | 332 | |
11149536 VD |
333 | /* |
334 | * VLAN support | |
335 | */ | |
fb2dabad VD |
336 | int (*port_vlan_filtering)(struct dsa_switch *ds, int port, |
337 | bool vlan_filtering); | |
76e398a6 VD |
338 | int (*port_vlan_prepare)(struct dsa_switch *ds, int port, |
339 | const struct switchdev_obj_port_vlan *vlan, | |
340 | struct switchdev_trans *trans); | |
4d5770b3 | 341 | void (*port_vlan_add)(struct dsa_switch *ds, int port, |
76e398a6 VD |
342 | const struct switchdev_obj_port_vlan *vlan, |
343 | struct switchdev_trans *trans); | |
344 | int (*port_vlan_del)(struct dsa_switch *ds, int port, | |
345 | const struct switchdev_obj_port_vlan *vlan); | |
65aebfc0 VD |
346 | int (*port_vlan_dump)(struct dsa_switch *ds, int port, |
347 | struct switchdev_obj_port_vlan *vlan, | |
348 | int (*cb)(struct switchdev_obj *obj)); | |
11149536 | 349 | |
2a778e1b VD |
350 | /* |
351 | * Forwarding database | |
352 | */ | |
146a3206 VD |
353 | int (*port_fdb_prepare)(struct dsa_switch *ds, int port, |
354 | const struct switchdev_obj_port_fdb *fdb, | |
355 | struct switchdev_trans *trans); | |
8497aa61 | 356 | void (*port_fdb_add)(struct dsa_switch *ds, int port, |
1f36faf2 VD |
357 | const struct switchdev_obj_port_fdb *fdb, |
358 | struct switchdev_trans *trans); | |
2a778e1b | 359 | int (*port_fdb_del)(struct dsa_switch *ds, int port, |
8057b3e7 | 360 | const struct switchdev_obj_port_fdb *fdb); |
ea70ba98 VD |
361 | int (*port_fdb_dump)(struct dsa_switch *ds, int port, |
362 | struct switchdev_obj_port_fdb *fdb, | |
363 | int (*cb)(struct switchdev_obj *obj)); | |
8df30255 VD |
364 | |
365 | /* | |
366 | * Multicast database | |
367 | */ | |
368 | int (*port_mdb_prepare)(struct dsa_switch *ds, int port, | |
369 | const struct switchdev_obj_port_mdb *mdb, | |
370 | struct switchdev_trans *trans); | |
371 | void (*port_mdb_add)(struct dsa_switch *ds, int port, | |
372 | const struct switchdev_obj_port_mdb *mdb, | |
373 | struct switchdev_trans *trans); | |
374 | int (*port_mdb_del)(struct dsa_switch *ds, int port, | |
375 | const struct switchdev_obj_port_mdb *mdb); | |
376 | int (*port_mdb_dump)(struct dsa_switch *ds, int port, | |
377 | struct switchdev_obj_port_mdb *mdb, | |
378 | int (*cb)(struct switchdev_obj *obj)); | |
c8f0b869 BH |
379 | }; |
380 | ||
ab3d408d FF |
381 | struct dsa_switch_driver { |
382 | struct list_head list; | |
a82f67af | 383 | const struct dsa_switch_ops *ops; |
ab3d408d FF |
384 | }; |
385 | ||
386 | void register_switch_driver(struct dsa_switch_driver *type); | |
387 | void unregister_switch_driver(struct dsa_switch_driver *type); | |
b4d2394d | 388 | struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev); |
c8f0b869 | 389 | |
5aed85ce FF |
390 | static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst) |
391 | { | |
5075314e | 392 | return dst->rcv != NULL; |
5aed85ce | 393 | } |
83c0afae | 394 | |
a0c02161 | 395 | struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n); |
83c0afae | 396 | void dsa_unregister_switch(struct dsa_switch *ds); |
55ed0ce0 | 397 | int dsa_register_switch(struct dsa_switch *ds, struct device *dev); |
ea825e70 FF |
398 | #ifdef CONFIG_PM_SLEEP |
399 | int dsa_switch_suspend(struct dsa_switch *ds); | |
400 | int dsa_switch_resume(struct dsa_switch *ds); | |
401 | #else | |
402 | static inline int dsa_switch_suspend(struct dsa_switch *ds) | |
403 | { | |
404 | return 0; | |
405 | } | |
406 | static inline int dsa_switch_resume(struct dsa_switch *ds) | |
407 | { | |
408 | return 0; | |
409 | } | |
410 | #endif /* CONFIG_PM_SLEEP */ | |
411 | ||
91da11f8 | 412 | #endif |