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 <phy_interface.h>
14 #include <dm/ofnode.h>
16 #include <linux/errno.h>
17 #include <linux/list.h>
18 #include <linux/mii.h>
19 #include <linux/ethtool.h>
20 #include <linux/mdio.h>
24 #define PHY_FIXED_ID 0xa5a55a5a
25 #define PHY_NCSI_ID 0xbeefcafe
28 * There is no actual id for this.
29 * This is just a dummy id for gmii2rgmmi converter.
31 #define PHY_GMII2RGMII_ID 0x5a5a5a5a
33 #define PHY_MAX_ADDR 32
35 #define PHY_FLAG_BROKEN_RESET (1 << 0) /* soft reset not supported */
37 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
41 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
42 SUPPORTED_10baseT_Full)
44 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
45 SUPPORTED_100baseT_Full)
47 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
48 SUPPORTED_1000baseT_Full)
50 #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
51 PHY_100BT_FEATURES | \
54 #define PHY_100BT1_FEATURES (SUPPORTED_TP | \
56 SUPPORTED_100baseT_Full)
58 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
61 #define PHY_10G_FEATURES (PHY_GBIT_FEATURES | \
62 SUPPORTED_10000baseT_Full)
64 #ifndef PHY_ANEG_TIMEOUT
65 #define PHY_ANEG_TIMEOUT 4000
71 #define MDIO_NAME_LEN 32
74 struct list_head link;
75 char name[MDIO_NAME_LEN];
77 int (*read)(struct mii_dev *bus, int addr, int devad, int reg);
78 int (*write)(struct mii_dev *bus, int addr, int devad, int reg,
80 int (*reset)(struct mii_dev *bus);
81 struct phy_device *phymap[PHY_MAX_ADDR];
85 /* struct phy_driver: a structure which defines PHY behavior
87 * uid will contain a number which represents the PHY. During
88 * startup, the driver will poll the PHY to find out what its
89 * UID--as defined by registers 2 and 3--is. The 32-bit result
90 * gotten from the PHY will be masked to
91 * discard any bits which may change based on revision numbers
92 * unimportant to functionality
103 /* Called to do any driver startup necessities */
104 /* Will be called during phy_connect */
105 int (*probe)(struct phy_device *phydev);
107 /* Called to configure the PHY, and modify the controller
108 * based on the results. Should be called after phy_connect */
109 int (*config)(struct phy_device *phydev);
111 /* Called when starting up the controller */
112 int (*startup)(struct phy_device *phydev);
114 /* Called when bringing down the controller */
115 int (*shutdown)(struct phy_device *phydev);
117 int (*readext)(struct phy_device *phydev, int addr, int devad, int reg);
118 int (*writeext)(struct phy_device *phydev, int addr, int devad, int reg,
121 /* Phy specific driver override for reading a MMD register */
122 int (*read_mmd)(struct phy_device *phydev, int devad, int reg);
124 /* Phy specific driver override for writing a MMD register */
125 int (*write_mmd)(struct phy_device *phydev, int devad, int reg,
128 /* driver private data */
133 /* Information about the PHY type */
134 /* And management functions */
136 struct phy_driver *drv;
142 /* forced speed & duplex (no autoneg)
143 * partner speed & duplex & pause (autoneg)
148 /* The most recently read link state */
151 phy_interface_t interface;
175 * phy_init() - Initializes the PHY drivers
176 * This function registers all available PHY drivers
178 * @return: 0 if OK, -ve on error
183 * phy_reset() - Resets the specified PHY
184 * Issues a reset of the PHY and waits for it to complete
186 * @phydev: PHY to reset
187 * @return: 0 if OK, -ve on error
189 int phy_reset(struct phy_device *phydev);
192 * phy_find_by_mask() - Searches for a PHY on the specified MDIO bus
193 * The function checks the PHY addresses flagged in phy_mask and returns a
194 * phy_device pointer if it detects a PHY.
195 * This function should only be called if just one PHY is expected to be present
196 * in the set of addresses flagged in phy_mask. If multiple PHYs are present,
197 * it is undefined which of these PHYs is returned.
199 * @bus: MII/MDIO bus to scan
200 * @phy_mask: bitmap of PYH addresses to scan
201 * @return: pointer to phy_device if a PHY is found, or NULL otherwise
203 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask);
205 #ifdef CONFIG_PHY_FIXED
208 * fixed_phy_create() - create an unconnected fixed-link pseudo-PHY device
209 * @node: OF node for the container of the fixed-link node
211 * Description: Creates a struct phy_device based on a fixed-link of_node
212 * description. Can be used without phy_connect by drivers which do not expose
213 * a UCLASS_ETH udevice.
215 struct phy_device *fixed_phy_create(ofnode node);
219 static inline struct phy_device *fixed_phy_create(ofnode node)
227 * phy_connect() - Creates a PHY device for the Ethernet interface
228 * Creates a PHY device for the PHY at the given address, if one doesn't exist
229 * already, and associates it with the Ethernet device.
230 * The function may be called with addr <= 0, in this case addr value is ignored
231 * and the bus is scanned to detect a PHY. Scanning should only be used if only
232 * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
233 * which PHY is returned.
235 * @bus: MII/MDIO bus that hosts the PHY
236 * @addr: PHY address on MDIO bus
237 * @dev: Ethernet device to associate to the PHY
238 * @interface: type of MAC-PHY interface
239 * @return: pointer to phy_device if a PHY is found, or NULL otherwise
241 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
243 phy_interface_t interface);
245 * phy_device_create() - Create a PHY device
247 * @bus: MII/MDIO bus that hosts the PHY
248 * @addr: PHY address on MDIO bus
249 * @phy_id: where to store the ID retrieved
250 * @is_c45: Device Identifiers if is_c45
251 * @return: pointer to phy_device if a PHY is found, or NULL otherwise
253 struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
254 u32 phy_id, bool is_c45);
257 * phy_connect_phy_id() - Connect to phy device by reading PHY id
260 * @bus: MII/MDIO bus that hosts the PHY
261 * @dev: Ethernet device to associate to the PHY
262 * @return: pointer to phy_device if a PHY is found,
265 struct phy_device *phy_connect_phy_id(struct mii_dev *bus, struct udevice *dev,
268 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
270 if (ofnode_valid(phydev->node))
273 return dev_ofnode(phydev->dev);
277 * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
278 * condition is met or a timeout occurs
280 * @phydev: The phy_device struct
281 * @devaddr: The MMD to read from
282 * @regnum: The register on the MMD to read
283 * @val: Variable to read the register into
284 * @cond: Break condition (usually involving @val)
285 * @sleep_us: Maximum time to sleep between reads in us (0
286 * tight-loops). Should be less than ~20ms since usleep_range
287 * is used (see Documentation/timers/timers-howto.rst).
288 * @timeout_us: Timeout in us, 0 means never timeout
289 * @sleep_before_read: if it is true, sleep @sleep_us before read.
290 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
291 * case, the last read value at @args is stored in @val. Must not
292 * be called from atomic context if sleep_us or timeout_us are used.
294 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
295 sleep_us, timeout_us, sleep_before_read) \
297 int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
298 sleep_us, timeout_us, \
299 phydev, devaddr, regnum); \
303 dev_err(phydev->dev, "%s failed: %d\n", __func__, __ret); \
307 int phy_read(struct phy_device *phydev, int devad, int regnum);
308 int phy_write(struct phy_device *phydev, int devad, int regnum, u16 val);
309 void phy_mmd_start_indirect(struct phy_device *phydev, int devad, int regnum);
310 int phy_read_mmd(struct phy_device *phydev, int devad, int regnum);
311 int phy_write_mmd(struct phy_device *phydev, int devad, int regnum, u16 val);
312 int phy_set_bits_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
313 int phy_clear_bits_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
314 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
316 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
319 int phy_startup(struct phy_device *phydev);
320 int phy_config(struct phy_device *phydev);
321 int phy_shutdown(struct phy_device *phydev);
322 int phy_set_supported(struct phy_device *phydev, u32 max_speed);
323 int phy_modify(struct phy_device *phydev, int devad, int regnum, u16 mask,
325 int genphy_config_aneg(struct phy_device *phydev);
326 int genphy_restart_aneg(struct phy_device *phydev);
327 int genphy_update_link(struct phy_device *phydev);
328 int genphy_parse_link(struct phy_device *phydev);
329 int genphy_config(struct phy_device *phydev);
330 int genphy_startup(struct phy_device *phydev);
331 int genphy_shutdown(struct phy_device *phydev);
332 int gen10g_config(struct phy_device *phydev);
333 int gen10g_startup(struct phy_device *phydev);
334 int gen10g_shutdown(struct phy_device *phydev);
335 int gen10g_discover_mmds(struct phy_device *phydev);
338 * U_BOOT_PHY_DRIVER() - Declare a new U-Boot driver
339 * @__name: name of the driver
341 #define U_BOOT_PHY_DRIVER(__name) \
342 ll_entry_declare(struct phy_driver, __name, phy_driver)
344 int board_phy_config(struct phy_device *phydev);
345 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);
348 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
349 * is RGMII (all variants)
350 * @phydev: the phy_device struct
351 * @return: true if MII bus is RGMII or false if it is not
353 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
355 switch (phydev->interface) {
356 case PHY_INTERFACE_MODE_RGMII:
357 case PHY_INTERFACE_MODE_RGMII_ID:
358 case PHY_INTERFACE_MODE_RGMII_RXID:
359 case PHY_INTERFACE_MODE_RGMII_TXID:
366 bool phy_interface_is_ncsi(void);
368 /* PHY UIDs for various PHYs that are referenced in external code */
369 #define PHY_UID_CS4340 0x13e51002
370 #define PHY_UID_CS4223 0x03e57003
371 #define PHY_UID_TN2020 0x00a19410
372 #define PHY_UID_IN112525_S03 0x02107440