1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * linux/mdio.h: definitions for MDIO (clause 45) transceivers
4 * Copyright 2006-2009 Solarflare Communications Inc.
6 #ifndef __LINUX_MDIO_H__
7 #define __LINUX_MDIO_H__
9 #include <uapi/linux/mdio.h>
10 #include <linux/mod_devicetable.h>
12 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
13 * IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips.
15 #define MII_ADDR_C45 (1<<30)
16 #define MII_DEVADDR_C45_SHIFT 16
17 #define MII_REGADDR_C45_MASK GENMASK(15, 0)
23 /* Multiple levels of nesting are possible. However typically this is
24 * limited to nested DSA like layer, a MUX layer, and the normal
25 * user. Instead of trying to handle the general case, just define
28 enum mdio_mutex_lock_class
{
38 char modalias
[MDIO_NAME_SIZE
];
40 int (*bus_match
)(struct device
*dev
, struct device_driver
*drv
);
41 void (*device_free
)(struct mdio_device
*mdiodev
);
42 void (*device_remove
)(struct mdio_device
*mdiodev
);
44 /* Bus address of the MDIO device (0-31) */
47 struct gpio_desc
*reset_gpio
;
48 struct reset_control
*reset_ctrl
;
49 unsigned int reset_assert_delay
;
50 unsigned int reset_deassert_delay
;
53 static inline struct mdio_device
*to_mdio_device(const struct device
*dev
)
55 return container_of(dev
, struct mdio_device
, dev
);
58 /* struct mdio_driver_common: Common to all MDIO drivers */
59 struct mdio_driver_common
{
60 struct device_driver driver
;
63 #define MDIO_DEVICE_FLAG_PHY 1
65 static inline struct mdio_driver_common
*
66 to_mdio_common_driver(const struct device_driver
*driver
)
68 return container_of(driver
, struct mdio_driver_common
, driver
);
71 /* struct mdio_driver: Generic MDIO driver */
73 struct mdio_driver_common mdiodrv
;
76 * Called during discovery. Used to set
77 * up device-specific structures, if any
79 int (*probe
)(struct mdio_device
*mdiodev
);
81 /* Clears up any memory if needed */
82 void (*remove
)(struct mdio_device
*mdiodev
);
84 /* Quiesces the device on system shutdown, turns off interrupts etc */
85 void (*shutdown
)(struct mdio_device
*mdiodev
);
88 static inline struct mdio_driver
*
89 to_mdio_driver(const struct device_driver
*driver
)
91 return container_of(to_mdio_common_driver(driver
), struct mdio_driver
,
95 /* device driver data */
96 static inline void mdiodev_set_drvdata(struct mdio_device
*mdio
, void *data
)
98 dev_set_drvdata(&mdio
->dev
, data
);
101 static inline void *mdiodev_get_drvdata(struct mdio_device
*mdio
)
103 return dev_get_drvdata(&mdio
->dev
);
106 void mdio_device_free(struct mdio_device
*mdiodev
);
107 struct mdio_device
*mdio_device_create(struct mii_bus
*bus
, int addr
);
108 int mdio_device_register(struct mdio_device
*mdiodev
);
109 void mdio_device_remove(struct mdio_device
*mdiodev
);
110 void mdio_device_reset(struct mdio_device
*mdiodev
, int value
);
111 int mdio_driver_register(struct mdio_driver
*drv
);
112 void mdio_driver_unregister(struct mdio_driver
*drv
);
113 int mdio_device_bus_match(struct device
*dev
, struct device_driver
*drv
);
115 static inline bool mdio_phy_id_is_c45(int phy_id
)
117 return (phy_id
& MDIO_PHY_ID_C45
) && !(phy_id
& ~MDIO_PHY_ID_C45_MASK
);
120 static inline __u16
mdio_phy_id_prtad(int phy_id
)
122 return (phy_id
& MDIO_PHY_ID_PRTAD
) >> 5;
125 static inline __u16
mdio_phy_id_devad(int phy_id
)
127 return phy_id
& MDIO_PHY_ID_DEVAD
;
131 * struct mdio_if_info - Ethernet controller MDIO interface
132 * @prtad: PRTAD of the PHY (%MDIO_PRTAD_NONE if not present/unknown)
133 * @mmds: Mask of MMDs expected to be present in the PHY. This must be
134 * non-zero unless @prtad = %MDIO_PRTAD_NONE.
135 * @mode_support: MDIO modes supported. If %MDIO_SUPPORTS_C22 is set then
136 * MII register access will be passed through with @devad =
137 * %MDIO_DEVAD_NONE. If %MDIO_EMULATE_C22 is set then access to
138 * commonly used clause 22 registers will be translated into
139 * clause 45 registers.
140 * @dev: Net device structure
141 * @mdio_read: Register read function; returns value or negative error code
142 * @mdio_write: Register write function; returns 0 or negative error code
144 struct mdio_if_info
{
147 unsigned mode_support
;
149 struct net_device
*dev
;
150 int (*mdio_read
)(struct net_device
*dev
, int prtad
, int devad
,
152 int (*mdio_write
)(struct net_device
*dev
, int prtad
, int devad
,
156 #define MDIO_PRTAD_NONE (-1)
157 #define MDIO_DEVAD_NONE (-1)
158 #define MDIO_SUPPORTS_C22 1
159 #define MDIO_SUPPORTS_C45 2
160 #define MDIO_EMULATE_C22 4
163 struct ethtool_pauseparam
;
164 extern int mdio45_probe(struct mdio_if_info
*mdio
, int prtad
);
165 extern int mdio_set_flag(const struct mdio_if_info
*mdio
,
166 int prtad
, int devad
, u16 addr
, int mask
,
168 extern int mdio45_links_ok(const struct mdio_if_info
*mdio
, u32 mmds
);
169 extern int mdio45_nway_restart(const struct mdio_if_info
*mdio
);
170 extern void mdio45_ethtool_gset_npage(const struct mdio_if_info
*mdio
,
171 struct ethtool_cmd
*ecmd
,
172 u32 npage_adv
, u32 npage_lpa
);
174 mdio45_ethtool_ksettings_get_npage(const struct mdio_if_info
*mdio
,
175 struct ethtool_link_ksettings
*cmd
,
176 u32 npage_adv
, u32 npage_lpa
);
179 * mdio45_ethtool_gset - get settings for ETHTOOL_GSET
180 * @mdio: MDIO interface
181 * @ecmd: Ethtool request structure
183 * Since the CSRs for auto-negotiation using next pages are not fully
184 * standardised, this function does not attempt to decode them. Use
185 * mdio45_ethtool_gset_npage() to specify advertisement bits from next
188 static inline void mdio45_ethtool_gset(const struct mdio_if_info
*mdio
,
189 struct ethtool_cmd
*ecmd
)
191 mdio45_ethtool_gset_npage(mdio
, ecmd
, 0, 0);
195 * mdio45_ethtool_ksettings_get - get settings for ETHTOOL_GLINKSETTINGS
196 * @mdio: MDIO interface
197 * @cmd: Ethtool request structure
199 * Since the CSRs for auto-negotiation using next pages are not fully
200 * standardised, this function does not attempt to decode them. Use
201 * mdio45_ethtool_ksettings_get_npage() to specify advertisement bits
205 mdio45_ethtool_ksettings_get(const struct mdio_if_info
*mdio
,
206 struct ethtool_link_ksettings
*cmd
)
208 mdio45_ethtool_ksettings_get_npage(mdio
, cmd
, 0, 0);
211 extern int mdio_mii_ioctl(const struct mdio_if_info
*mdio
,
212 struct mii_ioctl_data
*mii_data
, int cmd
);
215 * mmd_eee_cap_to_ethtool_sup_t
216 * @eee_cap: value of the MMD EEE Capability register
218 * A small helper function that translates MMD EEE Capability (3.20) bits
219 * to ethtool supported settings.
221 static inline u32
mmd_eee_cap_to_ethtool_sup_t(u16 eee_cap
)
225 if (eee_cap
& MDIO_EEE_100TX
)
226 supported
|= SUPPORTED_100baseT_Full
;
227 if (eee_cap
& MDIO_EEE_1000T
)
228 supported
|= SUPPORTED_1000baseT_Full
;
229 if (eee_cap
& MDIO_EEE_10GT
)
230 supported
|= SUPPORTED_10000baseT_Full
;
231 if (eee_cap
& MDIO_EEE_1000KX
)
232 supported
|= SUPPORTED_1000baseKX_Full
;
233 if (eee_cap
& MDIO_EEE_10GKX4
)
234 supported
|= SUPPORTED_10000baseKX4_Full
;
235 if (eee_cap
& MDIO_EEE_10GKR
)
236 supported
|= SUPPORTED_10000baseKR_Full
;
242 * mmd_eee_adv_to_ethtool_adv_t
243 * @eee_adv: value of the MMD EEE Advertisement/Link Partner Ability registers
245 * A small helper function that translates the MMD EEE Advertisment (7.60)
246 * and MMD EEE Link Partner Ability (7.61) bits to ethtool advertisement
249 static inline u32
mmd_eee_adv_to_ethtool_adv_t(u16 eee_adv
)
253 if (eee_adv
& MDIO_EEE_100TX
)
254 adv
|= ADVERTISED_100baseT_Full
;
255 if (eee_adv
& MDIO_EEE_1000T
)
256 adv
|= ADVERTISED_1000baseT_Full
;
257 if (eee_adv
& MDIO_EEE_10GT
)
258 adv
|= ADVERTISED_10000baseT_Full
;
259 if (eee_adv
& MDIO_EEE_1000KX
)
260 adv
|= ADVERTISED_1000baseKX_Full
;
261 if (eee_adv
& MDIO_EEE_10GKX4
)
262 adv
|= ADVERTISED_10000baseKX4_Full
;
263 if (eee_adv
& MDIO_EEE_10GKR
)
264 adv
|= ADVERTISED_10000baseKR_Full
;
270 * ethtool_adv_to_mmd_eee_adv_t
271 * @adv: the ethtool advertisement settings
273 * A small helper function that translates ethtool advertisement settings
274 * to EEE advertisements for the MMD EEE Advertisement (7.60) and
275 * MMD EEE Link Partner Ability (7.61) registers.
277 static inline u16
ethtool_adv_to_mmd_eee_adv_t(u32 adv
)
281 if (adv
& ADVERTISED_100baseT_Full
)
282 reg
|= MDIO_EEE_100TX
;
283 if (adv
& ADVERTISED_1000baseT_Full
)
284 reg
|= MDIO_EEE_1000T
;
285 if (adv
& ADVERTISED_10000baseT_Full
)
286 reg
|= MDIO_EEE_10GT
;
287 if (adv
& ADVERTISED_1000baseKX_Full
)
288 reg
|= MDIO_EEE_1000KX
;
289 if (adv
& ADVERTISED_10000baseKX4_Full
)
290 reg
|= MDIO_EEE_10GKX4
;
291 if (adv
& ADVERTISED_10000baseKR_Full
)
292 reg
|= MDIO_EEE_10GKR
;
298 * linkmode_adv_to_mii_10gbt_adv_t
299 * @advertising: the linkmode advertisement settings
301 * A small helper function that translates linkmode advertisement
302 * settings to phy autonegotiation advertisements for the C45
303 * 10GBASE-T AN CONTROL (7.32) register.
305 static inline u32
linkmode_adv_to_mii_10gbt_adv_t(unsigned long *advertising
)
309 if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT
,
311 result
|= MDIO_AN_10GBT_CTRL_ADV2_5G
;
312 if (linkmode_test_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT
,
314 result
|= MDIO_AN_10GBT_CTRL_ADV5G
;
315 if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT
,
317 result
|= MDIO_AN_10GBT_CTRL_ADV10G
;
323 * mii_10gbt_stat_mod_linkmode_lpa_t
324 * @advertising: target the linkmode advertisement settings
325 * @lpa: value of the C45 10GBASE-T AN STATUS register
327 * A small helper function that translates C45 10GBASE-T AN STATUS register bits
328 * to linkmode advertisement settings. Other bits in advertising aren't changed.
330 static inline void mii_10gbt_stat_mod_linkmode_lpa_t(unsigned long *advertising
,
333 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT
,
334 advertising
, lpa
& MDIO_AN_10GBT_STAT_LP2_5G
);
335 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT
,
336 advertising
, lpa
& MDIO_AN_10GBT_STAT_LP5G
);
337 linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT
,
338 advertising
, lpa
& MDIO_AN_10GBT_STAT_LP10G
);
341 int __mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
);
342 int __mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
343 int __mdiobus_modify_changed(struct mii_bus
*bus
, int addr
, u32 regnum
,
346 int mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
);
347 int mdiobus_read_nested(struct mii_bus
*bus
, int addr
, u32 regnum
);
348 int mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
349 int mdiobus_write_nested(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
350 int mdiobus_modify(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 mask
,
353 static inline u32
mdiobus_c45_addr(int devad
, u16 regnum
)
355 return MII_ADDR_C45
| devad
<< MII_DEVADDR_C45_SHIFT
| regnum
;
358 static inline int __mdiobus_c45_read(struct mii_bus
*bus
, int prtad
, int devad
,
361 return __mdiobus_read(bus
, prtad
, mdiobus_c45_addr(devad
, regnum
));
364 static inline int __mdiobus_c45_write(struct mii_bus
*bus
, int prtad
, int devad
,
367 return __mdiobus_write(bus
, prtad
, mdiobus_c45_addr(devad
, regnum
),
371 static inline int mdiobus_c45_read(struct mii_bus
*bus
, int prtad
, int devad
,
374 return mdiobus_read(bus
, prtad
, mdiobus_c45_addr(devad
, regnum
));
377 static inline int mdiobus_c45_write(struct mii_bus
*bus
, int prtad
, int devad
,
380 return mdiobus_write(bus
, prtad
, mdiobus_c45_addr(devad
, regnum
), val
);
383 int mdiobus_register_device(struct mdio_device
*mdiodev
);
384 int mdiobus_unregister_device(struct mdio_device
*mdiodev
);
385 bool mdiobus_is_registered_device(struct mii_bus
*bus
, int addr
);
386 struct phy_device
*mdiobus_get_phy(struct mii_bus
*bus
, int addr
);
389 * mdio_module_driver() - Helper macro for registering mdio drivers
390 * @_mdio_driver: driver to register
392 * Helper macro for MDIO drivers which do not do anything special in module
393 * init/exit. Each module may only use this macro once, and calling it
394 * replaces module_init() and module_exit().
396 #define mdio_module_driver(_mdio_driver) \
397 static int __init mdio_module_init(void) \
399 return mdio_driver_register(&_mdio_driver); \
401 module_init(mdio_module_init); \
402 static void __exit mdio_module_exit(void) \
404 mdio_driver_unregister(&_mdio_driver); \
406 module_exit(mdio_module_exit)
408 #endif /* __LINUX_MDIO_H__ */