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";
32 static struct sk_buff *dsa_slave_notag_xmit(struct sk_buff *skb,
33 struct net_device *dev)
35 /* Just return the original SKB */
39 static const struct dsa_device_ops none_ops = {
40 .xmit = dsa_slave_notag_xmit,
44 const struct dsa_device_ops *dsa_device_ops[DSA_TAG_LAST] = {
45 #ifdef CONFIG_NET_DSA_TAG_DSA
46 [DSA_TAG_PROTO_DSA] = &dsa_netdev_ops,
48 #ifdef CONFIG_NET_DSA_TAG_EDSA
49 [DSA_TAG_PROTO_EDSA] = &edsa_netdev_ops,
51 #ifdef CONFIG_NET_DSA_TAG_TRAILER
52 [DSA_TAG_PROTO_TRAILER] = &trailer_netdev_ops,
54 #ifdef CONFIG_NET_DSA_TAG_BRCM
55 [DSA_TAG_PROTO_BRCM] = &brcm_netdev_ops,
57 [DSA_TAG_PROTO_NONE] = &none_ops,
60 /* switch driver registration ***********************************************/
61 static DEFINE_MUTEX(dsa_switch_drivers_mutex);
62 static LIST_HEAD(dsa_switch_drivers);
64 void register_switch_driver(struct dsa_switch_driver *drv)
66 mutex_lock(&dsa_switch_drivers_mutex);
67 list_add_tail(&drv->list, &dsa_switch_drivers);
68 mutex_unlock(&dsa_switch_drivers_mutex);
70 EXPORT_SYMBOL_GPL(register_switch_driver);
72 void unregister_switch_driver(struct dsa_switch_driver *drv)
74 mutex_lock(&dsa_switch_drivers_mutex);
75 list_del_init(&drv->list);
76 mutex_unlock(&dsa_switch_drivers_mutex);
78 EXPORT_SYMBOL_GPL(unregister_switch_driver);
80 static struct dsa_switch_driver *
81 dsa_switch_probe(struct device *parent, struct device *host_dev, int sw_addr,
82 const char **_name, void **priv)
84 struct dsa_switch_driver *ret;
85 struct list_head *list;
91 mutex_lock(&dsa_switch_drivers_mutex);
92 list_for_each(list, &dsa_switch_drivers) {
93 struct dsa_switch_driver *drv;
95 drv = list_entry(list, struct dsa_switch_driver, list);
97 name = drv->probe(parent, host_dev, sw_addr, priv);
103 mutex_unlock(&dsa_switch_drivers_mutex);
110 /* hwmon support ************************************************************/
112 #ifdef CONFIG_NET_DSA_HWMON
114 static ssize_t temp1_input_show(struct device *dev,
115 struct device_attribute *attr, char *buf)
117 struct dsa_switch *ds = dev_get_drvdata(dev);
120 ret = ds->drv->get_temp(ds, &temp);
124 return sprintf(buf, "%d\n", temp * 1000);
126 static DEVICE_ATTR_RO(temp1_input);
128 static ssize_t temp1_max_show(struct device *dev,
129 struct device_attribute *attr, char *buf)
131 struct dsa_switch *ds = dev_get_drvdata(dev);
134 ret = ds->drv->get_temp_limit(ds, &temp);
138 return sprintf(buf, "%d\n", temp * 1000);
141 static ssize_t temp1_max_store(struct device *dev,
142 struct device_attribute *attr, const char *buf,
145 struct dsa_switch *ds = dev_get_drvdata(dev);
148 ret = kstrtoint(buf, 0, &temp);
152 ret = ds->drv->set_temp_limit(ds, DIV_ROUND_CLOSEST(temp, 1000));
158 static DEVICE_ATTR_RW(temp1_max);
160 static ssize_t temp1_max_alarm_show(struct device *dev,
161 struct device_attribute *attr, char *buf)
163 struct dsa_switch *ds = dev_get_drvdata(dev);
167 ret = ds->drv->get_temp_alarm(ds, &alarm);
171 return sprintf(buf, "%d\n", alarm);
173 static DEVICE_ATTR_RO(temp1_max_alarm);
175 static struct attribute *dsa_hwmon_attrs[] = {
176 &dev_attr_temp1_input.attr, /* 0 */
177 &dev_attr_temp1_max.attr, /* 1 */
178 &dev_attr_temp1_max_alarm.attr, /* 2 */
182 static umode_t dsa_hwmon_attrs_visible(struct kobject *kobj,
183 struct attribute *attr, int index)
185 struct device *dev = container_of(kobj, struct device, kobj);
186 struct dsa_switch *ds = dev_get_drvdata(dev);
187 struct dsa_switch_driver *drv = ds->drv;
188 umode_t mode = attr->mode;
191 if (!drv->get_temp_limit)
193 else if (!drv->set_temp_limit)
195 } else if (index == 2 && !drv->get_temp_alarm) {
201 static const struct attribute_group dsa_hwmon_group = {
202 .attrs = dsa_hwmon_attrs,
203 .is_visible = dsa_hwmon_attrs_visible,
205 __ATTRIBUTE_GROUPS(dsa_hwmon);
207 #endif /* CONFIG_NET_DSA_HWMON */
209 /* basic switch operations **************************************************/
210 int dsa_cpu_dsa_setup(struct dsa_switch *ds, struct device *dev,
211 struct device_node *port_dn, int port)
213 struct phy_device *phydev;
216 if (of_phy_is_fixed_link(port_dn)) {
217 ret = of_phy_register_fixed_link(port_dn);
219 dev_err(dev, "failed to register fixed PHY\n");
222 phydev = of_phy_find_device(port_dn);
224 mode = of_get_phy_mode(port_dn);
226 mode = PHY_INTERFACE_MODE_NA;
227 phydev->interface = mode;
229 genphy_config_init(phydev);
230 genphy_read_status(phydev);
231 if (ds->drv->adjust_link)
232 ds->drv->adjust_link(ds, port, phydev);
238 static int dsa_cpu_dsa_setups(struct dsa_switch *ds, struct device *dev)
240 struct device_node *port_dn;
243 for (port = 0; port < DSA_MAX_PORTS; port++) {
244 if (!(dsa_is_cpu_port(ds, port) || dsa_is_dsa_port(ds, port)))
247 port_dn = ds->ports[port].dn;
248 ret = dsa_cpu_dsa_setup(ds, dev, port_dn, port);
255 const struct dsa_device_ops *dsa_resolve_tag_protocol(int tag_protocol)
257 const struct dsa_device_ops *ops;
259 if (tag_protocol >= DSA_TAG_LAST)
260 return ERR_PTR(-EINVAL);
261 ops = dsa_device_ops[tag_protocol];
264 return ERR_PTR(-ENOPROTOOPT);
269 static int dsa_switch_setup_one(struct dsa_switch *ds, struct device *parent)
271 struct dsa_switch_driver *drv = ds->drv;
272 struct dsa_switch_tree *dst = ds->dst;
273 struct dsa_chip_data *cd = ds->cd;
274 bool valid_name_found = false;
275 int index = ds->index;
279 * Validate supplied switch configuration.
281 for (i = 0; i < DSA_MAX_PORTS; i++) {
284 name = cd->port_names[i];
288 if (!strcmp(name, "cpu")) {
289 if (dst->cpu_switch != -1) {
290 netdev_err(dst->master_netdev,
291 "multiple cpu ports?!\n");
295 dst->cpu_switch = index;
297 } else if (!strcmp(name, "dsa")) {
298 ds->dsa_port_mask |= 1 << i;
300 ds->enabled_port_mask |= 1 << i;
302 valid_name_found = true;
305 if (!valid_name_found && i == DSA_MAX_PORTS) {
310 /* Make the built-in MII bus mask match the number of ports,
311 * switch drivers can override this later
313 ds->phys_mii_mask = ds->enabled_port_mask;
316 * If the CPU connects to this switch, set the switch tree
317 * tagging protocol to the preferred tagging format of this
320 if (dst->cpu_switch == index) {
321 dst->tag_ops = dsa_resolve_tag_protocol(drv->tag_protocol);
322 if (IS_ERR(dst->tag_ops)) {
323 ret = PTR_ERR(dst->tag_ops);
327 dst->rcv = dst->tag_ops->rcv;
330 memcpy(ds->rtable, cd->rtable, sizeof(ds->rtable));
333 * Do basic register setup.
335 ret = drv->setup(ds);
339 ret = drv->set_addr(ds, dst->master_netdev->dev_addr);
343 ds->slave_mii_bus = devm_mdiobus_alloc(parent);
344 if (ds->slave_mii_bus == NULL) {
348 dsa_slave_mii_bus_init(ds);
350 ret = mdiobus_register(ds->slave_mii_bus);
356 * Create network devices for physical switch ports.
358 for (i = 0; i < DSA_MAX_PORTS; i++) {
359 ds->ports[i].dn = cd->port_dn[i];
361 if (!(ds->enabled_port_mask & (1 << i)))
364 ret = dsa_slave_create(ds, parent, i, cd->port_names[i]);
366 netdev_err(dst->master_netdev, "[%d]: can't create dsa slave device for port %d(%s): %d\n",
367 index, i, cd->port_names[i], ret);
372 /* Perform configuration of the CPU and DSA ports */
373 ret = dsa_cpu_dsa_setups(ds, parent);
375 netdev_err(dst->master_netdev, "[%d] : can't configure CPU and DSA ports\n",
380 #ifdef CONFIG_NET_DSA_HWMON
381 /* If the switch provides a temperature sensor,
382 * register with hardware monitoring subsystem.
383 * Treat registration error as non-fatal and ignore it.
386 const char *netname = netdev_name(dst->master_netdev);
387 char hname[IFNAMSIZ + 1];
390 /* Create valid hwmon 'name' attribute */
391 for (i = j = 0; i < IFNAMSIZ && netname[i]; i++) {
392 if (isalnum(netname[i]))
393 hname[j++] = netname[i];
396 scnprintf(ds->hwmon_name, sizeof(ds->hwmon_name), "%s_dsa%d",
398 ds->hwmon_dev = hwmon_device_register_with_groups(NULL,
399 ds->hwmon_name, ds, dsa_hwmon_groups);
400 if (IS_ERR(ds->hwmon_dev))
401 ds->hwmon_dev = NULL;
403 #endif /* CONFIG_NET_DSA_HWMON */
411 static struct dsa_switch *
412 dsa_switch_setup(struct dsa_switch_tree *dst, int index,
413 struct device *parent, struct device *host_dev)
415 struct dsa_chip_data *cd = dst->pd->chip + index;
416 struct dsa_switch_driver *drv;
417 struct dsa_switch *ds;
423 * Probe for switch model.
425 drv = dsa_switch_probe(parent, host_dev, cd->sw_addr, &name, &priv);
427 netdev_err(dst->master_netdev, "[%d]: could not detect attached switch\n",
429 return ERR_PTR(-EINVAL);
431 netdev_info(dst->master_netdev, "[%d]: detected a %s switch\n",
436 * Allocate and initialise switch state.
438 ds = devm_kzalloc(parent, sizeof(*ds), GFP_KERNEL);
440 return ERR_PTR(-ENOMEM);
449 ret = dsa_switch_setup_one(ds, parent);
456 void dsa_cpu_dsa_destroy(struct device_node *port_dn)
458 struct phy_device *phydev;
460 if (of_phy_is_fixed_link(port_dn)) {
461 phydev = of_phy_find_device(port_dn);
463 phy_device_free(phydev);
464 fixed_phy_unregister(phydev);
469 static void dsa_switch_destroy(struct dsa_switch *ds)
473 #ifdef CONFIG_NET_DSA_HWMON
475 hwmon_device_unregister(ds->hwmon_dev);
478 /* Destroy network devices for physical switch ports. */
479 for (port = 0; port < DSA_MAX_PORTS; port++) {
480 if (!(ds->enabled_port_mask & (1 << port)))
483 if (!ds->ports[port].netdev)
486 dsa_slave_destroy(ds->ports[port].netdev);
489 /* Disable configuration of the CPU and DSA ports */
490 for (port = 0; port < DSA_MAX_PORTS; port++) {
491 if (!(dsa_is_cpu_port(ds, port) || dsa_is_dsa_port(ds, port)))
493 dsa_cpu_dsa_destroy(ds->ports[port].dn);
496 mdiobus_unregister(ds->slave_mii_bus);
499 #ifdef CONFIG_PM_SLEEP
500 static int dsa_switch_suspend(struct dsa_switch *ds)
504 /* Suspend slave network devices */
505 for (i = 0; i < DSA_MAX_PORTS; i++) {
506 if (!dsa_is_port_initialized(ds, i))
509 ret = dsa_slave_suspend(ds->ports[i].netdev);
514 if (ds->drv->suspend)
515 ret = ds->drv->suspend(ds);
520 static int dsa_switch_resume(struct dsa_switch *ds)
525 ret = ds->drv->resume(ds);
530 /* Resume slave network devices */
531 for (i = 0; i < DSA_MAX_PORTS; i++) {
532 if (!dsa_is_port_initialized(ds, i))
535 ret = dsa_slave_resume(ds->ports[i].netdev);
544 /* platform driver init and cleanup *****************************************/
545 static int dev_is_class(struct device *dev, void *class)
547 if (dev->class != NULL && !strcmp(dev->class->name, class))
553 static struct device *dev_find_class(struct device *parent, char *class)
555 if (dev_is_class(parent, class)) {
560 return device_find_child(parent, class, dev_is_class);
563 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
567 d = dev_find_class(dev, "mdio_bus");
579 EXPORT_SYMBOL_GPL(dsa_host_dev_to_mii_bus);
581 static struct net_device *dev_to_net_device(struct device *dev)
585 d = dev_find_class(dev, "net");
587 struct net_device *nd;
600 static int dsa_of_setup_routing_table(struct dsa_platform_data *pd,
601 struct dsa_chip_data *cd,
602 int chip_index, int port_index,
603 struct device_node *link)
607 struct device_node *parent_sw;
610 parent_sw = of_get_parent(link);
614 reg = of_get_property(parent_sw, "reg", &len);
615 if (!reg || (len != sizeof(*reg) * 2))
619 * Get the destination switch number from the second field of its 'reg'
620 * property, i.e. for "reg = <0x19 1>" sw_addr is '1'.
622 link_sw_addr = be32_to_cpup(reg + 1);
624 if (link_sw_addr >= pd->nr_chips)
627 cd->rtable[link_sw_addr] = port_index;
632 static int dsa_of_probe_links(struct dsa_platform_data *pd,
633 struct dsa_chip_data *cd,
634 int chip_index, int port_index,
635 struct device_node *port,
636 const char *port_name)
638 struct device_node *link;
642 for (link_index = 0;; link_index++) {
643 link = of_parse_phandle(port, "link", link_index);
647 if (!strcmp(port_name, "dsa") && pd->nr_chips > 1) {
648 ret = dsa_of_setup_routing_table(pd, cd, chip_index,
657 static void dsa_of_free_platform_data(struct dsa_platform_data *pd)
662 for (i = 0; i < pd->nr_chips; i++) {
664 while (port_index < DSA_MAX_PORTS) {
665 kfree(pd->chip[i].port_names[port_index]);
669 /* Drop our reference to the MDIO bus device */
670 if (pd->chip[i].host_dev)
671 put_device(pd->chip[i].host_dev);
676 static int dsa_of_probe(struct device *dev)
678 struct device_node *np = dev->of_node;
679 struct device_node *child, *mdio, *ethernet, *port;
680 struct mii_bus *mdio_bus, *mdio_bus_switch;
681 struct net_device *ethernet_dev;
682 struct dsa_platform_data *pd;
683 struct dsa_chip_data *cd;
684 const char *port_name;
685 int chip_index, port_index;
686 const unsigned int *sw_addr, *port_reg;
690 mdio = of_parse_phandle(np, "dsa,mii-bus", 0);
694 mdio_bus = of_mdio_find_bus(mdio);
696 return -EPROBE_DEFER;
698 ethernet = of_parse_phandle(np, "dsa,ethernet", 0);
704 ethernet_dev = of_find_net_device_by_node(ethernet);
710 pd = kzalloc(sizeof(*pd), GFP_KERNEL);
713 goto out_put_ethernet;
716 dev->platform_data = pd;
717 pd->of_netdev = ethernet_dev;
718 pd->nr_chips = of_get_available_child_count(np);
719 if (pd->nr_chips > DSA_MAX_SWITCHES)
720 pd->nr_chips = DSA_MAX_SWITCHES;
722 pd->chip = kcalloc(pd->nr_chips, sizeof(struct dsa_chip_data),
730 for_each_available_child_of_node(np, child) {
732 cd = &pd->chip[chip_index];
736 /* When assigning the host device, increment its refcount */
737 cd->host_dev = get_device(&mdio_bus->dev);
739 sw_addr = of_get_property(child, "reg", NULL);
743 cd->sw_addr = be32_to_cpup(sw_addr);
744 if (cd->sw_addr >= PHY_MAX_ADDR)
747 if (!of_property_read_u32(child, "eeprom-length", &eeprom_len))
748 cd->eeprom_len = eeprom_len;
750 mdio = of_parse_phandle(child, "mii-bus", 0);
752 mdio_bus_switch = of_mdio_find_bus(mdio);
753 if (!mdio_bus_switch) {
758 /* Drop the mdio_bus device ref, replacing the host
759 * device with the mdio_bus_switch device, keeping
760 * the refcount from of_mdio_find_bus() above.
762 put_device(cd->host_dev);
763 cd->host_dev = &mdio_bus_switch->dev;
766 for_each_available_child_of_node(child, port) {
767 port_reg = of_get_property(port, "reg", NULL);
771 port_index = be32_to_cpup(port_reg);
772 if (port_index >= DSA_MAX_PORTS)
775 port_name = of_get_property(port, "label", NULL);
779 cd->port_dn[port_index] = port;
781 cd->port_names[port_index] = kstrdup(port_name,
783 if (!cd->port_names[port_index]) {
788 ret = dsa_of_probe_links(pd, cd, chip_index,
789 port_index, port, port_name);
796 /* The individual chips hold their own refcount on the mdio bus,
798 put_device(&mdio_bus->dev);
803 dsa_of_free_platform_data(pd);
806 dev->platform_data = NULL;
808 put_device(ðernet_dev->dev);
810 put_device(&mdio_bus->dev);
814 static void dsa_of_remove(struct device *dev)
816 struct dsa_platform_data *pd = dev->platform_data;
821 dsa_of_free_platform_data(pd);
822 put_device(&pd->of_netdev->dev);
826 static inline int dsa_of_probe(struct device *dev)
831 static inline void dsa_of_remove(struct device *dev)
836 static int dsa_setup_dst(struct dsa_switch_tree *dst, struct net_device *dev,
837 struct device *parent, struct dsa_platform_data *pd)
840 unsigned configured = 0;
843 dst->master_netdev = dev;
844 dst->cpu_switch = -1;
847 for (i = 0; i < pd->nr_chips; i++) {
848 struct dsa_switch *ds;
850 ds = dsa_switch_setup(dst, i, parent, pd->chip[i].host_dev);
852 netdev_err(dev, "[%d]: couldn't create dsa switch instance (error %ld)\n",
863 * If no switch was found, exit cleanly
866 return -EPROBE_DEFER;
869 * If we use a tagging format that doesn't have an ethertype
870 * field, make sure that all packets from this point on get
871 * sent to the tag format's receive function.
874 dev->dsa_ptr = (void *)dst;
879 static int dsa_probe(struct platform_device *pdev)
881 struct dsa_platform_data *pd = pdev->dev.platform_data;
882 struct net_device *dev;
883 struct dsa_switch_tree *dst;
886 pr_notice_once("Distributed Switch Architecture driver version %s\n",
889 if (pdev->dev.of_node) {
890 ret = dsa_of_probe(&pdev->dev);
894 pd = pdev->dev.platform_data;
897 if (pd == NULL || (pd->netdev == NULL && pd->of_netdev == NULL))
904 dev = dev_to_net_device(pd->netdev);
911 if (dev->dsa_ptr != NULL) {
917 dst = devm_kzalloc(&pdev->dev, sizeof(*dst), GFP_KERNEL);
924 platform_set_drvdata(pdev, dst);
926 ret = dsa_setup_dst(dst, dev, &pdev->dev, pd);
935 dsa_of_remove(&pdev->dev);
940 static void dsa_remove_dst(struct dsa_switch_tree *dst)
944 dst->master_netdev->dsa_ptr = NULL;
946 /* If we used a tagging format that doesn't have an ethertype
947 * field, make sure that all packets from this point get sent
948 * without the tag and go through the regular receive path.
952 for (i = 0; i < dst->pd->nr_chips; i++) {
953 struct dsa_switch *ds = dst->ds[i];
956 dsa_switch_destroy(ds);
959 dev_put(dst->master_netdev);
962 static int dsa_remove(struct platform_device *pdev)
964 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
967 dsa_of_remove(&pdev->dev);
972 static void dsa_shutdown(struct platform_device *pdev)
976 static int dsa_switch_rcv(struct sk_buff *skb, struct net_device *dev,
977 struct packet_type *pt, struct net_device *orig_dev)
979 struct dsa_switch_tree *dst = dev->dsa_ptr;
981 if (unlikely(dst == NULL)) {
986 return dst->rcv(skb, dev, pt, orig_dev);
989 static struct packet_type dsa_pack_type __read_mostly = {
990 .type = cpu_to_be16(ETH_P_XDSA),
991 .func = dsa_switch_rcv,
994 static struct notifier_block dsa_netdevice_nb __read_mostly = {
995 .notifier_call = dsa_slave_netdevice_event,
998 #ifdef CONFIG_PM_SLEEP
999 static int dsa_suspend(struct device *d)
1001 struct platform_device *pdev = to_platform_device(d);
1002 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
1005 for (i = 0; i < dst->pd->nr_chips; i++) {
1006 struct dsa_switch *ds = dst->ds[i];
1009 ret = dsa_switch_suspend(ds);
1015 static int dsa_resume(struct device *d)
1017 struct platform_device *pdev = to_platform_device(d);
1018 struct dsa_switch_tree *dst = platform_get_drvdata(pdev);
1021 for (i = 0; i < dst->pd->nr_chips; i++) {
1022 struct dsa_switch *ds = dst->ds[i];
1025 ret = dsa_switch_resume(ds);
1032 static SIMPLE_DEV_PM_OPS(dsa_pm_ops, dsa_suspend, dsa_resume);
1034 static const struct of_device_id dsa_of_match_table[] = {
1035 { .compatible = "brcm,bcm7445-switch-v4.0" },
1036 { .compatible = "marvell,dsa", },
1039 MODULE_DEVICE_TABLE(of, dsa_of_match_table);
1041 static struct platform_driver dsa_driver = {
1043 .remove = dsa_remove,
1044 .shutdown = dsa_shutdown,
1047 .of_match_table = dsa_of_match_table,
1052 static int __init dsa_init_module(void)
1056 register_netdevice_notifier(&dsa_netdevice_nb);
1058 rc = platform_driver_register(&dsa_driver);
1062 dev_add_pack(&dsa_pack_type);
1066 module_init(dsa_init_module);
1068 static void __exit dsa_cleanup_module(void)
1070 unregister_netdevice_notifier(&dsa_netdevice_nb);
1071 dev_remove_pack(&dsa_pack_type);
1072 platform_driver_unregister(&dsa_driver);
1074 module_exit(dsa_cleanup_module);
1076 MODULE_AUTHOR("Lennert Buytenhek <buytenh@wantstofly.org>");
1077 MODULE_DESCRIPTION("Driver for Distributed Switch Architecture switch chips");
1078 MODULE_LICENSE("GPL");
1079 MODULE_ALIAS("platform:dsa");