xref: /linux-6.15/include/linux/mdio.h (revision e7cb7cf4)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * linux/mdio.h: definitions for MDIO (clause 45) transceivers
4  * Copyright 2006-2009 Solarflare Communications Inc.
5  */
6 #ifndef __LINUX_MDIO_H__
7 #define __LINUX_MDIO_H__
8 
9 #include <uapi/linux/mdio.h>
10 #include <linux/bitfield.h>
11 #include <linux/mod_devicetable.h>
12 
13 struct gpio_desc;
14 struct mii_bus;
15 struct reset_control;
16 
17 /* Multiple levels of nesting are possible. However typically this is
18  * limited to nested DSA like layer, a MUX layer, and the normal
19  * user. Instead of trying to handle the general case, just define
20  * these cases.
21  */
22 enum mdio_mutex_lock_class {
23 	MDIO_MUTEX_NORMAL,
24 	MDIO_MUTEX_MUX,
25 	MDIO_MUTEX_NESTED,
26 };
27 
28 struct mdio_device {
29 	struct device dev;
30 
31 	struct mii_bus *bus;
32 	char modalias[MDIO_NAME_SIZE];
33 
34 	int (*bus_match)(struct device *dev, const struct device_driver *drv);
35 	void (*device_free)(struct mdio_device *mdiodev);
36 	void (*device_remove)(struct mdio_device *mdiodev);
37 
38 	/* Bus address of the MDIO device (0-31) */
39 	int addr;
40 	int flags;
41 	int reset_state;
42 	struct gpio_desc *reset_gpio;
43 	struct reset_control *reset_ctrl;
44 	unsigned int reset_assert_delay;
45 	unsigned int reset_deassert_delay;
46 };
47 
48 static inline struct mdio_device *to_mdio_device(const struct device *dev)
49 {
50 	return container_of(dev, struct mdio_device, dev);
51 }
52 
53 /* struct mdio_driver_common: Common to all MDIO drivers */
54 struct mdio_driver_common {
55 	struct device_driver driver;
56 	int flags;
57 };
58 #define MDIO_DEVICE_FLAG_PHY		1
59 
60 #define to_mdio_common_driver(__drv_c)	container_of_const(__drv_c, struct mdio_driver_common,	\
61 							   driver)
62 
63 /* struct mdio_driver: Generic MDIO driver */
64 struct mdio_driver {
65 	struct mdio_driver_common mdiodrv;
66 
67 	/*
68 	 * Called during discovery.  Used to set
69 	 * up device-specific structures, if any
70 	 */
71 	int (*probe)(struct mdio_device *mdiodev);
72 
73 	/* Clears up any memory if needed */
74 	void (*remove)(struct mdio_device *mdiodev);
75 
76 	/* Quiesces the device on system shutdown, turns off interrupts etc */
77 	void (*shutdown)(struct mdio_device *mdiodev);
78 };
79 
80 #define to_mdio_driver(__drv_m)	container_of_const(to_mdio_common_driver(__drv_m),	\
81 						   struct mdio_driver, mdiodrv)
82 
83 /* device driver data */
84 static inline void mdiodev_set_drvdata(struct mdio_device *mdio, void *data)
85 {
86 	dev_set_drvdata(&mdio->dev, data);
87 }
88 
89 static inline void *mdiodev_get_drvdata(struct mdio_device *mdio)
90 {
91 	return dev_get_drvdata(&mdio->dev);
92 }
93 
94 void mdio_device_free(struct mdio_device *mdiodev);
95 struct mdio_device *mdio_device_create(struct mii_bus *bus, int addr);
96 int mdio_device_register(struct mdio_device *mdiodev);
97 void mdio_device_remove(struct mdio_device *mdiodev);
98 void mdio_device_reset(struct mdio_device *mdiodev, int value);
99 int mdio_driver_register(struct mdio_driver *drv);
100 void mdio_driver_unregister(struct mdio_driver *drv);
101 int mdio_device_bus_match(struct device *dev, const struct device_driver *drv);
102 
103 static inline void mdio_device_get(struct mdio_device *mdiodev)
104 {
105 	get_device(&mdiodev->dev);
106 }
107 
108 static inline void mdio_device_put(struct mdio_device *mdiodev)
109 {
110 	mdio_device_free(mdiodev);
111 }
112 
113 static inline bool mdio_phy_id_is_c45(int phy_id)
114 {
115 	return (phy_id & MDIO_PHY_ID_C45) && !(phy_id & ~MDIO_PHY_ID_C45_MASK);
116 }
117 
118 static inline __u16 mdio_phy_id_prtad(int phy_id)
119 {
120 	return (phy_id & MDIO_PHY_ID_PRTAD) >> 5;
121 }
122 
123 static inline __u16 mdio_phy_id_devad(int phy_id)
124 {
125 	return phy_id & MDIO_PHY_ID_DEVAD;
126 }
127 
128 /**
129  * struct mdio_if_info - Ethernet controller MDIO interface
130  * @prtad: PRTAD of the PHY (%MDIO_PRTAD_NONE if not present/unknown)
131  * @mmds: Mask of MMDs expected to be present in the PHY.  This must be
132  *	non-zero unless @prtad = %MDIO_PRTAD_NONE.
133  * @mode_support: MDIO modes supported.  If %MDIO_SUPPORTS_C22 is set then
134  *	MII register access will be passed through with @devad =
135  *	%MDIO_DEVAD_NONE.  If %MDIO_EMULATE_C22 is set then access to
136  *	commonly used clause 22 registers will be translated into
137  *	clause 45 registers.
138  * @dev: Net device structure
139  * @mdio_read: Register read function; returns value or negative error code
140  * @mdio_write: Register write function; returns 0 or negative error code
141  */
142 struct mdio_if_info {
143 	int prtad;
144 	u32 mmds;
145 	unsigned mode_support;
146 
147 	struct net_device *dev;
148 	int (*mdio_read)(struct net_device *dev, int prtad, int devad,
149 			 u16 addr);
150 	int (*mdio_write)(struct net_device *dev, int prtad, int devad,
151 			  u16 addr, u16 val);
152 };
153 
154 #define MDIO_PRTAD_NONE			(-1)
155 #define MDIO_DEVAD_NONE			(-1)
156 #define MDIO_SUPPORTS_C22		1
157 #define MDIO_SUPPORTS_C45		2
158 #define MDIO_EMULATE_C22		4
159 
160 struct ethtool_cmd;
161 struct ethtool_pauseparam;
162 extern int mdio45_probe(struct mdio_if_info *mdio, int prtad);
163 extern int mdio_set_flag(const struct mdio_if_info *mdio,
164 			 int prtad, int devad, u16 addr, int mask,
165 			 bool sense);
166 extern int mdio45_links_ok(const struct mdio_if_info *mdio, u32 mmds);
167 extern int mdio45_nway_restart(const struct mdio_if_info *mdio);
168 extern void mdio45_ethtool_gset_npage(const struct mdio_if_info *mdio,
169 				      struct ethtool_cmd *ecmd,
170 				      u32 npage_adv, u32 npage_lpa);
171 extern void
172 mdio45_ethtool_ksettings_get_npage(const struct mdio_if_info *mdio,
173 				   struct ethtool_link_ksettings *cmd,
174 				   u32 npage_adv, u32 npage_lpa);
175 
176 /**
177  * mdio45_ethtool_ksettings_get - get settings for ETHTOOL_GLINKSETTINGS
178  * @mdio: MDIO interface
179  * @cmd: Ethtool request structure
180  *
181  * Since the CSRs for auto-negotiation using next pages are not fully
182  * standardised, this function does not attempt to decode them.  Use
183  * mdio45_ethtool_ksettings_get_npage() to specify advertisement bits
184  * from next pages.
185  */
186 static inline void
187 mdio45_ethtool_ksettings_get(const struct mdio_if_info *mdio,
188 			     struct ethtool_link_ksettings *cmd)
189 {
190 	mdio45_ethtool_ksettings_get_npage(mdio, cmd, 0, 0);
191 }
192 
193 extern int mdio_mii_ioctl(const struct mdio_if_info *mdio,
194 			  struct mii_ioctl_data *mii_data, int cmd);
195 
196 /**
197  * mmd_eee_cap_to_ethtool_sup_t
198  * @eee_cap: value of the MMD EEE Capability register
199  *
200  * A small helper function that translates MMD EEE Capability (3.20) bits
201  * to ethtool supported settings.
202  */
203 static inline u32 mmd_eee_cap_to_ethtool_sup_t(u16 eee_cap)
204 {
205 	u32 supported = 0;
206 
207 	if (eee_cap & MDIO_EEE_100TX)
208 		supported |= SUPPORTED_100baseT_Full;
209 	if (eee_cap & MDIO_EEE_1000T)
210 		supported |= SUPPORTED_1000baseT_Full;
211 	if (eee_cap & MDIO_EEE_10GT)
212 		supported |= SUPPORTED_10000baseT_Full;
213 	if (eee_cap & MDIO_EEE_1000KX)
214 		supported |= SUPPORTED_1000baseKX_Full;
215 	if (eee_cap & MDIO_EEE_10GKX4)
216 		supported |= SUPPORTED_10000baseKX4_Full;
217 	if (eee_cap & MDIO_EEE_10GKR)
218 		supported |= SUPPORTED_10000baseKR_Full;
219 
220 	return supported;
221 }
222 
223 /**
224  * mmd_eee_adv_to_ethtool_adv_t
225  * @eee_adv: value of the MMD EEE Advertisement/Link Partner Ability registers
226  *
227  * A small helper function that translates the MMD EEE Advertisment (7.60)
228  * and MMD EEE Link Partner Ability (7.61) bits to ethtool advertisement
229  * settings.
230  */
231 static inline u32 mmd_eee_adv_to_ethtool_adv_t(u16 eee_adv)
232 {
233 	u32 adv = 0;
234 
235 	if (eee_adv & MDIO_EEE_100TX)
236 		adv |= ADVERTISED_100baseT_Full;
237 	if (eee_adv & MDIO_EEE_1000T)
238 		adv |= ADVERTISED_1000baseT_Full;
239 	if (eee_adv & MDIO_EEE_10GT)
240 		adv |= ADVERTISED_10000baseT_Full;
241 	if (eee_adv & MDIO_EEE_1000KX)
242 		adv |= ADVERTISED_1000baseKX_Full;
243 	if (eee_adv & MDIO_EEE_10GKX4)
244 		adv |= ADVERTISED_10000baseKX4_Full;
245 	if (eee_adv & MDIO_EEE_10GKR)
246 		adv |= ADVERTISED_10000baseKR_Full;
247 
248 	return adv;
249 }
250 
251 /**
252  * ethtool_adv_to_mmd_eee_adv_t
253  * @adv: the ethtool advertisement settings
254  *
255  * A small helper function that translates ethtool advertisement settings
256  * to EEE advertisements for the MMD EEE Advertisement (7.60) and
257  * MMD EEE Link Partner Ability (7.61) registers.
258  */
259 static inline u16 ethtool_adv_to_mmd_eee_adv_t(u32 adv)
260 {
261 	u16 reg = 0;
262 
263 	if (adv & ADVERTISED_100baseT_Full)
264 		reg |= MDIO_EEE_100TX;
265 	if (adv & ADVERTISED_1000baseT_Full)
266 		reg |= MDIO_EEE_1000T;
267 	if (adv & ADVERTISED_10000baseT_Full)
268 		reg |= MDIO_EEE_10GT;
269 	if (adv & ADVERTISED_1000baseKX_Full)
270 		reg |= MDIO_EEE_1000KX;
271 	if (adv & ADVERTISED_10000baseKX4_Full)
272 		reg |= MDIO_EEE_10GKX4;
273 	if (adv & ADVERTISED_10000baseKR_Full)
274 		reg |= MDIO_EEE_10GKR;
275 
276 	return reg;
277 }
278 
279 /**
280  * linkmode_adv_to_mii_10gbt_adv_t
281  * @advertising: the linkmode advertisement settings
282  *
283  * A small helper function that translates linkmode advertisement
284  * settings to phy autonegotiation advertisements for the C45
285  * 10GBASE-T AN CONTROL (7.32) register.
286  */
287 static inline u32 linkmode_adv_to_mii_10gbt_adv_t(unsigned long *advertising)
288 {
289 	u32 result = 0;
290 
291 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
292 			      advertising))
293 		result |= MDIO_AN_10GBT_CTRL_ADV2_5G;
294 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
295 			      advertising))
296 		result |= MDIO_AN_10GBT_CTRL_ADV5G;
297 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
298 			      advertising))
299 		result |= MDIO_AN_10GBT_CTRL_ADV10G;
300 
301 	return result;
302 }
303 
304 /**
305  * mii_10gbt_stat_mod_linkmode_lpa_t
306  * @advertising: target the linkmode advertisement settings
307  * @lpa: value of the C45 10GBASE-T AN STATUS register
308  *
309  * A small helper function that translates C45 10GBASE-T AN STATUS register bits
310  * to linkmode advertisement settings. Other bits in advertising aren't changed.
311  */
312 static inline void mii_10gbt_stat_mod_linkmode_lpa_t(unsigned long *advertising,
313 						     u32 lpa)
314 {
315 	linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
316 			 advertising, lpa & MDIO_AN_10GBT_STAT_LP2_5G);
317 	linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
318 			 advertising, lpa & MDIO_AN_10GBT_STAT_LP5G);
319 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
320 			 advertising, lpa & MDIO_AN_10GBT_STAT_LP10G);
321 }
322 
323 /**
324  * mii_t1_adv_l_mod_linkmode_t
325  * @advertising: target the linkmode advertisement settings
326  * @lpa: value of the BASE-T1 Autonegotiation Advertisement [15:0] Register
327  *
328  * A small helper function that translates BASE-T1 Autonegotiation
329  * Advertisement [15:0] Register bits to linkmode advertisement settings.
330  * Other bits in advertising aren't changed.
331  */
332 static inline void mii_t1_adv_l_mod_linkmode_t(unsigned long *advertising, u32 lpa)
333 {
334 	linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising,
335 			 lpa & MDIO_AN_T1_ADV_L_PAUSE_CAP);
336 	linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising,
337 			 lpa & MDIO_AN_T1_ADV_L_PAUSE_ASYM);
338 }
339 
340 /**
341  * mii_t1_adv_m_mod_linkmode_t
342  * @advertising: target the linkmode advertisement settings
343  * @lpa: value of the BASE-T1 Autonegotiation Advertisement [31:16] Register
344  *
345  * A small helper function that translates BASE-T1 Autonegotiation
346  * Advertisement [31:16] Register bits to linkmode advertisement settings.
347  * Other bits in advertising aren't changed.
348  */
349 static inline void mii_t1_adv_m_mod_linkmode_t(unsigned long *advertising, u32 lpa)
350 {
351 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT,
352 			 advertising, lpa & MDIO_AN_T1_ADV_M_B10L);
353 	linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
354 			 advertising, lpa & MDIO_AN_T1_ADV_M_100BT1);
355 	linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT1_Full_BIT,
356 			 advertising, lpa & MDIO_AN_T1_ADV_M_1000BT1);
357 }
358 
359 /**
360  * linkmode_adv_to_mii_t1_adv_l_t
361  * @advertising: the linkmode advertisement settings
362  *
363  * A small helper function that translates linkmode advertisement
364  * settings to phy autonegotiation advertisements for the
365  * BASE-T1 Autonegotiation Advertisement [15:0] Register.
366  */
367 static inline u32 linkmode_adv_to_mii_t1_adv_l_t(unsigned long *advertising)
368 {
369 	u32 result = 0;
370 
371 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising))
372 		result |= MDIO_AN_T1_ADV_L_PAUSE_CAP;
373 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising))
374 		result |= MDIO_AN_T1_ADV_L_PAUSE_ASYM;
375 
376 	return result;
377 }
378 
379 /**
380  * linkmode_adv_to_mii_t1_adv_m_t
381  * @advertising: the linkmode advertisement settings
382  *
383  * A small helper function that translates linkmode advertisement
384  * settings to phy autonegotiation advertisements for the
385  * BASE-T1 Autonegotiation Advertisement [31:16] Register.
386  */
387 static inline u32 linkmode_adv_to_mii_t1_adv_m_t(unsigned long *advertising)
388 {
389 	u32 result = 0;
390 
391 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT, advertising))
392 		result |= MDIO_AN_T1_ADV_M_B10L;
393 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT1_Full_BIT, advertising))
394 		result |= MDIO_AN_T1_ADV_M_100BT1;
395 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT1_Full_BIT, advertising))
396 		result |= MDIO_AN_T1_ADV_M_1000BT1;
397 
398 	return result;
399 }
400 
401 /**
402  * mii_eee_cap1_mod_linkmode_t()
403  * @adv: target the linkmode advertisement settings
404  * @val: register value
405  *
406  * A function that translates value of following registers to the linkmode:
407  * IEEE 802.3-2018 45.2.3.10 "EEE control and capability 1" register (3.20)
408  * IEEE 802.3-2018 45.2.7.13 "EEE advertisement 1" register (7.60)
409  * IEEE 802.3-2018 45.2.7.14 "EEE link partner ability 1" register (7.61)
410  */
411 static inline void mii_eee_cap1_mod_linkmode_t(unsigned long *adv, u32 val)
412 {
413 	linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
414 			 adv, val & MDIO_EEE_100TX);
415 	linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
416 			 adv, val & MDIO_EEE_1000T);
417 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
418 			 adv, val & MDIO_EEE_10GT);
419 	linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
420 			 adv, val & MDIO_EEE_1000KX);
421 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
422 			 adv, val & MDIO_EEE_10GKX4);
423 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
424 			 adv, val & MDIO_EEE_10GKR);
425 }
426 
427 /**
428  * mii_eee_cap2_mod_linkmode_sup_t()
429  * @adv: target the linkmode settings
430  * @val: register value
431  *
432  * A function that translates value of following registers to the linkmode:
433  * IEEE 802.3-2022 45.2.3.11 "EEE control and capability 2" register (3.21)
434  */
435 static inline void mii_eee_cap2_mod_linkmode_sup_t(unsigned long *adv, u32 val)
436 {
437 	linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
438 			 adv, val & MDIO_EEE_2_5GT);
439 	linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
440 			 adv, val & MDIO_EEE_5GT);
441 }
442 
443 /**
444  * mii_eee_cap2_mod_linkmode_adv_t()
445  * @adv: target the linkmode advertisement settings
446  * @val: register value
447  *
448  * A function that translates value of following registers to the linkmode:
449  * IEEE 802.3-2022 45.2.7.16 "EEE advertisement 2" register (7.62)
450  * IEEE 802.3-2022 45.2.7.17 "EEE link partner ability 2" register (7.63)
451  * Note: Currently this function is the same as mii_eee_cap2_mod_linkmode_sup_t.
452  *       For certain, not yet supported, modes however the bits differ.
453  *       Therefore create separate functions already.
454  */
455 static inline void mii_eee_cap2_mod_linkmode_adv_t(unsigned long *adv, u32 val)
456 {
457 	linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
458 			 adv, val & MDIO_EEE_2_5GT);
459 	linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
460 			 adv, val & MDIO_EEE_5GT);
461 }
462 
463 /**
464  * linkmode_to_mii_eee_cap1_t()
465  * @adv: the linkmode advertisement settings
466  *
467  * A function that translates linkmode to value for IEEE 802.3-2018 45.2.7.13
468  * "EEE advertisement 1" register (7.60)
469  */
470 static inline u32 linkmode_to_mii_eee_cap1_t(unsigned long *adv)
471 {
472 	u32 result = 0;
473 
474 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, adv))
475 		result |= MDIO_EEE_100TX;
476 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, adv))
477 		result |= MDIO_EEE_1000T;
478 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT, adv))
479 		result |= MDIO_EEE_10GT;
480 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT, adv))
481 		result |= MDIO_EEE_1000KX;
482 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT, adv))
483 		result |= MDIO_EEE_10GKX4;
484 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT, adv))
485 		result |= MDIO_EEE_10GKR;
486 
487 	return result;
488 }
489 
490 /**
491  * linkmode_to_mii_eee_cap2_t()
492  * @adv: the linkmode advertisement settings
493  *
494  * A function that translates linkmode to value for IEEE 802.3-2022 45.2.7.16
495  * "EEE advertisement 2" register (7.62)
496  */
497 static inline u32 linkmode_to_mii_eee_cap2_t(unsigned long *adv)
498 {
499 	u32 result = 0;
500 
501 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT, adv))
502 		result |= MDIO_EEE_2_5GT;
503 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT, adv))
504 		result |= MDIO_EEE_5GT;
505 
506 	return result;
507 }
508 
509 /**
510  * mii_10base_t1_adv_mod_linkmode_t()
511  * @adv: linkmode advertisement settings
512  * @val: register value
513  *
514  * A function that translates IEEE 802.3cg-2019 45.2.7.26 "10BASE-T1 AN status"
515  * register (7.527) value to the linkmode.
516  */
517 static inline void mii_10base_t1_adv_mod_linkmode_t(unsigned long *adv, u16 val)
518 {
519 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT,
520 			 adv, val & MDIO_AN_10BT1_AN_CTRL_ADV_EEE_T1L);
521 }
522 
523 /**
524  * linkmode_adv_to_mii_10base_t1_t()
525  * @adv: linkmode advertisement settings
526  *
527  * A function that translates the linkmode to IEEE 802.3cg-2019 45.2.7.25
528  * "10BASE-T1 AN control" register (7.526) value.
529  */
530 static inline u32 linkmode_adv_to_mii_10base_t1_t(unsigned long *adv)
531 {
532 	u32 result = 0;
533 
534 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT, adv))
535 		result |= MDIO_AN_10BT1_AN_CTRL_ADV_EEE_T1L;
536 
537 	return result;
538 }
539 
540 /**
541  * mii_c73_mod_linkmode - convert a Clause 73 advertisement to linkmodes
542  * @adv: linkmode advertisement setting
543  * @lpa: array of three u16s containing the advertisement
544  *
545  * Convert an IEEE 802.3 Clause 73 advertisement to ethtool link modes.
546  */
547 static inline void mii_c73_mod_linkmode(unsigned long *adv, u16 *lpa)
548 {
549 	linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
550 			 adv, lpa[0] & MDIO_AN_C73_0_PAUSE);
551 	linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
552 			 adv, lpa[0] & MDIO_AN_C73_0_ASM_DIR);
553 	linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
554 			 adv, lpa[1] & MDIO_AN_C73_1_1000BASE_KX);
555 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
556 			 adv, lpa[1] & MDIO_AN_C73_1_10GBASE_KX4);
557 	linkmode_mod_bit(ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT,
558 			 adv, lpa[1] & MDIO_AN_C73_1_40GBASE_KR4);
559 	linkmode_mod_bit(ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT,
560 			 adv, lpa[1] & MDIO_AN_C73_1_40GBASE_CR4);
561 	/* 100GBASE_CR10 and 100GBASE_KP4 not implemented */
562 	linkmode_mod_bit(ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT,
563 			 adv, lpa[1] & MDIO_AN_C73_1_100GBASE_KR4);
564 	linkmode_mod_bit(ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT,
565 			 adv, lpa[1] & MDIO_AN_C73_1_100GBASE_CR4);
566 	/* 25GBASE_R_S not implemented */
567 	/* The 25GBASE_R bit can be used for 25Gbase KR or CR modes */
568 	linkmode_mod_bit(ETHTOOL_LINK_MODE_25000baseKR_Full_BIT,
569 			 adv, lpa[1] & MDIO_AN_C73_1_25GBASE_R);
570 	linkmode_mod_bit(ETHTOOL_LINK_MODE_25000baseCR_Full_BIT,
571 			 adv, lpa[1] & MDIO_AN_C73_1_25GBASE_R);
572 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
573 			 adv, lpa[1] & MDIO_AN_C73_1_10GBASE_KR);
574 	linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseX_Full_BIT,
575 			 adv, lpa[2] & MDIO_AN_C73_2_2500BASE_KX);
576 	/* 5GBASE_KR not implemented */
577 }
578 
579 int __mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
580 int __mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
581 int __mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask,
582 		     u16 set);
583 int __mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
584 			     u16 mask, u16 set);
585 
586 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
587 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum);
588 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
589 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val);
590 int mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask,
591 		   u16 set);
592 int mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
593 			   u16 mask, u16 set);
594 int __mdiobus_c45_read(struct mii_bus *bus, int addr, int devad, u32 regnum);
595 int mdiobus_c45_read(struct mii_bus *bus, int addr, int devad, u32 regnum);
596 int mdiobus_c45_read_nested(struct mii_bus *bus, int addr, int devad,
597 			     u32 regnum);
598 int __mdiobus_c45_write(struct mii_bus *bus, int addr,  int devad, u32 regnum,
599 			u16 val);
600 int mdiobus_c45_write(struct mii_bus *bus, int addr,  int devad, u32 regnum,
601 		      u16 val);
602 int mdiobus_c45_write_nested(struct mii_bus *bus, int addr,  int devad,
603 			     u32 regnum, u16 val);
604 int mdiobus_c45_modify(struct mii_bus *bus, int addr, int devad, u32 regnum,
605 		       u16 mask, u16 set);
606 
607 int mdiobus_c45_modify_changed(struct mii_bus *bus, int addr, int devad,
608 			       u32 regnum, u16 mask, u16 set);
609 
610 static inline int __mdiodev_read(struct mdio_device *mdiodev, u32 regnum)
611 {
612 	return __mdiobus_read(mdiodev->bus, mdiodev->addr, regnum);
613 }
614 
615 static inline int __mdiodev_write(struct mdio_device *mdiodev, u32 regnum,
616 				  u16 val)
617 {
618 	return __mdiobus_write(mdiodev->bus, mdiodev->addr, regnum, val);
619 }
620 
621 static inline int __mdiodev_modify(struct mdio_device *mdiodev, u32 regnum,
622 				   u16 mask, u16 set)
623 {
624 	return __mdiobus_modify(mdiodev->bus, mdiodev->addr, regnum, mask, set);
625 }
626 
627 static inline int __mdiodev_modify_changed(struct mdio_device *mdiodev,
628 					   u32 regnum, u16 mask, u16 set)
629 {
630 	return __mdiobus_modify_changed(mdiodev->bus, mdiodev->addr, regnum,
631 					mask, set);
632 }
633 
634 static inline int mdiodev_read(struct mdio_device *mdiodev, u32 regnum)
635 {
636 	return mdiobus_read(mdiodev->bus, mdiodev->addr, regnum);
637 }
638 
639 static inline int mdiodev_write(struct mdio_device *mdiodev, u32 regnum,
640 				u16 val)
641 {
642 	return mdiobus_write(mdiodev->bus, mdiodev->addr, regnum, val);
643 }
644 
645 static inline int mdiodev_modify(struct mdio_device *mdiodev, u32 regnum,
646 				 u16 mask, u16 set)
647 {
648 	return mdiobus_modify(mdiodev->bus, mdiodev->addr, regnum, mask, set);
649 }
650 
651 static inline int mdiodev_modify_changed(struct mdio_device *mdiodev,
652 					 u32 regnum, u16 mask, u16 set)
653 {
654 	return mdiobus_modify_changed(mdiodev->bus, mdiodev->addr, regnum,
655 				      mask, set);
656 }
657 
658 static inline int mdiodev_c45_modify(struct mdio_device *mdiodev, int devad,
659 				     u32 regnum, u16 mask, u16 set)
660 {
661 	return mdiobus_c45_modify(mdiodev->bus, mdiodev->addr, devad, regnum,
662 				  mask, set);
663 }
664 
665 static inline int mdiodev_c45_modify_changed(struct mdio_device *mdiodev,
666 					     int devad, u32 regnum, u16 mask,
667 					     u16 set)
668 {
669 	return mdiobus_c45_modify_changed(mdiodev->bus, mdiodev->addr, devad,
670 					  regnum, mask, set);
671 }
672 
673 static inline int mdiodev_c45_read(struct mdio_device *mdiodev, int devad,
674 				   u16 regnum)
675 {
676 	return mdiobus_c45_read(mdiodev->bus, mdiodev->addr, devad, regnum);
677 }
678 
679 static inline int mdiodev_c45_write(struct mdio_device *mdiodev, u32 devad,
680 				    u16 regnum, u16 val)
681 {
682 	return mdiobus_c45_write(mdiodev->bus, mdiodev->addr, devad, regnum,
683 				 val);
684 }
685 
686 int mdiobus_register_device(struct mdio_device *mdiodev);
687 int mdiobus_unregister_device(struct mdio_device *mdiodev);
688 bool mdiobus_is_registered_device(struct mii_bus *bus, int addr);
689 struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr);
690 
691 /**
692  * mdio_module_driver() - Helper macro for registering mdio drivers
693  * @_mdio_driver: driver to register
694  *
695  * Helper macro for MDIO drivers which do not do anything special in module
696  * init/exit. Each module may only use this macro once, and calling it
697  * replaces module_init() and module_exit().
698  */
699 #define mdio_module_driver(_mdio_driver)				\
700 static int __init mdio_module_init(void)				\
701 {									\
702 	return mdio_driver_register(&_mdio_driver);			\
703 }									\
704 module_init(mdio_module_init);						\
705 static void __exit mdio_module_exit(void)				\
706 {									\
707 	mdio_driver_unregister(&_mdio_driver);				\
708 }									\
709 module_exit(mdio_module_exit)
710 
711 #endif /* __LINUX_MDIO_H__ */
712