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
[2];
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: Median-independent interface
91 * @PHY_INTERFACE_MODE_GMII: Gigabit median-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_RGMII: Reduced gigabit media-independent interface
97 * @PHY_INTERFACE_MODE_RGMII_ID: RGMII with Internal RX+TX delay
98 * @PHY_INTERFACE_MODE_RGMII_RXID: RGMII with Internal RX delay
99 * @PHY_INTERFACE_MODE_RGMII_TXID: RGMII with Internal RX delay
100 * @PHY_INTERFACE_MODE_RTBI: Reduced TBI
101 * @PHY_INTERFACE_MODE_SMII: ??? MII
102 * @PHY_INTERFACE_MODE_XGMII: 10 gigabit media-independent interface
103 * @PHY_INTERFACE_MODE_XLGMII:40 gigabit media-independent interface
104 * @PHY_INTERFACE_MODE_MOCA: Multimedia over Coax
105 * @PHY_INTERFACE_MODE_QSGMII: Quad SGMII
106 * @PHY_INTERFACE_MODE_TRGMII: Turbo RGMII
107 * @PHY_INTERFACE_MODE_100BASEX: 100 BaseX
108 * @PHY_INTERFACE_MODE_1000BASEX: 1000 BaseX
109 * @PHY_INTERFACE_MODE_2500BASEX: 2500 BaseX
110 * @PHY_INTERFACE_MODE_5GBASER: 5G BaseR
111 * @PHY_INTERFACE_MODE_RXAUI: Reduced XAUI
112 * @PHY_INTERFACE_MODE_XAUI: 10 Gigabit Attachment Unit Interface
113 * @PHY_INTERFACE_MODE_10GBASER: 10G BaseR
114 * @PHY_INTERFACE_MODE_USXGMII: Universal Serial 10GE MII
115 * @PHY_INTERFACE_MODE_10GKR: 10GBASE-KR - with Clause 73 AN
116 * @PHY_INTERFACE_MODE_MAX: Book keeping
118 * Describes the interface between the MAC and PHY.
121 PHY_INTERFACE_MODE_NA
,
122 PHY_INTERFACE_MODE_INTERNAL
,
123 PHY_INTERFACE_MODE_MII
,
124 PHY_INTERFACE_MODE_GMII
,
125 PHY_INTERFACE_MODE_SGMII
,
126 PHY_INTERFACE_MODE_TBI
,
127 PHY_INTERFACE_MODE_REVMII
,
128 PHY_INTERFACE_MODE_RMII
,
129 PHY_INTERFACE_MODE_RGMII
,
130 PHY_INTERFACE_MODE_RGMII_ID
,
131 PHY_INTERFACE_MODE_RGMII_RXID
,
132 PHY_INTERFACE_MODE_RGMII_TXID
,
133 PHY_INTERFACE_MODE_RTBI
,
134 PHY_INTERFACE_MODE_SMII
,
135 PHY_INTERFACE_MODE_XGMII
,
136 PHY_INTERFACE_MODE_XLGMII
,
137 PHY_INTERFACE_MODE_MOCA
,
138 PHY_INTERFACE_MODE_QSGMII
,
139 PHY_INTERFACE_MODE_TRGMII
,
140 PHY_INTERFACE_MODE_100BASEX
,
141 PHY_INTERFACE_MODE_1000BASEX
,
142 PHY_INTERFACE_MODE_2500BASEX
,
143 PHY_INTERFACE_MODE_5GBASER
,
144 PHY_INTERFACE_MODE_RXAUI
,
145 PHY_INTERFACE_MODE_XAUI
,
146 /* 10GBASE-R, XFI, SFI - single lane 10G Serdes */
147 PHY_INTERFACE_MODE_10GBASER
,
148 PHY_INTERFACE_MODE_USXGMII
,
149 /* 10GBASE-KR - with Clause 73 AN */
150 PHY_INTERFACE_MODE_10GKR
,
151 PHY_INTERFACE_MODE_MAX
,
155 * phy_supported_speeds - return all speeds currently supported by a PHY device
157 unsigned int phy_supported_speeds(struct phy_device
*phy
,
158 unsigned int *speeds
,
162 * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
163 * @interface: enum phy_interface_t value
165 * Description: maps enum &phy_interface_t defined in this file
166 * into the device tree binding of 'phy-mode', so that Ethernet
167 * device driver can get PHY interface from device tree.
169 static inline const char *phy_modes(phy_interface_t interface
)
172 case PHY_INTERFACE_MODE_NA
:
174 case PHY_INTERFACE_MODE_INTERNAL
:
176 case PHY_INTERFACE_MODE_MII
:
178 case PHY_INTERFACE_MODE_GMII
:
180 case PHY_INTERFACE_MODE_SGMII
:
182 case PHY_INTERFACE_MODE_TBI
:
184 case PHY_INTERFACE_MODE_REVMII
:
186 case PHY_INTERFACE_MODE_RMII
:
188 case PHY_INTERFACE_MODE_RGMII
:
190 case PHY_INTERFACE_MODE_RGMII_ID
:
192 case PHY_INTERFACE_MODE_RGMII_RXID
:
194 case PHY_INTERFACE_MODE_RGMII_TXID
:
196 case PHY_INTERFACE_MODE_RTBI
:
198 case PHY_INTERFACE_MODE_SMII
:
200 case PHY_INTERFACE_MODE_XGMII
:
202 case PHY_INTERFACE_MODE_XLGMII
:
204 case PHY_INTERFACE_MODE_MOCA
:
206 case PHY_INTERFACE_MODE_QSGMII
:
208 case PHY_INTERFACE_MODE_TRGMII
:
210 case PHY_INTERFACE_MODE_1000BASEX
:
212 case PHY_INTERFACE_MODE_2500BASEX
:
214 case PHY_INTERFACE_MODE_5GBASER
:
216 case PHY_INTERFACE_MODE_RXAUI
:
218 case PHY_INTERFACE_MODE_XAUI
:
220 case PHY_INTERFACE_MODE_10GBASER
:
222 case PHY_INTERFACE_MODE_USXGMII
:
224 case PHY_INTERFACE_MODE_10GKR
:
226 case PHY_INTERFACE_MODE_100BASEX
:
234 #define PHY_INIT_TIMEOUT 100000
235 #define PHY_FORCE_TIMEOUT 10
237 #define PHY_MAX_ADDR 32
239 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
240 #define PHY_ID_FMT "%s:%02x"
242 #define MII_BUS_ID_SIZE 61
247 struct sfp_upstream_ops
;
251 * struct mdio_bus_stats - Statistics counters for MDIO busses
252 * @transfers: Total number of transfers, i.e. @writes + @reads
253 * @errors: Number of MDIO transfers that returned an error
254 * @writes: Number of write transfers
255 * @reads: Number of read transfers
256 * @syncp: Synchronisation for incrementing statistics
258 struct mdio_bus_stats
{
259 u64_stats_t transfers
;
263 /* Must be last, add new statistics above */
264 struct u64_stats_sync syncp
;
268 * struct phy_package_shared - Shared information in PHY packages
269 * @addr: Common PHY address used to combine PHYs in one package
270 * @refcnt: Number of PHYs connected to this shared data
271 * @flags: Initialization of PHY package
272 * @priv_size: Size of the shared private data @priv
273 * @priv: Driver private data shared across a PHY package
275 * Represents a shared structure between different phydev's in the same
276 * package, for example a quad PHY. See phy_package_join() and
277 * phy_package_leave().
279 struct phy_package_shared
{
285 /* private data pointer */
286 /* note that this pointer is shared between different phydevs and
287 * the user has to take care of appropriate locking. It is allocated
288 * and freed automatically by phy_package_join() and
289 * phy_package_leave().
294 /* used as bit number in atomic bitops */
295 #define PHY_SHARED_F_INIT_DONE 0
296 #define PHY_SHARED_F_PROBE_DONE 1
299 * struct mii_bus - Represents an MDIO bus
301 * @owner: Who owns this device
302 * @name: User friendly name for this MDIO device, or driver name
303 * @id: Unique identifier for this bus, typical from bus hierarchy
304 * @priv: Driver private data
306 * The Bus class for PHYs. Devices which provide access to
307 * PHYs should register using this structure
310 struct module
*owner
;
312 char id
[MII_BUS_ID_SIZE
];
314 /** @read: Perform a read transfer on the bus */
315 int (*read
)(struct mii_bus
*bus
, int addr
, int regnum
);
316 /** @write: Perform a write transfer on the bus */
317 int (*write
)(struct mii_bus
*bus
, int addr
, int regnum
, u16 val
);
318 /** @reset: Perform a reset of the bus */
319 int (*reset
)(struct mii_bus
*bus
);
321 /** @stats: Statistic counters per device on the bus */
322 struct mdio_bus_stats stats
[PHY_MAX_ADDR
];
325 * @mdio_lock: A lock to ensure that only one thing can read/write
326 * the MDIO bus at a time
328 struct mutex mdio_lock
;
330 /** @parent: Parent device of this bus */
331 struct device
*parent
;
332 /** @state: State of bus structure */
334 MDIOBUS_ALLOCATED
= 1,
336 MDIOBUS_UNREGISTERED
,
340 /** @dev: Kernel device representation */
343 /** @mdio_map: list of all MDIO devices on bus */
344 struct mdio_device
*mdio_map
[PHY_MAX_ADDR
];
346 /** @phy_mask: PHY addresses to be ignored when probing */
349 /** @phy_ignore_ta_mask: PHY addresses to ignore the TA/read failure */
350 u32 phy_ignore_ta_mask
;
353 * @irq: An array of interrupts, each PHY's interrupt at the index
354 * matching its address
356 int irq
[PHY_MAX_ADDR
];
358 /** @reset_delay_us: GPIO reset pulse width in microseconds */
360 /** @reset_post_delay_us: GPIO reset deassert delay in microseconds */
361 int reset_post_delay_us
;
362 /** @reset_gpiod: Reset GPIO descriptor pointer */
363 struct gpio_desc
*reset_gpiod
;
365 /** @probe_capabilities: bus capabilities, used for probing */
371 } probe_capabilities
;
373 /** @shared_lock: protect access to the shared element */
374 struct mutex shared_lock
;
376 /** @shared: shared state across different PHYs */
377 struct phy_package_shared
*shared
[PHY_MAX_ADDR
];
379 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
381 struct mii_bus
*mdiobus_alloc_size(size_t size
);
384 * mdiobus_alloc - Allocate an MDIO bus structure
386 * The internal state of the MDIO bus will be set of MDIOBUS_ALLOCATED ready
387 * for the driver to register the bus.
389 static inline struct mii_bus
*mdiobus_alloc(void)
391 return mdiobus_alloc_size(0);
394 int __mdiobus_register(struct mii_bus
*bus
, struct module
*owner
);
395 int __devm_mdiobus_register(struct device
*dev
, struct mii_bus
*bus
,
396 struct module
*owner
);
397 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
398 #define devm_mdiobus_register(dev, bus) \
399 __devm_mdiobus_register(dev, bus, THIS_MODULE)
401 void mdiobus_unregister(struct mii_bus
*bus
);
402 void mdiobus_free(struct mii_bus
*bus
);
403 struct mii_bus
*devm_mdiobus_alloc_size(struct device
*dev
, int sizeof_priv
);
404 static inline struct mii_bus
*devm_mdiobus_alloc(struct device
*dev
)
406 return devm_mdiobus_alloc_size(dev
, 0);
409 struct mii_bus
*mdio_find_bus(const char *mdio_name
);
410 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
);
412 #define PHY_INTERRUPT_DISABLED false
413 #define PHY_INTERRUPT_ENABLED true
416 * enum phy_state - PHY state machine states:
418 * @PHY_DOWN: PHY device and driver are not ready for anything. probe
419 * should be called if and only if the PHY is in this state,
420 * given that the PHY device exists.
421 * - PHY driver probe function will set the state to @PHY_READY
423 * @PHY_READY: PHY is ready to send and receive packets, but the
424 * controller is not. By default, PHYs which do not implement
425 * probe will be set to this state by phy_probe().
426 * - start will set the state to UP
428 * @PHY_UP: The PHY and attached device are ready to do work.
429 * Interrupts should be started here.
430 * - timer moves to @PHY_NOLINK or @PHY_RUNNING
432 * @PHY_NOLINK: PHY is up, but not currently plugged in.
433 * - irq or timer will set @PHY_RUNNING if link comes back
434 * - phy_stop moves to @PHY_HALTED
436 * @PHY_RUNNING: PHY is currently up, running, and possibly sending
437 * and/or receiving packets
438 * - irq or timer will set @PHY_NOLINK if link goes down
439 * - phy_stop moves to @PHY_HALTED
441 * @PHY_CABLETEST: PHY is performing a cable test. Packet reception/sending
442 * is not expected to work, carrier will be indicated as down. PHY will be
443 * poll once per second, or on interrupt for it current state.
444 * Once complete, move to UP to restart the PHY.
445 * - phy_stop aborts the running test and moves to @PHY_HALTED
447 * @PHY_HALTED: PHY is up, but no polling or interrupts are done. Or
448 * PHY is in an error state.
449 * - phy_start moves to @PHY_UP
461 #define MDIO_MMD_NUM 32
464 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
465 * @devices_in_package: IEEE 802.3 devices in package register value.
466 * @mmds_present: bit vector of MMDs present.
467 * @device_ids: The device identifer for each present device.
469 struct phy_c45_device_ids
{
470 u32 devices_in_package
;
472 u32 device_ids
[MDIO_MMD_NUM
];
475 struct macsec_context
;
479 * struct phy_device - An instance of a PHY
481 * @mdio: MDIO bus this PHY is on
482 * @drv: Pointer to the driver for this PHY instance
483 * @phy_id: UID for this device found during discovery
484 * @c45_ids: 802.3-c45 Device Identifiers if is_c45.
485 * @is_c45: Set to true if this PHY uses clause 45 addressing.
486 * @is_internal: Set to true if this PHY is internal to a MAC.
487 * @is_pseudo_fixed_link: Set to true if this PHY is an Ethernet switch, etc.
488 * @is_gigabit_capable: Set to true if PHY supports 1000Mbps
489 * @has_fixups: Set to true if this PHY has fixups/quirks.
490 * @suspended: Set to true if this PHY has been suspended successfully.
491 * @suspended_by_mdio_bus: Set to true if this PHY was suspended by MDIO bus.
492 * @sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
493 * @loopback_enabled: Set true if this PHY has been loopbacked successfully.
494 * @downshifted_rate: Set true if link speed has been downshifted.
495 * @is_on_sfp_module: Set true if PHY is located on an SFP module.
496 * @mac_managed_pm: Set true if MAC driver takes of suspending/resuming PHY
497 * @state: State of the PHY for management purposes
498 * @dev_flags: Device-specific flags used by the PHY driver.
499 * Bits [15:0] are free to use by the PHY driver to communicate
500 * driver specific behavior.
501 * Bits [23:16] are currently reserved for future use.
502 * Bits [31:24] are reserved for defining generic
503 * PHY driver behavior.
504 * @irq: IRQ number of the PHY's interrupt (-1 if none)
505 * @phy_timer: The timer for handling the state machine
506 * @phylink: Pointer to phylink instance for this PHY
507 * @sfp_bus_attached: Flag indicating whether the SFP bus has been attached
508 * @sfp_bus: SFP bus attached to this PHY's fiber port
509 * @attached_dev: The attached enet driver's device instance ptr
510 * @adjust_link: Callback for the enet controller to respond to changes: in the
512 * @phy_link_change: Callback for phylink for notification of link change
513 * @macsec_ops: MACsec offloading ops.
515 * @speed: Current link speed
516 * @duplex: Current duplex
517 * @port: Current port
518 * @pause: Current pause
519 * @asym_pause: Current asymmetric pause
520 * @supported: Combined MAC/PHY supported linkmodes
521 * @advertising: Currently advertised linkmodes
522 * @adv_old: Saved advertised while power saving for WoL
523 * @lp_advertising: Current link partner advertised linkmodes
524 * @eee_broken_modes: Energy efficient ethernet modes which should be prohibited
525 * @autoneg: Flag autoneg being used
526 * @link: Current link state
527 * @autoneg_complete: Flag auto negotiation of the link has completed
528 * @mdix: Current crossover
529 * @mdix_ctrl: User setting of crossover
530 * @interrupts: Flag interrupts have been enabled
531 * @interface: enum phy_interface_t value
532 * @skb: Netlink message for cable diagnostics
533 * @nest: Netlink nest used for cable diagnostics
534 * @ehdr: nNtlink header for cable diagnostics
535 * @phy_led_triggers: Array of LED triggers
536 * @phy_num_led_triggers: Number of triggers in @phy_led_triggers
537 * @led_link_trigger: LED trigger for link up/down
538 * @last_triggered: last LED trigger for link speed
539 * @master_slave_set: User requested master/slave configuration
540 * @master_slave_get: Current master/slave advertisement
541 * @master_slave_state: Current master/slave configuration
542 * @mii_ts: Pointer to time stamper callbacks
543 * @lock: Mutex for serialization access to PHY
544 * @state_queue: Work queue for state machine
545 * @shared: Pointer to private data shared by phys in one package
546 * @priv: Pointer to driver private data
548 * interrupts currently only supports enabled or disabled,
549 * but could be changed in the future to support enabling
550 * and disabling specific interrupts
552 * Contains some infrastructure for polling and interrupt
553 * handling, as well as handling shifts in PHY hardware state
556 struct mdio_device mdio
;
558 /* Information about the PHY type */
559 /* And management functions */
560 struct phy_driver
*drv
;
564 struct phy_c45_device_ids c45_ids
;
566 unsigned is_internal
:1;
567 unsigned is_pseudo_fixed_link
:1;
568 unsigned is_gigabit_capable
:1;
569 unsigned has_fixups
:1;
570 unsigned suspended
:1;
571 unsigned suspended_by_mdio_bus
:1;
572 unsigned sysfs_links
:1;
573 unsigned loopback_enabled
:1;
574 unsigned downshifted_rate
:1;
575 unsigned is_on_sfp_module
:1;
576 unsigned mac_managed_pm
:1;
579 /* The most recently read link state */
581 unsigned autoneg_complete
:1;
583 /* Interrupts are enabled */
584 unsigned interrupts
:1;
586 enum phy_state state
;
590 phy_interface_t interface
;
593 * forced speed & duplex (no autoneg)
594 * partner speed & duplex & pause (autoneg)
603 u8 master_slave_state
;
605 /* Union of PHY and Attached devices' supported link modes */
606 /* See ethtool.h for more info */
607 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported
);
608 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising
);
609 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising
);
610 /* used with phy_speed_down */
611 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old
);
613 /* Energy efficient ethernet modes which should be prohibited */
614 u32 eee_broken_modes
;
616 #ifdef CONFIG_LED_TRIGGER_PHY
617 struct phy_led_trigger
*phy_led_triggers
;
618 unsigned int phy_num_led_triggers
;
619 struct phy_led_trigger
*last_triggered
;
621 struct phy_led_trigger
*led_link_trigger
;
625 * Interrupt number for this PHY
626 * -1 means no interrupt
630 /* private data pointer */
631 /* For use by PHYs to maintain extra state */
634 /* shared data pointer */
635 /* For use by PHYs inside the same package that need a shared state. */
636 struct phy_package_shared
*shared
;
638 /* Reporting cable test results */
643 /* Interrupt and Polling infrastructure */
644 struct delayed_work state_queue
;
648 /* This may be modified under the rtnl lock */
649 bool sfp_bus_attached
;
650 struct sfp_bus
*sfp_bus
;
651 struct phylink
*phylink
;
652 struct net_device
*attached_dev
;
653 struct mii_timestamper
*mii_ts
;
658 void (*phy_link_change
)(struct phy_device
*phydev
, bool up
);
659 void (*adjust_link
)(struct net_device
*dev
);
661 #if IS_ENABLED(CONFIG_MACSEC)
662 /* MACsec management functions */
663 const struct macsec_ops
*macsec_ops
;
667 static inline struct phy_device
*to_phy_device(const struct device
*dev
)
669 return container_of(to_mdio_device(dev
), struct phy_device
, mdio
);
673 * struct phy_tdr_config - Configuration of a TDR raw test
675 * @first: Distance for first data collection point
676 * @last: Distance for last data collection point
677 * @step: Step between data collection points
678 * @pair: Bitmap of cable pairs to collect data for
680 * A structure containing possible configuration parameters
681 * for a TDR cable test. The driver does not need to implement
682 * all the parameters, but should report what is actually used.
683 * All distances are in centimeters.
685 struct phy_tdr_config
{
691 #define PHY_PAIR_ALL -1
694 * struct phy_driver - Driver structure for a particular PHY type
696 * @mdiodrv: Data common to all MDIO devices
697 * @phy_id: The result of reading the UID registers of this PHY
698 * type, and ANDing them with the phy_id_mask. This driver
699 * only works for PHYs with IDs which match this field
700 * @name: The friendly name of this PHY type
701 * @phy_id_mask: Defines the important bits of the phy_id
702 * @features: A mandatory list of features (speed, duplex, etc)
703 * supported by this PHY
704 * @flags: A bitfield defining certain other features this PHY
705 * supports (like interrupts)
706 * @driver_data: Static driver data
708 * All functions are optional. If config_aneg or read_status
709 * are not implemented, the phy core uses the genphy versions.
710 * Note that none of these functions should be called from
711 * interrupt time. The goal is for the bus read/write functions
712 * to be able to block when the bus transaction is happening,
713 * and be freed up by an interrupt (The MPC85xx has this ability,
714 * though it is not currently supported in the driver).
717 struct mdio_driver_common mdiodrv
;
721 const unsigned long * const features
;
723 const void *driver_data
;
726 * @soft_reset: Called to issue a PHY software reset
728 int (*soft_reset
)(struct phy_device
*phydev
);
731 * @config_init: Called to initialize the PHY,
732 * including after a reset
734 int (*config_init
)(struct phy_device
*phydev
);
737 * @probe: Called during discovery. Used to set
738 * up device-specific structures, if any
740 int (*probe
)(struct phy_device
*phydev
);
743 * @get_features: Probe the hardware to determine what
744 * abilities it has. Should only set phydev->supported.
746 int (*get_features
)(struct phy_device
*phydev
);
748 /* PHY Power Management */
749 /** @suspend: Suspend the hardware, saving state if needed */
750 int (*suspend
)(struct phy_device
*phydev
);
751 /** @resume: Resume the hardware, restoring state if needed */
752 int (*resume
)(struct phy_device
*phydev
);
755 * @config_aneg: Configures the advertisement and resets
756 * autonegotiation if phydev->autoneg is on,
757 * forces the speed to the current settings in phydev
758 * if phydev->autoneg is off
760 int (*config_aneg
)(struct phy_device
*phydev
);
762 /** @aneg_done: Determines the auto negotiation result */
763 int (*aneg_done
)(struct phy_device
*phydev
);
765 /** @read_status: Determines the negotiated speed and duplex */
766 int (*read_status
)(struct phy_device
*phydev
);
769 * @config_intr: Enables or disables interrupts.
770 * It should also clear any pending interrupts prior to enabling the
771 * IRQs and after disabling them.
773 int (*config_intr
)(struct phy_device
*phydev
);
775 /** @handle_interrupt: Override default interrupt handling */
776 irqreturn_t (*handle_interrupt
)(struct phy_device
*phydev
);
778 /** @remove: Clears up any memory if needed */
779 void (*remove
)(struct phy_device
*phydev
);
782 * @match_phy_device: Returns true if this is a suitable
783 * driver for the given phydev. If NULL, matching is based on
784 * phy_id and phy_id_mask.
786 int (*match_phy_device
)(struct phy_device
*phydev
);
789 * @set_wol: Some devices (e.g. qnap TS-119P II) require PHY
790 * register changes to enable Wake on LAN, so set_wol is
791 * provided to be called in the ethernet driver's set_wol
794 int (*set_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
797 * @get_wol: See set_wol, but for checking whether Wake on LAN
800 void (*get_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
803 * @link_change_notify: Called to inform a PHY device driver
804 * when the core is about to change the link state. This
805 * callback is supposed to be used as fixup hook for drivers
806 * that need to take action when the link state
807 * changes. Drivers are by no means allowed to mess with the
808 * PHY device structure in their implementations.
810 void (*link_change_notify
)(struct phy_device
*dev
);
813 * @read_mmd: PHY specific driver override for reading a MMD
814 * register. This function is optional for PHY specific
815 * drivers. When not provided, the default MMD read function
816 * will be used by phy_read_mmd(), which will use either a
817 * direct read for Clause 45 PHYs or an indirect read for
818 * Clause 22 PHYs. devnum is the MMD device number within the
819 * PHY device, regnum is the register within the selected MMD
822 int (*read_mmd
)(struct phy_device
*dev
, int devnum
, u16 regnum
);
825 * @write_mmd: PHY specific driver override for writing a MMD
826 * register. This function is optional for PHY specific
827 * drivers. When not provided, the default MMD write function
828 * will be used by phy_write_mmd(), which will use either a
829 * direct write for Clause 45 PHYs, or an indirect write for
830 * Clause 22 PHYs. devnum is the MMD device number within the
831 * PHY device, regnum is the register within the selected MMD
832 * device. val is the value to be written.
834 int (*write_mmd
)(struct phy_device
*dev
, int devnum
, u16 regnum
,
837 /** @read_page: Return the current PHY register page number */
838 int (*read_page
)(struct phy_device
*dev
);
839 /** @write_page: Set the current PHY register page number */
840 int (*write_page
)(struct phy_device
*dev
, int page
);
843 * @module_info: Get the size and type of the eeprom contained
844 * within a plug-in module
846 int (*module_info
)(struct phy_device
*dev
,
847 struct ethtool_modinfo
*modinfo
);
850 * @module_eeprom: Get the eeprom information from the plug-in
853 int (*module_eeprom
)(struct phy_device
*dev
,
854 struct ethtool_eeprom
*ee
, u8
*data
);
856 /** @cable_test_start: Start a cable test */
857 int (*cable_test_start
)(struct phy_device
*dev
);
859 /** @cable_test_tdr_start: Start a raw TDR cable test */
860 int (*cable_test_tdr_start
)(struct phy_device
*dev
,
861 const struct phy_tdr_config
*config
);
864 * @cable_test_get_status: Once per second, or on interrupt,
865 * request the status of the test.
867 int (*cable_test_get_status
)(struct phy_device
*dev
, bool *finished
);
869 /* Get statistics from the PHY using ethtool */
870 /** @get_sset_count: Number of statistic counters */
871 int (*get_sset_count
)(struct phy_device
*dev
);
872 /** @get_strings: Names of the statistic counters */
873 void (*get_strings
)(struct phy_device
*dev
, u8
*data
);
874 /** @get_stats: Return the statistic counter values */
875 void (*get_stats
)(struct phy_device
*dev
,
876 struct ethtool_stats
*stats
, u64
*data
);
878 /* Get and Set PHY tunables */
879 /** @get_tunable: Return the value of a tunable */
880 int (*get_tunable
)(struct phy_device
*dev
,
881 struct ethtool_tunable
*tuna
, void *data
);
882 /** @set_tunable: Set the value of a tunable */
883 int (*set_tunable
)(struct phy_device
*dev
,
884 struct ethtool_tunable
*tuna
,
886 /** @set_loopback: Set the loopback mood of the PHY */
887 int (*set_loopback
)(struct phy_device
*dev
, bool enable
);
888 /** @get_sqi: Get the signal quality indication */
889 int (*get_sqi
)(struct phy_device
*dev
);
890 /** @get_sqi_max: Get the maximum signal quality indication */
891 int (*get_sqi_max
)(struct phy_device
*dev
);
893 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \
894 struct phy_driver, mdiodrv)
896 #define PHY_ANY_ID "MATCH ANY PHY"
897 #define PHY_ANY_UID 0xffffffff
899 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
900 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
901 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
903 /* A Structure for boards to register fixups with the PHY Lib */
905 struct list_head list
;
906 char bus_id
[MII_BUS_ID_SIZE
+ 3];
909 int (*run
)(struct phy_device
*phydev
);
912 const char *phy_speed_to_str(int speed
);
913 const char *phy_duplex_to_str(unsigned int duplex
);
915 /* A structure for mapping a particular speed and duplex
916 * combination to a particular SUPPORTED and ADVERTISED value
924 const struct phy_setting
*
925 phy_lookup_setting(int speed
, int duplex
, const unsigned long *mask
,
927 size_t phy_speeds(unsigned int *speeds
, size_t size
,
928 unsigned long *mask
);
929 void of_set_phy_supported(struct phy_device
*phydev
);
930 void of_set_phy_eee_broken(struct phy_device
*phydev
);
931 int phy_speed_down_core(struct phy_device
*phydev
);
934 * phy_is_started - Convenience function to check whether PHY is started
935 * @phydev: The phy_device struct
937 static inline bool phy_is_started(struct phy_device
*phydev
)
939 return phydev
->state
>= PHY_UP
;
942 void phy_resolve_aneg_pause(struct phy_device
*phydev
);
943 void phy_resolve_aneg_linkmode(struct phy_device
*phydev
);
944 void phy_check_downshift(struct phy_device
*phydev
);
947 * phy_read - Convenience function for reading a given PHY register
948 * @phydev: the phy_device struct
949 * @regnum: register number to read
951 * NOTE: MUST NOT be called from interrupt context,
952 * because the bus read/write functions may wait for an interrupt
953 * to conclude the operation.
955 static inline int phy_read(struct phy_device
*phydev
, u32 regnum
)
957 return mdiobus_read(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
);
960 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \
961 timeout_us, sleep_before_read) \
963 int __ret = read_poll_timeout(phy_read, val, (cond) || val < 0, \
964 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \
968 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
974 * __phy_read - convenience function for reading a given PHY register
975 * @phydev: the phy_device struct
976 * @regnum: register number to read
978 * The caller must have taken the MDIO bus lock.
980 static inline int __phy_read(struct phy_device
*phydev
, u32 regnum
)
982 return __mdiobus_read(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
);
986 * phy_write - Convenience function for writing a given PHY register
987 * @phydev: the phy_device struct
988 * @regnum: register number to write
989 * @val: value to write to @regnum
991 * NOTE: MUST NOT be called from interrupt context,
992 * because the bus read/write functions may wait for an interrupt
993 * to conclude the operation.
995 static inline int phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
997 return mdiobus_write(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
, val
);
1001 * __phy_write - Convenience function for writing a given PHY register
1002 * @phydev: the phy_device struct
1003 * @regnum: register number to write
1004 * @val: value to write to @regnum
1006 * The caller must have taken the MDIO bus lock.
1008 static inline int __phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
1010 return __mdiobus_write(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
,
1015 * __phy_modify_changed() - Convenience function for modifying a PHY register
1016 * @phydev: a pointer to a &struct phy_device
1017 * @regnum: register number
1018 * @mask: bit mask of bits to clear
1019 * @set: bit mask of bits to set
1021 * Unlocked helper function which allows a PHY register to be modified as
1022 * new register value = (old register value & ~mask) | set
1024 * Returns negative errno, 0 if there was no change, and 1 in case of change
1026 static inline int __phy_modify_changed(struct phy_device
*phydev
, u32 regnum
,
1029 return __mdiobus_modify_changed(phydev
->mdio
.bus
, phydev
->mdio
.addr
,
1034 * phy_read_mmd - Convenience function for reading a register
1035 * from an MMD on a given PHY.
1037 int phy_read_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
);
1040 * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
1041 * condition is met or a timeout occurs
1043 * @phydev: The phy_device struct
1044 * @devaddr: The MMD to read from
1045 * @regnum: The register on the MMD to read
1046 * @val: Variable to read the register into
1047 * @cond: Break condition (usually involving @val)
1048 * @sleep_us: Maximum time to sleep between reads in us (0
1049 * tight-loops). Should be less than ~20ms since usleep_range
1050 * is used (see Documentation/timers/timers-howto.rst).
1051 * @timeout_us: Timeout in us, 0 means never timeout
1052 * @sleep_before_read: if it is true, sleep @sleep_us before read.
1053 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
1054 * case, the last read value at @args is stored in @val. Must not
1055 * be called from atomic context if sleep_us or timeout_us are used.
1057 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
1058 sleep_us, timeout_us, sleep_before_read) \
1060 int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
1061 sleep_us, timeout_us, sleep_before_read, \
1062 phydev, devaddr, regnum); \
1066 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1071 * __phy_read_mmd - Convenience function for reading a register
1072 * from an MMD on a given PHY.
1074 int __phy_read_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
);
1077 * phy_write_mmd - Convenience function for writing a register
1078 * on an MMD on a given PHY.
1080 int phy_write_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
, u16 val
);
1083 * __phy_write_mmd - Convenience function for writing a register
1084 * on an MMD on a given PHY.
1086 int __phy_write_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
, u16 val
);
1088 int __phy_modify_changed(struct phy_device
*phydev
, u32 regnum
, u16 mask
,
1090 int phy_modify_changed(struct phy_device
*phydev
, u32 regnum
, u16 mask
,
1092 int __phy_modify(struct phy_device
*phydev
, u32 regnum
, u16 mask
, u16 set
);
1093 int phy_modify(struct phy_device
*phydev
, u32 regnum
, u16 mask
, u16 set
);
1095 int __phy_modify_mmd_changed(struct phy_device
*phydev
, int devad
, u32 regnum
,
1097 int phy_modify_mmd_changed(struct phy_device
*phydev
, int devad
, u32 regnum
,
1099 int __phy_modify_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
,
1101 int phy_modify_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
,
1105 * __phy_set_bits - Convenience function for setting bits in a PHY register
1106 * @phydev: the phy_device struct
1107 * @regnum: register number to write
1110 * The caller must have taken the MDIO bus lock.
1112 static inline int __phy_set_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
1114 return __phy_modify(phydev
, regnum
, 0, val
);
1118 * __phy_clear_bits - Convenience function for clearing bits in a PHY register
1119 * @phydev: the phy_device struct
1120 * @regnum: register number to write
1121 * @val: bits to clear
1123 * The caller must have taken the MDIO bus lock.
1125 static inline int __phy_clear_bits(struct phy_device
*phydev
, u32 regnum
,
1128 return __phy_modify(phydev
, regnum
, val
, 0);
1132 * phy_set_bits - Convenience function for setting bits in a PHY register
1133 * @phydev: the phy_device struct
1134 * @regnum: register number to write
1137 static inline int phy_set_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
1139 return phy_modify(phydev
, regnum
, 0, val
);
1143 * phy_clear_bits - Convenience function for clearing bits in a PHY register
1144 * @phydev: the phy_device struct
1145 * @regnum: register number to write
1146 * @val: bits to clear
1148 static inline int phy_clear_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
1150 return phy_modify(phydev
, regnum
, val
, 0);
1154 * __phy_set_bits_mmd - Convenience function for setting bits in a register
1156 * @phydev: the phy_device struct
1157 * @devad: the MMD containing register to modify
1158 * @regnum: register number to modify
1161 * The caller must have taken the MDIO bus lock.
1163 static inline int __phy_set_bits_mmd(struct phy_device
*phydev
, int devad
,
1164 u32 regnum
, u16 val
)
1166 return __phy_modify_mmd(phydev
, devad
, regnum
, 0, val
);
1170 * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
1172 * @phydev: the phy_device struct
1173 * @devad: the MMD containing register to modify
1174 * @regnum: register number to modify
1175 * @val: bits to clear
1177 * The caller must have taken the MDIO bus lock.
1179 static inline int __phy_clear_bits_mmd(struct phy_device
*phydev
, int devad
,
1180 u32 regnum
, u16 val
)
1182 return __phy_modify_mmd(phydev
, devad
, regnum
, val
, 0);
1186 * phy_set_bits_mmd - Convenience function for setting bits in a register
1188 * @phydev: the phy_device struct
1189 * @devad: the MMD containing register to modify
1190 * @regnum: register number to modify
1193 static inline int phy_set_bits_mmd(struct phy_device
*phydev
, int devad
,
1194 u32 regnum
, u16 val
)
1196 return phy_modify_mmd(phydev
, devad
, regnum
, 0, val
);
1200 * phy_clear_bits_mmd - Convenience function for clearing bits in a register
1202 * @phydev: the phy_device struct
1203 * @devad: the MMD containing register to modify
1204 * @regnum: register number to modify
1205 * @val: bits to clear
1207 static inline int phy_clear_bits_mmd(struct phy_device
*phydev
, int devad
,
1208 u32 regnum
, u16 val
)
1210 return phy_modify_mmd(phydev
, devad
, regnum
, val
, 0);
1214 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
1215 * @phydev: the phy_device struct
1217 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
1220 static inline bool phy_interrupt_is_valid(struct phy_device
*phydev
)
1222 return phydev
->irq
!= PHY_POLL
&& phydev
->irq
!= PHY_MAC_INTERRUPT
;
1226 * phy_polling_mode - Convenience function for testing whether polling is
1227 * used to detect PHY status changes
1228 * @phydev: the phy_device struct
1230 static inline bool phy_polling_mode(struct phy_device
*phydev
)
1232 if (phydev
->state
== PHY_CABLETEST
)
1233 if (phydev
->drv
->flags
& PHY_POLL_CABLE_TEST
)
1236 return phydev
->irq
== PHY_POLL
;
1240 * phy_has_hwtstamp - Tests whether a PHY time stamp configuration.
1241 * @phydev: the phy_device struct
1243 static inline bool phy_has_hwtstamp(struct phy_device
*phydev
)
1245 return phydev
&& phydev
->mii_ts
&& phydev
->mii_ts
->hwtstamp
;
1249 * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping.
1250 * @phydev: the phy_device struct
1252 static inline bool phy_has_rxtstamp(struct phy_device
*phydev
)
1254 return phydev
&& phydev
->mii_ts
&& phydev
->mii_ts
->rxtstamp
;
1258 * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or
1259 * PTP hardware clock capabilities.
1260 * @phydev: the phy_device struct
1262 static inline bool phy_has_tsinfo(struct phy_device
*phydev
)
1264 return phydev
&& phydev
->mii_ts
&& phydev
->mii_ts
->ts_info
;
1268 * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping.
1269 * @phydev: the phy_device struct
1271 static inline bool phy_has_txtstamp(struct phy_device
*phydev
)
1273 return phydev
&& phydev
->mii_ts
&& phydev
->mii_ts
->txtstamp
;
1276 static inline int phy_hwtstamp(struct phy_device
*phydev
, struct ifreq
*ifr
)
1278 return phydev
->mii_ts
->hwtstamp(phydev
->mii_ts
, ifr
);
1281 static inline bool phy_rxtstamp(struct phy_device
*phydev
, struct sk_buff
*skb
,
1284 return phydev
->mii_ts
->rxtstamp(phydev
->mii_ts
, skb
, type
);
1287 static inline int phy_ts_info(struct phy_device
*phydev
,
1288 struct ethtool_ts_info
*tsinfo
)
1290 return phydev
->mii_ts
->ts_info(phydev
->mii_ts
, tsinfo
);
1293 static inline void phy_txtstamp(struct phy_device
*phydev
, struct sk_buff
*skb
,
1296 phydev
->mii_ts
->txtstamp(phydev
->mii_ts
, skb
, type
);
1300 * phy_is_internal - Convenience function for testing if a PHY is internal
1301 * @phydev: the phy_device struct
1303 static inline bool phy_is_internal(struct phy_device
*phydev
)
1305 return phydev
->is_internal
;
1309 * phy_on_sfp - Convenience function for testing if a PHY is on an SFP module
1310 * @phydev: the phy_device struct
1312 static inline bool phy_on_sfp(struct phy_device
*phydev
)
1314 return phydev
->is_on_sfp_module
;
1318 * phy_interface_mode_is_rgmii - Convenience function for testing if a
1319 * PHY interface mode is RGMII (all variants)
1320 * @mode: the &phy_interface_t enum
1322 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode
)
1324 return mode
>= PHY_INTERFACE_MODE_RGMII
&&
1325 mode
<= PHY_INTERFACE_MODE_RGMII_TXID
;
1329 * phy_interface_mode_is_8023z() - does the PHY interface mode use 802.3z
1331 * @mode: one of &enum phy_interface_t
1333 * Returns true if the PHY interface mode uses the 16-bit negotiation
1334 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
1336 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode
)
1338 return mode
== PHY_INTERFACE_MODE_1000BASEX
||
1339 mode
== PHY_INTERFACE_MODE_2500BASEX
;
1343 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
1344 * is RGMII (all variants)
1345 * @phydev: the phy_device struct
1347 static inline bool phy_interface_is_rgmii(struct phy_device
*phydev
)
1349 return phy_interface_mode_is_rgmii(phydev
->interface
);
1353 * phy_is_pseudo_fixed_link - Convenience function for testing if this
1354 * PHY is the CPU port facing side of an Ethernet switch, or similar.
1355 * @phydev: the phy_device struct
1357 static inline bool phy_is_pseudo_fixed_link(struct phy_device
*phydev
)
1359 return phydev
->is_pseudo_fixed_link
;
1362 int phy_save_page(struct phy_device
*phydev
);
1363 int phy_select_page(struct phy_device
*phydev
, int page
);
1364 int phy_restore_page(struct phy_device
*phydev
, int oldpage
, int ret
);
1365 int phy_read_paged(struct phy_device
*phydev
, int page
, u32 regnum
);
1366 int phy_write_paged(struct phy_device
*phydev
, int page
, u32 regnum
, u16 val
);
1367 int phy_modify_paged_changed(struct phy_device
*phydev
, int page
, u32 regnum
,
1369 int phy_modify_paged(struct phy_device
*phydev
, int page
, u32 regnum
,
1372 struct phy_device
*phy_device_create(struct mii_bus
*bus
, int addr
, u32 phy_id
,
1374 struct phy_c45_device_ids
*c45_ids
);
1375 #if IS_ENABLED(CONFIG_PHYLIB)
1376 struct phy_device
*get_phy_device(struct mii_bus
*bus
, int addr
, bool is_c45
);
1377 int phy_device_register(struct phy_device
*phy
);
1378 void phy_device_free(struct phy_device
*phydev
);
1381 struct phy_device
*get_phy_device(struct mii_bus
*bus
, int addr
, bool is_c45
)
1386 static inline int phy_device_register(struct phy_device
*phy
)
1391 static inline void phy_device_free(struct phy_device
*phydev
) { }
1392 #endif /* CONFIG_PHYLIB */
1393 void phy_device_remove(struct phy_device
*phydev
);
1394 int phy_init_hw(struct phy_device
*phydev
);
1395 int phy_suspend(struct phy_device
*phydev
);
1396 int phy_resume(struct phy_device
*phydev
);
1397 int __phy_resume(struct phy_device
*phydev
);
1398 int phy_loopback(struct phy_device
*phydev
, bool enable
);
1399 void phy_sfp_attach(void *upstream
, struct sfp_bus
*bus
);
1400 void phy_sfp_detach(void *upstream
, struct sfp_bus
*bus
);
1401 int phy_sfp_probe(struct phy_device
*phydev
,
1402 const struct sfp_upstream_ops
*ops
);
1403 struct phy_device
*phy_attach(struct net_device
*dev
, const char *bus_id
,
1404 phy_interface_t interface
);
1405 struct phy_device
*phy_find_first(struct mii_bus
*bus
);
1406 int phy_attach_direct(struct net_device
*dev
, struct phy_device
*phydev
,
1407 u32 flags
, phy_interface_t interface
);
1408 int phy_connect_direct(struct net_device
*dev
, struct phy_device
*phydev
,
1409 void (*handler
)(struct net_device
*),
1410 phy_interface_t interface
);
1411 struct phy_device
*phy_connect(struct net_device
*dev
, const char *bus_id
,
1412 void (*handler
)(struct net_device
*),
1413 phy_interface_t interface
);
1414 void phy_disconnect(struct phy_device
*phydev
);
1415 void phy_detach(struct phy_device
*phydev
);
1416 void phy_start(struct phy_device
*phydev
);
1417 void phy_stop(struct phy_device
*phydev
);
1418 int phy_config_aneg(struct phy_device
*phydev
);
1419 int phy_start_aneg(struct phy_device
*phydev
);
1420 int phy_aneg_done(struct phy_device
*phydev
);
1421 int phy_speed_down(struct phy_device
*phydev
, bool sync
);
1422 int phy_speed_up(struct phy_device
*phydev
);
1424 int phy_restart_aneg(struct phy_device
*phydev
);
1425 int phy_reset_after_clk_enable(struct phy_device
*phydev
);
1427 #if IS_ENABLED(CONFIG_PHYLIB)
1428 int phy_start_cable_test(struct phy_device
*phydev
,
1429 struct netlink_ext_ack
*extack
);
1430 int phy_start_cable_test_tdr(struct phy_device
*phydev
,
1431 struct netlink_ext_ack
*extack
,
1432 const struct phy_tdr_config
*config
);
1435 int phy_start_cable_test(struct phy_device
*phydev
,
1436 struct netlink_ext_ack
*extack
)
1438 NL_SET_ERR_MSG(extack
, "Kernel not compiled with PHYLIB support");
1442 int phy_start_cable_test_tdr(struct phy_device
*phydev
,
1443 struct netlink_ext_ack
*extack
,
1444 const struct phy_tdr_config
*config
)
1446 NL_SET_ERR_MSG(extack
, "Kernel not compiled with PHYLIB support");
1451 int phy_cable_test_result(struct phy_device
*phydev
, u8 pair
, u16 result
);
1452 int phy_cable_test_fault_length(struct phy_device
*phydev
, u8 pair
,
1455 static inline void phy_device_reset(struct phy_device
*phydev
, int value
)
1457 mdio_device_reset(&phydev
->mdio
, value
);
1460 #define phydev_err(_phydev, format, args...) \
1461 dev_err(&_phydev->mdio.dev, format, ##args)
1463 #define phydev_info(_phydev, format, args...) \
1464 dev_info(&_phydev->mdio.dev, format, ##args)
1466 #define phydev_warn(_phydev, format, args...) \
1467 dev_warn(&_phydev->mdio.dev, format, ##args)
1469 #define phydev_dbg(_phydev, format, args...) \
1470 dev_dbg(&_phydev->mdio.dev, format, ##args)
1472 static inline const char *phydev_name(const struct phy_device
*phydev
)
1474 return dev_name(&phydev
->mdio
.dev
);
1477 static inline void phy_lock_mdio_bus(struct phy_device
*phydev
)
1479 mutex_lock(&phydev
->mdio
.bus
->mdio_lock
);
1482 static inline void phy_unlock_mdio_bus(struct phy_device
*phydev
)
1484 mutex_unlock(&phydev
->mdio
.bus
->mdio_lock
);
1487 void phy_attached_print(struct phy_device
*phydev
, const char *fmt
, ...)
1489 char *phy_attached_info_irq(struct phy_device
*phydev
)
1491 void phy_attached_info(struct phy_device
*phydev
);
1494 int genphy_read_abilities(struct phy_device
*phydev
);
1495 int genphy_setup_forced(struct phy_device
*phydev
);
1496 int genphy_restart_aneg(struct phy_device
*phydev
);
1497 int genphy_check_and_restart_aneg(struct phy_device
*phydev
, bool restart
);
1498 int genphy_config_eee_advert(struct phy_device
*phydev
);
1499 int __genphy_config_aneg(struct phy_device
*phydev
, bool changed
);
1500 int genphy_aneg_done(struct phy_device
*phydev
);
1501 int genphy_update_link(struct phy_device
*phydev
);
1502 int genphy_read_lpa(struct phy_device
*phydev
);
1503 int genphy_read_status_fixed(struct phy_device
*phydev
);
1504 int genphy_read_status(struct phy_device
*phydev
);
1505 int genphy_suspend(struct phy_device
*phydev
);
1506 int genphy_resume(struct phy_device
*phydev
);
1507 int genphy_loopback(struct phy_device
*phydev
, bool enable
);
1508 int genphy_soft_reset(struct phy_device
*phydev
);
1509 irqreturn_t
genphy_handle_interrupt_no_ack(struct phy_device
*phydev
);
1511 static inline int genphy_config_aneg(struct phy_device
*phydev
)
1513 return __genphy_config_aneg(phydev
, false);
1516 static inline int genphy_no_config_intr(struct phy_device
*phydev
)
1520 int genphy_read_mmd_unsupported(struct phy_device
*phdev
, int devad
,
1522 int genphy_write_mmd_unsupported(struct phy_device
*phdev
, int devnum
,
1523 u16 regnum
, u16 val
);
1526 int genphy_c37_config_aneg(struct phy_device
*phydev
);
1527 int genphy_c37_read_status(struct phy_device
*phydev
);
1530 int genphy_c45_restart_aneg(struct phy_device
*phydev
);
1531 int genphy_c45_check_and_restart_aneg(struct phy_device
*phydev
, bool restart
);
1532 int genphy_c45_aneg_done(struct phy_device
*phydev
);
1533 int genphy_c45_read_link(struct phy_device
*phydev
);
1534 int genphy_c45_read_lpa(struct phy_device
*phydev
);
1535 int genphy_c45_read_pma(struct phy_device
*phydev
);
1536 int genphy_c45_pma_setup_forced(struct phy_device
*phydev
);
1537 int genphy_c45_an_config_aneg(struct phy_device
*phydev
);
1538 int genphy_c45_an_disable_aneg(struct phy_device
*phydev
);
1539 int genphy_c45_read_mdix(struct phy_device
*phydev
);
1540 int genphy_c45_pma_read_abilities(struct phy_device
*phydev
);
1541 int genphy_c45_read_status(struct phy_device
*phydev
);
1542 int genphy_c45_config_aneg(struct phy_device
*phydev
);
1543 int genphy_c45_loopback(struct phy_device
*phydev
, bool enable
);
1544 int genphy_c45_pma_resume(struct phy_device
*phydev
);
1545 int genphy_c45_pma_suspend(struct phy_device
*phydev
);
1547 /* Generic C45 PHY driver */
1548 extern struct phy_driver genphy_c45_driver
;
1550 /* The gen10g_* functions are the old Clause 45 stub */
1551 int gen10g_config_aneg(struct phy_device
*phydev
);
1553 static inline int phy_read_status(struct phy_device
*phydev
)
1558 if (phydev
->drv
->read_status
)
1559 return phydev
->drv
->read_status(phydev
);
1561 return genphy_read_status(phydev
);
1564 void phy_driver_unregister(struct phy_driver
*drv
);
1565 void phy_drivers_unregister(struct phy_driver
*drv
, int n
);
1566 int phy_driver_register(struct phy_driver
*new_driver
, struct module
*owner
);
1567 int phy_drivers_register(struct phy_driver
*new_driver
, int n
,
1568 struct module
*owner
);
1569 void phy_error(struct phy_device
*phydev
);
1570 void phy_state_machine(struct work_struct
*work
);
1571 void phy_queue_state_machine(struct phy_device
*phydev
, unsigned long jiffies
);
1572 void phy_trigger_machine(struct phy_device
*phydev
);
1573 void phy_mac_interrupt(struct phy_device
*phydev
);
1574 void phy_start_machine(struct phy_device
*phydev
);
1575 void phy_stop_machine(struct phy_device
*phydev
);
1576 void phy_ethtool_ksettings_get(struct phy_device
*phydev
,
1577 struct ethtool_link_ksettings
*cmd
);
1578 int phy_ethtool_ksettings_set(struct phy_device
*phydev
,
1579 const struct ethtool_link_ksettings
*cmd
);
1580 int phy_mii_ioctl(struct phy_device
*phydev
, struct ifreq
*ifr
, int cmd
);
1581 int phy_do_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
);
1582 int phy_do_ioctl_running(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
);
1583 int phy_disable_interrupts(struct phy_device
*phydev
);
1584 void phy_request_interrupt(struct phy_device
*phydev
);
1585 void phy_free_interrupt(struct phy_device
*phydev
);
1586 void phy_print_status(struct phy_device
*phydev
);
1587 int phy_set_max_speed(struct phy_device
*phydev
, u32 max_speed
);
1588 void phy_remove_link_mode(struct phy_device
*phydev
, u32 link_mode
);
1589 void phy_advertise_supported(struct phy_device
*phydev
);
1590 void phy_support_sym_pause(struct phy_device
*phydev
);
1591 void phy_support_asym_pause(struct phy_device
*phydev
);
1592 void phy_set_sym_pause(struct phy_device
*phydev
, bool rx
, bool tx
,
1594 void phy_set_asym_pause(struct phy_device
*phydev
, bool rx
, bool tx
);
1595 bool phy_validate_pause(struct phy_device
*phydev
,
1596 struct ethtool_pauseparam
*pp
);
1597 void phy_get_pause(struct phy_device
*phydev
, bool *tx_pause
, bool *rx_pause
);
1599 s32
phy_get_internal_delay(struct phy_device
*phydev
, struct device
*dev
,
1600 const int *delay_values
, int size
, bool is_rx
);
1602 void phy_resolve_pause(unsigned long *local_adv
, unsigned long *partner_adv
,
1603 bool *tx_pause
, bool *rx_pause
);
1605 int phy_register_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
,
1606 int (*run
)(struct phy_device
*));
1607 int phy_register_fixup_for_id(const char *bus_id
,
1608 int (*run
)(struct phy_device
*));
1609 int phy_register_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
,
1610 int (*run
)(struct phy_device
*));
1612 int phy_unregister_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
);
1613 int phy_unregister_fixup_for_id(const char *bus_id
);
1614 int phy_unregister_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
);
1616 int phy_init_eee(struct phy_device
*phydev
, bool clk_stop_enable
);
1617 int phy_get_eee_err(struct phy_device
*phydev
);
1618 int phy_ethtool_set_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
1619 int phy_ethtool_get_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
1620 int phy_ethtool_set_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
);
1621 void phy_ethtool_get_wol(struct phy_device
*phydev
,
1622 struct ethtool_wolinfo
*wol
);
1623 int phy_ethtool_get_link_ksettings(struct net_device
*ndev
,
1624 struct ethtool_link_ksettings
*cmd
);
1625 int phy_ethtool_set_link_ksettings(struct net_device
*ndev
,
1626 const struct ethtool_link_ksettings
*cmd
);
1627 int phy_ethtool_nway_reset(struct net_device
*ndev
);
1628 int phy_package_join(struct phy_device
*phydev
, int addr
, size_t priv_size
);
1629 void phy_package_leave(struct phy_device
*phydev
);
1630 int devm_phy_package_join(struct device
*dev
, struct phy_device
*phydev
,
1631 int addr
, size_t priv_size
);
1633 #if IS_ENABLED(CONFIG_PHYLIB)
1634 int __init
mdio_bus_init(void);
1635 void mdio_bus_exit(void);
1638 int phy_ethtool_get_strings(struct phy_device
*phydev
, u8
*data
);
1639 int phy_ethtool_get_sset_count(struct phy_device
*phydev
);
1640 int phy_ethtool_get_stats(struct phy_device
*phydev
,
1641 struct ethtool_stats
*stats
, u64
*data
);
1643 static inline int phy_package_read(struct phy_device
*phydev
, u32 regnum
)
1645 struct phy_package_shared
*shared
= phydev
->shared
;
1650 return mdiobus_read(phydev
->mdio
.bus
, shared
->addr
, regnum
);
1653 static inline int __phy_package_read(struct phy_device
*phydev
, u32 regnum
)
1655 struct phy_package_shared
*shared
= phydev
->shared
;
1660 return __mdiobus_read(phydev
->mdio
.bus
, shared
->addr
, regnum
);
1663 static inline int phy_package_write(struct phy_device
*phydev
,
1664 u32 regnum
, u16 val
)
1666 struct phy_package_shared
*shared
= phydev
->shared
;
1671 return mdiobus_write(phydev
->mdio
.bus
, shared
->addr
, regnum
, val
);
1674 static inline int __phy_package_write(struct phy_device
*phydev
,
1675 u32 regnum
, u16 val
)
1677 struct phy_package_shared
*shared
= phydev
->shared
;
1682 return __mdiobus_write(phydev
->mdio
.bus
, shared
->addr
, regnum
, val
);
1685 static inline bool __phy_package_set_once(struct phy_device
*phydev
,
1688 struct phy_package_shared
*shared
= phydev
->shared
;
1693 return !test_and_set_bit(b
, &shared
->flags
);
1696 static inline bool phy_package_init_once(struct phy_device
*phydev
)
1698 return __phy_package_set_once(phydev
, PHY_SHARED_F_INIT_DONE
);
1701 static inline bool phy_package_probe_once(struct phy_device
*phydev
)
1703 return __phy_package_set_once(phydev
, PHY_SHARED_F_PROBE_DONE
);
1706 extern struct bus_type mdio_bus_type
;
1708 struct mdio_board_info
{
1710 char modalias
[MDIO_NAME_SIZE
];
1712 const void *platform_data
;
1715 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1716 int mdiobus_register_board_info(const struct mdio_board_info
*info
,
1719 static inline int mdiobus_register_board_info(const struct mdio_board_info
*i
,
1728 * phy_module_driver() - Helper macro for registering PHY drivers
1729 * @__phy_drivers: array of PHY drivers to register
1730 * @__count: Numbers of members in array
1732 * Helper macro for PHY drivers which do not do anything special in module
1733 * init/exit. Each module may only use this macro once, and calling it
1734 * replaces module_init() and module_exit().
1736 #define phy_module_driver(__phy_drivers, __count) \
1737 static int __init phy_module_init(void) \
1739 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1741 module_init(phy_module_init); \
1742 static void __exit phy_module_exit(void) \
1744 phy_drivers_unregister(__phy_drivers, __count); \
1746 module_exit(phy_module_exit)
1748 #define module_phy_driver(__phy_drivers) \
1749 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1751 bool phy_driver_is_genphy(struct phy_device
*phydev
);
1752 bool phy_driver_is_genphy_10g(struct phy_device
*phydev
);
1754 #endif /* __PHY_H */