1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * OF helpers for the MDIO (Ethernet PHY) API
4 *
5 * Copyright (c) 2009 Secret Lab Technologies, Ltd.
6 */
7
8 #ifndef __LINUX_OF_MDIO_H
9 #define __LINUX_OF_MDIO_H
10
11 #include <linux/device.h>
12 #include <linux/phy.h>
13 #include <linux/of.h>
14
15 #if IS_ENABLED(CONFIG_OF_MDIO)
16 bool of_mdiobus_child_is_phy(struct device_node *child);
17 int __of_mdiobus_register(struct mii_bus *mdio, struct device_node *np,
18 struct module *owner);
19
of_mdiobus_register(struct mii_bus * mdio,struct device_node * np)20 static inline int of_mdiobus_register(struct mii_bus *mdio,
21 struct device_node *np)
22 {
23 return __of_mdiobus_register(mdio, np, THIS_MODULE);
24 }
25
26 int __devm_of_mdiobus_register(struct device *dev, struct mii_bus *mdio,
27 struct device_node *np, struct module *owner);
28
devm_of_mdiobus_register(struct device * dev,struct mii_bus * mdio,struct device_node * np)29 static inline int devm_of_mdiobus_register(struct device *dev,
30 struct mii_bus *mdio,
31 struct device_node *np)
32 {
33 return __devm_of_mdiobus_register(dev, mdio, np, THIS_MODULE);
34 }
35
36 struct mdio_device *of_mdio_find_device(struct device_node *np);
37 struct phy_device *of_phy_find_device(struct device_node *phy_np);
38 struct phy_device *
39 of_phy_connect(struct net_device *dev, struct device_node *phy_np,
40 void (*hndlr)(struct net_device *), u32 flags,
41 phy_interface_t iface);
42 struct phy_device *
43 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
44 void (*hndlr)(struct net_device *));
45 struct phy_device *
46 of_phy_attach(struct net_device *dev, struct device_node *phy_np,
47 u32 flags, phy_interface_t iface);
48
49 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np);
50 int of_phy_register_fixed_link(struct device_node *np);
51 void of_phy_deregister_fixed_link(struct device_node *np);
52 bool of_phy_is_fixed_link(struct device_node *np);
53 int of_mdiobus_phy_device_register(struct mii_bus *mdio, struct phy_device *phy,
54 struct device_node *child, u32 addr);
55
of_mdio_parse_addr(struct device * dev,const struct device_node * np)56 static inline int of_mdio_parse_addr(struct device *dev,
57 const struct device_node *np)
58 {
59 u32 addr;
60 int ret;
61
62 ret = of_property_read_u32(np, "reg", &addr);
63 if (ret < 0) {
64 dev_err(dev, "%s has invalid PHY address\n", np->full_name);
65 return ret;
66 }
67
68 /* A PHY must have a reg property in the range [0-31] */
69 if (addr >= PHY_MAX_ADDR) {
70 dev_err(dev, "%s PHY address %i is too large\n",
71 np->full_name, addr);
72 return -EINVAL;
73 }
74
75 return addr;
76 }
77
78 #else /* CONFIG_OF_MDIO */
of_mdiobus_child_is_phy(struct device_node * child)79 static inline bool of_mdiobus_child_is_phy(struct device_node *child)
80 {
81 return false;
82 }
83
of_mdiobus_register(struct mii_bus * mdio,struct device_node * np)84 static inline int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
85 {
86 /*
87 * Fall back to the non-DT function to register a bus.
88 * This way, we don't have to keep compat bits around in drivers.
89 */
90
91 return mdiobus_register(mdio);
92 }
93
devm_of_mdiobus_register(struct device * dev,struct mii_bus * mdio,struct device_node * np)94 static inline int devm_of_mdiobus_register(struct device *dev,
95 struct mii_bus *mdio,
96 struct device_node *np)
97 {
98 return devm_mdiobus_register(dev, mdio);
99 }
100
of_mdio_find_device(struct device_node * np)101 static inline struct mdio_device *of_mdio_find_device(struct device_node *np)
102 {
103 return NULL;
104 }
105
of_phy_find_device(struct device_node * phy_np)106 static inline struct phy_device *of_phy_find_device(struct device_node *phy_np)
107 {
108 return NULL;
109 }
110
of_phy_connect(struct net_device * dev,struct device_node * phy_np,void (* hndlr)(struct net_device *),u32 flags,phy_interface_t iface)111 static inline struct phy_device *of_phy_connect(struct net_device *dev,
112 struct device_node *phy_np,
113 void (*hndlr)(struct net_device *),
114 u32 flags, phy_interface_t iface)
115 {
116 return NULL;
117 }
118
119 static inline struct phy_device *
of_phy_get_and_connect(struct net_device * dev,struct device_node * np,void (* hndlr)(struct net_device *))120 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
121 void (*hndlr)(struct net_device *))
122 {
123 return NULL;
124 }
125
of_phy_attach(struct net_device * dev,struct device_node * phy_np,u32 flags,phy_interface_t iface)126 static inline struct phy_device *of_phy_attach(struct net_device *dev,
127 struct device_node *phy_np,
128 u32 flags, phy_interface_t iface)
129 {
130 return NULL;
131 }
132
of_mdio_find_bus(struct device_node * mdio_np)133 static inline struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np)
134 {
135 return NULL;
136 }
137
of_mdio_parse_addr(struct device * dev,const struct device_node * np)138 static inline int of_mdio_parse_addr(struct device *dev,
139 const struct device_node *np)
140 {
141 return -ENOSYS;
142 }
of_phy_register_fixed_link(struct device_node * np)143 static inline int of_phy_register_fixed_link(struct device_node *np)
144 {
145 return -ENOSYS;
146 }
of_phy_deregister_fixed_link(struct device_node * np)147 static inline void of_phy_deregister_fixed_link(struct device_node *np)
148 {
149 }
of_phy_is_fixed_link(struct device_node * np)150 static inline bool of_phy_is_fixed_link(struct device_node *np)
151 {
152 return false;
153 }
154
of_mdiobus_phy_device_register(struct mii_bus * mdio,struct phy_device * phy,struct device_node * child,u32 addr)155 static inline int of_mdiobus_phy_device_register(struct mii_bus *mdio,
156 struct phy_device *phy,
157 struct device_node *child, u32 addr)
158 {
159 return -ENOSYS;
160 }
161 #endif
162
163
164 #endif /* __LINUX_OF_MDIO_H */
165