2 * net/dsa/legacy.c - Hardware switch handling
3 * Copyright (c) 2008-2009 Marvell Semiconductor
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
12 #include <linux/device.h>
13 #include <linux/list.h>
14 #include <linux/platform_device.h>
15 #include <linux/slab.h>
16 #include <linux/module.h>
18 #include <linux/of_mdio.h>
19 #include <linux/of_platform.h>
20 #include <linux/of_net.h>
21 #include <linux/netdevice.h>
22 #include <linux/sysfs.h>
23 #include <linux/phy_fixed.h>
24 #include <linux/etherdevice.h>
28 /* switch driver registration ***********************************************/
29 static DEFINE_MUTEX(dsa_switch_drivers_mutex);
30 static LIST_HEAD(dsa_switch_drivers);
32 void register_switch_driver(struct dsa_switch_driver *drv)
34 mutex_lock(&dsa_switch_drivers_mutex);
35 list_add_tail(&drv->list, &dsa_switch_drivers);
36 mutex_unlock(&dsa_switch_drivers_mutex);
38 EXPORT_SYMBOL_GPL(register_switch_driver);
40 void unregister_switch_driver(struct dsa_switch_driver *drv)
42 mutex_lock(&dsa_switch_drivers_mutex);
43 list_del_init(&drv->list);
44 mutex_unlock(&dsa_switch_drivers_mutex);
46 EXPORT_SYMBOL_GPL(unregister_switch_driver);
48 static const struct dsa_switch_ops *
49 dsa_switch_probe(struct device *parent, struct device *host_dev, int sw_addr,
50 const char **_name, void **priv)
52 const struct dsa_switch_ops *ret;
53 struct list_head *list;
59 mutex_lock(&dsa_switch_drivers_mutex);
60 list_for_each(list, &dsa_switch_drivers) {
61 const struct dsa_switch_ops *ops;
62 struct dsa_switch_driver *drv;
64 drv = list_entry(list, struct dsa_switch_driver, list);
67 name = ops->probe(parent, host_dev, sw_addr, priv);
73 mutex_unlock(&dsa_switch_drivers_mutex);
80 /* basic switch operations **************************************************/
81 static int dsa_cpu_dsa_setups(struct dsa_switch *ds, struct device *dev)
83 struct dsa_port *dport;
86 for (port = 0; port < ds->num_ports; port++) {
87 if (!(dsa_is_cpu_port(ds, port) || dsa_is_dsa_port(ds, port)))
90 dport = &ds->ports[port];
91 ret = dsa_cpu_dsa_setup(ds, dev, dport, port);
98 static int dsa_switch_setup_one(struct dsa_switch *ds, struct device *parent)
100 const struct dsa_switch_ops *ops = ds->ops;
101 struct dsa_switch_tree *dst = ds->dst;
102 struct dsa_chip_data *cd = ds->cd;
103 bool valid_name_found = false;
104 int index = ds->index;
108 * Validate supplied switch configuration.
110 for (i = 0; i < ds->num_ports; i++) {
113 name = cd->port_names[i];
117 if (!strcmp(name, "cpu")) {
119 netdev_err(dst->master_netdev,
120 "multiple cpu ports?!\n");
123 dst->cpu_dp = &ds->ports[i];
124 ds->cpu_port_mask |= 1 << i;
125 } else if (!strcmp(name, "dsa")) {
126 ds->dsa_port_mask |= 1 << i;
128 ds->enabled_port_mask |= 1 << i;
130 valid_name_found = true;
133 if (!valid_name_found && i == ds->num_ports)
136 /* Make the built-in MII bus mask match the number of ports,
137 * switch drivers can override this later
139 ds->phys_mii_mask = ds->enabled_port_mask;
142 * If the CPU connects to this switch, set the switch tree
143 * tagging protocol to the preferred tagging format of this
146 if (dst->cpu_dp->ds == ds) {
147 enum dsa_tag_protocol tag_protocol;
149 tag_protocol = ops->get_tag_protocol(ds);
150 dst->tag_ops = dsa_resolve_tag_protocol(tag_protocol);
151 if (IS_ERR(dst->tag_ops))
152 return PTR_ERR(dst->tag_ops);
154 dst->rcv = dst->tag_ops->rcv;
157 memcpy(ds->rtable, cd->rtable, sizeof(ds->rtable));
160 * Do basic register setup.
162 ret = ops->setup(ds);
166 ret = dsa_switch_register_notifier(ds);
171 ret = ops->set_addr(ds, dst->master_netdev->dev_addr);
176 if (!ds->slave_mii_bus && ops->phy_read) {
177 ds->slave_mii_bus = devm_mdiobus_alloc(parent);
178 if (!ds->slave_mii_bus)
180 dsa_slave_mii_bus_init(ds);
182 ret = mdiobus_register(ds->slave_mii_bus);
188 * Create network devices for physical switch ports.
190 for (i = 0; i < ds->num_ports; i++) {
191 ds->ports[i].dn = cd->port_dn[i];
193 if (!(ds->enabled_port_mask & (1 << i)))
196 ret = dsa_slave_create(ds, parent, i, cd->port_names[i]);
198 netdev_err(dst->master_netdev, "[%d]: can't create dsa slave device for port %d(%s): %d\n",
199 index, i, cd->port_names[i], ret);
202 /* Perform configuration of the CPU and DSA ports */
203 ret = dsa_cpu_dsa_setups(ds, parent);
205 netdev_err(dst->master_netdev, "[%d] : can't configure CPU and DSA ports\n",
208 ret = dsa_cpu_port_ethtool_setup(ds->dst->cpu_dp);
215 static struct dsa_switch *
216 dsa_switch_setup(struct dsa_switch_tree *dst, int index,
217 struct device *parent, struct device *host_dev)
219 struct dsa_chip_data *cd = dst->pd->chip + index;
220 const struct dsa_switch_ops *ops;
221 struct dsa_switch *ds;
227 * Probe for switch model.
229 ops = dsa_switch_probe(parent, host_dev, cd->sw_addr, &name, &priv);
231 netdev_err(dst->master_netdev, "[%d]: could not detect attached switch\n",
233 return ERR_PTR(-EINVAL);
235 netdev_info(dst->master_netdev, "[%d]: detected a %s switch\n",
240 * Allocate and initialise switch state.
242 ds = dsa_switch_alloc(parent, DSA_MAX_PORTS);
244 return ERR_PTR(-ENOMEM);
252 ret = dsa_switch_setup_one(ds, parent);
259 static void dsa_switch_destroy(struct dsa_switch *ds)
263 /* Destroy network devices for physical switch ports. */
264 for (port = 0; port < ds->num_ports; port++) {
265 if (!(ds->enabled_port_mask & (1 << port)))
268 if (!ds->ports[port].netdev)
271 dsa_slave_destroy(ds->ports[port].netdev);
274 /* Disable configuration of the CPU and DSA ports */
275 for (port = 0; port < ds->num_ports; port++) {
276 if (!(dsa_is_cpu_port(ds, port) || dsa_is_dsa_port(ds, port)))
278 dsa_cpu_dsa_destroy(&ds->ports[port]);
280 /* Clearing a bit which is not set does no harm */
281 ds->cpu_port_mask |= ~(1 << port);
282 ds->dsa_port_mask |= ~(1 << port);
285 if (ds->slave_mii_bus && ds->ops->phy_read)
286 mdiobus_unregister(ds->slave_mii_bus);
288 dsa_switch_unregister_notifier(ds);
291 #ifdef CONFIG_PM_SLEEP
292 int dsa_switch_suspend(struct dsa_switch *ds)
296 /* Suspend slave network devices */
297 for (i = 0; i < ds->num_ports; i++) {
298 if (!dsa_is_port_initialized(ds, i))
301 ret = dsa_slave_suspend(ds->ports[i].netdev);
306 if (ds->ops->suspend)
307 ret = ds->ops->suspend(ds);
311 EXPORT_SYMBOL_GPL(dsa_switch_suspend);
313 int dsa_switch_resume(struct dsa_switch *ds)
318 ret = ds->ops->resume(ds);
323 /* Resume slave network devices */
324 for (i = 0; i < ds->num_ports; i++) {
325 if (!dsa_is_port_initialized(ds, i))
328 ret = dsa_slave_resume(ds->ports[i].netdev);
335 EXPORT_SYMBOL_GPL(dsa_switch_resume);
338 /* platform driver init and cleanup *****************************************/
339 static int dev_is_class(struct device *dev, void *class)
341 if (dev->class != NULL && !strcmp(dev->class->name, class))
347 static struct device *dev_find_class(struct device *parent, char *class)
349 if (dev_is_class(parent, class)) {
354 return device_find_child(parent, class, dev_is_class);
357 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
361 d = dev_find_class(dev, "mdio_bus");
373 EXPORT_SYMBOL_GPL(dsa_host_dev_to_mii_bus);
376 static int dsa_of_setup_routing_table(struct dsa_platform_data *pd,
377 struct dsa_chip_data *cd,
378 int chip_index, int port_index,
379 struct device_node *link)
383 struct device_node *parent_sw;
386 parent_sw = of_get_parent(link);
390 reg = of_get_property(parent_sw, "reg", &len);
391 if (!reg || (len != sizeof(*reg) * 2))
395 * Get the destination switch number from the second field of its 'reg'
396 * property, i.e. for "reg = <0x19 1>" sw_addr is '1'.
398 link_sw_addr = be32_to_cpup(reg + 1);
400 if (link_sw_addr >= pd->nr_chips)
403 cd->rtable[link_sw_addr] = port_index;
408 static int dsa_of_probe_links(struct dsa_platform_data *pd,
409 struct dsa_chip_data *cd,
410 int chip_index, int port_index,
411 struct device_node *port,
412 const char *port_name)
414 struct device_node *link;
418 for (link_index = 0;; link_index++) {
419 link = of_parse_phandle(port, "link", link_index);
423 if (!strcmp(port_name, "dsa") && pd->nr_chips > 1) {
424 ret = dsa_of_setup_routing_table(pd, cd, chip_index,
433 static void dsa_of_free_platform_data(struct dsa_platform_data *pd)
438 for (i = 0; i < pd->nr_chips; i++) {
440 while (port_index < DSA_MAX_PORTS) {
441 kfree(pd->chip[i].port_names[port_index]);
445 /* Drop our reference to the MDIO bus device */
446 if (pd->chip[i].host_dev)
447 put_device(pd->chip[i].host_dev);
452 static int dsa_of_probe(struct device *dev)
454 struct device_node *np = dev->of_node;
455 struct device_node *child, *mdio, *ethernet, *port;
456 struct mii_bus *mdio_bus, *mdio_bus_switch;
457 struct net_device *ethernet_dev;
458 struct dsa_platform_data *pd;
459 struct dsa_chip_data *cd;
460 const char *port_name;
461 int chip_index, port_index;
462 const unsigned int *sw_addr, *port_reg;
466 mdio = of_parse_phandle(np, "dsa,mii-bus", 0);
470 mdio_bus = of_mdio_find_bus(mdio);
472 return -EPROBE_DEFER;
474 ethernet = of_parse_phandle(np, "dsa,ethernet", 0);
480 ethernet_dev = of_find_net_device_by_node(ethernet);
486 pd = kzalloc(sizeof(*pd), GFP_KERNEL);
489 goto out_put_ethernet;
492 dev->platform_data = pd;
493 pd->of_netdev = ethernet_dev;
494 pd->nr_chips = of_get_available_child_count(np);
495 if (pd->nr_chips > DSA_MAX_SWITCHES)
496 pd->nr_chips = DSA_MAX_SWITCHES;
498 pd->chip = kcalloc(pd->nr_chips, sizeof(struct dsa_chip_data),
506 for_each_available_child_of_node(np, child) {
510 cd = &pd->chip[chip_index];
514 /* Initialize the routing table */
515 for (i = 0; i < DSA_MAX_SWITCHES; ++i)
516 cd->rtable[i] = DSA_RTABLE_NONE;
518 /* When assigning the host device, increment its refcount */
519 cd->host_dev = get_device(&mdio_bus->dev);
521 sw_addr = of_get_property(child, "reg", NULL);
525 cd->sw_addr = be32_to_cpup(sw_addr);
526 if (cd->sw_addr >= PHY_MAX_ADDR)
529 if (!of_property_read_u32(child, "eeprom-length", &eeprom_len))
530 cd->eeprom_len = eeprom_len;
532 mdio = of_parse_phandle(child, "mii-bus", 0);
534 mdio_bus_switch = of_mdio_find_bus(mdio);
535 if (!mdio_bus_switch) {
540 /* Drop the mdio_bus device ref, replacing the host
541 * device with the mdio_bus_switch device, keeping
542 * the refcount from of_mdio_find_bus() above.
544 put_device(cd->host_dev);
545 cd->host_dev = &mdio_bus_switch->dev;
548 for_each_available_child_of_node(child, port) {
549 port_reg = of_get_property(port, "reg", NULL);
553 port_index = be32_to_cpup(port_reg);
554 if (port_index >= DSA_MAX_PORTS)
557 port_name = of_get_property(port, "label", NULL);
561 cd->port_dn[port_index] = port;
563 cd->port_names[port_index] = kstrdup(port_name,
565 if (!cd->port_names[port_index]) {
570 ret = dsa_of_probe_links(pd, cd, chip_index,
571 port_index, port, port_name);
578 /* The individual chips hold their own refcount on the mdio bus,
580 put_device(&mdio_bus->dev);
585 dsa_of_free_platform_data(pd);
588 dev->platform_data = NULL;
590 put_device(ðernet_dev->dev);
592 put_device(&mdio_bus->dev);
596 static void dsa_of_remove(struct device *dev)
598 struct dsa_platform_data *pd = dev->platform_data;
603 dsa_of_free_platform_data(pd);
604 put_device(&pd->of_netdev->dev);
608 static inline int dsa_of_probe(struct device *dev)
613 static inline void dsa_of_remove(struct device *dev)
618 static int dsa_setup_dst(struct dsa_switch_tree *dst, struct net_device *dev,
619 struct device *parent, struct dsa_platform_data *pd)
622 unsigned configured = 0;
625 dst->master_netdev = dev;
627 for (i = 0; i < pd->nr_chips; i++) {
628 struct dsa_switch *ds;
630 ds = dsa_switch_setup(dst, i, parent, pd->chip[i].host_dev);
632 netdev_err(dev, "[%d]: couldn't create dsa switch instance (error %ld)\n",
643 * If no switch was found, exit cleanly
646 return -EPROBE_DEFER;
649 * If we use a tagging format that doesn't have an ethertype
650 * field, make sure that all packets from this point on get
651 * sent to the tag format's receive function.
659 static int dsa_probe(struct platform_device *pdev)
661 struct dsa_platform_data *pd = pdev->dev.platform_data;
662 struct net_device *dev;
663 struct dsa_switch_tree *dst;
666 if (pdev->dev.of_node) {
667 ret = dsa_of_probe(&pdev->dev);
671 pd = pdev->dev.platform_data;
674 if (pd == NULL || (pd->netdev == NULL && pd->of_netdev == NULL))
681 dev = dsa_dev_to_net_device(pd->netdev);
688 if (dev->dsa_ptr != NULL) {
694 dst = devm_kzalloc(&pdev->dev, sizeof(*dst), GFP_KERNEL);
701 platform_set_drvdata(pdev, dst);
703 ret = dsa_setup_dst(dst, dev, &pdev->dev, pd);
712 dsa_of_remove(&pdev->dev);
717 static void dsa_remove_dst(struct dsa_switch_tree *dst)
721 dst->master_netdev->dsa_ptr = NULL;
723 /* If we used a tagging format that doesn't have an ethertype
724 * field, make sure that all packets from this point get sent
725 * without the tag and go through the regular receive path.
729 for (i = 0; i < dst->pd->nr_chips; i++) {
730 struct dsa_switch *ds = dst->ds[i];
733 dsa_switch_destroy(ds);
736 dsa_cpu_port_ethtool_restore(dst->cpu_dp);
738 dev_put(dst->master_netdev);
741 static int dsa_remove(struct platform_device *pdev)
743 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
746 dsa_of_remove(&pdev->dev);
751 static void dsa_shutdown(struct platform_device *pdev)
755 #ifdef CONFIG_PM_SLEEP
756 static int dsa_suspend(struct device *d)
758 struct platform_device *pdev = to_platform_device(d);
759 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
762 for (i = 0; i < dst->pd->nr_chips; i++) {
763 struct dsa_switch *ds = dst->ds[i];
766 ret = dsa_switch_suspend(ds);
772 static int dsa_resume(struct device *d)
774 struct platform_device *pdev = to_platform_device(d);
775 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
778 for (i = 0; i < dst->pd->nr_chips; i++) {
779 struct dsa_switch *ds = dst->ds[i];
782 ret = dsa_switch_resume(ds);
789 static SIMPLE_DEV_PM_OPS(dsa_pm_ops, dsa_suspend, dsa_resume);
791 static const struct of_device_id dsa_of_match_table[] = {
792 { .compatible = "marvell,dsa", },
795 MODULE_DEVICE_TABLE(of, dsa_of_match_table);
797 static struct platform_driver dsa_driver = {
799 .remove = dsa_remove,
800 .shutdown = dsa_shutdown,
803 .of_match_table = dsa_of_match_table,
808 int dsa_legacy_register(void)
810 return platform_driver_register(&dsa_driver);
813 void dsa_legacy_unregister(void)
815 platform_driver_unregister(&dsa_driver);