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_IGNORE_INTERRUPT if
75 * the attached driver handles the interrupt
78 #define PHY_IGNORE_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
85 /* Interface Mode definitions */
87 PHY_INTERFACE_MODE_NA,
88 PHY_INTERFACE_MODE_INTERNAL,
89 PHY_INTERFACE_MODE_MII,
90 PHY_INTERFACE_MODE_GMII,
91 PHY_INTERFACE_MODE_SGMII,
92 PHY_INTERFACE_MODE_TBI,
93 PHY_INTERFACE_MODE_REVMII,
94 PHY_INTERFACE_MODE_RMII,
95 PHY_INTERFACE_MODE_RGMII,
96 PHY_INTERFACE_MODE_RGMII_ID,
97 PHY_INTERFACE_MODE_RGMII_RXID,
98 PHY_INTERFACE_MODE_RGMII_TXID,
99 PHY_INTERFACE_MODE_RTBI,
100 PHY_INTERFACE_MODE_SMII,
101 PHY_INTERFACE_MODE_XGMII,
102 PHY_INTERFACE_MODE_XLGMII,
103 PHY_INTERFACE_MODE_MOCA,
104 PHY_INTERFACE_MODE_QSGMII,
105 PHY_INTERFACE_MODE_TRGMII,
106 PHY_INTERFACE_MODE_1000BASEX,
107 PHY_INTERFACE_MODE_2500BASEX,
108 PHY_INTERFACE_MODE_RXAUI,
109 PHY_INTERFACE_MODE_XAUI,
110 /* 10GBASE-R, XFI, SFI - single lane 10G Serdes */
111 PHY_INTERFACE_MODE_10GBASER,
112 PHY_INTERFACE_MODE_USXGMII,
113 /* 10GBASE-KR - with Clause 73 AN */
114 PHY_INTERFACE_MODE_10GKR,
115 PHY_INTERFACE_MODE_MAX,
119 * phy_supported_speeds - return all speeds currently supported by a phy device
120 * @phy: The phy device to return supported speeds of.
121 * @speeds: buffer to store supported speeds in.
122 * @size: size of speeds buffer.
124 * Description: Returns the number of supported speeds, and fills
125 * the speeds buffer with the supported speeds. If speeds buffer is
126 * too small to contain all currently supported speeds, will return as
127 * many speeds as can fit.
129 unsigned int phy_supported_speeds(struct phy_device *phy,
130 unsigned int *speeds,
134 * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
135 * @interface: enum phy_interface_t value
137 * Description: maps 'enum phy_interface_t' defined in this file
138 * into the device tree binding of 'phy-mode', so that Ethernet
139 * device driver can get phy interface from device tree.
141 static inline const char *phy_modes(phy_interface_t interface)
144 case PHY_INTERFACE_MODE_NA:
146 case PHY_INTERFACE_MODE_INTERNAL:
148 case PHY_INTERFACE_MODE_MII:
150 case PHY_INTERFACE_MODE_GMII:
152 case PHY_INTERFACE_MODE_SGMII:
154 case PHY_INTERFACE_MODE_TBI:
156 case PHY_INTERFACE_MODE_REVMII:
158 case PHY_INTERFACE_MODE_RMII:
160 case PHY_INTERFACE_MODE_RGMII:
162 case PHY_INTERFACE_MODE_RGMII_ID:
164 case PHY_INTERFACE_MODE_RGMII_RXID:
166 case PHY_INTERFACE_MODE_RGMII_TXID:
168 case PHY_INTERFACE_MODE_RTBI:
170 case PHY_INTERFACE_MODE_SMII:
172 case PHY_INTERFACE_MODE_XGMII:
174 case PHY_INTERFACE_MODE_XLGMII:
176 case PHY_INTERFACE_MODE_MOCA:
178 case PHY_INTERFACE_MODE_QSGMII:
180 case PHY_INTERFACE_MODE_TRGMII:
182 case PHY_INTERFACE_MODE_1000BASEX:
184 case PHY_INTERFACE_MODE_2500BASEX:
186 case PHY_INTERFACE_MODE_RXAUI:
188 case PHY_INTERFACE_MODE_XAUI:
190 case PHY_INTERFACE_MODE_10GBASER:
192 case PHY_INTERFACE_MODE_USXGMII:
194 case PHY_INTERFACE_MODE_10GKR:
202 #define PHY_INIT_TIMEOUT 100000
203 #define PHY_FORCE_TIMEOUT 10
205 #define PHY_MAX_ADDR 32
207 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
208 #define PHY_ID_FMT "%s:%02x"
210 #define MII_BUS_ID_SIZE 61
215 struct sfp_upstream_ops;
218 struct mdio_bus_stats {
219 u64_stats_t transfers;
223 /* Must be last, add new statistics above */
224 struct u64_stats_sync syncp;
227 /* Represents a shared structure between different phydev's in the same
228 * package, for example a quad PHY. See phy_package_join() and
229 * phy_package_leave().
231 struct phy_package_shared {
237 /* private data pointer */
238 /* note that this pointer is shared between different phydevs and
239 * the user has to take care of appropriate locking. It is allocated
240 * and freed automatically by phy_package_join() and
241 * phy_package_leave().
246 /* used as bit number in atomic bitops */
247 #define PHY_SHARED_F_INIT_DONE 0
250 * The Bus class for PHYs. Devices which provide access to
251 * PHYs should register using this structure
254 struct module *owner;
256 char id[MII_BUS_ID_SIZE];
258 int (*read)(struct mii_bus *bus, int addr, int regnum);
259 int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
260 int (*reset)(struct mii_bus *bus);
261 struct mdio_bus_stats stats[PHY_MAX_ADDR];
263 unsigned int is_managed:1; /* is device-managed */
264 unsigned int is_managed_registered:1;
267 * A lock to ensure that only one thing can read/write
268 * the MDIO bus at a time
270 struct mutex mdio_lock;
272 struct device *parent;
274 MDIOBUS_ALLOCATED = 1,
276 MDIOBUS_UNREGISTERED,
281 /* list of all PHYs on bus */
282 struct mdio_device *mdio_map[PHY_MAX_ADDR];
284 /* PHY addresses to be ignored when probing */
287 /* PHY addresses to ignore the TA/read failure */
288 u32 phy_ignore_ta_mask;
291 * An array of interrupts, each PHY's interrupt at the index
292 * matching its address
294 int irq[PHY_MAX_ADDR];
296 /* GPIO reset pulse width in microseconds */
298 /* RESET GPIO descriptor pointer */
299 struct gpio_desc *reset_gpiod;
301 /* protect access to the shared element */
302 struct mutex shared_lock;
304 /* shared state across different PHYs */
305 struct phy_package_shared *shared[PHY_MAX_ADDR];
307 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
309 struct mii_bus *mdiobus_alloc_size(size_t);
310 static inline struct mii_bus *mdiobus_alloc(void)
312 return mdiobus_alloc_size(0);
315 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
316 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
317 static inline int devm_mdiobus_register(struct mii_bus *bus)
321 if (!bus->is_managed)
324 ret = mdiobus_register(bus);
326 bus->is_managed_registered = 1;
331 void mdiobus_unregister(struct mii_bus *bus);
332 void mdiobus_free(struct mii_bus *bus);
333 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
334 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
336 return devm_mdiobus_alloc_size(dev, 0);
339 struct mii_bus *mdio_find_bus(const char *mdio_name);
340 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
341 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
343 #define PHY_INTERRUPT_DISABLED false
344 #define PHY_INTERRUPT_ENABLED true
346 /* PHY state machine states:
348 * DOWN: PHY device and driver are not ready for anything. probe
349 * should be called if and only if the PHY is in this state,
350 * given that the PHY device exists.
351 * - PHY driver probe function will set the state to READY
353 * READY: PHY is ready to send and receive packets, but the
354 * controller is not. By default, PHYs which do not implement
355 * probe will be set to this state by phy_probe().
356 * - start will set the state to UP
358 * UP: The PHY and attached device are ready to do work.
359 * Interrupts should be started here.
360 * - timer moves to NOLINK or RUNNING
362 * NOLINK: PHY is up, but not currently plugged in.
363 * - irq or timer will set RUNNING if link comes back
364 * - phy_stop moves to HALTED
366 * RUNNING: PHY is currently up, running, and possibly sending
367 * and/or receiving packets
368 * - irq or timer will set NOLINK if link goes down
369 * - phy_stop moves to HALTED
371 * CABLETEST: PHY is performing a cable test. Packet reception/sending
372 * is not expected to work, carrier will be indicated as down. PHY will be
373 * poll once per second, or on interrupt for it current state.
374 * Once complete, move to UP to restart the PHY.
375 * - phy_stop aborts the running test and moves to HALTED
377 * HALTED: PHY is up, but no polling or interrupts are done. Or
378 * PHY is in an error state.
379 * - phy_start moves to UP
392 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
393 * @devices_in_package: Bit vector of devices present.
394 * @device_ids: The device identifer for each present device.
396 struct phy_c45_device_ids {
397 u32 devices_in_package;
401 struct macsec_context;
404 /* phy_device: An instance of a PHY
406 * drv: Pointer to the driver for this PHY instance
407 * phy_id: UID for this device found during discovery
408 * c45_ids: 802.3-c45 Device Identifers if is_c45.
409 * is_c45: Set to true if this phy uses clause 45 addressing.
410 * is_internal: Set to true if this phy is internal to a MAC.
411 * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc.
412 * is_gigabit_capable: Set to true if PHY supports 1000Mbps
413 * has_fixups: Set to true if this phy has fixups/quirks.
414 * suspended: Set to true if this phy has been suspended successfully.
415 * suspended_by_mdio_bus: Set to true if this phy was suspended by MDIO bus.
416 * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
417 * loopback_enabled: Set true if this phy has been loopbacked successfully.
418 * downshifted_rate: Set true if link speed has been downshifted.
419 * state: state of the PHY for management purposes
420 * dev_flags: Device-specific flags used by the PHY driver.
421 * irq: IRQ number of the PHY's interrupt (-1 if none)
422 * phy_timer: The timer for handling the state machine
423 * sfp_bus_attached: flag indicating whether the SFP bus has been attached
424 * sfp_bus: SFP bus attached to this PHY's fiber port
425 * attached_dev: The attached enet driver's device instance ptr
426 * adjust_link: Callback for the enet controller to respond to
427 * changes in the link state.
428 * macsec_ops: MACsec offloading ops.
430 * speed, duplex, pause, supported, advertising, lp_advertising,
431 * and autoneg are used like in mii_if_info
433 * interrupts currently only supports enabled or disabled,
434 * but could be changed in the future to support enabling
435 * and disabling specific interrupts
437 * Contains some infrastructure for polling and interrupt
438 * handling, as well as handling shifts in PHY hardware state
441 struct mdio_device mdio;
443 /* Information about the PHY type */
444 /* And management functions */
445 struct phy_driver *drv;
449 struct phy_c45_device_ids c45_ids;
451 unsigned is_internal:1;
452 unsigned is_pseudo_fixed_link:1;
453 unsigned is_gigabit_capable:1;
454 unsigned has_fixups:1;
455 unsigned suspended:1;
456 unsigned suspended_by_mdio_bus:1;
457 unsigned sysfs_links:1;
458 unsigned loopback_enabled:1;
459 unsigned downshifted_rate:1;
462 /* The most recently read link state */
464 unsigned autoneg_complete:1;
466 /* Interrupts are enabled */
467 unsigned interrupts:1;
469 enum phy_state state;
473 phy_interface_t interface;
476 * forced speed & duplex (no autoneg)
477 * partner speed & duplex & pause (autoneg)
485 u8 master_slave_state;
487 /* Union of PHY and Attached devices' supported link modes */
488 /* See ethtool.h for more info */
489 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
490 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
491 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
492 /* used with phy_speed_down */
493 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
495 /* Energy efficient ethernet modes which should be prohibited */
496 u32 eee_broken_modes;
498 #ifdef CONFIG_LED_TRIGGER_PHY
499 struct phy_led_trigger *phy_led_triggers;
500 unsigned int phy_num_led_triggers;
501 struct phy_led_trigger *last_triggered;
503 struct phy_led_trigger *led_link_trigger;
507 * Interrupt number for this PHY
508 * -1 means no interrupt
512 /* private data pointer */
513 /* For use by PHYs to maintain extra state */
516 /* shared data pointer */
517 /* For use by PHYs inside the same package that need a shared state. */
518 struct phy_package_shared *shared;
520 /* Reporting cable test results */
525 /* Interrupt and Polling infrastructure */
526 struct delayed_work state_queue;
530 /* This may be modified under the rtnl lock */
531 bool sfp_bus_attached;
532 struct sfp_bus *sfp_bus;
533 struct phylink *phylink;
534 struct net_device *attached_dev;
535 struct mii_timestamper *mii_ts;
540 void (*phy_link_change)(struct phy_device *phydev, bool up);
541 void (*adjust_link)(struct net_device *dev);
543 #if IS_ENABLED(CONFIG_MACSEC)
544 /* MACsec management functions */
545 const struct macsec_ops *macsec_ops;
548 #define to_phy_device(d) container_of(to_mdio_device(d), \
549 struct phy_device, mdio)
551 /* A structure containing possible configuration parameters
552 * for a TDR cable test. The driver does not need to implement
553 * all the parameters, but should report what is actually used.
555 struct phy_tdr_config {
561 #define PHY_PAIR_ALL -1
563 /* struct phy_driver: Driver structure for a particular PHY type
565 * driver_data: static driver data
566 * phy_id: The result of reading the UID registers of this PHY
567 * type, and ANDing them with the phy_id_mask. This driver
568 * only works for PHYs with IDs which match this field
569 * name: The friendly name of this PHY type
570 * phy_id_mask: Defines the important bits of the phy_id
571 * features: A mandatory list of features (speed, duplex, etc)
572 * supported by this PHY
573 * flags: A bitfield defining certain other features this PHY
574 * supports (like interrupts)
576 * All functions are optional. If config_aneg or read_status
577 * are not implemented, the phy core uses the genphy versions.
578 * Note that none of these functions should be called from
579 * interrupt time. The goal is for the bus read/write functions
580 * to be able to block when the bus transaction is happening,
581 * and be freed up by an interrupt (The MPC85xx has this ability,
582 * though it is not currently supported in the driver).
585 struct mdio_driver_common mdiodrv;
589 const unsigned long * const features;
591 const void *driver_data;
594 * Called to issue a PHY software reset
596 int (*soft_reset)(struct phy_device *phydev);
599 * Called to initialize the PHY,
600 * including after a reset
602 int (*config_init)(struct phy_device *phydev);
605 * Called during discovery. Used to set
606 * up device-specific structures, if any
608 int (*probe)(struct phy_device *phydev);
611 * Probe the hardware to determine what abilities it has.
612 * Should only set phydev->supported.
614 int (*get_features)(struct phy_device *phydev);
616 /* PHY Power Management */
617 int (*suspend)(struct phy_device *phydev);
618 int (*resume)(struct phy_device *phydev);
621 * Configures the advertisement and resets
622 * autonegotiation if phydev->autoneg is on,
623 * forces the speed to the current settings in phydev
624 * if phydev->autoneg is off
626 int (*config_aneg)(struct phy_device *phydev);
628 /* Determines the auto negotiation result */
629 int (*aneg_done)(struct phy_device *phydev);
631 /* Determines the negotiated speed and duplex */
632 int (*read_status)(struct phy_device *phydev);
634 /* Clears any pending interrupts */
635 int (*ack_interrupt)(struct phy_device *phydev);
637 /* Enables or disables interrupts */
638 int (*config_intr)(struct phy_device *phydev);
641 * Checks if the PHY generated an interrupt.
642 * For multi-PHY devices with shared PHY interrupt pin
643 * Set interrupt bits have to be cleared.
645 int (*did_interrupt)(struct phy_device *phydev);
647 /* Override default interrupt handling */
648 irqreturn_t (*handle_interrupt)(struct phy_device *phydev);
650 /* Clears up any memory if needed */
651 void (*remove)(struct phy_device *phydev);
653 /* Returns true if this is a suitable driver for the given
654 * phydev. If NULL, matching is based on phy_id and
657 int (*match_phy_device)(struct phy_device *phydev);
659 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
660 * enable Wake on LAN, so set_wol is provided to be called in the
661 * ethernet driver's set_wol function. */
662 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
664 /* See set_wol, but for checking whether Wake on LAN is enabled. */
665 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
668 * Called to inform a PHY device driver when the core is about to
669 * change the link state. This callback is supposed to be used as
670 * fixup hook for drivers that need to take action when the link
671 * state changes. Drivers are by no means allowed to mess with the
672 * PHY device structure in their implementations.
674 void (*link_change_notify)(struct phy_device *dev);
677 * Phy specific driver override for reading a MMD register.
678 * This function is optional for PHY specific drivers. When
679 * not provided, the default MMD read function will be used
680 * by phy_read_mmd(), which will use either a direct read for
681 * Clause 45 PHYs or an indirect read for Clause 22 PHYs.
682 * devnum is the MMD device number within the PHY device,
683 * regnum is the register within the selected MMD device.
685 int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
688 * Phy specific driver override for writing a MMD register.
689 * This function is optional for PHY specific drivers. When
690 * not provided, the default MMD write function will be used
691 * by phy_write_mmd(), which will use either a direct write for
692 * Clause 45 PHYs, or an indirect write for Clause 22 PHYs.
693 * devnum is the MMD device number within the PHY device,
694 * regnum is the register within the selected MMD device.
695 * val is the value to be written.
697 int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
700 int (*read_page)(struct phy_device *dev);
701 int (*write_page)(struct phy_device *dev, int page);
703 /* Get the size and type of the eeprom contained within a plug-in
705 int (*module_info)(struct phy_device *dev,
706 struct ethtool_modinfo *modinfo);
708 /* Get the eeprom information from the plug-in module */
709 int (*module_eeprom)(struct phy_device *dev,
710 struct ethtool_eeprom *ee, u8 *data);
712 /* Start a cable test */
713 int (*cable_test_start)(struct phy_device *dev);
715 /* Start a raw TDR cable test */
716 int (*cable_test_tdr_start)(struct phy_device *dev,
717 const struct phy_tdr_config *config);
719 /* Once per second, or on interrupt, request the status of the
722 int (*cable_test_get_status)(struct phy_device *dev, bool *finished);
724 /* Get statistics from the phy using ethtool */
725 int (*get_sset_count)(struct phy_device *dev);
726 void (*get_strings)(struct phy_device *dev, u8 *data);
727 void (*get_stats)(struct phy_device *dev,
728 struct ethtool_stats *stats, u64 *data);
730 /* Get and Set PHY tunables */
731 int (*get_tunable)(struct phy_device *dev,
732 struct ethtool_tunable *tuna, void *data);
733 int (*set_tunable)(struct phy_device *dev,
734 struct ethtool_tunable *tuna,
736 int (*set_loopback)(struct phy_device *dev, bool enable);
737 int (*get_sqi)(struct phy_device *dev);
738 int (*get_sqi_max)(struct phy_device *dev);
740 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \
741 struct phy_driver, mdiodrv)
743 #define PHY_ANY_ID "MATCH ANY PHY"
744 #define PHY_ANY_UID 0xffffffff
746 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
747 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
748 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
750 /* A Structure for boards to register fixups with the PHY Lib */
752 struct list_head list;
753 char bus_id[MII_BUS_ID_SIZE + 3];
756 int (*run)(struct phy_device *phydev);
759 const char *phy_speed_to_str(int speed);
760 const char *phy_duplex_to_str(unsigned int duplex);
762 /* A structure for mapping a particular speed and duplex
763 * combination to a particular SUPPORTED and ADVERTISED value
771 const struct phy_setting *
772 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
774 size_t phy_speeds(unsigned int *speeds, size_t size,
775 unsigned long *mask);
776 void of_set_phy_supported(struct phy_device *phydev);
777 void of_set_phy_eee_broken(struct phy_device *phydev);
778 int phy_speed_down_core(struct phy_device *phydev);
781 * phy_is_started - Convenience function to check whether PHY is started
782 * @phydev: The phy_device struct
784 static inline bool phy_is_started(struct phy_device *phydev)
786 return phydev->state >= PHY_UP;
789 void phy_resolve_aneg_pause(struct phy_device *phydev);
790 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
791 void phy_check_downshift(struct phy_device *phydev);
794 * phy_read - Convenience function for reading a given PHY register
795 * @phydev: the phy_device struct
796 * @regnum: register number to read
798 * NOTE: MUST NOT be called from interrupt context,
799 * because the bus read/write functions may wait for an interrupt
800 * to conclude the operation.
802 static inline int phy_read(struct phy_device *phydev, u32 regnum)
804 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
807 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \
808 timeout_us, sleep_before_read) \
810 int __ret = read_poll_timeout(phy_read, val, (cond) || val < 0, \
811 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \
815 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
821 * __phy_read - convenience function for reading a given PHY register
822 * @phydev: the phy_device struct
823 * @regnum: register number to read
825 * The caller must have taken the MDIO bus lock.
827 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
829 return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
833 * phy_write - Convenience function for writing a given PHY register
834 * @phydev: the phy_device struct
835 * @regnum: register number to write
836 * @val: value to write to @regnum
838 * NOTE: MUST NOT be called from interrupt context,
839 * because the bus read/write functions may wait for an interrupt
840 * to conclude the operation.
842 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
844 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
848 * __phy_write - Convenience function for writing a given PHY register
849 * @phydev: the phy_device struct
850 * @regnum: register number to write
851 * @val: value to write to @regnum
853 * The caller must have taken the MDIO bus lock.
855 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
857 return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
862 * __phy_modify_changed() - Convenience function for modifying a PHY register
863 * @phydev: a pointer to a &struct phy_device
864 * @regnum: register number
865 * @mask: bit mask of bits to clear
866 * @set: bit mask of bits to set
868 * Unlocked helper function which allows a PHY register to be modified as
869 * new register value = (old register value & ~mask) | set
871 * Returns negative errno, 0 if there was no change, and 1 in case of change
873 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
876 return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr,
881 * phy_read_mmd - Convenience function for reading a register
882 * from an MMD on a given PHY.
883 * @phydev: The phy_device struct
884 * @devad: The MMD to read from
885 * @regnum: The register on the MMD to read
887 * Same rules as for phy_read();
889 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
891 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
892 sleep_us, timeout_us, sleep_before_read) \
894 int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
895 sleep_us, timeout_us, sleep_before_read, \
896 phydev, devaddr, regnum); \
900 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
905 * __phy_read_mmd - Convenience function for reading a register
906 * from an MMD on a given PHY.
907 * @phydev: The phy_device struct
908 * @devad: The MMD to read from
909 * @regnum: The register on the MMD to read
911 * Same rules as for __phy_read();
913 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
916 * phy_write_mmd - Convenience function for writing a register
917 * on an MMD on a given PHY.
918 * @phydev: The phy_device struct
919 * @devad: The MMD to write to
920 * @regnum: The register on the MMD to read
921 * @val: value to write to @regnum
923 * Same rules as for phy_write();
925 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
928 * __phy_write_mmd - Convenience function for writing a register
929 * on an MMD on a given PHY.
930 * @phydev: The phy_device struct
931 * @devad: The MMD to write to
932 * @regnum: The register on the MMD to read
933 * @val: value to write to @regnum
935 * Same rules as for __phy_write();
937 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
939 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
941 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
943 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
944 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
946 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
948 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
950 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
952 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
956 * __phy_set_bits - Convenience function for setting bits in a PHY register
957 * @phydev: the phy_device struct
958 * @regnum: register number to write
961 * The caller must have taken the MDIO bus lock.
963 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
965 return __phy_modify(phydev, regnum, 0, val);
969 * __phy_clear_bits - Convenience function for clearing bits in a PHY register
970 * @phydev: the phy_device struct
971 * @regnum: register number to write
972 * @val: bits to clear
974 * The caller must have taken the MDIO bus lock.
976 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
979 return __phy_modify(phydev, regnum, val, 0);
983 * phy_set_bits - Convenience function for setting bits in a PHY register
984 * @phydev: the phy_device struct
985 * @regnum: register number to write
988 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
990 return phy_modify(phydev, regnum, 0, val);
994 * phy_clear_bits - Convenience function for clearing bits in a PHY register
995 * @phydev: the phy_device struct
996 * @regnum: register number to write
997 * @val: bits to clear
999 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
1001 return phy_modify(phydev, regnum, val, 0);
1005 * __phy_set_bits_mmd - Convenience function for setting bits in a register
1007 * @phydev: the phy_device struct
1008 * @devad: the MMD containing register to modify
1009 * @regnum: register number to modify
1012 * The caller must have taken the MDIO bus lock.
1014 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
1015 u32 regnum, u16 val)
1017 return __phy_modify_mmd(phydev, devad, regnum, 0, val);
1021 * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
1023 * @phydev: the phy_device struct
1024 * @devad: the MMD containing register to modify
1025 * @regnum: register number to modify
1026 * @val: bits to clear
1028 * The caller must have taken the MDIO bus lock.
1030 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1031 u32 regnum, u16 val)
1033 return __phy_modify_mmd(phydev, devad, regnum, val, 0);
1037 * phy_set_bits_mmd - Convenience function for setting bits in a register
1039 * @phydev: the phy_device struct
1040 * @devad: the MMD containing register to modify
1041 * @regnum: register number to modify
1044 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
1045 u32 regnum, u16 val)
1047 return phy_modify_mmd(phydev, devad, regnum, 0, val);
1051 * phy_clear_bits_mmd - Convenience function for clearing bits in a register
1053 * @phydev: the phy_device struct
1054 * @devad: the MMD containing register to modify
1055 * @regnum: register number to modify
1056 * @val: bits to clear
1058 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1059 u32 regnum, u16 val)
1061 return phy_modify_mmd(phydev, devad, regnum, val, 0);
1065 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
1066 * @phydev: the phy_device struct
1068 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
1069 * PHY_IGNORE_INTERRUPT
1071 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
1073 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
1077 * phy_polling_mode - Convenience function for testing whether polling is
1078 * used to detect PHY status changes
1079 * @phydev: the phy_device struct
1081 static inline bool phy_polling_mode(struct phy_device *phydev)
1083 if (phydev->state == PHY_CABLETEST)
1084 if (phydev->drv->flags & PHY_POLL_CABLE_TEST)
1087 return phydev->irq == PHY_POLL;
1091 * phy_has_hwtstamp - Tests whether a PHY time stamp configuration.
1092 * @phydev: the phy_device struct
1094 static inline bool phy_has_hwtstamp(struct phy_device *phydev)
1096 return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp;
1100 * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping.
1101 * @phydev: the phy_device struct
1103 static inline bool phy_has_rxtstamp(struct phy_device *phydev)
1105 return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp;
1109 * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or
1110 * PTP hardware clock capabilities.
1111 * @phydev: the phy_device struct
1113 static inline bool phy_has_tsinfo(struct phy_device *phydev)
1115 return phydev && phydev->mii_ts && phydev->mii_ts->ts_info;
1119 * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping.
1120 * @phydev: the phy_device struct
1122 static inline bool phy_has_txtstamp(struct phy_device *phydev)
1124 return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp;
1127 static inline int phy_hwtstamp(struct phy_device *phydev, struct ifreq *ifr)
1129 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
1132 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb,
1135 return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type);
1138 static inline int phy_ts_info(struct phy_device *phydev,
1139 struct ethtool_ts_info *tsinfo)
1141 return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo);
1144 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb,
1147 phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type);
1151 * phy_is_internal - Convenience function for testing if a PHY is internal
1152 * @phydev: the phy_device struct
1154 static inline bool phy_is_internal(struct phy_device *phydev)
1156 return phydev->is_internal;
1160 * phy_interface_mode_is_rgmii - Convenience function for testing if a
1161 * PHY interface mode is RGMII (all variants)
1162 * @mode: the phy_interface_t enum
1164 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
1166 return mode >= PHY_INTERFACE_MODE_RGMII &&
1167 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
1171 * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z
1173 * @mode: one of &enum phy_interface_t
1175 * Returns true if the phy interface mode uses the 16-bit negotiation
1176 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
1178 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
1180 return mode == PHY_INTERFACE_MODE_1000BASEX ||
1181 mode == PHY_INTERFACE_MODE_2500BASEX;
1185 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
1186 * is RGMII (all variants)
1187 * @phydev: the phy_device struct
1189 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
1191 return phy_interface_mode_is_rgmii(phydev->interface);
1195 * phy_is_pseudo_fixed_link - Convenience function for testing if this
1196 * PHY is the CPU port facing side of an Ethernet switch, or similar.
1197 * @phydev: the phy_device struct
1199 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
1201 return phydev->is_pseudo_fixed_link;
1204 int phy_save_page(struct phy_device *phydev);
1205 int phy_select_page(struct phy_device *phydev, int page);
1206 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
1207 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
1208 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
1209 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum,
1211 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
1214 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
1216 struct phy_c45_device_ids *c45_ids);
1217 #if IS_ENABLED(CONFIG_PHYLIB)
1218 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
1219 int phy_device_register(struct phy_device *phy);
1220 void phy_device_free(struct phy_device *phydev);
1223 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1228 static inline int phy_device_register(struct phy_device *phy)
1233 static inline void phy_device_free(struct phy_device *phydev) { }
1234 #endif /* CONFIG_PHYLIB */
1235 void phy_device_remove(struct phy_device *phydev);
1236 int phy_init_hw(struct phy_device *phydev);
1237 int phy_suspend(struct phy_device *phydev);
1238 int phy_resume(struct phy_device *phydev);
1239 int __phy_resume(struct phy_device *phydev);
1240 int phy_loopback(struct phy_device *phydev, bool enable);
1241 void phy_sfp_attach(void *upstream, struct sfp_bus *bus);
1242 void phy_sfp_detach(void *upstream, struct sfp_bus *bus);
1243 int phy_sfp_probe(struct phy_device *phydev,
1244 const struct sfp_upstream_ops *ops);
1245 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1246 phy_interface_t interface);
1247 struct phy_device *phy_find_first(struct mii_bus *bus);
1248 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1249 u32 flags, phy_interface_t interface);
1250 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1251 void (*handler)(struct net_device *),
1252 phy_interface_t interface);
1253 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1254 void (*handler)(struct net_device *),
1255 phy_interface_t interface);
1256 void phy_disconnect(struct phy_device *phydev);
1257 void phy_detach(struct phy_device *phydev);
1258 void phy_start(struct phy_device *phydev);
1259 void phy_stop(struct phy_device *phydev);
1260 int phy_start_aneg(struct phy_device *phydev);
1261 int phy_aneg_done(struct phy_device *phydev);
1262 int phy_speed_down(struct phy_device *phydev, bool sync);
1263 int phy_speed_up(struct phy_device *phydev);
1265 int phy_restart_aneg(struct phy_device *phydev);
1266 int phy_reset_after_clk_enable(struct phy_device *phydev);
1268 #if IS_ENABLED(CONFIG_PHYLIB)
1269 int phy_start_cable_test(struct phy_device *phydev,
1270 struct netlink_ext_ack *extack);
1271 int phy_start_cable_test_tdr(struct phy_device *phydev,
1272 struct netlink_ext_ack *extack,
1273 const struct phy_tdr_config *config);
1276 int phy_start_cable_test(struct phy_device *phydev,
1277 struct netlink_ext_ack *extack)
1279 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1283 int phy_start_cable_test_tdr(struct phy_device *phydev,
1284 struct netlink_ext_ack *extack,
1285 const struct phy_tdr_config *config)
1287 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1292 int phy_cable_test_result(struct phy_device *phydev, u8 pair, u16 result);
1293 int phy_cable_test_fault_length(struct phy_device *phydev, u8 pair,
1296 static inline void phy_device_reset(struct phy_device *phydev, int value)
1298 mdio_device_reset(&phydev->mdio, value);
1301 #define phydev_err(_phydev, format, args...) \
1302 dev_err(&_phydev->mdio.dev, format, ##args)
1304 #define phydev_info(_phydev, format, args...) \
1305 dev_info(&_phydev->mdio.dev, format, ##args)
1307 #define phydev_warn(_phydev, format, args...) \
1308 dev_warn(&_phydev->mdio.dev, format, ##args)
1310 #define phydev_dbg(_phydev, format, args...) \
1311 dev_dbg(&_phydev->mdio.dev, format, ##args)
1313 static inline const char *phydev_name(const struct phy_device *phydev)
1315 return dev_name(&phydev->mdio.dev);
1318 static inline void phy_lock_mdio_bus(struct phy_device *phydev)
1320 mutex_lock(&phydev->mdio.bus->mdio_lock);
1323 static inline void phy_unlock_mdio_bus(struct phy_device *phydev)
1325 mutex_unlock(&phydev->mdio.bus->mdio_lock);
1328 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1330 char *phy_attached_info_irq(struct phy_device *phydev)
1332 void phy_attached_info(struct phy_device *phydev);
1335 int genphy_read_abilities(struct phy_device *phydev);
1336 int genphy_setup_forced(struct phy_device *phydev);
1337 int genphy_restart_aneg(struct phy_device *phydev);
1338 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1339 int genphy_config_eee_advert(struct phy_device *phydev);
1340 int __genphy_config_aneg(struct phy_device *phydev, bool changed);
1341 int genphy_aneg_done(struct phy_device *phydev);
1342 int genphy_update_link(struct phy_device *phydev);
1343 int genphy_read_lpa(struct phy_device *phydev);
1344 int genphy_read_status_fixed(struct phy_device *phydev);
1345 int genphy_read_status(struct phy_device *phydev);
1346 int genphy_suspend(struct phy_device *phydev);
1347 int genphy_resume(struct phy_device *phydev);
1348 int genphy_loopback(struct phy_device *phydev, bool enable);
1349 int genphy_soft_reset(struct phy_device *phydev);
1351 static inline int genphy_config_aneg(struct phy_device *phydev)
1353 return __genphy_config_aneg(phydev, false);
1356 static inline int genphy_no_ack_interrupt(struct phy_device *phydev)
1360 static inline int genphy_no_config_intr(struct phy_device *phydev)
1364 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1366 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1367 u16 regnum, u16 val);
1370 int genphy_c37_config_aneg(struct phy_device *phydev);
1371 int genphy_c37_read_status(struct phy_device *phydev);
1374 int genphy_c45_restart_aneg(struct phy_device *phydev);
1375 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1376 int genphy_c45_aneg_done(struct phy_device *phydev);
1377 int genphy_c45_read_link(struct phy_device *phydev);
1378 int genphy_c45_read_lpa(struct phy_device *phydev);
1379 int genphy_c45_read_pma(struct phy_device *phydev);
1380 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1381 int genphy_c45_an_config_aneg(struct phy_device *phydev);
1382 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1383 int genphy_c45_read_mdix(struct phy_device *phydev);
1384 int genphy_c45_pma_read_abilities(struct phy_device *phydev);
1385 int genphy_c45_read_status(struct phy_device *phydev);
1386 int genphy_c45_config_aneg(struct phy_device *phydev);
1388 /* The gen10g_* functions are the old Clause 45 stub */
1389 int gen10g_config_aneg(struct phy_device *phydev);
1391 static inline int phy_read_status(struct phy_device *phydev)
1396 if (phydev->drv->read_status)
1397 return phydev->drv->read_status(phydev);
1399 return genphy_read_status(phydev);
1402 void phy_driver_unregister(struct phy_driver *drv);
1403 void phy_drivers_unregister(struct phy_driver *drv, int n);
1404 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1405 int phy_drivers_register(struct phy_driver *new_driver, int n,
1406 struct module *owner);
1407 void phy_state_machine(struct work_struct *work);
1408 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies);
1409 void phy_mac_interrupt(struct phy_device *phydev);
1410 void phy_start_machine(struct phy_device *phydev);
1411 void phy_stop_machine(struct phy_device *phydev);
1412 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1413 struct ethtool_link_ksettings *cmd);
1414 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1415 const struct ethtool_link_ksettings *cmd);
1416 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1417 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
1418 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd);
1419 void phy_request_interrupt(struct phy_device *phydev);
1420 void phy_free_interrupt(struct phy_device *phydev);
1421 void phy_print_status(struct phy_device *phydev);
1422 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1423 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1424 void phy_advertise_supported(struct phy_device *phydev);
1425 void phy_support_sym_pause(struct phy_device *phydev);
1426 void phy_support_asym_pause(struct phy_device *phydev);
1427 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1429 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1430 bool phy_validate_pause(struct phy_device *phydev,
1431 struct ethtool_pauseparam *pp);
1432 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause);
1433 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv,
1434 bool *tx_pause, bool *rx_pause);
1436 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1437 int (*run)(struct phy_device *));
1438 int phy_register_fixup_for_id(const char *bus_id,
1439 int (*run)(struct phy_device *));
1440 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1441 int (*run)(struct phy_device *));
1443 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1444 int phy_unregister_fixup_for_id(const char *bus_id);
1445 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1447 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1448 int phy_get_eee_err(struct phy_device *phydev);
1449 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1450 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1451 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1452 void phy_ethtool_get_wol(struct phy_device *phydev,
1453 struct ethtool_wolinfo *wol);
1454 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1455 struct ethtool_link_ksettings *cmd);
1456 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1457 const struct ethtool_link_ksettings *cmd);
1458 int phy_ethtool_nway_reset(struct net_device *ndev);
1459 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size);
1460 void phy_package_leave(struct phy_device *phydev);
1461 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1462 int addr, size_t priv_size);
1464 #if IS_ENABLED(CONFIG_PHYLIB)
1465 int __init mdio_bus_init(void);
1466 void mdio_bus_exit(void);
1469 /* Inline function for use within net/core/ethtool.c (built-in) */
1470 static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
1475 mutex_lock(&phydev->lock);
1476 phydev->drv->get_strings(phydev, data);
1477 mutex_unlock(&phydev->lock);
1482 static inline int phy_ethtool_get_sset_count(struct phy_device *phydev)
1489 if (phydev->drv->get_sset_count &&
1490 phydev->drv->get_strings &&
1491 phydev->drv->get_stats) {
1492 mutex_lock(&phydev->lock);
1493 ret = phydev->drv->get_sset_count(phydev);
1494 mutex_unlock(&phydev->lock);
1502 static inline int phy_ethtool_get_stats(struct phy_device *phydev,
1503 struct ethtool_stats *stats, u64 *data)
1508 mutex_lock(&phydev->lock);
1509 phydev->drv->get_stats(phydev, stats, data);
1510 mutex_unlock(&phydev->lock);
1515 static inline int phy_package_read(struct phy_device *phydev, u32 regnum)
1517 struct phy_package_shared *shared = phydev->shared;
1522 return mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1525 static inline int __phy_package_read(struct phy_device *phydev, u32 regnum)
1527 struct phy_package_shared *shared = phydev->shared;
1532 return __mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1535 static inline int phy_package_write(struct phy_device *phydev,
1536 u32 regnum, u16 val)
1538 struct phy_package_shared *shared = phydev->shared;
1543 return mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1546 static inline int __phy_package_write(struct phy_device *phydev,
1547 u32 regnum, u16 val)
1549 struct phy_package_shared *shared = phydev->shared;
1554 return __mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1557 static inline bool phy_package_init_once(struct phy_device *phydev)
1559 struct phy_package_shared *shared = phydev->shared;
1564 return !test_and_set_bit(PHY_SHARED_F_INIT_DONE, &shared->flags);
1567 extern struct bus_type mdio_bus_type;
1569 struct mdio_board_info {
1571 char modalias[MDIO_NAME_SIZE];
1573 const void *platform_data;
1576 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1577 int mdiobus_register_board_info(const struct mdio_board_info *info,
1580 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1589 * module_phy_driver() - Helper macro for registering PHY drivers
1590 * @__phy_drivers: array of PHY drivers to register
1592 * Helper macro for PHY drivers which do not do anything special in module
1593 * init/exit. Each module may only use this macro once, and calling it
1594 * replaces module_init() and module_exit().
1596 #define phy_module_driver(__phy_drivers, __count) \
1597 static int __init phy_module_init(void) \
1599 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1601 module_init(phy_module_init); \
1602 static void __exit phy_module_exit(void) \
1604 phy_drivers_unregister(__phy_drivers, __count); \
1606 module_exit(phy_module_exit)
1608 #define module_phy_driver(__phy_drivers) \
1609 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1611 bool phy_driver_is_genphy(struct phy_device *phydev);
1612 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
1614 #endif /* __PHY_H */