1/*
 2 * OF helpers for network devices.
 3 *
 4 * This file is released under the GPLv2
 5 *
 6 * Initially copied out of arch/powerpc/kernel/prom_parse.c
 7 */
 8#include <linux/etherdevice.h>
 9#include <linux/kernel.h>
10#include <linux/of_net.h>
11#include <linux/phy.h>
12
13/**
14 * It maps 'enum phy_interface_t' found in include/linux/phy.h
15 * into the device tree binding of 'phy-mode', so that Ethernet
16 * device driver can get phy interface from device tree.
17 */
18static const char *phy_modes[] = {
19	[PHY_INTERFACE_MODE_NA]		= "",
20	[PHY_INTERFACE_MODE_MII]	= "mii",
21	[PHY_INTERFACE_MODE_GMII]	= "gmii",
22	[PHY_INTERFACE_MODE_SGMII]	= "sgmii",
23	[PHY_INTERFACE_MODE_TBI]	= "tbi",
24	[PHY_INTERFACE_MODE_RMII]	= "rmii",
25	[PHY_INTERFACE_MODE_RGMII]	= "rgmii",
26	[PHY_INTERFACE_MODE_RGMII_ID]	= "rgmii-id",
27	[PHY_INTERFACE_MODE_RGMII_RXID]	= "rgmii-rxid",
28	[PHY_INTERFACE_MODE_RGMII_TXID] = "rgmii-txid",
29	[PHY_INTERFACE_MODE_RTBI]	= "rtbi",
30	[PHY_INTERFACE_MODE_SMII]	= "smii",
31};
32
33/**
34 * of_get_phy_mode - Get phy mode for given device_node
35 * @np:	Pointer to the given device_node
36 *
37 * The function gets phy interface string from property 'phy-mode',
38 * and return its index in phy_modes table, or errno in error case.
39 */
40const int of_get_phy_mode(struct device_node *np)
41{
42	const char *pm;
43	int err, i;
44
45	err = of_property_read_string(np, "phy-mode", &pm);
46	if (err < 0)
47		return err;
48
49	for (i = 0; i < ARRAY_SIZE(phy_modes); i++)
50		if (!strcasecmp(pm, phy_modes[i]))
51			return i;
52
53	return -ENODEV;
54}
55EXPORT_SYMBOL_GPL(of_get_phy_mode);
56
57/**
58 * Search the device tree for the best MAC address to use.  'mac-address' is
59 * checked first, because that is supposed to contain to "most recent" MAC
60 * address. If that isn't set, then 'local-mac-address' is checked next,
61 * because that is the default address.  If that isn't set, then the obsolete
62 * 'address' is checked, just in case we're using an old device tree.
63 *
64 * Note that the 'address' property is supposed to contain a virtual address of
65 * the register set, but some DTS files have redefined that property to be the
66 * MAC address.
67 *
68 * All-zero MAC addresses are rejected, because those could be properties that
69 * exist in the device tree, but were not set by U-Boot.  For example, the
70 * DTS could define 'mac-address' and 'local-mac-address', with zero MAC
71 * addresses.  Some older U-Boots only initialized 'local-mac-address'.  In
72 * this case, the real MAC is in 'local-mac-address', and 'mac-address' exists
73 * but is all zeros.
74*/
75const void *of_get_mac_address(struct device_node *np)
76{
77	struct property *pp;
78
79	pp = of_find_property(np, "mac-address", NULL);
80	if (pp && (pp->length == 6) && is_valid_ether_addr(pp->value))
81		return pp->value;
82
83	pp = of_find_property(np, "local-mac-address", NULL);
84	if (pp && (pp->length == 6) && is_valid_ether_addr(pp->value))
85		return pp->value;
86
87	pp = of_find_property(np, "address", NULL);
88	if (pp && (pp->length == 6) && is_valid_ether_addr(pp->value))
89		return pp->value;
90
91	return NULL;
92}
93EXPORT_SYMBOL(of_get_mac_address);