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 static const struct devlink_ops dsa_devlink_ops = {
27 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index)
29 struct dsa_switch_tree *dst;
32 list_for_each_entry(dst, &dsa_tree_list, list) {
33 if (dst->index != tree_index)
36 list_for_each_entry(dp, &dst->ports, list) {
37 if (dp->ds->index != sw_index)
46 EXPORT_SYMBOL_GPL(dsa_switch_find);
48 static struct dsa_switch_tree *dsa_tree_find(int index)
50 struct dsa_switch_tree *dst;
52 list_for_each_entry(dst, &dsa_tree_list, list)
53 if (dst->index == index)
59 static struct dsa_switch_tree *dsa_tree_alloc(int index)
61 struct dsa_switch_tree *dst;
63 dst = kzalloc(sizeof(*dst), GFP_KERNEL);
69 INIT_LIST_HEAD(&dst->rtable);
71 INIT_LIST_HEAD(&dst->ports);
73 INIT_LIST_HEAD(&dst->list);
74 list_add_tail(&dst->list, &dsa_tree_list);
76 kref_init(&dst->refcount);
81 static void dsa_tree_free(struct dsa_switch_tree *dst)
87 static struct dsa_switch_tree *dsa_tree_get(struct dsa_switch_tree *dst)
90 kref_get(&dst->refcount);
95 static struct dsa_switch_tree *dsa_tree_touch(int index)
97 struct dsa_switch_tree *dst;
99 dst = dsa_tree_find(index);
101 return dsa_tree_get(dst);
103 return dsa_tree_alloc(index);
106 static void dsa_tree_release(struct kref *ref)
108 struct dsa_switch_tree *dst;
110 dst = container_of(ref, struct dsa_switch_tree, refcount);
115 static void dsa_tree_put(struct dsa_switch_tree *dst)
118 kref_put(&dst->refcount, dsa_tree_release);
121 static bool dsa_port_is_dsa(struct dsa_port *port)
123 return port->type == DSA_PORT_TYPE_DSA;
126 static bool dsa_port_is_cpu(struct dsa_port *port)
128 return port->type == DSA_PORT_TYPE_CPU;
131 static bool dsa_port_is_user(struct dsa_port *dp)
133 return dp->type == DSA_PORT_TYPE_USER;
136 static struct dsa_port *dsa_tree_find_port_by_node(struct dsa_switch_tree *dst,
137 struct device_node *dn)
141 list_for_each_entry(dp, &dst->ports, list)
148 static struct dsa_link *dsa_link_touch(struct dsa_port *dp,
149 struct dsa_port *link_dp)
151 struct dsa_switch *ds = dp->ds;
152 struct dsa_switch_tree *dst;
157 list_for_each_entry(dl, &dst->rtable, list)
158 if (dl->dp == dp && dl->link_dp == link_dp)
161 dl = kzalloc(sizeof(*dl), GFP_KERNEL);
166 dl->link_dp = link_dp;
168 INIT_LIST_HEAD(&dl->list);
169 list_add_tail(&dl->list, &dst->rtable);
174 static bool dsa_port_setup_routing_table(struct dsa_port *dp)
176 struct dsa_switch *ds = dp->ds;
177 struct dsa_switch_tree *dst = ds->dst;
178 struct device_node *dn = dp->dn;
179 struct of_phandle_iterator it;
180 struct dsa_port *link_dp;
184 of_for_each_phandle(&it, err, dn, "link", NULL, 0) {
185 link_dp = dsa_tree_find_port_by_node(dst, it.node);
187 of_node_put(it.node);
191 dl = dsa_link_touch(dp, link_dp);
193 of_node_put(it.node);
201 static bool dsa_tree_setup_routing_table(struct dsa_switch_tree *dst)
203 bool complete = true;
206 list_for_each_entry(dp, &dst->ports, list) {
207 if (dsa_port_is_dsa(dp)) {
208 complete = dsa_port_setup_routing_table(dp);
217 static struct dsa_port *dsa_tree_find_first_cpu(struct dsa_switch_tree *dst)
221 list_for_each_entry(dp, &dst->ports, list)
222 if (dsa_port_is_cpu(dp))
228 static int dsa_tree_setup_default_cpu(struct dsa_switch_tree *dst)
230 struct dsa_port *cpu_dp, *dp;
232 cpu_dp = dsa_tree_find_first_cpu(dst);
234 pr_err("DSA: tree %d has no CPU port\n", dst->index);
238 /* Assign the default CPU port to all ports of the fabric */
239 list_for_each_entry(dp, &dst->ports, list)
240 if (dsa_port_is_user(dp) || dsa_port_is_dsa(dp))
246 static void dsa_tree_teardown_default_cpu(struct dsa_switch_tree *dst)
250 list_for_each_entry(dp, &dst->ports, list)
251 if (dsa_port_is_user(dp) || dsa_port_is_dsa(dp))
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;
272 case DSA_PORT_TYPE_UNUSED:
273 dsa_port_disable(dp);
275 case DSA_PORT_TYPE_CPU:
276 memset(dlp, 0, sizeof(*dlp));
277 devlink_port_attrs_set(dlp, DEVLINK_PORT_FLAVOUR_CPU,
278 dp->index, false, 0, id, len);
279 err = devlink_port_register(dl, dlp, dp->index);
282 devlink_port_registered = true;
284 err = dsa_port_link_register_of(dp);
287 dsa_port_link_registered = true;
289 err = dsa_port_enable(dp, NULL);
292 dsa_port_enabled = true;
295 case DSA_PORT_TYPE_DSA:
296 memset(dlp, 0, sizeof(*dlp));
297 devlink_port_attrs_set(dlp, DEVLINK_PORT_FLAVOUR_DSA,
298 dp->index, false, 0, id, len);
299 err = devlink_port_register(dl, dlp, dp->index);
302 devlink_port_registered = true;
304 err = dsa_port_link_register_of(dp);
307 dsa_port_link_registered = true;
309 err = dsa_port_enable(dp, NULL);
312 dsa_port_enabled = true;
315 case DSA_PORT_TYPE_USER:
316 memset(dlp, 0, sizeof(*dlp));
317 devlink_port_attrs_set(dlp, DEVLINK_PORT_FLAVOUR_PHYSICAL,
318 dp->index, false, 0, id, len);
319 err = devlink_port_register(dl, dlp, dp->index);
322 devlink_port_registered = true;
324 dp->mac = of_get_mac_address(dp->dn);
325 err = dsa_slave_create(dp);
329 devlink_port_type_eth_set(dlp, dp->slave);
333 if (err && dsa_port_enabled)
334 dsa_port_disable(dp);
335 if (err && dsa_port_link_registered)
336 dsa_port_link_unregister_of(dp);
337 if (err && devlink_port_registered)
338 devlink_port_unregister(dlp);
347 static void dsa_port_teardown(struct dsa_port *dp)
349 struct devlink_port *dlp = &dp->devlink_port;
355 case DSA_PORT_TYPE_UNUSED:
357 case DSA_PORT_TYPE_CPU:
358 dsa_port_disable(dp);
359 dsa_tag_driver_put(dp->tag_ops);
360 devlink_port_unregister(dlp);
361 dsa_port_link_unregister_of(dp);
363 case DSA_PORT_TYPE_DSA:
364 dsa_port_disable(dp);
365 devlink_port_unregister(dlp);
366 dsa_port_link_unregister_of(dp);
368 case DSA_PORT_TYPE_USER:
369 devlink_port_unregister(dlp);
371 dsa_slave_destroy(dp->slave);
380 static int dsa_switch_setup(struct dsa_switch *ds)
382 struct dsa_devlink_priv *dl_priv;
388 /* Initialize ds->phys_mii_mask before registering the slave MDIO bus
389 * driver and before ops->setup() has run, since the switch drivers and
390 * the slave MDIO bus driver rely on these values for probing PHY
393 ds->phys_mii_mask |= dsa_user_ports(ds);
395 /* Add the switch to devlink before calling setup, so that setup can
398 ds->devlink = devlink_alloc(&dsa_devlink_ops, sizeof(*dl_priv));
401 dl_priv = devlink_priv(ds->devlink);
404 err = devlink_register(ds->devlink, ds->dev);
408 err = dsa_switch_register_notifier(ds);
410 goto unregister_devlink;
412 err = ds->ops->setup(ds);
414 goto unregister_notifier;
416 devlink_params_publish(ds->devlink);
418 if (!ds->slave_mii_bus && ds->ops->phy_read) {
419 ds->slave_mii_bus = devm_mdiobus_alloc(ds->dev);
420 if (!ds->slave_mii_bus) {
422 goto unregister_notifier;
425 dsa_slave_mii_bus_init(ds);
427 err = mdiobus_register(ds->slave_mii_bus);
429 goto unregister_notifier;
437 dsa_switch_unregister_notifier(ds);
439 devlink_unregister(ds->devlink);
441 devlink_free(ds->devlink);
447 static void dsa_switch_teardown(struct dsa_switch *ds)
452 if (ds->slave_mii_bus && ds->ops->phy_read)
453 mdiobus_unregister(ds->slave_mii_bus);
455 dsa_switch_unregister_notifier(ds);
457 if (ds->ops->teardown)
458 ds->ops->teardown(ds);
461 devlink_unregister(ds->devlink);
462 devlink_free(ds->devlink);
469 static int dsa_tree_setup_switches(struct dsa_switch_tree *dst)
474 list_for_each_entry(dp, &dst->ports, list) {
475 err = dsa_switch_setup(dp->ds);
480 list_for_each_entry(dp, &dst->ports, list) {
481 err = dsa_port_setup(dp);
489 list_for_each_entry(dp, &dst->ports, list)
490 dsa_port_teardown(dp);
492 list_for_each_entry(dp, &dst->ports, list)
493 dsa_switch_teardown(dp->ds);
498 static void dsa_tree_teardown_switches(struct dsa_switch_tree *dst)
502 list_for_each_entry(dp, &dst->ports, list)
503 dsa_port_teardown(dp);
505 list_for_each_entry(dp, &dst->ports, list)
506 dsa_switch_teardown(dp->ds);
509 static int dsa_tree_setup_master(struct dsa_switch_tree *dst)
514 list_for_each_entry(dp, &dst->ports, list) {
515 if (dsa_port_is_cpu(dp)) {
516 err = dsa_master_setup(dp->master, dp);
525 static void dsa_tree_teardown_master(struct dsa_switch_tree *dst)
529 list_for_each_entry(dp, &dst->ports, list)
530 if (dsa_port_is_cpu(dp))
531 dsa_master_teardown(dp->master);
534 static int dsa_tree_setup(struct dsa_switch_tree *dst)
540 pr_err("DSA: tree %d already setup! Disjoint trees?\n",
545 complete = dsa_tree_setup_routing_table(dst);
549 err = dsa_tree_setup_default_cpu(dst);
553 err = dsa_tree_setup_switches(dst);
555 goto teardown_default_cpu;
557 err = dsa_tree_setup_master(dst);
559 goto teardown_switches;
563 pr_info("DSA: tree %d setup\n", dst->index);
568 dsa_tree_teardown_switches(dst);
569 teardown_default_cpu:
570 dsa_tree_teardown_default_cpu(dst);
575 static void dsa_tree_teardown(struct dsa_switch_tree *dst)
577 struct dsa_link *dl, *next;
582 dsa_tree_teardown_master(dst);
584 dsa_tree_teardown_switches(dst);
586 dsa_tree_teardown_default_cpu(dst);
588 list_for_each_entry_safe(dl, next, &dst->rtable, list) {
593 pr_info("DSA: tree %d torn down\n", dst->index);
598 static struct dsa_port *dsa_port_touch(struct dsa_switch *ds, int index)
600 struct dsa_switch_tree *dst = ds->dst;
603 list_for_each_entry(dp, &dst->ports, list)
604 if (dp->ds == ds && dp->index == index)
607 dp = kzalloc(sizeof(*dp), GFP_KERNEL);
614 INIT_LIST_HEAD(&dp->list);
615 list_add_tail(&dp->list, &dst->ports);
620 static int dsa_port_parse_user(struct dsa_port *dp, const char *name)
625 dp->type = DSA_PORT_TYPE_USER;
631 static int dsa_port_parse_dsa(struct dsa_port *dp)
633 dp->type = DSA_PORT_TYPE_DSA;
638 static enum dsa_tag_protocol dsa_get_tag_protocol(struct dsa_port *dp,
639 struct net_device *master)
641 enum dsa_tag_protocol tag_protocol = DSA_TAG_PROTO_NONE;
642 struct dsa_switch *mds, *ds = dp->ds;
643 unsigned int mdp_upstream;
644 struct dsa_port *mdp;
646 /* It is possible to stack DSA switches onto one another when that
647 * happens the switch driver may want to know if its tagging protocol
648 * is going to work in such a configuration.
650 if (dsa_slave_dev_check(master)) {
651 mdp = dsa_slave_to_port(master);
653 mdp_upstream = dsa_upstream_port(mds, mdp->index);
654 tag_protocol = mds->ops->get_tag_protocol(mds, mdp_upstream,
658 /* If the master device is not itself a DSA slave in a disjoint DSA
659 * tree, then return immediately.
661 return ds->ops->get_tag_protocol(ds, dp->index, tag_protocol);
664 static int dsa_port_parse_cpu(struct dsa_port *dp, struct net_device *master)
666 struct dsa_switch *ds = dp->ds;
667 struct dsa_switch_tree *dst = ds->dst;
668 const struct dsa_device_ops *tag_ops;
669 enum dsa_tag_protocol tag_protocol;
671 tag_protocol = dsa_get_tag_protocol(dp, master);
672 tag_ops = dsa_tag_driver_get(tag_protocol);
673 if (IS_ERR(tag_ops)) {
674 if (PTR_ERR(tag_ops) == -ENOPROTOOPT)
675 return -EPROBE_DEFER;
676 dev_warn(ds->dev, "No tagger for this switch\n");
678 return PTR_ERR(tag_ops);
682 dp->type = DSA_PORT_TYPE_CPU;
683 dp->filter = tag_ops->filter;
684 dp->rcv = tag_ops->rcv;
685 dp->tag_ops = tag_ops;
691 static int dsa_port_parse_of(struct dsa_port *dp, struct device_node *dn)
693 struct device_node *ethernet = of_parse_phandle(dn, "ethernet", 0);
694 const char *name = of_get_property(dn, "label", NULL);
695 bool link = of_property_read_bool(dn, "link");
700 struct net_device *master;
702 master = of_find_net_device_by_node(ethernet);
704 return -EPROBE_DEFER;
706 return dsa_port_parse_cpu(dp, master);
710 return dsa_port_parse_dsa(dp);
712 return dsa_port_parse_user(dp, name);
715 static int dsa_switch_parse_ports_of(struct dsa_switch *ds,
716 struct device_node *dn)
718 struct device_node *ports, *port;
723 ports = of_get_child_by_name(dn, "ports");
725 dev_err(ds->dev, "no ports child node found\n");
729 for_each_available_child_of_node(ports, port) {
730 err = of_property_read_u32(port, "reg", ®);
734 if (reg >= ds->num_ports) {
739 dp = dsa_to_port(ds, reg);
741 err = dsa_port_parse_of(dp, port);
751 static int dsa_switch_parse_member_of(struct dsa_switch *ds,
752 struct device_node *dn)
757 /* Don't error out if this optional property isn't found */
758 sz = of_property_read_variable_u32_array(dn, "dsa,member", m, 2, 2);
759 if (sz < 0 && sz != -EINVAL)
764 ds->dst = dsa_tree_touch(m[0]);
771 static int dsa_switch_touch_ports(struct dsa_switch *ds)
776 for (port = 0; port < ds->num_ports; port++) {
777 dp = dsa_port_touch(ds, port);
785 static int dsa_switch_parse_of(struct dsa_switch *ds, struct device_node *dn)
789 err = dsa_switch_parse_member_of(ds, dn);
793 err = dsa_switch_touch_ports(ds);
797 return dsa_switch_parse_ports_of(ds, dn);
800 static int dsa_port_parse(struct dsa_port *dp, const char *name,
803 if (!strcmp(name, "cpu")) {
804 struct net_device *master;
806 master = dsa_dev_to_net_device(dev);
808 return -EPROBE_DEFER;
812 return dsa_port_parse_cpu(dp, master);
815 if (!strcmp(name, "dsa"))
816 return dsa_port_parse_dsa(dp);
818 return dsa_port_parse_user(dp, name);
821 static int dsa_switch_parse_ports(struct dsa_switch *ds,
822 struct dsa_chip_data *cd)
824 bool valid_name_found = false;
831 for (i = 0; i < DSA_MAX_PORTS; i++) {
832 name = cd->port_names[i];
834 dp = dsa_to_port(ds, i);
839 err = dsa_port_parse(dp, name, dev);
843 valid_name_found = true;
846 if (!valid_name_found && i == DSA_MAX_PORTS)
852 static int dsa_switch_parse(struct dsa_switch *ds, struct dsa_chip_data *cd)
858 /* We don't support interconnected switches nor multiple trees via
859 * platform data, so this is the unique switch of the tree.
862 ds->dst = dsa_tree_touch(0);
866 err = dsa_switch_touch_ports(ds);
870 return dsa_switch_parse_ports(ds, cd);
873 static void dsa_switch_release_ports(struct dsa_switch *ds)
875 struct dsa_switch_tree *dst = ds->dst;
876 struct dsa_port *dp, *next;
878 list_for_each_entry_safe(dp, next, &dst->ports, list) {
886 static int dsa_switch_probe(struct dsa_switch *ds)
888 struct dsa_switch_tree *dst;
889 struct dsa_chip_data *pdata;
890 struct device_node *np;
896 pdata = ds->dev->platform_data;
897 np = ds->dev->of_node;
903 err = dsa_switch_parse_of(ds, np);
905 dsa_switch_release_ports(ds);
907 err = dsa_switch_parse(ds, pdata);
909 dsa_switch_release_ports(ds);
919 err = dsa_tree_setup(dst);
921 dsa_switch_release_ports(ds);
928 int dsa_register_switch(struct dsa_switch *ds)
932 mutex_lock(&dsa2_mutex);
933 err = dsa_switch_probe(ds);
934 dsa_tree_put(ds->dst);
935 mutex_unlock(&dsa2_mutex);
939 EXPORT_SYMBOL_GPL(dsa_register_switch);
941 static void dsa_switch_remove(struct dsa_switch *ds)
943 struct dsa_switch_tree *dst = ds->dst;
945 dsa_tree_teardown(dst);
946 dsa_switch_release_ports(ds);
950 void dsa_unregister_switch(struct dsa_switch *ds)
952 mutex_lock(&dsa2_mutex);
953 dsa_switch_remove(ds);
954 mutex_unlock(&dsa2_mutex);
956 EXPORT_SYMBOL_GPL(dsa_unregister_switch);