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