2 * linux/mdio.h: definitions for MDIO (clause 45) transceivers
3 * Copyright 2006-2009 Solarflare Communications Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published
7 * by the Free Software Foundation, incorporated herein by reference.
9 #ifndef __LINUX_MDIO_H__
10 #define __LINUX_MDIO_H__
12 #include <uapi/linux/mdio.h>
13 #include <linux/mod_devicetable.h>
18 /* Multiple levels of nesting are possible. However typically this is
19 * limited to nested DSA like layer, a MUX layer, and the normal
20 * user. Instead of trying to handle the general case, just define
23 enum mdio_mutex_lock_class
{
33 char modalias
[MDIO_NAME_SIZE
];
35 int (*bus_match
)(struct device
*dev
, struct device_driver
*drv
);
36 void (*device_free
)(struct mdio_device
*mdiodev
);
37 void (*device_remove
)(struct mdio_device
*mdiodev
);
39 /* Bus address of the MDIO device (0-31) */
42 struct gpio_desc
*reset
;
43 unsigned int reset_assert_delay
;
44 unsigned int reset_deassert_delay
;
46 #define to_mdio_device(d) container_of(d, struct mdio_device, dev)
48 /* struct mdio_driver_common: Common to all MDIO drivers */
49 struct mdio_driver_common
{
50 struct device_driver driver
;
53 #define MDIO_DEVICE_FLAG_PHY 1
54 #define to_mdio_common_driver(d) \
55 container_of(d, struct mdio_driver_common, driver)
57 /* struct mdio_driver: Generic MDIO driver */
59 struct mdio_driver_common mdiodrv
;
62 * Called during discovery. Used to set
63 * up device-specific structures, if any
65 int (*probe
)(struct mdio_device
*mdiodev
);
67 /* Clears up any memory if needed */
68 void (*remove
)(struct mdio_device
*mdiodev
);
70 #define to_mdio_driver(d) \
71 container_of(to_mdio_common_driver(d), struct mdio_driver, mdiodrv)
73 void mdio_device_free(struct mdio_device
*mdiodev
);
74 struct mdio_device
*mdio_device_create(struct mii_bus
*bus
, int addr
);
75 int mdio_device_register(struct mdio_device
*mdiodev
);
76 void mdio_device_remove(struct mdio_device
*mdiodev
);
77 void mdio_device_reset(struct mdio_device
*mdiodev
, int value
);
78 int mdio_driver_register(struct mdio_driver
*drv
);
79 void mdio_driver_unregister(struct mdio_driver
*drv
);
80 int mdio_device_bus_match(struct device
*dev
, struct device_driver
*drv
);
82 static inline bool mdio_phy_id_is_c45(int phy_id
)
84 return (phy_id
& MDIO_PHY_ID_C45
) && !(phy_id
& ~MDIO_PHY_ID_C45_MASK
);
87 static inline __u16
mdio_phy_id_prtad(int phy_id
)
89 return (phy_id
& MDIO_PHY_ID_PRTAD
) >> 5;
92 static inline __u16
mdio_phy_id_devad(int phy_id
)
94 return phy_id
& MDIO_PHY_ID_DEVAD
;
98 * struct mdio_if_info - Ethernet controller MDIO interface
99 * @prtad: PRTAD of the PHY (%MDIO_PRTAD_NONE if not present/unknown)
100 * @mmds: Mask of MMDs expected to be present in the PHY. This must be
101 * non-zero unless @prtad = %MDIO_PRTAD_NONE.
102 * @mode_support: MDIO modes supported. If %MDIO_SUPPORTS_C22 is set then
103 * MII register access will be passed through with @devad =
104 * %MDIO_DEVAD_NONE. If %MDIO_EMULATE_C22 is set then access to
105 * commonly used clause 22 registers will be translated into
106 * clause 45 registers.
107 * @dev: Net device structure
108 * @mdio_read: Register read function; returns value or negative error code
109 * @mdio_write: Register write function; returns 0 or negative error code
111 struct mdio_if_info
{
114 unsigned mode_support
;
116 struct net_device
*dev
;
117 int (*mdio_read
)(struct net_device
*dev
, int prtad
, int devad
,
119 int (*mdio_write
)(struct net_device
*dev
, int prtad
, int devad
,
123 #define MDIO_PRTAD_NONE (-1)
124 #define MDIO_DEVAD_NONE (-1)
125 #define MDIO_SUPPORTS_C22 1
126 #define MDIO_SUPPORTS_C45 2
127 #define MDIO_EMULATE_C22 4
130 struct ethtool_pauseparam
;
131 extern int mdio45_probe(struct mdio_if_info
*mdio
, int prtad
);
132 extern int mdio_set_flag(const struct mdio_if_info
*mdio
,
133 int prtad
, int devad
, u16 addr
, int mask
,
135 extern int mdio45_links_ok(const struct mdio_if_info
*mdio
, u32 mmds
);
136 extern int mdio45_nway_restart(const struct mdio_if_info
*mdio
);
137 extern void mdio45_ethtool_gset_npage(const struct mdio_if_info
*mdio
,
138 struct ethtool_cmd
*ecmd
,
139 u32 npage_adv
, u32 npage_lpa
);
141 mdio45_ethtool_ksettings_get_npage(const struct mdio_if_info
*mdio
,
142 struct ethtool_link_ksettings
*cmd
,
143 u32 npage_adv
, u32 npage_lpa
);
146 * mdio45_ethtool_gset - get settings for ETHTOOL_GSET
147 * @mdio: MDIO interface
148 * @ecmd: Ethtool request structure
150 * Since the CSRs for auto-negotiation using next pages are not fully
151 * standardised, this function does not attempt to decode them. Use
152 * mdio45_ethtool_gset_npage() to specify advertisement bits from next
155 static inline void mdio45_ethtool_gset(const struct mdio_if_info
*mdio
,
156 struct ethtool_cmd
*ecmd
)
158 mdio45_ethtool_gset_npage(mdio
, ecmd
, 0, 0);
162 * mdio45_ethtool_ksettings_get - get settings for ETHTOOL_GLINKSETTINGS
163 * @mdio: MDIO interface
164 * @cmd: Ethtool request structure
166 * Since the CSRs for auto-negotiation using next pages are not fully
167 * standardised, this function does not attempt to decode them. Use
168 * mdio45_ethtool_ksettings_get_npage() to specify advertisement bits
172 mdio45_ethtool_ksettings_get(const struct mdio_if_info
*mdio
,
173 struct ethtool_link_ksettings
*cmd
)
175 mdio45_ethtool_ksettings_get_npage(mdio
, cmd
, 0, 0);
178 extern int mdio_mii_ioctl(const struct mdio_if_info
*mdio
,
179 struct mii_ioctl_data
*mii_data
, int cmd
);
182 * mmd_eee_cap_to_ethtool_sup_t
183 * @eee_cap: value of the MMD EEE Capability register
185 * A small helper function that translates MMD EEE Capability (3.20) bits
186 * to ethtool supported settings.
188 static inline u32
mmd_eee_cap_to_ethtool_sup_t(u16 eee_cap
)
192 if (eee_cap
& MDIO_EEE_100TX
)
193 supported
|= SUPPORTED_100baseT_Full
;
194 if (eee_cap
& MDIO_EEE_1000T
)
195 supported
|= SUPPORTED_1000baseT_Full
;
196 if (eee_cap
& MDIO_EEE_10GT
)
197 supported
|= SUPPORTED_10000baseT_Full
;
198 if (eee_cap
& MDIO_EEE_1000KX
)
199 supported
|= SUPPORTED_1000baseKX_Full
;
200 if (eee_cap
& MDIO_EEE_10GKX4
)
201 supported
|= SUPPORTED_10000baseKX4_Full
;
202 if (eee_cap
& MDIO_EEE_10GKR
)
203 supported
|= SUPPORTED_10000baseKR_Full
;
209 * mmd_eee_adv_to_ethtool_adv_t
210 * @eee_adv: value of the MMD EEE Advertisement/Link Partner Ability registers
212 * A small helper function that translates the MMD EEE Advertisment (7.60)
213 * and MMD EEE Link Partner Ability (7.61) bits to ethtool advertisement
216 static inline u32
mmd_eee_adv_to_ethtool_adv_t(u16 eee_adv
)
220 if (eee_adv
& MDIO_EEE_100TX
)
221 adv
|= ADVERTISED_100baseT_Full
;
222 if (eee_adv
& MDIO_EEE_1000T
)
223 adv
|= ADVERTISED_1000baseT_Full
;
224 if (eee_adv
& MDIO_EEE_10GT
)
225 adv
|= ADVERTISED_10000baseT_Full
;
226 if (eee_adv
& MDIO_EEE_1000KX
)
227 adv
|= ADVERTISED_1000baseKX_Full
;
228 if (eee_adv
& MDIO_EEE_10GKX4
)
229 adv
|= ADVERTISED_10000baseKX4_Full
;
230 if (eee_adv
& MDIO_EEE_10GKR
)
231 adv
|= ADVERTISED_10000baseKR_Full
;
237 * ethtool_adv_to_mmd_eee_adv_t
238 * @adv: the ethtool advertisement settings
240 * A small helper function that translates ethtool advertisement settings
241 * to EEE advertisements for the MMD EEE Advertisement (7.60) and
242 * MMD EEE Link Partner Ability (7.61) registers.
244 static inline u16
ethtool_adv_to_mmd_eee_adv_t(u32 adv
)
248 if (adv
& ADVERTISED_100baseT_Full
)
249 reg
|= MDIO_EEE_100TX
;
250 if (adv
& ADVERTISED_1000baseT_Full
)
251 reg
|= MDIO_EEE_1000T
;
252 if (adv
& ADVERTISED_10000baseT_Full
)
253 reg
|= MDIO_EEE_10GT
;
254 if (adv
& ADVERTISED_1000baseKX_Full
)
255 reg
|= MDIO_EEE_1000KX
;
256 if (adv
& ADVERTISED_10000baseKX4_Full
)
257 reg
|= MDIO_EEE_10GKX4
;
258 if (adv
& ADVERTISED_10000baseKR_Full
)
259 reg
|= MDIO_EEE_10GKR
;
264 int __mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
);
265 int __mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
267 int mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
);
268 int mdiobus_read_nested(struct mii_bus
*bus
, int addr
, u32 regnum
);
269 int mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
270 int mdiobus_write_nested(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
272 int mdiobus_register_device(struct mdio_device
*mdiodev
);
273 int mdiobus_unregister_device(struct mdio_device
*mdiodev
);
274 bool mdiobus_is_registered_device(struct mii_bus
*bus
, int addr
);
275 struct phy_device
*mdiobus_get_phy(struct mii_bus
*bus
, int addr
);
278 * mdio_module_driver() - Helper macro for registering mdio drivers
280 * Helper macro for MDIO drivers which do not do anything special in module
281 * init/exit. Each module may only use this macro once, and calling it
282 * replaces module_init() and module_exit().
284 #define mdio_module_driver(_mdio_driver) \
285 static int __init mdio_module_init(void) \
287 return mdio_driver_register(&_mdio_driver); \
289 module_init(mdio_module_init); \
290 static void __exit mdio_module_exit(void) \
292 mdio_driver_unregister(&_mdio_driver); \
294 module_exit(mdio_module_exit)
296 #endif /* __LINUX_MDIO_H__ */