xref: /linux-6.15/include/linux/of_mdio.h (revision ca91ddef)
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 
34 
35 static inline int of_mdio_parse_addr(struct device *dev,
36 				     const struct device_node *np)
37 {
38 	u32 addr;
39 	int ret;
40 
41 	ret = of_property_read_u32(np, "reg", &addr);
42 	if (ret < 0) {
43 		dev_err(dev, "%s has invalid PHY address\n", np->full_name);
44 		return ret;
45 	}
46 
47 	/* A PHY must have a reg property in the range [0-31] */
48 	if (addr >= PHY_MAX_ADDR) {
49 		dev_err(dev, "%s PHY address %i is too large\n",
50 			np->full_name, addr);
51 		return -EINVAL;
52 	}
53 
54 	return addr;
55 }
56 
57 #else /* CONFIG_OF_MDIO */
58 static inline bool of_mdiobus_child_is_phy(struct device_node *child)
59 {
60 	return false;
61 }
62 
63 static inline int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
64 {
65 	/*
66 	 * Fall back to the non-DT function to register a bus.
67 	 * This way, we don't have to keep compat bits around in drivers.
68 	 */
69 
70 	return mdiobus_register(mdio);
71 }
72 
73 static inline struct phy_device *of_phy_find_device(struct device_node *phy_np)
74 {
75 	return NULL;
76 }
77 
78 static inline struct phy_device *of_phy_connect(struct net_device *dev,
79 						struct device_node *phy_np,
80 						void (*hndlr)(struct net_device *),
81 						u32 flags, phy_interface_t iface)
82 {
83 	return NULL;
84 }
85 
86 static inline struct phy_device *
87 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
88 		       void (*hndlr)(struct net_device *))
89 {
90 	return NULL;
91 }
92 
93 static inline struct phy_device *of_phy_attach(struct net_device *dev,
94 					       struct device_node *phy_np,
95 					       u32 flags, phy_interface_t iface)
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 #endif
122 
123 
124 #endif /* __LINUX_OF_MDIO_H */
125