include/linux/phy.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Framework and drivers for configuring and reading different PHYs
   4  * Based on code in sungem_phy.c and (long-removed) gianfar_phy.c
   5  *
   6  * Author: Andy Fleming
   7  *
   8  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   9  */
  10
  11 #ifndef __PHY_H
  12 #define __PHY_H
  13
  14 #include <linux/compiler.h>
  15 #include <linux/spinlock.h>
  16 #include <linux/ethtool.h>
  17 #include <linux/leds.h>
  18 #include <linux/linkmode.h>
  19 #include <linux/netlink.h>
  20 #include <linux/mdio.h>
  21 #include <linux/mii.h>
  22 #include <linux/mii_timestamper.h>
  23 #include <linux/module.h>
  24 #include <linux/timer.h>
  25 #include <linux/workqueue.h>
  26 #include <linux/mod_devicetable.h>
  27 #include <linux/u64_stats_sync.h>
  28 #include <linux/irqreturn.h>
  29 #include <linux/iopoll.h>
  30 #include <linux/refcount.h>
  31
  32 #include <linux/atomic.h>
  33 #include <net/eee.h>
  34
  35 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
  36                                  SUPPORTED_TP | \
  37                                  SUPPORTED_MII)
  38
  39 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
  40                                  SUPPORTED_10baseT_Full)
  41
  42 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
  43                                  SUPPORTED_100baseT_Full)
  44
  45 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
  46                                  SUPPORTED_1000baseT_Full)
  47
  48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
  49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
  50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1s_p2mp_features) __ro_after_init;
  51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
  52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
  53 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
  54 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
  55 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
  56 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
  57 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap1_features) __ro_after_init;
  58 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap2_features) __ro_after_init;
  59
  60 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
  61 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
  62 #define PHY_BASIC_T1S_P2MP_FEATURES ((unsigned long *)&phy_basic_t1s_p2mp_features)
  63 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
  64 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
  65 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
  66 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
  67 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
  68 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
  69 #define PHY_EEE_CAP1_FEATURES ((unsigned long *)&phy_eee_cap1_features)
  70 #define PHY_EEE_CAP2_FEATURES ((unsigned long *)&phy_eee_cap2_features)
  71
  72 extern const int phy_basic_ports_array[3];
  73 extern const int phy_fibre_port_array[1];
  74 extern const int phy_all_ports_features_array[7];
  75 extern const int phy_10_100_features_array[4];
  76 extern const int phy_basic_t1_features_array[3];
  77 extern const int phy_basic_t1s_p2mp_features_array[2];
  78 extern const int phy_gbit_features_array[2];
  79 extern const int phy_10gbit_features_array[1];
  80
  81 /*
  82  * Set phydev->irq to PHY_POLL if interrupts are not supported,
  83  * or not desired for this PHY.  Set to PHY_MAC_INTERRUPT if
  84  * the attached MAC driver handles the interrupt
  85  */
  86 #define PHY_POLL                -1
  87 #define PHY_MAC_INTERRUPT       -2
  88
  89 #define PHY_IS_INTERNAL         0x00000001
  90 #define PHY_RST_AFTER_CLK_EN    0x00000002
  91 #define PHY_POLL_CABLE_TEST     0x00000004
  92 #define PHY_ALWAYS_CALL_SUSPEND 0x00000008
  93 #define MDIO_DEVICE_IS_PHY      0x80000000
  94
  95 /**
  96  * enum phy_interface_t - Interface Mode definitions
  97  *
  98  * @PHY_INTERFACE_MODE_NA: Not Applicable - don't touch
  99  * @PHY_INTERFACE_MODE_INTERNAL: No interface, MAC and PHY combined
 100  * @PHY_INTERFACE_MODE_MII: Media-independent interface
 101  * @PHY_INTERFACE_MODE_GMII: Gigabit media-independent interface
 102  * @PHY_INTERFACE_MODE_SGMII: Serial gigabit media-independent interface
 103  * @PHY_INTERFACE_MODE_TBI: Ten Bit Interface
 104  * @PHY_INTERFACE_MODE_REVMII: Reverse Media Independent Interface
 105  * @PHY_INTERFACE_MODE_RMII: Reduced Media Independent Interface
 106  * @PHY_INTERFACE_MODE_REVRMII: Reduced Media Independent Interface in PHY role
 107  * @PHY_INTERFACE_MODE_RGMII: Reduced gigabit media-independent interface
 108  * @PHY_INTERFACE_MODE_RGMII_ID: RGMII with Internal RX+TX delay
 109  * @PHY_INTERFACE_MODE_RGMII_RXID: RGMII with Internal RX delay
 110  * @PHY_INTERFACE_MODE_RGMII_TXID: RGMII with Internal RX delay
 111  * @PHY_INTERFACE_MODE_RTBI: Reduced TBI
 112  * @PHY_INTERFACE_MODE_SMII: Serial MII
 113  * @PHY_INTERFACE_MODE_XGMII: 10 gigabit media-independent interface
 114  * @PHY_INTERFACE_MODE_XLGMII:40 gigabit media-independent interface
 115  * @PHY_INTERFACE_MODE_MOCA: Multimedia over Coax
 116  * @PHY_INTERFACE_MODE_PSGMII: Penta SGMII
 117  * @PHY_INTERFACE_MODE_QSGMII: Quad SGMII
 118  * @PHY_INTERFACE_MODE_TRGMII: Turbo RGMII
 119  * @PHY_INTERFACE_MODE_100BASEX: 100 BaseX
 120  * @PHY_INTERFACE_MODE_1000BASEX: 1000 BaseX
 121  * @PHY_INTERFACE_MODE_2500BASEX: 2500 BaseX
 122  * @PHY_INTERFACE_MODE_5GBASER: 5G BaseR
 123  * @PHY_INTERFACE_MODE_RXAUI: Reduced XAUI
 124  * @PHY_INTERFACE_MODE_XAUI: 10 Gigabit Attachment Unit Interface
 125  * @PHY_INTERFACE_MODE_10GBASER: 10G BaseR
 126  * @PHY_INTERFACE_MODE_25GBASER: 25G BaseR
 127  * @PHY_INTERFACE_MODE_USXGMII:  Universal Serial 10GE MII
 128  * @PHY_INTERFACE_MODE_10GKR: 10GBASE-KR - with Clause 73 AN
 129  * @PHY_INTERFACE_MODE_QUSGMII: Quad Universal SGMII
 130  * @PHY_INTERFACE_MODE_1000BASEKX: 1000Base-KX - with Clause 73 AN
 131  * @PHY_INTERFACE_MODE_10G_QXGMII: 10G-QXGMII - 4 ports over 10G USXGMII
 132  * @PHY_INTERFACE_MODE_MAX: Book keeping
 133  *
 134  * Describes the interface between the MAC and PHY.
 135  */
 136 typedef enum {
 137         PHY_INTERFACE_MODE_NA,
 138         PHY_INTERFACE_MODE_INTERNAL,
 139         PHY_INTERFACE_MODE_MII,
 140         PHY_INTERFACE_MODE_GMII,
 141         PHY_INTERFACE_MODE_SGMII,
 142         PHY_INTERFACE_MODE_TBI,
 143         PHY_INTERFACE_MODE_REVMII,
 144         PHY_INTERFACE_MODE_RMII,
 145         PHY_INTERFACE_MODE_REVRMII,
 146         PHY_INTERFACE_MODE_RGMII,
 147         PHY_INTERFACE_MODE_RGMII_ID,
 148         PHY_INTERFACE_MODE_RGMII_RXID,
 149         PHY_INTERFACE_MODE_RGMII_TXID,
 150         PHY_INTERFACE_MODE_RTBI,
 151         PHY_INTERFACE_MODE_SMII,
 152         PHY_INTERFACE_MODE_XGMII,
 153         PHY_INTERFACE_MODE_XLGMII,
 154         PHY_INTERFACE_MODE_MOCA,
 155         PHY_INTERFACE_MODE_PSGMII,
 156         PHY_INTERFACE_MODE_QSGMII,
 157         PHY_INTERFACE_MODE_TRGMII,
 158         PHY_INTERFACE_MODE_100BASEX,
 159         PHY_INTERFACE_MODE_1000BASEX,
 160         PHY_INTERFACE_MODE_2500BASEX,
 161         PHY_INTERFACE_MODE_5GBASER,
 162         PHY_INTERFACE_MODE_RXAUI,
 163         PHY_INTERFACE_MODE_XAUI,
 164         /* 10GBASE-R, XFI, SFI - single lane 10G Serdes */
 165         PHY_INTERFACE_MODE_10GBASER,
 166         PHY_INTERFACE_MODE_25GBASER,
 167         PHY_INTERFACE_MODE_USXGMII,
 168         /* 10GBASE-KR - with Clause 73 AN */
 169         PHY_INTERFACE_MODE_10GKR,
 170         PHY_INTERFACE_MODE_QUSGMII,
 171         PHY_INTERFACE_MODE_1000BASEKX,
 172         PHY_INTERFACE_MODE_10G_QXGMII,
 173         PHY_INTERFACE_MODE_MAX,
 174 } phy_interface_t;
 175
 176 /* PHY interface mode bitmap handling */
 177 #define DECLARE_PHY_INTERFACE_MASK(name) \
 178         DECLARE_BITMAP(name, PHY_INTERFACE_MODE_MAX)
 179
 180 static inline void phy_interface_zero(unsigned long *intf)
 181 {
 182         bitmap_zero(intf, PHY_INTERFACE_MODE_MAX);
 183 }
 184
 185 static inline bool phy_interface_empty(const unsigned long *intf)
 186 {
 187         return bitmap_empty(intf, PHY_INTERFACE_MODE_MAX);
 188 }
 189
 190 static inline void phy_interface_and(unsigned long *dst, const unsigned long *a,
 191                                      const unsigned long *b)
 192 {
 193         bitmap_and(dst, a, b, PHY_INTERFACE_MODE_MAX);
 194 }
 195
 196 static inline void phy_interface_or(unsigned long *dst, const unsigned long *a,
 197                                     const unsigned long *b)
 198 {
 199         bitmap_or(dst, a, b, PHY_INTERFACE_MODE_MAX);
 200 }
 201
 202 static inline void phy_interface_set_rgmii(unsigned long *intf)
 203 {
 204         __set_bit(PHY_INTERFACE_MODE_RGMII, intf);
 205         __set_bit(PHY_INTERFACE_MODE_RGMII_ID, intf);
 206         __set_bit(PHY_INTERFACE_MODE_RGMII_RXID, intf);
 207         __set_bit(PHY_INTERFACE_MODE_RGMII_TXID, intf);
 208 }
 209
 210 /*
 211  * phy_supported_speeds - return all speeds currently supported by a PHY device
 212  */
 213 unsigned int phy_supported_speeds(struct phy_device *phy,
 214                                       unsigned int *speeds,
 215                                       unsigned int size);
 216
 217 /**
 218  * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
 219  * @interface: enum phy_interface_t value
 220  *
 221  * Description: maps enum &phy_interface_t defined in this file
 222  * into the device tree binding of 'phy-mode', so that Ethernet
 223  * device driver can get PHY interface from device tree.
 224  */
 225 static inline const char *phy_modes(phy_interface_t interface)
 226 {
 227         switch (interface) {
 228         case PHY_INTERFACE_MODE_NA:
 229                 return "";
 230         case PHY_INTERFACE_MODE_INTERNAL:
 231                 return "internal";
 232         case PHY_INTERFACE_MODE_MII:
 233                 return "mii";
 234         case PHY_INTERFACE_MODE_GMII:
 235                 return "gmii";
 236         case PHY_INTERFACE_MODE_SGMII:
 237                 return "sgmii";
 238         case PHY_INTERFACE_MODE_TBI:
 239                 return "tbi";
 240         case PHY_INTERFACE_MODE_REVMII:
 241                 return "rev-mii";
 242         case PHY_INTERFACE_MODE_RMII:
 243                 return "rmii";
 244         case PHY_INTERFACE_MODE_REVRMII:
 245                 return "rev-rmii";
 246         case PHY_INTERFACE_MODE_RGMII:
 247                 return "rgmii";
 248         case PHY_INTERFACE_MODE_RGMII_ID:
 249                 return "rgmii-id";
 250         case PHY_INTERFACE_MODE_RGMII_RXID:
 251                 return "rgmii-rxid";
 252         case PHY_INTERFACE_MODE_RGMII_TXID:
 253                 return "rgmii-txid";
 254         case PHY_INTERFACE_MODE_RTBI:
 255                 return "rtbi";
 256         case PHY_INTERFACE_MODE_SMII:
 257                 return "smii";
 258         case PHY_INTERFACE_MODE_XGMII:
 259                 return "xgmii";
 260         case PHY_INTERFACE_MODE_XLGMII:
 261                 return "xlgmii";
 262         case PHY_INTERFACE_MODE_MOCA:
 263                 return "moca";
 264         case PHY_INTERFACE_MODE_PSGMII:
 265                 return "psgmii";
 266         case PHY_INTERFACE_MODE_QSGMII:
 267                 return "qsgmii";
 268         case PHY_INTERFACE_MODE_TRGMII:
 269                 return "trgmii";
 270         case PHY_INTERFACE_MODE_1000BASEX:
 271                 return "1000base-x";
 272         case PHY_INTERFACE_MODE_1000BASEKX:
 273                 return "1000base-kx";
 274         case PHY_INTERFACE_MODE_2500BASEX:
 275                 return "2500base-x";
 276         case PHY_INTERFACE_MODE_5GBASER:
 277                 return "5gbase-r";
 278         case PHY_INTERFACE_MODE_RXAUI:
 279                 return "rxaui";
 280         case PHY_INTERFACE_MODE_XAUI:
 281                 return "xaui";
 282         case PHY_INTERFACE_MODE_10GBASER:
 283                 return "10gbase-r";
 284         case PHY_INTERFACE_MODE_25GBASER:
 285                 return "25gbase-r";
 286         case PHY_INTERFACE_MODE_USXGMII:
 287                 return "usxgmii";
 288         case PHY_INTERFACE_MODE_10GKR:
 289                 return "10gbase-kr";
 290         case PHY_INTERFACE_MODE_100BASEX:
 291                 return "100base-x";
 292         case PHY_INTERFACE_MODE_QUSGMII:
 293                 return "qusgmii";
 294         case PHY_INTERFACE_MODE_10G_QXGMII:
 295                 return "10g-qxgmii";
 296         default:
 297                 return "unknown";
 298         }
 299 }
 300
 301 #define PHY_INIT_TIMEOUT        100000
 302 #define PHY_FORCE_TIMEOUT       10
 303
 304 #define PHY_MAX_ADDR    32
 305
 306 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
 307 #define PHY_ID_FMT "%s:%02x"
 308
 309 #define MII_BUS_ID_SIZE 61
 310
 311 struct device;
 312 struct kernel_hwtstamp_config;
 313 struct phylink;
 314 struct sfp_bus;
 315 struct sfp_upstream_ops;
 316 struct sk_buff;
 317
 318 /**
 319  * struct mdio_bus_stats - Statistics counters for MDIO busses
 320  * @transfers: Total number of transfers, i.e. @writes + @reads
 321  * @errors: Number of MDIO transfers that returned an error
 322  * @writes: Number of write transfers
 323  * @reads: Number of read transfers
 324  * @syncp: Synchronisation for incrementing statistics
 325  */
 326 struct mdio_bus_stats {
 327         u64_stats_t transfers;
 328         u64_stats_t errors;
 329         u64_stats_t writes;
 330         u64_stats_t reads;
 331         /* Must be last, add new statistics above */
 332         struct u64_stats_sync syncp;
 333 };
 334
 335 /**
 336  * struct phy_package_shared - Shared information in PHY packages
 337  * @base_addr: Base PHY address of PHY package used to combine PHYs
 338  *   in one package and for offset calculation of phy_package_read/write
 339  * @np: Pointer to the Device Node if PHY package defined in DT
 340  * @refcnt: Number of PHYs connected to this shared data
 341  * @flags: Initialization of PHY package
 342  * @priv_size: Size of the shared private data @priv
 343  * @priv: Driver private data shared across a PHY package
 344  *
 345  * Represents a shared structure between different phydev's in the same
 346  * package, for example a quad PHY. See phy_package_join() and
 347  * phy_package_leave().
 348  */
 349 struct phy_package_shared {
 350         u8 base_addr;
 351         /* With PHY package defined in DT this points to the PHY package node */
 352         struct device_node *np;
 353         refcount_t refcnt;
 354         unsigned long flags;
 355         size_t priv_size;
 356
 357         /* private data pointer */
 358         /* note that this pointer is shared between different phydevs and
 359          * the user has to take care of appropriate locking. It is allocated
 360          * and freed automatically by phy_package_join() and
 361          * phy_package_leave().
 362          */
 363         void *priv;
 364 };
 365
 366 /* used as bit number in atomic bitops */
 367 #define PHY_SHARED_F_INIT_DONE  0
 368 #define PHY_SHARED_F_PROBE_DONE 1
 369
 370 /**
 371  * struct mii_bus - Represents an MDIO bus
 372  *
 373  * @owner: Who owns this device
 374  * @name: User friendly name for this MDIO device, or driver name
 375  * @id: Unique identifier for this bus, typical from bus hierarchy
 376  * @priv: Driver private data
 377  *
 378  * The Bus class for PHYs.  Devices which provide access to
 379  * PHYs should register using this structure
 380  */
 381 struct mii_bus {
 382         struct module *owner;
 383         const char *name;
 384         char id[MII_BUS_ID_SIZE];
 385         void *priv;
 386         /** @read: Perform a read transfer on the bus */
 387         int (*read)(struct mii_bus *bus, int addr, int regnum);
 388         /** @write: Perform a write transfer on the bus */
 389         int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
 390         /** @read_c45: Perform a C45 read transfer on the bus */
 391         int (*read_c45)(struct mii_bus *bus, int addr, int devnum, int regnum);
 392         /** @write_c45: Perform a C45 write transfer on the bus */
 393         int (*write_c45)(struct mii_bus *bus, int addr, int devnum,
 394                          int regnum, u16 val);
 395         /** @reset: Perform a reset of the bus */
 396         int (*reset)(struct mii_bus *bus);
 397
 398         /** @stats: Statistic counters per device on the bus */
 399         struct mdio_bus_stats stats[PHY_MAX_ADDR];
 400
 401         /**
 402          * @mdio_lock: A lock to ensure that only one thing can read/write
 403          * the MDIO bus at a time
 404          */
 405         struct mutex mdio_lock;
 406
 407         /** @parent: Parent device of this bus */
 408         struct device *parent;
 409         /** @state: State of bus structure */
 410         enum {
 411                 MDIOBUS_ALLOCATED = 1,
 412                 MDIOBUS_REGISTERED,
 413                 MDIOBUS_UNREGISTERED,
 414                 MDIOBUS_RELEASED,
 415         } state;
 416
 417         /** @dev: Kernel device representation */
 418         struct device dev;
 419
 420         /** @mdio_map: list of all MDIO devices on bus */
 421         struct mdio_device *mdio_map[PHY_MAX_ADDR];
 422
 423         /** @phy_mask: PHY addresses to be ignored when probing */
 424         u32 phy_mask;
 425
 426         /** @phy_ignore_ta_mask: PHY addresses to ignore the TA/read failure */
 427         u32 phy_ignore_ta_mask;
 428
 429         /**
 430          * @irq: An array of interrupts, each PHY's interrupt at the index
 431          * matching its address
 432          */
 433         int irq[PHY_MAX_ADDR];
 434
 435         /** @reset_delay_us: GPIO reset pulse width in microseconds */
 436         int reset_delay_us;
 437         /** @reset_post_delay_us: GPIO reset deassert delay in microseconds */
 438         int reset_post_delay_us;
 439         /** @reset_gpiod: Reset GPIO descriptor pointer */
 440         struct gpio_desc *reset_gpiod;
 441
 442         /** @shared_lock: protect access to the shared element */
 443         struct mutex shared_lock;
 444
 445         /** @shared: shared state across different PHYs */
 446         struct phy_package_shared *shared[PHY_MAX_ADDR];
 447 };
 448 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
 449
 450 struct mii_bus *mdiobus_alloc_size(size_t size);
 451
 452 /**
 453  * mdiobus_alloc - Allocate an MDIO bus structure
 454  *
 455  * The internal state of the MDIO bus will be set of MDIOBUS_ALLOCATED ready
 456  * for the driver to register the bus.
 457  */
 458 static inline struct mii_bus *mdiobus_alloc(void)
 459 {
 460         return mdiobus_alloc_size(0);
 461 }
 462
 463 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
 464 int __devm_mdiobus_register(struct device *dev, struct mii_bus *bus,
 465                             struct module *owner);
 466 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
 467 #define devm_mdiobus_register(dev, bus) \
 468                 __devm_mdiobus_register(dev, bus, THIS_MODULE)
 469
 470 void mdiobus_unregister(struct mii_bus *bus);
 471 void mdiobus_free(struct mii_bus *bus);
 472 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
 473 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
 474 {
 475         return devm_mdiobus_alloc_size(dev, 0);
 476 }
 477
 478 struct mii_bus *mdio_find_bus(const char *mdio_name);
 479 struct phy_device *mdiobus_scan_c22(struct mii_bus *bus, int addr);
 480
 481 #define PHY_INTERRUPT_DISABLED  false
 482 #define PHY_INTERRUPT_ENABLED   true
 483
 484 /**
 485  * enum phy_state - PHY state machine states:
 486  *
 487  * @PHY_DOWN: PHY device and driver are not ready for anything.  probe
 488  * should be called if and only if the PHY is in this state,
 489  * given that the PHY device exists.
 490  * - PHY driver probe function will set the state to @PHY_READY
 491  *
 492  * @PHY_READY: PHY is ready to send and receive packets, but the
 493  * controller is not.  By default, PHYs which do not implement
 494  * probe will be set to this state by phy_probe().
 495  * - start will set the state to UP
 496  *
 497  * @PHY_UP: The PHY and attached device are ready to do work.
 498  * Interrupts should be started here.
 499  * - timer moves to @PHY_NOLINK or @PHY_RUNNING
 500  *
 501  * @PHY_NOLINK: PHY is up, but not currently plugged in.
 502  * - irq or timer will set @PHY_RUNNING if link comes back
 503  * - phy_stop moves to @PHY_HALTED
 504  *
 505  * @PHY_RUNNING: PHY is currently up, running, and possibly sending
 506  * and/or receiving packets
 507  * - irq or timer will set @PHY_NOLINK if link goes down
 508  * - phy_stop moves to @PHY_HALTED
 509  *
 510  * @PHY_CABLETEST: PHY is performing a cable test. Packet reception/sending
 511  * is not expected to work, carrier will be indicated as down. PHY will be
 512  * poll once per second, or on interrupt for it current state.
 513  * Once complete, move to UP to restart the PHY.
 514  * - phy_stop aborts the running test and moves to @PHY_HALTED
 515  *
 516  * @PHY_HALTED: PHY is up, but no polling or interrupts are done.
 517  * - phy_start moves to @PHY_UP
 518  *
 519  * @PHY_ERROR: PHY is up, but is in an error state.
 520  * - phy_stop moves to @PHY_HALTED
 521  */
 522 enum phy_state {
 523         PHY_DOWN = 0,
 524         PHY_READY,
 525         PHY_HALTED,
 526         PHY_ERROR,
 527         PHY_UP,
 528         PHY_RUNNING,
 529         PHY_NOLINK,
 530         PHY_CABLETEST,
 531 };
 532
 533 #define MDIO_MMD_NUM 32
 534
 535 /**
 536  * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
 537  * @devices_in_package: IEEE 802.3 devices in package register value.
 538  * @mmds_present: bit vector of MMDs present.
 539  * @device_ids: The device identifer for each present device.
 540  */
 541 struct phy_c45_device_ids {
 542         u32 devices_in_package;
 543         u32 mmds_present;
 544         u32 device_ids[MDIO_MMD_NUM];
 545 };
 546
 547 struct macsec_context;
 548 struct macsec_ops;
 549
 550 /**
 551  * struct phy_device - An instance of a PHY
 552  *
 553  * @mdio: MDIO bus this PHY is on
 554  * @drv: Pointer to the driver for this PHY instance
 555  * @devlink: Create a link between phy dev and mac dev, if the external phy
 556  *           used by current mac interface is managed by another mac interface.
 557  * @phyindex: Unique id across the phy's parent tree of phys to address the PHY
 558  *            from userspace, similar to ifindex. A zero index means the PHY
 559  *            wasn't assigned an id yet.
 560  * @phy_id: UID for this device found during discovery
 561  * @c45_ids: 802.3-c45 Device Identifiers if is_c45.
 562  * @is_c45:  Set to true if this PHY uses clause 45 addressing.
 563  * @is_internal: Set to true if this PHY is internal to a MAC.
 564  * @is_pseudo_fixed_link: Set to true if this PHY is an Ethernet switch, etc.
 565  * @is_gigabit_capable: Set to true if PHY supports 1000Mbps
 566  * @has_fixups: Set to true if this PHY has fixups/quirks.
 567  * @suspended: Set to true if this PHY has been suspended successfully.
 568  * @suspended_by_mdio_bus: Set to true if this PHY was suspended by MDIO bus.
 569  * @sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
 570  * @loopback_enabled: Set true if this PHY has been loopbacked successfully.
 571  * @downshifted_rate: Set true if link speed has been downshifted.
 572  * @is_on_sfp_module: Set true if PHY is located on an SFP module.
 573  * @mac_managed_pm: Set true if MAC driver takes of suspending/resuming PHY
 574  * @wol_enabled: Set to true if the PHY or the attached MAC have Wake-on-LAN
 575  *               enabled.
 576  * @state: State of the PHY for management purposes
 577  * @dev_flags: Device-specific flags used by the PHY driver.
 578  *
 579  *      - Bits [15:0] are free to use by the PHY driver to communicate
 580  *        driver specific behavior.
 581  *      - Bits [23:16] are currently reserved for future use.
 582  *      - Bits [31:24] are reserved for defining generic
 583  *        PHY driver behavior.
 584  * @irq: IRQ number of the PHY's interrupt (-1 if none)
 585  * @phylink: Pointer to phylink instance for this PHY
 586  * @sfp_bus_attached: Flag indicating whether the SFP bus has been attached
 587  * @sfp_bus: SFP bus attached to this PHY's fiber port
 588  * @attached_dev: The attached enet driver's device instance ptr
 589  * @adjust_link: Callback for the enet controller to respond to changes: in the
 590  *               link state.
 591  * @phy_link_change: Callback for phylink for notification of link change
 592  * @macsec_ops: MACsec offloading ops.
 593  *
 594  * @speed: Current link speed
 595  * @duplex: Current duplex
 596  * @port: Current port
 597  * @pause: Current pause
 598  * @asym_pause: Current asymmetric pause
 599  * @supported: Combined MAC/PHY supported linkmodes
 600  * @advertising: Currently advertised linkmodes
 601  * @adv_old: Saved advertised while power saving for WoL
 602  * @supported_eee: supported PHY EEE linkmodes
 603  * @advertising_eee: Currently advertised EEE linkmodes
 604  * @enable_tx_lpi: When True, MAC should transmit LPI to PHY
 605  * @eee_cfg: User configuration of EEE
 606  * @lp_advertising: Current link partner advertised linkmodes
 607  * @host_interfaces: PHY interface modes supported by host
 608  * @eee_broken_modes: Energy efficient ethernet modes which should be prohibited
 609  * @autoneg: Flag autoneg being used
 610  * @rate_matching: Current rate matching mode
 611  * @link: Current link state
 612  * @autoneg_complete: Flag auto negotiation of the link has completed
 613  * @mdix: Current crossover
 614  * @mdix_ctrl: User setting of crossover
 615  * @pma_extable: Cached value of PMA/PMD Extended Abilities Register
 616  * @interrupts: Flag interrupts have been enabled
 617  * @irq_suspended: Flag indicating PHY is suspended and therefore interrupt
 618  *                 handling shall be postponed until PHY has resumed
 619  * @irq_rerun: Flag indicating interrupts occurred while PHY was suspended,
 620  *             requiring a rerun of the interrupt handler after resume
 621  * @default_timestamp: Flag indicating whether we are using the phy
 622  *                     timestamp as the default one
 623  * @interface: enum phy_interface_t value
 624  * @possible_interfaces: bitmap if interface modes that the attached PHY
 625  *                       will switch between depending on media speed.
 626  * @skb: Netlink message for cable diagnostics
 627  * @nest: Netlink nest used for cable diagnostics
 628  * @ehdr: nNtlink header for cable diagnostics
 629  * @phy_led_triggers: Array of LED triggers
 630  * @phy_num_led_triggers: Number of triggers in @phy_led_triggers
 631  * @led_link_trigger: LED trigger for link up/down
 632  * @last_triggered: last LED trigger for link speed
 633  * @leds: list of PHY LED structures
 634  * @master_slave_set: User requested master/slave configuration
 635  * @master_slave_get: Current master/slave advertisement
 636  * @master_slave_state: Current master/slave configuration
 637  * @mii_ts: Pointer to time stamper callbacks
 638  * @psec: Pointer to Power Sourcing Equipment control struct
 639  * @lock:  Mutex for serialization access to PHY
 640  * @state_queue: Work queue for state machine
 641  * @link_down_events: Number of times link was lost
 642  * @shared: Pointer to private data shared by phys in one package
 643  * @priv: Pointer to driver private data
 644  *
 645  * interrupts currently only supports enabled or disabled,
 646  * but could be changed in the future to support enabling
 647  * and disabling specific interrupts
 648  *
 649  * Contains some infrastructure for polling and interrupt
 650  * handling, as well as handling shifts in PHY hardware state
 651  */
 652 struct phy_device {
 653         struct mdio_device mdio;
 654
 655         /* Information about the PHY type */
 656         /* And management functions */
 657         const struct phy_driver *drv;
 658
 659         struct device_link *devlink;
 660
 661         u32 phyindex;
 662         u32 phy_id;
 663
 664         struct phy_c45_device_ids c45_ids;
 665         unsigned is_c45:1;
 666         unsigned is_internal:1;
 667         unsigned is_pseudo_fixed_link:1;
 668         unsigned is_gigabit_capable:1;
 669         unsigned has_fixups:1;
 670         unsigned suspended:1;
 671         unsigned suspended_by_mdio_bus:1;
 672         unsigned sysfs_links:1;
 673         unsigned loopback_enabled:1;
 674         unsigned downshifted_rate:1;
 675         unsigned is_on_sfp_module:1;
 676         unsigned mac_managed_pm:1;
 677         unsigned wol_enabled:1;
 678
 679         unsigned autoneg:1;
 680         /* The most recently read link state */
 681         unsigned link:1;
 682         unsigned autoneg_complete:1;
 683
 684         /* Interrupts are enabled */
 685         unsigned interrupts:1;
 686         unsigned irq_suspended:1;
 687         unsigned irq_rerun:1;
 688
 689         unsigned default_timestamp:1;
 690
 691         int rate_matching;
 692
 693         enum phy_state state;
 694
 695         u32 dev_flags;
 696
 697         phy_interface_t interface;
 698         DECLARE_PHY_INTERFACE_MASK(possible_interfaces);
 699
 700         /*
 701          * forced speed & duplex (no autoneg)
 702          * partner speed & duplex & pause (autoneg)
 703          */
 704         int speed;
 705         int duplex;
 706         int port;
 707         int pause;
 708         int asym_pause;
 709         u8 master_slave_get;
 710         u8 master_slave_set;
 711         u8 master_slave_state;
 712
 713         /* Union of PHY and Attached devices' supported link modes */
 714         /* See ethtool.h for more info */
 715         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 716         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 717         __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
 718         /* used with phy_speed_down */
 719         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
 720         /* used for eee validation and configuration*/
 721         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported_eee);
 722         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising_eee);
 723
 724         /* Host supported PHY interface types. Should be ignored if empty. */
 725         DECLARE_PHY_INTERFACE_MASK(host_interfaces);
 726
 727         /* Energy efficient ethernet modes which should be prohibited */
 728         u32 eee_broken_modes;
 729         bool enable_tx_lpi;
 730         struct eee_config eee_cfg;
 731
 732 #ifdef CONFIG_LED_TRIGGER_PHY
 733         struct phy_led_trigger *phy_led_triggers;
 734         unsigned int phy_num_led_triggers;
 735         struct phy_led_trigger *last_triggered;
 736
 737         struct phy_led_trigger *led_link_trigger;
 738 #endif
 739         struct list_head leds;
 740
 741         /*
 742          * Interrupt number for this PHY
 743          * -1 means no interrupt
 744          */
 745         int irq;
 746
 747         /* private data pointer */
 748         /* For use by PHYs to maintain extra state */
 749         void *priv;
 750
 751         /* shared data pointer */
 752         /* For use by PHYs inside the same package that need a shared state. */
 753         struct phy_package_shared *shared;
 754
 755         /* Reporting cable test results */
 756         struct sk_buff *skb;
 757         void *ehdr;
 758         struct nlattr *nest;
 759
 760         /* Interrupt and Polling infrastructure */
 761         struct delayed_work state_queue;
 762
 763         struct mutex lock;
 764
 765         /* This may be modified under the rtnl lock */
 766         bool sfp_bus_attached;
 767         struct sfp_bus *sfp_bus;
 768         struct phylink *phylink;
 769         struct net_device *attached_dev;
 770         struct mii_timestamper *mii_ts;
 771         struct pse_control *psec;
 772
 773         u8 mdix;
 774         u8 mdix_ctrl;
 775
 776         int pma_extable;
 777
 778         unsigned int link_down_events;
 779
 780         void (*phy_link_change)(struct phy_device *phydev, bool up);
 781         void (*adjust_link)(struct net_device *dev);
 782
 783 #if IS_ENABLED(CONFIG_MACSEC)
 784         /* MACsec management functions */
 785         const struct macsec_ops *macsec_ops;
 786 #endif
 787 };
 788
 789 /* Generic phy_device::dev_flags */
 790 #define PHY_F_NO_IRQ            0x80000000
 791 #define PHY_F_RXC_ALWAYS_ON     0x40000000
 792
 793 static inline struct phy_device *to_phy_device(const struct device *dev)
 794 {
 795         return container_of(to_mdio_device(dev), struct phy_device, mdio);
 796 }
 797
 798 /**
 799  * struct phy_tdr_config - Configuration of a TDR raw test
 800  *
 801  * @first: Distance for first data collection point
 802  * @last: Distance for last data collection point
 803  * @step: Step between data collection points
 804  * @pair: Bitmap of cable pairs to collect data for
 805  *
 806  * A structure containing possible configuration parameters
 807  * for a TDR cable test. The driver does not need to implement
 808  * all the parameters, but should report what is actually used.
 809  * All distances are in centimeters.
 810  */
 811 struct phy_tdr_config {
 812         u32 first;
 813         u32 last;
 814         u32 step;
 815         s8 pair;
 816 };
 817 #define PHY_PAIR_ALL -1
 818
 819 /**
 820  * struct phy_plca_cfg - Configuration of the PLCA (Physical Layer Collision
 821  * Avoidance) Reconciliation Sublayer.
 822  *
 823  * @version: read-only PLCA register map version. -1 = not available. Ignored
 824  *   when setting the configuration. Format is the same as reported by the PLCA
 825  *   IDVER register (31.CA00). -1 = not available.
 826  * @enabled: PLCA configured mode (enabled/disabled). -1 = not available / don't
 827  *   set. 0 = disabled, anything else = enabled.
 828  * @node_id: the PLCA local node identifier. -1 = not available / don't set.
 829  *   Allowed values [0 .. 254]. 255 = node disabled.
 830  * @node_cnt: the PLCA node count (maximum number of nodes having a TO). Only
 831  *   meaningful for the coordinator (node_id = 0). -1 = not available / don't
 832  *   set. Allowed values [1 .. 255].
 833  * @to_tmr: The value of the PLCA to_timer in bit-times, which determines the
 834  *   PLCA transmit opportunity window opening. See IEEE802.3 Clause 148 for
 835  *   more details. The to_timer shall be set equal over all nodes.
 836  *   -1 = not available / don't set. Allowed values [0 .. 255].
 837  * @burst_cnt: controls how many additional frames a node is allowed to send in
 838  *   single transmit opportunity (TO). The default value of 0 means that the
 839  *   node is allowed exactly one frame per TO. A value of 1 allows two frames
 840  *   per TO, and so on. -1 = not available / don't set.
 841  *   Allowed values [0 .. 255].
 842  * @burst_tmr: controls how many bit times to wait for the MAC to send a new
 843  *   frame before interrupting the burst. This value should be set to a value
 844  *   greater than the MAC inter-packet gap (which is typically 96 bits).
 845  *   -1 = not available / don't set. Allowed values [0 .. 255].
 846  *
 847  * A structure containing configuration parameters for setting/getting the PLCA
 848  * RS configuration. The driver does not need to implement all the parameters,
 849  * but should report what is actually used.
 850  */
 851 struct phy_plca_cfg {
 852         int version;
 853         int enabled;
 854         int node_id;
 855         int node_cnt;
 856         int to_tmr;
 857         int burst_cnt;
 858         int burst_tmr;
 859 };
 860
 861 /**
 862  * struct phy_plca_status - Status of the PLCA (Physical Layer Collision
 863  * Avoidance) Reconciliation Sublayer.
 864  *
 865  * @pst: The PLCA status as reported by the PST bit in the PLCA STATUS
 866  *      register(31.CA03), indicating BEACON activity.
 867  *
 868  * A structure containing status information of the PLCA RS configuration.
 869  * The driver does not need to implement all the parameters, but should report
 870  * what is actually used.
 871  */
 872 struct phy_plca_status {
 873         bool pst;
 874 };
 875
 876 /* Modes for PHY LED configuration */
 877 enum phy_led_modes {
 878         PHY_LED_ACTIVE_LOW = 0,
 879         PHY_LED_INACTIVE_HIGH_IMPEDANCE = 1,
 880
 881         /* keep it last */
 882         __PHY_LED_MODES_NUM,
 883 };
 884
 885 /**
 886  * struct phy_led: An LED driven by the PHY
 887  *
 888  * @list: List of LEDs
 889  * @phydev: PHY this LED is attached to
 890  * @led_cdev: Standard LED class structure
 891  * @index: Number of the LED
 892  */
 893 struct phy_led {
 894         struct list_head list;
 895         struct phy_device *phydev;
 896         struct led_classdev led_cdev;
 897         u8 index;
 898 };
 899
 900 #define to_phy_led(d) container_of(d, struct phy_led, led_cdev)
 901
 902 /**
 903  * struct phy_driver - Driver structure for a particular PHY type
 904  *
 905  * @mdiodrv: Data common to all MDIO devices
 906  * @phy_id: The result of reading the UID registers of this PHY
 907  *   type, and ANDing them with the phy_id_mask.  This driver
 908  *   only works for PHYs with IDs which match this field
 909  * @name: The friendly name of this PHY type
 910  * @phy_id_mask: Defines the important bits of the phy_id
 911  * @features: A mandatory list of features (speed, duplex, etc)
 912  *   supported by this PHY
 913  * @flags: A bitfield defining certain other features this PHY
 914  *   supports (like interrupts)
 915  * @driver_data: Static driver data
 916  *
 917  * All functions are optional. If config_aneg or read_status
 918  * are not implemented, the phy core uses the genphy versions.
 919  * Note that none of these functions should be called from
 920  * interrupt time. The goal is for the bus read/write functions
 921  * to be able to block when the bus transaction is happening,
 922  * and be freed up by an interrupt (The MPC85xx has this ability,
 923  * though it is not currently supported in the driver).
 924  */
 925 struct phy_driver {
 926         struct mdio_driver_common mdiodrv;
 927         u32 phy_id;
 928         char *name;
 929         u32 phy_id_mask;
 930         const unsigned long * const features;
 931         u32 flags;
 932         const void *driver_data;
 933
 934         /**
 935          * @soft_reset: Called to issue a PHY software reset
 936          */
 937         int (*soft_reset)(struct phy_device *phydev);
 938
 939         /**
 940          * @config_init: Called to initialize the PHY,
 941          * including after a reset
 942          */
 943         int (*config_init)(struct phy_device *phydev);
 944
 945         /**
 946          * @probe: Called during discovery.  Used to set
 947          * up device-specific structures, if any
 948          */
 949         int (*probe)(struct phy_device *phydev);
 950
 951         /**
 952          * @get_features: Probe the hardware to determine what
 953          * abilities it has.  Should only set phydev->supported.
 954          */
 955         int (*get_features)(struct phy_device *phydev);
 956
 957         /**
 958          * @get_rate_matching: Get the supported type of rate matching for a
 959          * particular phy interface. This is used by phy consumers to determine
 960          * whether to advertise lower-speed modes for that interface. It is
 961          * assumed that if a rate matching mode is supported on an interface,
 962          * then that interface's rate can be adapted to all slower link speeds
 963          * supported by the phy. If the interface is not supported, this should
 964          * return %RATE_MATCH_NONE.
 965          */
 966         int (*get_rate_matching)(struct phy_device *phydev,
 967                                    phy_interface_t iface);
 968
 969         /* PHY Power Management */
 970         /** @suspend: Suspend the hardware, saving state if needed */
 971         int (*suspend)(struct phy_device *phydev);
 972         /** @resume: Resume the hardware, restoring state if needed */
 973         int (*resume)(struct phy_device *phydev);
 974
 975         /**
 976          * @config_aneg: Configures the advertisement and resets
 977          * autonegotiation if phydev->autoneg is on,
 978          * forces the speed to the current settings in phydev
 979          * if phydev->autoneg is off
 980          */
 981         int (*config_aneg)(struct phy_device *phydev);
 982
 983         /** @aneg_done: Determines the auto negotiation result */
 984         int (*aneg_done)(struct phy_device *phydev);
 985
 986         /** @read_status: Determines the negotiated speed and duplex */
 987         int (*read_status)(struct phy_device *phydev);
 988
 989         /**
 990          * @config_intr: Enables or disables interrupts.
 991          * It should also clear any pending interrupts prior to enabling the
 992          * IRQs and after disabling them.
 993          */
 994         int (*config_intr)(struct phy_device *phydev);
 995
 996         /** @handle_interrupt: Override default interrupt handling */
 997         irqreturn_t (*handle_interrupt)(struct phy_device *phydev);
 998
 999         /** @remove: Clears up any memory if needed */
1000         void (*remove)(struct phy_device *phydev);
1001
1002         /**
1003          * @match_phy_device: Returns true if this is a suitable
1004          * driver for the given phydev.  If NULL, matching is based on
1005          * phy_id and phy_id_mask.
1006          */
1007         int (*match_phy_device)(struct phy_device *phydev);
1008
1009         /**
1010          * @set_wol: Some devices (e.g. qnap TS-119P II) require PHY
1011          * register changes to enable Wake on LAN, so set_wol is
1012          * provided to be called in the ethernet driver's set_wol
1013          * function.
1014          */
1015         int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
1016
1017         /**
1018          * @get_wol: See set_wol, but for checking whether Wake on LAN
1019          * is enabled.
1020          */
1021         void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
1022
1023         /**
1024          * @link_change_notify: Called to inform a PHY device driver
1025          * when the core is about to change the link state. This
1026          * callback is supposed to be used as fixup hook for drivers
1027          * that need to take action when the link state
1028          * changes. Drivers are by no means allowed to mess with the
1029          * PHY device structure in their implementations.
1030          */
1031         void (*link_change_notify)(struct phy_device *dev);
1032
1033         /**
1034          * @read_mmd: PHY specific driver override for reading a MMD
1035          * register.  This function is optional for PHY specific
1036          * drivers.  When not provided, the default MMD read function
1037          * will be used by phy_read_mmd(), which will use either a
1038          * direct read for Clause 45 PHYs or an indirect read for
1039          * Clause 22 PHYs.  devnum is the MMD device number within the
1040          * PHY device, regnum is the register within the selected MMD
1041          * device.
1042          */
1043         int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
1044
1045         /**
1046          * @write_mmd: PHY specific driver override for writing a MMD
1047          * register.  This function is optional for PHY specific
1048          * drivers.  When not provided, the default MMD write function
1049          * will be used by phy_write_mmd(), which will use either a
1050          * direct write for Clause 45 PHYs, or an indirect write for
1051          * Clause 22 PHYs.  devnum is the MMD device number within the
1052          * PHY device, regnum is the register within the selected MMD
1053          * device.  val is the value to be written.
1054          */
1055         int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
1056                          u16 val);
1057
1058         /** @read_page: Return the current PHY register page number */
1059         int (*read_page)(struct phy_device *dev);
1060         /** @write_page: Set the current PHY register page number */
1061         int (*write_page)(struct phy_device *dev, int page);
1062
1063         /**
1064          * @module_info: Get the size and type of the eeprom contained
1065          * within a plug-in module
1066          */
1067         int (*module_info)(struct phy_device *dev,
1068                            struct ethtool_modinfo *modinfo);
1069
1070         /**
1071          * @module_eeprom: Get the eeprom information from the plug-in
1072          * module
1073          */
1074         int (*module_eeprom)(struct phy_device *dev,
1075                              struct ethtool_eeprom *ee, u8 *data);
1076
1077         /** @cable_test_start: Start a cable test */
1078         int (*cable_test_start)(struct phy_device *dev);
1079
1080         /**  @cable_test_tdr_start: Start a raw TDR cable test */
1081         int (*cable_test_tdr_start)(struct phy_device *dev,
1082                                     const struct phy_tdr_config *config);
1083
1084         /**
1085          * @cable_test_get_status: Once per second, or on interrupt,
1086          * request the status of the test.
1087          */
1088         int (*cable_test_get_status)(struct phy_device *dev, bool *finished);
1089
1090         /* Get statistics from the PHY using ethtool */
1091         /** @get_sset_count: Number of statistic counters */
1092         int (*get_sset_count)(struct phy_device *dev);
1093         /** @get_strings: Names of the statistic counters */
1094         void (*get_strings)(struct phy_device *dev, u8 *data);
1095         /** @get_stats: Return the statistic counter values */
1096         void (*get_stats)(struct phy_device *dev,
1097                           struct ethtool_stats *stats, u64 *data);
1098
1099         /* Get and Set PHY tunables */
1100         /** @get_tunable: Return the value of a tunable */
1101         int (*get_tunable)(struct phy_device *dev,
1102                            struct ethtool_tunable *tuna, void *data);
1103         /** @set_tunable: Set the value of a tunable */
1104         int (*set_tunable)(struct phy_device *dev,
1105                             struct ethtool_tunable *tuna,
1106                             const void *data);
1107         /** @set_loopback: Set the loopback mood of the PHY */
1108         int (*set_loopback)(struct phy_device *dev, bool enable);
1109         /** @get_sqi: Get the signal quality indication */
1110         int (*get_sqi)(struct phy_device *dev);
1111         /** @get_sqi_max: Get the maximum signal quality indication */
1112         int (*get_sqi_max)(struct phy_device *dev);
1113
1114         /* PLCA RS interface */
1115         /** @get_plca_cfg: Return the current PLCA configuration */
1116         int (*get_plca_cfg)(struct phy_device *dev,
1117                             struct phy_plca_cfg *plca_cfg);
1118         /** @set_plca_cfg: Set the PLCA configuration */
1119         int (*set_plca_cfg)(struct phy_device *dev,
1120                             const struct phy_plca_cfg *plca_cfg);
1121         /** @get_plca_status: Return the current PLCA status info */
1122         int (*get_plca_status)(struct phy_device *dev,
1123                                struct phy_plca_status *plca_st);
1124
1125         /**
1126          * @led_brightness_set: Set a PHY LED brightness. Index
1127          * indicates which of the PHYs led should be set. Value
1128          * follows the standard LED class meaning, e.g. LED_OFF,
1129          * LED_HALF, LED_FULL.
1130          */
1131         int (*led_brightness_set)(struct phy_device *dev,
1132                                   u8 index, enum led_brightness value);
1133
1134         /**
1135          * @led_blink_set: Set a PHY LED blinking.  Index indicates
1136          * which of the PHYs led should be configured to blink. Delays
1137          * are in milliseconds and if both are zero then a sensible
1138          * default should be chosen.  The call should adjust the
1139          * timings in that case and if it can't match the values
1140          * specified exactly.
1141          */
1142         int (*led_blink_set)(struct phy_device *dev, u8 index,
1143                              unsigned long *delay_on,
1144                              unsigned long *delay_off);
1145         /**
1146          * @led_hw_is_supported: Can the HW support the given rules.
1147          * @dev: PHY device which has the LED
1148          * @index: Which LED of the PHY device
1149          * @rules The core is interested in these rules
1150          *
1151          * Return 0 if yes,  -EOPNOTSUPP if not, or an error code.
1152          */
1153         int (*led_hw_is_supported)(struct phy_device *dev, u8 index,
1154                                    unsigned long rules);
1155         /**
1156          * @led_hw_control_set: Set the HW to control the LED
1157          * @dev: PHY device which has the LED
1158          * @index: Which LED of the PHY device
1159          * @rules The rules used to control the LED
1160          *
1161          * Returns 0, or a an error code.
1162          */
1163         int (*led_hw_control_set)(struct phy_device *dev, u8 index,
1164                                   unsigned long rules);
1165         /**
1166          * @led_hw_control_get: Get how the HW is controlling the LED
1167          * @dev: PHY device which has the LED
1168          * @index: Which LED of the PHY device
1169          * @rules Pointer to the rules used to control the LED
1170          *
1171          * Set *@rules to how the HW is currently blinking. Returns 0
1172          * on success, or a error code if the current blinking cannot
1173          * be represented in rules, or some other error happens.
1174          */
1175         int (*led_hw_control_get)(struct phy_device *dev, u8 index,
1176                                   unsigned long *rules);
1177
1178         /**
1179          * @led_polarity_set: Set the LED polarity modes
1180          * @dev: PHY device which has the LED
1181          * @index: Which LED of the PHY device
1182          * @modes: bitmap of LED polarity modes
1183          *
1184          * Configure LED with all the required polarity modes in @modes
1185          * to make it correctly turn ON or OFF.
1186          *
1187          * Returns 0, or an error code.
1188          */
1189         int (*led_polarity_set)(struct phy_device *dev, int index,
1190                                 unsigned long modes);
1191 };
1192 #define to_phy_driver(d) container_of_const(to_mdio_common_driver(d),           \
1193                                       struct phy_driver, mdiodrv)
1194
1195 #define PHY_ANY_ID "MATCH ANY PHY"
1196 #define PHY_ANY_UID 0xffffffff
1197
1198 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
1199 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
1200 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
1201
1202 /**
1203  * phy_id_compare - compare @id1 with @id2 taking account of @mask
1204  * @id1: first PHY ID
1205  * @id2: second PHY ID
1206  * @mask: the PHY ID mask, set bits are significant in matching
1207  *
1208  * Return true if the bits from @id1 and @id2 specified by @mask match.
1209  * This uses an equivalent test to (@id & @mask) == (@phy_id & @mask).
1210  */
1211 static inline bool phy_id_compare(u32 id1, u32 id2, u32 mask)
1212 {
1213         return !((id1 ^ id2) & mask);
1214 }
1215
1216 /**
1217  * phydev_id_compare - compare @id with the PHY's Clause 22 ID
1218  * @phydev: the PHY device
1219  * @id: the PHY ID to be matched
1220  *
1221  * Compare the @phydev clause 22 ID with the provided @id and return true or
1222  * false depending whether it matches, using the bound driver mask. The
1223  * @phydev must be bound to a driver.
1224  */
1225 static inline bool phydev_id_compare(struct phy_device *phydev, u32 id)
1226 {
1227         return phy_id_compare(id, phydev->phy_id, phydev->drv->phy_id_mask);
1228 }
1229
1230 /* A Structure for boards to register fixups with the PHY Lib */
1231 struct phy_fixup {
1232         struct list_head list;
1233         char bus_id[MII_BUS_ID_SIZE + 3];
1234         u32 phy_uid;
1235         u32 phy_uid_mask;
1236         int (*run)(struct phy_device *phydev);
1237 };
1238
1239 const char *phy_speed_to_str(int speed);
1240 const char *phy_duplex_to_str(unsigned int duplex);
1241 const char *phy_rate_matching_to_str(int rate_matching);
1242
1243 int phy_interface_num_ports(phy_interface_t interface);
1244
1245 /* A structure for mapping a particular speed and duplex
1246  * combination to a particular SUPPORTED and ADVERTISED value
1247  */
1248 struct phy_setting {
1249         u32 speed;
1250         u8 duplex;
1251         u8 bit;
1252 };
1253
1254 const struct phy_setting *
1255 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
1256                    bool exact);
1257 size_t phy_speeds(unsigned int *speeds, size_t size,
1258                   unsigned long *mask);
1259 void of_set_phy_supported(struct phy_device *phydev);
1260 void of_set_phy_eee_broken(struct phy_device *phydev);
1261 int phy_speed_down_core(struct phy_device *phydev);
1262
1263 /**
1264  * phy_is_started - Convenience function to check whether PHY is started
1265  * @phydev: The phy_device struct
1266  */
1267 static inline bool phy_is_started(struct phy_device *phydev)
1268 {
1269         return phydev->state >= PHY_UP;
1270 }
1271
1272 void phy_resolve_aneg_pause(struct phy_device *phydev);
1273 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
1274 void phy_check_downshift(struct phy_device *phydev);
1275
1276 /**
1277  * phy_read - Convenience function for reading a given PHY register
1278  * @phydev: the phy_device struct
1279  * @regnum: register number to read
1280  *
1281  * NOTE: MUST NOT be called from interrupt context,
1282  * because the bus read/write functions may wait for an interrupt
1283  * to conclude the operation.
1284  */
1285 static inline int phy_read(struct phy_device *phydev, u32 regnum)
1286 {
1287         return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
1288 }
1289
1290 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \
1291                                 timeout_us, sleep_before_read) \
1292 ({ \
1293         int __ret, __val; \
1294         __ret = read_poll_timeout(__val = phy_read, val, \
1295                                   __val < 0 || (cond), \
1296                 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \
1297         if (__val < 0) \
1298                 __ret = __val; \
1299         if (__ret) \
1300                 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1301         __ret; \
1302 })
1303
1304 /**
1305  * __phy_read - convenience function for reading a given PHY register
1306  * @phydev: the phy_device struct
1307  * @regnum: register number to read
1308  *
1309  * The caller must have taken the MDIO bus lock.
1310  */
1311 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
1312 {
1313         return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
1314 }
1315
1316 /**
1317  * phy_write - Convenience function for writing a given PHY register
1318  * @phydev: the phy_device struct
1319  * @regnum: register number to write
1320  * @val: value to write to @regnum
1321  *
1322  * NOTE: MUST NOT be called from interrupt context,
1323  * because the bus read/write functions may wait for an interrupt
1324  * to conclude the operation.
1325  */
1326 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1327 {
1328         return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
1329 }
1330
1331 /**
1332  * __phy_write - Convenience function for writing a given PHY register
1333  * @phydev: the phy_device struct
1334  * @regnum: register number to write
1335  * @val: value to write to @regnum
1336  *
1337  * The caller must have taken the MDIO bus lock.
1338  */
1339 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1340 {
1341         return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
1342                                val);
1343 }
1344
1345 /**
1346  * __phy_modify_changed() - Convenience function for modifying a PHY register
1347  * @phydev: a pointer to a &struct phy_device
1348  * @regnum: register number
1349  * @mask: bit mask of bits to clear
1350  * @set: bit mask of bits to set
1351  *
1352  * Unlocked helper function which allows a PHY register to be modified as
1353  * new register value = (old register value & ~mask) | set
1354  *
1355  * Returns negative errno, 0 if there was no change, and 1 in case of change
1356  */
1357 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
1358                                        u16 mask, u16 set)
1359 {
1360         return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr,
1361                                         regnum, mask, set);
1362 }
1363
1364 /*
1365  * phy_read_mmd - Convenience function for reading a register
1366  * from an MMD on a given PHY.
1367  */
1368 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1369
1370 /**
1371  * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
1372  *                             condition is met or a timeout occurs
1373  *
1374  * @phydev: The phy_device struct
1375  * @devaddr: The MMD to read from
1376  * @regnum: The register on the MMD to read
1377  * @val: Variable to read the register into
1378  * @cond: Break condition (usually involving @val)
1379  * @sleep_us: Maximum time to sleep between reads in us (0
1380  *            tight-loops).  Should be less than ~20ms since usleep_range
1381  *            is used (see Documentation/timers/timers-howto.rst).
1382  * @timeout_us: Timeout in us, 0 means never timeout
1383  * @sleep_before_read: if it is true, sleep @sleep_us before read.
1384  * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
1385  * case, the last read value at @args is stored in @val. Must not
1386  * be called from atomic context if sleep_us or timeout_us are used.
1387  */
1388 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
1389                                   sleep_us, timeout_us, sleep_before_read) \
1390 ({ \
1391         int __ret, __val; \
1392         __ret = read_poll_timeout(__val = phy_read_mmd, val, \
1393                                   __val < 0 || (cond), \
1394                                   sleep_us, timeout_us, sleep_before_read, \
1395                                   phydev, devaddr, regnum); \
1396         if (__val < 0) \
1397                 __ret = __val; \
1398         if (__ret) \
1399                 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1400         __ret; \
1401 })
1402
1403 /*
1404  * __phy_read_mmd - Convenience function for reading a register
1405  * from an MMD on a given PHY.
1406  */
1407 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1408
1409 /*
1410  * phy_write_mmd - Convenience function for writing a register
1411  * on an MMD on a given PHY.
1412  */
1413 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1414
1415 /*
1416  * __phy_write_mmd - Convenience function for writing a register
1417  * on an MMD on a given PHY.
1418  */
1419 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1420
1421 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1422                          u16 set);
1423 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1424                        u16 set);
1425 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1426 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1427
1428 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1429                              u16 mask, u16 set);
1430 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1431                            u16 mask, u16 set);
1432 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1433                      u16 mask, u16 set);
1434 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1435                    u16 mask, u16 set);
1436
1437 /**
1438  * __phy_set_bits - Convenience function for setting bits in a PHY register
1439  * @phydev: the phy_device struct
1440  * @regnum: register number to write
1441  * @val: bits to set
1442  *
1443  * The caller must have taken the MDIO bus lock.
1444  */
1445 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1446 {
1447         return __phy_modify(phydev, regnum, 0, val);
1448 }
1449
1450 /**
1451  * __phy_clear_bits - Convenience function for clearing bits in a PHY register
1452  * @phydev: the phy_device struct
1453  * @regnum: register number to write
1454  * @val: bits to clear
1455  *
1456  * The caller must have taken the MDIO bus lock.
1457  */
1458 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
1459                                    u16 val)
1460 {
1461         return __phy_modify(phydev, regnum, val, 0);
1462 }
1463
1464 /**
1465  * phy_set_bits - Convenience function for setting bits in a PHY register
1466  * @phydev: the phy_device struct
1467  * @regnum: register number to write
1468  * @val: bits to set
1469  */
1470 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1471 {
1472         return phy_modify(phydev, regnum, 0, val);
1473 }
1474
1475 /**
1476  * phy_clear_bits - Convenience function for clearing bits in a PHY register
1477  * @phydev: the phy_device struct
1478  * @regnum: register number to write
1479  * @val: bits to clear
1480  */
1481 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
1482 {
1483         return phy_modify(phydev, regnum, val, 0);
1484 }
1485
1486 /**
1487  * __phy_set_bits_mmd - Convenience function for setting bits in a register
1488  * on MMD
1489  * @phydev: the phy_device struct
1490  * @devad: the MMD containing register to modify
1491  * @regnum: register number to modify
1492  * @val: bits to set
1493  *
1494  * The caller must have taken the MDIO bus lock.
1495  */
1496 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
1497                 u32 regnum, u16 val)
1498 {
1499         return __phy_modify_mmd(phydev, devad, regnum, 0, val);
1500 }
1501
1502 /**
1503  * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
1504  * on MMD
1505  * @phydev: the phy_device struct
1506  * @devad: the MMD containing register to modify
1507  * @regnum: register number to modify
1508  * @val: bits to clear
1509  *
1510  * The caller must have taken the MDIO bus lock.
1511  */
1512 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1513                 u32 regnum, u16 val)
1514 {
1515         return __phy_modify_mmd(phydev, devad, regnum, val, 0);
1516 }
1517
1518 /**
1519  * phy_set_bits_mmd - Convenience function for setting bits in a register
1520  * on MMD
1521  * @phydev: the phy_device struct
1522  * @devad: the MMD containing register to modify
1523  * @regnum: register number to modify
1524  * @val: bits to set
1525  */
1526 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
1527                 u32 regnum, u16 val)
1528 {
1529         return phy_modify_mmd(phydev, devad, regnum, 0, val);
1530 }
1531
1532 /**
1533  * phy_clear_bits_mmd - Convenience function for clearing bits in a register
1534  * on MMD
1535  * @phydev: the phy_device struct
1536  * @devad: the MMD containing register to modify
1537  * @regnum: register number to modify
1538  * @val: bits to clear
1539  */
1540 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1541                 u32 regnum, u16 val)
1542 {
1543         return phy_modify_mmd(phydev, devad, regnum, val, 0);
1544 }
1545
1546 /**
1547  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
1548  * @phydev: the phy_device struct
1549  *
1550  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
1551  * PHY_MAC_INTERRUPT
1552  */
1553 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
1554 {
1555         return phydev->irq != PHY_POLL && phydev->irq != PHY_MAC_INTERRUPT;
1556 }
1557
1558 /**
1559  * phy_polling_mode - Convenience function for testing whether polling is
1560  * used to detect PHY status changes
1561  * @phydev: the phy_device struct
1562  */
1563 static inline bool phy_polling_mode(struct phy_device *phydev)
1564 {
1565         if (phydev->state == PHY_CABLETEST)
1566                 if (phydev->drv->flags & PHY_POLL_CABLE_TEST)
1567                         return true;
1568
1569         return phydev->irq == PHY_POLL;
1570 }
1571
1572 /**
1573  * phy_has_hwtstamp - Tests whether a PHY time stamp configuration.
1574  * @phydev: the phy_device struct
1575  */
1576 static inline bool phy_has_hwtstamp(struct phy_device *phydev)
1577 {
1578         return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp;
1579 }
1580
1581 /**
1582  * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping.
1583  * @phydev: the phy_device struct
1584  */
1585 static inline bool phy_has_rxtstamp(struct phy_device *phydev)
1586 {
1587         return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp;
1588 }
1589
1590 /**
1591  * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or
1592  * PTP hardware clock capabilities.
1593  * @phydev: the phy_device struct
1594  */
1595 static inline bool phy_has_tsinfo(struct phy_device *phydev)
1596 {
1597         return phydev && phydev->mii_ts && phydev->mii_ts->ts_info;
1598 }
1599
1600 /**
1601  * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping.
1602  * @phydev: the phy_device struct
1603  */
1604 static inline bool phy_has_txtstamp(struct phy_device *phydev)
1605 {
1606         return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp;
1607 }
1608
1609 static inline int phy_hwtstamp(struct phy_device *phydev,
1610                                struct kernel_hwtstamp_config *cfg,
1611                                struct netlink_ext_ack *extack)
1612 {
1613         return phydev->mii_ts->hwtstamp(phydev->mii_ts, cfg, extack);
1614 }
1615
1616 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb,
1617                                 int type)
1618 {
1619         return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type);
1620 }
1621
1622 static inline int phy_ts_info(struct phy_device *phydev,
1623                               struct kernel_ethtool_ts_info *tsinfo)
1624 {
1625         return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo);
1626 }
1627
1628 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb,
1629                                 int type)
1630 {
1631         phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type);
1632 }
1633
1634 /**
1635  * phy_is_default_hwtstamp - Is the PHY hwtstamp the default timestamp
1636  * @phydev: Pointer to phy_device
1637  *
1638  * This is used to get default timestamping device taking into account
1639  * the new API choice, which is selecting the timestamping from MAC by
1640  * default if the phydev does not have default_timestamp flag enabled.
1641  *
1642  * Return: True if phy is the default hw timestamp, false otherwise.
1643  */
1644 static inline bool phy_is_default_hwtstamp(struct phy_device *phydev)
1645 {
1646         return phy_has_hwtstamp(phydev) && phydev->default_timestamp;
1647 }
1648
1649 /**
1650  * phy_is_internal - Convenience function for testing if a PHY is internal
1651  * @phydev: the phy_device struct
1652  */
1653 static inline bool phy_is_internal(struct phy_device *phydev)
1654 {
1655         return phydev->is_internal;
1656 }
1657
1658 /**
1659  * phy_on_sfp - Convenience function for testing if a PHY is on an SFP module
1660  * @phydev: the phy_device struct
1661  */
1662 static inline bool phy_on_sfp(struct phy_device *phydev)
1663 {
1664         return phydev->is_on_sfp_module;
1665 }
1666
1667 /**
1668  * phy_interface_mode_is_rgmii - Convenience function for testing if a
1669  * PHY interface mode is RGMII (all variants)
1670  * @mode: the &phy_interface_t enum
1671  */
1672 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
1673 {
1674         return mode >= PHY_INTERFACE_MODE_RGMII &&
1675                 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
1676 };
1677
1678 /**
1679  * phy_interface_mode_is_8023z() - does the PHY interface mode use 802.3z
1680  *   negotiation
1681  * @mode: one of &enum phy_interface_t
1682  *
1683  * Returns true if the PHY interface mode uses the 16-bit negotiation
1684  * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
1685  */
1686 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
1687 {
1688         return mode == PHY_INTERFACE_MODE_1000BASEX ||
1689                mode == PHY_INTERFACE_MODE_2500BASEX;
1690 }
1691
1692 /**
1693  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
1694  * is RGMII (all variants)
1695  * @phydev: the phy_device struct
1696  */
1697 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
1698 {
1699         return phy_interface_mode_is_rgmii(phydev->interface);
1700 };
1701
1702 /**
1703  * phy_is_pseudo_fixed_link - Convenience function for testing if this
1704  * PHY is the CPU port facing side of an Ethernet switch, or similar.
1705  * @phydev: the phy_device struct
1706  */
1707 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
1708 {
1709         return phydev->is_pseudo_fixed_link;
1710 }
1711
1712 int phy_save_page(struct phy_device *phydev);
1713 int phy_select_page(struct phy_device *phydev, int page);
1714 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
1715 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
1716 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
1717 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum,
1718                              u16 mask, u16 set);
1719 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
1720                      u16 mask, u16 set);
1721
1722 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
1723                                      bool is_c45,
1724                                      struct phy_c45_device_ids *c45_ids);
1725 #if IS_ENABLED(CONFIG_PHYLIB)
1726 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id);
1727 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode);
1728 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode);
1729 struct phy_device *device_phy_find_device(struct device *dev);
1730 struct fwnode_handle *fwnode_get_phy_node(const struct fwnode_handle *fwnode);
1731 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
1732 int phy_device_register(struct phy_device *phy);
1733 void phy_device_free(struct phy_device *phydev);
1734 #else
1735 static inline int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
1736 {
1737         return 0;
1738 }
1739 static inline
1740 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
1741 {
1742         return 0;
1743 }
1744
1745 static inline
1746 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
1747 {
1748         return NULL;
1749 }
1750
1751 static inline struct phy_device *device_phy_find_device(struct device *dev)
1752 {
1753         return NULL;
1754 }
1755
1756 static inline
1757 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode)
1758 {
1759         return NULL;
1760 }
1761
1762 static inline
1763 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1764 {
1765         return NULL;
1766 }
1767
1768 static inline int phy_device_register(struct phy_device *phy)
1769 {
1770         return 0;
1771 }
1772
1773 static inline void phy_device_free(struct phy_device *phydev) { }
1774 #endif /* CONFIG_PHYLIB */
1775 void phy_device_remove(struct phy_device *phydev);
1776 int phy_get_c45_ids(struct phy_device *phydev);
1777 int phy_init_hw(struct phy_device *phydev);
1778 int phy_suspend(struct phy_device *phydev);
1779 int phy_resume(struct phy_device *phydev);
1780 int __phy_resume(struct phy_device *phydev);
1781 int phy_loopback(struct phy_device *phydev, bool enable);
1782 int phy_sfp_connect_phy(void *upstream, struct phy_device *phy);
1783 void phy_sfp_disconnect_phy(void *upstream, struct phy_device *phy);
1784 void phy_sfp_attach(void *upstream, struct sfp_bus *bus);
1785 void phy_sfp_detach(void *upstream, struct sfp_bus *bus);
1786 int phy_sfp_probe(struct phy_device *phydev,
1787                   const struct sfp_upstream_ops *ops);
1788 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1789                               phy_interface_t interface);
1790 struct phy_device *phy_find_first(struct mii_bus *bus);
1791 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1792                       u32 flags, phy_interface_t interface);
1793 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1794                        void (*handler)(struct net_device *),
1795                        phy_interface_t interface);
1796 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1797                                void (*handler)(struct net_device *),
1798                                phy_interface_t interface);
1799 void phy_disconnect(struct phy_device *phydev);
1800 void phy_detach(struct phy_device *phydev);
1801 void phy_start(struct phy_device *phydev);
1802 void phy_stop(struct phy_device *phydev);
1803 int phy_config_aneg(struct phy_device *phydev);
1804 int _phy_start_aneg(struct phy_device *phydev);
1805 int phy_start_aneg(struct phy_device *phydev);
1806 int phy_aneg_done(struct phy_device *phydev);
1807 int phy_speed_down(struct phy_device *phydev, bool sync);
1808 int phy_speed_up(struct phy_device *phydev);
1809 bool phy_check_valid(int speed, int duplex, unsigned long *features);
1810
1811 int phy_restart_aneg(struct phy_device *phydev);
1812 int phy_reset_after_clk_enable(struct phy_device *phydev);
1813
1814 #if IS_ENABLED(CONFIG_PHYLIB)
1815 int phy_start_cable_test(struct phy_device *phydev,
1816                          struct netlink_ext_ack *extack);
1817 int phy_start_cable_test_tdr(struct phy_device *phydev,
1818                              struct netlink_ext_ack *extack,
1819                              const struct phy_tdr_config *config);
1820 #else
1821 static inline
1822 int phy_start_cable_test(struct phy_device *phydev,
1823                          struct netlink_ext_ack *extack)
1824 {
1825         NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1826         return -EOPNOTSUPP;
1827 }
1828 static inline
1829 int phy_start_cable_test_tdr(struct phy_device *phydev,
1830                              struct netlink_ext_ack *extack,
1831                              const struct phy_tdr_config *config)
1832 {
1833         NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1834         return -EOPNOTSUPP;
1835 }
1836 #endif
1837
1838 static inline void phy_device_reset(struct phy_device *phydev, int value)
1839 {
1840         mdio_device_reset(&phydev->mdio, value);
1841 }
1842
1843 #define phydev_err(_phydev, format, args...)    \
1844         dev_err(&_phydev->mdio.dev, format, ##args)
1845
1846 #define phydev_err_probe(_phydev, err, format, args...) \
1847         dev_err_probe(&_phydev->mdio.dev, err, format, ##args)
1848
1849 #define phydev_info(_phydev, format, args...)   \
1850         dev_info(&_phydev->mdio.dev, format, ##args)
1851
1852 #define phydev_warn(_phydev, format, args...)   \
1853         dev_warn(&_phydev->mdio.dev, format, ##args)
1854
1855 #define phydev_dbg(_phydev, format, args...)    \
1856         dev_dbg(&_phydev->mdio.dev, format, ##args)
1857
1858 static inline const char *phydev_name(const struct phy_device *phydev)
1859 {
1860         return dev_name(&phydev->mdio.dev);
1861 }
1862
1863 static inline void phy_lock_mdio_bus(struct phy_device *phydev)
1864 {
1865         mutex_lock(&phydev->mdio.bus->mdio_lock);
1866 }
1867
1868 static inline void phy_unlock_mdio_bus(struct phy_device *phydev)
1869 {
1870         mutex_unlock(&phydev->mdio.bus->mdio_lock);
1871 }
1872
1873 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1874         __printf(2, 3);
1875 char *phy_attached_info_irq(struct phy_device *phydev)
1876         __malloc;
1877 void phy_attached_info(struct phy_device *phydev);
1878
1879 /* Clause 22 PHY */
1880 int genphy_read_abilities(struct phy_device *phydev);
1881 int genphy_setup_forced(struct phy_device *phydev);
1882 int genphy_restart_aneg(struct phy_device *phydev);
1883 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1884 int genphy_config_eee_advert(struct phy_device *phydev);
1885 int __genphy_config_aneg(struct phy_device *phydev, bool changed);
1886 int genphy_aneg_done(struct phy_device *phydev);
1887 int genphy_update_link(struct phy_device *phydev);
1888 int genphy_read_lpa(struct phy_device *phydev);
1889 int genphy_read_status_fixed(struct phy_device *phydev);
1890 int genphy_read_status(struct phy_device *phydev);
1891 int genphy_read_master_slave(struct phy_device *phydev);
1892 int genphy_suspend(struct phy_device *phydev);
1893 int genphy_resume(struct phy_device *phydev);
1894 int genphy_loopback(struct phy_device *phydev, bool enable);
1895 int genphy_soft_reset(struct phy_device *phydev);
1896 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev);
1897
1898 static inline int genphy_config_aneg(struct phy_device *phydev)
1899 {
1900         return __genphy_config_aneg(phydev, false);
1901 }
1902
1903 static inline int genphy_no_config_intr(struct phy_device *phydev)
1904 {
1905         return 0;
1906 }
1907 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1908                                 u16 regnum);
1909 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1910                                  u16 regnum, u16 val);
1911
1912 /* Clause 37 */
1913 int genphy_c37_config_aneg(struct phy_device *phydev);
1914 int genphy_c37_read_status(struct phy_device *phydev, bool *changed);
1915
1916 /* Clause 45 PHY */
1917 int genphy_c45_restart_aneg(struct phy_device *phydev);
1918 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1919 int genphy_c45_aneg_done(struct phy_device *phydev);
1920 int genphy_c45_read_link(struct phy_device *phydev);
1921 int genphy_c45_read_lpa(struct phy_device *phydev);
1922 int genphy_c45_read_pma(struct phy_device *phydev);
1923 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1924 int genphy_c45_pma_baset1_setup_master_slave(struct phy_device *phydev);
1925 int genphy_c45_an_config_aneg(struct phy_device *phydev);
1926 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1927 int genphy_c45_read_mdix(struct phy_device *phydev);
1928 int genphy_c45_pma_read_abilities(struct phy_device *phydev);
1929 int genphy_c45_pma_read_ext_abilities(struct phy_device *phydev);
1930 int genphy_c45_pma_baset1_read_abilities(struct phy_device *phydev);
1931 int genphy_c45_read_eee_abilities(struct phy_device *phydev);
1932 int genphy_c45_pma_baset1_read_master_slave(struct phy_device *phydev);
1933 int genphy_c45_read_status(struct phy_device *phydev);
1934 int genphy_c45_baset1_read_status(struct phy_device *phydev);
1935 int genphy_c45_config_aneg(struct phy_device *phydev);
1936 int genphy_c45_loopback(struct phy_device *phydev, bool enable);
1937 int genphy_c45_pma_resume(struct phy_device *phydev);
1938 int genphy_c45_pma_suspend(struct phy_device *phydev);
1939 int genphy_c45_fast_retrain(struct phy_device *phydev, bool enable);
1940 int genphy_c45_plca_get_cfg(struct phy_device *phydev,
1941                             struct phy_plca_cfg *plca_cfg);
1942 int genphy_c45_plca_set_cfg(struct phy_device *phydev,
1943                             const struct phy_plca_cfg *plca_cfg);
1944 int genphy_c45_plca_get_status(struct phy_device *phydev,
1945                                struct phy_plca_status *plca_st);
1946 int genphy_c45_eee_is_active(struct phy_device *phydev, unsigned long *adv,
1947                              unsigned long *lp, bool *is_enabled);
1948 int genphy_c45_ethtool_get_eee(struct phy_device *phydev,
1949                                struct ethtool_keee *data);
1950 int genphy_c45_ethtool_set_eee(struct phy_device *phydev,
1951                                struct ethtool_keee *data);
1952 int genphy_c45_write_eee_adv(struct phy_device *phydev, unsigned long *adv);
1953 int genphy_c45_an_config_eee_aneg(struct phy_device *phydev);
1954 int genphy_c45_read_eee_adv(struct phy_device *phydev, unsigned long *adv);
1955
1956 /* Generic C45 PHY driver */
1957 extern struct phy_driver genphy_c45_driver;
1958
1959 /* The gen10g_* functions are the old Clause 45 stub */
1960 int gen10g_config_aneg(struct phy_device *phydev);
1961
1962 static inline int phy_read_status(struct phy_device *phydev)
1963 {
1964         if (!phydev->drv)
1965                 return -EIO;
1966
1967         if (phydev->drv->read_status)
1968                 return phydev->drv->read_status(phydev);
1969         else
1970                 return genphy_read_status(phydev);
1971 }
1972
1973 void phy_driver_unregister(struct phy_driver *drv);
1974 void phy_drivers_unregister(struct phy_driver *drv, int n);
1975 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1976 int phy_drivers_register(struct phy_driver *new_driver, int n,
1977                          struct module *owner);
1978 void phy_error(struct phy_device *phydev);
1979 void phy_state_machine(struct work_struct *work);
1980 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies);
1981 void phy_trigger_machine(struct phy_device *phydev);
1982 void phy_mac_interrupt(struct phy_device *phydev);
1983 void phy_start_machine(struct phy_device *phydev);
1984 void phy_stop_machine(struct phy_device *phydev);
1985 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1986                                struct ethtool_link_ksettings *cmd);
1987 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1988                               const struct ethtool_link_ksettings *cmd);
1989 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1990 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
1991 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd);
1992 int phy_disable_interrupts(struct phy_device *phydev);
1993 void phy_request_interrupt(struct phy_device *phydev);
1994 void phy_free_interrupt(struct phy_device *phydev);
1995 void phy_print_status(struct phy_device *phydev);
1996 int phy_get_rate_matching(struct phy_device *phydev,
1997                             phy_interface_t iface);
1998 void phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1999 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
2000 void phy_advertise_supported(struct phy_device *phydev);
2001 void phy_advertise_eee_all(struct phy_device *phydev);
2002 void phy_support_sym_pause(struct phy_device *phydev);
2003 void phy_support_asym_pause(struct phy_device *phydev);
2004 void phy_support_eee(struct phy_device *phydev);
2005 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2006                        bool autoneg);
2007 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
2008 bool phy_validate_pause(struct phy_device *phydev,
2009                         struct ethtool_pauseparam *pp);
2010 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause);
2011
2012 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
2013                            const int *delay_values, int size, bool is_rx);
2014
2015 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv,
2016                        bool *tx_pause, bool *rx_pause);
2017
2018 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
2019                        int (*run)(struct phy_device *));
2020 int phy_register_fixup_for_id(const char *bus_id,
2021                               int (*run)(struct phy_device *));
2022 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
2023                                int (*run)(struct phy_device *));
2024
2025 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
2026 int phy_unregister_fixup_for_id(const char *bus_id);
2027 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
2028
2029 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
2030 int phy_get_eee_err(struct phy_device *phydev);
2031 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_keee *data);
2032 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_keee *data);
2033 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
2034 void phy_ethtool_get_wol(struct phy_device *phydev,
2035                          struct ethtool_wolinfo *wol);
2036 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
2037                                    struct ethtool_link_ksettings *cmd);
2038 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
2039                                    const struct ethtool_link_ksettings *cmd);
2040 int phy_ethtool_nway_reset(struct net_device *ndev);
2041 int phy_package_join(struct phy_device *phydev, int base_addr, size_t priv_size);
2042 int of_phy_package_join(struct phy_device *phydev, size_t priv_size);
2043 void phy_package_leave(struct phy_device *phydev);
2044 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
2045                           int base_addr, size_t priv_size);
2046 int devm_of_phy_package_join(struct device *dev, struct phy_device *phydev,
2047                              size_t priv_size);
2048
2049 int __init mdio_bus_init(void);
2050 void mdio_bus_exit(void);
2051
2052 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data);
2053 int phy_ethtool_get_sset_count(struct phy_device *phydev);
2054 int phy_ethtool_get_stats(struct phy_device *phydev,
2055                           struct ethtool_stats *stats, u64 *data);
2056 int phy_ethtool_get_plca_cfg(struct phy_device *phydev,
2057                              struct phy_plca_cfg *plca_cfg);
2058 int phy_ethtool_set_plca_cfg(struct phy_device *phydev,
2059                              const struct phy_plca_cfg *plca_cfg,
2060                              struct netlink_ext_ack *extack);
2061 int phy_ethtool_get_plca_status(struct phy_device *phydev,
2062                                 struct phy_plca_status *plca_st);
2063
2064 int __phy_hwtstamp_get(struct phy_device *phydev,
2065                        struct kernel_hwtstamp_config *config);
2066 int __phy_hwtstamp_set(struct phy_device *phydev,
2067                        struct kernel_hwtstamp_config *config,
2068                        struct netlink_ext_ack *extack);
2069
2070 static inline int phy_package_address(struct phy_device *phydev,
2071                                       unsigned int addr_offset)
2072 {
2073         struct phy_package_shared *shared = phydev->shared;
2074         u8 base_addr = shared->base_addr;
2075
2076         if (addr_offset >= PHY_MAX_ADDR - base_addr)
2077                 return -EIO;
2078
2079         /* we know that addr will be in the range 0..31 and thus the
2080          * implicit cast to a signed int is not a problem.
2081          */
2082         return base_addr + addr_offset;
2083 }
2084
2085 static inline int phy_package_read(struct phy_device *phydev,
2086                                    unsigned int addr_offset, u32 regnum)
2087 {
2088         int addr = phy_package_address(phydev, addr_offset);
2089
2090         if (addr < 0)
2091                 return addr;
2092
2093         return mdiobus_read(phydev->mdio.bus, addr, regnum);
2094 }
2095
2096 static inline int __phy_package_read(struct phy_device *phydev,
2097                                      unsigned int addr_offset, u32 regnum)
2098 {
2099         int addr = phy_package_address(phydev, addr_offset);
2100
2101         if (addr < 0)
2102                 return addr;
2103
2104         return __mdiobus_read(phydev->mdio.bus, addr, regnum);
2105 }
2106
2107 static inline int phy_package_write(struct phy_device *phydev,
2108                                     unsigned int addr_offset, u32 regnum,
2109                                     u16 val)
2110 {
2111         int addr = phy_package_address(phydev, addr_offset);
2112
2113         if (addr < 0)
2114                 return addr;
2115
2116         return mdiobus_write(phydev->mdio.bus, addr, regnum, val);
2117 }
2118
2119 static inline int __phy_package_write(struct phy_device *phydev,
2120                                       unsigned int addr_offset, u32 regnum,
2121                                       u16 val)
2122 {
2123         int addr = phy_package_address(phydev, addr_offset);
2124
2125         if (addr < 0)
2126                 return addr;
2127
2128         return __mdiobus_write(phydev->mdio.bus, addr, regnum, val);
2129 }
2130
2131 int __phy_package_read_mmd(struct phy_device *phydev,
2132                            unsigned int addr_offset, int devad,
2133                            u32 regnum);
2134
2135 int phy_package_read_mmd(struct phy_device *phydev,
2136                          unsigned int addr_offset, int devad,
2137                          u32 regnum);
2138
2139 int __phy_package_write_mmd(struct phy_device *phydev,
2140                             unsigned int addr_offset, int devad,
2141                             u32 regnum, u16 val);
2142
2143 int phy_package_write_mmd(struct phy_device *phydev,
2144                           unsigned int addr_offset, int devad,
2145                           u32 regnum, u16 val);
2146
2147 static inline bool __phy_package_set_once(struct phy_device *phydev,
2148                                           unsigned int b)
2149 {
2150         struct phy_package_shared *shared = phydev->shared;
2151
2152         if (!shared)
2153                 return false;
2154
2155         return !test_and_set_bit(b, &shared->flags);
2156 }
2157
2158 static inline bool phy_package_init_once(struct phy_device *phydev)
2159 {
2160         return __phy_package_set_once(phydev, PHY_SHARED_F_INIT_DONE);
2161 }
2162
2163 static inline bool phy_package_probe_once(struct phy_device *phydev)
2164 {
2165         return __phy_package_set_once(phydev, PHY_SHARED_F_PROBE_DONE);
2166 }
2167
2168 extern const struct bus_type mdio_bus_type;
2169
2170 struct mdio_board_info {
2171         const char      *bus_id;
2172         char            modalias[MDIO_NAME_SIZE];
2173         int             mdio_addr;
2174         const void      *platform_data;
2175 };
2176
2177 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
2178 int mdiobus_register_board_info(const struct mdio_board_info *info,
2179                                 unsigned int n);
2180 #else
2181 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
2182                                               unsigned int n)
2183 {
2184         return 0;
2185 }
2186 #endif
2187
2188
2189 /**
2190  * phy_module_driver() - Helper macro for registering PHY drivers
2191  * @__phy_drivers: array of PHY drivers to register
2192  * @__count: Numbers of members in array
2193  *
2194  * Helper macro for PHY drivers which do not do anything special in module
2195  * init/exit. Each module may only use this macro once, and calling it
2196  * replaces module_init() and module_exit().
2197  */
2198 #define phy_module_driver(__phy_drivers, __count)                       \
2199 static int __init phy_module_init(void)                                 \
2200 {                                                                       \
2201         return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
2202 }                                                                       \
2203 module_init(phy_module_init);                                           \
2204 static void __exit phy_module_exit(void)                                \
2205 {                                                                       \
2206         phy_drivers_unregister(__phy_drivers, __count);                 \
2207 }                                                                       \
2208 module_exit(phy_module_exit)
2209
2210 #define module_phy_driver(__phy_drivers)                                \
2211         phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
2212
2213 bool phy_driver_is_genphy(struct phy_device *phydev);
2214 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
2215
2216 #endif /* __PHY_H */