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/leds.h>
18 #include <linux/linkmode.h>
19 #include <linux/netlink.h>
20 #include <linux/mdio.h>
21 #include <linux/mii.h>
22 #include <linux/mii_timestamper.h>
23 #include <linux/module.h>
24 #include <linux/timer.h>
25 #include <linux/workqueue.h>
26 #include <linux/mod_devicetable.h>
27 #include <linux/u64_stats_sync.h>
28 #include <linux/irqreturn.h>
29 #include <linux/iopoll.h>
30 #include <linux/refcount.h>
32 #include <linux/atomic.h>
35 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
39 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
40 SUPPORTED_10baseT_Full)
42 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
43 SUPPORTED_100baseT_Full)
45 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
46 SUPPORTED_1000baseT_Full)
48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1s_p2mp_features) __ro_after_init;
51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
53 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
54 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
55 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
56 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
57 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap1_features) __ro_after_init;
58 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap2_features) __ro_after_init;
60 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
61 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
62 #define PHY_BASIC_T1S_P2MP_FEATURES ((unsigned long *)&phy_basic_t1s_p2mp_features)
63 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
64 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
65 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
66 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
67 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
68 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
69 #define PHY_EEE_CAP1_FEATURES ((unsigned long *)&phy_eee_cap1_features)
70 #define PHY_EEE_CAP2_FEATURES ((unsigned long *)&phy_eee_cap2_features)
72 extern const int phy_basic_ports_array[3];
73 extern const int phy_fibre_port_array[1];
74 extern const int phy_all_ports_features_array[7];
75 extern const int phy_10_100_features_array[4];
76 extern const int phy_basic_t1_features_array[3];
77 extern const int phy_basic_t1s_p2mp_features_array[2];
78 extern const int phy_gbit_features_array[2];
79 extern const int phy_10gbit_features_array[1];
82 * Set phydev->irq to PHY_POLL if interrupts are not supported,
83 * or not desired for this PHY. Set to PHY_MAC_INTERRUPT if
84 * the attached MAC driver handles the interrupt
87 #define PHY_MAC_INTERRUPT -2
89 #define PHY_IS_INTERNAL 0x00000001
90 #define PHY_RST_AFTER_CLK_EN 0x00000002
91 #define PHY_POLL_CABLE_TEST 0x00000004
92 #define PHY_ALWAYS_CALL_SUSPEND 0x00000008
93 #define MDIO_DEVICE_IS_PHY 0x80000000
96 * enum phy_interface_t - Interface Mode definitions
98 * @PHY_INTERFACE_MODE_NA: Not Applicable - don't touch
99 * @PHY_INTERFACE_MODE_INTERNAL: No interface, MAC and PHY combined
100 * @PHY_INTERFACE_MODE_MII: Media-independent interface
101 * @PHY_INTERFACE_MODE_GMII: Gigabit media-independent interface
102 * @PHY_INTERFACE_MODE_SGMII: Serial gigabit media-independent interface
103 * @PHY_INTERFACE_MODE_TBI: Ten Bit Interface
104 * @PHY_INTERFACE_MODE_REVMII: Reverse Media Independent Interface
105 * @PHY_INTERFACE_MODE_RMII: Reduced Media Independent Interface
106 * @PHY_INTERFACE_MODE_REVRMII: Reduced Media Independent Interface in PHY role
107 * @PHY_INTERFACE_MODE_RGMII: Reduced gigabit media-independent interface
108 * @PHY_INTERFACE_MODE_RGMII_ID: RGMII with Internal RX+TX delay
109 * @PHY_INTERFACE_MODE_RGMII_RXID: RGMII with Internal RX delay
110 * @PHY_INTERFACE_MODE_RGMII_TXID: RGMII with Internal RX delay
111 * @PHY_INTERFACE_MODE_RTBI: Reduced TBI
112 * @PHY_INTERFACE_MODE_SMII: Serial MII
113 * @PHY_INTERFACE_MODE_XGMII: 10 gigabit media-independent interface
114 * @PHY_INTERFACE_MODE_XLGMII:40 gigabit media-independent interface
115 * @PHY_INTERFACE_MODE_MOCA: Multimedia over Coax
116 * @PHY_INTERFACE_MODE_PSGMII: Penta SGMII
117 * @PHY_INTERFACE_MODE_QSGMII: Quad SGMII
118 * @PHY_INTERFACE_MODE_TRGMII: Turbo RGMII
119 * @PHY_INTERFACE_MODE_100BASEX: 100 BaseX
120 * @PHY_INTERFACE_MODE_1000BASEX: 1000 BaseX
121 * @PHY_INTERFACE_MODE_2500BASEX: 2500 BaseX
122 * @PHY_INTERFACE_MODE_5GBASER: 5G BaseR
123 * @PHY_INTERFACE_MODE_RXAUI: Reduced XAUI
124 * @PHY_INTERFACE_MODE_XAUI: 10 Gigabit Attachment Unit Interface
125 * @PHY_INTERFACE_MODE_10GBASER: 10G BaseR
126 * @PHY_INTERFACE_MODE_25GBASER: 25G BaseR
127 * @PHY_INTERFACE_MODE_USXGMII: Universal Serial 10GE MII
128 * @PHY_INTERFACE_MODE_10GKR: 10GBASE-KR - with Clause 73 AN
129 * @PHY_INTERFACE_MODE_QUSGMII: Quad Universal SGMII
130 * @PHY_INTERFACE_MODE_1000BASEKX: 1000Base-KX - with Clause 73 AN
131 * @PHY_INTERFACE_MODE_MAX: Book keeping
133 * Describes the interface between the MAC and PHY.
136 PHY_INTERFACE_MODE_NA,
137 PHY_INTERFACE_MODE_INTERNAL,
138 PHY_INTERFACE_MODE_MII,
139 PHY_INTERFACE_MODE_GMII,
140 PHY_INTERFACE_MODE_SGMII,
141 PHY_INTERFACE_MODE_TBI,
142 PHY_INTERFACE_MODE_REVMII,
143 PHY_INTERFACE_MODE_RMII,
144 PHY_INTERFACE_MODE_REVRMII,
145 PHY_INTERFACE_MODE_RGMII,
146 PHY_INTERFACE_MODE_RGMII_ID,
147 PHY_INTERFACE_MODE_RGMII_RXID,
148 PHY_INTERFACE_MODE_RGMII_TXID,
149 PHY_INTERFACE_MODE_RTBI,
150 PHY_INTERFACE_MODE_SMII,
151 PHY_INTERFACE_MODE_XGMII,
152 PHY_INTERFACE_MODE_XLGMII,
153 PHY_INTERFACE_MODE_MOCA,
154 PHY_INTERFACE_MODE_PSGMII,
155 PHY_INTERFACE_MODE_QSGMII,
156 PHY_INTERFACE_MODE_TRGMII,
157 PHY_INTERFACE_MODE_100BASEX,
158 PHY_INTERFACE_MODE_1000BASEX,
159 PHY_INTERFACE_MODE_2500BASEX,
160 PHY_INTERFACE_MODE_5GBASER,
161 PHY_INTERFACE_MODE_RXAUI,
162 PHY_INTERFACE_MODE_XAUI,
163 /* 10GBASE-R, XFI, SFI - single lane 10G Serdes */
164 PHY_INTERFACE_MODE_10GBASER,
165 PHY_INTERFACE_MODE_25GBASER,
166 PHY_INTERFACE_MODE_USXGMII,
167 /* 10GBASE-KR - with Clause 73 AN */
168 PHY_INTERFACE_MODE_10GKR,
169 PHY_INTERFACE_MODE_QUSGMII,
170 PHY_INTERFACE_MODE_1000BASEKX,
171 PHY_INTERFACE_MODE_MAX,
174 /* PHY interface mode bitmap handling */
175 #define DECLARE_PHY_INTERFACE_MASK(name) \
176 DECLARE_BITMAP(name, PHY_INTERFACE_MODE_MAX)
178 static inline void phy_interface_zero(unsigned long *intf)
180 bitmap_zero(intf, PHY_INTERFACE_MODE_MAX);
183 static inline bool phy_interface_empty(const unsigned long *intf)
185 return bitmap_empty(intf, PHY_INTERFACE_MODE_MAX);
188 static inline void phy_interface_and(unsigned long *dst, const unsigned long *a,
189 const unsigned long *b)
191 bitmap_and(dst, a, b, PHY_INTERFACE_MODE_MAX);
194 static inline void phy_interface_or(unsigned long *dst, const unsigned long *a,
195 const unsigned long *b)
197 bitmap_or(dst, a, b, PHY_INTERFACE_MODE_MAX);
200 static inline void phy_interface_set_rgmii(unsigned long *intf)
202 __set_bit(PHY_INTERFACE_MODE_RGMII, intf);
203 __set_bit(PHY_INTERFACE_MODE_RGMII_ID, intf);
204 __set_bit(PHY_INTERFACE_MODE_RGMII_RXID, intf);
205 __set_bit(PHY_INTERFACE_MODE_RGMII_TXID, intf);
209 * phy_supported_speeds - return all speeds currently supported by a PHY device
211 unsigned int phy_supported_speeds(struct phy_device *phy,
212 unsigned int *speeds,
216 * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
217 * @interface: enum phy_interface_t value
219 * Description: maps enum &phy_interface_t defined in this file
220 * into the device tree binding of 'phy-mode', so that Ethernet
221 * device driver can get PHY interface from device tree.
223 static inline const char *phy_modes(phy_interface_t interface)
226 case PHY_INTERFACE_MODE_NA:
228 case PHY_INTERFACE_MODE_INTERNAL:
230 case PHY_INTERFACE_MODE_MII:
232 case PHY_INTERFACE_MODE_GMII:
234 case PHY_INTERFACE_MODE_SGMII:
236 case PHY_INTERFACE_MODE_TBI:
238 case PHY_INTERFACE_MODE_REVMII:
240 case PHY_INTERFACE_MODE_RMII:
242 case PHY_INTERFACE_MODE_REVRMII:
244 case PHY_INTERFACE_MODE_RGMII:
246 case PHY_INTERFACE_MODE_RGMII_ID:
248 case PHY_INTERFACE_MODE_RGMII_RXID:
250 case PHY_INTERFACE_MODE_RGMII_TXID:
252 case PHY_INTERFACE_MODE_RTBI:
254 case PHY_INTERFACE_MODE_SMII:
256 case PHY_INTERFACE_MODE_XGMII:
258 case PHY_INTERFACE_MODE_XLGMII:
260 case PHY_INTERFACE_MODE_MOCA:
262 case PHY_INTERFACE_MODE_PSGMII:
264 case PHY_INTERFACE_MODE_QSGMII:
266 case PHY_INTERFACE_MODE_TRGMII:
268 case PHY_INTERFACE_MODE_1000BASEX:
270 case PHY_INTERFACE_MODE_1000BASEKX:
271 return "1000base-kx";
272 case PHY_INTERFACE_MODE_2500BASEX:
274 case PHY_INTERFACE_MODE_5GBASER:
276 case PHY_INTERFACE_MODE_RXAUI:
278 case PHY_INTERFACE_MODE_XAUI:
280 case PHY_INTERFACE_MODE_10GBASER:
282 case PHY_INTERFACE_MODE_25GBASER:
284 case PHY_INTERFACE_MODE_USXGMII:
286 case PHY_INTERFACE_MODE_10GKR:
288 case PHY_INTERFACE_MODE_100BASEX:
290 case PHY_INTERFACE_MODE_QUSGMII:
297 #define PHY_INIT_TIMEOUT 100000
298 #define PHY_FORCE_TIMEOUT 10
300 #define PHY_MAX_ADDR 32
302 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
303 #define PHY_ID_FMT "%s:%02x"
305 #define MII_BUS_ID_SIZE 61
308 struct kernel_hwtstamp_config;
311 struct sfp_upstream_ops;
315 * struct mdio_bus_stats - Statistics counters for MDIO busses
316 * @transfers: Total number of transfers, i.e. @writes + @reads
317 * @errors: Number of MDIO transfers that returned an error
318 * @writes: Number of write transfers
319 * @reads: Number of read transfers
320 * @syncp: Synchronisation for incrementing statistics
322 struct mdio_bus_stats {
323 u64_stats_t transfers;
327 /* Must be last, add new statistics above */
328 struct u64_stats_sync syncp;
332 * struct phy_package_shared - Shared information in PHY packages
333 * @base_addr: Base PHY address of PHY package used to combine PHYs
334 * in one package and for offset calculation of phy_package_read/write
335 * @np: Pointer to the Device Node if PHY package defined in DT
336 * @refcnt: Number of PHYs connected to this shared data
337 * @flags: Initialization of PHY package
338 * @priv_size: Size of the shared private data @priv
339 * @priv: Driver private data shared across a PHY package
341 * Represents a shared structure between different phydev's in the same
342 * package, for example a quad PHY. See phy_package_join() and
343 * phy_package_leave().
345 struct phy_package_shared {
347 /* With PHY package defined in DT this points to the PHY package node */
348 struct device_node *np;
353 /* private data pointer */
354 /* note that this pointer is shared between different phydevs and
355 * the user has to take care of appropriate locking. It is allocated
356 * and freed automatically by phy_package_join() and
357 * phy_package_leave().
362 /* used as bit number in atomic bitops */
363 #define PHY_SHARED_F_INIT_DONE 0
364 #define PHY_SHARED_F_PROBE_DONE 1
367 * struct mii_bus - Represents an MDIO bus
369 * @owner: Who owns this device
370 * @name: User friendly name for this MDIO device, or driver name
371 * @id: Unique identifier for this bus, typical from bus hierarchy
372 * @priv: Driver private data
374 * The Bus class for PHYs. Devices which provide access to
375 * PHYs should register using this structure
378 struct module *owner;
380 char id[MII_BUS_ID_SIZE];
382 /** @read: Perform a read transfer on the bus */
383 int (*read)(struct mii_bus *bus, int addr, int regnum);
384 /** @write: Perform a write transfer on the bus */
385 int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
386 /** @read_c45: Perform a C45 read transfer on the bus */
387 int (*read_c45)(struct mii_bus *bus, int addr, int devnum, int regnum);
388 /** @write_c45: Perform a C45 write transfer on the bus */
389 int (*write_c45)(struct mii_bus *bus, int addr, int devnum,
390 int regnum, u16 val);
391 /** @reset: Perform a reset of the bus */
392 int (*reset)(struct mii_bus *bus);
394 /** @stats: Statistic counters per device on the bus */
395 struct mdio_bus_stats stats[PHY_MAX_ADDR];
398 * @mdio_lock: A lock to ensure that only one thing can read/write
399 * the MDIO bus at a time
401 struct mutex mdio_lock;
403 /** @parent: Parent device of this bus */
404 struct device *parent;
405 /** @state: State of bus structure */
407 MDIOBUS_ALLOCATED = 1,
409 MDIOBUS_UNREGISTERED,
413 /** @dev: Kernel device representation */
416 /** @mdio_map: list of all MDIO devices on bus */
417 struct mdio_device *mdio_map[PHY_MAX_ADDR];
419 /** @phy_mask: PHY addresses to be ignored when probing */
422 /** @phy_ignore_ta_mask: PHY addresses to ignore the TA/read failure */
423 u32 phy_ignore_ta_mask;
426 * @irq: An array of interrupts, each PHY's interrupt at the index
427 * matching its address
429 int irq[PHY_MAX_ADDR];
431 /** @reset_delay_us: GPIO reset pulse width in microseconds */
433 /** @reset_post_delay_us: GPIO reset deassert delay in microseconds */
434 int reset_post_delay_us;
435 /** @reset_gpiod: Reset GPIO descriptor pointer */
436 struct gpio_desc *reset_gpiod;
438 /** @shared_lock: protect access to the shared element */
439 struct mutex shared_lock;
441 /** @shared: shared state across different PHYs */
442 struct phy_package_shared *shared[PHY_MAX_ADDR];
444 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
446 struct mii_bus *mdiobus_alloc_size(size_t size);
449 * mdiobus_alloc - Allocate an MDIO bus structure
451 * The internal state of the MDIO bus will be set of MDIOBUS_ALLOCATED ready
452 * for the driver to register the bus.
454 static inline struct mii_bus *mdiobus_alloc(void)
456 return mdiobus_alloc_size(0);
459 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
460 int __devm_mdiobus_register(struct device *dev, struct mii_bus *bus,
461 struct module *owner);
462 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
463 #define devm_mdiobus_register(dev, bus) \
464 __devm_mdiobus_register(dev, bus, THIS_MODULE)
466 void mdiobus_unregister(struct mii_bus *bus);
467 void mdiobus_free(struct mii_bus *bus);
468 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
469 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
471 return devm_mdiobus_alloc_size(dev, 0);
474 struct mii_bus *mdio_find_bus(const char *mdio_name);
475 struct phy_device *mdiobus_scan_c22(struct mii_bus *bus, int addr);
477 #define PHY_INTERRUPT_DISABLED false
478 #define PHY_INTERRUPT_ENABLED true
481 * enum phy_state - PHY state machine states:
483 * @PHY_DOWN: PHY device and driver are not ready for anything. probe
484 * should be called if and only if the PHY is in this state,
485 * given that the PHY device exists.
486 * - PHY driver probe function will set the state to @PHY_READY
488 * @PHY_READY: PHY is ready to send and receive packets, but the
489 * controller is not. By default, PHYs which do not implement
490 * probe will be set to this state by phy_probe().
491 * - start will set the state to UP
493 * @PHY_UP: The PHY and attached device are ready to do work.
494 * Interrupts should be started here.
495 * - timer moves to @PHY_NOLINK or @PHY_RUNNING
497 * @PHY_NOLINK: PHY is up, but not currently plugged in.
498 * - irq or timer will set @PHY_RUNNING if link comes back
499 * - phy_stop moves to @PHY_HALTED
501 * @PHY_RUNNING: PHY is currently up, running, and possibly sending
502 * and/or receiving packets
503 * - irq or timer will set @PHY_NOLINK if link goes down
504 * - phy_stop moves to @PHY_HALTED
506 * @PHY_CABLETEST: PHY is performing a cable test. Packet reception/sending
507 * is not expected to work, carrier will be indicated as down. PHY will be
508 * poll once per second, or on interrupt for it current state.
509 * Once complete, move to UP to restart the PHY.
510 * - phy_stop aborts the running test and moves to @PHY_HALTED
512 * @PHY_HALTED: PHY is up, but no polling or interrupts are done.
513 * - phy_start moves to @PHY_UP
515 * @PHY_ERROR: PHY is up, but is in an error state.
516 * - phy_stop moves to @PHY_HALTED
529 #define MDIO_MMD_NUM 32
532 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
533 * @devices_in_package: IEEE 802.3 devices in package register value.
534 * @mmds_present: bit vector of MMDs present.
535 * @device_ids: The device identifer for each present device.
537 struct phy_c45_device_ids {
538 u32 devices_in_package;
540 u32 device_ids[MDIO_MMD_NUM];
543 struct macsec_context;
547 * struct phy_device - An instance of a PHY
549 * @mdio: MDIO bus this PHY is on
550 * @drv: Pointer to the driver for this PHY instance
551 * @devlink: Create a link between phy dev and mac dev, if the external phy
552 * used by current mac interface is managed by another mac interface.
553 * @phy_id: UID for this device found during discovery
554 * @c45_ids: 802.3-c45 Device Identifiers if is_c45.
555 * @is_c45: Set to true if this PHY uses clause 45 addressing.
556 * @is_internal: Set to true if this PHY is internal to a MAC.
557 * @is_pseudo_fixed_link: Set to true if this PHY is an Ethernet switch, etc.
558 * @is_gigabit_capable: Set to true if PHY supports 1000Mbps
559 * @has_fixups: Set to true if this PHY has fixups/quirks.
560 * @suspended: Set to true if this PHY has been suspended successfully.
561 * @suspended_by_mdio_bus: Set to true if this PHY was suspended by MDIO bus.
562 * @sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
563 * @loopback_enabled: Set true if this PHY has been loopbacked successfully.
564 * @downshifted_rate: Set true if link speed has been downshifted.
565 * @is_on_sfp_module: Set true if PHY is located on an SFP module.
566 * @mac_managed_pm: Set true if MAC driver takes of suspending/resuming PHY
567 * @wol_enabled: Set to true if the PHY or the attached MAC have Wake-on-LAN
569 * @state: State of the PHY for management purposes
570 * @dev_flags: Device-specific flags used by the PHY driver.
572 * - Bits [15:0] are free to use by the PHY driver to communicate
573 * driver specific behavior.
574 * - Bits [23:16] are currently reserved for future use.
575 * - Bits [31:24] are reserved for defining generic
576 * PHY driver behavior.
577 * @irq: IRQ number of the PHY's interrupt (-1 if none)
578 * @phylink: Pointer to phylink instance for this PHY
579 * @sfp_bus_attached: Flag indicating whether the SFP bus has been attached
580 * @sfp_bus: SFP bus attached to this PHY's fiber port
581 * @attached_dev: The attached enet driver's device instance ptr
582 * @adjust_link: Callback for the enet controller to respond to changes: in the
584 * @phy_link_change: Callback for phylink for notification of link change
585 * @macsec_ops: MACsec offloading ops.
587 * @speed: Current link speed
588 * @duplex: Current duplex
589 * @port: Current port
590 * @pause: Current pause
591 * @asym_pause: Current asymmetric pause
592 * @supported: Combined MAC/PHY supported linkmodes
593 * @advertising: Currently advertised linkmodes
594 * @adv_old: Saved advertised while power saving for WoL
595 * @supported_eee: supported PHY EEE linkmodes
596 * @advertising_eee: Currently advertised EEE linkmodes
597 * @eee_enabled: Flag indicating whether the EEE feature is enabled
598 * @enable_tx_lpi: When True, MAC should transmit LPI to PHY
599 * @eee_cfg: User configuration of EEE
600 * @lp_advertising: Current link partner advertised linkmodes
601 * @host_interfaces: PHY interface modes supported by host
602 * @eee_broken_modes: Energy efficient ethernet modes which should be prohibited
603 * @autoneg: Flag autoneg being used
604 * @rate_matching: Current rate matching mode
605 * @link: Current link state
606 * @autoneg_complete: Flag auto negotiation of the link has completed
607 * @mdix: Current crossover
608 * @mdix_ctrl: User setting of crossover
609 * @pma_extable: Cached value of PMA/PMD Extended Abilities Register
610 * @interrupts: Flag interrupts have been enabled
611 * @irq_suspended: Flag indicating PHY is suspended and therefore interrupt
612 * handling shall be postponed until PHY has resumed
613 * @irq_rerun: Flag indicating interrupts occurred while PHY was suspended,
614 * requiring a rerun of the interrupt handler after resume
615 * @interface: enum phy_interface_t value
616 * @possible_interfaces: bitmap if interface modes that the attached PHY
617 * will switch between depending on media speed.
618 * @skb: Netlink message for cable diagnostics
619 * @nest: Netlink nest used for cable diagnostics
620 * @ehdr: nNtlink header for cable diagnostics
621 * @phy_led_triggers: Array of LED triggers
622 * @phy_num_led_triggers: Number of triggers in @phy_led_triggers
623 * @led_link_trigger: LED trigger for link up/down
624 * @last_triggered: last LED trigger for link speed
625 * @leds: list of PHY LED structures
626 * @master_slave_set: User requested master/slave configuration
627 * @master_slave_get: Current master/slave advertisement
628 * @master_slave_state: Current master/slave configuration
629 * @mii_ts: Pointer to time stamper callbacks
630 * @psec: Pointer to Power Sourcing Equipment control struct
631 * @lock: Mutex for serialization access to PHY
632 * @state_queue: Work queue for state machine
633 * @link_down_events: Number of times link was lost
634 * @shared: Pointer to private data shared by phys in one package
635 * @priv: Pointer to driver private data
637 * interrupts currently only supports enabled or disabled,
638 * but could be changed in the future to support enabling
639 * and disabling specific interrupts
641 * Contains some infrastructure for polling and interrupt
642 * handling, as well as handling shifts in PHY hardware state
645 struct mdio_device mdio;
647 /* Information about the PHY type */
648 /* And management functions */
649 const struct phy_driver *drv;
651 struct device_link *devlink;
655 struct phy_c45_device_ids c45_ids;
657 unsigned is_internal:1;
658 unsigned is_pseudo_fixed_link:1;
659 unsigned is_gigabit_capable:1;
660 unsigned has_fixups:1;
661 unsigned suspended:1;
662 unsigned suspended_by_mdio_bus:1;
663 unsigned sysfs_links:1;
664 unsigned loopback_enabled:1;
665 unsigned downshifted_rate:1;
666 unsigned is_on_sfp_module:1;
667 unsigned mac_managed_pm:1;
668 unsigned wol_enabled:1;
671 /* The most recently read link state */
673 unsigned autoneg_complete:1;
675 /* Interrupts are enabled */
676 unsigned interrupts:1;
677 unsigned irq_suspended:1;
678 unsigned irq_rerun:1;
682 enum phy_state state;
686 phy_interface_t interface;
687 DECLARE_PHY_INTERFACE_MASK(possible_interfaces);
690 * forced speed & duplex (no autoneg)
691 * partner speed & duplex & pause (autoneg)
700 u8 master_slave_state;
702 /* Union of PHY and Attached devices' supported link modes */
703 /* See ethtool.h for more info */
704 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
705 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
706 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
707 /* used with phy_speed_down */
708 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
709 /* used for eee validation and configuration*/
710 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported_eee);
711 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising_eee);
714 /* Host supported PHY interface types. Should be ignored if empty. */
715 DECLARE_PHY_INTERFACE_MASK(host_interfaces);
717 /* Energy efficient ethernet modes which should be prohibited */
718 u32 eee_broken_modes;
720 struct eee_config eee_cfg;
722 #ifdef CONFIG_LED_TRIGGER_PHY
723 struct phy_led_trigger *phy_led_triggers;
724 unsigned int phy_num_led_triggers;
725 struct phy_led_trigger *last_triggered;
727 struct phy_led_trigger *led_link_trigger;
729 struct list_head leds;
732 * Interrupt number for this PHY
733 * -1 means no interrupt
737 /* private data pointer */
738 /* For use by PHYs to maintain extra state */
741 /* shared data pointer */
742 /* For use by PHYs inside the same package that need a shared state. */
743 struct phy_package_shared *shared;
745 /* Reporting cable test results */
750 /* Interrupt and Polling infrastructure */
751 struct delayed_work state_queue;
755 /* This may be modified under the rtnl lock */
756 bool sfp_bus_attached;
757 struct sfp_bus *sfp_bus;
758 struct phylink *phylink;
759 struct net_device *attached_dev;
760 struct mii_timestamper *mii_ts;
761 struct pse_control *psec;
768 unsigned int link_down_events;
770 void (*phy_link_change)(struct phy_device *phydev, bool up);
771 void (*adjust_link)(struct net_device *dev);
773 #if IS_ENABLED(CONFIG_MACSEC)
774 /* MACsec management functions */
775 const struct macsec_ops *macsec_ops;
779 /* Generic phy_device::dev_flags */
780 #define PHY_F_NO_IRQ 0x80000000
782 static inline struct phy_device *to_phy_device(const struct device *dev)
784 return container_of(to_mdio_device(dev), struct phy_device, mdio);
788 * struct phy_tdr_config - Configuration of a TDR raw test
790 * @first: Distance for first data collection point
791 * @last: Distance for last data collection point
792 * @step: Step between data collection points
793 * @pair: Bitmap of cable pairs to collect data for
795 * A structure containing possible configuration parameters
796 * for a TDR cable test. The driver does not need to implement
797 * all the parameters, but should report what is actually used.
798 * All distances are in centimeters.
800 struct phy_tdr_config {
806 #define PHY_PAIR_ALL -1
809 * struct phy_plca_cfg - Configuration of the PLCA (Physical Layer Collision
810 * Avoidance) Reconciliation Sublayer.
812 * @version: read-only PLCA register map version. -1 = not available. Ignored
813 * when setting the configuration. Format is the same as reported by the PLCA
814 * IDVER register (31.CA00). -1 = not available.
815 * @enabled: PLCA configured mode (enabled/disabled). -1 = not available / don't
816 * set. 0 = disabled, anything else = enabled.
817 * @node_id: the PLCA local node identifier. -1 = not available / don't set.
818 * Allowed values [0 .. 254]. 255 = node disabled.
819 * @node_cnt: the PLCA node count (maximum number of nodes having a TO). Only
820 * meaningful for the coordinator (node_id = 0). -1 = not available / don't
821 * set. Allowed values [1 .. 255].
822 * @to_tmr: The value of the PLCA to_timer in bit-times, which determines the
823 * PLCA transmit opportunity window opening. See IEEE802.3 Clause 148 for
824 * more details. The to_timer shall be set equal over all nodes.
825 * -1 = not available / don't set. Allowed values [0 .. 255].
826 * @burst_cnt: controls how many additional frames a node is allowed to send in
827 * single transmit opportunity (TO). The default value of 0 means that the
828 * node is allowed exactly one frame per TO. A value of 1 allows two frames
829 * per TO, and so on. -1 = not available / don't set.
830 * Allowed values [0 .. 255].
831 * @burst_tmr: controls how many bit times to wait for the MAC to send a new
832 * frame before interrupting the burst. This value should be set to a value
833 * greater than the MAC inter-packet gap (which is typically 96 bits).
834 * -1 = not available / don't set. Allowed values [0 .. 255].
836 * A structure containing configuration parameters for setting/getting the PLCA
837 * RS configuration. The driver does not need to implement all the parameters,
838 * but should report what is actually used.
840 struct phy_plca_cfg {
851 * struct phy_plca_status - Status of the PLCA (Physical Layer Collision
852 * Avoidance) Reconciliation Sublayer.
854 * @pst: The PLCA status as reported by the PST bit in the PLCA STATUS
855 * register(31.CA03), indicating BEACON activity.
857 * A structure containing status information of the PLCA RS configuration.
858 * The driver does not need to implement all the parameters, but should report
859 * what is actually used.
861 struct phy_plca_status {
865 /* Modes for PHY LED configuration */
867 PHY_LED_ACTIVE_LOW = 0,
868 PHY_LED_INACTIVE_HIGH_IMPEDANCE = 1,
875 * struct phy_led: An LED driven by the PHY
877 * @list: List of LEDs
878 * @phydev: PHY this LED is attached to
879 * @led_cdev: Standard LED class structure
880 * @index: Number of the LED
883 struct list_head list;
884 struct phy_device *phydev;
885 struct led_classdev led_cdev;
889 #define to_phy_led(d) container_of(d, struct phy_led, led_cdev)
892 * struct phy_driver - Driver structure for a particular PHY type
894 * @mdiodrv: Data common to all MDIO devices
895 * @phy_id: The result of reading the UID registers of this PHY
896 * type, and ANDing them with the phy_id_mask. This driver
897 * only works for PHYs with IDs which match this field
898 * @name: The friendly name of this PHY type
899 * @phy_id_mask: Defines the important bits of the phy_id
900 * @features: A mandatory list of features (speed, duplex, etc)
901 * supported by this PHY
902 * @flags: A bitfield defining certain other features this PHY
903 * supports (like interrupts)
904 * @driver_data: Static driver data
906 * All functions are optional. If config_aneg or read_status
907 * are not implemented, the phy core uses the genphy versions.
908 * Note that none of these functions should be called from
909 * interrupt time. The goal is for the bus read/write functions
910 * to be able to block when the bus transaction is happening,
911 * and be freed up by an interrupt (The MPC85xx has this ability,
912 * though it is not currently supported in the driver).
915 struct mdio_driver_common mdiodrv;
919 const unsigned long * const features;
921 const void *driver_data;
924 * @soft_reset: Called to issue a PHY software reset
926 int (*soft_reset)(struct phy_device *phydev);
929 * @config_init: Called to initialize the PHY,
930 * including after a reset
932 int (*config_init)(struct phy_device *phydev);
935 * @probe: Called during discovery. Used to set
936 * up device-specific structures, if any
938 int (*probe)(struct phy_device *phydev);
941 * @get_features: Probe the hardware to determine what
942 * abilities it has. Should only set phydev->supported.
944 int (*get_features)(struct phy_device *phydev);
947 * @get_rate_matching: Get the supported type of rate matching for a
948 * particular phy interface. This is used by phy consumers to determine
949 * whether to advertise lower-speed modes for that interface. It is
950 * assumed that if a rate matching mode is supported on an interface,
951 * then that interface's rate can be adapted to all slower link speeds
952 * supported by the phy. If the interface is not supported, this should
953 * return %RATE_MATCH_NONE.
955 int (*get_rate_matching)(struct phy_device *phydev,
956 phy_interface_t iface);
958 /* PHY Power Management */
959 /** @suspend: Suspend the hardware, saving state if needed */
960 int (*suspend)(struct phy_device *phydev);
961 /** @resume: Resume the hardware, restoring state if needed */
962 int (*resume)(struct phy_device *phydev);
965 * @config_aneg: Configures the advertisement and resets
966 * autonegotiation if phydev->autoneg is on,
967 * forces the speed to the current settings in phydev
968 * if phydev->autoneg is off
970 int (*config_aneg)(struct phy_device *phydev);
972 /** @aneg_done: Determines the auto negotiation result */
973 int (*aneg_done)(struct phy_device *phydev);
975 /** @read_status: Determines the negotiated speed and duplex */
976 int (*read_status)(struct phy_device *phydev);
979 * @config_intr: Enables or disables interrupts.
980 * It should also clear any pending interrupts prior to enabling the
981 * IRQs and after disabling them.
983 int (*config_intr)(struct phy_device *phydev);
985 /** @handle_interrupt: Override default interrupt handling */
986 irqreturn_t (*handle_interrupt)(struct phy_device *phydev);
988 /** @remove: Clears up any memory if needed */
989 void (*remove)(struct phy_device *phydev);
992 * @match_phy_device: Returns true if this is a suitable
993 * driver for the given phydev. If NULL, matching is based on
994 * phy_id and phy_id_mask.
996 int (*match_phy_device)(struct phy_device *phydev);
999 * @set_wol: Some devices (e.g. qnap TS-119P II) require PHY
1000 * register changes to enable Wake on LAN, so set_wol is
1001 * provided to be called in the ethernet driver's set_wol
1004 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
1007 * @get_wol: See set_wol, but for checking whether Wake on LAN
1010 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
1013 * @link_change_notify: Called to inform a PHY device driver
1014 * when the core is about to change the link state. This
1015 * callback is supposed to be used as fixup hook for drivers
1016 * that need to take action when the link state
1017 * changes. Drivers are by no means allowed to mess with the
1018 * PHY device structure in their implementations.
1020 void (*link_change_notify)(struct phy_device *dev);
1023 * @read_mmd: PHY specific driver override for reading a MMD
1024 * register. This function is optional for PHY specific
1025 * drivers. When not provided, the default MMD read function
1026 * will be used by phy_read_mmd(), which will use either a
1027 * direct read for Clause 45 PHYs or an indirect read for
1028 * Clause 22 PHYs. devnum is the MMD device number within the
1029 * PHY device, regnum is the register within the selected MMD
1032 int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
1035 * @write_mmd: PHY specific driver override for writing a MMD
1036 * register. This function is optional for PHY specific
1037 * drivers. When not provided, the default MMD write function
1038 * will be used by phy_write_mmd(), which will use either a
1039 * direct write for Clause 45 PHYs, or an indirect write for
1040 * Clause 22 PHYs. devnum is the MMD device number within the
1041 * PHY device, regnum is the register within the selected MMD
1042 * device. val is the value to be written.
1044 int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
1047 /** @read_page: Return the current PHY register page number */
1048 int (*read_page)(struct phy_device *dev);
1049 /** @write_page: Set the current PHY register page number */
1050 int (*write_page)(struct phy_device *dev, int page);
1053 * @module_info: Get the size and type of the eeprom contained
1054 * within a plug-in module
1056 int (*module_info)(struct phy_device *dev,
1057 struct ethtool_modinfo *modinfo);
1060 * @module_eeprom: Get the eeprom information from the plug-in
1063 int (*module_eeprom)(struct phy_device *dev,
1064 struct ethtool_eeprom *ee, u8 *data);
1066 /** @cable_test_start: Start a cable test */
1067 int (*cable_test_start)(struct phy_device *dev);
1069 /** @cable_test_tdr_start: Start a raw TDR cable test */
1070 int (*cable_test_tdr_start)(struct phy_device *dev,
1071 const struct phy_tdr_config *config);
1074 * @cable_test_get_status: Once per second, or on interrupt,
1075 * request the status of the test.
1077 int (*cable_test_get_status)(struct phy_device *dev, bool *finished);
1079 /* Get statistics from the PHY using ethtool */
1080 /** @get_sset_count: Number of statistic counters */
1081 int (*get_sset_count)(struct phy_device *dev);
1082 /** @get_strings: Names of the statistic counters */
1083 void (*get_strings)(struct phy_device *dev, u8 *data);
1084 /** @get_stats: Return the statistic counter values */
1085 void (*get_stats)(struct phy_device *dev,
1086 struct ethtool_stats *stats, u64 *data);
1088 /* Get and Set PHY tunables */
1089 /** @get_tunable: Return the value of a tunable */
1090 int (*get_tunable)(struct phy_device *dev,
1091 struct ethtool_tunable *tuna, void *data);
1092 /** @set_tunable: Set the value of a tunable */
1093 int (*set_tunable)(struct phy_device *dev,
1094 struct ethtool_tunable *tuna,
1096 /** @set_loopback: Set the loopback mood of the PHY */
1097 int (*set_loopback)(struct phy_device *dev, bool enable);
1098 /** @get_sqi: Get the signal quality indication */
1099 int (*get_sqi)(struct phy_device *dev);
1100 /** @get_sqi_max: Get the maximum signal quality indication */
1101 int (*get_sqi_max)(struct phy_device *dev);
1103 /* PLCA RS interface */
1104 /** @get_plca_cfg: Return the current PLCA configuration */
1105 int (*get_plca_cfg)(struct phy_device *dev,
1106 struct phy_plca_cfg *plca_cfg);
1107 /** @set_plca_cfg: Set the PLCA configuration */
1108 int (*set_plca_cfg)(struct phy_device *dev,
1109 const struct phy_plca_cfg *plca_cfg);
1110 /** @get_plca_status: Return the current PLCA status info */
1111 int (*get_plca_status)(struct phy_device *dev,
1112 struct phy_plca_status *plca_st);
1115 * @led_brightness_set: Set a PHY LED brightness. Index
1116 * indicates which of the PHYs led should be set. Value
1117 * follows the standard LED class meaning, e.g. LED_OFF,
1118 * LED_HALF, LED_FULL.
1120 int (*led_brightness_set)(struct phy_device *dev,
1121 u8 index, enum led_brightness value);
1124 * @led_blink_set: Set a PHY LED brightness. Index indicates
1125 * which of the PHYs led should be configured to blink. Delays
1126 * are in milliseconds and if both are zero then a sensible
1127 * default should be chosen. The call should adjust the
1128 * timings in that case and if it can't match the values
1129 * specified exactly.
1131 int (*led_blink_set)(struct phy_device *dev, u8 index,
1132 unsigned long *delay_on,
1133 unsigned long *delay_off);
1135 * @led_hw_is_supported: Can the HW support the given rules.
1136 * @dev: PHY device which has the LED
1137 * @index: Which LED of the PHY device
1138 * @rules The core is interested in these rules
1140 * Return 0 if yes, -EOPNOTSUPP if not, or an error code.
1142 int (*led_hw_is_supported)(struct phy_device *dev, u8 index,
1143 unsigned long rules);
1145 * @led_hw_control_set: Set the HW to control the LED
1146 * @dev: PHY device which has the LED
1147 * @index: Which LED of the PHY device
1148 * @rules The rules used to control the LED
1150 * Returns 0, or a an error code.
1152 int (*led_hw_control_set)(struct phy_device *dev, u8 index,
1153 unsigned long rules);
1155 * @led_hw_control_get: Get how the HW is controlling the LED
1156 * @dev: PHY device which has the LED
1157 * @index: Which LED of the PHY device
1158 * @rules Pointer to the rules used to control the LED
1160 * Set *@rules to how the HW is currently blinking. Returns 0
1161 * on success, or a error code if the current blinking cannot
1162 * be represented in rules, or some other error happens.
1164 int (*led_hw_control_get)(struct phy_device *dev, u8 index,
1165 unsigned long *rules);
1168 * @led_polarity_set: Set the LED polarity modes
1169 * @dev: PHY device which has the LED
1170 * @index: Which LED of the PHY device
1171 * @modes: bitmap of LED polarity modes
1173 * Configure LED with all the required polarity modes in @modes
1174 * to make it correctly turn ON or OFF.
1176 * Returns 0, or an error code.
1178 int (*led_polarity_set)(struct phy_device *dev, int index,
1179 unsigned long modes);
1181 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \
1182 struct phy_driver, mdiodrv)
1184 #define PHY_ANY_ID "MATCH ANY PHY"
1185 #define PHY_ANY_UID 0xffffffff
1187 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
1188 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
1189 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
1192 * phy_id_compare - compare @id1 with @id2 taking account of @mask
1193 * @id1: first PHY ID
1194 * @id2: second PHY ID
1195 * @mask: the PHY ID mask, set bits are significant in matching
1197 * Return true if the bits from @id1 and @id2 specified by @mask match.
1198 * This uses an equivalent test to (@id & @mask) == (@phy_id & @mask).
1200 static inline bool phy_id_compare(u32 id1, u32 id2, u32 mask)
1202 return !((id1 ^ id2) & mask);
1206 * phydev_id_compare - compare @id with the PHY's Clause 22 ID
1207 * @phydev: the PHY device
1208 * @id: the PHY ID to be matched
1210 * Compare the @phydev clause 22 ID with the provided @id and return true or
1211 * false depending whether it matches, using the bound driver mask. The
1212 * @phydev must be bound to a driver.
1214 static inline bool phydev_id_compare(struct phy_device *phydev, u32 id)
1216 return phy_id_compare(id, phydev->phy_id, phydev->drv->phy_id_mask);
1219 /* A Structure for boards to register fixups with the PHY Lib */
1221 struct list_head list;
1222 char bus_id[MII_BUS_ID_SIZE + 3];
1225 int (*run)(struct phy_device *phydev);
1228 const char *phy_speed_to_str(int speed);
1229 const char *phy_duplex_to_str(unsigned int duplex);
1230 const char *phy_rate_matching_to_str(int rate_matching);
1232 int phy_interface_num_ports(phy_interface_t interface);
1234 /* A structure for mapping a particular speed and duplex
1235 * combination to a particular SUPPORTED and ADVERTISED value
1237 struct phy_setting {
1243 const struct phy_setting *
1244 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
1246 size_t phy_speeds(unsigned int *speeds, size_t size,
1247 unsigned long *mask);
1248 void of_set_phy_supported(struct phy_device *phydev);
1249 void of_set_phy_eee_broken(struct phy_device *phydev);
1250 int phy_speed_down_core(struct phy_device *phydev);
1253 * phy_is_started - Convenience function to check whether PHY is started
1254 * @phydev: The phy_device struct
1256 static inline bool phy_is_started(struct phy_device *phydev)
1258 return phydev->state >= PHY_UP;
1261 void phy_resolve_aneg_pause(struct phy_device *phydev);
1262 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
1263 void phy_check_downshift(struct phy_device *phydev);
1266 * phy_read - Convenience function for reading a given PHY register
1267 * @phydev: the phy_device struct
1268 * @regnum: register number to read
1270 * NOTE: MUST NOT be called from interrupt context,
1271 * because the bus read/write functions may wait for an interrupt
1272 * to conclude the operation.
1274 static inline int phy_read(struct phy_device *phydev, u32 regnum)
1276 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
1279 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \
1280 timeout_us, sleep_before_read) \
1283 __ret = read_poll_timeout(__val = phy_read, val, \
1284 __val < 0 || (cond), \
1285 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \
1289 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1294 * __phy_read - convenience function for reading a given PHY register
1295 * @phydev: the phy_device struct
1296 * @regnum: register number to read
1298 * The caller must have taken the MDIO bus lock.
1300 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
1302 return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
1306 * phy_write - Convenience function for writing a given PHY register
1307 * @phydev: the phy_device struct
1308 * @regnum: register number to write
1309 * @val: value to write to @regnum
1311 * NOTE: MUST NOT be called from interrupt context,
1312 * because the bus read/write functions may wait for an interrupt
1313 * to conclude the operation.
1315 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1317 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
1321 * __phy_write - Convenience function for writing a given PHY register
1322 * @phydev: the phy_device struct
1323 * @regnum: register number to write
1324 * @val: value to write to @regnum
1326 * The caller must have taken the MDIO bus lock.
1328 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1330 return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
1335 * __phy_modify_changed() - Convenience function for modifying a PHY register
1336 * @phydev: a pointer to a &struct phy_device
1337 * @regnum: register number
1338 * @mask: bit mask of bits to clear
1339 * @set: bit mask of bits to set
1341 * Unlocked helper function which allows a PHY register to be modified as
1342 * new register value = (old register value & ~mask) | set
1344 * Returns negative errno, 0 if there was no change, and 1 in case of change
1346 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
1349 return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr,
1354 * phy_read_mmd - Convenience function for reading a register
1355 * from an MMD on a given PHY.
1357 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1360 * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
1361 * condition is met or a timeout occurs
1363 * @phydev: The phy_device struct
1364 * @devaddr: The MMD to read from
1365 * @regnum: The register on the MMD to read
1366 * @val: Variable to read the register into
1367 * @cond: Break condition (usually involving @val)
1368 * @sleep_us: Maximum time to sleep between reads in us (0
1369 * tight-loops). Should be less than ~20ms since usleep_range
1370 * is used (see Documentation/timers/timers-howto.rst).
1371 * @timeout_us: Timeout in us, 0 means never timeout
1372 * @sleep_before_read: if it is true, sleep @sleep_us before read.
1373 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
1374 * case, the last read value at @args is stored in @val. Must not
1375 * be called from atomic context if sleep_us or timeout_us are used.
1377 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
1378 sleep_us, timeout_us, sleep_before_read) \
1381 __ret = read_poll_timeout(__val = phy_read_mmd, val, \
1382 __val < 0 || (cond), \
1383 sleep_us, timeout_us, sleep_before_read, \
1384 phydev, devaddr, regnum); \
1388 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1393 * __phy_read_mmd - Convenience function for reading a register
1394 * from an MMD on a given PHY.
1396 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1399 * phy_write_mmd - Convenience function for writing a register
1400 * on an MMD on a given PHY.
1402 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1405 * __phy_write_mmd - Convenience function for writing a register
1406 * on an MMD on a given PHY.
1408 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1410 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1412 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1414 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1415 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1417 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1419 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1421 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1423 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1427 * __phy_set_bits - Convenience function for setting bits in a PHY register
1428 * @phydev: the phy_device struct
1429 * @regnum: register number to write
1432 * The caller must have taken the MDIO bus lock.
1434 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1436 return __phy_modify(phydev, regnum, 0, val);
1440 * __phy_clear_bits - Convenience function for clearing bits in a PHY register
1441 * @phydev: the phy_device struct
1442 * @regnum: register number to write
1443 * @val: bits to clear
1445 * The caller must have taken the MDIO bus lock.
1447 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
1450 return __phy_modify(phydev, regnum, val, 0);
1454 * phy_set_bits - Convenience function for setting bits in a PHY register
1455 * @phydev: the phy_device struct
1456 * @regnum: register number to write
1459 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1461 return phy_modify(phydev, regnum, 0, val);
1465 * phy_clear_bits - Convenience function for clearing bits in a PHY register
1466 * @phydev: the phy_device struct
1467 * @regnum: register number to write
1468 * @val: bits to clear
1470 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
1472 return phy_modify(phydev, regnum, val, 0);
1476 * __phy_set_bits_mmd - Convenience function for setting bits in a register
1478 * @phydev: the phy_device struct
1479 * @devad: the MMD containing register to modify
1480 * @regnum: register number to modify
1483 * The caller must have taken the MDIO bus lock.
1485 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
1486 u32 regnum, u16 val)
1488 return __phy_modify_mmd(phydev, devad, regnum, 0, val);
1492 * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
1494 * @phydev: the phy_device struct
1495 * @devad: the MMD containing register to modify
1496 * @regnum: register number to modify
1497 * @val: bits to clear
1499 * The caller must have taken the MDIO bus lock.
1501 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1502 u32 regnum, u16 val)
1504 return __phy_modify_mmd(phydev, devad, regnum, val, 0);
1508 * phy_set_bits_mmd - Convenience function for setting bits in a register
1510 * @phydev: the phy_device struct
1511 * @devad: the MMD containing register to modify
1512 * @regnum: register number to modify
1515 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
1516 u32 regnum, u16 val)
1518 return phy_modify_mmd(phydev, devad, regnum, 0, val);
1522 * phy_clear_bits_mmd - Convenience function for clearing bits in a register
1524 * @phydev: the phy_device struct
1525 * @devad: the MMD containing register to modify
1526 * @regnum: register number to modify
1527 * @val: bits to clear
1529 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1530 u32 regnum, u16 val)
1532 return phy_modify_mmd(phydev, devad, regnum, val, 0);
1536 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
1537 * @phydev: the phy_device struct
1539 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
1542 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
1544 return phydev->irq != PHY_POLL && phydev->irq != PHY_MAC_INTERRUPT;
1548 * phy_polling_mode - Convenience function for testing whether polling is
1549 * used to detect PHY status changes
1550 * @phydev: the phy_device struct
1552 static inline bool phy_polling_mode(struct phy_device *phydev)
1554 if (phydev->state == PHY_CABLETEST)
1555 if (phydev->drv->flags & PHY_POLL_CABLE_TEST)
1558 return phydev->irq == PHY_POLL;
1562 * phy_has_hwtstamp - Tests whether a PHY time stamp configuration.
1563 * @phydev: the phy_device struct
1565 static inline bool phy_has_hwtstamp(struct phy_device *phydev)
1567 return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp;
1571 * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping.
1572 * @phydev: the phy_device struct
1574 static inline bool phy_has_rxtstamp(struct phy_device *phydev)
1576 return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp;
1580 * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or
1581 * PTP hardware clock capabilities.
1582 * @phydev: the phy_device struct
1584 static inline bool phy_has_tsinfo(struct phy_device *phydev)
1586 return phydev && phydev->mii_ts && phydev->mii_ts->ts_info;
1590 * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping.
1591 * @phydev: the phy_device struct
1593 static inline bool phy_has_txtstamp(struct phy_device *phydev)
1595 return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp;
1598 static inline int phy_hwtstamp(struct phy_device *phydev,
1599 struct kernel_hwtstamp_config *cfg,
1600 struct netlink_ext_ack *extack)
1602 return phydev->mii_ts->hwtstamp(phydev->mii_ts, cfg, extack);
1605 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb,
1608 return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type);
1611 static inline int phy_ts_info(struct phy_device *phydev,
1612 struct ethtool_ts_info *tsinfo)
1614 return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo);
1617 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb,
1620 phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type);
1624 * phy_is_internal - Convenience function for testing if a PHY is internal
1625 * @phydev: the phy_device struct
1627 static inline bool phy_is_internal(struct phy_device *phydev)
1629 return phydev->is_internal;
1633 * phy_on_sfp - Convenience function for testing if a PHY is on an SFP module
1634 * @phydev: the phy_device struct
1636 static inline bool phy_on_sfp(struct phy_device *phydev)
1638 return phydev->is_on_sfp_module;
1642 * phy_interface_mode_is_rgmii - Convenience function for testing if a
1643 * PHY interface mode is RGMII (all variants)
1644 * @mode: the &phy_interface_t enum
1646 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
1648 return mode >= PHY_INTERFACE_MODE_RGMII &&
1649 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
1653 * phy_interface_mode_is_8023z() - does the PHY interface mode use 802.3z
1655 * @mode: one of &enum phy_interface_t
1657 * Returns true if the PHY interface mode uses the 16-bit negotiation
1658 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
1660 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
1662 return mode == PHY_INTERFACE_MODE_1000BASEX ||
1663 mode == PHY_INTERFACE_MODE_2500BASEX;
1667 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
1668 * is RGMII (all variants)
1669 * @phydev: the phy_device struct
1671 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
1673 return phy_interface_mode_is_rgmii(phydev->interface);
1677 * phy_is_pseudo_fixed_link - Convenience function for testing if this
1678 * PHY is the CPU port facing side of an Ethernet switch, or similar.
1679 * @phydev: the phy_device struct
1681 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
1683 return phydev->is_pseudo_fixed_link;
1686 int phy_save_page(struct phy_device *phydev);
1687 int phy_select_page(struct phy_device *phydev, int page);
1688 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
1689 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
1690 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
1691 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum,
1693 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
1696 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
1698 struct phy_c45_device_ids *c45_ids);
1699 #if IS_ENABLED(CONFIG_PHYLIB)
1700 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id);
1701 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode);
1702 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode);
1703 struct phy_device *device_phy_find_device(struct device *dev);
1704 struct fwnode_handle *fwnode_get_phy_node(const struct fwnode_handle *fwnode);
1705 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
1706 int phy_device_register(struct phy_device *phy);
1707 void phy_device_free(struct phy_device *phydev);
1709 static inline int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
1714 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
1720 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
1725 static inline struct phy_device *device_phy_find_device(struct device *dev)
1731 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode)
1737 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1742 static inline int phy_device_register(struct phy_device *phy)
1747 static inline void phy_device_free(struct phy_device *phydev) { }
1748 #endif /* CONFIG_PHYLIB */
1749 void phy_device_remove(struct phy_device *phydev);
1750 int phy_get_c45_ids(struct phy_device *phydev);
1751 int phy_init_hw(struct phy_device *phydev);
1752 int phy_suspend(struct phy_device *phydev);
1753 int phy_resume(struct phy_device *phydev);
1754 int __phy_resume(struct phy_device *phydev);
1755 int phy_loopback(struct phy_device *phydev, bool enable);
1756 void phy_sfp_attach(void *upstream, struct sfp_bus *bus);
1757 void phy_sfp_detach(void *upstream, struct sfp_bus *bus);
1758 int phy_sfp_probe(struct phy_device *phydev,
1759 const struct sfp_upstream_ops *ops);
1760 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1761 phy_interface_t interface);
1762 struct phy_device *phy_find_first(struct mii_bus *bus);
1763 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1764 u32 flags, phy_interface_t interface);
1765 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1766 void (*handler)(struct net_device *),
1767 phy_interface_t interface);
1768 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1769 void (*handler)(struct net_device *),
1770 phy_interface_t interface);
1771 void phy_disconnect(struct phy_device *phydev);
1772 void phy_detach(struct phy_device *phydev);
1773 void phy_start(struct phy_device *phydev);
1774 void phy_stop(struct phy_device *phydev);
1775 int phy_config_aneg(struct phy_device *phydev);
1776 int _phy_start_aneg(struct phy_device *phydev);
1777 int phy_start_aneg(struct phy_device *phydev);
1778 int phy_aneg_done(struct phy_device *phydev);
1779 int phy_speed_down(struct phy_device *phydev, bool sync);
1780 int phy_speed_up(struct phy_device *phydev);
1781 bool phy_check_valid(int speed, int duplex, unsigned long *features);
1783 int phy_restart_aneg(struct phy_device *phydev);
1784 int phy_reset_after_clk_enable(struct phy_device *phydev);
1786 #if IS_ENABLED(CONFIG_PHYLIB)
1787 int phy_start_cable_test(struct phy_device *phydev,
1788 struct netlink_ext_ack *extack);
1789 int phy_start_cable_test_tdr(struct phy_device *phydev,
1790 struct netlink_ext_ack *extack,
1791 const struct phy_tdr_config *config);
1794 int phy_start_cable_test(struct phy_device *phydev,
1795 struct netlink_ext_ack *extack)
1797 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1801 int phy_start_cable_test_tdr(struct phy_device *phydev,
1802 struct netlink_ext_ack *extack,
1803 const struct phy_tdr_config *config)
1805 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1810 static inline void phy_device_reset(struct phy_device *phydev, int value)
1812 mdio_device_reset(&phydev->mdio, value);
1815 #define phydev_err(_phydev, format, args...) \
1816 dev_err(&_phydev->mdio.dev, format, ##args)
1818 #define phydev_err_probe(_phydev, err, format, args...) \
1819 dev_err_probe(&_phydev->mdio.dev, err, format, ##args)
1821 #define phydev_info(_phydev, format, args...) \
1822 dev_info(&_phydev->mdio.dev, format, ##args)
1824 #define phydev_warn(_phydev, format, args...) \
1825 dev_warn(&_phydev->mdio.dev, format, ##args)
1827 #define phydev_dbg(_phydev, format, args...) \
1828 dev_dbg(&_phydev->mdio.dev, format, ##args)
1830 static inline const char *phydev_name(const struct phy_device *phydev)
1832 return dev_name(&phydev->mdio.dev);
1835 static inline void phy_lock_mdio_bus(struct phy_device *phydev)
1837 mutex_lock(&phydev->mdio.bus->mdio_lock);
1840 static inline void phy_unlock_mdio_bus(struct phy_device *phydev)
1842 mutex_unlock(&phydev->mdio.bus->mdio_lock);
1845 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1847 char *phy_attached_info_irq(struct phy_device *phydev)
1849 void phy_attached_info(struct phy_device *phydev);
1852 int genphy_read_abilities(struct phy_device *phydev);
1853 int genphy_setup_forced(struct phy_device *phydev);
1854 int genphy_restart_aneg(struct phy_device *phydev);
1855 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1856 int genphy_config_eee_advert(struct phy_device *phydev);
1857 int __genphy_config_aneg(struct phy_device *phydev, bool changed);
1858 int genphy_aneg_done(struct phy_device *phydev);
1859 int genphy_update_link(struct phy_device *phydev);
1860 int genphy_read_lpa(struct phy_device *phydev);
1861 int genphy_read_status_fixed(struct phy_device *phydev);
1862 int genphy_read_status(struct phy_device *phydev);
1863 int genphy_read_master_slave(struct phy_device *phydev);
1864 int genphy_suspend(struct phy_device *phydev);
1865 int genphy_resume(struct phy_device *phydev);
1866 int genphy_loopback(struct phy_device *phydev, bool enable);
1867 int genphy_soft_reset(struct phy_device *phydev);
1868 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev);
1870 static inline int genphy_config_aneg(struct phy_device *phydev)
1872 return __genphy_config_aneg(phydev, false);
1875 static inline int genphy_no_config_intr(struct phy_device *phydev)
1879 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1881 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1882 u16 regnum, u16 val);
1885 int genphy_c37_config_aneg(struct phy_device *phydev);
1886 int genphy_c37_read_status(struct phy_device *phydev, bool *changed);
1889 int genphy_c45_restart_aneg(struct phy_device *phydev);
1890 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1891 int genphy_c45_aneg_done(struct phy_device *phydev);
1892 int genphy_c45_read_link(struct phy_device *phydev);
1893 int genphy_c45_read_lpa(struct phy_device *phydev);
1894 int genphy_c45_read_pma(struct phy_device *phydev);
1895 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1896 int genphy_c45_pma_baset1_setup_master_slave(struct phy_device *phydev);
1897 int genphy_c45_an_config_aneg(struct phy_device *phydev);
1898 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1899 int genphy_c45_read_mdix(struct phy_device *phydev);
1900 int genphy_c45_pma_read_abilities(struct phy_device *phydev);
1901 int genphy_c45_pma_read_ext_abilities(struct phy_device *phydev);
1902 int genphy_c45_pma_baset1_read_abilities(struct phy_device *phydev);
1903 int genphy_c45_read_eee_abilities(struct phy_device *phydev);
1904 int genphy_c45_pma_baset1_read_master_slave(struct phy_device *phydev);
1905 int genphy_c45_read_status(struct phy_device *phydev);
1906 int genphy_c45_baset1_read_status(struct phy_device *phydev);
1907 int genphy_c45_config_aneg(struct phy_device *phydev);
1908 int genphy_c45_loopback(struct phy_device *phydev, bool enable);
1909 int genphy_c45_pma_resume(struct phy_device *phydev);
1910 int genphy_c45_pma_suspend(struct phy_device *phydev);
1911 int genphy_c45_fast_retrain(struct phy_device *phydev, bool enable);
1912 int genphy_c45_plca_get_cfg(struct phy_device *phydev,
1913 struct phy_plca_cfg *plca_cfg);
1914 int genphy_c45_plca_set_cfg(struct phy_device *phydev,
1915 const struct phy_plca_cfg *plca_cfg);
1916 int genphy_c45_plca_get_status(struct phy_device *phydev,
1917 struct phy_plca_status *plca_st);
1918 int genphy_c45_eee_is_active(struct phy_device *phydev, unsigned long *adv,
1919 unsigned long *lp, bool *is_enabled);
1920 int genphy_c45_ethtool_get_eee(struct phy_device *phydev,
1921 struct ethtool_keee *data);
1922 int genphy_c45_ethtool_set_eee(struct phy_device *phydev,
1923 struct ethtool_keee *data);
1924 int genphy_c45_write_eee_adv(struct phy_device *phydev, unsigned long *adv);
1925 int genphy_c45_an_config_eee_aneg(struct phy_device *phydev);
1926 int genphy_c45_read_eee_adv(struct phy_device *phydev, unsigned long *adv);
1928 /* Generic C45 PHY driver */
1929 extern struct phy_driver genphy_c45_driver;
1931 /* The gen10g_* functions are the old Clause 45 stub */
1932 int gen10g_config_aneg(struct phy_device *phydev);
1934 static inline int phy_read_status(struct phy_device *phydev)
1939 if (phydev->drv->read_status)
1940 return phydev->drv->read_status(phydev);
1942 return genphy_read_status(phydev);
1945 void phy_driver_unregister(struct phy_driver *drv);
1946 void phy_drivers_unregister(struct phy_driver *drv, int n);
1947 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1948 int phy_drivers_register(struct phy_driver *new_driver, int n,
1949 struct module *owner);
1950 void phy_error(struct phy_device *phydev);
1951 void phy_state_machine(struct work_struct *work);
1952 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies);
1953 void phy_trigger_machine(struct phy_device *phydev);
1954 void phy_mac_interrupt(struct phy_device *phydev);
1955 void phy_start_machine(struct phy_device *phydev);
1956 void phy_stop_machine(struct phy_device *phydev);
1957 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1958 struct ethtool_link_ksettings *cmd);
1959 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1960 const struct ethtool_link_ksettings *cmd);
1961 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1962 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
1963 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd);
1964 int phy_disable_interrupts(struct phy_device *phydev);
1965 void phy_request_interrupt(struct phy_device *phydev);
1966 void phy_free_interrupt(struct phy_device *phydev);
1967 void phy_print_status(struct phy_device *phydev);
1968 int phy_get_rate_matching(struct phy_device *phydev,
1969 phy_interface_t iface);
1970 void phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1971 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1972 void phy_advertise_supported(struct phy_device *phydev);
1973 void phy_advertise_eee_all(struct phy_device *phydev);
1974 void phy_support_sym_pause(struct phy_device *phydev);
1975 void phy_support_asym_pause(struct phy_device *phydev);
1976 void phy_support_eee(struct phy_device *phydev);
1977 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1979 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1980 bool phy_validate_pause(struct phy_device *phydev,
1981 struct ethtool_pauseparam *pp);
1982 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause);
1984 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
1985 const int *delay_values, int size, bool is_rx);
1987 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv,
1988 bool *tx_pause, bool *rx_pause);
1990 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1991 int (*run)(struct phy_device *));
1992 int phy_register_fixup_for_id(const char *bus_id,
1993 int (*run)(struct phy_device *));
1994 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1995 int (*run)(struct phy_device *));
1997 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1998 int phy_unregister_fixup_for_id(const char *bus_id);
1999 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
2001 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
2002 int phy_get_eee_err(struct phy_device *phydev);
2003 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_keee *data);
2004 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_keee *data);
2005 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
2006 void phy_ethtool_get_wol(struct phy_device *phydev,
2007 struct ethtool_wolinfo *wol);
2008 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
2009 struct ethtool_link_ksettings *cmd);
2010 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
2011 const struct ethtool_link_ksettings *cmd);
2012 int phy_ethtool_nway_reset(struct net_device *ndev);
2013 int phy_package_join(struct phy_device *phydev, int base_addr, size_t priv_size);
2014 int of_phy_package_join(struct phy_device *phydev, size_t priv_size);
2015 void phy_package_leave(struct phy_device *phydev);
2016 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
2017 int base_addr, size_t priv_size);
2018 int devm_of_phy_package_join(struct device *dev, struct phy_device *phydev,
2021 int __init mdio_bus_init(void);
2022 void mdio_bus_exit(void);
2024 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data);
2025 int phy_ethtool_get_sset_count(struct phy_device *phydev);
2026 int phy_ethtool_get_stats(struct phy_device *phydev,
2027 struct ethtool_stats *stats, u64 *data);
2028 int phy_ethtool_get_plca_cfg(struct phy_device *phydev,
2029 struct phy_plca_cfg *plca_cfg);
2030 int phy_ethtool_set_plca_cfg(struct phy_device *phydev,
2031 const struct phy_plca_cfg *plca_cfg,
2032 struct netlink_ext_ack *extack);
2033 int phy_ethtool_get_plca_status(struct phy_device *phydev,
2034 struct phy_plca_status *plca_st);
2036 int __phy_hwtstamp_get(struct phy_device *phydev,
2037 struct kernel_hwtstamp_config *config);
2038 int __phy_hwtstamp_set(struct phy_device *phydev,
2039 struct kernel_hwtstamp_config *config,
2040 struct netlink_ext_ack *extack);
2042 static inline int phy_package_address(struct phy_device *phydev,
2043 unsigned int addr_offset)
2045 struct phy_package_shared *shared = phydev->shared;
2046 u8 base_addr = shared->base_addr;
2048 if (addr_offset >= PHY_MAX_ADDR - base_addr)
2051 /* we know that addr will be in the range 0..31 and thus the
2052 * implicit cast to a signed int is not a problem.
2054 return base_addr + addr_offset;
2057 static inline int phy_package_read(struct phy_device *phydev,
2058 unsigned int addr_offset, u32 regnum)
2060 int addr = phy_package_address(phydev, addr_offset);
2065 return mdiobus_read(phydev->mdio.bus, addr, regnum);
2068 static inline int __phy_package_read(struct phy_device *phydev,
2069 unsigned int addr_offset, u32 regnum)
2071 int addr = phy_package_address(phydev, addr_offset);
2076 return __mdiobus_read(phydev->mdio.bus, addr, regnum);
2079 static inline int phy_package_write(struct phy_device *phydev,
2080 unsigned int addr_offset, u32 regnum,
2083 int addr = phy_package_address(phydev, addr_offset);
2088 return mdiobus_write(phydev->mdio.bus, addr, regnum, val);
2091 static inline int __phy_package_write(struct phy_device *phydev,
2092 unsigned int addr_offset, u32 regnum,
2095 int addr = phy_package_address(phydev, addr_offset);
2100 return __mdiobus_write(phydev->mdio.bus, addr, regnum, val);
2103 int __phy_package_read_mmd(struct phy_device *phydev,
2104 unsigned int addr_offset, int devad,
2107 int phy_package_read_mmd(struct phy_device *phydev,
2108 unsigned int addr_offset, int devad,
2111 int __phy_package_write_mmd(struct phy_device *phydev,
2112 unsigned int addr_offset, int devad,
2113 u32 regnum, u16 val);
2115 int phy_package_write_mmd(struct phy_device *phydev,
2116 unsigned int addr_offset, int devad,
2117 u32 regnum, u16 val);
2119 static inline bool __phy_package_set_once(struct phy_device *phydev,
2122 struct phy_package_shared *shared = phydev->shared;
2127 return !test_and_set_bit(b, &shared->flags);
2130 static inline bool phy_package_init_once(struct phy_device *phydev)
2132 return __phy_package_set_once(phydev, PHY_SHARED_F_INIT_DONE);
2135 static inline bool phy_package_probe_once(struct phy_device *phydev)
2137 return __phy_package_set_once(phydev, PHY_SHARED_F_PROBE_DONE);
2140 extern const struct bus_type mdio_bus_type;
2142 struct mdio_board_info {
2144 char modalias[MDIO_NAME_SIZE];
2146 const void *platform_data;
2149 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
2150 int mdiobus_register_board_info(const struct mdio_board_info *info,
2153 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
2162 * phy_module_driver() - Helper macro for registering PHY drivers
2163 * @__phy_drivers: array of PHY drivers to register
2164 * @__count: Numbers of members in array
2166 * Helper macro for PHY drivers which do not do anything special in module
2167 * init/exit. Each module may only use this macro once, and calling it
2168 * replaces module_init() and module_exit().
2170 #define phy_module_driver(__phy_drivers, __count) \
2171 static int __init phy_module_init(void) \
2173 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
2175 module_init(phy_module_init); \
2176 static void __exit phy_module_exit(void) \
2178 phy_drivers_unregister(__phy_drivers, __count); \
2180 module_exit(phy_module_exit)
2182 #define module_phy_driver(__phy_drivers) \
2183 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
2185 bool phy_driver_is_genphy(struct phy_device *phydev);
2186 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
2188 #endif /* __PHY_H */