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/netlink.h>
19 #include <linux/mdio.h>
20 #include <linux/mii.h>
21 #include <linux/mii_timestamper.h>
22 #include <linux/module.h>
23 #include <linux/timer.h>
24 #include <linux/workqueue.h>
25 #include <linux/mod_devicetable.h>
26 #include <linux/u64_stats_sync.h>
27 #include <linux/irqreturn.h>
28 #include <linux/iopoll.h>
29 #include <linux/refcount.h>
31 #include <linux/atomic.h>
33 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
37 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
38 SUPPORTED_10baseT_Full)
40 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
41 SUPPORTED_100baseT_Full)
43 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
44 SUPPORTED_1000baseT_Full)
46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
53 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
55 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
56 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
57 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
58 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
59 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
60 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
61 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
62 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
64 extern const int phy_basic_ports_array[3];
65 extern const int phy_fibre_port_array[1];
66 extern const int phy_all_ports_features_array[7];
67 extern const int phy_10_100_features_array[4];
68 extern const int phy_basic_t1_features_array[3];
69 extern const int phy_gbit_features_array[2];
70 extern const int phy_10gbit_features_array[1];
73 * Set phydev->irq to PHY_POLL if interrupts are not supported,
74 * or not desired for this PHY. Set to PHY_MAC_INTERRUPT if
75 * the attached MAC driver handles the interrupt
78 #define PHY_MAC_INTERRUPT -2
80 #define PHY_IS_INTERNAL 0x00000001
81 #define PHY_RST_AFTER_CLK_EN 0x00000002
82 #define PHY_POLL_CABLE_TEST 0x00000004
83 #define MDIO_DEVICE_IS_PHY 0x80000000
86 * enum phy_interface_t - Interface Mode definitions
88 * @PHY_INTERFACE_MODE_NA: Not Applicable - don't touch
89 * @PHY_INTERFACE_MODE_INTERNAL: No interface, MAC and PHY combined
90 * @PHY_INTERFACE_MODE_MII: Media-independent interface
91 * @PHY_INTERFACE_MODE_GMII: Gigabit media-independent interface
92 * @PHY_INTERFACE_MODE_SGMII: Serial gigabit media-independent interface
93 * @PHY_INTERFACE_MODE_TBI: Ten Bit Interface
94 * @PHY_INTERFACE_MODE_REVMII: Reverse Media Independent Interface
95 * @PHY_INTERFACE_MODE_RMII: Reduced Media Independent Interface
96 * @PHY_INTERFACE_MODE_REVRMII: Reduced Media Independent Interface in PHY role
97 * @PHY_INTERFACE_MODE_RGMII: Reduced gigabit media-independent interface
98 * @PHY_INTERFACE_MODE_RGMII_ID: RGMII with Internal RX+TX delay
99 * @PHY_INTERFACE_MODE_RGMII_RXID: RGMII with Internal RX delay
100 * @PHY_INTERFACE_MODE_RGMII_TXID: RGMII with Internal RX delay
101 * @PHY_INTERFACE_MODE_RTBI: Reduced TBI
102 * @PHY_INTERFACE_MODE_SMII: Serial MII
103 * @PHY_INTERFACE_MODE_XGMII: 10 gigabit media-independent interface
104 * @PHY_INTERFACE_MODE_XLGMII:40 gigabit media-independent interface
105 * @PHY_INTERFACE_MODE_MOCA: Multimedia over Coax
106 * @PHY_INTERFACE_MODE_QSGMII: Quad SGMII
107 * @PHY_INTERFACE_MODE_TRGMII: Turbo RGMII
108 * @PHY_INTERFACE_MODE_100BASEX: 100 BaseX
109 * @PHY_INTERFACE_MODE_1000BASEX: 1000 BaseX
110 * @PHY_INTERFACE_MODE_2500BASEX: 2500 BaseX
111 * @PHY_INTERFACE_MODE_5GBASER: 5G BaseR
112 * @PHY_INTERFACE_MODE_RXAUI: Reduced XAUI
113 * @PHY_INTERFACE_MODE_XAUI: 10 Gigabit Attachment Unit Interface
114 * @PHY_INTERFACE_MODE_10GBASER: 10G BaseR
115 * @PHY_INTERFACE_MODE_25GBASER: 25G BaseR
116 * @PHY_INTERFACE_MODE_USXGMII: Universal Serial 10GE MII
117 * @PHY_INTERFACE_MODE_10GKR: 10GBASE-KR - with Clause 73 AN
118 * @PHY_INTERFACE_MODE_QUSGMII: Quad Universal SGMII
119 * @PHY_INTERFACE_MODE_1000BASEKX: 1000Base-KX - with Clause 73 AN
120 * @PHY_INTERFACE_MODE_MAX: Book keeping
122 * Describes the interface between the MAC and PHY.
125 PHY_INTERFACE_MODE_NA,
126 PHY_INTERFACE_MODE_INTERNAL,
127 PHY_INTERFACE_MODE_MII,
128 PHY_INTERFACE_MODE_GMII,
129 PHY_INTERFACE_MODE_SGMII,
130 PHY_INTERFACE_MODE_TBI,
131 PHY_INTERFACE_MODE_REVMII,
132 PHY_INTERFACE_MODE_RMII,
133 PHY_INTERFACE_MODE_REVRMII,
134 PHY_INTERFACE_MODE_RGMII,
135 PHY_INTERFACE_MODE_RGMII_ID,
136 PHY_INTERFACE_MODE_RGMII_RXID,
137 PHY_INTERFACE_MODE_RGMII_TXID,
138 PHY_INTERFACE_MODE_RTBI,
139 PHY_INTERFACE_MODE_SMII,
140 PHY_INTERFACE_MODE_XGMII,
141 PHY_INTERFACE_MODE_XLGMII,
142 PHY_INTERFACE_MODE_MOCA,
143 PHY_INTERFACE_MODE_QSGMII,
144 PHY_INTERFACE_MODE_TRGMII,
145 PHY_INTERFACE_MODE_100BASEX,
146 PHY_INTERFACE_MODE_1000BASEX,
147 PHY_INTERFACE_MODE_2500BASEX,
148 PHY_INTERFACE_MODE_5GBASER,
149 PHY_INTERFACE_MODE_RXAUI,
150 PHY_INTERFACE_MODE_XAUI,
151 /* 10GBASE-R, XFI, SFI - single lane 10G Serdes */
152 PHY_INTERFACE_MODE_10GBASER,
153 PHY_INTERFACE_MODE_25GBASER,
154 PHY_INTERFACE_MODE_USXGMII,
155 /* 10GBASE-KR - with Clause 73 AN */
156 PHY_INTERFACE_MODE_10GKR,
157 PHY_INTERFACE_MODE_QUSGMII,
158 PHY_INTERFACE_MODE_1000BASEKX,
159 PHY_INTERFACE_MODE_MAX,
162 /* PHY interface mode bitmap handling */
163 #define DECLARE_PHY_INTERFACE_MASK(name) \
164 DECLARE_BITMAP(name, PHY_INTERFACE_MODE_MAX)
166 static inline void phy_interface_zero(unsigned long *intf)
168 bitmap_zero(intf, PHY_INTERFACE_MODE_MAX);
171 static inline bool phy_interface_empty(const unsigned long *intf)
173 return bitmap_empty(intf, PHY_INTERFACE_MODE_MAX);
176 static inline void phy_interface_and(unsigned long *dst, const unsigned long *a,
177 const unsigned long *b)
179 bitmap_and(dst, a, b, PHY_INTERFACE_MODE_MAX);
182 static inline void phy_interface_or(unsigned long *dst, const unsigned long *a,
183 const unsigned long *b)
185 bitmap_or(dst, a, b, PHY_INTERFACE_MODE_MAX);
188 static inline void phy_interface_set_rgmii(unsigned long *intf)
190 __set_bit(PHY_INTERFACE_MODE_RGMII, intf);
191 __set_bit(PHY_INTERFACE_MODE_RGMII_ID, intf);
192 __set_bit(PHY_INTERFACE_MODE_RGMII_RXID, intf);
193 __set_bit(PHY_INTERFACE_MODE_RGMII_TXID, intf);
197 * phy_supported_speeds - return all speeds currently supported by a PHY device
199 unsigned int phy_supported_speeds(struct phy_device *phy,
200 unsigned int *speeds,
204 * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
205 * @interface: enum phy_interface_t value
207 * Description: maps enum &phy_interface_t defined in this file
208 * into the device tree binding of 'phy-mode', so that Ethernet
209 * device driver can get PHY interface from device tree.
211 static inline const char *phy_modes(phy_interface_t interface)
214 case PHY_INTERFACE_MODE_NA:
216 case PHY_INTERFACE_MODE_INTERNAL:
218 case PHY_INTERFACE_MODE_MII:
220 case PHY_INTERFACE_MODE_GMII:
222 case PHY_INTERFACE_MODE_SGMII:
224 case PHY_INTERFACE_MODE_TBI:
226 case PHY_INTERFACE_MODE_REVMII:
228 case PHY_INTERFACE_MODE_RMII:
230 case PHY_INTERFACE_MODE_REVRMII:
232 case PHY_INTERFACE_MODE_RGMII:
234 case PHY_INTERFACE_MODE_RGMII_ID:
236 case PHY_INTERFACE_MODE_RGMII_RXID:
238 case PHY_INTERFACE_MODE_RGMII_TXID:
240 case PHY_INTERFACE_MODE_RTBI:
242 case PHY_INTERFACE_MODE_SMII:
244 case PHY_INTERFACE_MODE_XGMII:
246 case PHY_INTERFACE_MODE_XLGMII:
248 case PHY_INTERFACE_MODE_MOCA:
250 case PHY_INTERFACE_MODE_QSGMII:
252 case PHY_INTERFACE_MODE_TRGMII:
254 case PHY_INTERFACE_MODE_1000BASEX:
256 case PHY_INTERFACE_MODE_1000BASEKX:
257 return "1000base-kx";
258 case PHY_INTERFACE_MODE_2500BASEX:
260 case PHY_INTERFACE_MODE_5GBASER:
262 case PHY_INTERFACE_MODE_RXAUI:
264 case PHY_INTERFACE_MODE_XAUI:
266 case PHY_INTERFACE_MODE_10GBASER:
268 case PHY_INTERFACE_MODE_25GBASER:
270 case PHY_INTERFACE_MODE_USXGMII:
272 case PHY_INTERFACE_MODE_10GKR:
274 case PHY_INTERFACE_MODE_100BASEX:
276 case PHY_INTERFACE_MODE_QUSGMII:
283 #define PHY_INIT_TIMEOUT 100000
284 #define PHY_FORCE_TIMEOUT 10
286 #define PHY_MAX_ADDR 32
288 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
289 #define PHY_ID_FMT "%s:%02x"
291 #define MII_BUS_ID_SIZE 61
296 struct sfp_upstream_ops;
300 * struct mdio_bus_stats - Statistics counters for MDIO busses
301 * @transfers: Total number of transfers, i.e. @writes + @reads
302 * @errors: Number of MDIO transfers that returned an error
303 * @writes: Number of write transfers
304 * @reads: Number of read transfers
305 * @syncp: Synchronisation for incrementing statistics
307 struct mdio_bus_stats {
308 u64_stats_t transfers;
312 /* Must be last, add new statistics above */
313 struct u64_stats_sync syncp;
317 * struct phy_package_shared - Shared information in PHY packages
318 * @addr: Common PHY address used to combine PHYs in one package
319 * @refcnt: Number of PHYs connected to this shared data
320 * @flags: Initialization of PHY package
321 * @priv_size: Size of the shared private data @priv
322 * @priv: Driver private data shared across a PHY package
324 * Represents a shared structure between different phydev's in the same
325 * package, for example a quad PHY. See phy_package_join() and
326 * phy_package_leave().
328 struct phy_package_shared {
334 /* private data pointer */
335 /* note that this pointer is shared between different phydevs and
336 * the user has to take care of appropriate locking. It is allocated
337 * and freed automatically by phy_package_join() and
338 * phy_package_leave().
343 /* used as bit number in atomic bitops */
344 #define PHY_SHARED_F_INIT_DONE 0
345 #define PHY_SHARED_F_PROBE_DONE 1
348 * struct mii_bus - Represents an MDIO bus
350 * @owner: Who owns this device
351 * @name: User friendly name for this MDIO device, or driver name
352 * @id: Unique identifier for this bus, typical from bus hierarchy
353 * @priv: Driver private data
355 * The Bus class for PHYs. Devices which provide access to
356 * PHYs should register using this structure
359 struct module *owner;
361 char id[MII_BUS_ID_SIZE];
363 /** @read: Perform a read transfer on the bus */
364 int (*read)(struct mii_bus *bus, int addr, int regnum);
365 /** @write: Perform a write transfer on the bus */
366 int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
367 /** @reset: Perform a reset of the bus */
368 int (*reset)(struct mii_bus *bus);
370 /** @stats: Statistic counters per device on the bus */
371 struct mdio_bus_stats stats[PHY_MAX_ADDR];
374 * @mdio_lock: A lock to ensure that only one thing can read/write
375 * the MDIO bus at a time
377 struct mutex mdio_lock;
379 /** @parent: Parent device of this bus */
380 struct device *parent;
381 /** @state: State of bus structure */
383 MDIOBUS_ALLOCATED = 1,
385 MDIOBUS_UNREGISTERED,
389 /** @dev: Kernel device representation */
392 /** @mdio_map: list of all MDIO devices on bus */
393 struct mdio_device *mdio_map[PHY_MAX_ADDR];
395 /** @phy_mask: PHY addresses to be ignored when probing */
398 /** @phy_ignore_ta_mask: PHY addresses to ignore the TA/read failure */
399 u32 phy_ignore_ta_mask;
402 * @irq: An array of interrupts, each PHY's interrupt at the index
403 * matching its address
405 int irq[PHY_MAX_ADDR];
407 /** @reset_delay_us: GPIO reset pulse width in microseconds */
409 /** @reset_post_delay_us: GPIO reset deassert delay in microseconds */
410 int reset_post_delay_us;
411 /** @reset_gpiod: Reset GPIO descriptor pointer */
412 struct gpio_desc *reset_gpiod;
414 /** @probe_capabilities: bus capabilities, used for probing */
420 } probe_capabilities;
422 /** @shared_lock: protect access to the shared element */
423 struct mutex shared_lock;
425 /** @shared: shared state across different PHYs */
426 struct phy_package_shared *shared[PHY_MAX_ADDR];
428 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
430 struct mii_bus *mdiobus_alloc_size(size_t size);
433 * mdiobus_alloc - Allocate an MDIO bus structure
435 * The internal state of the MDIO bus will be set of MDIOBUS_ALLOCATED ready
436 * for the driver to register the bus.
438 static inline struct mii_bus *mdiobus_alloc(void)
440 return mdiobus_alloc_size(0);
443 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
444 int __devm_mdiobus_register(struct device *dev, struct mii_bus *bus,
445 struct module *owner);
446 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
447 #define devm_mdiobus_register(dev, bus) \
448 __devm_mdiobus_register(dev, bus, THIS_MODULE)
450 void mdiobus_unregister(struct mii_bus *bus);
451 void mdiobus_free(struct mii_bus *bus);
452 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
453 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
455 return devm_mdiobus_alloc_size(dev, 0);
458 struct mii_bus *mdio_find_bus(const char *mdio_name);
459 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
461 #define PHY_INTERRUPT_DISABLED false
462 #define PHY_INTERRUPT_ENABLED true
465 * enum phy_state - PHY state machine states:
467 * @PHY_DOWN: PHY device and driver are not ready for anything. probe
468 * should be called if and only if the PHY is in this state,
469 * given that the PHY device exists.
470 * - PHY driver probe function will set the state to @PHY_READY
472 * @PHY_READY: PHY is ready to send and receive packets, but the
473 * controller is not. By default, PHYs which do not implement
474 * probe will be set to this state by phy_probe().
475 * - start will set the state to UP
477 * @PHY_UP: The PHY and attached device are ready to do work.
478 * Interrupts should be started here.
479 * - timer moves to @PHY_NOLINK or @PHY_RUNNING
481 * @PHY_NOLINK: PHY is up, but not currently plugged in.
482 * - irq or timer will set @PHY_RUNNING if link comes back
483 * - phy_stop moves to @PHY_HALTED
485 * @PHY_RUNNING: PHY is currently up, running, and possibly sending
486 * and/or receiving packets
487 * - irq or timer will set @PHY_NOLINK if link goes down
488 * - phy_stop moves to @PHY_HALTED
490 * @PHY_CABLETEST: PHY is performing a cable test. Packet reception/sending
491 * is not expected to work, carrier will be indicated as down. PHY will be
492 * poll once per second, or on interrupt for it current state.
493 * Once complete, move to UP to restart the PHY.
494 * - phy_stop aborts the running test and moves to @PHY_HALTED
496 * @PHY_HALTED: PHY is up, but no polling or interrupts are done. Or
497 * PHY is in an error state.
498 * - phy_start moves to @PHY_UP
510 #define MDIO_MMD_NUM 32
513 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
514 * @devices_in_package: IEEE 802.3 devices in package register value.
515 * @mmds_present: bit vector of MMDs present.
516 * @device_ids: The device identifer for each present device.
518 struct phy_c45_device_ids {
519 u32 devices_in_package;
521 u32 device_ids[MDIO_MMD_NUM];
524 struct macsec_context;
528 * struct phy_device - An instance of a PHY
530 * @mdio: MDIO bus this PHY is on
531 * @drv: Pointer to the driver for this PHY instance
532 * @phy_id: UID for this device found during discovery
533 * @c45_ids: 802.3-c45 Device Identifiers if is_c45.
534 * @is_c45: Set to true if this PHY uses clause 45 addressing.
535 * @is_internal: Set to true if this PHY is internal to a MAC.
536 * @is_pseudo_fixed_link: Set to true if this PHY is an Ethernet switch, etc.
537 * @is_gigabit_capable: Set to true if PHY supports 1000Mbps
538 * @has_fixups: Set to true if this PHY has fixups/quirks.
539 * @suspended: Set to true if this PHY has been suspended successfully.
540 * @suspended_by_mdio_bus: Set to true if this PHY was suspended by MDIO bus.
541 * @sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
542 * @loopback_enabled: Set true if this PHY has been loopbacked successfully.
543 * @downshifted_rate: Set true if link speed has been downshifted.
544 * @is_on_sfp_module: Set true if PHY is located on an SFP module.
545 * @mac_managed_pm: Set true if MAC driver takes of suspending/resuming PHY
546 * @state: State of the PHY for management purposes
547 * @dev_flags: Device-specific flags used by the PHY driver.
549 * - Bits [15:0] are free to use by the PHY driver to communicate
550 * driver specific behavior.
551 * - Bits [23:16] are currently reserved for future use.
552 * - Bits [31:24] are reserved for defining generic
553 * PHY driver behavior.
554 * @irq: IRQ number of the PHY's interrupt (-1 if none)
555 * @phy_timer: The timer for handling the state machine
556 * @phylink: Pointer to phylink instance for this PHY
557 * @sfp_bus_attached: Flag indicating whether the SFP bus has been attached
558 * @sfp_bus: SFP bus attached to this PHY's fiber port
559 * @attached_dev: The attached enet driver's device instance ptr
560 * @adjust_link: Callback for the enet controller to respond to changes: in the
562 * @phy_link_change: Callback for phylink for notification of link change
563 * @macsec_ops: MACsec offloading ops.
565 * @speed: Current link speed
566 * @duplex: Current duplex
567 * @port: Current port
568 * @pause: Current pause
569 * @asym_pause: Current asymmetric pause
570 * @supported: Combined MAC/PHY supported linkmodes
571 * @advertising: Currently advertised linkmodes
572 * @adv_old: Saved advertised while power saving for WoL
573 * @lp_advertising: Current link partner advertised linkmodes
574 * @host_interfaces: PHY interface modes supported by host
575 * @eee_broken_modes: Energy efficient ethernet modes which should be prohibited
576 * @autoneg: Flag autoneg being used
577 * @rate_matching: Current rate matching mode
578 * @link: Current link state
579 * @autoneg_complete: Flag auto negotiation of the link has completed
580 * @mdix: Current crossover
581 * @mdix_ctrl: User setting of crossover
582 * @pma_extable: Cached value of PMA/PMD Extended Abilities Register
583 * @interrupts: Flag interrupts have been enabled
584 * @irq_suspended: Flag indicating PHY is suspended and therefore interrupt
585 * handling shall be postponed until PHY has resumed
586 * @irq_rerun: Flag indicating interrupts occurred while PHY was suspended,
587 * requiring a rerun of the interrupt handler after resume
588 * @interface: enum phy_interface_t value
589 * @skb: Netlink message for cable diagnostics
590 * @nest: Netlink nest used for cable diagnostics
591 * @ehdr: nNtlink header for cable diagnostics
592 * @phy_led_triggers: Array of LED triggers
593 * @phy_num_led_triggers: Number of triggers in @phy_led_triggers
594 * @led_link_trigger: LED trigger for link up/down
595 * @last_triggered: last LED trigger for link speed
596 * @master_slave_set: User requested master/slave configuration
597 * @master_slave_get: Current master/slave advertisement
598 * @master_slave_state: Current master/slave configuration
599 * @mii_ts: Pointer to time stamper callbacks
600 * @psec: Pointer to Power Sourcing Equipment control struct
601 * @lock: Mutex for serialization access to PHY
602 * @state_queue: Work queue for state machine
603 * @shared: Pointer to private data shared by phys in one package
604 * @priv: Pointer to driver private data
606 * interrupts currently only supports enabled or disabled,
607 * but could be changed in the future to support enabling
608 * and disabling specific interrupts
610 * Contains some infrastructure for polling and interrupt
611 * handling, as well as handling shifts in PHY hardware state
614 struct mdio_device mdio;
616 /* Information about the PHY type */
617 /* And management functions */
618 struct phy_driver *drv;
622 struct phy_c45_device_ids c45_ids;
624 unsigned is_internal:1;
625 unsigned is_pseudo_fixed_link:1;
626 unsigned is_gigabit_capable:1;
627 unsigned has_fixups:1;
628 unsigned suspended:1;
629 unsigned suspended_by_mdio_bus:1;
630 unsigned sysfs_links:1;
631 unsigned loopback_enabled:1;
632 unsigned downshifted_rate:1;
633 unsigned is_on_sfp_module:1;
634 unsigned mac_managed_pm:1;
637 /* The most recently read link state */
639 unsigned autoneg_complete:1;
641 /* Interrupts are enabled */
642 unsigned interrupts:1;
643 unsigned irq_suspended:1;
644 unsigned irq_rerun:1;
648 enum phy_state state;
652 phy_interface_t interface;
655 * forced speed & duplex (no autoneg)
656 * partner speed & duplex & pause (autoneg)
665 u8 master_slave_state;
667 /* Union of PHY and Attached devices' supported link modes */
668 /* See ethtool.h for more info */
669 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
670 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
671 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
672 /* used with phy_speed_down */
673 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
675 /* Host supported PHY interface types. Should be ignored if empty. */
676 DECLARE_PHY_INTERFACE_MASK(host_interfaces);
678 /* Energy efficient ethernet modes which should be prohibited */
679 u32 eee_broken_modes;
681 #ifdef CONFIG_LED_TRIGGER_PHY
682 struct phy_led_trigger *phy_led_triggers;
683 unsigned int phy_num_led_triggers;
684 struct phy_led_trigger *last_triggered;
686 struct phy_led_trigger *led_link_trigger;
690 * Interrupt number for this PHY
691 * -1 means no interrupt
695 /* private data pointer */
696 /* For use by PHYs to maintain extra state */
699 /* shared data pointer */
700 /* For use by PHYs inside the same package that need a shared state. */
701 struct phy_package_shared *shared;
703 /* Reporting cable test results */
708 /* Interrupt and Polling infrastructure */
709 struct delayed_work state_queue;
713 /* This may be modified under the rtnl lock */
714 bool sfp_bus_attached;
715 struct sfp_bus *sfp_bus;
716 struct phylink *phylink;
717 struct net_device *attached_dev;
718 struct mii_timestamper *mii_ts;
719 struct pse_control *psec;
726 void (*phy_link_change)(struct phy_device *phydev, bool up);
727 void (*adjust_link)(struct net_device *dev);
729 #if IS_ENABLED(CONFIG_MACSEC)
730 /* MACsec management functions */
731 const struct macsec_ops *macsec_ops;
735 static inline struct phy_device *to_phy_device(const struct device *dev)
737 return container_of(to_mdio_device(dev), struct phy_device, mdio);
741 * struct phy_tdr_config - Configuration of a TDR raw test
743 * @first: Distance for first data collection point
744 * @last: Distance for last data collection point
745 * @step: Step between data collection points
746 * @pair: Bitmap of cable pairs to collect data for
748 * A structure containing possible configuration parameters
749 * for a TDR cable test. The driver does not need to implement
750 * all the parameters, but should report what is actually used.
751 * All distances are in centimeters.
753 struct phy_tdr_config {
759 #define PHY_PAIR_ALL -1
762 * struct phy_driver - Driver structure for a particular PHY type
764 * @mdiodrv: Data common to all MDIO devices
765 * @phy_id: The result of reading the UID registers of this PHY
766 * type, and ANDing them with the phy_id_mask. This driver
767 * only works for PHYs with IDs which match this field
768 * @name: The friendly name of this PHY type
769 * @phy_id_mask: Defines the important bits of the phy_id
770 * @features: A mandatory list of features (speed, duplex, etc)
771 * supported by this PHY
772 * @flags: A bitfield defining certain other features this PHY
773 * supports (like interrupts)
774 * @driver_data: Static driver data
776 * All functions are optional. If config_aneg or read_status
777 * are not implemented, the phy core uses the genphy versions.
778 * Note that none of these functions should be called from
779 * interrupt time. The goal is for the bus read/write functions
780 * to be able to block when the bus transaction is happening,
781 * and be freed up by an interrupt (The MPC85xx has this ability,
782 * though it is not currently supported in the driver).
785 struct mdio_driver_common mdiodrv;
789 const unsigned long * const features;
791 const void *driver_data;
794 * @soft_reset: Called to issue a PHY software reset
796 int (*soft_reset)(struct phy_device *phydev);
799 * @config_init: Called to initialize the PHY,
800 * including after a reset
802 int (*config_init)(struct phy_device *phydev);
805 * @probe: Called during discovery. Used to set
806 * up device-specific structures, if any
808 int (*probe)(struct phy_device *phydev);
811 * @get_features: Probe the hardware to determine what
812 * abilities it has. Should only set phydev->supported.
814 int (*get_features)(struct phy_device *phydev);
817 * @get_rate_matching: Get the supported type of rate matching for a
818 * particular phy interface. This is used by phy consumers to determine
819 * whether to advertise lower-speed modes for that interface. It is
820 * assumed that if a rate matching mode is supported on an interface,
821 * then that interface's rate can be adapted to all slower link speeds
822 * supported by the phy. If iface is %PHY_INTERFACE_MODE_NA, and the phy
823 * supports any kind of rate matching for any interface, then it must
824 * return that rate matching mode (preferring %RATE_MATCH_PAUSE to
825 * %RATE_MATCH_CRS). If the interface is not supported, this should
826 * return %RATE_MATCH_NONE.
828 int (*get_rate_matching)(struct phy_device *phydev,
829 phy_interface_t iface);
831 /* PHY Power Management */
832 /** @suspend: Suspend the hardware, saving state if needed */
833 int (*suspend)(struct phy_device *phydev);
834 /** @resume: Resume the hardware, restoring state if needed */
835 int (*resume)(struct phy_device *phydev);
838 * @config_aneg: Configures the advertisement and resets
839 * autonegotiation if phydev->autoneg is on,
840 * forces the speed to the current settings in phydev
841 * if phydev->autoneg is off
843 int (*config_aneg)(struct phy_device *phydev);
845 /** @aneg_done: Determines the auto negotiation result */
846 int (*aneg_done)(struct phy_device *phydev);
848 /** @read_status: Determines the negotiated speed and duplex */
849 int (*read_status)(struct phy_device *phydev);
852 * @config_intr: Enables or disables interrupts.
853 * It should also clear any pending interrupts prior to enabling the
854 * IRQs and after disabling them.
856 int (*config_intr)(struct phy_device *phydev);
858 /** @handle_interrupt: Override default interrupt handling */
859 irqreturn_t (*handle_interrupt)(struct phy_device *phydev);
861 /** @remove: Clears up any memory if needed */
862 void (*remove)(struct phy_device *phydev);
865 * @match_phy_device: Returns true if this is a suitable
866 * driver for the given phydev. If NULL, matching is based on
867 * phy_id and phy_id_mask.
869 int (*match_phy_device)(struct phy_device *phydev);
872 * @set_wol: Some devices (e.g. qnap TS-119P II) require PHY
873 * register changes to enable Wake on LAN, so set_wol is
874 * provided to be called in the ethernet driver's set_wol
877 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
880 * @get_wol: See set_wol, but for checking whether Wake on LAN
883 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
886 * @link_change_notify: Called to inform a PHY device driver
887 * when the core is about to change the link state. This
888 * callback is supposed to be used as fixup hook for drivers
889 * that need to take action when the link state
890 * changes. Drivers are by no means allowed to mess with the
891 * PHY device structure in their implementations.
893 void (*link_change_notify)(struct phy_device *dev);
896 * @read_mmd: PHY specific driver override for reading a MMD
897 * register. This function is optional for PHY specific
898 * drivers. When not provided, the default MMD read function
899 * will be used by phy_read_mmd(), which will use either a
900 * direct read for Clause 45 PHYs or an indirect read for
901 * Clause 22 PHYs. devnum is the MMD device number within the
902 * PHY device, regnum is the register within the selected MMD
905 int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
908 * @write_mmd: PHY specific driver override for writing a MMD
909 * register. This function is optional for PHY specific
910 * drivers. When not provided, the default MMD write function
911 * will be used by phy_write_mmd(), which will use either a
912 * direct write for Clause 45 PHYs, or an indirect write for
913 * Clause 22 PHYs. devnum is the MMD device number within the
914 * PHY device, regnum is the register within the selected MMD
915 * device. val is the value to be written.
917 int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
920 /** @read_page: Return the current PHY register page number */
921 int (*read_page)(struct phy_device *dev);
922 /** @write_page: Set the current PHY register page number */
923 int (*write_page)(struct phy_device *dev, int page);
926 * @module_info: Get the size and type of the eeprom contained
927 * within a plug-in module
929 int (*module_info)(struct phy_device *dev,
930 struct ethtool_modinfo *modinfo);
933 * @module_eeprom: Get the eeprom information from the plug-in
936 int (*module_eeprom)(struct phy_device *dev,
937 struct ethtool_eeprom *ee, u8 *data);
939 /** @cable_test_start: Start a cable test */
940 int (*cable_test_start)(struct phy_device *dev);
942 /** @cable_test_tdr_start: Start a raw TDR cable test */
943 int (*cable_test_tdr_start)(struct phy_device *dev,
944 const struct phy_tdr_config *config);
947 * @cable_test_get_status: Once per second, or on interrupt,
948 * request the status of the test.
950 int (*cable_test_get_status)(struct phy_device *dev, bool *finished);
952 /* Get statistics from the PHY using ethtool */
953 /** @get_sset_count: Number of statistic counters */
954 int (*get_sset_count)(struct phy_device *dev);
955 /** @get_strings: Names of the statistic counters */
956 void (*get_strings)(struct phy_device *dev, u8 *data);
957 /** @get_stats: Return the statistic counter values */
958 void (*get_stats)(struct phy_device *dev,
959 struct ethtool_stats *stats, u64 *data);
961 /* Get and Set PHY tunables */
962 /** @get_tunable: Return the value of a tunable */
963 int (*get_tunable)(struct phy_device *dev,
964 struct ethtool_tunable *tuna, void *data);
965 /** @set_tunable: Set the value of a tunable */
966 int (*set_tunable)(struct phy_device *dev,
967 struct ethtool_tunable *tuna,
969 /** @set_loopback: Set the loopback mood of the PHY */
970 int (*set_loopback)(struct phy_device *dev, bool enable);
971 /** @get_sqi: Get the signal quality indication */
972 int (*get_sqi)(struct phy_device *dev);
973 /** @get_sqi_max: Get the maximum signal quality indication */
974 int (*get_sqi_max)(struct phy_device *dev);
976 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \
977 struct phy_driver, mdiodrv)
979 #define PHY_ANY_ID "MATCH ANY PHY"
980 #define PHY_ANY_UID 0xffffffff
982 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
983 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
984 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
986 /* A Structure for boards to register fixups with the PHY Lib */
988 struct list_head list;
989 char bus_id[MII_BUS_ID_SIZE + 3];
992 int (*run)(struct phy_device *phydev);
995 const char *phy_speed_to_str(int speed);
996 const char *phy_duplex_to_str(unsigned int duplex);
997 const char *phy_rate_matching_to_str(int rate_matching);
999 int phy_interface_num_ports(phy_interface_t interface);
1001 /* A structure for mapping a particular speed and duplex
1002 * combination to a particular SUPPORTED and ADVERTISED value
1004 struct phy_setting {
1010 const struct phy_setting *
1011 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
1013 size_t phy_speeds(unsigned int *speeds, size_t size,
1014 unsigned long *mask);
1015 void of_set_phy_supported(struct phy_device *phydev);
1016 void of_set_phy_eee_broken(struct phy_device *phydev);
1017 int phy_speed_down_core(struct phy_device *phydev);
1020 * phy_is_started - Convenience function to check whether PHY is started
1021 * @phydev: The phy_device struct
1023 static inline bool phy_is_started(struct phy_device *phydev)
1025 return phydev->state >= PHY_UP;
1028 void phy_resolve_aneg_pause(struct phy_device *phydev);
1029 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
1030 void phy_check_downshift(struct phy_device *phydev);
1033 * phy_read - Convenience function for reading a given PHY register
1034 * @phydev: the phy_device struct
1035 * @regnum: register number to read
1037 * NOTE: MUST NOT be called from interrupt context,
1038 * because the bus read/write functions may wait for an interrupt
1039 * to conclude the operation.
1041 static inline int phy_read(struct phy_device *phydev, u32 regnum)
1043 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
1046 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \
1047 timeout_us, sleep_before_read) \
1049 int __ret = read_poll_timeout(phy_read, val, (cond) || val < 0, \
1050 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \
1054 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1060 * __phy_read - convenience function for reading a given PHY register
1061 * @phydev: the phy_device struct
1062 * @regnum: register number to read
1064 * The caller must have taken the MDIO bus lock.
1066 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
1068 return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
1072 * phy_write - Convenience function for writing a given PHY register
1073 * @phydev: the phy_device struct
1074 * @regnum: register number to write
1075 * @val: value to write to @regnum
1077 * NOTE: MUST NOT be called from interrupt context,
1078 * because the bus read/write functions may wait for an interrupt
1079 * to conclude the operation.
1081 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1083 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
1087 * __phy_write - Convenience function for writing a given PHY register
1088 * @phydev: the phy_device struct
1089 * @regnum: register number to write
1090 * @val: value to write to @regnum
1092 * The caller must have taken the MDIO bus lock.
1094 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1096 return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
1101 * __phy_modify_changed() - Convenience function for modifying a PHY register
1102 * @phydev: a pointer to a &struct phy_device
1103 * @regnum: register number
1104 * @mask: bit mask of bits to clear
1105 * @set: bit mask of bits to set
1107 * Unlocked helper function which allows a PHY register to be modified as
1108 * new register value = (old register value & ~mask) | set
1110 * Returns negative errno, 0 if there was no change, and 1 in case of change
1112 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
1115 return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr,
1120 * phy_read_mmd - Convenience function for reading a register
1121 * from an MMD on a given PHY.
1123 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1126 * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
1127 * condition is met or a timeout occurs
1129 * @phydev: The phy_device struct
1130 * @devaddr: The MMD to read from
1131 * @regnum: The register on the MMD to read
1132 * @val: Variable to read the register into
1133 * @cond: Break condition (usually involving @val)
1134 * @sleep_us: Maximum time to sleep between reads in us (0
1135 * tight-loops). Should be less than ~20ms since usleep_range
1136 * is used (see Documentation/timers/timers-howto.rst).
1137 * @timeout_us: Timeout in us, 0 means never timeout
1138 * @sleep_before_read: if it is true, sleep @sleep_us before read.
1139 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
1140 * case, the last read value at @args is stored in @val. Must not
1141 * be called from atomic context if sleep_us or timeout_us are used.
1143 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
1144 sleep_us, timeout_us, sleep_before_read) \
1146 int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
1147 sleep_us, timeout_us, sleep_before_read, \
1148 phydev, devaddr, regnum); \
1152 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1157 * __phy_read_mmd - Convenience function for reading a register
1158 * from an MMD on a given PHY.
1160 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1163 * phy_write_mmd - Convenience function for writing a register
1164 * on an MMD on a given PHY.
1166 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1169 * __phy_write_mmd - Convenience function for writing a register
1170 * on an MMD on a given PHY.
1172 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1174 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1176 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1178 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1179 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1181 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1183 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1185 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1187 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1191 * __phy_set_bits - Convenience function for setting bits in a PHY register
1192 * @phydev: the phy_device struct
1193 * @regnum: register number to write
1196 * The caller must have taken the MDIO bus lock.
1198 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1200 return __phy_modify(phydev, regnum, 0, val);
1204 * __phy_clear_bits - Convenience function for clearing bits in a PHY register
1205 * @phydev: the phy_device struct
1206 * @regnum: register number to write
1207 * @val: bits to clear
1209 * The caller must have taken the MDIO bus lock.
1211 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
1214 return __phy_modify(phydev, regnum, val, 0);
1218 * phy_set_bits - Convenience function for setting bits in a PHY register
1219 * @phydev: the phy_device struct
1220 * @regnum: register number to write
1223 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1225 return phy_modify(phydev, regnum, 0, val);
1229 * phy_clear_bits - Convenience function for clearing bits in a PHY register
1230 * @phydev: the phy_device struct
1231 * @regnum: register number to write
1232 * @val: bits to clear
1234 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
1236 return phy_modify(phydev, regnum, val, 0);
1240 * __phy_set_bits_mmd - Convenience function for setting bits in a register
1242 * @phydev: the phy_device struct
1243 * @devad: the MMD containing register to modify
1244 * @regnum: register number to modify
1247 * The caller must have taken the MDIO bus lock.
1249 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
1250 u32 regnum, u16 val)
1252 return __phy_modify_mmd(phydev, devad, regnum, 0, val);
1256 * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
1258 * @phydev: the phy_device struct
1259 * @devad: the MMD containing register to modify
1260 * @regnum: register number to modify
1261 * @val: bits to clear
1263 * The caller must have taken the MDIO bus lock.
1265 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1266 u32 regnum, u16 val)
1268 return __phy_modify_mmd(phydev, devad, regnum, val, 0);
1272 * phy_set_bits_mmd - Convenience function for setting bits in a register
1274 * @phydev: the phy_device struct
1275 * @devad: the MMD containing register to modify
1276 * @regnum: register number to modify
1279 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
1280 u32 regnum, u16 val)
1282 return phy_modify_mmd(phydev, devad, regnum, 0, val);
1286 * phy_clear_bits_mmd - Convenience function for clearing bits in a register
1288 * @phydev: the phy_device struct
1289 * @devad: the MMD containing register to modify
1290 * @regnum: register number to modify
1291 * @val: bits to clear
1293 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1294 u32 regnum, u16 val)
1296 return phy_modify_mmd(phydev, devad, regnum, val, 0);
1300 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
1301 * @phydev: the phy_device struct
1303 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
1306 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
1308 return phydev->irq != PHY_POLL && phydev->irq != PHY_MAC_INTERRUPT;
1312 * phy_polling_mode - Convenience function for testing whether polling is
1313 * used to detect PHY status changes
1314 * @phydev: the phy_device struct
1316 static inline bool phy_polling_mode(struct phy_device *phydev)
1318 if (phydev->state == PHY_CABLETEST)
1319 if (phydev->drv->flags & PHY_POLL_CABLE_TEST)
1322 return phydev->irq == PHY_POLL;
1326 * phy_has_hwtstamp - Tests whether a PHY time stamp configuration.
1327 * @phydev: the phy_device struct
1329 static inline bool phy_has_hwtstamp(struct phy_device *phydev)
1331 return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp;
1335 * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping.
1336 * @phydev: the phy_device struct
1338 static inline bool phy_has_rxtstamp(struct phy_device *phydev)
1340 return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp;
1344 * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or
1345 * PTP hardware clock capabilities.
1346 * @phydev: the phy_device struct
1348 static inline bool phy_has_tsinfo(struct phy_device *phydev)
1350 return phydev && phydev->mii_ts && phydev->mii_ts->ts_info;
1354 * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping.
1355 * @phydev: the phy_device struct
1357 static inline bool phy_has_txtstamp(struct phy_device *phydev)
1359 return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp;
1362 static inline int phy_hwtstamp(struct phy_device *phydev, struct ifreq *ifr)
1364 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
1367 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb,
1370 return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type);
1373 static inline int phy_ts_info(struct phy_device *phydev,
1374 struct ethtool_ts_info *tsinfo)
1376 return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo);
1379 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb,
1382 phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type);
1386 * phy_is_internal - Convenience function for testing if a PHY is internal
1387 * @phydev: the phy_device struct
1389 static inline bool phy_is_internal(struct phy_device *phydev)
1391 return phydev->is_internal;
1395 * phy_on_sfp - Convenience function for testing if a PHY is on an SFP module
1396 * @phydev: the phy_device struct
1398 static inline bool phy_on_sfp(struct phy_device *phydev)
1400 return phydev->is_on_sfp_module;
1404 * phy_interface_mode_is_rgmii - Convenience function for testing if a
1405 * PHY interface mode is RGMII (all variants)
1406 * @mode: the &phy_interface_t enum
1408 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
1410 return mode >= PHY_INTERFACE_MODE_RGMII &&
1411 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
1415 * phy_interface_mode_is_8023z() - does the PHY interface mode use 802.3z
1417 * @mode: one of &enum phy_interface_t
1419 * Returns true if the PHY interface mode uses the 16-bit negotiation
1420 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
1422 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
1424 return mode == PHY_INTERFACE_MODE_1000BASEX ||
1425 mode == PHY_INTERFACE_MODE_2500BASEX;
1429 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
1430 * is RGMII (all variants)
1431 * @phydev: the phy_device struct
1433 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
1435 return phy_interface_mode_is_rgmii(phydev->interface);
1439 * phy_is_pseudo_fixed_link - Convenience function for testing if this
1440 * PHY is the CPU port facing side of an Ethernet switch, or similar.
1441 * @phydev: the phy_device struct
1443 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
1445 return phydev->is_pseudo_fixed_link;
1448 int phy_save_page(struct phy_device *phydev);
1449 int phy_select_page(struct phy_device *phydev, int page);
1450 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
1451 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
1452 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
1453 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum,
1455 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
1458 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
1460 struct phy_c45_device_ids *c45_ids);
1461 #if IS_ENABLED(CONFIG_PHYLIB)
1462 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id);
1463 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode);
1464 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode);
1465 struct phy_device *device_phy_find_device(struct device *dev);
1466 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode);
1467 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
1468 int phy_device_register(struct phy_device *phy);
1469 void phy_device_free(struct phy_device *phydev);
1471 static inline int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
1476 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
1482 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
1487 static inline struct phy_device *device_phy_find_device(struct device *dev)
1493 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode)
1499 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1504 static inline int phy_device_register(struct phy_device *phy)
1509 static inline void phy_device_free(struct phy_device *phydev) { }
1510 #endif /* CONFIG_PHYLIB */
1511 void phy_device_remove(struct phy_device *phydev);
1512 int phy_get_c45_ids(struct phy_device *phydev);
1513 int phy_init_hw(struct phy_device *phydev);
1514 int phy_suspend(struct phy_device *phydev);
1515 int phy_resume(struct phy_device *phydev);
1516 int __phy_resume(struct phy_device *phydev);
1517 int phy_loopback(struct phy_device *phydev, bool enable);
1518 void phy_sfp_attach(void *upstream, struct sfp_bus *bus);
1519 void phy_sfp_detach(void *upstream, struct sfp_bus *bus);
1520 int phy_sfp_probe(struct phy_device *phydev,
1521 const struct sfp_upstream_ops *ops);
1522 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1523 phy_interface_t interface);
1524 struct phy_device *phy_find_first(struct mii_bus *bus);
1525 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1526 u32 flags, phy_interface_t interface);
1527 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1528 void (*handler)(struct net_device *),
1529 phy_interface_t interface);
1530 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1531 void (*handler)(struct net_device *),
1532 phy_interface_t interface);
1533 void phy_disconnect(struct phy_device *phydev);
1534 void phy_detach(struct phy_device *phydev);
1535 void phy_start(struct phy_device *phydev);
1536 void phy_stop(struct phy_device *phydev);
1537 int phy_config_aneg(struct phy_device *phydev);
1538 int phy_start_aneg(struct phy_device *phydev);
1539 int phy_aneg_done(struct phy_device *phydev);
1540 int phy_speed_down(struct phy_device *phydev, bool sync);
1541 int phy_speed_up(struct phy_device *phydev);
1543 int phy_restart_aneg(struct phy_device *phydev);
1544 int phy_reset_after_clk_enable(struct phy_device *phydev);
1546 #if IS_ENABLED(CONFIG_PHYLIB)
1547 int phy_start_cable_test(struct phy_device *phydev,
1548 struct netlink_ext_ack *extack);
1549 int phy_start_cable_test_tdr(struct phy_device *phydev,
1550 struct netlink_ext_ack *extack,
1551 const struct phy_tdr_config *config);
1554 int phy_start_cable_test(struct phy_device *phydev,
1555 struct netlink_ext_ack *extack)
1557 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1561 int phy_start_cable_test_tdr(struct phy_device *phydev,
1562 struct netlink_ext_ack *extack,
1563 const struct phy_tdr_config *config)
1565 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1570 int phy_cable_test_result(struct phy_device *phydev, u8 pair, u16 result);
1571 int phy_cable_test_fault_length(struct phy_device *phydev, u8 pair,
1574 static inline void phy_device_reset(struct phy_device *phydev, int value)
1576 mdio_device_reset(&phydev->mdio, value);
1579 #define phydev_err(_phydev, format, args...) \
1580 dev_err(&_phydev->mdio.dev, format, ##args)
1582 #define phydev_err_probe(_phydev, err, format, args...) \
1583 dev_err_probe(&_phydev->mdio.dev, err, format, ##args)
1585 #define phydev_info(_phydev, format, args...) \
1586 dev_info(&_phydev->mdio.dev, format, ##args)
1588 #define phydev_warn(_phydev, format, args...) \
1589 dev_warn(&_phydev->mdio.dev, format, ##args)
1591 #define phydev_dbg(_phydev, format, args...) \
1592 dev_dbg(&_phydev->mdio.dev, format, ##args)
1594 static inline const char *phydev_name(const struct phy_device *phydev)
1596 return dev_name(&phydev->mdio.dev);
1599 static inline void phy_lock_mdio_bus(struct phy_device *phydev)
1601 mutex_lock(&phydev->mdio.bus->mdio_lock);
1604 static inline void phy_unlock_mdio_bus(struct phy_device *phydev)
1606 mutex_unlock(&phydev->mdio.bus->mdio_lock);
1609 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1611 char *phy_attached_info_irq(struct phy_device *phydev)
1613 void phy_attached_info(struct phy_device *phydev);
1616 int genphy_read_abilities(struct phy_device *phydev);
1617 int genphy_setup_forced(struct phy_device *phydev);
1618 int genphy_restart_aneg(struct phy_device *phydev);
1619 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1620 int genphy_config_eee_advert(struct phy_device *phydev);
1621 int __genphy_config_aneg(struct phy_device *phydev, bool changed);
1622 int genphy_aneg_done(struct phy_device *phydev);
1623 int genphy_update_link(struct phy_device *phydev);
1624 int genphy_read_lpa(struct phy_device *phydev);
1625 int genphy_read_status_fixed(struct phy_device *phydev);
1626 int genphy_read_status(struct phy_device *phydev);
1627 int genphy_read_master_slave(struct phy_device *phydev);
1628 int genphy_suspend(struct phy_device *phydev);
1629 int genphy_resume(struct phy_device *phydev);
1630 int genphy_loopback(struct phy_device *phydev, bool enable);
1631 int genphy_soft_reset(struct phy_device *phydev);
1632 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev);
1634 static inline int genphy_config_aneg(struct phy_device *phydev)
1636 return __genphy_config_aneg(phydev, false);
1639 static inline int genphy_no_config_intr(struct phy_device *phydev)
1643 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1645 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1646 u16 regnum, u16 val);
1649 int genphy_c37_config_aneg(struct phy_device *phydev);
1650 int genphy_c37_read_status(struct phy_device *phydev);
1653 int genphy_c45_restart_aneg(struct phy_device *phydev);
1654 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1655 int genphy_c45_aneg_done(struct phy_device *phydev);
1656 int genphy_c45_read_link(struct phy_device *phydev);
1657 int genphy_c45_read_lpa(struct phy_device *phydev);
1658 int genphy_c45_read_pma(struct phy_device *phydev);
1659 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1660 int genphy_c45_pma_baset1_setup_master_slave(struct phy_device *phydev);
1661 int genphy_c45_an_config_aneg(struct phy_device *phydev);
1662 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1663 int genphy_c45_read_mdix(struct phy_device *phydev);
1664 int genphy_c45_pma_read_abilities(struct phy_device *phydev);
1665 int genphy_c45_pma_baset1_read_master_slave(struct phy_device *phydev);
1666 int genphy_c45_read_status(struct phy_device *phydev);
1667 int genphy_c45_baset1_read_status(struct phy_device *phydev);
1668 int genphy_c45_config_aneg(struct phy_device *phydev);
1669 int genphy_c45_loopback(struct phy_device *phydev, bool enable);
1670 int genphy_c45_pma_resume(struct phy_device *phydev);
1671 int genphy_c45_pma_suspend(struct phy_device *phydev);
1672 int genphy_c45_fast_retrain(struct phy_device *phydev, bool enable);
1674 /* Generic C45 PHY driver */
1675 extern struct phy_driver genphy_c45_driver;
1677 /* The gen10g_* functions are the old Clause 45 stub */
1678 int gen10g_config_aneg(struct phy_device *phydev);
1680 static inline int phy_read_status(struct phy_device *phydev)
1685 if (phydev->drv->read_status)
1686 return phydev->drv->read_status(phydev);
1688 return genphy_read_status(phydev);
1691 void phy_driver_unregister(struct phy_driver *drv);
1692 void phy_drivers_unregister(struct phy_driver *drv, int n);
1693 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1694 int phy_drivers_register(struct phy_driver *new_driver, int n,
1695 struct module *owner);
1696 void phy_error(struct phy_device *phydev);
1697 void phy_state_machine(struct work_struct *work);
1698 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies);
1699 void phy_trigger_machine(struct phy_device *phydev);
1700 void phy_mac_interrupt(struct phy_device *phydev);
1701 void phy_start_machine(struct phy_device *phydev);
1702 void phy_stop_machine(struct phy_device *phydev);
1703 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1704 struct ethtool_link_ksettings *cmd);
1705 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1706 const struct ethtool_link_ksettings *cmd);
1707 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1708 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
1709 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd);
1710 int phy_disable_interrupts(struct phy_device *phydev);
1711 void phy_request_interrupt(struct phy_device *phydev);
1712 void phy_free_interrupt(struct phy_device *phydev);
1713 void phy_print_status(struct phy_device *phydev);
1714 int phy_get_rate_matching(struct phy_device *phydev,
1715 phy_interface_t iface);
1716 void phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1717 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1718 void phy_advertise_supported(struct phy_device *phydev);
1719 void phy_support_sym_pause(struct phy_device *phydev);
1720 void phy_support_asym_pause(struct phy_device *phydev);
1721 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1723 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1724 bool phy_validate_pause(struct phy_device *phydev,
1725 struct ethtool_pauseparam *pp);
1726 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause);
1728 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
1729 const int *delay_values, int size, bool is_rx);
1731 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv,
1732 bool *tx_pause, bool *rx_pause);
1734 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1735 int (*run)(struct phy_device *));
1736 int phy_register_fixup_for_id(const char *bus_id,
1737 int (*run)(struct phy_device *));
1738 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1739 int (*run)(struct phy_device *));
1741 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1742 int phy_unregister_fixup_for_id(const char *bus_id);
1743 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1745 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1746 int phy_get_eee_err(struct phy_device *phydev);
1747 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1748 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1749 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1750 void phy_ethtool_get_wol(struct phy_device *phydev,
1751 struct ethtool_wolinfo *wol);
1752 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1753 struct ethtool_link_ksettings *cmd);
1754 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1755 const struct ethtool_link_ksettings *cmd);
1756 int phy_ethtool_nway_reset(struct net_device *ndev);
1757 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size);
1758 void phy_package_leave(struct phy_device *phydev);
1759 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1760 int addr, size_t priv_size);
1762 #if IS_ENABLED(CONFIG_PHYLIB)
1763 int __init mdio_bus_init(void);
1764 void mdio_bus_exit(void);
1767 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data);
1768 int phy_ethtool_get_sset_count(struct phy_device *phydev);
1769 int phy_ethtool_get_stats(struct phy_device *phydev,
1770 struct ethtool_stats *stats, u64 *data);
1772 static inline int phy_package_read(struct phy_device *phydev, u32 regnum)
1774 struct phy_package_shared *shared = phydev->shared;
1779 return mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1782 static inline int __phy_package_read(struct phy_device *phydev, u32 regnum)
1784 struct phy_package_shared *shared = phydev->shared;
1789 return __mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1792 static inline int phy_package_write(struct phy_device *phydev,
1793 u32 regnum, u16 val)
1795 struct phy_package_shared *shared = phydev->shared;
1800 return mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1803 static inline int __phy_package_write(struct phy_device *phydev,
1804 u32 regnum, u16 val)
1806 struct phy_package_shared *shared = phydev->shared;
1811 return __mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1814 static inline bool __phy_package_set_once(struct phy_device *phydev,
1817 struct phy_package_shared *shared = phydev->shared;
1822 return !test_and_set_bit(b, &shared->flags);
1825 static inline bool phy_package_init_once(struct phy_device *phydev)
1827 return __phy_package_set_once(phydev, PHY_SHARED_F_INIT_DONE);
1830 static inline bool phy_package_probe_once(struct phy_device *phydev)
1832 return __phy_package_set_once(phydev, PHY_SHARED_F_PROBE_DONE);
1835 extern struct bus_type mdio_bus_type;
1837 struct mdio_board_info {
1839 char modalias[MDIO_NAME_SIZE];
1841 const void *platform_data;
1844 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1845 int mdiobus_register_board_info(const struct mdio_board_info *info,
1848 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1857 * phy_module_driver() - Helper macro for registering PHY drivers
1858 * @__phy_drivers: array of PHY drivers to register
1859 * @__count: Numbers of members in array
1861 * Helper macro for PHY drivers which do not do anything special in module
1862 * init/exit. Each module may only use this macro once, and calling it
1863 * replaces module_init() and module_exit().
1865 #define phy_module_driver(__phy_drivers, __count) \
1866 static int __init phy_module_init(void) \
1868 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1870 module_init(phy_module_init); \
1871 static void __exit phy_module_exit(void) \
1873 phy_drivers_unregister(__phy_drivers, __count); \
1875 module_exit(phy_module_exit)
1877 #define module_phy_driver(__phy_drivers) \
1878 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1880 bool phy_driver_is_genphy(struct phy_device *phydev);
1881 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
1883 #endif /* __PHY_H */