1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Framework and drivers for configuring and reading different PHYs
4 * Based on code in sungem_phy.c and (long-removed) gianfar_phy.c
8 * Copyright (c) 2004 Freescale Semiconductor, Inc.
14 #include <linux/compiler.h>
15 #include <linux/spinlock.h>
16 #include <linux/ethtool.h>
17 #include <linux/linkmode.h>
18 #include <linux/mdio.h>
19 #include <linux/mii.h>
20 #include <linux/module.h>
21 #include <linux/timer.h>
22 #include <linux/workqueue.h>
23 #include <linux/mod_devicetable.h>
25 #include <linux/atomic.h>
27 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
31 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
32 SUPPORTED_10baseT_Full)
34 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
35 SUPPORTED_100baseT_Full)
37 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
38 SUPPORTED_1000baseT_Full)
40 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features
) __ro_after_init
;
41 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features
) __ro_after_init
;
42 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features
) __ro_after_init
;
43 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features
) __ro_after_init
;
44 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features
) __ro_after_init
;
45 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features
) __ro_after_init
;
46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features
) __ro_after_init
;
47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features
) __ro_after_init
;
49 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
50 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
51 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
52 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
53 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
54 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
55 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
56 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
58 extern const int phy_10_100_features_array
[4];
59 extern const int phy_basic_t1_features_array
[2];
60 extern const int phy_gbit_features_array
[2];
61 extern const int phy_10gbit_features_array
[1];
64 * Set phydev->irq to PHY_POLL if interrupts are not supported,
65 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
66 * the attached driver handles the interrupt
69 #define PHY_IGNORE_INTERRUPT -2
71 #define PHY_IS_INTERNAL 0x00000001
72 #define PHY_RST_AFTER_CLK_EN 0x00000002
73 #define MDIO_DEVICE_IS_PHY 0x80000000
75 /* Interface Mode definitions */
77 PHY_INTERFACE_MODE_NA
,
78 PHY_INTERFACE_MODE_INTERNAL
,
79 PHY_INTERFACE_MODE_MII
,
80 PHY_INTERFACE_MODE_GMII
,
81 PHY_INTERFACE_MODE_SGMII
,
82 PHY_INTERFACE_MODE_TBI
,
83 PHY_INTERFACE_MODE_REVMII
,
84 PHY_INTERFACE_MODE_RMII
,
85 PHY_INTERFACE_MODE_RGMII
,
86 PHY_INTERFACE_MODE_RGMII_ID
,
87 PHY_INTERFACE_MODE_RGMII_RXID
,
88 PHY_INTERFACE_MODE_RGMII_TXID
,
89 PHY_INTERFACE_MODE_RTBI
,
90 PHY_INTERFACE_MODE_SMII
,
91 PHY_INTERFACE_MODE_XGMII
,
92 PHY_INTERFACE_MODE_MOCA
,
93 PHY_INTERFACE_MODE_QSGMII
,
94 PHY_INTERFACE_MODE_TRGMII
,
95 PHY_INTERFACE_MODE_1000BASEX
,
96 PHY_INTERFACE_MODE_2500BASEX
,
97 PHY_INTERFACE_MODE_RXAUI
,
98 PHY_INTERFACE_MODE_XAUI
,
99 /* 10GBASE-KR, XFI, SFI - single lane 10G Serdes */
100 PHY_INTERFACE_MODE_10GKR
,
101 PHY_INTERFACE_MODE_MAX
,
105 * phy_supported_speeds - return all speeds currently supported by a phy device
106 * @phy: The phy device to return supported speeds of.
107 * @speeds: buffer to store supported speeds in.
108 * @size: size of speeds buffer.
110 * Description: Returns the number of supported speeds, and fills
111 * the speeds buffer with the supported speeds. If speeds buffer is
112 * too small to contain all currently supported speeds, will return as
113 * many speeds as can fit.
115 unsigned int phy_supported_speeds(struct phy_device
*phy
,
116 unsigned int *speeds
,
120 * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
121 * @interface: enum phy_interface_t value
123 * Description: maps 'enum phy_interface_t' defined in this file
124 * into the device tree binding of 'phy-mode', so that Ethernet
125 * device driver can get phy interface from device tree.
127 static inline const char *phy_modes(phy_interface_t interface
)
130 case PHY_INTERFACE_MODE_NA
:
132 case PHY_INTERFACE_MODE_INTERNAL
:
134 case PHY_INTERFACE_MODE_MII
:
136 case PHY_INTERFACE_MODE_GMII
:
138 case PHY_INTERFACE_MODE_SGMII
:
140 case PHY_INTERFACE_MODE_TBI
:
142 case PHY_INTERFACE_MODE_REVMII
:
144 case PHY_INTERFACE_MODE_RMII
:
146 case PHY_INTERFACE_MODE_RGMII
:
148 case PHY_INTERFACE_MODE_RGMII_ID
:
150 case PHY_INTERFACE_MODE_RGMII_RXID
:
152 case PHY_INTERFACE_MODE_RGMII_TXID
:
154 case PHY_INTERFACE_MODE_RTBI
:
156 case PHY_INTERFACE_MODE_SMII
:
158 case PHY_INTERFACE_MODE_XGMII
:
160 case PHY_INTERFACE_MODE_MOCA
:
162 case PHY_INTERFACE_MODE_QSGMII
:
164 case PHY_INTERFACE_MODE_TRGMII
:
166 case PHY_INTERFACE_MODE_1000BASEX
:
168 case PHY_INTERFACE_MODE_2500BASEX
:
170 case PHY_INTERFACE_MODE_RXAUI
:
172 case PHY_INTERFACE_MODE_XAUI
:
174 case PHY_INTERFACE_MODE_10GKR
:
182 #define PHY_INIT_TIMEOUT 100000
183 #define PHY_STATE_TIME 1
184 #define PHY_FORCE_TIMEOUT 10
186 #define PHY_MAX_ADDR 32
188 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
189 #define PHY_ID_FMT "%s:%02x"
191 #define MII_BUS_ID_SIZE 61
193 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
194 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
195 #define MII_ADDR_C45 (1<<30)
202 * The Bus class for PHYs. Devices which provide access to
203 * PHYs should register using this structure
206 struct module
*owner
;
208 char id
[MII_BUS_ID_SIZE
];
210 int (*read
)(struct mii_bus
*bus
, int addr
, int regnum
);
211 int (*write
)(struct mii_bus
*bus
, int addr
, int regnum
, u16 val
);
212 int (*reset
)(struct mii_bus
*bus
);
215 * A lock to ensure that only one thing can read/write
216 * the MDIO bus at a time
218 struct mutex mdio_lock
;
220 struct device
*parent
;
222 MDIOBUS_ALLOCATED
= 1,
224 MDIOBUS_UNREGISTERED
,
229 /* list of all PHYs on bus */
230 struct mdio_device
*mdio_map
[PHY_MAX_ADDR
];
232 /* PHY addresses to be ignored when probing */
235 /* PHY addresses to ignore the TA/read failure */
236 u32 phy_ignore_ta_mask
;
239 * An array of interrupts, each PHY's interrupt at the index
240 * matching its address
242 int irq
[PHY_MAX_ADDR
];
244 /* GPIO reset pulse width in microseconds */
246 /* RESET GPIO descriptor pointer */
247 struct gpio_desc
*reset_gpiod
;
249 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
251 struct mii_bus
*mdiobus_alloc_size(size_t);
252 static inline struct mii_bus
*mdiobus_alloc(void)
254 return mdiobus_alloc_size(0);
257 int __mdiobus_register(struct mii_bus
*bus
, struct module
*owner
);
258 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
259 void mdiobus_unregister(struct mii_bus
*bus
);
260 void mdiobus_free(struct mii_bus
*bus
);
261 struct mii_bus
*devm_mdiobus_alloc_size(struct device
*dev
, int sizeof_priv
);
262 static inline struct mii_bus
*devm_mdiobus_alloc(struct device
*dev
)
264 return devm_mdiobus_alloc_size(dev
, 0);
267 void devm_mdiobus_free(struct device
*dev
, struct mii_bus
*bus
);
268 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
);
270 #define PHY_INTERRUPT_DISABLED false
271 #define PHY_INTERRUPT_ENABLED true
273 /* PHY state machine states:
275 * DOWN: PHY device and driver are not ready for anything. probe
276 * should be called if and only if the PHY is in this state,
277 * given that the PHY device exists.
278 * - PHY driver probe function will set the state to READY
280 * READY: PHY is ready to send and receive packets, but the
281 * controller is not. By default, PHYs which do not implement
282 * probe will be set to this state by phy_probe().
283 * - start will set the state to UP
285 * UP: The PHY and attached device are ready to do work.
286 * Interrupts should be started here.
287 * - timer moves to NOLINK or RUNNING
289 * NOLINK: PHY is up, but not currently plugged in.
290 * - irq or timer will set RUNNING if link comes back
291 * - phy_stop moves to HALTED
293 * FORCING: PHY is being configured with forced settings
294 * - if link is up, move to RUNNING
295 * - If link is down, we drop to the next highest setting, and
296 * retry (FORCING) after a timeout
297 * - phy_stop moves to HALTED
299 * RUNNING: PHY is currently up, running, and possibly sending
300 * and/or receiving packets
301 * - irq or timer will set NOLINK if link goes down
302 * - phy_stop moves to HALTED
304 * HALTED: PHY is up, but no polling or interrupts are done. Or
305 * PHY is in an error state.
306 * - phy_start moves to UP
319 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
320 * @devices_in_package: Bit vector of devices present.
321 * @device_ids: The device identifer for each present device.
323 struct phy_c45_device_ids
{
324 u32 devices_in_package
;
328 /* phy_device: An instance of a PHY
330 * drv: Pointer to the driver for this PHY instance
331 * phy_id: UID for this device found during discovery
332 * c45_ids: 802.3-c45 Device Identifers if is_c45.
333 * is_c45: Set to true if this phy uses clause 45 addressing.
334 * is_internal: Set to true if this phy is internal to a MAC.
335 * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc.
336 * is_gigabit_capable: Set to true if PHY supports 1000Mbps
337 * has_fixups: Set to true if this phy has fixups/quirks.
338 * suspended: Set to true if this phy has been suspended successfully.
339 * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
340 * loopback_enabled: Set true if this phy has been loopbacked successfully.
341 * state: state of the PHY for management purposes
342 * dev_flags: Device-specific flags used by the PHY driver.
343 * link_timeout: The number of timer firings to wait before the
344 * giving up on the current attempt at acquiring a link
345 * irq: IRQ number of the PHY's interrupt (-1 if none)
346 * phy_timer: The timer for handling the state machine
347 * attached_dev: The attached enet driver's device instance ptr
348 * adjust_link: Callback for the enet controller to respond to
349 * changes in the link state.
351 * speed, duplex, pause, supported, advertising, lp_advertising,
352 * and autoneg are used like in mii_if_info
354 * interrupts currently only supports enabled or disabled,
355 * but could be changed in the future to support enabling
356 * and disabling specific interrupts
358 * Contains some infrastructure for polling and interrupt
359 * handling, as well as handling shifts in PHY hardware state
362 struct mdio_device mdio
;
364 /* Information about the PHY type */
365 /* And management functions */
366 struct phy_driver
*drv
;
370 struct phy_c45_device_ids c45_ids
;
372 unsigned is_internal
:1;
373 unsigned is_pseudo_fixed_link
:1;
374 unsigned is_gigabit_capable
:1;
375 unsigned has_fixups
:1;
376 unsigned suspended
:1;
377 unsigned sysfs_links
:1;
378 unsigned loopback_enabled
:1;
381 /* The most recently read link state */
383 unsigned autoneg_complete
:1;
385 /* Interrupts are enabled */
386 unsigned interrupts
:1;
388 enum phy_state state
;
392 phy_interface_t interface
;
395 * forced speed & duplex (no autoneg)
396 * partner speed & duplex & pause (autoneg)
403 /* Union of PHY and Attached devices' supported link modes */
404 /* See ethtool.h for more info */
405 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported
);
406 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising
);
407 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising
);
409 /* Energy efficient ethernet modes which should be prohibited */
410 u32 eee_broken_modes
;
414 #ifdef CONFIG_LED_TRIGGER_PHY
415 struct phy_led_trigger
*phy_led_triggers
;
416 unsigned int phy_num_led_triggers
;
417 struct phy_led_trigger
*last_triggered
;
419 struct phy_led_trigger
*led_link_trigger
;
423 * Interrupt number for this PHY
424 * -1 means no interrupt
428 /* private data pointer */
429 /* For use by PHYs to maintain extra state */
432 /* Interrupt and Polling infrastructure */
433 struct delayed_work state_queue
;
437 struct phylink
*phylink
;
438 struct net_device
*attached_dev
;
443 void (*phy_link_change
)(struct phy_device
*, bool up
, bool do_carrier
);
444 void (*adjust_link
)(struct net_device
*dev
);
446 #define to_phy_device(d) container_of(to_mdio_device(d), \
447 struct phy_device, mdio)
449 /* struct phy_driver: Driver structure for a particular PHY type
451 * driver_data: static driver data
452 * phy_id: The result of reading the UID registers of this PHY
453 * type, and ANDing them with the phy_id_mask. This driver
454 * only works for PHYs with IDs which match this field
455 * name: The friendly name of this PHY type
456 * phy_id_mask: Defines the important bits of the phy_id
457 * features: A mandatory list of features (speed, duplex, etc)
458 * supported by this PHY
459 * flags: A bitfield defining certain other features this PHY
460 * supports (like interrupts)
462 * All functions are optional. If config_aneg or read_status
463 * are not implemented, the phy core uses the genphy versions.
464 * Note that none of these functions should be called from
465 * interrupt time. The goal is for the bus read/write functions
466 * to be able to block when the bus transaction is happening,
467 * and be freed up by an interrupt (The MPC85xx has this ability,
468 * though it is not currently supported in the driver).
471 struct mdio_driver_common mdiodrv
;
475 const unsigned long * const features
;
477 const void *driver_data
;
480 * Called to issue a PHY software reset
482 int (*soft_reset
)(struct phy_device
*phydev
);
485 * Called to initialize the PHY,
486 * including after a reset
488 int (*config_init
)(struct phy_device
*phydev
);
491 * Called during discovery. Used to set
492 * up device-specific structures, if any
494 int (*probe
)(struct phy_device
*phydev
);
497 * Probe the hardware to determine what abilities it has.
498 * Should only set phydev->supported.
500 int (*get_features
)(struct phy_device
*phydev
);
502 /* PHY Power Management */
503 int (*suspend
)(struct phy_device
*phydev
);
504 int (*resume
)(struct phy_device
*phydev
);
507 * Configures the advertisement and resets
508 * autonegotiation if phydev->autoneg is on,
509 * forces the speed to the current settings in phydev
510 * if phydev->autoneg is off
512 int (*config_aneg
)(struct phy_device
*phydev
);
514 /* Determines the auto negotiation result */
515 int (*aneg_done
)(struct phy_device
*phydev
);
517 /* Determines the negotiated speed and duplex */
518 int (*read_status
)(struct phy_device
*phydev
);
520 /* Clears any pending interrupts */
521 int (*ack_interrupt
)(struct phy_device
*phydev
);
523 /* Enables or disables interrupts */
524 int (*config_intr
)(struct phy_device
*phydev
);
527 * Checks if the PHY generated an interrupt.
528 * For multi-PHY devices with shared PHY interrupt pin
530 int (*did_interrupt
)(struct phy_device
*phydev
);
532 /* Clears up any memory if needed */
533 void (*remove
)(struct phy_device
*phydev
);
535 /* Returns true if this is a suitable driver for the given
536 * phydev. If NULL, matching is based on phy_id and
539 int (*match_phy_device
)(struct phy_device
*phydev
);
541 /* Handles ethtool queries for hardware time stamping. */
542 int (*ts_info
)(struct phy_device
*phydev
, struct ethtool_ts_info
*ti
);
544 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
545 int (*hwtstamp
)(struct phy_device
*phydev
, struct ifreq
*ifr
);
548 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
549 * the phy driver promises to deliver it using netif_rx() as
550 * soon as a timestamp becomes available. One of the
551 * PTP_CLASS_ values is passed in 'type'. The function must
552 * return true if the skb is accepted for delivery.
554 bool (*rxtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
557 * Requests a Tx timestamp for 'skb'. The phy driver promises
558 * to deliver it using skb_complete_tx_timestamp() as soon as a
559 * timestamp becomes available. One of the PTP_CLASS_ values
560 * is passed in 'type'.
562 void (*txtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
564 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
565 * enable Wake on LAN, so set_wol is provided to be called in the
566 * ethernet driver's set_wol function. */
567 int (*set_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
569 /* See set_wol, but for checking whether Wake on LAN is enabled. */
570 void (*get_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
573 * Called to inform a PHY device driver when the core is about to
574 * change the link state. This callback is supposed to be used as
575 * fixup hook for drivers that need to take action when the link
576 * state changes. Drivers are by no means allowed to mess with the
577 * PHY device structure in their implementations.
579 void (*link_change_notify
)(struct phy_device
*dev
);
582 * Phy specific driver override for reading a MMD register.
583 * This function is optional for PHY specific drivers. When
584 * not provided, the default MMD read function will be used
585 * by phy_read_mmd(), which will use either a direct read for
586 * Clause 45 PHYs or an indirect read for Clause 22 PHYs.
587 * devnum is the MMD device number within the PHY device,
588 * regnum is the register within the selected MMD device.
590 int (*read_mmd
)(struct phy_device
*dev
, int devnum
, u16 regnum
);
593 * Phy specific driver override for writing a MMD register.
594 * This function is optional for PHY specific drivers. When
595 * not provided, the default MMD write function will be used
596 * by phy_write_mmd(), which will use either a direct write for
597 * Clause 45 PHYs, or an indirect write for Clause 22 PHYs.
598 * devnum is the MMD device number within the PHY device,
599 * regnum is the register within the selected MMD device.
600 * val is the value to be written.
602 int (*write_mmd
)(struct phy_device
*dev
, int devnum
, u16 regnum
,
605 int (*read_page
)(struct phy_device
*dev
);
606 int (*write_page
)(struct phy_device
*dev
, int page
);
608 /* Get the size and type of the eeprom contained within a plug-in
610 int (*module_info
)(struct phy_device
*dev
,
611 struct ethtool_modinfo
*modinfo
);
613 /* Get the eeprom information from the plug-in module */
614 int (*module_eeprom
)(struct phy_device
*dev
,
615 struct ethtool_eeprom
*ee
, u8
*data
);
617 /* Get statistics from the phy using ethtool */
618 int (*get_sset_count
)(struct phy_device
*dev
);
619 void (*get_strings
)(struct phy_device
*dev
, u8
*data
);
620 void (*get_stats
)(struct phy_device
*dev
,
621 struct ethtool_stats
*stats
, u64
*data
);
623 /* Get and Set PHY tunables */
624 int (*get_tunable
)(struct phy_device
*dev
,
625 struct ethtool_tunable
*tuna
, void *data
);
626 int (*set_tunable
)(struct phy_device
*dev
,
627 struct ethtool_tunable
*tuna
,
629 int (*set_loopback
)(struct phy_device
*dev
, bool enable
);
631 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \
632 struct phy_driver, mdiodrv)
634 #define PHY_ANY_ID "MATCH ANY PHY"
635 #define PHY_ANY_UID 0xffffffff
637 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
638 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
639 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
641 /* A Structure for boards to register fixups with the PHY Lib */
643 struct list_head list
;
644 char bus_id
[MII_BUS_ID_SIZE
+ 3];
647 int (*run
)(struct phy_device
*phydev
);
650 const char *phy_speed_to_str(int speed
);
651 const char *phy_duplex_to_str(unsigned int duplex
);
653 /* A structure for mapping a particular speed and duplex
654 * combination to a particular SUPPORTED and ADVERTISED value
662 const struct phy_setting
*
663 phy_lookup_setting(int speed
, int duplex
, const unsigned long *mask
,
665 size_t phy_speeds(unsigned int *speeds
, size_t size
,
666 unsigned long *mask
);
667 void of_set_phy_supported(struct phy_device
*phydev
);
668 void of_set_phy_eee_broken(struct phy_device
*phydev
);
671 * phy_is_started - Convenience function to check whether PHY is started
672 * @phydev: The phy_device struct
674 static inline bool phy_is_started(struct phy_device
*phydev
)
676 return phydev
->state
>= PHY_UP
;
679 void phy_resolve_aneg_linkmode(struct phy_device
*phydev
);
682 * phy_read - Convenience function for reading a given PHY register
683 * @phydev: the phy_device struct
684 * @regnum: register number to read
686 * NOTE: MUST NOT be called from interrupt context,
687 * because the bus read/write functions may wait for an interrupt
688 * to conclude the operation.
690 static inline int phy_read(struct phy_device
*phydev
, u32 regnum
)
692 return mdiobus_read(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
);
696 * __phy_read - convenience function for reading a given PHY register
697 * @phydev: the phy_device struct
698 * @regnum: register number to read
700 * The caller must have taken the MDIO bus lock.
702 static inline int __phy_read(struct phy_device
*phydev
, u32 regnum
)
704 return __mdiobus_read(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
);
708 * phy_write - Convenience function for writing a given PHY register
709 * @phydev: the phy_device struct
710 * @regnum: register number to write
711 * @val: value to write to @regnum
713 * NOTE: MUST NOT be called from interrupt context,
714 * because the bus read/write functions may wait for an interrupt
715 * to conclude the operation.
717 static inline int phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
719 return mdiobus_write(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
, val
);
723 * __phy_write - Convenience function for writing a given PHY register
724 * @phydev: the phy_device struct
725 * @regnum: register number to write
726 * @val: value to write to @regnum
728 * The caller must have taken the MDIO bus lock.
730 static inline int __phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
732 return __mdiobus_write(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
,
737 * phy_read_mmd - Convenience function for reading a register
738 * from an MMD on a given PHY.
739 * @phydev: The phy_device struct
740 * @devad: The MMD to read from
741 * @regnum: The register on the MMD to read
743 * Same rules as for phy_read();
745 int phy_read_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
);
748 * __phy_read_mmd - Convenience function for reading a register
749 * from an MMD on a given PHY.
750 * @phydev: The phy_device struct
751 * @devad: The MMD to read from
752 * @regnum: The register on the MMD to read
754 * Same rules as for __phy_read();
756 int __phy_read_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
);
759 * phy_write_mmd - Convenience function for writing a register
760 * on an MMD on a given PHY.
761 * @phydev: The phy_device struct
762 * @devad: The MMD to write to
763 * @regnum: The register on the MMD to read
764 * @val: value to write to @regnum
766 * Same rules as for phy_write();
768 int phy_write_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
, u16 val
);
771 * __phy_write_mmd - Convenience function for writing a register
772 * on an MMD on a given PHY.
773 * @phydev: The phy_device struct
774 * @devad: The MMD to write to
775 * @regnum: The register on the MMD to read
776 * @val: value to write to @regnum
778 * Same rules as for __phy_write();
780 int __phy_write_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
, u16 val
);
782 int __phy_modify_changed(struct phy_device
*phydev
, u32 regnum
, u16 mask
,
784 int phy_modify_changed(struct phy_device
*phydev
, u32 regnum
, u16 mask
,
786 int __phy_modify(struct phy_device
*phydev
, u32 regnum
, u16 mask
, u16 set
);
787 int phy_modify(struct phy_device
*phydev
, u32 regnum
, u16 mask
, u16 set
);
789 int __phy_modify_mmd_changed(struct phy_device
*phydev
, int devad
, u32 regnum
,
791 int phy_modify_mmd_changed(struct phy_device
*phydev
, int devad
, u32 regnum
,
793 int __phy_modify_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
,
795 int phy_modify_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
,
799 * __phy_set_bits - Convenience function for setting bits in a PHY register
800 * @phydev: the phy_device struct
801 * @regnum: register number to write
804 * The caller must have taken the MDIO bus lock.
806 static inline int __phy_set_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
808 return __phy_modify(phydev
, regnum
, 0, val
);
812 * __phy_clear_bits - Convenience function for clearing bits in a PHY register
813 * @phydev: the phy_device struct
814 * @regnum: register number to write
815 * @val: bits to clear
817 * The caller must have taken the MDIO bus lock.
819 static inline int __phy_clear_bits(struct phy_device
*phydev
, u32 regnum
,
822 return __phy_modify(phydev
, regnum
, val
, 0);
826 * phy_set_bits - Convenience function for setting bits in a PHY register
827 * @phydev: the phy_device struct
828 * @regnum: register number to write
831 static inline int phy_set_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
833 return phy_modify(phydev
, regnum
, 0, val
);
837 * phy_clear_bits - Convenience function for clearing bits in a PHY register
838 * @phydev: the phy_device struct
839 * @regnum: register number to write
840 * @val: bits to clear
842 static inline int phy_clear_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
844 return phy_modify(phydev
, regnum
, val
, 0);
848 * __phy_set_bits_mmd - Convenience function for setting bits in a register
850 * @phydev: the phy_device struct
851 * @devad: the MMD containing register to modify
852 * @regnum: register number to modify
855 * The caller must have taken the MDIO bus lock.
857 static inline int __phy_set_bits_mmd(struct phy_device
*phydev
, int devad
,
860 return __phy_modify_mmd(phydev
, devad
, regnum
, 0, val
);
864 * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
866 * @phydev: the phy_device struct
867 * @devad: the MMD containing register to modify
868 * @regnum: register number to modify
869 * @val: bits to clear
871 * The caller must have taken the MDIO bus lock.
873 static inline int __phy_clear_bits_mmd(struct phy_device
*phydev
, int devad
,
876 return __phy_modify_mmd(phydev
, devad
, regnum
, val
, 0);
880 * phy_set_bits_mmd - Convenience function for setting bits in a register
882 * @phydev: the phy_device struct
883 * @devad: the MMD containing register to modify
884 * @regnum: register number to modify
887 static inline int phy_set_bits_mmd(struct phy_device
*phydev
, int devad
,
890 return phy_modify_mmd(phydev
, devad
, regnum
, 0, val
);
894 * phy_clear_bits_mmd - Convenience function for clearing bits in a register
896 * @phydev: the phy_device struct
897 * @devad: the MMD containing register to modify
898 * @regnum: register number to modify
899 * @val: bits to clear
901 static inline int phy_clear_bits_mmd(struct phy_device
*phydev
, int devad
,
904 return phy_modify_mmd(phydev
, devad
, regnum
, val
, 0);
908 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
909 * @phydev: the phy_device struct
911 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
912 * PHY_IGNORE_INTERRUPT
914 static inline bool phy_interrupt_is_valid(struct phy_device
*phydev
)
916 return phydev
->irq
!= PHY_POLL
&& phydev
->irq
!= PHY_IGNORE_INTERRUPT
;
920 * phy_polling_mode - Convenience function for testing whether polling is
921 * used to detect PHY status changes
922 * @phydev: the phy_device struct
924 static inline bool phy_polling_mode(struct phy_device
*phydev
)
926 return phydev
->irq
== PHY_POLL
;
930 * phy_is_internal - Convenience function for testing if a PHY is internal
931 * @phydev: the phy_device struct
933 static inline bool phy_is_internal(struct phy_device
*phydev
)
935 return phydev
->is_internal
;
939 * phy_interface_mode_is_rgmii - Convenience function for testing if a
940 * PHY interface mode is RGMII (all variants)
941 * @mode: the phy_interface_t enum
943 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode
)
945 return mode
>= PHY_INTERFACE_MODE_RGMII
&&
946 mode
<= PHY_INTERFACE_MODE_RGMII_TXID
;
950 * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z
952 * @mode: one of &enum phy_interface_t
954 * Returns true if the phy interface mode uses the 16-bit negotiation
955 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
957 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode
)
959 return mode
== PHY_INTERFACE_MODE_1000BASEX
||
960 mode
== PHY_INTERFACE_MODE_2500BASEX
;
964 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
965 * is RGMII (all variants)
966 * @phydev: the phy_device struct
968 static inline bool phy_interface_is_rgmii(struct phy_device
*phydev
)
970 return phy_interface_mode_is_rgmii(phydev
->interface
);
974 * phy_is_pseudo_fixed_link - Convenience function for testing if this
975 * PHY is the CPU port facing side of an Ethernet switch, or similar.
976 * @phydev: the phy_device struct
978 static inline bool phy_is_pseudo_fixed_link(struct phy_device
*phydev
)
980 return phydev
->is_pseudo_fixed_link
;
983 int phy_save_page(struct phy_device
*phydev
);
984 int phy_select_page(struct phy_device
*phydev
, int page
);
985 int phy_restore_page(struct phy_device
*phydev
, int oldpage
, int ret
);
986 int phy_read_paged(struct phy_device
*phydev
, int page
, u32 regnum
);
987 int phy_write_paged(struct phy_device
*phydev
, int page
, u32 regnum
, u16 val
);
988 int phy_modify_paged(struct phy_device
*phydev
, int page
, u32 regnum
,
991 struct phy_device
*phy_device_create(struct mii_bus
*bus
, int addr
, int phy_id
,
993 struct phy_c45_device_ids
*c45_ids
);
994 #if IS_ENABLED(CONFIG_PHYLIB)
995 struct phy_device
*get_phy_device(struct mii_bus
*bus
, int addr
, bool is_c45
);
996 int phy_device_register(struct phy_device
*phy
);
997 void phy_device_free(struct phy_device
*phydev
);
1000 struct phy_device
*get_phy_device(struct mii_bus
*bus
, int addr
, bool is_c45
)
1005 static inline int phy_device_register(struct phy_device
*phy
)
1010 static inline void phy_device_free(struct phy_device
*phydev
) { }
1011 #endif /* CONFIG_PHYLIB */
1012 void phy_device_remove(struct phy_device
*phydev
);
1013 int phy_init_hw(struct phy_device
*phydev
);
1014 int phy_suspend(struct phy_device
*phydev
);
1015 int phy_resume(struct phy_device
*phydev
);
1016 int __phy_resume(struct phy_device
*phydev
);
1017 int phy_loopback(struct phy_device
*phydev
, bool enable
);
1018 struct phy_device
*phy_attach(struct net_device
*dev
, const char *bus_id
,
1019 phy_interface_t interface
);
1020 struct phy_device
*phy_find_first(struct mii_bus
*bus
);
1021 int phy_attach_direct(struct net_device
*dev
, struct phy_device
*phydev
,
1022 u32 flags
, phy_interface_t interface
);
1023 int phy_connect_direct(struct net_device
*dev
, struct phy_device
*phydev
,
1024 void (*handler
)(struct net_device
*),
1025 phy_interface_t interface
);
1026 struct phy_device
*phy_connect(struct net_device
*dev
, const char *bus_id
,
1027 void (*handler
)(struct net_device
*),
1028 phy_interface_t interface
);
1029 void phy_disconnect(struct phy_device
*phydev
);
1030 void phy_detach(struct phy_device
*phydev
);
1031 void phy_start(struct phy_device
*phydev
);
1032 void phy_stop(struct phy_device
*phydev
);
1033 int phy_start_aneg(struct phy_device
*phydev
);
1034 int phy_aneg_done(struct phy_device
*phydev
);
1035 int phy_speed_down(struct phy_device
*phydev
, bool sync
);
1036 int phy_speed_up(struct phy_device
*phydev
);
1038 int phy_restart_aneg(struct phy_device
*phydev
);
1039 int phy_reset_after_clk_enable(struct phy_device
*phydev
);
1041 static inline void phy_device_reset(struct phy_device
*phydev
, int value
)
1043 mdio_device_reset(&phydev
->mdio
, value
);
1046 #define phydev_err(_phydev, format, args...) \
1047 dev_err(&_phydev->mdio.dev, format, ##args)
1049 #define phydev_info(_phydev, format, args...) \
1050 dev_info(&_phydev->mdio.dev, format, ##args)
1052 #define phydev_warn(_phydev, format, args...) \
1053 dev_warn(&_phydev->mdio.dev, format, ##args)
1055 #define phydev_dbg(_phydev, format, args...) \
1056 dev_dbg(&_phydev->mdio.dev, format, ##args)
1058 static inline const char *phydev_name(const struct phy_device
*phydev
)
1060 return dev_name(&phydev
->mdio
.dev
);
1063 void phy_attached_print(struct phy_device
*phydev
, const char *fmt
, ...)
1065 void phy_attached_info(struct phy_device
*phydev
);
1068 int genphy_config_init(struct phy_device
*phydev
);
1069 int genphy_read_abilities(struct phy_device
*phydev
);
1070 int genphy_setup_forced(struct phy_device
*phydev
);
1071 int genphy_restart_aneg(struct phy_device
*phydev
);
1072 int genphy_config_eee_advert(struct phy_device
*phydev
);
1073 int genphy_config_aneg(struct phy_device
*phydev
);
1074 int genphy_aneg_done(struct phy_device
*phydev
);
1075 int genphy_update_link(struct phy_device
*phydev
);
1076 int genphy_read_status(struct phy_device
*phydev
);
1077 int genphy_suspend(struct phy_device
*phydev
);
1078 int genphy_resume(struct phy_device
*phydev
);
1079 int genphy_loopback(struct phy_device
*phydev
, bool enable
);
1080 int genphy_soft_reset(struct phy_device
*phydev
);
1081 static inline int genphy_no_soft_reset(struct phy_device
*phydev
)
1085 static inline int genphy_no_ack_interrupt(struct phy_device
*phydev
)
1089 static inline int genphy_no_config_intr(struct phy_device
*phydev
)
1093 int genphy_read_mmd_unsupported(struct phy_device
*phdev
, int devad
,
1095 int genphy_write_mmd_unsupported(struct phy_device
*phdev
, int devnum
,
1096 u16 regnum
, u16 val
);
1099 int genphy_c45_restart_aneg(struct phy_device
*phydev
);
1100 int genphy_c45_check_and_restart_aneg(struct phy_device
*phydev
, bool restart
);
1101 int genphy_c45_aneg_done(struct phy_device
*phydev
);
1102 int genphy_c45_read_link(struct phy_device
*phydev
);
1103 int genphy_c45_read_lpa(struct phy_device
*phydev
);
1104 int genphy_c45_read_pma(struct phy_device
*phydev
);
1105 int genphy_c45_pma_setup_forced(struct phy_device
*phydev
);
1106 int genphy_c45_an_config_aneg(struct phy_device
*phydev
);
1107 int genphy_c45_an_disable_aneg(struct phy_device
*phydev
);
1108 int genphy_c45_read_mdix(struct phy_device
*phydev
);
1109 int genphy_c45_pma_read_abilities(struct phy_device
*phydev
);
1110 int genphy_c45_read_status(struct phy_device
*phydev
);
1112 /* The gen10g_* functions are the old Clause 45 stub */
1113 int gen10g_config_aneg(struct phy_device
*phydev
);
1115 static inline int phy_read_status(struct phy_device
*phydev
)
1120 if (phydev
->drv
->read_status
)
1121 return phydev
->drv
->read_status(phydev
);
1123 return genphy_read_status(phydev
);
1126 void phy_driver_unregister(struct phy_driver
*drv
);
1127 void phy_drivers_unregister(struct phy_driver
*drv
, int n
);
1128 int phy_driver_register(struct phy_driver
*new_driver
, struct module
*owner
);
1129 int phy_drivers_register(struct phy_driver
*new_driver
, int n
,
1130 struct module
*owner
);
1131 void phy_state_machine(struct work_struct
*work
);
1132 void phy_mac_interrupt(struct phy_device
*phydev
);
1133 void phy_start_machine(struct phy_device
*phydev
);
1134 void phy_stop_machine(struct phy_device
*phydev
);
1135 int phy_ethtool_sset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
1136 void phy_ethtool_ksettings_get(struct phy_device
*phydev
,
1137 struct ethtool_link_ksettings
*cmd
);
1138 int phy_ethtool_ksettings_set(struct phy_device
*phydev
,
1139 const struct ethtool_link_ksettings
*cmd
);
1140 int phy_mii_ioctl(struct phy_device
*phydev
, struct ifreq
*ifr
, int cmd
);
1141 void phy_request_interrupt(struct phy_device
*phydev
);
1142 void phy_print_status(struct phy_device
*phydev
);
1143 int phy_set_max_speed(struct phy_device
*phydev
, u32 max_speed
);
1144 void phy_remove_link_mode(struct phy_device
*phydev
, u32 link_mode
);
1145 void phy_advertise_supported(struct phy_device
*phydev
);
1146 void phy_support_sym_pause(struct phy_device
*phydev
);
1147 void phy_support_asym_pause(struct phy_device
*phydev
);
1148 void phy_set_sym_pause(struct phy_device
*phydev
, bool rx
, bool tx
,
1150 void phy_set_asym_pause(struct phy_device
*phydev
, bool rx
, bool tx
);
1151 bool phy_validate_pause(struct phy_device
*phydev
,
1152 struct ethtool_pauseparam
*pp
);
1154 int phy_register_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
,
1155 int (*run
)(struct phy_device
*));
1156 int phy_register_fixup_for_id(const char *bus_id
,
1157 int (*run
)(struct phy_device
*));
1158 int phy_register_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
,
1159 int (*run
)(struct phy_device
*));
1161 int phy_unregister_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
);
1162 int phy_unregister_fixup_for_id(const char *bus_id
);
1163 int phy_unregister_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
);
1165 int phy_init_eee(struct phy_device
*phydev
, bool clk_stop_enable
);
1166 int phy_get_eee_err(struct phy_device
*phydev
);
1167 int phy_ethtool_set_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
1168 int phy_ethtool_get_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
1169 int phy_ethtool_set_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
);
1170 void phy_ethtool_get_wol(struct phy_device
*phydev
,
1171 struct ethtool_wolinfo
*wol
);
1172 int phy_ethtool_get_link_ksettings(struct net_device
*ndev
,
1173 struct ethtool_link_ksettings
*cmd
);
1174 int phy_ethtool_set_link_ksettings(struct net_device
*ndev
,
1175 const struct ethtool_link_ksettings
*cmd
);
1176 int phy_ethtool_nway_reset(struct net_device
*ndev
);
1178 #if IS_ENABLED(CONFIG_PHYLIB)
1179 int __init
mdio_bus_init(void);
1180 void mdio_bus_exit(void);
1183 /* Inline function for use within net/core/ethtool.c (built-in) */
1184 static inline int phy_ethtool_get_strings(struct phy_device
*phydev
, u8
*data
)
1189 mutex_lock(&phydev
->lock
);
1190 phydev
->drv
->get_strings(phydev
, data
);
1191 mutex_unlock(&phydev
->lock
);
1196 static inline int phy_ethtool_get_sset_count(struct phy_device
*phydev
)
1203 if (phydev
->drv
->get_sset_count
&&
1204 phydev
->drv
->get_strings
&&
1205 phydev
->drv
->get_stats
) {
1206 mutex_lock(&phydev
->lock
);
1207 ret
= phydev
->drv
->get_sset_count(phydev
);
1208 mutex_unlock(&phydev
->lock
);
1216 static inline int phy_ethtool_get_stats(struct phy_device
*phydev
,
1217 struct ethtool_stats
*stats
, u64
*data
)
1222 mutex_lock(&phydev
->lock
);
1223 phydev
->drv
->get_stats(phydev
, stats
, data
);
1224 mutex_unlock(&phydev
->lock
);
1229 extern struct bus_type mdio_bus_type
;
1231 struct mdio_board_info
{
1233 char modalias
[MDIO_NAME_SIZE
];
1235 const void *platform_data
;
1238 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1239 int mdiobus_register_board_info(const struct mdio_board_info
*info
,
1242 static inline int mdiobus_register_board_info(const struct mdio_board_info
*i
,
1251 * module_phy_driver() - Helper macro for registering PHY drivers
1252 * @__phy_drivers: array of PHY drivers to register
1254 * Helper macro for PHY drivers which do not do anything special in module
1255 * init/exit. Each module may only use this macro once, and calling it
1256 * replaces module_init() and module_exit().
1258 #define phy_module_driver(__phy_drivers, __count) \
1259 static int __init phy_module_init(void) \
1261 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1263 module_init(phy_module_init); \
1264 static void __exit phy_module_exit(void) \
1266 phy_drivers_unregister(__phy_drivers, __count); \
1268 module_exit(phy_module_exit)
1270 #define module_phy_driver(__phy_drivers) \
1271 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1273 bool phy_driver_is_genphy(struct phy_device
*phydev
);
1274 bool phy_driver_is_genphy_10g(struct phy_device
*phydev
);
1276 #endif /* __PHY_H */