blob: 6e411821583e4f2fd71d108687dee528b767a7a0 [file] [log] [blame]
Thomas Gleixner55716d22019-06-01 10:08:42 +02001// SPDX-License-Identifier: GPL-2.0-only
David Daney4b6ba8a2010-10-26 15:07:13 -07002/*
3 * OF helpers for network devices.
4 *
David Daney4b6ba8a2010-10-26 15:07:13 -07005 * Initially copied out of arch/powerpc/kernel/prom_parse.c
6 */
7#include <linux/etherdevice.h>
8#include <linux/kernel.h>
9#include <linux/of_net.h>
Petr Štetiard01f4492019-05-03 16:27:06 +020010#include <linux/of_platform.h>
Shawn Guo6ca1a112011-07-04 14:03:17 +080011#include <linux/phy.h>
Paul Gortmaker2c8d6672011-07-29 16:05:38 +100012#include <linux/export.h>
Petr Štetiard01f4492019-05-03 16:27:06 +020013#include <linux/device.h>
Shawn Guo6ca1a112011-07-04 14:03:17 +080014
15/**
Shawn Guo6ca1a112011-07-04 14:03:17 +080016 * of_get_phy_mode - Get phy mode for given device_node
17 * @np: Pointer to the given device_node
Andrew Lunn0c65b2b2019-11-04 02:40:33 +010018 * @interface: Pointer to the result
Shawn Guo6ca1a112011-07-04 14:03:17 +080019 *
Florian Fainellicf4c9eb2013-11-15 06:23:32 +000020 * The function gets phy interface string from property 'phy-mode' or
Andrew Lunn0c65b2b2019-11-04 02:40:33 +010021 * 'phy-connection-type'. The index in phy_modes table is set in
22 * interface and 0 returned. In case of error interface is set to
23 * PHY_INTERFACE_MODE_NA and an errno is returned, e.g. -ENODEV.
Shawn Guo6ca1a112011-07-04 14:03:17 +080024 */
Andrew Lunn0c65b2b2019-11-04 02:40:33 +010025int of_get_phy_mode(struct device_node *np, phy_interface_t *interface)
Shawn Guo6ca1a112011-07-04 14:03:17 +080026{
27 const char *pm;
28 int err, i;
29
Andrew Lunn0c65b2b2019-11-04 02:40:33 +010030 *interface = PHY_INTERFACE_MODE_NA;
31
Shawn Guo6ca1a112011-07-04 14:03:17 +080032 err = of_property_read_string(np, "phy-mode", &pm);
33 if (err < 0)
Florian Fainellicf4c9eb2013-11-15 06:23:32 +000034 err = of_property_read_string(np, "phy-connection-type", &pm);
35 if (err < 0)
Shawn Guo6ca1a112011-07-04 14:03:17 +080036 return err;
37
Florian Fainelli8a2fe562014-02-11 17:27:39 -080038 for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++)
Andrew Lunn0c65b2b2019-11-04 02:40:33 +010039 if (!strcasecmp(pm, phy_modes(i))) {
40 *interface = i;
41 return 0;
42 }
Shawn Guo6ca1a112011-07-04 14:03:17 +080043
44 return -ENODEV;
45}
46EXPORT_SYMBOL_GPL(of_get_phy_mode);
David Daney4b6ba8a2010-10-26 15:07:13 -070047
Sergei Shtylyov3eb46a12015-03-18 22:25:46 +030048static const void *of_get_mac_addr(struct device_node *np, const char *name)
49{
50 struct property *pp = of_find_property(np, name, NULL);
51
52 if (pp && pp->length == ETH_ALEN && is_valid_ether_addr(pp->value))
53 return pp->value;
54 return NULL;
55}
56
Petr Štetiard01f4492019-05-03 16:27:06 +020057static const void *of_get_mac_addr_nvmem(struct device_node *np)
58{
59 int ret;
Petr Štetiar26574982019-05-10 11:35:14 +020060 const void *mac;
61 u8 nvmem_mac[ETH_ALEN];
Petr Štetiard01f4492019-05-03 16:27:06 +020062 struct platform_device *pdev = of_find_device_by_node(np);
63
64 if (!pdev)
65 return ERR_PTR(-ENODEV);
66
Petr Štetiar26574982019-05-10 11:35:14 +020067 ret = nvmem_get_mac_address(&pdev->dev, &nvmem_mac);
Petr Štetiar3ee9ae72019-05-13 11:41:39 +020068 if (ret) {
69 put_device(&pdev->dev);
Petr Štetiard01f4492019-05-03 16:27:06 +020070 return ERR_PTR(ret);
Petr Štetiar3ee9ae72019-05-13 11:41:39 +020071 }
Petr Štetiard01f4492019-05-03 16:27:06 +020072
Petr Štetiar26574982019-05-10 11:35:14 +020073 mac = devm_kmemdup(&pdev->dev, nvmem_mac, ETH_ALEN, GFP_KERNEL);
Petr Štetiar3ee9ae72019-05-13 11:41:39 +020074 put_device(&pdev->dev);
Petr Štetiar26574982019-05-10 11:35:14 +020075 if (!mac)
Petr Štetiard01f4492019-05-03 16:27:06 +020076 return ERR_PTR(-ENOMEM);
77
Petr Štetiar26574982019-05-10 11:35:14 +020078 return mac;
Petr Štetiard01f4492019-05-03 16:27:06 +020079}
80
David Daney4b6ba8a2010-10-26 15:07:13 -070081/**
82 * Search the device tree for the best MAC address to use. 'mac-address' is
83 * checked first, because that is supposed to contain to "most recent" MAC
84 * address. If that isn't set, then 'local-mac-address' is checked next,
Petr Štetiard01f4492019-05-03 16:27:06 +020085 * because that is the default address. If that isn't set, then the obsolete
86 * 'address' is checked, just in case we're using an old device tree. If any
87 * of the above isn't set, then try to get MAC address from nvmem cell named
88 * 'mac-address'.
David Daney4b6ba8a2010-10-26 15:07:13 -070089 *
90 * Note that the 'address' property is supposed to contain a virtual address of
91 * the register set, but some DTS files have redefined that property to be the
92 * MAC address.
93 *
94 * All-zero MAC addresses are rejected, because those could be properties that
95 * exist in the device tree, but were not set by U-Boot. For example, the
96 * DTS could define 'mac-address' and 'local-mac-address', with zero MAC
97 * addresses. Some older U-Boots only initialized 'local-mac-address'. In
98 * this case, the real MAC is in 'local-mac-address', and 'mac-address' exists
99 * but is all zeros.
Petr Štetiard01f4492019-05-03 16:27:06 +0200100 *
101 * Return: Will be a valid pointer on success and ERR_PTR in case of error.
David Daney4b6ba8a2010-10-26 15:07:13 -0700102*/
103const void *of_get_mac_address(struct device_node *np)
104{
Sergei Shtylyov3eb46a12015-03-18 22:25:46 +0300105 const void *addr;
David Daney4b6ba8a2010-10-26 15:07:13 -0700106
Sergei Shtylyov3eb46a12015-03-18 22:25:46 +0300107 addr = of_get_mac_addr(np, "mac-address");
108 if (addr)
109 return addr;
David Daney4b6ba8a2010-10-26 15:07:13 -0700110
Sergei Shtylyov3eb46a12015-03-18 22:25:46 +0300111 addr = of_get_mac_addr(np, "local-mac-address");
112 if (addr)
113 return addr;
David Daney4b6ba8a2010-10-26 15:07:13 -0700114
Petr Štetiard01f4492019-05-03 16:27:06 +0200115 addr = of_get_mac_addr(np, "address");
116 if (addr)
117 return addr;
118
119 return of_get_mac_addr_nvmem(np);
David Daney4b6ba8a2010-10-26 15:07:13 -0700120}
121EXPORT_SYMBOL(of_get_mac_address);