2 * net/dsa/dsa2.c - Hardware switch handling, binding version 2
3 * Copyright (c) 2008-2009 Marvell Semiconductor
4 * Copyright (c) 2013 Florian Fainelli <florian@openwrt.org>
5 * Copyright (c) 2016 Andrew Lunn <andrew@lunn.ch>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/list.h>
16 #include <linux/netdevice.h>
17 #include <linux/slab.h>
18 #include <linux/rtnetlink.h>
20 #include <linux/of_net.h>
24 static LIST_HEAD(dsa_switch_trees);
25 static DEFINE_MUTEX(dsa2_mutex);
27 static const struct devlink_ops dsa_devlink_ops = {
30 static struct dsa_switch_tree *dsa_get_dst(u32 tree)
32 struct dsa_switch_tree *dst;
34 list_for_each_entry(dst, &dsa_switch_trees, list)
35 if (dst->tree == tree) {
36 kref_get(&dst->refcount);
42 static void dsa_free_dst(struct kref *ref)
44 struct dsa_switch_tree *dst = container_of(ref, struct dsa_switch_tree,
51 static void dsa_put_dst(struct dsa_switch_tree *dst)
53 kref_put(&dst->refcount, dsa_free_dst);
56 static struct dsa_switch_tree *dsa_add_dst(u32 tree)
58 struct dsa_switch_tree *dst;
60 dst = kzalloc(sizeof(*dst), GFP_KERNEL);
64 INIT_LIST_HEAD(&dst->list);
65 list_add_tail(&dsa_switch_trees, &dst->list);
66 kref_init(&dst->refcount);
71 static void dsa_dst_add_ds(struct dsa_switch_tree *dst,
72 struct dsa_switch *ds, u32 index)
74 kref_get(&dst->refcount);
78 static void dsa_dst_del_ds(struct dsa_switch_tree *dst,
79 struct dsa_switch *ds, u32 index)
81 dst->ds[index] = NULL;
82 kref_put(&dst->refcount, dsa_free_dst);
85 /* For platform data configurations, we need to have a valid name argument to
86 * differentiate a disabled port from an enabled one
88 static bool dsa_port_is_valid(struct dsa_port *port)
90 return !!(port->dn || port->name);
93 static bool dsa_port_is_dsa(struct dsa_port *port)
95 if (port->name && !strcmp(port->name, "dsa"))
98 return !!of_parse_phandle(port->dn, "link", 0);
101 static bool dsa_port_is_cpu(struct dsa_port *port)
103 if (port->name && !strcmp(port->name, "cpu"))
106 return !!of_parse_phandle(port->dn, "ethernet", 0);
109 static bool dsa_ds_find_port_dn(struct dsa_switch *ds,
110 struct device_node *port)
114 for (index = 0; index < ds->num_ports; index++)
115 if (ds->ports[index].dn == port)
120 static struct dsa_switch *dsa_dst_find_port_dn(struct dsa_switch_tree *dst,
121 struct device_node *port)
123 struct dsa_switch *ds;
126 for (index = 0; index < DSA_MAX_SWITCHES; index++) {
131 if (dsa_ds_find_port_dn(ds, port))
138 static int dsa_port_complete(struct dsa_switch_tree *dst,
139 struct dsa_switch *src_ds,
140 struct dsa_port *port,
143 struct device_node *link;
145 struct dsa_switch *dst_ds;
147 for (index = 0;; index++) {
148 link = of_parse_phandle(port->dn, "link", index);
152 dst_ds = dsa_dst_find_port_dn(dst, link);
158 src_ds->rtable[dst_ds->index] = src_port;
164 /* A switch is complete if all the DSA ports phandles point to ports
165 * known in the tree. A return value of 1 means the tree is not
166 * complete. This is not an error condition. A value of 0 is
169 static int dsa_ds_complete(struct dsa_switch_tree *dst, struct dsa_switch *ds)
171 struct dsa_port *port;
175 for (index = 0; index < ds->num_ports; index++) {
176 port = &ds->ports[index];
177 if (!dsa_port_is_valid(port))
180 if (!dsa_port_is_dsa(port))
183 err = dsa_port_complete(dst, ds, port, index);
187 ds->dsa_port_mask |= BIT(index);
193 /* A tree is complete if all the DSA ports phandles point to ports
194 * known in the tree. A return value of 1 means the tree is not
195 * complete. This is not an error condition. A value of 0 is
198 static int dsa_dst_complete(struct dsa_switch_tree *dst)
200 struct dsa_switch *ds;
204 for (index = 0; index < DSA_MAX_SWITCHES; index++) {
209 err = dsa_ds_complete(dst, ds);
217 static int dsa_dsa_port_apply(struct dsa_port *port)
219 struct dsa_switch *ds = port->ds;
222 err = dsa_cpu_dsa_setup(port);
224 dev_warn(ds->dev, "Failed to setup dsa port %d: %d\n",
229 memset(&port->devlink_port, 0, sizeof(port->devlink_port));
231 return devlink_port_register(ds->devlink, &port->devlink_port,
235 static void dsa_dsa_port_unapply(struct dsa_port *port)
237 devlink_port_unregister(&port->devlink_port);
238 dsa_cpu_dsa_destroy(port);
241 static int dsa_cpu_port_apply(struct dsa_port *port)
243 struct dsa_switch *ds = port->ds;
246 err = dsa_cpu_dsa_setup(port);
248 dev_warn(ds->dev, "Failed to setup cpu port %d: %d\n",
253 memset(&port->devlink_port, 0, sizeof(port->devlink_port));
254 err = devlink_port_register(ds->devlink, &port->devlink_port,
259 static void dsa_cpu_port_unapply(struct dsa_port *port)
261 devlink_port_unregister(&port->devlink_port);
262 dsa_cpu_dsa_destroy(port);
265 static int dsa_user_port_apply(struct dsa_port *port)
267 struct dsa_switch *ds = port->ds;
268 const char *name = port->name;
272 name = of_get_property(port->dn, "label", NULL);
276 err = dsa_slave_create(port, name);
278 dev_warn(ds->dev, "Failed to create slave %d: %d\n",
284 memset(&port->devlink_port, 0, sizeof(port->devlink_port));
285 err = devlink_port_register(ds->devlink, &port->devlink_port,
290 devlink_port_type_eth_set(&port->devlink_port, port->slave);
295 static void dsa_user_port_unapply(struct dsa_port *port)
297 devlink_port_unregister(&port->devlink_port);
299 dsa_slave_destroy(port->slave);
304 static int dsa_ds_apply(struct dsa_switch_tree *dst, struct dsa_switch *ds)
306 struct dsa_port *port;
310 /* Initialize ds->phys_mii_mask before registering the slave MDIO bus
311 * driver and before ops->setup() has run, since the switch drivers and
312 * the slave MDIO bus driver rely on these values for probing PHY
315 ds->phys_mii_mask |= dsa_user_ports(ds);
317 /* Add the switch to devlink before calling setup, so that setup can
320 ds->devlink = devlink_alloc(&dsa_devlink_ops, 0);
324 err = devlink_register(ds->devlink, ds->dev);
328 err = ds->ops->setup(ds);
332 err = dsa_switch_register_notifier(ds);
336 if (!ds->slave_mii_bus && ds->ops->phy_read) {
337 ds->slave_mii_bus = devm_mdiobus_alloc(ds->dev);
338 if (!ds->slave_mii_bus)
341 dsa_slave_mii_bus_init(ds);
343 err = mdiobus_register(ds->slave_mii_bus);
348 for (index = 0; index < ds->num_ports; index++) {
349 port = &ds->ports[index];
350 if (!dsa_port_is_valid(port))
353 if (dsa_port_is_dsa(port)) {
354 err = dsa_dsa_port_apply(port);
360 if (dsa_port_is_cpu(port)) {
361 err = dsa_cpu_port_apply(port);
367 err = dsa_user_port_apply(port);
375 static void dsa_ds_unapply(struct dsa_switch_tree *dst, struct dsa_switch *ds)
377 struct dsa_port *port;
380 for (index = 0; index < ds->num_ports; index++) {
381 port = &ds->ports[index];
382 if (!dsa_port_is_valid(port))
385 if (dsa_port_is_dsa(port)) {
386 dsa_dsa_port_unapply(port);
390 if (dsa_port_is_cpu(port)) {
391 dsa_cpu_port_unapply(port);
395 dsa_user_port_unapply(port);
398 if (ds->slave_mii_bus && ds->ops->phy_read)
399 mdiobus_unregister(ds->slave_mii_bus);
401 dsa_switch_unregister_notifier(ds);
404 devlink_unregister(ds->devlink);
405 devlink_free(ds->devlink);
411 static int dsa_dst_apply(struct dsa_switch_tree *dst)
413 struct dsa_switch *ds;
417 for (index = 0; index < DSA_MAX_SWITCHES; index++) {
422 err = dsa_ds_apply(dst, ds);
427 /* If we use a tagging format that doesn't have an ethertype
428 * field, make sure that all packets from this point on get
429 * sent to the tag format's receive function.
432 dst->cpu_dp->master->dsa_ptr = dst->cpu_dp;
434 err = dsa_master_ethtool_setup(dst->cpu_dp->master);
443 static void dsa_dst_unapply(struct dsa_switch_tree *dst)
445 struct dsa_switch *ds;
451 dsa_master_ethtool_restore(dst->cpu_dp->master);
453 dst->cpu_dp->master->dsa_ptr = NULL;
455 /* If we used a tagging format that doesn't have an ethertype
456 * field, make sure that all packets from this point get sent
457 * without the tag and go through the regular receive path.
461 for (index = 0; index < DSA_MAX_SWITCHES; index++) {
466 dsa_ds_unapply(dst, ds);
471 pr_info("DSA: tree %d unapplied\n", dst->tree);
472 dst->applied = false;
475 static int dsa_cpu_parse(struct dsa_port *port, u32 index,
476 struct dsa_switch_tree *dst,
477 struct dsa_switch *ds)
479 const struct dsa_device_ops *tag_ops;
480 enum dsa_tag_protocol tag_protocol;
481 struct net_device *ethernet_dev;
482 struct device_node *ethernet;
485 ethernet = of_parse_phandle(port->dn, "ethernet", 0);
488 ethernet_dev = of_find_net_device_by_node(ethernet);
490 ethernet_dev = dsa_dev_to_net_device(ds->cd->netdev[index]);
491 dev_put(ethernet_dev);
495 return -EPROBE_DEFER;
499 dst->cpu_dp->master = ethernet_dev;
502 /* Initialize cpu_port_mask now for drv->setup()
503 * to have access to a correct value, just like what
504 * net/dsa/dsa.c::dsa_switch_setup_one does.
506 ds->cpu_port_mask |= BIT(index);
508 tag_protocol = ds->ops->get_tag_protocol(ds);
509 tag_ops = dsa_resolve_tag_protocol(tag_protocol);
510 if (IS_ERR(tag_ops)) {
511 dev_warn(ds->dev, "No tagger for this switch\n");
512 return PTR_ERR(tag_ops);
515 dst->cpu_dp->tag_ops = tag_ops;
517 /* Make a few copies for faster access in master receive hot path */
518 dst->cpu_dp->rcv = dst->cpu_dp->tag_ops->rcv;
519 dst->cpu_dp->dst = dst;
524 static int dsa_ds_parse(struct dsa_switch_tree *dst, struct dsa_switch *ds)
526 struct dsa_port *port;
530 for (index = 0; index < ds->num_ports; index++) {
531 port = &ds->ports[index];
532 if (!dsa_port_is_valid(port) ||
533 dsa_port_is_dsa(port))
536 if (dsa_port_is_cpu(port)) {
537 err = dsa_cpu_parse(port, index, dst, ds);
541 /* Initialize enabled_port_mask now for drv->setup()
542 * to have access to a correct value, just like what
543 * net/dsa/dsa.c::dsa_switch_setup_one does.
545 ds->enabled_port_mask |= BIT(index);
550 pr_info("DSA: switch %d %d parsed\n", dst->tree, ds->index);
555 static int dsa_dst_parse(struct dsa_switch_tree *dst)
557 struct dsa_switch *ds;
563 for (index = 0; index < DSA_MAX_SWITCHES; index++) {
568 err = dsa_ds_parse(dst, ds);
574 pr_warn("Tree has no master device\n");
578 /* Assign the default CPU port to all ports of the fabric */
579 for (index = 0; index < DSA_MAX_SWITCHES; index++) {
584 for (port = 0; port < ds->num_ports; port++) {
585 dp = &ds->ports[port];
586 if (!dsa_port_is_valid(dp) ||
587 dsa_port_is_dsa(dp) ||
591 dp->cpu_dp = dst->cpu_dp;
595 pr_info("DSA: tree %d parsed\n", dst->tree);
600 static int dsa_parse_ports_dn(struct device_node *ports, struct dsa_switch *ds)
602 struct device_node *port;
606 for_each_available_child_of_node(ports, port) {
607 err = of_property_read_u32(port, "reg", ®);
611 if (reg >= ds->num_ports)
614 ds->ports[reg].dn = port;
620 static int dsa_parse_ports(struct dsa_chip_data *cd, struct dsa_switch *ds)
622 bool valid_name_found = false;
625 for (i = 0; i < DSA_MAX_PORTS; i++) {
626 if (!cd->port_names[i])
629 ds->ports[i].name = cd->port_names[i];
630 valid_name_found = true;
633 if (!valid_name_found && i == DSA_MAX_PORTS)
639 static int dsa_parse_member_dn(struct device_node *np, u32 *tree, u32 *index)
645 err = of_property_read_u32_index(np, "dsa,member", 0, tree);
647 /* Does not exist, but it is optional */
653 err = of_property_read_u32_index(np, "dsa,member", 1, index);
657 if (*index >= DSA_MAX_SWITCHES)
663 static int dsa_parse_member(struct dsa_chip_data *pd, u32 *tree, u32 *index)
668 /* We do not support complex trees with dsa_chip_data */
675 static struct device_node *dsa_get_ports(struct dsa_switch *ds,
676 struct device_node *np)
678 struct device_node *ports;
680 ports = of_get_child_by_name(np, "ports");
682 dev_err(ds->dev, "no ports child node found\n");
683 return ERR_PTR(-EINVAL);
689 static int _dsa_register_switch(struct dsa_switch *ds)
691 struct dsa_chip_data *pdata = ds->dev->platform_data;
692 struct device_node *np = ds->dev->of_node;
693 struct dsa_switch_tree *dst;
694 struct device_node *ports;
699 err = dsa_parse_member_dn(np, &tree, &index);
703 ports = dsa_get_ports(ds, np);
705 return PTR_ERR(ports);
707 err = dsa_parse_ports_dn(ports, ds);
711 err = dsa_parse_member(pdata, &tree, &index);
715 err = dsa_parse_ports(pdata, ds);
720 dst = dsa_get_dst(tree);
722 dst = dsa_add_dst(tree);
727 if (dst->ds[index]) {
736 /* Initialize the routing table */
737 for (i = 0; i < DSA_MAX_SWITCHES; ++i)
738 ds->rtable[i] = DSA_RTABLE_NONE;
740 dsa_dst_add_ds(dst, ds, index);
742 err = dsa_dst_complete(dst);
747 /* Not all switches registered yet */
753 pr_info("DSA: Disjoint trees?\n");
757 err = dsa_dst_parse(dst);
759 if (err == -EPROBE_DEFER) {
760 dsa_dst_del_ds(dst, ds, ds->index);
767 err = dsa_dst_apply(dst);
769 dsa_dst_unapply(dst);
777 dsa_dst_del_ds(dst, ds, ds->index);
784 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n)
786 size_t size = sizeof(struct dsa_switch) + n * sizeof(struct dsa_port);
787 struct dsa_switch *ds;
790 ds = devm_kzalloc(dev, size, GFP_KERNEL);
797 for (i = 0; i < ds->num_ports; ++i) {
798 ds->ports[i].index = i;
799 ds->ports[i].ds = ds;
804 EXPORT_SYMBOL_GPL(dsa_switch_alloc);
806 int dsa_register_switch(struct dsa_switch *ds)
810 mutex_lock(&dsa2_mutex);
811 err = _dsa_register_switch(ds);
812 mutex_unlock(&dsa2_mutex);
816 EXPORT_SYMBOL_GPL(dsa_register_switch);
818 static void _dsa_unregister_switch(struct dsa_switch *ds)
820 struct dsa_switch_tree *dst = ds->dst;
822 dsa_dst_unapply(dst);
824 dsa_dst_del_ds(dst, ds, ds->index);
827 void dsa_unregister_switch(struct dsa_switch *ds)
829 mutex_lock(&dsa2_mutex);
830 _dsa_unregister_switch(ds);
831 mutex_unlock(&dsa2_mutex);
833 EXPORT_SYMBOL_GPL(dsa_unregister_switch);