Commit | Line | Data |
---|---|---|
55716d26 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
4b6ba8aa DD |
2 | /* |
3 | * OF helpers for network devices. | |
4 | * | |
4b6ba8aa DD |
5 | * 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> | |
d01f449c | 10 | #include <linux/of_platform.h> |
6ca1a113 | 11 | #include <linux/phy.h> |
2c8d667a | 12 | #include <linux/export.h> |
d01f449c | 13 | #include <linux/device.h> |
f10843e0 | 14 | #include <linux/nvmem-consumer.h> |
6ca1a113 | 15 | |
6ca1a113 SG |
16 | /** |
17 | * of_get_phy_mode - Get phy mode for given device_node | |
18 | * @np: Pointer to the given device_node | |
0c65b2b9 | 19 | * @interface: Pointer to the result |
6ca1a113 | 20 | * |
cf4c9eb5 | 21 | * The function gets phy interface string from property 'phy-mode' or |
0c65b2b9 AL |
22 | * 'phy-connection-type'. The index in phy_modes table is set in |
23 | * interface and 0 returned. In case of error interface is set to | |
24 | * PHY_INTERFACE_MODE_NA and an errno is returned, e.g. -ENODEV. | |
6ca1a113 | 25 | */ |
0c65b2b9 | 26 | int of_get_phy_mode(struct device_node *np, phy_interface_t *interface) |
6ca1a113 SG |
27 | { |
28 | const char *pm; | |
29 | int err, i; | |
30 | ||
0c65b2b9 AL |
31 | *interface = PHY_INTERFACE_MODE_NA; |
32 | ||
6ca1a113 | 33 | err = of_property_read_string(np, "phy-mode", &pm); |
cf4c9eb5 FF |
34 | if (err < 0) |
35 | err = of_property_read_string(np, "phy-connection-type", &pm); | |
6ca1a113 SG |
36 | if (err < 0) |
37 | return err; | |
38 | ||
8a2fe56e | 39 | for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++) |
0c65b2b9 AL |
40 | if (!strcasecmp(pm, phy_modes(i))) { |
41 | *interface = i; | |
42 | return 0; | |
43 | } | |
6ca1a113 SG |
44 | |
45 | return -ENODEV; | |
46 | } | |
47 | EXPORT_SYMBOL_GPL(of_get_phy_mode); | |
4b6ba8aa | 48 | |
83216e39 | 49 | static int of_get_mac_addr(struct device_node *np, const char *name, u8 *addr) |
3eb46a1d SS |
50 | { |
51 | struct property *pp = of_find_property(np, name, NULL); | |
52 | ||
83216e39 MW |
53 | if (pp && pp->length == ETH_ALEN && is_valid_ether_addr(pp->value)) { |
54 | memcpy(addr, pp->value, ETH_ALEN); | |
55 | return 0; | |
56 | } | |
57 | return -ENODEV; | |
3eb46a1d SS |
58 | } |
59 | ||
4c47867b | 60 | int of_get_mac_address_nvmem(struct device_node *np, u8 *addr) |
d01f449c | 61 | { |
d01f449c | 62 | struct platform_device *pdev = of_find_device_by_node(np); |
f10843e0 | 63 | struct nvmem_cell *cell; |
3486eb77 | 64 | const void *mac; |
f10843e0 | 65 | size_t len; |
83216e39 | 66 | int ret; |
d01f449c | 67 | |
f10843e0 MW |
68 | /* Try lookup by device first, there might be a nvmem_cell_lookup |
69 | * associated with a given device. | |
70 | */ | |
71 | if (pdev) { | |
72 | ret = nvmem_get_mac_address(&pdev->dev, addr); | |
73 | put_device(&pdev->dev); | |
74 | return ret; | |
75 | } | |
76 | ||
77 | cell = of_nvmem_cell_get(np, "mac-address"); | |
78 | if (IS_ERR(cell)) | |
79 | return PTR_ERR(cell); | |
80 | ||
3486eb77 | 81 | mac = nvmem_cell_read(cell, &len); |
f10843e0 MW |
82 | nvmem_cell_put(cell); |
83 | ||
3486eb77 MW |
84 | if (IS_ERR(mac)) |
85 | return PTR_ERR(mac); | |
86 | ||
87 | if (len != ETH_ALEN || !is_valid_ether_addr(mac)) { | |
88 | kfree(mac); | |
89 | return -EINVAL; | |
f10843e0 | 90 | } |
d01f449c | 91 | |
3486eb77 MW |
92 | memcpy(addr, mac, ETH_ALEN); |
93 | kfree(mac); | |
d01f449c | 94 | |
3486eb77 | 95 | return 0; |
d01f449c | 96 | } |
4c47867b | 97 | EXPORT_SYMBOL(of_get_mac_address_nvmem); |
d01f449c | 98 | |
4b6ba8aa | 99 | /** |
21e0b8fc LJ |
100 | * of_get_mac_address() |
101 | * @np: Caller's Device Node | |
83216e39 | 102 | * @addr: Pointer to a six-byte array for the result |
21e0b8fc | 103 | * |
4b6ba8aa DD |
104 | * Search the device tree for the best MAC address to use. 'mac-address' is |
105 | * checked first, because that is supposed to contain to "most recent" MAC | |
106 | * address. If that isn't set, then 'local-mac-address' is checked next, | |
d01f449c PŠ |
107 | * because that is the default address. If that isn't set, then the obsolete |
108 | * 'address' is checked, just in case we're using an old device tree. If any | |
109 | * of the above isn't set, then try to get MAC address from nvmem cell named | |
110 | * 'mac-address'. | |
4b6ba8aa DD |
111 | * |
112 | * Note that the 'address' property is supposed to contain a virtual address of | |
113 | * the register set, but some DTS files have redefined that property to be the | |
114 | * MAC address. | |
115 | * | |
116 | * All-zero MAC addresses are rejected, because those could be properties that | |
117 | * exist in the device tree, but were not set by U-Boot. For example, the | |
118 | * DTS could define 'mac-address' and 'local-mac-address', with zero MAC | |
119 | * addresses. Some older U-Boots only initialized 'local-mac-address'. In | |
120 | * this case, the real MAC is in 'local-mac-address', and 'mac-address' exists | |
121 | * but is all zeros. | |
d01f449c | 122 | * |
83216e39 | 123 | * Return: 0 on success and errno in case of error. |
4b6ba8aa | 124 | */ |
83216e39 | 125 | int of_get_mac_address(struct device_node *np, u8 *addr) |
4b6ba8aa | 126 | { |
83216e39 MW |
127 | int ret; |
128 | ||
129 | if (!np) | |
130 | return -ENODEV; | |
4b6ba8aa | 131 | |
83216e39 MW |
132 | ret = of_get_mac_addr(np, "mac-address", addr); |
133 | if (!ret) | |
134 | return 0; | |
4b6ba8aa | 135 | |
83216e39 MW |
136 | ret = of_get_mac_addr(np, "local-mac-address", addr); |
137 | if (!ret) | |
138 | return 0; | |
4b6ba8aa | 139 | |
83216e39 MW |
140 | ret = of_get_mac_addr(np, "address", addr); |
141 | if (!ret) | |
142 | return 0; | |
d01f449c | 143 | |
4c47867b | 144 | return of_get_mac_address_nvmem(np, addr); |
4b6ba8aa DD |
145 | } |
146 | EXPORT_SYMBOL(of_get_mac_address); | |
d466effe JK |
147 | |
148 | /** | |
149 | * of_get_ethdev_address() | |
150 | * @np: Caller's Device Node | |
151 | * @dev: Pointer to netdevice which address will be updated | |
152 | * | |
153 | * Search the device tree for the best MAC address to use. | |
154 | * If found set @dev->dev_addr to that address. | |
155 | * | |
156 | * See documentation of of_get_mac_address() for more information on how | |
157 | * the best address is determined. | |
158 | * | |
159 | * Return: 0 on success and errno in case of error. | |
160 | */ | |
161 | int of_get_ethdev_address(struct device_node *np, struct net_device *dev) | |
162 | { | |
163 | u8 addr[ETH_ALEN]; | |
164 | int ret; | |
165 | ||
166 | ret = of_get_mac_address(np, addr); | |
167 | if (!ret) | |
168 | eth_hw_addr_set(dev, addr); | |
169 | return ret; | |
170 | } | |
171 | EXPORT_SYMBOL(of_get_ethdev_address); |