2 * net/dsa/dsa.c - Hardware switch handling
3 * Copyright (c) 2008-2009 Marvell Semiconductor
4 * Copyright (c) 2013 Florian Fainelli <florian@openwrt.org>
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/ctype.h>
13 #include <linux/device.h>
14 #include <linux/hwmon.h>
15 #include <linux/list.h>
16 #include <linux/platform_device.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
21 #include <linux/of_mdio.h>
22 #include <linux/of_platform.h>
23 #include <linux/of_net.h>
24 #include <linux/of_gpio.h>
25 #include <linux/sysfs.h>
26 #include <linux/phy_fixed.h>
27 #include <linux/gpio/consumer.h>
30 char dsa_driver_version[] = "0.1";
33 /* switch driver registration ***********************************************/
34 static DEFINE_MUTEX(dsa_switch_drivers_mutex);
35 static LIST_HEAD(dsa_switch_drivers);
37 void register_switch_driver(struct dsa_switch_driver *drv)
39 mutex_lock(&dsa_switch_drivers_mutex);
40 list_add_tail(&drv->list, &dsa_switch_drivers);
41 mutex_unlock(&dsa_switch_drivers_mutex);
43 EXPORT_SYMBOL_GPL(register_switch_driver);
45 void unregister_switch_driver(struct dsa_switch_driver *drv)
47 mutex_lock(&dsa_switch_drivers_mutex);
48 list_del_init(&drv->list);
49 mutex_unlock(&dsa_switch_drivers_mutex);
51 EXPORT_SYMBOL_GPL(unregister_switch_driver);
53 static struct dsa_switch_driver *
54 dsa_switch_probe(struct device *parent, struct device *host_dev, int sw_addr,
55 char **_name, void **priv)
57 struct dsa_switch_driver *ret;
58 struct list_head *list;
64 mutex_lock(&dsa_switch_drivers_mutex);
65 list_for_each(list, &dsa_switch_drivers) {
66 struct dsa_switch_driver *drv;
68 drv = list_entry(list, struct dsa_switch_driver, list);
70 name = drv->probe(parent, host_dev, sw_addr, priv);
76 mutex_unlock(&dsa_switch_drivers_mutex);
83 /* hwmon support ************************************************************/
85 #ifdef CONFIG_NET_DSA_HWMON
87 static ssize_t temp1_input_show(struct device *dev,
88 struct device_attribute *attr, char *buf)
90 struct dsa_switch *ds = dev_get_drvdata(dev);
93 ret = ds->drv->get_temp(ds, &temp);
97 return sprintf(buf, "%d\n", temp * 1000);
99 static DEVICE_ATTR_RO(temp1_input);
101 static ssize_t temp1_max_show(struct device *dev,
102 struct device_attribute *attr, char *buf)
104 struct dsa_switch *ds = dev_get_drvdata(dev);
107 ret = ds->drv->get_temp_limit(ds, &temp);
111 return sprintf(buf, "%d\n", temp * 1000);
114 static ssize_t temp1_max_store(struct device *dev,
115 struct device_attribute *attr, const char *buf,
118 struct dsa_switch *ds = dev_get_drvdata(dev);
121 ret = kstrtoint(buf, 0, &temp);
125 ret = ds->drv->set_temp_limit(ds, DIV_ROUND_CLOSEST(temp, 1000));
131 static DEVICE_ATTR_RW(temp1_max);
133 static ssize_t temp1_max_alarm_show(struct device *dev,
134 struct device_attribute *attr, char *buf)
136 struct dsa_switch *ds = dev_get_drvdata(dev);
140 ret = ds->drv->get_temp_alarm(ds, &alarm);
144 return sprintf(buf, "%d\n", alarm);
146 static DEVICE_ATTR_RO(temp1_max_alarm);
148 static struct attribute *dsa_hwmon_attrs[] = {
149 &dev_attr_temp1_input.attr, /* 0 */
150 &dev_attr_temp1_max.attr, /* 1 */
151 &dev_attr_temp1_max_alarm.attr, /* 2 */
155 static umode_t dsa_hwmon_attrs_visible(struct kobject *kobj,
156 struct attribute *attr, int index)
158 struct device *dev = container_of(kobj, struct device, kobj);
159 struct dsa_switch *ds = dev_get_drvdata(dev);
160 struct dsa_switch_driver *drv = ds->drv;
161 umode_t mode = attr->mode;
164 if (!drv->get_temp_limit)
166 else if (!drv->set_temp_limit)
168 } else if (index == 2 && !drv->get_temp_alarm) {
174 static const struct attribute_group dsa_hwmon_group = {
175 .attrs = dsa_hwmon_attrs,
176 .is_visible = dsa_hwmon_attrs_visible,
178 __ATTRIBUTE_GROUPS(dsa_hwmon);
180 #endif /* CONFIG_NET_DSA_HWMON */
182 /* basic switch operations **************************************************/
183 static int dsa_cpu_dsa_setup(struct dsa_switch *ds, struct net_device *master)
185 struct dsa_chip_data *cd = ds->pd;
186 struct device_node *port_dn;
187 struct phy_device *phydev;
190 for (port = 0; port < DSA_MAX_PORTS; port++) {
191 if (!(dsa_is_cpu_port(ds, port) || dsa_is_dsa_port(ds, port)))
194 port_dn = cd->port_dn[port];
195 if (of_phy_is_fixed_link(port_dn)) {
196 ret = of_phy_register_fixed_link(port_dn);
199 "failed to register fixed PHY\n");
202 phydev = of_phy_find_device(port_dn);
204 mode = of_get_phy_mode(port_dn);
206 mode = PHY_INTERFACE_MODE_NA;
207 phydev->interface = mode;
209 genphy_config_init(phydev);
210 genphy_read_status(phydev);
211 if (ds->drv->adjust_link)
212 ds->drv->adjust_link(ds, port, phydev);
218 static int dsa_switch_setup_one(struct dsa_switch *ds, struct device *parent)
220 struct dsa_switch_driver *drv = ds->drv;
221 struct dsa_switch_tree *dst = ds->dst;
222 struct dsa_chip_data *pd = ds->pd;
223 bool valid_name_found = false;
224 int index = ds->index;
228 * Validate supplied switch configuration.
230 for (i = 0; i < DSA_MAX_PORTS; i++) {
233 name = pd->port_names[i];
237 if (!strcmp(name, "cpu")) {
238 if (dst->cpu_switch != -1) {
239 netdev_err(dst->master_netdev,
240 "multiple cpu ports?!\n");
244 dst->cpu_switch = index;
246 } else if (!strcmp(name, "dsa")) {
247 ds->dsa_port_mask |= 1 << i;
249 ds->phys_port_mask |= 1 << i;
251 valid_name_found = true;
254 if (!valid_name_found && i == DSA_MAX_PORTS) {
259 /* Make the built-in MII bus mask match the number of ports,
260 * switch drivers can override this later
262 ds->phys_mii_mask = ds->phys_port_mask;
265 * If the CPU connects to this switch, set the switch tree
266 * tagging protocol to the preferred tagging format of this
269 if (dst->cpu_switch == index) {
270 switch (ds->tag_protocol) {
271 #ifdef CONFIG_NET_DSA_TAG_DSA
272 case DSA_TAG_PROTO_DSA:
273 dst->rcv = dsa_netdev_ops.rcv;
276 #ifdef CONFIG_NET_DSA_TAG_EDSA
277 case DSA_TAG_PROTO_EDSA:
278 dst->rcv = edsa_netdev_ops.rcv;
281 #ifdef CONFIG_NET_DSA_TAG_TRAILER
282 case DSA_TAG_PROTO_TRAILER:
283 dst->rcv = trailer_netdev_ops.rcv;
286 #ifdef CONFIG_NET_DSA_TAG_BRCM
287 case DSA_TAG_PROTO_BRCM:
288 dst->rcv = brcm_netdev_ops.rcv;
291 case DSA_TAG_PROTO_NONE:
298 dst->tag_protocol = ds->tag_protocol;
302 * Do basic register setup.
304 ret = drv->setup(ds);
308 ret = drv->set_addr(ds, dst->master_netdev->dev_addr);
312 ds->slave_mii_bus = devm_mdiobus_alloc(parent);
313 if (ds->slave_mii_bus == NULL) {
317 dsa_slave_mii_bus_init(ds);
319 ret = mdiobus_register(ds->slave_mii_bus);
325 * Create network devices for physical switch ports.
327 for (i = 0; i < DSA_MAX_PORTS; i++) {
328 if (!(ds->phys_port_mask & (1 << i)))
331 ret = dsa_slave_create(ds, parent, i, pd->port_names[i]);
333 netdev_err(dst->master_netdev, "[%d]: can't create dsa slave device for port %d(%s): %d\n",
334 index, i, pd->port_names[i], ret);
339 /* Perform configuration of the CPU and DSA ports */
340 ret = dsa_cpu_dsa_setup(ds, dst->master_netdev);
342 netdev_err(dst->master_netdev, "[%d] : can't configure CPU and DSA ports\n",
347 #ifdef CONFIG_NET_DSA_HWMON
348 /* If the switch provides a temperature sensor,
349 * register with hardware monitoring subsystem.
350 * Treat registration error as non-fatal and ignore it.
353 const char *netname = netdev_name(dst->master_netdev);
354 char hname[IFNAMSIZ + 1];
357 /* Create valid hwmon 'name' attribute */
358 for (i = j = 0; i < IFNAMSIZ && netname[i]; i++) {
359 if (isalnum(netname[i]))
360 hname[j++] = netname[i];
363 scnprintf(ds->hwmon_name, sizeof(ds->hwmon_name), "%s_dsa%d",
365 ds->hwmon_dev = hwmon_device_register_with_groups(NULL,
366 ds->hwmon_name, ds, dsa_hwmon_groups);
367 if (IS_ERR(ds->hwmon_dev))
368 ds->hwmon_dev = NULL;
370 #endif /* CONFIG_NET_DSA_HWMON */
378 static struct dsa_switch *
379 dsa_switch_setup(struct dsa_switch_tree *dst, int index,
380 struct device *parent, struct device *host_dev)
382 struct dsa_chip_data *pd = dst->pd->chip + index;
383 struct dsa_switch_driver *drv;
384 struct dsa_switch *ds;
390 * Probe for switch model.
392 drv = dsa_switch_probe(parent, host_dev, pd->sw_addr, &name, &priv);
394 netdev_err(dst->master_netdev, "[%d]: could not detect attached switch\n",
396 return ERR_PTR(-EINVAL);
398 netdev_info(dst->master_netdev, "[%d]: detected a %s switch\n",
403 * Allocate and initialise switch state.
405 ds = devm_kzalloc(parent, sizeof(*ds), GFP_KERNEL);
407 return ERR_PTR(-ENOMEM);
414 ds->tag_protocol = drv->tag_protocol;
415 ds->master_dev = host_dev;
417 ret = dsa_switch_setup_one(ds, parent);
424 static void dsa_switch_destroy(struct dsa_switch *ds)
426 struct device_node *port_dn;
427 struct phy_device *phydev;
428 struct dsa_chip_data *cd = ds->pd;
431 #ifdef CONFIG_NET_DSA_HWMON
433 hwmon_device_unregister(ds->hwmon_dev);
436 /* Destroy network devices for physical switch ports. */
437 for (port = 0; port < DSA_MAX_PORTS; port++) {
438 if (!(ds->phys_port_mask & (1 << port)))
441 if (!ds->ports[port])
444 dsa_slave_destroy(ds->ports[port]);
447 /* Remove any fixed link PHYs */
448 for (port = 0; port < DSA_MAX_PORTS; port++) {
449 port_dn = cd->port_dn[port];
450 if (of_phy_is_fixed_link(port_dn)) {
451 phydev = of_phy_find_device(port_dn);
453 phy_device_free(phydev);
454 of_node_put(port_dn);
455 fixed_phy_unregister(phydev);
460 mdiobus_unregister(ds->slave_mii_bus);
463 #ifdef CONFIG_PM_SLEEP
464 static int dsa_switch_suspend(struct dsa_switch *ds)
468 /* Suspend slave network devices */
469 for (i = 0; i < DSA_MAX_PORTS; i++) {
470 if (!dsa_is_port_initialized(ds, i))
473 ret = dsa_slave_suspend(ds->ports[i]);
478 if (ds->drv->suspend)
479 ret = ds->drv->suspend(ds);
484 static int dsa_switch_resume(struct dsa_switch *ds)
489 ret = ds->drv->resume(ds);
494 /* Resume slave network devices */
495 for (i = 0; i < DSA_MAX_PORTS; i++) {
496 if (!dsa_is_port_initialized(ds, i))
499 ret = dsa_slave_resume(ds->ports[i]);
508 /* platform driver init and cleanup *****************************************/
509 static int dev_is_class(struct device *dev, void *class)
511 if (dev->class != NULL && !strcmp(dev->class->name, class))
517 static struct device *dev_find_class(struct device *parent, char *class)
519 if (dev_is_class(parent, class)) {
524 return device_find_child(parent, class, dev_is_class);
527 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
531 d = dev_find_class(dev, "mdio_bus");
543 EXPORT_SYMBOL_GPL(dsa_host_dev_to_mii_bus);
545 static struct net_device *dev_to_net_device(struct device *dev)
549 d = dev_find_class(dev, "net");
551 struct net_device *nd;
564 static int dsa_of_setup_routing_table(struct dsa_platform_data *pd,
565 struct dsa_chip_data *cd,
566 int chip_index, int port_index,
567 struct device_node *link)
571 struct device_node *parent_sw;
574 parent_sw = of_get_parent(link);
578 reg = of_get_property(parent_sw, "reg", &len);
579 if (!reg || (len != sizeof(*reg) * 2))
583 * Get the destination switch number from the second field of its 'reg'
584 * property, i.e. for "reg = <0x19 1>" sw_addr is '1'.
586 link_sw_addr = be32_to_cpup(reg + 1);
588 if (link_sw_addr >= pd->nr_chips)
591 /* First time routing table allocation */
593 cd->rtable = kmalloc_array(pd->nr_chips, sizeof(s8),
598 /* default to no valid uplink/downlink */
599 memset(cd->rtable, -1, pd->nr_chips * sizeof(s8));
602 cd->rtable[link_sw_addr] = port_index;
607 static int dsa_of_probe_links(struct dsa_platform_data *pd,
608 struct dsa_chip_data *cd,
609 int chip_index, int port_index,
610 struct device_node *port,
611 const char *port_name)
613 struct device_node *link;
617 for (link_index = 0;; link_index++) {
618 link = of_parse_phandle(port, "link", link_index);
622 if (!strcmp(port_name, "dsa") && pd->nr_chips > 1) {
623 ret = dsa_of_setup_routing_table(pd, cd, chip_index,
632 static void dsa_of_free_platform_data(struct dsa_platform_data *pd)
637 for (i = 0; i < pd->nr_chips; i++) {
639 while (port_index < DSA_MAX_PORTS) {
640 kfree(pd->chip[i].port_names[port_index]);
643 kfree(pd->chip[i].rtable);
645 /* Drop our reference to the MDIO bus device */
646 if (pd->chip[i].host_dev)
647 put_device(pd->chip[i].host_dev);
652 static int dsa_of_probe(struct device *dev)
654 struct device_node *np = dev->of_node;
655 struct device_node *child, *mdio, *ethernet, *port;
656 struct mii_bus *mdio_bus, *mdio_bus_switch;
657 struct net_device *ethernet_dev;
658 struct dsa_platform_data *pd;
659 struct dsa_chip_data *cd;
660 const char *port_name;
661 int chip_index, port_index;
662 const unsigned int *sw_addr, *port_reg;
664 enum of_gpio_flags of_flags;
669 mdio = of_parse_phandle(np, "dsa,mii-bus", 0);
673 mdio_bus = of_mdio_find_bus(mdio);
675 return -EPROBE_DEFER;
677 ethernet = of_parse_phandle(np, "dsa,ethernet", 0);
683 ethernet_dev = of_find_net_device_by_node(ethernet);
689 pd = kzalloc(sizeof(*pd), GFP_KERNEL);
692 goto out_put_ethernet;
695 dev->platform_data = pd;
696 pd->of_netdev = ethernet_dev;
697 pd->nr_chips = of_get_available_child_count(np);
698 if (pd->nr_chips > DSA_MAX_SWITCHES)
699 pd->nr_chips = DSA_MAX_SWITCHES;
701 pd->chip = kcalloc(pd->nr_chips, sizeof(struct dsa_chip_data),
709 for_each_available_child_of_node(np, child) {
711 cd = &pd->chip[chip_index];
715 /* When assigning the host device, increment its refcount */
716 cd->host_dev = get_device(&mdio_bus->dev);
718 sw_addr = of_get_property(child, "reg", NULL);
722 cd->sw_addr = be32_to_cpup(sw_addr);
723 if (cd->sw_addr >= PHY_MAX_ADDR)
726 if (!of_property_read_u32(child, "eeprom-length", &eeprom_len))
727 cd->eeprom_len = eeprom_len;
729 mdio = of_parse_phandle(child, "mii-bus", 0);
731 mdio_bus_switch = of_mdio_find_bus(mdio);
732 if (!mdio_bus_switch) {
737 /* Drop the mdio_bus device ref, replacing the host
738 * device with the mdio_bus_switch device, keeping
739 * the refcount from of_mdio_find_bus() above.
741 put_device(cd->host_dev);
742 cd->host_dev = &mdio_bus_switch->dev;
744 gpio = of_get_named_gpio_flags(child, "reset-gpios", 0,
746 if (gpio_is_valid(gpio)) {
747 flags = (of_flags == OF_GPIO_ACTIVE_LOW ?
748 GPIOF_ACTIVE_LOW : 0);
749 ret = devm_gpio_request_one(dev, gpio, flags,
754 cd->reset = gpio_to_desc(gpio);
755 gpiod_direction_output(cd->reset, 0);
758 for_each_available_child_of_node(child, port) {
759 port_reg = of_get_property(port, "reg", NULL);
763 port_index = be32_to_cpup(port_reg);
764 if (port_index >= DSA_MAX_PORTS)
767 port_name = of_get_property(port, "label", NULL);
771 cd->port_dn[port_index] = port;
773 cd->port_names[port_index] = kstrdup(port_name,
775 if (!cd->port_names[port_index]) {
780 ret = dsa_of_probe_links(pd, cd, chip_index,
781 port_index, port, port_name);
788 /* The individual chips hold their own refcount on the mdio bus,
790 put_device(&mdio_bus->dev);
795 dsa_of_free_platform_data(pd);
798 dev->platform_data = NULL;
800 put_device(ðernet_dev->dev);
802 put_device(&mdio_bus->dev);
806 static void dsa_of_remove(struct device *dev)
808 struct dsa_platform_data *pd = dev->platform_data;
813 dsa_of_free_platform_data(pd);
814 put_device(&pd->of_netdev->dev);
818 static inline int dsa_of_probe(struct device *dev)
823 static inline void dsa_of_remove(struct device *dev)
828 static int dsa_setup_dst(struct dsa_switch_tree *dst, struct net_device *dev,
829 struct device *parent, struct dsa_platform_data *pd)
832 unsigned configured = 0;
835 dst->master_netdev = dev;
836 dst->cpu_switch = -1;
839 for (i = 0; i < pd->nr_chips; i++) {
840 struct dsa_switch *ds;
842 ds = dsa_switch_setup(dst, i, parent, pd->chip[i].host_dev);
844 netdev_err(dev, "[%d]: couldn't create dsa switch instance (error %ld)\n",
855 * If no switch was found, exit cleanly
858 return -EPROBE_DEFER;
861 * If we use a tagging format that doesn't have an ethertype
862 * field, make sure that all packets from this point on get
863 * sent to the tag format's receive function.
866 dev->dsa_ptr = (void *)dst;
871 static int dsa_probe(struct platform_device *pdev)
873 struct dsa_platform_data *pd = pdev->dev.platform_data;
874 struct net_device *dev;
875 struct dsa_switch_tree *dst;
878 pr_notice_once("Distributed Switch Architecture driver version %s\n",
881 if (pdev->dev.of_node) {
882 ret = dsa_of_probe(&pdev->dev);
886 pd = pdev->dev.platform_data;
889 if (pd == NULL || (pd->netdev == NULL && pd->of_netdev == NULL))
896 dev = dev_to_net_device(pd->netdev);
903 if (dev->dsa_ptr != NULL) {
909 dst = devm_kzalloc(&pdev->dev, sizeof(*dst), GFP_KERNEL);
916 platform_set_drvdata(pdev, dst);
918 ret = dsa_setup_dst(dst, dev, &pdev->dev, pd);
927 dsa_of_remove(&pdev->dev);
932 static void dsa_remove_dst(struct dsa_switch_tree *dst)
936 dst->master_netdev->dsa_ptr = NULL;
938 /* If we used a tagging format that doesn't have an ethertype
939 * field, make sure that all packets from this point get sent
940 * without the tag and go through the regular receive path.
944 for (i = 0; i < dst->pd->nr_chips; i++) {
945 struct dsa_switch *ds = dst->ds[i];
948 dsa_switch_destroy(ds);
951 dev_put(dst->master_netdev);
954 static int dsa_remove(struct platform_device *pdev)
956 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
959 dsa_of_remove(&pdev->dev);
964 static void dsa_shutdown(struct platform_device *pdev)
968 static int dsa_switch_rcv(struct sk_buff *skb, struct net_device *dev,
969 struct packet_type *pt, struct net_device *orig_dev)
971 struct dsa_switch_tree *dst = dev->dsa_ptr;
973 if (unlikely(dst == NULL)) {
978 return dst->rcv(skb, dev, pt, orig_dev);
981 static struct packet_type dsa_pack_type __read_mostly = {
982 .type = cpu_to_be16(ETH_P_XDSA),
983 .func = dsa_switch_rcv,
986 static struct notifier_block dsa_netdevice_nb __read_mostly = {
987 .notifier_call = dsa_slave_netdevice_event,
990 #ifdef CONFIG_PM_SLEEP
991 static int dsa_suspend(struct device *d)
993 struct platform_device *pdev = to_platform_device(d);
994 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
997 for (i = 0; i < dst->pd->nr_chips; i++) {
998 struct dsa_switch *ds = dst->ds[i];
1001 ret = dsa_switch_suspend(ds);
1007 static int dsa_resume(struct device *d)
1009 struct platform_device *pdev = to_platform_device(d);
1010 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
1013 for (i = 0; i < dst->pd->nr_chips; i++) {
1014 struct dsa_switch *ds = dst->ds[i];
1017 ret = dsa_switch_resume(ds);
1024 static SIMPLE_DEV_PM_OPS(dsa_pm_ops, dsa_suspend, dsa_resume);
1026 static const struct of_device_id dsa_of_match_table[] = {
1027 { .compatible = "brcm,bcm7445-switch-v4.0" },
1028 { .compatible = "marvell,dsa", },
1031 MODULE_DEVICE_TABLE(of, dsa_of_match_table);
1033 static struct platform_driver dsa_driver = {
1035 .remove = dsa_remove,
1036 .shutdown = dsa_shutdown,
1039 .of_match_table = dsa_of_match_table,
1044 static int __init dsa_init_module(void)
1048 register_netdevice_notifier(&dsa_netdevice_nb);
1050 rc = platform_driver_register(&dsa_driver);
1054 dev_add_pack(&dsa_pack_type);
1058 module_init(dsa_init_module);
1060 static void __exit dsa_cleanup_module(void)
1062 unregister_netdevice_notifier(&dsa_netdevice_nb);
1063 dev_remove_pack(&dsa_pack_type);
1064 platform_driver_unregister(&dsa_driver);
1066 module_exit(dsa_cleanup_module);
1068 MODULE_AUTHOR("Lennert Buytenhek <buytenh@wantstofly.org>");
1069 MODULE_DESCRIPTION("Driver for Distributed Switch Architecture switch chips");
1070 MODULE_LICENSE("GPL");
1071 MODULE_ALIAS("platform:dsa");