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, | |
39a7f2a4 | 29 | DSA_TAG_LAST, /* MUST BE LAST */ |
ac7a04c3 | 30 | }; |
5037d532 | 31 | |
e84665c9 LB |
32 | #define DSA_MAX_SWITCHES 4 |
33 | #define DSA_MAX_PORTS 12 | |
34 | ||
d390238c VD |
35 | #define DSA_RTABLE_NONE -1 |
36 | ||
e84665c9 LB |
37 | struct dsa_chip_data { |
38 | /* | |
39 | * How to access the switch configuration registers. | |
40 | */ | |
b4d2394d | 41 | struct device *host_dev; |
e84665c9 LB |
42 | int sw_addr; |
43 | ||
6793abb4 GR |
44 | /* set to size of eeprom if supported by the switch */ |
45 | int eeprom_len; | |
46 | ||
fa981d9a FF |
47 | /* Device tree node pointer for this specific switch chip |
48 | * used during switch setup in case additional properties | |
49 | * and resources needs to be used | |
50 | */ | |
51 | struct device_node *of_node; | |
52 | ||
e84665c9 LB |
53 | /* |
54 | * The names of the switch's ports. Use "cpu" to | |
55 | * designate the switch port that the cpu is connected to, | |
56 | * "dsa" to indicate that this port is a DSA link to | |
57 | * another switch, NULL to indicate the port is unused, | |
58 | * or any other string to indicate this is a physical port. | |
59 | */ | |
60 | char *port_names[DSA_MAX_PORTS]; | |
bd47497a | 61 | struct device_node *port_dn[DSA_MAX_PORTS]; |
e84665c9 LB |
62 | |
63 | /* | |
4a7704ff AL |
64 | * An array of which element [a] indicates which port on this |
65 | * switch should be used to send packets to that are destined | |
66 | * for switch a. Can be NULL if there is only one switch chip. | |
e84665c9 | 67 | */ |
4a7704ff | 68 | s8 rtable[DSA_MAX_SWITCHES]; |
e84665c9 | 69 | }; |
91da11f8 LB |
70 | |
71 | struct dsa_platform_data { | |
72 | /* | |
73 | * Reference to a Linux network interface that connects | |
e84665c9 | 74 | * to the root switch chip of the tree. |
91da11f8 LB |
75 | */ |
76 | struct device *netdev; | |
769a0202 | 77 | struct net_device *of_netdev; |
91da11f8 LB |
78 | |
79 | /* | |
e84665c9 LB |
80 | * Info structs describing each of the switch chips |
81 | * connected via this network interface. | |
91da11f8 | 82 | */ |
e84665c9 LB |
83 | int nr_chips; |
84 | struct dsa_chip_data *chip; | |
91da11f8 LB |
85 | }; |
86 | ||
5075314e | 87 | struct packet_type; |
3e8a72d1 | 88 | |
cf50dcc2 | 89 | struct dsa_switch_tree { |
83c0afae AL |
90 | struct list_head list; |
91 | ||
92 | /* Tree identifier */ | |
93 | u32 tree; | |
94 | ||
95 | /* Number of switches attached to this tree */ | |
96 | struct kref refcount; | |
97 | ||
98 | /* Has this tree been applied to the hardware? */ | |
99 | bool applied; | |
100 | ||
cf50dcc2 BH |
101 | /* |
102 | * Configuration data for the platform device that owns | |
103 | * this dsa switch tree instance. | |
104 | */ | |
105 | struct dsa_platform_data *pd; | |
106 | ||
107 | /* | |
108 | * Reference to network device to use, and which tagging | |
109 | * protocol to use. | |
110 | */ | |
111 | struct net_device *master_netdev; | |
5075314e AD |
112 | int (*rcv)(struct sk_buff *skb, |
113 | struct net_device *dev, | |
114 | struct packet_type *pt, | |
115 | struct net_device *orig_dev); | |
cf50dcc2 | 116 | |
badf3ada FF |
117 | /* |
118 | * Original copy of the master netdev ethtool_ops | |
119 | */ | |
120 | struct ethtool_ops master_ethtool_ops; | |
0c73c523 | 121 | const struct ethtool_ops *master_orig_ethtool_ops; |
badf3ada | 122 | |
cf50dcc2 BH |
123 | /* |
124 | * The switch and port to which the CPU is attached. | |
125 | */ | |
126 | s8 cpu_switch; | |
127 | s8 cpu_port; | |
128 | ||
cf50dcc2 BH |
129 | /* |
130 | * Data for the individual switch chips. | |
131 | */ | |
132 | struct dsa_switch *ds[DSA_MAX_SWITCHES]; | |
39a7f2a4 AL |
133 | |
134 | /* | |
135 | * Tagging protocol operations for adding and removing an | |
136 | * encapsulation tag. | |
137 | */ | |
138 | const struct dsa_device_ops *tag_ops; | |
cf50dcc2 BH |
139 | }; |
140 | ||
c8b09808 AL |
141 | struct dsa_port { |
142 | struct net_device *netdev; | |
189b0d93 | 143 | struct device_node *dn; |
34a79f63 | 144 | unsigned int ageing_time; |
c8b09808 AL |
145 | }; |
146 | ||
c8f0b869 | 147 | struct dsa_switch { |
c33063d6 AL |
148 | struct device *dev; |
149 | ||
c8f0b869 BH |
150 | /* |
151 | * Parent switch tree, and switch index. | |
152 | */ | |
153 | struct dsa_switch_tree *dst; | |
154 | int index; | |
155 | ||
7543a6d5 AL |
156 | /* |
157 | * Give the switch driver somewhere to hang its private data | |
158 | * structure. | |
159 | */ | |
160 | void *priv; | |
161 | ||
c8f0b869 BH |
162 | /* |
163 | * Configuration data for this switch. | |
164 | */ | |
ff04955c | 165 | struct dsa_chip_data *cd; |
c8f0b869 BH |
166 | |
167 | /* | |
9d490b4e | 168 | * The switch operations. |
c8f0b869 | 169 | */ |
9d490b4e | 170 | struct dsa_switch_ops *ops; |
c8f0b869 | 171 | |
66472fc0 AL |
172 | /* |
173 | * An array of which element [a] indicates which port on this | |
174 | * switch should be used to send packets to that are destined | |
175 | * for switch a. Can be NULL if there is only one switch chip. | |
176 | */ | |
177 | s8 rtable[DSA_MAX_SWITCHES]; | |
178 | ||
51579c3f GR |
179 | #ifdef CONFIG_NET_DSA_HWMON |
180 | /* | |
181 | * Hardware monitoring information | |
182 | */ | |
183 | char hwmon_name[IFNAMSIZ + 8]; | |
184 | struct device *hwmon_dev; | |
185 | #endif | |
186 | ||
83c0afae AL |
187 | /* |
188 | * The lower device this switch uses to talk to the host | |
189 | */ | |
190 | struct net_device *master_netdev; | |
191 | ||
c8f0b869 BH |
192 | /* |
193 | * Slave mii_bus and devices for the individual ports. | |
194 | */ | |
195 | u32 dsa_port_mask; | |
83c0afae | 196 | u32 cpu_port_mask; |
74c3e2a5 | 197 | u32 enabled_port_mask; |
0d8bcdd3 | 198 | u32 phys_mii_mask; |
c8b09808 | 199 | struct dsa_port ports[DSA_MAX_PORTS]; |
c8f0b869 | 200 | struct mii_bus *slave_mii_bus; |
c8f0b869 BH |
201 | }; |
202 | ||
203 | static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p) | |
204 | { | |
205 | return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port); | |
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 | */ | |
228 | if (dst->cpu_switch == ds->index) | |
229 | return dst->cpu_port; | |
230 | else | |
66472fc0 | 231 | return ds->rtable[dst->cpu_switch]; |
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 | struct list_head list; |
242 | ||
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); | |
2a778e1b | 341 | |
11149536 VD |
342 | /* |
343 | * VLAN support | |
344 | */ | |
fb2dabad VD |
345 | int (*port_vlan_filtering)(struct dsa_switch *ds, int port, |
346 | bool vlan_filtering); | |
76e398a6 VD |
347 | int (*port_vlan_prepare)(struct dsa_switch *ds, int port, |
348 | const struct switchdev_obj_port_vlan *vlan, | |
349 | struct switchdev_trans *trans); | |
4d5770b3 | 350 | void (*port_vlan_add)(struct dsa_switch *ds, int port, |
76e398a6 VD |
351 | const struct switchdev_obj_port_vlan *vlan, |
352 | struct switchdev_trans *trans); | |
353 | int (*port_vlan_del)(struct dsa_switch *ds, int port, | |
354 | const struct switchdev_obj_port_vlan *vlan); | |
65aebfc0 VD |
355 | int (*port_vlan_dump)(struct dsa_switch *ds, int port, |
356 | struct switchdev_obj_port_vlan *vlan, | |
357 | int (*cb)(struct switchdev_obj *obj)); | |
11149536 | 358 | |
2a778e1b VD |
359 | /* |
360 | * Forwarding database | |
361 | */ | |
146a3206 VD |
362 | int (*port_fdb_prepare)(struct dsa_switch *ds, int port, |
363 | const struct switchdev_obj_port_fdb *fdb, | |
364 | struct switchdev_trans *trans); | |
8497aa61 | 365 | void (*port_fdb_add)(struct dsa_switch *ds, int port, |
1f36faf2 VD |
366 | const struct switchdev_obj_port_fdb *fdb, |
367 | struct switchdev_trans *trans); | |
2a778e1b | 368 | int (*port_fdb_del)(struct dsa_switch *ds, int port, |
8057b3e7 | 369 | const struct switchdev_obj_port_fdb *fdb); |
ea70ba98 VD |
370 | int (*port_fdb_dump)(struct dsa_switch *ds, int port, |
371 | struct switchdev_obj_port_fdb *fdb, | |
372 | int (*cb)(struct switchdev_obj *obj)); | |
8df30255 VD |
373 | |
374 | /* | |
375 | * Multicast database | |
376 | */ | |
377 | int (*port_mdb_prepare)(struct dsa_switch *ds, int port, | |
378 | const struct switchdev_obj_port_mdb *mdb, | |
379 | struct switchdev_trans *trans); | |
380 | void (*port_mdb_add)(struct dsa_switch *ds, int port, | |
381 | const struct switchdev_obj_port_mdb *mdb, | |
382 | struct switchdev_trans *trans); | |
383 | int (*port_mdb_del)(struct dsa_switch *ds, int port, | |
384 | const struct switchdev_obj_port_mdb *mdb); | |
385 | int (*port_mdb_dump)(struct dsa_switch *ds, int port, | |
386 | struct switchdev_obj_port_mdb *mdb, | |
387 | int (*cb)(struct switchdev_obj *obj)); | |
c8f0b869 BH |
388 | }; |
389 | ||
9d490b4e VD |
390 | void register_switch_driver(struct dsa_switch_ops *type); |
391 | void unregister_switch_driver(struct dsa_switch_ops *type); | |
b4d2394d | 392 | struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev); |
c8f0b869 | 393 | |
5aed85ce FF |
394 | static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst) |
395 | { | |
5075314e | 396 | return dst->rcv != NULL; |
5aed85ce | 397 | } |
83c0afae AL |
398 | |
399 | void dsa_unregister_switch(struct dsa_switch *ds); | |
400 | int dsa_register_switch(struct dsa_switch *ds, struct device_node *np); | |
ea825e70 FF |
401 | #ifdef CONFIG_PM_SLEEP |
402 | int dsa_switch_suspend(struct dsa_switch *ds); | |
403 | int dsa_switch_resume(struct dsa_switch *ds); | |
404 | #else | |
405 | static inline int dsa_switch_suspend(struct dsa_switch *ds) | |
406 | { | |
407 | return 0; | |
408 | } | |
409 | static inline int dsa_switch_resume(struct dsa_switch *ds) | |
410 | { | |
411 | return 0; | |
412 | } | |
413 | #endif /* CONFIG_PM_SLEEP */ | |
414 | ||
91da11f8 | 415 | #endif |