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