xref: /openbmc/linux/include/linux/of_mdio.h (revision c606970d)
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 int devm_of_mdiobus_register(struct device *dev, struct mii_bus *mdio,
19 			     struct device_node *np);
20 struct mdio_device *of_mdio_find_device(struct device_node *np);
21 struct phy_device *of_phy_find_device(struct device_node *phy_np);
22 struct phy_device *
23 of_phy_connect(struct net_device *dev, struct device_node *phy_np,
24 	       void (*hndlr)(struct net_device *), u32 flags,
25 	       phy_interface_t iface);
26 struct phy_device *
27 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
28 		       void (*hndlr)(struct net_device *));
29 
30 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np);
31 int of_phy_register_fixed_link(struct device_node *np);
32 void of_phy_deregister_fixed_link(struct device_node *np);
33 bool of_phy_is_fixed_link(struct device_node *np);
34 int of_mdiobus_phy_device_register(struct mii_bus *mdio, struct phy_device *phy,
35 				   struct device_node *child, u32 addr);
36 
37 static inline int of_mdio_parse_addr(struct device *dev,
38 				     const struct device_node *np)
39 {
40 	u32 addr;
41 	int ret;
42 
43 	ret = of_property_read_u32(np, "reg", &addr);
44 	if (ret < 0) {
45 		dev_err(dev, "%s has invalid PHY address\n", np->full_name);
46 		return ret;
47 	}
48 
49 	/* A PHY must have a reg property in the range [0-31] */
50 	if (addr >= PHY_MAX_ADDR) {
51 		dev_err(dev, "%s PHY address %i is too large\n",
52 			np->full_name, addr);
53 		return -EINVAL;
54 	}
55 
56 	return addr;
57 }
58 
59 #else /* CONFIG_OF_MDIO */
60 static inline bool of_mdiobus_child_is_phy(struct device_node *child)
61 {
62 	return false;
63 }
64 
65 static inline int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
66 {
67 	/*
68 	 * Fall back to the non-DT function to register a bus.
69 	 * This way, we don't have to keep compat bits around in drivers.
70 	 */
71 
72 	return mdiobus_register(mdio);
73 }
74 
75 static inline struct mdio_device *of_mdio_find_device(struct device_node *np)
76 {
77 	return NULL;
78 }
79 
80 static inline struct phy_device *of_phy_find_device(struct device_node *phy_np)
81 {
82 	return NULL;
83 }
84 
85 static inline struct phy_device *of_phy_connect(struct net_device *dev,
86 						struct device_node *phy_np,
87 						void (*hndlr)(struct net_device *),
88 						u32 flags, phy_interface_t iface)
89 {
90 	return NULL;
91 }
92 
93 static inline struct phy_device *
94 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
95 		       void (*hndlr)(struct net_device *))
96 {
97 	return NULL;
98 }
99 
100 static inline struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np)
101 {
102 	return NULL;
103 }
104 
105 static inline int of_mdio_parse_addr(struct device *dev,
106 				     const struct device_node *np)
107 {
108 	return -ENOSYS;
109 }
110 static inline int of_phy_register_fixed_link(struct device_node *np)
111 {
112 	return -ENOSYS;
113 }
114 static inline void of_phy_deregister_fixed_link(struct device_node *np)
115 {
116 }
117 static inline bool of_phy_is_fixed_link(struct device_node *np)
118 {
119 	return false;
120 }
121 
122 static inline int of_mdiobus_phy_device_register(struct mii_bus *mdio,
123 					    struct phy_device *phy,
124 					    struct device_node *child, u32 addr)
125 {
126 	return -ENOSYS;
127 }
128 #endif
129 
130 
131 #endif /* __LINUX_OF_MDIO_H */
132