xref: /linux-6.15/include/linux/of_mdio.h (revision bb79974c)
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/phy.h>
12 #include <linux/of.h>
13 
14 #if IS_ENABLED(CONFIG_OF_MDIO)
15 extern bool of_mdiobus_child_is_phy(struct device_node *child);
16 extern int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np);
17 extern struct phy_device *of_phy_find_device(struct device_node *phy_np);
18 extern struct phy_device *of_phy_connect(struct net_device *dev,
19 					 struct device_node *phy_np,
20 					 void (*hndlr)(struct net_device *),
21 					 u32 flags, phy_interface_t iface);
22 extern struct phy_device *
23 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
24 		       void (*hndlr)(struct net_device *));
25 struct phy_device *of_phy_attach(struct net_device *dev,
26 				 struct device_node *phy_np, u32 flags,
27 				 phy_interface_t iface);
28 
29 extern struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np);
30 extern int of_phy_register_fixed_link(struct device_node *np);
31 extern void of_phy_deregister_fixed_link(struct device_node *np);
32 extern bool of_phy_is_fixed_link(struct device_node *np);
33 extern int of_mdiobus_phy_device_register(struct mii_bus *mdio,
34 				     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 phy_device *of_phy_find_device(struct device_node *phy_np)
76 {
77 	return NULL;
78 }
79 
80 static inline struct phy_device *of_phy_connect(struct net_device *dev,
81 						struct device_node *phy_np,
82 						void (*hndlr)(struct net_device *),
83 						u32 flags, phy_interface_t iface)
84 {
85 	return NULL;
86 }
87 
88 static inline struct phy_device *
89 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
90 		       void (*hndlr)(struct net_device *))
91 {
92 	return NULL;
93 }
94 
95 static inline struct phy_device *of_phy_attach(struct net_device *dev,
96 					       struct device_node *phy_np,
97 					       u32 flags, phy_interface_t iface)
98 {
99 	return NULL;
100 }
101 
102 static inline struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np)
103 {
104 	return NULL;
105 }
106 
107 static inline int of_mdio_parse_addr(struct device *dev,
108 				     const struct device_node *np)
109 {
110 	return -ENOSYS;
111 }
112 static inline int of_phy_register_fixed_link(struct device_node *np)
113 {
114 	return -ENOSYS;
115 }
116 static inline void of_phy_deregister_fixed_link(struct device_node *np)
117 {
118 }
119 static inline bool of_phy_is_fixed_link(struct device_node *np)
120 {
121 	return false;
122 }
123 
124 static inline int of_mdiobus_phy_device_register(struct mii_bus *mdio,
125 					    struct phy_device *phy,
126 					    struct device_node *child, u32 addr)
127 {
128 	return -ENOSYS;
129 }
130 #endif
131 
132 
133 #endif /* __LINUX_OF_MDIO_H */
134