1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright 2011 Freescale Semiconductor, Inc.
4 * Andy Fleming <afleming@gmail.com>
6 * This file pretty much stolen from Linux's mii.h/ethtool.h/phy.h
13 #include <linux/errno.h>
14 #include <linux/list.h>
15 #include <linux/mii.h>
16 #include <linux/ethtool.h>
17 #include <linux/mdio.h>
19 #include <phy_interface.h>
21 #define PHY_FIXED_ID 0xa5a55a5a
22 #define PHY_NCSI_ID 0xbeefcafe
25 * There is no actual id for this.
26 * This is just a dummy id for gmii2rgmmi converter.
28 #define PHY_GMII2RGMII_ID 0x5a5a5a5a
30 #define PHY_MAX_ADDR 32
32 #define PHY_FLAG_BROKEN_RESET (1 << 0) /* soft reset not supported */
34 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
38 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
39 SUPPORTED_10baseT_Full)
41 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
42 SUPPORTED_100baseT_Full)
44 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
45 SUPPORTED_1000baseT_Full)
47 #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
48 PHY_100BT_FEATURES | \
51 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
54 #define PHY_10G_FEATURES (PHY_GBIT_FEATURES | \
55 SUPPORTED_10000baseT_Full)
57 #ifndef PHY_ANEG_TIMEOUT
58 #define PHY_ANEG_TIMEOUT 4000
64 #define MDIO_NAME_LEN 32
67 struct list_head link
;
68 char name
[MDIO_NAME_LEN
];
70 int (*read
)(struct mii_dev
*bus
, int addr
, int devad
, int reg
);
71 int (*write
)(struct mii_dev
*bus
, int addr
, int devad
, int reg
,
73 int (*reset
)(struct mii_dev
*bus
);
74 struct phy_device
*phymap
[PHY_MAX_ADDR
];
78 /* struct phy_driver: a structure which defines PHY behavior
80 * uid will contain a number which represents the PHY. During
81 * startup, the driver will poll the PHY to find out what its
82 * UID--as defined by registers 2 and 3--is. The 32-bit result
83 * gotten from the PHY will be masked to
84 * discard any bits which may change based on revision numbers
85 * unimportant to functionality
96 /* Called to do any driver startup necessities */
97 /* Will be called during phy_connect */
98 int (*probe
)(struct phy_device
*phydev
);
100 /* Called to configure the PHY, and modify the controller
101 * based on the results. Should be called after phy_connect */
102 int (*config
)(struct phy_device
*phydev
);
104 /* Called when starting up the controller */
105 int (*startup
)(struct phy_device
*phydev
);
107 /* Called when bringing down the controller */
108 int (*shutdown
)(struct phy_device
*phydev
);
110 int (*readext
)(struct phy_device
*phydev
, int addr
, int devad
, int reg
);
111 int (*writeext
)(struct phy_device
*phydev
, int addr
, int devad
, int reg
,
114 /* Phy specific driver override for reading a MMD register */
115 int (*read_mmd
)(struct phy_device
*phydev
, int devad
, int reg
);
117 /* Phy specific driver override for writing a MMD register */
118 int (*write_mmd
)(struct phy_device
*phydev
, int devad
, int reg
,
121 struct list_head list
;
123 /* driver private data */
128 /* Information about the PHY type */
129 /* And management functions */
131 struct phy_driver
*drv
;
138 struct eth_device
*dev
;
141 /* forced speed & duplex (no autoneg)
142 * partner speed & duplex & pause (autoneg)
147 /* The most recently read link state */
150 phy_interface_t interface
;
173 static inline int phy_read(struct phy_device
*phydev
, int devad
, int regnum
)
175 struct mii_dev
*bus
= phydev
->bus
;
177 if (!bus
|| !bus
->read
) {
178 debug("%s: No bus configured\n", __func__
);
182 return bus
->read(bus
, phydev
->addr
, devad
, regnum
);
185 static inline int phy_write(struct phy_device
*phydev
, int devad
, int regnum
,
188 struct mii_dev
*bus
= phydev
->bus
;
190 if (!bus
|| !bus
->read
) {
191 debug("%s: No bus configured\n", __func__
);
195 return bus
->write(bus
, phydev
->addr
, devad
, regnum
, val
);
198 static inline void phy_mmd_start_indirect(struct phy_device
*phydev
, int devad
,
201 /* Write the desired MMD Devad */
202 phy_write(phydev
, MDIO_DEVAD_NONE
, MII_MMD_CTRL
, devad
);
204 /* Write the desired MMD register address */
205 phy_write(phydev
, MDIO_DEVAD_NONE
, MII_MMD_DATA
, regnum
);
207 /* Select the Function : DATA with no post increment */
208 phy_write(phydev
, MDIO_DEVAD_NONE
, MII_MMD_CTRL
,
209 (devad
| MII_MMD_CTRL_NOINCR
));
212 static inline int phy_read_mmd(struct phy_device
*phydev
, int devad
,
215 struct phy_driver
*drv
= phydev
->drv
;
217 if (regnum
> (u16
)~0 || devad
> 32)
220 /* driver-specific access */
222 return drv
->read_mmd(phydev
, devad
, regnum
);
224 /* direct C45 / C22 access */
225 if ((drv
->features
& PHY_10G_FEATURES
) == PHY_10G_FEATURES
||
226 devad
== MDIO_DEVAD_NONE
|| !devad
)
227 return phy_read(phydev
, devad
, regnum
);
229 /* indirect C22 access */
230 phy_mmd_start_indirect(phydev
, devad
, regnum
);
232 /* Read the content of the MMD's selected register */
233 return phy_read(phydev
, MDIO_DEVAD_NONE
, MII_MMD_DATA
);
236 static inline int phy_write_mmd(struct phy_device
*phydev
, int devad
,
239 struct phy_driver
*drv
= phydev
->drv
;
241 if (regnum
> (u16
)~0 || devad
> 32)
244 /* driver-specific access */
246 return drv
->write_mmd(phydev
, devad
, regnum
, val
);
248 /* direct C45 / C22 access */
249 if ((drv
->features
& PHY_10G_FEATURES
) == PHY_10G_FEATURES
||
250 devad
== MDIO_DEVAD_NONE
|| !devad
)
251 return phy_write(phydev
, devad
, regnum
, val
);
253 /* indirect C22 access */
254 phy_mmd_start_indirect(phydev
, devad
, regnum
);
256 /* Write the data into MMD's selected register */
257 return phy_write(phydev
, MDIO_DEVAD_NONE
, MII_MMD_DATA
, val
);
260 #ifdef CONFIG_PHYLIB_10G
261 extern struct phy_driver gen10g_driver
;
264 * List all 10G interfaces here, the assumption being that PHYs on these
267 static inline int is_10g_interface(phy_interface_t interface
)
269 return interface
== PHY_INTERFACE_MODE_XGMII
||
270 interface
== PHY_INTERFACE_MODE_USXGMII
||
271 interface
== PHY_INTERFACE_MODE_XFI
;
277 * phy_init() - Initializes the PHY drivers
279 * This function registers all available PHY drivers
281 * @return 0 if OK, -ve on error
286 * phy_reset() - Resets the specified PHY
288 * Issues a reset of the PHY and waits for it to complete
290 * @phydev: PHY to reset
291 * @return 0 if OK, -ve on error
293 int phy_reset(struct phy_device
*phydev
);
296 * phy_find_by_mask() - Searches for a PHY on the specified MDIO bus
298 * The function checks the PHY addresses flagged in phy_mask and returns a
299 * phy_device pointer if it detects a PHY.
300 * This function should only be called if just one PHY is expected to be present
301 * in the set of addresses flagged in phy_mask. If multiple PHYs are present,
302 * it is undefined which of these PHYs is returned.
304 * @bus: MII/MDIO bus to scan
305 * @phy_mask: bitmap of PYH addresses to scan
306 * @interface: type of MAC-PHY interface
307 * @return pointer to phy_device if a PHY is found, or NULL otherwise
309 struct phy_device
*phy_find_by_mask(struct mii_dev
*bus
, unsigned phy_mask
,
310 phy_interface_t interface
);
315 * phy_connect_dev() - Associates the given pair of PHY and Ethernet devices
316 * @phydev: PHY device
317 * @dev: Ethernet device
319 void phy_connect_dev(struct phy_device
*phydev
, struct udevice
*dev
);
322 * phy_connect() - Creates a PHY device for the Ethernet interface
324 * Creates a PHY device for the PHY at the given address, if one doesn't exist
325 * already, and associates it with the Ethernet device.
326 * The function may be called with addr <= 0, in this case addr value is ignored
327 * and the bus is scanned to detect a PHY. Scanning should only be used if only
328 * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
329 * which PHY is returned.
331 * @bus: MII/MDIO bus that hosts the PHY
332 * @addr: PHY address on MDIO bus
333 * @dev: Ethernet device to associate to the PHY
334 * @interface: type of MAC-PHY interface
335 * @return pointer to phy_device if a PHY is found, or NULL otherwise
337 struct phy_device
*phy_connect(struct mii_dev
*bus
, int addr
,
339 phy_interface_t interface
);
341 static inline ofnode
phy_get_ofnode(struct phy_device
*phydev
)
343 if (ofnode_valid(phydev
->node
))
346 return dev_ofnode(phydev
->dev
);
351 * phy_connect_dev() - Associates the given pair of PHY and Ethernet devices
352 * @phydev: PHY device
353 * @dev: Ethernet device
355 void phy_connect_dev(struct phy_device
*phydev
, struct eth_device
*dev
);
358 * phy_connect() - Creates a PHY device for the Ethernet interface
360 * Creates a PHY device for the PHY at the given address, if one doesn't exist
361 * already, and associates it with the Ethernet device.
362 * The function may be called with addr <= 0, in this case addr value is ignored
363 * and the bus is scanned to detect a PHY. Scanning should only be used if only
364 * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
365 * which PHY is returned.
367 * @bus: MII/MDIO bus that hosts the PHY
368 * @addr: PHY address on MDIO bus
369 * @dev: Ethernet device to associate to the PHY
370 * @interface: type of MAC-PHY interface
371 * @return pointer to phy_device if a PHY is found, or NULL otherwise
373 struct phy_device
*phy_connect(struct mii_dev
*bus
, int addr
,
374 struct eth_device
*dev
,
375 phy_interface_t interface
);
377 static inline ofnode
phy_get_ofnode(struct phy_device
*phydev
)
379 return ofnode_null();
382 int phy_startup(struct phy_device
*phydev
);
383 int phy_config(struct phy_device
*phydev
);
384 int phy_shutdown(struct phy_device
*phydev
);
385 int phy_register(struct phy_driver
*drv
);
386 int phy_set_supported(struct phy_device
*phydev
, u32 max_speed
);
387 int genphy_config_aneg(struct phy_device
*phydev
);
388 int genphy_restart_aneg(struct phy_device
*phydev
);
389 int genphy_update_link(struct phy_device
*phydev
);
390 int genphy_parse_link(struct phy_device
*phydev
);
391 int genphy_config(struct phy_device
*phydev
);
392 int genphy_startup(struct phy_device
*phydev
);
393 int genphy_shutdown(struct phy_device
*phydev
);
394 int gen10g_config(struct phy_device
*phydev
);
395 int gen10g_startup(struct phy_device
*phydev
);
396 int gen10g_shutdown(struct phy_device
*phydev
);
397 int gen10g_discover_mmds(struct phy_device
*phydev
);
399 int phy_b53_init(void);
400 int phy_mv88e61xx_init(void);
401 int phy_aquantia_init(void);
402 int phy_atheros_init(void);
403 int phy_broadcom_init(void);
404 int phy_cortina_init(void);
405 int phy_davicom_init(void);
406 int phy_et1011c_init(void);
407 int phy_lxt_init(void);
408 int phy_marvell_init(void);
409 int phy_micrel_ksz8xxx_init(void);
410 int phy_micrel_ksz90x1_init(void);
411 int phy_meson_gxl_init(void);
412 int phy_natsemi_init(void);
413 int phy_realtek_init(void);
414 int phy_smsc_init(void);
415 int phy_teranetics_init(void);
416 int phy_ti_init(void);
417 int phy_vitesse_init(void);
418 int phy_xilinx_init(void);
419 int phy_mscc_init(void);
420 int phy_fixed_init(void);
421 int phy_ncsi_init(void);
422 int phy_xilinx_gmii2rgmii_init(void);
424 int board_phy_config(struct phy_device
*phydev
);
425 int get_phy_id(struct mii_dev
*bus
, int addr
, int devad
, u32
*phy_id
);
428 * phy_get_interface_by_name() - Look up a PHY interface name
430 * @str: PHY interface name, e.g. "mii"
431 * @return PHY_INTERFACE_MODE_... value, or -1 if not found
433 int phy_get_interface_by_name(const char *str
);
436 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
437 * is RGMII (all variants)
438 * @phydev: the phy_device struct
440 static inline bool phy_interface_is_rgmii(struct phy_device
*phydev
)
442 return phydev
->interface
>= PHY_INTERFACE_MODE_RGMII
&&
443 phydev
->interface
<= PHY_INTERFACE_MODE_RGMII_TXID
;
447 * phy_interface_is_sgmii - Convenience function for testing if a PHY interface
448 * is SGMII (all variants)
449 * @phydev: the phy_device struct
451 static inline bool phy_interface_is_sgmii(struct phy_device
*phydev
)
453 return phydev
->interface
>= PHY_INTERFACE_MODE_SGMII
&&
454 phydev
->interface
<= PHY_INTERFACE_MODE_QSGMII
;
457 /* PHY UIDs for various PHYs that are referenced in external code */
458 #define PHY_UID_CS4340 0x13e51002
459 #define PHY_UID_CS4223 0x03e57003
460 #define PHY_UID_TN2020 0x00a19410
461 #define PHY_UID_IN112525_S03 0x02107440