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
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(&dsa_tree_list, &dst->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) {
402 goto unregister_notifier;
405 dsa_slave_mii_bus_init(ds);
407 err = mdiobus_register(ds->slave_mii_bus);
409 goto unregister_notifier;
415 dsa_switch_unregister_notifier(ds);
417 devlink_unregister(ds->devlink);
419 devlink_free(ds->devlink);
425 static void dsa_switch_teardown(struct dsa_switch *ds)
427 if (ds->slave_mii_bus && ds->ops->phy_read)
428 mdiobus_unregister(ds->slave_mii_bus);
430 dsa_switch_unregister_notifier(ds);
432 if (ds->ops->teardown)
433 ds->ops->teardown(ds);
436 devlink_unregister(ds->devlink);
437 devlink_free(ds->devlink);
443 static int dsa_tree_setup_switches(struct dsa_switch_tree *dst)
445 struct dsa_switch *ds;
450 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
451 ds = dst->ds[device];
455 err = dsa_switch_setup(ds);
457 goto switch_teardown;
459 for (port = 0; port < ds->num_ports; port++) {
460 dp = &ds->ports[port];
462 err = dsa_port_setup(dp);
471 for (i = 0; i < port; i++)
472 dsa_port_teardown(&ds->ports[i]);
474 dsa_switch_teardown(ds);
477 for (i = 0; i < device; i++) {
482 for (port = 0; port < ds->num_ports; port++) {
483 dp = &ds->ports[port];
485 dsa_port_teardown(dp);
488 dsa_switch_teardown(ds);
494 static void dsa_tree_teardown_switches(struct dsa_switch_tree *dst)
496 struct dsa_switch *ds;
500 for (device = 0; device < DSA_MAX_SWITCHES; device++) {
501 ds = dst->ds[device];
505 for (port = 0; port < ds->num_ports; port++) {
506 dp = &ds->ports[port];
508 dsa_port_teardown(dp);
511 dsa_switch_teardown(ds);
515 static int dsa_tree_setup_master(struct dsa_switch_tree *dst)
517 struct dsa_port *cpu_dp = dst->cpu_dp;
518 struct net_device *master = cpu_dp->master;
520 /* DSA currently supports a single pair of CPU port and master device */
521 return dsa_master_setup(master, cpu_dp);
524 static void dsa_tree_teardown_master(struct dsa_switch_tree *dst)
526 struct dsa_port *cpu_dp = dst->cpu_dp;
527 struct net_device *master = cpu_dp->master;
529 return dsa_master_teardown(master);
532 static int dsa_tree_setup(struct dsa_switch_tree *dst)
538 pr_err("DSA: tree %d already setup! Disjoint trees?\n",
543 complete = dsa_tree_setup_routing_table(dst);
547 err = dsa_tree_setup_default_cpu(dst);
551 err = dsa_tree_setup_switches(dst);
553 goto teardown_default_cpu;
555 err = dsa_tree_setup_master(dst);
557 goto teardown_switches;
561 pr_info("DSA: tree %d setup\n", dst->index);
566 dsa_tree_teardown_switches(dst);
567 teardown_default_cpu:
568 dsa_tree_teardown_default_cpu(dst);
573 static void dsa_tree_teardown(struct dsa_switch_tree *dst)
578 dsa_tree_teardown_master(dst);
580 dsa_tree_teardown_switches(dst);
582 dsa_tree_teardown_default_cpu(dst);
584 pr_info("DSA: tree %d torn down\n", dst->index);
589 static void dsa_tree_remove_switch(struct dsa_switch_tree *dst,
592 dsa_tree_teardown(dst);
594 dst->ds[index] = NULL;
598 static int dsa_tree_add_switch(struct dsa_switch_tree *dst,
599 struct dsa_switch *ds)
601 unsigned int index = ds->index;
610 err = dsa_tree_setup(dst);
612 dst->ds[index] = NULL;
619 static int dsa_port_parse_user(struct dsa_port *dp, const char *name)
624 dp->type = DSA_PORT_TYPE_USER;
630 static int dsa_port_parse_dsa(struct dsa_port *dp)
632 dp->type = DSA_PORT_TYPE_DSA;
637 static int dsa_port_parse_cpu(struct dsa_port *dp, struct net_device *master)
639 struct dsa_switch *ds = dp->ds;
640 struct dsa_switch_tree *dst = ds->dst;
641 const struct dsa_device_ops *tag_ops;
642 enum dsa_tag_protocol tag_protocol;
644 tag_protocol = ds->ops->get_tag_protocol(ds, dp->index);
645 tag_ops = dsa_tag_driver_get(tag_protocol);
646 if (IS_ERR(tag_ops)) {
647 if (PTR_ERR(tag_ops) == -ENOPROTOOPT)
648 return -EPROBE_DEFER;
649 dev_warn(ds->dev, "No tagger for this switch\n");
650 return PTR_ERR(tag_ops);
653 dp->type = DSA_PORT_TYPE_CPU;
654 dp->filter = tag_ops->filter;
655 dp->rcv = tag_ops->rcv;
656 dp->tag_ops = tag_ops;
663 static int dsa_port_parse_of(struct dsa_port *dp, struct device_node *dn)
665 struct device_node *ethernet = of_parse_phandle(dn, "ethernet", 0);
666 const char *name = of_get_property(dn, "label", NULL);
667 bool link = of_property_read_bool(dn, "link");
672 struct net_device *master;
674 master = of_find_net_device_by_node(ethernet);
676 return -EPROBE_DEFER;
678 return dsa_port_parse_cpu(dp, master);
682 return dsa_port_parse_dsa(dp);
684 return dsa_port_parse_user(dp, name);
687 static int dsa_switch_parse_ports_of(struct dsa_switch *ds,
688 struct device_node *dn)
690 struct device_node *ports, *port;
695 ports = of_get_child_by_name(dn, "ports");
697 dev_err(ds->dev, "no ports child node found\n");
701 for_each_available_child_of_node(ports, port) {
702 err = of_property_read_u32(port, "reg", ®);
706 if (reg >= ds->num_ports) {
711 dp = &ds->ports[reg];
713 err = dsa_port_parse_of(dp, port);
723 static int dsa_switch_parse_member_of(struct dsa_switch *ds,
724 struct device_node *dn)
729 /* Don't error out if this optional property isn't found */
730 sz = of_property_read_variable_u32_array(dn, "dsa,member", m, 2, 2);
731 if (sz < 0 && sz != -EINVAL)
735 if (ds->index >= DSA_MAX_SWITCHES)
738 ds->dst = dsa_tree_touch(m[0]);
745 static int dsa_switch_parse_of(struct dsa_switch *ds, struct device_node *dn)
749 err = dsa_switch_parse_member_of(ds, dn);
753 return dsa_switch_parse_ports_of(ds, dn);
756 static int dsa_port_parse(struct dsa_port *dp, const char *name,
759 if (!strcmp(name, "cpu")) {
760 struct net_device *master;
762 master = dsa_dev_to_net_device(dev);
764 return -EPROBE_DEFER;
768 return dsa_port_parse_cpu(dp, master);
771 if (!strcmp(name, "dsa"))
772 return dsa_port_parse_dsa(dp);
774 return dsa_port_parse_user(dp, name);
777 static int dsa_switch_parse_ports(struct dsa_switch *ds,
778 struct dsa_chip_data *cd)
780 bool valid_name_found = false;
787 for (i = 0; i < DSA_MAX_PORTS; i++) {
788 name = cd->port_names[i];
795 err = dsa_port_parse(dp, name, dev);
799 valid_name_found = true;
802 if (!valid_name_found && i == DSA_MAX_PORTS)
808 static int dsa_switch_parse(struct dsa_switch *ds, struct dsa_chip_data *cd)
812 /* We don't support interconnected switches nor multiple trees via
813 * platform data, so this is the unique switch of the tree.
816 ds->dst = dsa_tree_touch(0);
820 return dsa_switch_parse_ports(ds, cd);
823 static int dsa_switch_add(struct dsa_switch *ds)
825 struct dsa_switch_tree *dst = ds->dst;
827 return dsa_tree_add_switch(dst, ds);
830 static int dsa_switch_probe(struct dsa_switch *ds)
832 struct dsa_chip_data *pdata = ds->dev->platform_data;
833 struct device_node *np = ds->dev->of_node;
837 err = dsa_switch_parse_of(ds, np);
839 err = dsa_switch_parse(ds, pdata);
846 return dsa_switch_add(ds);
849 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n)
851 struct dsa_switch *ds;
854 ds = devm_kzalloc(dev, struct_size(ds, ports, n), GFP_KERNEL);
861 for (i = 0; i < ds->num_ports; ++i) {
862 ds->ports[i].index = i;
863 ds->ports[i].ds = ds;
868 EXPORT_SYMBOL_GPL(dsa_switch_alloc);
870 int dsa_register_switch(struct dsa_switch *ds)
874 mutex_lock(&dsa2_mutex);
875 err = dsa_switch_probe(ds);
876 dsa_tree_put(ds->dst);
877 mutex_unlock(&dsa2_mutex);
881 EXPORT_SYMBOL_GPL(dsa_register_switch);
883 static void dsa_switch_remove(struct dsa_switch *ds)
885 struct dsa_switch_tree *dst = ds->dst;
886 unsigned int index = ds->index;
888 dsa_tree_remove_switch(dst, index);
891 void dsa_unregister_switch(struct dsa_switch *ds)
893 mutex_lock(&dsa2_mutex);
894 dsa_switch_remove(ds);
895 mutex_unlock(&dsa2_mutex);
897 EXPORT_SYMBOL_GPL(dsa_unregister_switch);