tracing/doc: Fix ascii-art in histogram-design.rst
[linux-2.6-microblaze.git] / net / dsa / dsa_priv.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * net/dsa/dsa_priv.h - Hardware switch handling
4  * Copyright (c) 2008-2009 Marvell Semiconductor
5  */
6
7 #ifndef __DSA_PRIV_H
8 #define __DSA_PRIV_H
9
10 #include <linux/phy.h>
11 #include <linux/netdevice.h>
12 #include <linux/netpoll.h>
13 #include <net/dsa.h>
14
15 enum {
16         DSA_NOTIFIER_AGEING_TIME,
17         DSA_NOTIFIER_BRIDGE_JOIN,
18         DSA_NOTIFIER_BRIDGE_LEAVE,
19         DSA_NOTIFIER_FDB_ADD,
20         DSA_NOTIFIER_FDB_DEL,
21         DSA_NOTIFIER_MDB_ADD,
22         DSA_NOTIFIER_MDB_DEL,
23         DSA_NOTIFIER_VLAN_ADD,
24         DSA_NOTIFIER_VLAN_DEL,
25         DSA_NOTIFIER_MTU,
26 };
27
28 /* DSA_NOTIFIER_AGEING_TIME */
29 struct dsa_notifier_ageing_time_info {
30         struct switchdev_trans *trans;
31         unsigned int ageing_time;
32 };
33
34 /* DSA_NOTIFIER_BRIDGE_* */
35 struct dsa_notifier_bridge_info {
36         struct net_device *br;
37         int sw_index;
38         int port;
39 };
40
41 /* DSA_NOTIFIER_FDB_* */
42 struct dsa_notifier_fdb_info {
43         int sw_index;
44         int port;
45         const unsigned char *addr;
46         u16 vid;
47 };
48
49 /* DSA_NOTIFIER_MDB_* */
50 struct dsa_notifier_mdb_info {
51         const struct switchdev_obj_port_mdb *mdb;
52         struct switchdev_trans *trans;
53         int sw_index;
54         int port;
55 };
56
57 /* DSA_NOTIFIER_VLAN_* */
58 struct dsa_notifier_vlan_info {
59         const struct switchdev_obj_port_vlan *vlan;
60         struct switchdev_trans *trans;
61         int sw_index;
62         int port;
63 };
64
65 /* DSA_NOTIFIER_MTU */
66 struct dsa_notifier_mtu_info {
67         bool propagate_upstream;
68         int sw_index;
69         int port;
70         int mtu;
71 };
72
73 struct dsa_slave_priv {
74         /* Copy of CPU port xmit for faster access in slave transmit hot path */
75         struct sk_buff *        (*xmit)(struct sk_buff *skb,
76                                         struct net_device *dev);
77
78         struct pcpu_sw_netstats *stats64;
79
80         /* DSA port data, such as switch, port index, etc. */
81         struct dsa_port         *dp;
82
83 #ifdef CONFIG_NET_POLL_CONTROLLER
84         struct netpoll          *netpoll;
85 #endif
86
87         /* TC context */
88         struct list_head        mall_tc_list;
89 };
90
91 /* dsa.c */
92 const struct dsa_device_ops *dsa_tag_driver_get(int tag_protocol);
93 void dsa_tag_driver_put(const struct dsa_device_ops *ops);
94
95 bool dsa_schedule_work(struct work_struct *work);
96 const char *dsa_tag_protocol_to_str(const struct dsa_device_ops *ops);
97
98 int dsa_legacy_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
99                        struct net_device *dev,
100                        const unsigned char *addr, u16 vid,
101                        u16 flags,
102                        struct netlink_ext_ack *extack);
103 int dsa_legacy_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
104                        struct net_device *dev,
105                        const unsigned char *addr, u16 vid);
106
107 /* master.c */
108 int dsa_master_setup(struct net_device *dev, struct dsa_port *cpu_dp);
109 void dsa_master_teardown(struct net_device *dev);
110
111 static inline struct net_device *dsa_master_find_slave(struct net_device *dev,
112                                                        int device, int port)
113 {
114         struct dsa_port *cpu_dp = dev->dsa_ptr;
115         struct dsa_switch_tree *dst = cpu_dp->dst;
116         struct dsa_port *dp;
117
118         list_for_each_entry(dp, &dst->ports, list)
119                 if (dp->ds->index == device && dp->index == port &&
120                     dp->type == DSA_PORT_TYPE_USER)
121                         return dp->slave;
122
123         return NULL;
124 }
125
126 /* port.c */
127 int dsa_port_set_state(struct dsa_port *dp, u8 state,
128                        struct switchdev_trans *trans);
129 int dsa_port_enable_rt(struct dsa_port *dp, struct phy_device *phy);
130 int dsa_port_enable(struct dsa_port *dp, struct phy_device *phy);
131 void dsa_port_disable_rt(struct dsa_port *dp);
132 void dsa_port_disable(struct dsa_port *dp);
133 int dsa_port_bridge_join(struct dsa_port *dp, struct net_device *br);
134 void dsa_port_bridge_leave(struct dsa_port *dp, struct net_device *br);
135 int dsa_port_vlan_filtering(struct dsa_port *dp, bool vlan_filtering,
136                             struct switchdev_trans *trans);
137 int dsa_port_ageing_time(struct dsa_port *dp, clock_t ageing_clock,
138                          struct switchdev_trans *trans);
139 int dsa_port_mtu_change(struct dsa_port *dp, int new_mtu,
140                         bool propagate_upstream);
141 int dsa_port_fdb_add(struct dsa_port *dp, const unsigned char *addr,
142                      u16 vid);
143 int dsa_port_fdb_del(struct dsa_port *dp, const unsigned char *addr,
144                      u16 vid);
145 int dsa_port_fdb_dump(struct dsa_port *dp, dsa_fdb_dump_cb_t *cb, void *data);
146 int dsa_port_mdb_add(const struct dsa_port *dp,
147                      const struct switchdev_obj_port_mdb *mdb,
148                      struct switchdev_trans *trans);
149 int dsa_port_mdb_del(const struct dsa_port *dp,
150                      const struct switchdev_obj_port_mdb *mdb);
151 int dsa_port_pre_bridge_flags(const struct dsa_port *dp, unsigned long flags,
152                               struct switchdev_trans *trans);
153 int dsa_port_bridge_flags(const struct dsa_port *dp, unsigned long flags,
154                           struct switchdev_trans *trans);
155 int dsa_port_mrouter(struct dsa_port *dp, bool mrouter,
156                      struct switchdev_trans *trans);
157 int dsa_port_vlan_add(struct dsa_port *dp,
158                       const struct switchdev_obj_port_vlan *vlan,
159                       struct switchdev_trans *trans);
160 int dsa_port_vlan_del(struct dsa_port *dp,
161                       const struct switchdev_obj_port_vlan *vlan);
162 int dsa_port_vid_add(struct dsa_port *dp, u16 vid, u16 flags);
163 int dsa_port_vid_del(struct dsa_port *dp, u16 vid);
164 int dsa_port_link_register_of(struct dsa_port *dp);
165 void dsa_port_link_unregister_of(struct dsa_port *dp);
166 extern const struct phylink_mac_ops dsa_port_phylink_mac_ops;
167
168 /* slave.c */
169 extern const struct dsa_device_ops notag_netdev_ops;
170 void dsa_slave_mii_bus_init(struct dsa_switch *ds);
171 int dsa_slave_create(struct dsa_port *dp);
172 void dsa_slave_destroy(struct net_device *slave_dev);
173 bool dsa_slave_dev_check(const struct net_device *dev);
174 int dsa_slave_suspend(struct net_device *slave_dev);
175 int dsa_slave_resume(struct net_device *slave_dev);
176 int dsa_slave_register_notifier(void);
177 void dsa_slave_unregister_notifier(void);
178
179 static inline struct dsa_port *dsa_slave_to_port(const struct net_device *dev)
180 {
181         struct dsa_slave_priv *p = netdev_priv(dev);
182
183         return p->dp;
184 }
185
186 static inline struct net_device *
187 dsa_slave_to_master(const struct net_device *dev)
188 {
189         struct dsa_port *dp = dsa_slave_to_port(dev);
190
191         return dp->cpu_dp->master;
192 }
193
194 /* switch.c */
195 int dsa_switch_register_notifier(struct dsa_switch *ds);
196 void dsa_switch_unregister_notifier(struct dsa_switch *ds);
197
198 /* dsa2.c */
199 extern struct list_head dsa_tree_list;
200
201 #endif