1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * net/dsa/dsa2.c - Hardware switch handling, binding version 2
4 * Copyright (c) 2008-2009 Marvell Semiconductor
5 * Copyright (c) 2013 Florian Fainelli <florian@openwrt.org>
6 * Copyright (c) 2016 Andrew Lunn <andrew@lunn.ch>
9 #include <linux/device.h>
10 #include <linux/err.h>
11 #include <linux/list.h>
12 #include <linux/netdevice.h>
13 #include <linux/slab.h>
14 #include <linux/rtnetlink.h>
16 #include <linux/of_net.h>
17 #include <net/devlink.h>
21 static LIST_HEAD(dsa_tree_list);
22 static DEFINE_MUTEX(dsa2_mutex);
24 static const struct devlink_ops dsa_devlink_ops = {
27 static struct dsa_switch_tree *dsa_tree_find(int index)
29 struct dsa_switch_tree *dst;
31 list_for_each_entry(dst, &dsa_tree_list, list)
32 if (dst->index == index)
38 static struct dsa_switch_tree *dsa_tree_alloc(int index)
40 struct dsa_switch_tree *dst;
42 dst = kzalloc(sizeof(*dst), GFP_KERNEL);
48 INIT_LIST_HEAD(&dst->list);
49 list_add_tail(&dst->list, &dsa_tree_list);
51 kref_init(&dst->refcount);
56 static void dsa_tree_free(struct dsa_switch_tree *dst)
62 static struct dsa_switch_tree *dsa_tree_get(struct dsa_switch_tree *dst)
65 kref_get(&dst->refcount);
70 static struct dsa_switch_tree *dsa_tree_touch(int index)
72 struct dsa_switch_tree *dst;
74 dst = dsa_tree_find(index);
76 return dsa_tree_get(dst);
78 return dsa_tree_alloc(index);
81 static void dsa_tree_release(struct kref *ref)
83 struct dsa_switch_tree *dst;
85 dst = container_of(ref, struct dsa_switch_tree, refcount);
90 static void dsa_tree_put(struct dsa_switch_tree *dst)
93 kref_put(&dst->refcount, dsa_tree_release);
96 static bool dsa_port_is_dsa(struct dsa_port *port)
98 return port->type == DSA_PORT_TYPE_DSA;
101 static bool dsa_port_is_cpu(struct dsa_port *port)
103 return port->type == DSA_PORT_TYPE_CPU;
106 static bool dsa_port_is_user(struct dsa_port *dp)
108 return dp->type == DSA_PORT_TYPE_USER;
111 static struct dsa_port *dsa_tree_find_port_by_node(struct dsa_switch_tree *dst,
112 struct device_node *dn)
114 struct dsa_switch *ds;
118 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
119 ds = dst->ds[device];
123 for (port = 0; port < ds->num_ports; port++) {
124 dp = &ds->ports[port];
134 static bool dsa_port_setup_routing_table(struct dsa_port *dp)
136 struct dsa_switch *ds = dp->ds;
137 struct dsa_switch_tree *dst = ds->dst;
138 struct device_node *dn = dp->dn;
139 struct of_phandle_iterator it;
140 struct dsa_port *link_dp;
143 of_for_each_phandle(&it, err, dn, "link", NULL, 0) {
144 link_dp = dsa_tree_find_port_by_node(dst, it.node);
146 of_node_put(it.node);
150 ds->rtable[link_dp->ds->index] = dp->index;
156 static bool dsa_switch_setup_routing_table(struct dsa_switch *ds)
158 bool complete = true;
162 for (i = 0; i < DSA_MAX_SWITCHES; i++)
163 ds->rtable[i] = DSA_RTABLE_NONE;
165 for (i = 0; i < ds->num_ports; i++) {
168 if (dsa_port_is_dsa(dp)) {
169 complete = dsa_port_setup_routing_table(dp);
178 static bool dsa_tree_setup_routing_table(struct dsa_switch_tree *dst)
180 struct dsa_switch *ds;
181 bool complete = true;
184 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
185 ds = dst->ds[device];
189 complete = dsa_switch_setup_routing_table(ds);
197 static struct dsa_port *dsa_tree_find_first_cpu(struct dsa_switch_tree *dst)
199 struct dsa_switch *ds;
203 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
204 ds = dst->ds[device];
208 for (port = 0; port < ds->num_ports; port++) {
209 dp = &ds->ports[port];
211 if (dsa_port_is_cpu(dp))
219 static int dsa_tree_setup_default_cpu(struct dsa_switch_tree *dst)
221 struct dsa_switch *ds;
225 /* DSA currently only supports a single CPU port */
226 dst->cpu_dp = dsa_tree_find_first_cpu(dst);
228 pr_warn("Tree has no master device\n");
232 /* Assign the default CPU port to all ports of the fabric */
233 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
234 ds = dst->ds[device];
238 for (port = 0; port < ds->num_ports; port++) {
239 dp = &ds->ports[port];
241 if (dsa_port_is_user(dp) || dsa_port_is_dsa(dp))
242 dp->cpu_dp = dst->cpu_dp;
249 static void dsa_tree_teardown_default_cpu(struct dsa_switch_tree *dst)
251 /* DSA currently only supports a single CPU port */
255 static int dsa_port_setup(struct dsa_port *dp)
257 struct dsa_switch *ds = dp->ds;
258 struct dsa_switch_tree *dst = ds->dst;
259 const unsigned char *id = (const unsigned char *)&dst->index;
260 const unsigned char len = sizeof(dst->index);
261 struct devlink_port *dlp = &dp->devlink_port;
262 bool dsa_port_link_registered = false;
263 bool devlink_port_registered = false;
264 struct devlink *dl = ds->devlink;
265 bool dsa_port_enabled = false;
269 case DSA_PORT_TYPE_UNUSED:
270 dsa_port_disable(dp);
272 case DSA_PORT_TYPE_CPU:
273 memset(dlp, 0, sizeof(*dlp));
274 devlink_port_attrs_set(dlp, DEVLINK_PORT_FLAVOUR_CPU,
275 dp->index, false, 0, id, len);
276 err = devlink_port_register(dl, dlp, dp->index);
279 devlink_port_registered = true;
281 err = dsa_port_link_register_of(dp);
284 dsa_port_link_registered = true;
286 err = dsa_port_enable(dp, NULL);
289 dsa_port_enabled = true;
292 case DSA_PORT_TYPE_DSA:
293 memset(dlp, 0, sizeof(*dlp));
294 devlink_port_attrs_set(dlp, DEVLINK_PORT_FLAVOUR_DSA,
295 dp->index, false, 0, id, len);
296 err = devlink_port_register(dl, dlp, dp->index);
299 devlink_port_registered = true;
301 err = dsa_port_link_register_of(dp);
304 dsa_port_link_registered = true;
306 err = dsa_port_enable(dp, NULL);
309 dsa_port_enabled = true;
312 case DSA_PORT_TYPE_USER:
313 memset(dlp, 0, sizeof(*dlp));
314 devlink_port_attrs_set(dlp, DEVLINK_PORT_FLAVOUR_PHYSICAL,
315 dp->index, false, 0, id, len);
316 err = devlink_port_register(dl, dlp, dp->index);
319 devlink_port_registered = true;
321 dp->mac = of_get_mac_address(dp->dn);
322 err = dsa_slave_create(dp);
326 devlink_port_type_eth_set(dlp, dp->slave);
330 if (err && dsa_port_enabled)
331 dsa_port_disable(dp);
332 if (err && dsa_port_link_registered)
333 dsa_port_link_unregister_of(dp);
334 if (err && devlink_port_registered)
335 devlink_port_unregister(dlp);
340 static void dsa_port_teardown(struct dsa_port *dp)
342 struct devlink_port *dlp = &dp->devlink_port;
345 case DSA_PORT_TYPE_UNUSED:
347 case DSA_PORT_TYPE_CPU:
348 dsa_port_disable(dp);
349 dsa_tag_driver_put(dp->tag_ops);
350 devlink_port_unregister(dlp);
351 dsa_port_link_unregister_of(dp);
353 case DSA_PORT_TYPE_DSA:
354 dsa_port_disable(dp);
355 devlink_port_unregister(dlp);
356 dsa_port_link_unregister_of(dp);
358 case DSA_PORT_TYPE_USER:
359 devlink_port_unregister(dlp);
361 dsa_slave_destroy(dp->slave);
368 static int dsa_switch_setup(struct dsa_switch *ds)
372 /* Initialize ds->phys_mii_mask before registering the slave MDIO bus
373 * driver and before ops->setup() has run, since the switch drivers and
374 * the slave MDIO bus driver rely on these values for probing PHY
377 ds->phys_mii_mask |= dsa_user_ports(ds);
379 /* Add the switch to devlink before calling setup, so that setup can
382 ds->devlink = devlink_alloc(&dsa_devlink_ops, 0);
386 err = devlink_register(ds->devlink, ds->dev);
390 err = dsa_switch_register_notifier(ds);
392 goto unregister_devlink;
394 err = ds->ops->setup(ds);
396 goto unregister_notifier;
398 if (!ds->slave_mii_bus && ds->ops->phy_read) {
399 ds->slave_mii_bus = devm_mdiobus_alloc(ds->dev);
400 if (!ds->slave_mii_bus) {
405 dsa_slave_mii_bus_init(ds);
407 err = mdiobus_register(ds->slave_mii_bus);
415 if (ds->ops->teardown)
416 ds->ops->teardown(ds);
418 dsa_switch_unregister_notifier(ds);
420 devlink_unregister(ds->devlink);
422 devlink_free(ds->devlink);
428 static void dsa_switch_teardown(struct dsa_switch *ds)
430 if (ds->slave_mii_bus && ds->ops->phy_read)
431 mdiobus_unregister(ds->slave_mii_bus);
433 dsa_switch_unregister_notifier(ds);
435 if (ds->ops->teardown)
436 ds->ops->teardown(ds);
439 devlink_unregister(ds->devlink);
440 devlink_free(ds->devlink);
446 static int dsa_tree_setup_switches(struct dsa_switch_tree *dst)
448 struct dsa_switch *ds;
453 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
454 ds = dst->ds[device];
458 err = dsa_switch_setup(ds);
460 goto switch_teardown;
462 for (port = 0; port < ds->num_ports; port++) {
463 dp = &ds->ports[port];
465 err = dsa_port_setup(dp);
474 for (i = 0; i < device; i++) {
479 for (port = 0; port < ds->num_ports; port++) {
480 dp = &ds->ports[port];
482 dsa_port_teardown(dp);
485 dsa_switch_teardown(ds);
491 static void dsa_tree_teardown_switches(struct dsa_switch_tree *dst)
493 struct dsa_switch *ds;
497 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
498 ds = dst->ds[device];
502 for (port = 0; port < ds->num_ports; port++) {
503 dp = &ds->ports[port];
505 dsa_port_teardown(dp);
508 dsa_switch_teardown(ds);
512 static int dsa_tree_setup_master(struct dsa_switch_tree *dst)
514 struct dsa_port *cpu_dp = dst->cpu_dp;
515 struct net_device *master = cpu_dp->master;
517 /* DSA currently supports a single pair of CPU port and master device */
518 return dsa_master_setup(master, cpu_dp);
521 static void dsa_tree_teardown_master(struct dsa_switch_tree *dst)
523 struct dsa_port *cpu_dp = dst->cpu_dp;
524 struct net_device *master = cpu_dp->master;
526 return dsa_master_teardown(master);
529 static int dsa_tree_setup(struct dsa_switch_tree *dst)
535 pr_err("DSA: tree %d already setup! Disjoint trees?\n",
540 complete = dsa_tree_setup_routing_table(dst);
544 err = dsa_tree_setup_default_cpu(dst);
548 err = dsa_tree_setup_switches(dst);
550 goto teardown_default_cpu;
552 err = dsa_tree_setup_master(dst);
554 goto teardown_switches;
558 pr_info("DSA: tree %d setup\n", dst->index);
563 dsa_tree_teardown_switches(dst);
564 teardown_default_cpu:
565 dsa_tree_teardown_default_cpu(dst);
570 static void dsa_tree_teardown(struct dsa_switch_tree *dst)
575 dsa_tree_teardown_master(dst);
577 dsa_tree_teardown_switches(dst);
579 dsa_tree_teardown_default_cpu(dst);
581 pr_info("DSA: tree %d torn down\n", dst->index);
586 static void dsa_tree_remove_switch(struct dsa_switch_tree *dst,
589 dsa_tree_teardown(dst);
591 dst->ds[index] = NULL;
595 static int dsa_tree_add_switch(struct dsa_switch_tree *dst,
596 struct dsa_switch *ds)
598 unsigned int index = ds->index;
607 err = dsa_tree_setup(dst);
609 dst->ds[index] = NULL;
616 static int dsa_port_parse_user(struct dsa_port *dp, const char *name)
621 dp->type = DSA_PORT_TYPE_USER;
627 static int dsa_port_parse_dsa(struct dsa_port *dp)
629 dp->type = DSA_PORT_TYPE_DSA;
634 static int dsa_port_parse_cpu(struct dsa_port *dp, struct net_device *master)
636 struct dsa_switch *ds = dp->ds;
637 struct dsa_switch_tree *dst = ds->dst;
638 const struct dsa_device_ops *tag_ops;
639 enum dsa_tag_protocol tag_protocol;
641 tag_protocol = ds->ops->get_tag_protocol(ds, dp->index);
642 tag_ops = dsa_tag_driver_get(tag_protocol);
643 if (IS_ERR(tag_ops)) {
644 if (PTR_ERR(tag_ops) == -ENOPROTOOPT)
645 return -EPROBE_DEFER;
646 dev_warn(ds->dev, "No tagger for this switch\n");
647 return PTR_ERR(tag_ops);
650 dp->type = DSA_PORT_TYPE_CPU;
651 dp->filter = tag_ops->filter;
652 dp->rcv = tag_ops->rcv;
653 dp->tag_ops = tag_ops;
660 static int dsa_port_parse_of(struct dsa_port *dp, struct device_node *dn)
662 struct device_node *ethernet = of_parse_phandle(dn, "ethernet", 0);
663 const char *name = of_get_property(dn, "label", NULL);
664 bool link = of_property_read_bool(dn, "link");
669 struct net_device *master;
671 master = of_find_net_device_by_node(ethernet);
672 of_node_put(ethernet);
674 return -EPROBE_DEFER;
676 return dsa_port_parse_cpu(dp, master);
680 return dsa_port_parse_dsa(dp);
682 return dsa_port_parse_user(dp, name);
685 static int dsa_switch_parse_ports_of(struct dsa_switch *ds,
686 struct device_node *dn)
688 struct device_node *ports, *port;
693 ports = of_get_child_by_name(dn, "ports");
695 dev_err(ds->dev, "no ports child node found\n");
699 for_each_available_child_of_node(ports, port) {
700 err = of_property_read_u32(port, "reg", ®);
704 if (reg >= ds->num_ports) {
709 dp = &ds->ports[reg];
711 err = dsa_port_parse_of(dp, port);
721 static int dsa_switch_parse_member_of(struct dsa_switch *ds,
722 struct device_node *dn)
727 /* Don't error out if this optional property isn't found */
728 sz = of_property_read_variable_u32_array(dn, "dsa,member", m, 2, 2);
729 if (sz < 0 && sz != -EINVAL)
733 if (ds->index >= DSA_MAX_SWITCHES)
736 ds->dst = dsa_tree_touch(m[0]);
743 static int dsa_switch_parse_of(struct dsa_switch *ds, struct device_node *dn)
747 err = dsa_switch_parse_member_of(ds, dn);
751 return dsa_switch_parse_ports_of(ds, dn);
754 static int dsa_port_parse(struct dsa_port *dp, const char *name,
757 if (!strcmp(name, "cpu")) {
758 struct net_device *master;
760 master = dsa_dev_to_net_device(dev);
762 return -EPROBE_DEFER;
766 return dsa_port_parse_cpu(dp, master);
769 if (!strcmp(name, "dsa"))
770 return dsa_port_parse_dsa(dp);
772 return dsa_port_parse_user(dp, name);
775 static int dsa_switch_parse_ports(struct dsa_switch *ds,
776 struct dsa_chip_data *cd)
778 bool valid_name_found = false;
785 for (i = 0; i < DSA_MAX_PORTS; i++) {
786 name = cd->port_names[i];
793 err = dsa_port_parse(dp, name, dev);
797 valid_name_found = true;
800 if (!valid_name_found && i == DSA_MAX_PORTS)
806 static int dsa_switch_parse(struct dsa_switch *ds, struct dsa_chip_data *cd)
810 /* We don't support interconnected switches nor multiple trees via
811 * platform data, so this is the unique switch of the tree.
814 ds->dst = dsa_tree_touch(0);
818 return dsa_switch_parse_ports(ds, cd);
821 static int dsa_switch_add(struct dsa_switch *ds)
823 struct dsa_switch_tree *dst = ds->dst;
825 return dsa_tree_add_switch(dst, ds);
828 static int dsa_switch_probe(struct dsa_switch *ds)
830 struct dsa_chip_data *pdata = ds->dev->platform_data;
831 struct device_node *np = ds->dev->of_node;
835 err = dsa_switch_parse_of(ds, np);
837 err = dsa_switch_parse(ds, pdata);
844 return dsa_switch_add(ds);
847 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n)
849 struct dsa_switch *ds;
852 ds = devm_kzalloc(dev, struct_size(ds, ports, n), GFP_KERNEL);
859 for (i = 0; i < ds->num_ports; ++i) {
860 ds->ports[i].index = i;
861 ds->ports[i].ds = ds;
866 EXPORT_SYMBOL_GPL(dsa_switch_alloc);
868 int dsa_register_switch(struct dsa_switch *ds)
872 mutex_lock(&dsa2_mutex);
873 err = dsa_switch_probe(ds);
874 dsa_tree_put(ds->dst);
875 mutex_unlock(&dsa2_mutex);
879 EXPORT_SYMBOL_GPL(dsa_register_switch);
881 static void dsa_switch_remove(struct dsa_switch *ds)
883 struct dsa_switch_tree *dst = ds->dst;
884 unsigned int index = ds->index;
886 dsa_tree_remove_switch(dst, index);
889 void dsa_unregister_switch(struct dsa_switch *ds)
891 mutex_lock(&dsa2_mutex);
892 dsa_switch_remove(ds);
893 mutex_unlock(&dsa2_mutex);
895 EXPORT_SYMBOL_GPL(dsa_unregister_switch);