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 DEFINE_MUTEX(dsa2_mutex);
22 LIST_HEAD(dsa_tree_list);
24 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index)
26 struct dsa_switch_tree *dst;
29 list_for_each_entry(dst, &dsa_tree_list, list) {
30 if (dst->index != tree_index)
33 list_for_each_entry(dp, &dst->ports, list) {
34 if (dp->ds->index != sw_index)
43 EXPORT_SYMBOL_GPL(dsa_switch_find);
45 static struct dsa_switch_tree *dsa_tree_find(int index)
47 struct dsa_switch_tree *dst;
49 list_for_each_entry(dst, &dsa_tree_list, list)
50 if (dst->index == index)
56 static struct dsa_switch_tree *dsa_tree_alloc(int index)
58 struct dsa_switch_tree *dst;
60 dst = kzalloc(sizeof(*dst), GFP_KERNEL);
66 INIT_LIST_HEAD(&dst->rtable);
68 INIT_LIST_HEAD(&dst->ports);
70 INIT_LIST_HEAD(&dst->list);
71 list_add_tail(&dst->list, &dsa_tree_list);
73 kref_init(&dst->refcount);
78 static void dsa_tree_free(struct dsa_switch_tree *dst)
84 static struct dsa_switch_tree *dsa_tree_get(struct dsa_switch_tree *dst)
87 kref_get(&dst->refcount);
92 static struct dsa_switch_tree *dsa_tree_touch(int index)
94 struct dsa_switch_tree *dst;
96 dst = dsa_tree_find(index);
98 return dsa_tree_get(dst);
100 return dsa_tree_alloc(index);
103 static void dsa_tree_release(struct kref *ref)
105 struct dsa_switch_tree *dst;
107 dst = container_of(ref, struct dsa_switch_tree, refcount);
112 static void dsa_tree_put(struct dsa_switch_tree *dst)
115 kref_put(&dst->refcount, dsa_tree_release);
118 static bool dsa_port_is_dsa(struct dsa_port *port)
120 return port->type == DSA_PORT_TYPE_DSA;
123 static bool dsa_port_is_cpu(struct dsa_port *port)
125 return port->type == DSA_PORT_TYPE_CPU;
128 static bool dsa_port_is_user(struct dsa_port *dp)
130 return dp->type == DSA_PORT_TYPE_USER;
133 static struct dsa_port *dsa_tree_find_port_by_node(struct dsa_switch_tree *dst,
134 struct device_node *dn)
138 list_for_each_entry(dp, &dst->ports, list)
145 static struct dsa_link *dsa_link_touch(struct dsa_port *dp,
146 struct dsa_port *link_dp)
148 struct dsa_switch *ds = dp->ds;
149 struct dsa_switch_tree *dst;
154 list_for_each_entry(dl, &dst->rtable, list)
155 if (dl->dp == dp && dl->link_dp == link_dp)
158 dl = kzalloc(sizeof(*dl), GFP_KERNEL);
163 dl->link_dp = link_dp;
165 INIT_LIST_HEAD(&dl->list);
166 list_add_tail(&dl->list, &dst->rtable);
171 static bool dsa_port_setup_routing_table(struct dsa_port *dp)
173 struct dsa_switch *ds = dp->ds;
174 struct dsa_switch_tree *dst = ds->dst;
175 struct device_node *dn = dp->dn;
176 struct of_phandle_iterator it;
177 struct dsa_port *link_dp;
181 of_for_each_phandle(&it, err, dn, "link", NULL, 0) {
182 link_dp = dsa_tree_find_port_by_node(dst, it.node);
184 of_node_put(it.node);
188 dl = dsa_link_touch(dp, link_dp);
190 of_node_put(it.node);
198 static bool dsa_tree_setup_routing_table(struct dsa_switch_tree *dst)
200 bool complete = true;
203 list_for_each_entry(dp, &dst->ports, list) {
204 if (dsa_port_is_dsa(dp)) {
205 complete = dsa_port_setup_routing_table(dp);
214 static struct dsa_port *dsa_tree_find_first_cpu(struct dsa_switch_tree *dst)
218 list_for_each_entry(dp, &dst->ports, list)
219 if (dsa_port_is_cpu(dp))
225 static int dsa_tree_setup_default_cpu(struct dsa_switch_tree *dst)
227 struct dsa_port *cpu_dp, *dp;
229 cpu_dp = dsa_tree_find_first_cpu(dst);
231 pr_err("DSA: tree %d has no CPU port\n", dst->index);
235 /* Assign the default CPU port to all ports of the fabric */
236 list_for_each_entry(dp, &dst->ports, list)
237 if (dsa_port_is_user(dp) || dsa_port_is_dsa(dp))
243 static void dsa_tree_teardown_default_cpu(struct dsa_switch_tree *dst)
247 list_for_each_entry(dp, &dst->ports, list)
248 if (dsa_port_is_user(dp) || dsa_port_is_dsa(dp))
252 static int dsa_port_setup(struct dsa_port *dp)
254 struct devlink_port *dlp = &dp->devlink_port;
255 bool dsa_port_link_registered = false;
256 bool dsa_port_enabled = false;
263 case DSA_PORT_TYPE_UNUSED:
264 dsa_port_disable(dp);
266 case DSA_PORT_TYPE_CPU:
267 err = dsa_port_link_register_of(dp);
270 dsa_port_link_registered = true;
272 err = dsa_port_enable(dp, NULL);
275 dsa_port_enabled = true;
278 case DSA_PORT_TYPE_DSA:
279 err = dsa_port_link_register_of(dp);
282 dsa_port_link_registered = true;
284 err = dsa_port_enable(dp, NULL);
287 dsa_port_enabled = true;
290 case DSA_PORT_TYPE_USER:
291 dp->mac = of_get_mac_address(dp->dn);
292 err = dsa_slave_create(dp);
296 devlink_port_type_eth_set(dlp, dp->slave);
300 if (err && dsa_port_enabled)
301 dsa_port_disable(dp);
302 if (err && dsa_port_link_registered)
303 dsa_port_link_unregister_of(dp);
312 static int dsa_port_devlink_setup(struct dsa_port *dp)
314 struct devlink_port *dlp = &dp->devlink_port;
315 struct dsa_switch_tree *dst = dp->ds->dst;
316 struct devlink_port_attrs attrs = {};
317 struct devlink *dl = dp->ds->devlink;
318 const unsigned char *id;
322 id = (const unsigned char *)&dst->index;
323 len = sizeof(dst->index);
325 attrs.phys.port_number = dp->index;
326 memcpy(attrs.switch_id.id, id, len);
327 attrs.switch_id.id_len = len;
328 memset(dlp, 0, sizeof(*dlp));
331 case DSA_PORT_TYPE_UNUSED:
332 attrs.flavour = DEVLINK_PORT_FLAVOUR_UNUSED;
334 case DSA_PORT_TYPE_CPU:
335 attrs.flavour = DEVLINK_PORT_FLAVOUR_CPU;
337 case DSA_PORT_TYPE_DSA:
338 attrs.flavour = DEVLINK_PORT_FLAVOUR_DSA;
340 case DSA_PORT_TYPE_USER:
341 attrs.flavour = DEVLINK_PORT_FLAVOUR_PHYSICAL;
345 devlink_port_attrs_set(dlp, &attrs);
346 err = devlink_port_register(dl, dlp, dp->index);
349 dp->devlink_port_setup = true;
354 static void dsa_port_teardown(struct dsa_port *dp)
356 struct devlink_port *dlp = &dp->devlink_port;
361 devlink_port_type_clear(dlp);
364 case DSA_PORT_TYPE_UNUSED:
366 case DSA_PORT_TYPE_CPU:
367 dsa_port_disable(dp);
368 dsa_tag_driver_put(dp->tag_ops);
369 dsa_port_link_unregister_of(dp);
371 case DSA_PORT_TYPE_DSA:
372 dsa_port_disable(dp);
373 dsa_port_link_unregister_of(dp);
375 case DSA_PORT_TYPE_USER:
377 dsa_slave_destroy(dp->slave);
386 static void dsa_port_devlink_teardown(struct dsa_port *dp)
388 struct devlink_port *dlp = &dp->devlink_port;
390 if (dp->devlink_port_setup)
391 devlink_port_unregister(dlp);
392 dp->devlink_port_setup = false;
395 static int dsa_devlink_info_get(struct devlink *dl,
396 struct devlink_info_req *req,
397 struct netlink_ext_ack *extack)
399 struct dsa_switch *ds = dsa_devlink_to_ds(dl);
401 if (ds->ops->devlink_info_get)
402 return ds->ops->devlink_info_get(ds, req, extack);
407 static const struct devlink_ops dsa_devlink_ops = {
408 .info_get = dsa_devlink_info_get,
411 static int dsa_switch_setup(struct dsa_switch *ds)
413 struct dsa_devlink_priv *dl_priv;
420 /* Initialize ds->phys_mii_mask before registering the slave MDIO bus
421 * driver and before ops->setup() has run, since the switch drivers and
422 * the slave MDIO bus driver rely on these values for probing PHY
425 ds->phys_mii_mask |= dsa_user_ports(ds);
427 /* Add the switch to devlink before calling setup, so that setup can
430 ds->devlink = devlink_alloc(&dsa_devlink_ops, sizeof(*dl_priv));
433 dl_priv = devlink_priv(ds->devlink);
436 err = devlink_register(ds->devlink, ds->dev);
440 /* Setup devlink port instances now, so that the switch
441 * setup() can register regions etc, against the ports
443 list_for_each_entry(dp, &ds->dst->ports, list) {
445 err = dsa_port_devlink_setup(dp);
447 goto unregister_devlink_ports;
451 err = dsa_switch_register_notifier(ds);
453 goto unregister_devlink_ports;
455 err = ds->ops->setup(ds);
457 goto unregister_notifier;
459 devlink_params_publish(ds->devlink);
461 if (!ds->slave_mii_bus && ds->ops->phy_read) {
462 ds->slave_mii_bus = devm_mdiobus_alloc(ds->dev);
463 if (!ds->slave_mii_bus) {
465 goto unregister_notifier;
468 dsa_slave_mii_bus_init(ds);
470 err = mdiobus_register(ds->slave_mii_bus);
472 goto unregister_notifier;
480 dsa_switch_unregister_notifier(ds);
481 unregister_devlink_ports:
482 list_for_each_entry(dp, &ds->dst->ports, list)
484 dsa_port_devlink_teardown(dp);
485 devlink_unregister(ds->devlink);
487 devlink_free(ds->devlink);
493 static void dsa_switch_teardown(struct dsa_switch *ds)
500 if (ds->slave_mii_bus && ds->ops->phy_read)
501 mdiobus_unregister(ds->slave_mii_bus);
503 dsa_switch_unregister_notifier(ds);
505 if (ds->ops->teardown)
506 ds->ops->teardown(ds);
509 list_for_each_entry(dp, &ds->dst->ports, list)
511 dsa_port_devlink_teardown(dp);
512 devlink_unregister(ds->devlink);
513 devlink_free(ds->devlink);
520 static int dsa_tree_setup_switches(struct dsa_switch_tree *dst)
525 list_for_each_entry(dp, &dst->ports, list) {
526 err = dsa_switch_setup(dp->ds);
531 list_for_each_entry(dp, &dst->ports, list) {
532 err = dsa_port_setup(dp);
540 list_for_each_entry(dp, &dst->ports, list)
541 dsa_port_teardown(dp);
543 list_for_each_entry(dp, &dst->ports, list)
544 dsa_switch_teardown(dp->ds);
549 static void dsa_tree_teardown_switches(struct dsa_switch_tree *dst)
553 list_for_each_entry(dp, &dst->ports, list)
554 dsa_port_teardown(dp);
556 list_for_each_entry(dp, &dst->ports, list)
557 dsa_switch_teardown(dp->ds);
560 static int dsa_tree_setup_master(struct dsa_switch_tree *dst)
565 list_for_each_entry(dp, &dst->ports, list) {
566 if (dsa_port_is_cpu(dp)) {
567 err = dsa_master_setup(dp->master, dp);
576 static void dsa_tree_teardown_master(struct dsa_switch_tree *dst)
580 list_for_each_entry(dp, &dst->ports, list)
581 if (dsa_port_is_cpu(dp))
582 dsa_master_teardown(dp->master);
585 static int dsa_tree_setup(struct dsa_switch_tree *dst)
591 pr_err("DSA: tree %d already setup! Disjoint trees?\n",
596 complete = dsa_tree_setup_routing_table(dst);
600 err = dsa_tree_setup_default_cpu(dst);
604 err = dsa_tree_setup_switches(dst);
606 goto teardown_default_cpu;
608 err = dsa_tree_setup_master(dst);
610 goto teardown_switches;
614 pr_info("DSA: tree %d setup\n", dst->index);
619 dsa_tree_teardown_switches(dst);
620 teardown_default_cpu:
621 dsa_tree_teardown_default_cpu(dst);
626 static void dsa_tree_teardown(struct dsa_switch_tree *dst)
628 struct dsa_link *dl, *next;
633 dsa_tree_teardown_master(dst);
635 dsa_tree_teardown_switches(dst);
637 dsa_tree_teardown_default_cpu(dst);
639 list_for_each_entry_safe(dl, next, &dst->rtable, list) {
644 pr_info("DSA: tree %d torn down\n", dst->index);
649 static struct dsa_port *dsa_port_touch(struct dsa_switch *ds, int index)
651 struct dsa_switch_tree *dst = ds->dst;
654 list_for_each_entry(dp, &dst->ports, list)
655 if (dp->ds == ds && dp->index == index)
658 dp = kzalloc(sizeof(*dp), GFP_KERNEL);
665 INIT_LIST_HEAD(&dp->list);
666 list_add_tail(&dp->list, &dst->ports);
671 static int dsa_port_parse_user(struct dsa_port *dp, const char *name)
676 dp->type = DSA_PORT_TYPE_USER;
682 static int dsa_port_parse_dsa(struct dsa_port *dp)
684 dp->type = DSA_PORT_TYPE_DSA;
689 static enum dsa_tag_protocol dsa_get_tag_protocol(struct dsa_port *dp,
690 struct net_device *master)
692 enum dsa_tag_protocol tag_protocol = DSA_TAG_PROTO_NONE;
693 struct dsa_switch *mds, *ds = dp->ds;
694 unsigned int mdp_upstream;
695 struct dsa_port *mdp;
697 /* It is possible to stack DSA switches onto one another when that
698 * happens the switch driver may want to know if its tagging protocol
699 * is going to work in such a configuration.
701 if (dsa_slave_dev_check(master)) {
702 mdp = dsa_slave_to_port(master);
704 mdp_upstream = dsa_upstream_port(mds, mdp->index);
705 tag_protocol = mds->ops->get_tag_protocol(mds, mdp_upstream,
709 /* If the master device is not itself a DSA slave in a disjoint DSA
710 * tree, then return immediately.
712 return ds->ops->get_tag_protocol(ds, dp->index, tag_protocol);
715 static int dsa_port_parse_cpu(struct dsa_port *dp, struct net_device *master)
717 struct dsa_switch *ds = dp->ds;
718 struct dsa_switch_tree *dst = ds->dst;
719 const struct dsa_device_ops *tag_ops;
720 enum dsa_tag_protocol tag_protocol;
722 tag_protocol = dsa_get_tag_protocol(dp, master);
723 tag_ops = dsa_tag_driver_get(tag_protocol);
724 if (IS_ERR(tag_ops)) {
725 if (PTR_ERR(tag_ops) == -ENOPROTOOPT)
726 return -EPROBE_DEFER;
727 dev_warn(ds->dev, "No tagger for this switch\n");
729 return PTR_ERR(tag_ops);
733 dp->type = DSA_PORT_TYPE_CPU;
734 dp->filter = tag_ops->filter;
735 dp->rcv = tag_ops->rcv;
736 dp->tag_ops = tag_ops;
742 static int dsa_port_parse_of(struct dsa_port *dp, struct device_node *dn)
744 struct device_node *ethernet = of_parse_phandle(dn, "ethernet", 0);
745 const char *name = of_get_property(dn, "label", NULL);
746 bool link = of_property_read_bool(dn, "link");
751 struct net_device *master;
753 master = of_find_net_device_by_node(ethernet);
755 return -EPROBE_DEFER;
757 return dsa_port_parse_cpu(dp, master);
761 return dsa_port_parse_dsa(dp);
763 return dsa_port_parse_user(dp, name);
766 static int dsa_switch_parse_ports_of(struct dsa_switch *ds,
767 struct device_node *dn)
769 struct device_node *ports, *port;
774 ports = of_get_child_by_name(dn, "ports");
776 /* The second possibility is "ethernet-ports" */
777 ports = of_get_child_by_name(dn, "ethernet-ports");
779 dev_err(ds->dev, "no ports child node found\n");
784 for_each_available_child_of_node(ports, port) {
785 err = of_property_read_u32(port, "reg", ®);
789 if (reg >= ds->num_ports) {
794 dp = dsa_to_port(ds, reg);
796 err = dsa_port_parse_of(dp, port);
806 static int dsa_switch_parse_member_of(struct dsa_switch *ds,
807 struct device_node *dn)
812 /* Don't error out if this optional property isn't found */
813 sz = of_property_read_variable_u32_array(dn, "dsa,member", m, 2, 2);
814 if (sz < 0 && sz != -EINVAL)
819 ds->dst = dsa_tree_touch(m[0]);
826 static int dsa_switch_touch_ports(struct dsa_switch *ds)
831 for (port = 0; port < ds->num_ports; port++) {
832 dp = dsa_port_touch(ds, port);
840 static int dsa_switch_parse_of(struct dsa_switch *ds, struct device_node *dn)
844 err = dsa_switch_parse_member_of(ds, dn);
848 err = dsa_switch_touch_ports(ds);
852 return dsa_switch_parse_ports_of(ds, dn);
855 static int dsa_port_parse(struct dsa_port *dp, const char *name,
858 if (!strcmp(name, "cpu")) {
859 struct net_device *master;
861 master = dsa_dev_to_net_device(dev);
863 return -EPROBE_DEFER;
867 return dsa_port_parse_cpu(dp, master);
870 if (!strcmp(name, "dsa"))
871 return dsa_port_parse_dsa(dp);
873 return dsa_port_parse_user(dp, name);
876 static int dsa_switch_parse_ports(struct dsa_switch *ds,
877 struct dsa_chip_data *cd)
879 bool valid_name_found = false;
886 for (i = 0; i < DSA_MAX_PORTS; i++) {
887 name = cd->port_names[i];
889 dp = dsa_to_port(ds, i);
894 err = dsa_port_parse(dp, name, dev);
898 valid_name_found = true;
901 if (!valid_name_found && i == DSA_MAX_PORTS)
907 static int dsa_switch_parse(struct dsa_switch *ds, struct dsa_chip_data *cd)
913 /* We don't support interconnected switches nor multiple trees via
914 * platform data, so this is the unique switch of the tree.
917 ds->dst = dsa_tree_touch(0);
921 err = dsa_switch_touch_ports(ds);
925 return dsa_switch_parse_ports(ds, cd);
928 static void dsa_switch_release_ports(struct dsa_switch *ds)
930 struct dsa_switch_tree *dst = ds->dst;
931 struct dsa_port *dp, *next;
933 list_for_each_entry_safe(dp, next, &dst->ports, list) {
941 static int dsa_switch_probe(struct dsa_switch *ds)
943 struct dsa_switch_tree *dst;
944 struct dsa_chip_data *pdata;
945 struct device_node *np;
951 pdata = ds->dev->platform_data;
952 np = ds->dev->of_node;
958 err = dsa_switch_parse_of(ds, np);
960 dsa_switch_release_ports(ds);
962 err = dsa_switch_parse(ds, pdata);
964 dsa_switch_release_ports(ds);
974 err = dsa_tree_setup(dst);
976 dsa_switch_release_ports(ds);
983 int dsa_register_switch(struct dsa_switch *ds)
987 mutex_lock(&dsa2_mutex);
988 err = dsa_switch_probe(ds);
989 dsa_tree_put(ds->dst);
990 mutex_unlock(&dsa2_mutex);
994 EXPORT_SYMBOL_GPL(dsa_register_switch);
996 static void dsa_switch_remove(struct dsa_switch *ds)
998 struct dsa_switch_tree *dst = ds->dst;
1000 dsa_tree_teardown(dst);
1001 dsa_switch_release_ports(ds);
1005 void dsa_unregister_switch(struct dsa_switch *ds)
1007 mutex_lock(&dsa2_mutex);
1008 dsa_switch_remove(ds);
1009 mutex_unlock(&dsa2_mutex);
1011 EXPORT_SYMBOL_GPL(dsa_unregister_switch);