]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/dsa.h
Revert "net: qcom/emac: enforce DMA address restrictions"
[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
4d56a29f 14#include <linux/if.h>
ea1f51be 15#include <linux/if_ether.h>
c8f0b869 16#include <linux/list.h>
f515f192 17#include <linux/notifier.h>
cf50dcc2
BH
18#include <linux/timer.h>
19#include <linux/workqueue.h>
fa981d9a 20#include <linux/of.h>
a2820543 21#include <linux/ethtool.h>
96567d5d 22#include <net/devlink.h>
f0c24ccf 23#include <net/switchdev.h>
cf50dcc2 24
f50f2127 25struct tc_action;
4d56a29f
RK
26struct phy_device;
27struct fixed_phy_status;
f50f2127 28
ac7a04c3
FF
29enum dsa_tag_protocol {
30 DSA_TAG_PROTO_NONE = 0,
eb7b7211 31 DSA_TAG_PROTO_BRCM,
ac7a04c3 32 DSA_TAG_PROTO_DSA,
ac7a04c3 33 DSA_TAG_PROTO_EDSA,
8b8010fb 34 DSA_TAG_PROTO_KSZ,
e8fe177a 35 DSA_TAG_PROTO_LAN9303,
eb7b7211
AL
36 DSA_TAG_PROTO_MTK,
37 DSA_TAG_PROTO_QCA,
38 DSA_TAG_PROTO_TRAILER,
39a7f2a4 39 DSA_TAG_LAST, /* MUST BE LAST */
ac7a04c3 40};
5037d532 41
e84665c9
LB
42#define DSA_MAX_SWITCHES 4
43#define DSA_MAX_PORTS 12
44
d390238c
VD
45#define DSA_RTABLE_NONE -1
46
e84665c9
LB
47struct dsa_chip_data {
48 /*
49 * How to access the switch configuration registers.
50 */
b4d2394d 51 struct device *host_dev;
e84665c9
LB
52 int sw_addr;
53
71e0bbde
FF
54 /*
55 * Reference to network devices
56 */
57 struct device *netdev[DSA_MAX_PORTS];
58
6793abb4
GR
59 /* set to size of eeprom if supported by the switch */
60 int eeprom_len;
61
fa981d9a
FF
62 /* Device tree node pointer for this specific switch chip
63 * used during switch setup in case additional properties
64 * and resources needs to be used
65 */
66 struct device_node *of_node;
67
e84665c9
LB
68 /*
69 * The names of the switch's ports. Use "cpu" to
70 * designate the switch port that the cpu is connected to,
71 * "dsa" to indicate that this port is a DSA link to
72 * another switch, NULL to indicate the port is unused,
73 * or any other string to indicate this is a physical port.
74 */
75 char *port_names[DSA_MAX_PORTS];
bd47497a 76 struct device_node *port_dn[DSA_MAX_PORTS];
e84665c9
LB
77
78 /*
4a7704ff
AL
79 * An array of which element [a] indicates which port on this
80 * switch should be used to send packets to that are destined
81 * for switch a. Can be NULL if there is only one switch chip.
e84665c9 82 */
4a7704ff 83 s8 rtable[DSA_MAX_SWITCHES];
e84665c9 84};
91da11f8
LB
85
86struct dsa_platform_data {
87 /*
88 * Reference to a Linux network interface that connects
e84665c9 89 * to the root switch chip of the tree.
91da11f8
LB
90 */
91 struct device *netdev;
769a0202 92 struct net_device *of_netdev;
91da11f8
LB
93
94 /*
e84665c9
LB
95 * Info structs describing each of the switch chips
96 * connected via this network interface.
91da11f8 97 */
e84665c9
LB
98 int nr_chips;
99 struct dsa_chip_data *chip;
91da11f8
LB
100};
101
5075314e 102struct packet_type;
3e8a72d1 103
68277a2c
JC
104struct dsa_device_ops {
105 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
106 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
89e49506 107 struct packet_type *pt);
598a9680
JC
108 int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
109 int *offset);
68277a2c
JC
110};
111
cf50dcc2 112struct dsa_switch_tree {
83c0afae
AL
113 struct list_head list;
114
f515f192
VD
115 /* Notifier chain for switch-wide events */
116 struct raw_notifier_head nh;
117
83c0afae
AL
118 /* Tree identifier */
119 u32 tree;
120
121 /* Number of switches attached to this tree */
122 struct kref refcount;
123
124 /* Has this tree been applied to the hardware? */
125 bool applied;
126
cf50dcc2
BH
127 /*
128 * Configuration data for the platform device that owns
129 * this dsa switch tree instance.
130 */
131 struct dsa_platform_data *pd;
132
cf50dcc2 133 /*
8b0d3ea5 134 * The switch port to which the CPU is attached.
cf50dcc2 135 */
8b0d3ea5 136 struct dsa_port *cpu_dp;
cf50dcc2 137
cf50dcc2
BH
138 /*
139 * Data for the individual switch chips.
140 */
141 struct dsa_switch *ds[DSA_MAX_SWITCHES];
142};
143
f50f2127
FF
144/* TC matchall action types, only mirroring for now */
145enum dsa_port_mall_action_type {
146 DSA_PORT_MALL_MIRROR,
147};
148
149/* TC mirroring entry */
150struct dsa_mall_mirror_tc_entry {
151 u8 to_local_port;
152 bool ingress;
153};
154
155/* TC matchall entry */
156struct dsa_mall_tc_entry {
157 struct list_head list;
158 unsigned long cookie;
159 enum dsa_port_mall_action_type type;
160 union {
161 struct dsa_mall_mirror_tc_entry mirror;
162 };
163};
164
165
c8b09808 166struct dsa_port {
15240248
VD
167 /* CPU port tagging operations used by master or slave devices */
168 const struct dsa_device_ops *tag_ops;
169
3e41f93b
VD
170 /* Copies for faster access in master receive hot path */
171 struct dsa_switch_tree *dst;
172 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
173 struct packet_type *pt);
174
818be848
VD
175 struct dsa_switch *ds;
176 unsigned int index;
71e0bbde 177 const char *name;
a29342e7 178 struct dsa_port *cpu_dp;
c8b09808 179 struct net_device *netdev;
189b0d93 180 struct device_node *dn;
34a79f63 181 unsigned int ageing_time;
732f794c 182 u8 stp_state;
a5e9a02e 183 struct net_device *bridge_dev;
96567d5d 184 struct devlink_port devlink_port;
67dbb9d4
FF
185 /*
186 * Original copy of the master netdev ethtool_ops
187 */
67dbb9d4 188 const struct ethtool_ops *orig_ethtool_ops;
c8b09808
AL
189};
190
c8f0b869 191struct dsa_switch {
c33063d6
AL
192 struct device *dev;
193
c8f0b869
BH
194 /*
195 * Parent switch tree, and switch index.
196 */
197 struct dsa_switch_tree *dst;
198 int index;
199
f515f192
VD
200 /* Listener for switch fabric events */
201 struct notifier_block nb;
202
7543a6d5
AL
203 /*
204 * Give the switch driver somewhere to hang its private data
205 * structure.
206 */
207 void *priv;
208
c8f0b869
BH
209 /*
210 * Configuration data for this switch.
211 */
ff04955c 212 struct dsa_chip_data *cd;
c8f0b869
BH
213
214 /*
9d490b4e 215 * The switch operations.
c8f0b869 216 */
a82f67af 217 const struct dsa_switch_ops *ops;
c8f0b869 218
66472fc0
AL
219 /*
220 * An array of which element [a] indicates which port on this
221 * switch should be used to send packets to that are destined
222 * for switch a. Can be NULL if there is only one switch chip.
223 */
224 s8 rtable[DSA_MAX_SWITCHES];
225
c8f0b869
BH
226 /*
227 * Slave mii_bus and devices for the individual ports.
228 */
229 u32 dsa_port_mask;
83c0afae 230 u32 cpu_port_mask;
74c3e2a5 231 u32 enabled_port_mask;
0d8bcdd3 232 u32 phys_mii_mask;
c8f0b869 233 struct mii_bus *slave_mii_bus;
a0c02161 234
0f3da6af
VD
235 /* Ageing Time limits in msecs */
236 unsigned int ageing_time_min;
237 unsigned int ageing_time_max;
238
96567d5d
AL
239 /* devlink used to represent this switch device */
240 struct devlink *devlink;
241
55199df6
FF
242 /* Number of switch port queues */
243 unsigned int num_tx_queues;
244
a0c02161
VD
245 /* Dynamically allocated ports, keep last */
246 size_t num_ports;
247 struct dsa_port ports[];
c8f0b869
BH
248};
249
250static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
251{
14be36c2 252 return !!(ds->cpu_port_mask & (1 << p));
c8f0b869
BH
253}
254
60045cbf
AL
255static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
256{
257 return !!((ds->dsa_port_mask) & (1 << p));
258}
259
6cd456f3
VD
260static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
261{
262 return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
263}
264
c8f0b869
BH
265static inline u8 dsa_upstream_port(struct dsa_switch *ds)
266{
267 struct dsa_switch_tree *dst = ds->dst;
268
269 /*
270 * If this is the root switch (i.e. the switch that connects
271 * to the CPU), return the cpu port number on this switch.
272 * Else return the (DSA) port number that connects to the
273 * switch that is one hop closer to the cpu.
274 */
8b0d3ea5
VD
275 if (dst->cpu_dp->ds == ds)
276 return dst->cpu_dp->index;
c8f0b869 277 else
8b0d3ea5 278 return ds->rtable[dst->cpu_dp->ds->index];
c8f0b869
BH
279}
280
2bedde1a
AS
281typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
282 bool is_static, void *data);
9d490b4e 283struct dsa_switch_ops {
c8f0b869 284 /*
a6a71f19 285 * Legacy probing.
c8f0b869 286 */
0209d144
VD
287 const char *(*probe)(struct device *dsa_dev,
288 struct device *host_dev, int sw_addr,
289 void **priv);
7b314362
AL
290
291 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
292
c8f0b869
BH
293 int (*setup)(struct dsa_switch *ds);
294 int (*set_addr)(struct dsa_switch *ds, u8 *addr);
6819563e 295 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
c8f0b869
BH
296
297 /*
298 * Access to the switch's PHY registers.
299 */
300 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
301 int (*phy_write)(struct dsa_switch *ds, int port,
302 int regnum, u16 val);
303
ec9436ba
FF
304 /*
305 * Link state adjustment (called from libphy)
306 */
307 void (*adjust_link)(struct dsa_switch *ds, int port,
308 struct phy_device *phydev);
ce31b31c
FF
309 void (*fixed_link_update)(struct dsa_switch *ds, int port,
310 struct fixed_phy_status *st);
ec9436ba 311
c8f0b869
BH
312 /*
313 * ethtool hardware statistics.
314 */
315 void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
316 void (*get_ethtool_stats)(struct dsa_switch *ds,
317 int port, uint64_t *data);
318 int (*get_sset_count)(struct dsa_switch *ds);
24462549 319
19e57c4e
FF
320 /*
321 * ethtool Wake-on-LAN
322 */
323 void (*get_wol)(struct dsa_switch *ds, int port,
324 struct ethtool_wolinfo *w);
325 int (*set_wol)(struct dsa_switch *ds, int port,
326 struct ethtool_wolinfo *w);
327
24462549
FF
328 /*
329 * Suspend and resume
330 */
331 int (*suspend)(struct dsa_switch *ds);
332 int (*resume)(struct dsa_switch *ds);
b2f2af21
FF
333
334 /*
335 * Port enable/disable
336 */
337 int (*port_enable)(struct dsa_switch *ds, int port,
338 struct phy_device *phy);
339 void (*port_disable)(struct dsa_switch *ds, int port,
340 struct phy_device *phy);
7905288f
FF
341
342 /*
08f50061 343 * Port's MAC EEE settings
7905288f 344 */
08f50061
VD
345 int (*set_mac_eee)(struct dsa_switch *ds, int port,
346 struct ethtool_eee *e);
347 int (*get_mac_eee)(struct dsa_switch *ds, int port,
348 struct ethtool_eee *e);
51579c3f 349
6793abb4
GR
350 /* EEPROM access */
351 int (*get_eeprom_len)(struct dsa_switch *ds);
352 int (*get_eeprom)(struct dsa_switch *ds,
353 struct ethtool_eeprom *eeprom, u8 *data);
354 int (*set_eeprom)(struct dsa_switch *ds,
355 struct ethtool_eeprom *eeprom, u8 *data);
3d762a0f
GR
356
357 /*
358 * Register access.
359 */
360 int (*get_regs_len)(struct dsa_switch *ds, int port);
361 void (*get_regs)(struct dsa_switch *ds, int port,
362 struct ethtool_regs *regs, void *p);
b73adef6
FF
363
364 /*
365 * Bridge integration
366 */
34a79f63 367 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
71327a4e 368 int (*port_bridge_join)(struct dsa_switch *ds, int port,
a6692754 369 struct net_device *bridge);
f123f2fb
VD
370 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
371 struct net_device *bridge);
43c44a9f
VD
372 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
373 u8 state);
732f794c 374 void (*port_fast_age)(struct dsa_switch *ds, int port);
2a778e1b 375
11149536
VD
376 /*
377 * VLAN support
378 */
fb2dabad
VD
379 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
380 bool vlan_filtering);
76e398a6
VD
381 int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
382 const struct switchdev_obj_port_vlan *vlan,
383 struct switchdev_trans *trans);
4d5770b3 384 void (*port_vlan_add)(struct dsa_switch *ds, int port,
76e398a6
VD
385 const struct switchdev_obj_port_vlan *vlan,
386 struct switchdev_trans *trans);
387 int (*port_vlan_del)(struct dsa_switch *ds, int port,
388 const struct switchdev_obj_port_vlan *vlan);
2a778e1b
VD
389 /*
390 * Forwarding database
391 */
1b6dd556 392 int (*port_fdb_add)(struct dsa_switch *ds, int port,
6c2c1dcb 393 const unsigned char *addr, u16 vid);
2a778e1b 394 int (*port_fdb_del)(struct dsa_switch *ds, int port,
6c2c1dcb 395 const unsigned char *addr, u16 vid);
ea70ba98 396 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
2bedde1a 397 dsa_fdb_dump_cb_t *cb, void *data);
8df30255
VD
398
399 /*
400 * Multicast database
401 */
402 int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
403 const struct switchdev_obj_port_mdb *mdb,
404 struct switchdev_trans *trans);
405 void (*port_mdb_add)(struct dsa_switch *ds, int port,
406 const struct switchdev_obj_port_mdb *mdb,
407 struct switchdev_trans *trans);
408 int (*port_mdb_del)(struct dsa_switch *ds, int port,
409 const struct switchdev_obj_port_mdb *mdb);
bf9f2648
FF
410 /*
411 * RXNFC
412 */
413 int (*get_rxnfc)(struct dsa_switch *ds, int port,
414 struct ethtool_rxnfc *nfc, u32 *rule_locs);
415 int (*set_rxnfc)(struct dsa_switch *ds, int port,
416 struct ethtool_rxnfc *nfc);
f50f2127
FF
417
418 /*
419 * TC integration
420 */
421 int (*port_mirror_add)(struct dsa_switch *ds, int port,
422 struct dsa_mall_mirror_tc_entry *mirror,
423 bool ingress);
424 void (*port_mirror_del)(struct dsa_switch *ds, int port,
425 struct dsa_mall_mirror_tc_entry *mirror);
40ef2c93
VD
426
427 /*
428 * Cross-chip operations
429 */
430 int (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
431 int port, struct net_device *br);
432 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
433 int port, struct net_device *br);
c8f0b869
BH
434};
435
ab3d408d
FF
436struct dsa_switch_driver {
437 struct list_head list;
a82f67af 438 const struct dsa_switch_ops *ops;
ab3d408d
FF
439};
440
a6a71f19 441/* Legacy driver registration */
ab3d408d
FF
442void register_switch_driver(struct dsa_switch_driver *type);
443void unregister_switch_driver(struct dsa_switch_driver *type);
b4d2394d 444struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
a6a71f19 445
14b89f36 446struct net_device *dsa_dev_to_net_device(struct device *dev);
c8f0b869 447
73a7ece8 448/* Keep inline for faster access in hot path */
c6e970a0
AL
449static inline bool netdev_uses_dsa(struct net_device *dev)
450{
451#if IS_ENABLED(CONFIG_NET_DSA)
717ffbfb 452 return dev->dsa_ptr && dev->dsa_ptr->rcv;
c6e970a0
AL
453#endif
454 return false;
455}
456
a0c02161 457struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
83c0afae 458void dsa_unregister_switch(struct dsa_switch *ds);
23c9ee49 459int dsa_register_switch(struct dsa_switch *ds);
ea825e70
FF
460#ifdef CONFIG_PM_SLEEP
461int dsa_switch_suspend(struct dsa_switch *ds);
462int dsa_switch_resume(struct dsa_switch *ds);
463#else
464static inline int dsa_switch_suspend(struct dsa_switch *ds)
465{
466 return 0;
467}
468static inline int dsa_switch_resume(struct dsa_switch *ds)
469{
470 return 0;
471}
472#endif /* CONFIG_PM_SLEEP */
473
91da11f8 474#endif