1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * net/dsa/dsa.c - Hardware switch handling
4 * Copyright (c) 2008-2009 Marvell Semiconductor
8 #include <linux/device.h>
9 #include <linux/list.h>
10 #include <linux/platform_device.h>
11 #include <linux/slab.h>
12 #include <linux/module.h>
13 #include <linux/notifier.h>
15 #include <linux/of_mdio.h>
16 #include <linux/of_platform.h>
17 #include <linux/of_net.h>
18 #include <linux/netdevice.h>
19 #include <linux/sysfs.h>
20 #include <linux/phy_fixed.h>
21 #include <linux/ptp_classify.h>
22 #include <linux/etherdevice.h>
26 static LIST_HEAD(dsa_tag_drivers_list);
27 static DEFINE_MUTEX(dsa_tag_drivers_lock);
29 static struct sk_buff *dsa_slave_notag_xmit(struct sk_buff *skb,
30 struct net_device *dev)
32 /* Just return the original SKB */
36 static const struct dsa_device_ops none_ops = {
38 .proto = DSA_TAG_PROTO_NONE,
39 .xmit = dsa_slave_notag_xmit,
43 DSA_TAG_DRIVER(none_ops);
45 static void dsa_tag_driver_register(struct dsa_tag_driver *dsa_tag_driver,
48 dsa_tag_driver->owner = owner;
50 mutex_lock(&dsa_tag_drivers_lock);
51 list_add_tail(&dsa_tag_driver->list, &dsa_tag_drivers_list);
52 mutex_unlock(&dsa_tag_drivers_lock);
55 void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[],
56 unsigned int count, struct module *owner)
60 for (i = 0; i < count; i++)
61 dsa_tag_driver_register(dsa_tag_driver_array[i], owner);
64 static void dsa_tag_driver_unregister(struct dsa_tag_driver *dsa_tag_driver)
66 mutex_lock(&dsa_tag_drivers_lock);
67 list_del(&dsa_tag_driver->list);
68 mutex_unlock(&dsa_tag_drivers_lock);
70 EXPORT_SYMBOL_GPL(dsa_tag_drivers_register);
72 void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[],
77 for (i = 0; i < count; i++)
78 dsa_tag_driver_unregister(dsa_tag_driver_array[i]);
80 EXPORT_SYMBOL_GPL(dsa_tag_drivers_unregister);
82 const char *dsa_tag_protocol_to_str(const struct dsa_device_ops *ops)
87 const struct dsa_device_ops *dsa_tag_driver_get(int tag_protocol)
89 struct dsa_tag_driver *dsa_tag_driver;
90 const struct dsa_device_ops *ops;
93 request_module("%s%d", DSA_TAG_DRIVER_ALIAS, tag_protocol);
95 mutex_lock(&dsa_tag_drivers_lock);
96 list_for_each_entry(dsa_tag_driver, &dsa_tag_drivers_list, list) {
97 ops = dsa_tag_driver->ops;
98 if (ops->proto == tag_protocol) {
105 if (!try_module_get(dsa_tag_driver->owner))
106 ops = ERR_PTR(-ENOPROTOOPT);
108 ops = ERR_PTR(-ENOPROTOOPT);
111 mutex_unlock(&dsa_tag_drivers_lock);
116 void dsa_tag_driver_put(const struct dsa_device_ops *ops)
118 struct dsa_tag_driver *dsa_tag_driver;
120 mutex_lock(&dsa_tag_drivers_lock);
121 list_for_each_entry(dsa_tag_driver, &dsa_tag_drivers_list, list) {
122 if (dsa_tag_driver->ops == ops) {
123 module_put(dsa_tag_driver->owner);
127 mutex_unlock(&dsa_tag_drivers_lock);
130 static int dev_is_class(struct device *dev, void *class)
132 if (dev->class != NULL && !strcmp(dev->class->name, class))
138 static struct device *dev_find_class(struct device *parent, char *class)
140 if (dev_is_class(parent, class)) {
145 return device_find_child(parent, class, dev_is_class);
148 struct net_device *dsa_dev_to_net_device(struct device *dev)
152 d = dev_find_class(dev, "net");
154 struct net_device *nd;
165 EXPORT_SYMBOL_GPL(dsa_dev_to_net_device);
167 /* Determine if we should defer delivery of skb until we have a rx timestamp.
169 * Called from dsa_switch_rcv. For now, this will only work if tagging is
170 * enabled on the switch. Normally the MAC driver would retrieve the hardware
171 * timestamp when it reads the packet out of the hardware. However in a DSA
172 * switch, the DSA driver owning the interface to which the packet is
173 * delivered is never notified unless we do so here.
175 static bool dsa_skb_defer_rx_timestamp(struct dsa_slave_priv *p,
178 struct dsa_switch *ds = p->dp->ds;
181 if (skb_headroom(skb) < ETH_HLEN)
184 __skb_push(skb, ETH_HLEN);
186 type = ptp_classify_raw(skb);
188 __skb_pull(skb, ETH_HLEN);
190 if (type == PTP_CLASS_NONE)
193 if (likely(ds->ops->port_rxtstamp))
194 return ds->ops->port_rxtstamp(ds, p->dp->index, skb, type);
199 static int dsa_switch_rcv(struct sk_buff *skb, struct net_device *dev,
200 struct packet_type *pt, struct net_device *unused)
202 struct dsa_port *cpu_dp = dev->dsa_ptr;
203 struct sk_buff *nskb = NULL;
204 struct dsa_slave_priv *p;
206 if (unlikely(!cpu_dp)) {
211 skb = skb_unshare(skb, GFP_ATOMIC);
215 nskb = cpu_dp->rcv(skb, dev, pt);
222 p = netdev_priv(skb->dev);
223 skb_push(skb, ETH_HLEN);
224 skb->pkt_type = PACKET_HOST;
225 skb->protocol = eth_type_trans(skb, skb->dev);
227 if (unlikely(cpu_dp->ds->untag_bridge_pvid)) {
228 nskb = dsa_untag_bridge_pvid(skb);
236 dev_sw_netstats_rx_add(skb->dev, skb->len);
238 if (dsa_skb_defer_rx_timestamp(p, skb))
241 gro_cells_receive(&p->gcells, skb);
246 #ifdef CONFIG_PM_SLEEP
247 static bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
249 const struct dsa_port *dp = dsa_to_port(ds, p);
251 return dp->type == DSA_PORT_TYPE_USER && dp->slave;
254 int dsa_switch_suspend(struct dsa_switch *ds)
258 /* Suspend slave network devices */
259 for (i = 0; i < ds->num_ports; i++) {
260 if (!dsa_is_port_initialized(ds, i))
263 ret = dsa_slave_suspend(dsa_to_port(ds, i)->slave);
268 if (ds->ops->suspend)
269 ret = ds->ops->suspend(ds);
273 EXPORT_SYMBOL_GPL(dsa_switch_suspend);
275 int dsa_switch_resume(struct dsa_switch *ds)
280 ret = ds->ops->resume(ds);
285 /* Resume slave network devices */
286 for (i = 0; i < ds->num_ports; i++) {
287 if (!dsa_is_port_initialized(ds, i))
290 ret = dsa_slave_resume(dsa_to_port(ds, i)->slave);
297 EXPORT_SYMBOL_GPL(dsa_switch_resume);
300 static struct packet_type dsa_pack_type __read_mostly = {
301 .type = cpu_to_be16(ETH_P_XDSA),
302 .func = dsa_switch_rcv,
305 static struct workqueue_struct *dsa_owq;
307 bool dsa_schedule_work(struct work_struct *work)
309 return queue_work(dsa_owq, work);
312 static ATOMIC_NOTIFIER_HEAD(dsa_notif_chain);
314 int register_dsa_notifier(struct notifier_block *nb)
316 return atomic_notifier_chain_register(&dsa_notif_chain, nb);
318 EXPORT_SYMBOL_GPL(register_dsa_notifier);
320 int unregister_dsa_notifier(struct notifier_block *nb)
322 return atomic_notifier_chain_unregister(&dsa_notif_chain, nb);
324 EXPORT_SYMBOL_GPL(unregister_dsa_notifier);
326 int call_dsa_notifiers(unsigned long val, struct net_device *dev,
327 struct dsa_notifier_info *info)
330 return atomic_notifier_call_chain(&dsa_notif_chain, val, info);
332 EXPORT_SYMBOL_GPL(call_dsa_notifiers);
334 int dsa_devlink_param_get(struct devlink *dl, u32 id,
335 struct devlink_param_gset_ctx *ctx)
337 struct dsa_switch *ds = dsa_devlink_to_ds(dl);
339 if (!ds->ops->devlink_param_get)
342 return ds->ops->devlink_param_get(ds, id, ctx);
344 EXPORT_SYMBOL_GPL(dsa_devlink_param_get);
346 int dsa_devlink_param_set(struct devlink *dl, u32 id,
347 struct devlink_param_gset_ctx *ctx)
349 struct dsa_switch *ds = dsa_devlink_to_ds(dl);
351 if (!ds->ops->devlink_param_set)
354 return ds->ops->devlink_param_set(ds, id, ctx);
356 EXPORT_SYMBOL_GPL(dsa_devlink_param_set);
358 int dsa_devlink_params_register(struct dsa_switch *ds,
359 const struct devlink_param *params,
362 return devlink_params_register(ds->devlink, params, params_count);
364 EXPORT_SYMBOL_GPL(dsa_devlink_params_register);
366 void dsa_devlink_params_unregister(struct dsa_switch *ds,
367 const struct devlink_param *params,
370 devlink_params_unregister(ds->devlink, params, params_count);
372 EXPORT_SYMBOL_GPL(dsa_devlink_params_unregister);
374 int dsa_devlink_resource_register(struct dsa_switch *ds,
375 const char *resource_name,
378 u64 parent_resource_id,
379 const struct devlink_resource_size_params *size_params)
381 return devlink_resource_register(ds->devlink, resource_name,
382 resource_size, resource_id,
386 EXPORT_SYMBOL_GPL(dsa_devlink_resource_register);
388 void dsa_devlink_resources_unregister(struct dsa_switch *ds)
390 devlink_resources_unregister(ds->devlink, NULL);
392 EXPORT_SYMBOL_GPL(dsa_devlink_resources_unregister);
394 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
396 devlink_resource_occ_get_t *occ_get,
399 return devlink_resource_occ_get_register(ds->devlink, resource_id,
400 occ_get, occ_get_priv);
402 EXPORT_SYMBOL_GPL(dsa_devlink_resource_occ_get_register);
404 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
407 devlink_resource_occ_get_unregister(ds->devlink, resource_id);
409 EXPORT_SYMBOL_GPL(dsa_devlink_resource_occ_get_unregister);
411 struct devlink_region *
412 dsa_devlink_region_create(struct dsa_switch *ds,
413 const struct devlink_region_ops *ops,
414 u32 region_max_snapshots, u64 region_size)
416 return devlink_region_create(ds->devlink, ops, region_max_snapshots,
419 EXPORT_SYMBOL_GPL(dsa_devlink_region_create);
421 struct devlink_region *
422 dsa_devlink_port_region_create(struct dsa_switch *ds,
424 const struct devlink_port_region_ops *ops,
425 u32 region_max_snapshots, u64 region_size)
427 struct dsa_port *dp = dsa_to_port(ds, port);
429 return devlink_port_region_create(&dp->devlink_port, ops,
430 region_max_snapshots,
433 EXPORT_SYMBOL_GPL(dsa_devlink_port_region_create);
435 void dsa_devlink_region_destroy(struct devlink_region *region)
437 devlink_region_destroy(region);
439 EXPORT_SYMBOL_GPL(dsa_devlink_region_destroy);
441 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev)
443 if (!netdev || !dsa_slave_dev_check(netdev))
444 return ERR_PTR(-ENODEV);
446 return dsa_slave_to_port(netdev);
448 EXPORT_SYMBOL_GPL(dsa_port_from_netdev);
450 static int __init dsa_init_module(void)
454 dsa_owq = alloc_ordered_workqueue("dsa_ordered",
459 rc = dsa_slave_register_notifier();
461 goto register_notifier_fail;
463 dev_add_pack(&dsa_pack_type);
465 dsa_tag_driver_register(&DSA_TAG_DRIVER_NAME(none_ops),
470 register_notifier_fail:
471 destroy_workqueue(dsa_owq);
475 module_init(dsa_init_module);
477 static void __exit dsa_cleanup_module(void)
479 dsa_tag_driver_unregister(&DSA_TAG_DRIVER_NAME(none_ops));
481 dsa_slave_unregister_notifier();
482 dev_remove_pack(&dsa_pack_type);
483 destroy_workqueue(dsa_owq);
485 module_exit(dsa_cleanup_module);
488 MODULE_DESCRIPTION("Driver for Distributed Switch Architecture switch chips");
489 MODULE_LICENSE("GPL");
490 MODULE_ALIAS("platform:dsa");