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