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/linkmode.h>
  18 #include <linux/netlink.h>
  19 #include <linux/mdio.h>
  20 #include <linux/mii.h>
  21 #include <linux/mii_timestamper.h>
  22 #include <linux/module.h>
  23 #include <linux/timer.h>
  24 #include <linux/workqueue.h>
  25 #include <linux/mod_devicetable.h>
  26 #include <linux/u64_stats_sync.h>
  27 #include <linux/irqreturn.h>
  28 #include <linux/iopoll.h>
  29 #include <linux/refcount.h>
  30
  31 #include <linux/atomic.h>
  32
  33 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
  34                                  SUPPORTED_TP | \
  35                                  SUPPORTED_MII)
  36
  37 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
  38                                  SUPPORTED_10baseT_Full)
  39
  40 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
  41                                  SUPPORTED_100baseT_Full)
  42
  43 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
  44                                  SUPPORTED_1000baseT_Full)
  45
  46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
  47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
  48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
  49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
  50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
  51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
  52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
  53 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
  54
  55 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
  56 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
  57 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
  58 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
  59 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
  60 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
  61 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
  62 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
  63
  64 extern const int phy_basic_ports_array[3];
  65 extern const int phy_fibre_port_array[1];
  66 extern const int phy_all_ports_features_array[7];
  67 extern const int phy_10_100_features_array[4];
  68 extern const int phy_basic_t1_features_array[2];
  69 extern const int phy_gbit_features_array[2];
  70 extern const int phy_10gbit_features_array[1];
  71
  72 /*
  73  * Set phydev->irq to PHY_POLL if interrupts are not supported,
  74  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
  75  * the attached driver handles the interrupt
  76  */
  77 #define PHY_POLL                -1
  78 #define PHY_IGNORE_INTERRUPT    -2
  79
  80 #define PHY_IS_INTERNAL         0x00000001
  81 #define PHY_RST_AFTER_CLK_EN    0x00000002
  82 #define PHY_POLL_CABLE_TEST     0x00000004
  83 #define MDIO_DEVICE_IS_PHY      0x80000000
  84
  85 /**
  86  * enum phy_interface_t - Interface Mode definitions
  87  *
  88  * @PHY_INTERFACE_MODE_NA: Not Applicable - don't touch
  89  * @PHY_INTERFACE_MODE_INTERNAL: No interface, MAC and PHY combined
  90  * @PHY_INTERFACE_MODE_MII: Median-independent interface
  91  * @PHY_INTERFACE_MODE_GMII: Gigabit median-independent interface
  92  * @PHY_INTERFACE_MODE_SGMII: Serial gigabit media-independent interface
  93  * @PHY_INTERFACE_MODE_TBI: Ten Bit Interface
  94  * @PHY_INTERFACE_MODE_REVMII: Reverse Media Independent Interface
  95  * @PHY_INTERFACE_MODE_RMII: Reduced Media Independent Interface
  96  * @PHY_INTERFACE_MODE_RGMII: Reduced gigabit media-independent interface
  97  * @PHY_INTERFACE_MODE_RGMII_ID: RGMII with Internal RX+TX delay
  98  * @PHY_INTERFACE_MODE_RGMII_RXID: RGMII with Internal RX delay
  99  * @PHY_INTERFACE_MODE_RGMII_TXID: RGMII with Internal RX delay
 100  * @PHY_INTERFACE_MODE_RTBI: Reduced TBI
 101  * @PHY_INTERFACE_MODE_SMII: ??? MII
 102  * @PHY_INTERFACE_MODE_XGMII: 10 gigabit media-independent interface
 103  * @PHY_INTERFACE_MODE_XLGMII:40 gigabit media-independent interface
 104  * @PHY_INTERFACE_MODE_MOCA: Multimedia over Coax
 105  * @PHY_INTERFACE_MODE_QSGMII: Quad SGMII
 106  * @PHY_INTERFACE_MODE_TRGMII: Turbo RGMII
 107  * @PHY_INTERFACE_MODE_1000BASEX: 1000 BaseX
 108  * @PHY_INTERFACE_MODE_2500BASEX: 2500 BaseX
 109  * @PHY_INTERFACE_MODE_RXAUI: Reduced XAUI
 110  * @PHY_INTERFACE_MODE_XAUI: 10 Gigabit Attachment Unit Interface
 111  * @PHY_INTERFACE_MODE_10GBASER: 10G BaseR
 112  * @PHY_INTERFACE_MODE_USXGMII:  Universal Serial 10GE MII
 113  * @PHY_INTERFACE_MODE_10GKR: 10GBASE-KR - with Clause 73 AN
 114  * @PHY_INTERFACE_MODE_MAX: Book keeping
 115  *
 116  * Describes the interface between the MAC and PHY.
 117  */
 118 typedef enum {
 119         PHY_INTERFACE_MODE_NA,
 120         PHY_INTERFACE_MODE_INTERNAL,
 121         PHY_INTERFACE_MODE_MII,
 122         PHY_INTERFACE_MODE_GMII,
 123         PHY_INTERFACE_MODE_SGMII,
 124         PHY_INTERFACE_MODE_TBI,
 125         PHY_INTERFACE_MODE_REVMII,
 126         PHY_INTERFACE_MODE_RMII,
 127         PHY_INTERFACE_MODE_RGMII,
 128         PHY_INTERFACE_MODE_RGMII_ID,
 129         PHY_INTERFACE_MODE_RGMII_RXID,
 130         PHY_INTERFACE_MODE_RGMII_TXID,
 131         PHY_INTERFACE_MODE_RTBI,
 132         PHY_INTERFACE_MODE_SMII,
 133         PHY_INTERFACE_MODE_XGMII,
 134         PHY_INTERFACE_MODE_XLGMII,
 135         PHY_INTERFACE_MODE_MOCA,
 136         PHY_INTERFACE_MODE_QSGMII,
 137         PHY_INTERFACE_MODE_TRGMII,
 138         PHY_INTERFACE_MODE_1000BASEX,
 139         PHY_INTERFACE_MODE_2500BASEX,
 140         PHY_INTERFACE_MODE_RXAUI,
 141         PHY_INTERFACE_MODE_XAUI,
 142         /* 10GBASE-R, XFI, SFI - single lane 10G Serdes */
 143         PHY_INTERFACE_MODE_10GBASER,
 144         PHY_INTERFACE_MODE_USXGMII,
 145         /* 10GBASE-KR - with Clause 73 AN */
 146         PHY_INTERFACE_MODE_10GKR,
 147         PHY_INTERFACE_MODE_MAX,
 148 } phy_interface_t;
 149
 150 /*
 151  * phy_supported_speeds - return all speeds currently supported by a PHY device
 152  */
 153 unsigned int phy_supported_speeds(struct phy_device *phy,
 154                                       unsigned int *speeds,
 155                                       unsigned int size);
 156
 157 /**
 158  * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
 159  * @interface: enum phy_interface_t value
 160  *
 161  * Description: maps enum &phy_interface_t defined in this file
 162  * into the device tree binding of 'phy-mode', so that Ethernet
 163  * device driver can get PHY interface from device tree.
 164  */
 165 static inline const char *phy_modes(phy_interface_t interface)
 166 {
 167         switch (interface) {
 168         case PHY_INTERFACE_MODE_NA:
 169                 return "";
 170         case PHY_INTERFACE_MODE_INTERNAL:
 171                 return "internal";
 172         case PHY_INTERFACE_MODE_MII:
 173                 return "mii";
 174         case PHY_INTERFACE_MODE_GMII:
 175                 return "gmii";
 176         case PHY_INTERFACE_MODE_SGMII:
 177                 return "sgmii";
 178         case PHY_INTERFACE_MODE_TBI:
 179                 return "tbi";
 180         case PHY_INTERFACE_MODE_REVMII:
 181                 return "rev-mii";
 182         case PHY_INTERFACE_MODE_RMII:
 183                 return "rmii";
 184         case PHY_INTERFACE_MODE_RGMII:
 185                 return "rgmii";
 186         case PHY_INTERFACE_MODE_RGMII_ID:
 187                 return "rgmii-id";
 188         case PHY_INTERFACE_MODE_RGMII_RXID:
 189                 return "rgmii-rxid";
 190         case PHY_INTERFACE_MODE_RGMII_TXID:
 191                 return "rgmii-txid";
 192         case PHY_INTERFACE_MODE_RTBI:
 193                 return "rtbi";
 194         case PHY_INTERFACE_MODE_SMII:
 195                 return "smii";
 196         case PHY_INTERFACE_MODE_XGMII:
 197                 return "xgmii";
 198         case PHY_INTERFACE_MODE_XLGMII:
 199                 return "xlgmii";
 200         case PHY_INTERFACE_MODE_MOCA:
 201                 return "moca";
 202         case PHY_INTERFACE_MODE_QSGMII:
 203                 return "qsgmii";
 204         case PHY_INTERFACE_MODE_TRGMII:
 205                 return "trgmii";
 206         case PHY_INTERFACE_MODE_1000BASEX:
 207                 return "1000base-x";
 208         case PHY_INTERFACE_MODE_2500BASEX:
 209                 return "2500base-x";
 210         case PHY_INTERFACE_MODE_RXAUI:
 211                 return "rxaui";
 212         case PHY_INTERFACE_MODE_XAUI:
 213                 return "xaui";
 214         case PHY_INTERFACE_MODE_10GBASER:
 215                 return "10gbase-r";
 216         case PHY_INTERFACE_MODE_USXGMII:
 217                 return "usxgmii";
 218         case PHY_INTERFACE_MODE_10GKR:
 219                 return "10gbase-kr";
 220         default:
 221                 return "unknown";
 222         }
 223 }
 224
 225
 226 #define PHY_INIT_TIMEOUT        100000
 227 #define PHY_FORCE_TIMEOUT       10
 228
 229 #define PHY_MAX_ADDR    32
 230
 231 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
 232 #define PHY_ID_FMT "%s:%02x"
 233
 234 #define MII_BUS_ID_SIZE 61
 235
 236 struct device;
 237 struct phylink;
 238 struct sfp_bus;
 239 struct sfp_upstream_ops;
 240 struct sk_buff;
 241
 242 /**
 243  * struct mdio_bus_stats - Statistics counters for MDIO busses
 244  * @transfers: Total number of transfers, i.e. @writes + @reads
 245  * @errors: Number of MDIO transfers that returned an error
 246  * @writes: Number of write transfers
 247  * @reads: Number of read transfers
 248  * @syncp: Synchronisation for incrementing statistics
 249  */
 250 struct mdio_bus_stats {
 251         u64_stats_t transfers;
 252         u64_stats_t errors;
 253         u64_stats_t writes;
 254         u64_stats_t reads;
 255         /* Must be last, add new statistics above */
 256         struct u64_stats_sync syncp;
 257 };
 258
 259 /**
 260  * struct phy_package_shared - Shared information in PHY packages
 261  * @addr: Common PHY address used to combine PHYs in one package
 262  * @refcnt: Number of PHYs connected to this shared data
 263  * @flags: Initialization of PHY package
 264  * @priv_size: Size of the shared private data @priv
 265  * @priv: Driver private data shared across a PHY package
 266  *
 267  * Represents a shared structure between different phydev's in the same
 268  * package, for example a quad PHY. See phy_package_join() and
 269  * phy_package_leave().
 270  */
 271 struct phy_package_shared {
 272         int addr;
 273         refcount_t refcnt;
 274         unsigned long flags;
 275         size_t priv_size;
 276
 277         /* private data pointer */
 278         /* note that this pointer is shared between different phydevs and
 279          * the user has to take care of appropriate locking. It is allocated
 280          * and freed automatically by phy_package_join() and
 281          * phy_package_leave().
 282          */
 283         void *priv;
 284 };
 285
 286 /* used as bit number in atomic bitops */
 287 #define PHY_SHARED_F_INIT_DONE  0
 288 #define PHY_SHARED_F_PROBE_DONE 1
 289
 290 /**
 291  * struct mii_bus - Represents an MDIO bus
 292  *
 293  * @owner: Who owns this device
 294  * @name: User friendly name for this MDIO device, or driver name
 295  * @id: Unique identifier for this bus, typical from bus hierarchy
 296  * @priv: Driver private data
 297  *
 298  * The Bus class for PHYs.  Devices which provide access to
 299  * PHYs should register using this structure
 300  */
 301 struct mii_bus {
 302         struct module *owner;
 303         const char *name;
 304         char id[MII_BUS_ID_SIZE];
 305         void *priv;
 306         /** @read: Perform a read transfer on the bus */
 307         int (*read)(struct mii_bus *bus, int addr, int regnum);
 308         /** @write: Perform a write transfer on the bus */
 309         int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
 310         /** @reset: Perform a reset of the bus */
 311         int (*reset)(struct mii_bus *bus);
 312
 313         /** @stats: Statistic counters per device on the bus */
 314         struct mdio_bus_stats stats[PHY_MAX_ADDR];
 315
 316         /**
 317          * @mdio_lock: A lock to ensure that only one thing can read/write
 318          * the MDIO bus at a time
 319          */
 320         struct mutex mdio_lock;
 321
 322         /** @parent: Parent device of this bus */
 323         struct device *parent;
 324         /** @state: State of bus structure */
 325         enum {
 326                 MDIOBUS_ALLOCATED = 1,
 327                 MDIOBUS_REGISTERED,
 328                 MDIOBUS_UNREGISTERED,
 329                 MDIOBUS_RELEASED,
 330         } state;
 331
 332         /** @dev: Kernel device representation */
 333         struct device dev;
 334
 335         /** @mdio_map: list of all MDIO devices on bus */
 336         struct mdio_device *mdio_map[PHY_MAX_ADDR];
 337
 338         /** @phy_mask: PHY addresses to be ignored when probing */
 339         u32 phy_mask;
 340
 341         /** @phy_ignore_ta_mask: PHY addresses to ignore the TA/read failure */
 342         u32 phy_ignore_ta_mask;
 343
 344         /**
 345          * @irq: An array of interrupts, each PHY's interrupt at the index
 346          * matching its address
 347          */
 348         int irq[PHY_MAX_ADDR];
 349
 350         /** @reset_delay_us: GPIO reset pulse width in microseconds */
 351         int reset_delay_us;
 352         /** @reset_post_delay_us: GPIO reset deassert delay in microseconds */
 353         int reset_post_delay_us;
 354         /** @reset_gpiod: Reset GPIO descriptor pointer */
 355         struct gpio_desc *reset_gpiod;
 356
 357         /** @probe_capabilities: bus capabilities, used for probing */
 358         enum {
 359                 MDIOBUS_NO_CAP = 0,
 360                 MDIOBUS_C22,
 361                 MDIOBUS_C45,
 362                 MDIOBUS_C22_C45,
 363         } probe_capabilities;
 364
 365         /** @shared_lock: protect access to the shared element */
 366         struct mutex shared_lock;
 367
 368         /** @shared: shared state across different PHYs */
 369         struct phy_package_shared *shared[PHY_MAX_ADDR];
 370 };
 371 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
 372
 373 struct mii_bus *mdiobus_alloc_size(size_t size);
 374
 375 /**
 376  * mdiobus_alloc - Allocate an MDIO bus structure
 377  *
 378  * The internal state of the MDIO bus will be set of MDIOBUS_ALLOCATED ready
 379  * for the driver to register the bus.
 380  */
 381 static inline struct mii_bus *mdiobus_alloc(void)
 382 {
 383         return mdiobus_alloc_size(0);
 384 }
 385
 386 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
 387 int __devm_mdiobus_register(struct device *dev, struct mii_bus *bus,
 388                             struct module *owner);
 389 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
 390 #define devm_mdiobus_register(dev, bus) \
 391                 __devm_mdiobus_register(dev, bus, THIS_MODULE)
 392
 393 void mdiobus_unregister(struct mii_bus *bus);
 394 void mdiobus_free(struct mii_bus *bus);
 395 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
 396 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
 397 {
 398         return devm_mdiobus_alloc_size(dev, 0);
 399 }
 400
 401 struct mii_bus *mdio_find_bus(const char *mdio_name);
 402 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
 403
 404 #define PHY_INTERRUPT_DISABLED  false
 405 #define PHY_INTERRUPT_ENABLED   true
 406
 407 /**
 408  * enum phy_state - PHY state machine states:
 409  *
 410  * @PHY_DOWN: PHY device and driver are not ready for anything.  probe
 411  * should be called if and only if the PHY is in this state,
 412  * given that the PHY device exists.
 413  * - PHY driver probe function will set the state to @PHY_READY
 414  *
 415  * @PHY_READY: PHY is ready to send and receive packets, but the
 416  * controller is not.  By default, PHYs which do not implement
 417  * probe will be set to this state by phy_probe().
 418  * - start will set the state to UP
 419  *
 420  * @PHY_UP: The PHY and attached device are ready to do work.
 421  * Interrupts should be started here.
 422  * - timer moves to @PHY_NOLINK or @PHY_RUNNING
 423  *
 424  * @PHY_NOLINK: PHY is up, but not currently plugged in.
 425  * - irq or timer will set @PHY_RUNNING if link comes back
 426  * - phy_stop moves to @PHY_HALTED
 427  *
 428  * @PHY_RUNNING: PHY is currently up, running, and possibly sending
 429  * and/or receiving packets
 430  * - irq or timer will set @PHY_NOLINK if link goes down
 431  * - phy_stop moves to @PHY_HALTED
 432  *
 433  * @PHY_CABLETEST: PHY is performing a cable test. Packet reception/sending
 434  * is not expected to work, carrier will be indicated as down. PHY will be
 435  * poll once per second, or on interrupt for it current state.
 436  * Once complete, move to UP to restart the PHY.
 437  * - phy_stop aborts the running test and moves to @PHY_HALTED
 438  *
 439  * @PHY_HALTED: PHY is up, but no polling or interrupts are done. Or
 440  * PHY is in an error state.
 441  * - phy_start moves to @PHY_UP
 442  */
 443 enum phy_state {
 444         PHY_DOWN = 0,
 445         PHY_READY,
 446         PHY_HALTED,
 447         PHY_UP,
 448         PHY_RUNNING,
 449         PHY_NOLINK,
 450         PHY_CABLETEST,
 451 };
 452
 453 #define MDIO_MMD_NUM 32
 454
 455 /**
 456  * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
 457  * @devices_in_package: IEEE 802.3 devices in package register value.
 458  * @mmds_present: bit vector of MMDs present.
 459  * @device_ids: The device identifer for each present device.
 460  */
 461 struct phy_c45_device_ids {
 462         u32 devices_in_package;
 463         u32 mmds_present;
 464         u32 device_ids[MDIO_MMD_NUM];
 465 };
 466
 467 struct macsec_context;
 468 struct macsec_ops;
 469
 470 /**
 471  * struct phy_device - An instance of a PHY
 472  *
 473  * @mdio: MDIO bus this PHY is on
 474  * @drv: Pointer to the driver for this PHY instance
 475  * @phy_id: UID for this device found during discovery
 476  * @c45_ids: 802.3-c45 Device Identifiers if is_c45.
 477  * @is_c45:  Set to true if this PHY uses clause 45 addressing.
 478  * @is_internal: Set to true if this PHY is internal to a MAC.
 479  * @is_pseudo_fixed_link: Set to true if this PHY is an Ethernet switch, etc.
 480  * @is_gigabit_capable: Set to true if PHY supports 1000Mbps
 481  * @has_fixups: Set to true if this PHY has fixups/quirks.
 482  * @suspended: Set to true if this PHY has been suspended successfully.
 483  * @suspended_by_mdio_bus: Set to true if this PHY was suspended by MDIO bus.
 484  * @sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
 485  * @loopback_enabled: Set true if this PHY has been loopbacked successfully.
 486  * @downshifted_rate: Set true if link speed has been downshifted.
 487  * @state: State of the PHY for management purposes
 488  * @dev_flags: Device-specific flags used by the PHY driver.
 489  * @irq: IRQ number of the PHY's interrupt (-1 if none)
 490  * @phy_timer: The timer for handling the state machine
 491  * @phylink: Pointer to phylink instance for this PHY
 492  * @sfp_bus_attached: Flag indicating whether the SFP bus has been attached
 493  * @sfp_bus: SFP bus attached to this PHY's fiber port
 494  * @attached_dev: The attached enet driver's device instance ptr
 495  * @adjust_link: Callback for the enet controller to respond to changes: in the
 496  *               link state.
 497  * @phy_link_change: Callback for phylink for notification of link change
 498  * @macsec_ops: MACsec offloading ops.
 499  *
 500  * @speed: Current link speed
 501  * @duplex: Current duplex
 502  * @port: Current port
 503  * @pause: Current pause
 504  * @asym_pause: Current asymmetric pause
 505  * @supported: Combined MAC/PHY supported linkmodes
 506  * @advertising: Currently advertised linkmodes
 507  * @adv_old: Saved advertised while power saving for WoL
 508  * @lp_advertising: Current link partner advertised linkmodes
 509  * @eee_broken_modes: Energy efficient ethernet modes which should be prohibited
 510  * @autoneg: Flag autoneg being used
 511  * @link: Current link state
 512  * @autoneg_complete: Flag auto negotiation of the link has completed
 513  * @mdix: Current crossover
 514  * @mdix_ctrl: User setting of crossover
 515  * @interrupts: Flag interrupts have been enabled
 516  * @interface: enum phy_interface_t value
 517  * @skb: Netlink message for cable diagnostics
 518  * @nest: Netlink nest used for cable diagnostics
 519  * @ehdr: nNtlink header for cable diagnostics
 520  * @phy_led_triggers: Array of LED triggers
 521  * @phy_num_led_triggers: Number of triggers in @phy_led_triggers
 522  * @led_link_trigger: LED trigger for link up/down
 523  * @last_triggered: last LED trigger for link speed
 524  * @master_slave_set: User requested master/slave configuration
 525  * @master_slave_get: Current master/slave advertisement
 526  * @master_slave_state: Current master/slave configuration
 527  * @mii_ts: Pointer to time stamper callbacks
 528  * @lock:  Mutex for serialization access to PHY
 529  * @state_queue: Work queue for state machine
 530  * @shared: Pointer to private data shared by phys in one package
 531  * @priv: Pointer to driver private data
 532  *
 533  * interrupts currently only supports enabled or disabled,
 534  * but could be changed in the future to support enabling
 535  * and disabling specific interrupts
 536  *
 537  * Contains some infrastructure for polling and interrupt
 538  * handling, as well as handling shifts in PHY hardware state
 539  */
 540 struct phy_device {
 541         struct mdio_device mdio;
 542
 543         /* Information about the PHY type */
 544         /* And management functions */
 545         struct phy_driver *drv;
 546
 547         u32 phy_id;
 548
 549         struct phy_c45_device_ids c45_ids;
 550         unsigned is_c45:1;
 551         unsigned is_internal:1;
 552         unsigned is_pseudo_fixed_link:1;
 553         unsigned is_gigabit_capable:1;
 554         unsigned has_fixups:1;
 555         unsigned suspended:1;
 556         unsigned suspended_by_mdio_bus:1;
 557         unsigned sysfs_links:1;
 558         unsigned loopback_enabled:1;
 559         unsigned downshifted_rate:1;
 560
 561         unsigned autoneg:1;
 562         /* The most recently read link state */
 563         unsigned link:1;
 564         unsigned autoneg_complete:1;
 565
 566         /* Interrupts are enabled */
 567         unsigned interrupts:1;
 568
 569         enum phy_state state;
 570
 571         u32 dev_flags;
 572
 573         phy_interface_t interface;
 574
 575         /*
 576          * forced speed & duplex (no autoneg)
 577          * partner speed & duplex & pause (autoneg)
 578          */
 579         int speed;
 580         int duplex;
 581         int port;
 582         int pause;
 583         int asym_pause;
 584         u8 master_slave_get;
 585         u8 master_slave_set;
 586         u8 master_slave_state;
 587
 588         /* Union of PHY and Attached devices' supported link modes */
 589         /* See ethtool.h for more info */
 590         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 591         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 592         __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
 593         /* used with phy_speed_down */
 594         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
 595
 596         /* Energy efficient ethernet modes which should be prohibited */
 597         u32 eee_broken_modes;
 598
 599 #ifdef CONFIG_LED_TRIGGER_PHY
 600         struct phy_led_trigger *phy_led_triggers;
 601         unsigned int phy_num_led_triggers;
 602         struct phy_led_trigger *last_triggered;
 603
 604         struct phy_led_trigger *led_link_trigger;
 605 #endif
 606
 607         /*
 608          * Interrupt number for this PHY
 609          * -1 means no interrupt
 610          */
 611         int irq;
 612
 613         /* private data pointer */
 614         /* For use by PHYs to maintain extra state */
 615         void *priv;
 616
 617         /* shared data pointer */
 618         /* For use by PHYs inside the same package that need a shared state. */
 619         struct phy_package_shared *shared;
 620
 621         /* Reporting cable test results */
 622         struct sk_buff *skb;
 623         void *ehdr;
 624         struct nlattr *nest;
 625
 626         /* Interrupt and Polling infrastructure */
 627         struct delayed_work state_queue;
 628
 629         struct mutex lock;
 630
 631         /* This may be modified under the rtnl lock */
 632         bool sfp_bus_attached;
 633         struct sfp_bus *sfp_bus;
 634         struct phylink *phylink;
 635         struct net_device *attached_dev;
 636         struct mii_timestamper *mii_ts;
 637
 638         u8 mdix;
 639         u8 mdix_ctrl;
 640
 641         void (*phy_link_change)(struct phy_device *phydev, bool up);
 642         void (*adjust_link)(struct net_device *dev);
 643
 644 #if IS_ENABLED(CONFIG_MACSEC)
 645         /* MACsec management functions */
 646         const struct macsec_ops *macsec_ops;
 647 #endif
 648 };
 649 #define to_phy_device(d) container_of(to_mdio_device(d), \
 650                                       struct phy_device, mdio)
 651
 652 /**
 653  * struct phy_tdr_config - Configuration of a TDR raw test
 654  *
 655  * @first: Distance for first data collection point
 656  * @last: Distance for last data collection point
 657  * @step: Step between data collection points
 658  * @pair: Bitmap of cable pairs to collect data for
 659  *
 660  * A structure containing possible configuration parameters
 661  * for a TDR cable test. The driver does not need to implement
 662  * all the parameters, but should report what is actually used.
 663  * All distances are in centimeters.
 664  */
 665 struct phy_tdr_config {
 666         u32 first;
 667         u32 last;
 668         u32 step;
 669         s8 pair;
 670 };
 671 #define PHY_PAIR_ALL -1
 672
 673 /**
 674  * struct phy_driver - Driver structure for a particular PHY type
 675  *
 676  * @mdiodrv: Data common to all MDIO devices
 677  * @phy_id: The result of reading the UID registers of this PHY
 678  *   type, and ANDing them with the phy_id_mask.  This driver
 679  *   only works for PHYs with IDs which match this field
 680  * @name: The friendly name of this PHY type
 681  * @phy_id_mask: Defines the important bits of the phy_id
 682  * @features: A mandatory list of features (speed, duplex, etc)
 683  *   supported by this PHY
 684  * @flags: A bitfield defining certain other features this PHY
 685  *   supports (like interrupts)
 686  * @driver_data: Static driver data
 687  *
 688  * All functions are optional. If config_aneg or read_status
 689  * are not implemented, the phy core uses the genphy versions.
 690  * Note that none of these functions should be called from
 691  * interrupt time. The goal is for the bus read/write functions
 692  * to be able to block when the bus transaction is happening,
 693  * and be freed up by an interrupt (The MPC85xx has this ability,
 694  * though it is not currently supported in the driver).
 695  */
 696 struct phy_driver {
 697         struct mdio_driver_common mdiodrv;
 698         u32 phy_id;
 699         char *name;
 700         u32 phy_id_mask;
 701         const unsigned long * const features;
 702         u32 flags;
 703         const void *driver_data;
 704
 705         /**
 706          * @soft_reset: Called to issue a PHY software reset
 707          */
 708         int (*soft_reset)(struct phy_device *phydev);
 709
 710         /**
 711          * @config_init: Called to initialize the PHY,
 712          * including after a reset
 713          */
 714         int (*config_init)(struct phy_device *phydev);
 715
 716         /**
 717          * @probe: Called during discovery.  Used to set
 718          * up device-specific structures, if any
 719          */
 720         int (*probe)(struct phy_device *phydev);
 721
 722         /**
 723          * @get_features: Probe the hardware to determine what
 724          * abilities it has.  Should only set phydev->supported.
 725          */
 726         int (*get_features)(struct phy_device *phydev);
 727
 728         /* PHY Power Management */
 729         /** @suspend: Suspend the hardware, saving state if needed */
 730         int (*suspend)(struct phy_device *phydev);
 731         /** @resume: Resume the hardware, restoring state if needed */
 732         int (*resume)(struct phy_device *phydev);
 733
 734         /**
 735          * @config_aneg: Configures the advertisement and resets
 736          * autonegotiation if phydev->autoneg is on,
 737          * forces the speed to the current settings in phydev
 738          * if phydev->autoneg is off
 739          */
 740         int (*config_aneg)(struct phy_device *phydev);
 741
 742         /** @aneg_done: Determines the auto negotiation result */
 743         int (*aneg_done)(struct phy_device *phydev);
 744
 745         /** @read_status: Determines the negotiated speed and duplex */
 746         int (*read_status)(struct phy_device *phydev);
 747
 748         /** @ack_interrupt: Clears any pending interrupts */
 749         int (*ack_interrupt)(struct phy_device *phydev);
 750
 751         /** @config_intr: Enables or disables interrupts */
 752         int (*config_intr)(struct phy_device *phydev);
 753
 754         /**
 755          * @did_interrupt: Checks if the PHY generated an interrupt.
 756          * For multi-PHY devices with shared PHY interrupt pin
 757          * Set interrupt bits have to be cleared.
 758          */
 759         int (*did_interrupt)(struct phy_device *phydev);
 760
 761         /** @handle_interrupt: Override default interrupt handling */
 762         irqreturn_t (*handle_interrupt)(struct phy_device *phydev);
 763
 764         /** @remove: Clears up any memory if needed */
 765         void (*remove)(struct phy_device *phydev);
 766
 767         /**
 768          * @match_phy_device: Returns true if this is a suitable
 769          * driver for the given phydev.  If NULL, matching is based on
 770          * phy_id and phy_id_mask.
 771          */
 772         int (*match_phy_device)(struct phy_device *phydev);
 773
 774         /**
 775          * @set_wol: Some devices (e.g. qnap TS-119P II) require PHY
 776          * register changes to enable Wake on LAN, so set_wol is
 777          * provided to be called in the ethernet driver's set_wol
 778          * function.
 779          */
 780         int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 781
 782         /**
 783          * @get_wol: See set_wol, but for checking whether Wake on LAN
 784          * is enabled.
 785          */
 786         void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 787
 788         /**
 789          * @link_change_notify: Called to inform a PHY device driver
 790          * when the core is about to change the link state. This
 791          * callback is supposed to be used as fixup hook for drivers
 792          * that need to take action when the link state
 793          * changes. Drivers are by no means allowed to mess with the
 794          * PHY device structure in their implementations.
 795          */
 796         void (*link_change_notify)(struct phy_device *dev);
 797
 798         /**
 799          * @read_mmd: PHY specific driver override for reading a MMD
 800          * register.  This function is optional for PHY specific
 801          * drivers.  When not provided, the default MMD read function
 802          * will be used by phy_read_mmd(), which will use either a
 803          * direct read for Clause 45 PHYs or an indirect read for
 804          * Clause 22 PHYs.  devnum is the MMD device number within the
 805          * PHY device, regnum is the register within the selected MMD
 806          * device.
 807          */
 808         int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
 809
 810         /**
 811          * @write_mmd: PHY specific driver override for writing a MMD
 812          * register.  This function is optional for PHY specific
 813          * drivers.  When not provided, the default MMD write function
 814          * will be used by phy_write_mmd(), which will use either a
 815          * direct write for Clause 45 PHYs, or an indirect write for
 816          * Clause 22 PHYs.  devnum is the MMD device number within the
 817          * PHY device, regnum is the register within the selected MMD
 818          * device.  val is the value to be written.
 819          */
 820         int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
 821                          u16 val);
 822
 823         /** @read_page: Return the current PHY register page number */
 824         int (*read_page)(struct phy_device *dev);
 825         /** @write_page: Set the current PHY register page number */
 826         int (*write_page)(struct phy_device *dev, int page);
 827
 828         /**
 829          * @module_info: Get the size and type of the eeprom contained
 830          * within a plug-in module
 831          */
 832         int (*module_info)(struct phy_device *dev,
 833                            struct ethtool_modinfo *modinfo);
 834
 835         /**
 836          * @module_eeprom: Get the eeprom information from the plug-in
 837          * module
 838          */
 839         int (*module_eeprom)(struct phy_device *dev,
 840                              struct ethtool_eeprom *ee, u8 *data);
 841
 842         /** @cable_test_start: Start a cable test */
 843         int (*cable_test_start)(struct phy_device *dev);
 844
 845         /**  @cable_test_tdr_start: Start a raw TDR cable test */
 846         int (*cable_test_tdr_start)(struct phy_device *dev,
 847                                     const struct phy_tdr_config *config);
 848
 849         /**
 850          * @cable_test_get_status: Once per second, or on interrupt,
 851          * request the status of the test.
 852          */
 853         int (*cable_test_get_status)(struct phy_device *dev, bool *finished);
 854
 855         /* Get statistics from the PHY using ethtool */
 856         /** @get_sset_count: Number of statistic counters */
 857         int (*get_sset_count)(struct phy_device *dev);
 858         /** @get_strings: Names of the statistic counters */
 859         void (*get_strings)(struct phy_device *dev, u8 *data);
 860         /** @get_stats: Return the statistic counter values */
 861         void (*get_stats)(struct phy_device *dev,
 862                           struct ethtool_stats *stats, u64 *data);
 863
 864         /* Get and Set PHY tunables */
 865         /** @get_tunable: Return the value of a tunable */
 866         int (*get_tunable)(struct phy_device *dev,
 867                            struct ethtool_tunable *tuna, void *data);
 868         /** @set_tunable: Set the value of a tunable */
 869         int (*set_tunable)(struct phy_device *dev,
 870                             struct ethtool_tunable *tuna,
 871                             const void *data);
 872         /** @set_loopback: Set the loopback mood of the PHY */
 873         int (*set_loopback)(struct phy_device *dev, bool enable);
 874         /** @get_sqi: Get the signal quality indication */
 875         int (*get_sqi)(struct phy_device *dev);
 876         /** @get_sqi_max: Get the maximum signal quality indication */
 877         int (*get_sqi_max)(struct phy_device *dev);
 878 };
 879 #define to_phy_driver(d) container_of(to_mdio_common_driver(d),         \
 880                                       struct phy_driver, mdiodrv)
 881
 882 #define PHY_ANY_ID "MATCH ANY PHY"
 883 #define PHY_ANY_UID 0xffffffff
 884
 885 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
 886 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
 887 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
 888
 889 /* A Structure for boards to register fixups with the PHY Lib */
 890 struct phy_fixup {
 891         struct list_head list;
 892         char bus_id[MII_BUS_ID_SIZE + 3];
 893         u32 phy_uid;
 894         u32 phy_uid_mask;
 895         int (*run)(struct phy_device *phydev);
 896 };
 897
 898 const char *phy_speed_to_str(int speed);
 899 const char *phy_duplex_to_str(unsigned int duplex);
 900
 901 /* A structure for mapping a particular speed and duplex
 902  * combination to a particular SUPPORTED and ADVERTISED value
 903  */
 904 struct phy_setting {
 905         u32 speed;
 906         u8 duplex;
 907         u8 bit;
 908 };
 909
 910 const struct phy_setting *
 911 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
 912                    bool exact);
 913 size_t phy_speeds(unsigned int *speeds, size_t size,
 914                   unsigned long *mask);
 915 void of_set_phy_supported(struct phy_device *phydev);
 916 void of_set_phy_eee_broken(struct phy_device *phydev);
 917 int phy_speed_down_core(struct phy_device *phydev);
 918
 919 /**
 920  * phy_is_started - Convenience function to check whether PHY is started
 921  * @phydev: The phy_device struct
 922  */
 923 static inline bool phy_is_started(struct phy_device *phydev)
 924 {
 925         return phydev->state >= PHY_UP;
 926 }
 927
 928 void phy_resolve_aneg_pause(struct phy_device *phydev);
 929 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
 930 void phy_check_downshift(struct phy_device *phydev);
 931
 932 /**
 933  * phy_read - Convenience function for reading a given PHY register
 934  * @phydev: the phy_device struct
 935  * @regnum: register number to read
 936  *
 937  * NOTE: MUST NOT be called from interrupt context,
 938  * because the bus read/write functions may wait for an interrupt
 939  * to conclude the operation.
 940  */
 941 static inline int phy_read(struct phy_device *phydev, u32 regnum)
 942 {
 943         return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
 944 }
 945
 946 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \
 947                                 timeout_us, sleep_before_read) \
 948 ({ \
 949         int __ret = read_poll_timeout(phy_read, val, (cond) || val < 0, \
 950                 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \
 951         if (val <  0) \
 952                 __ret = val; \
 953         if (__ret) \
 954                 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
 955         __ret; \
 956 })
 957
 958
 959 /**
 960  * __phy_read - convenience function for reading a given PHY register
 961  * @phydev: the phy_device struct
 962  * @regnum: register number to read
 963  *
 964  * The caller must have taken the MDIO bus lock.
 965  */
 966 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
 967 {
 968         return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
 969 }
 970
 971 /**
 972  * phy_write - Convenience function for writing a given PHY register
 973  * @phydev: the phy_device struct
 974  * @regnum: register number to write
 975  * @val: value to write to @regnum
 976  *
 977  * NOTE: MUST NOT be called from interrupt context,
 978  * because the bus read/write functions may wait for an interrupt
 979  * to conclude the operation.
 980  */
 981 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 982 {
 983         return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
 984 }
 985
 986 /**
 987  * __phy_write - Convenience function for writing a given PHY register
 988  * @phydev: the phy_device struct
 989  * @regnum: register number to write
 990  * @val: value to write to @regnum
 991  *
 992  * The caller must have taken the MDIO bus lock.
 993  */
 994 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 995 {
 996         return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
 997                                val);
 998 }
 999
1000 /**
1001  * __phy_modify_changed() - Convenience function for modifying a PHY register
1002  * @phydev: a pointer to a &struct phy_device
1003  * @regnum: register number
1004  * @mask: bit mask of bits to clear
1005  * @set: bit mask of bits to set
1006  *
1007  * Unlocked helper function which allows a PHY register to be modified as
1008  * new register value = (old register value & ~mask) | set
1009  *
1010  * Returns negative errno, 0 if there was no change, and 1 in case of change
1011  */
1012 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
1013                                        u16 mask, u16 set)
1014 {
1015         return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr,
1016                                         regnum, mask, set);
1017 }
1018
1019 /*
1020  * phy_read_mmd - Convenience function for reading a register
1021  * from an MMD on a given PHY.
1022  */
1023 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1024
1025 /**
1026  * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
1027  *                             condition is met or a timeout occurs
1028  *
1029  * @phydev: The phy_device struct
1030  * @devaddr: The MMD to read from
1031  * @regnum: The register on the MMD to read
1032  * @val: Variable to read the register into
1033  * @cond: Break condition (usually involving @val)
1034  * @sleep_us: Maximum time to sleep between reads in us (0
1035  *            tight-loops).  Should be less than ~20ms since usleep_range
1036  *            is used (see Documentation/timers/timers-howto.rst).
1037  * @timeout_us: Timeout in us, 0 means never timeout
1038  * @sleep_before_read: if it is true, sleep @sleep_us before read.
1039  * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
1040  * case, the last read value at @args is stored in @val. Must not
1041  * be called from atomic context if sleep_us or timeout_us are used.
1042  */
1043 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
1044                                   sleep_us, timeout_us, sleep_before_read) \
1045 ({ \
1046         int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
1047                                   sleep_us, timeout_us, sleep_before_read, \
1048                                   phydev, devaddr, regnum); \
1049         if (val <  0) \
1050                 __ret = val; \
1051         if (__ret) \
1052                 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1053         __ret; \
1054 })
1055
1056 /*
1057  * __phy_read_mmd - Convenience function for reading a register
1058  * from an MMD on a given PHY.
1059  */
1060 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1061
1062 /*
1063  * phy_write_mmd - Convenience function for writing a register
1064  * on an MMD on a given PHY.
1065  */
1066 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1067
1068 /*
1069  * __phy_write_mmd - Convenience function for writing a register
1070  * on an MMD on a given PHY.
1071  */
1072 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1073
1074 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1075                          u16 set);
1076 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1077                        u16 set);
1078 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1079 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1080
1081 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1082                              u16 mask, u16 set);
1083 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1084                            u16 mask, u16 set);
1085 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1086                      u16 mask, u16 set);
1087 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1088                    u16 mask, u16 set);
1089
1090 /**
1091  * __phy_set_bits - Convenience function for setting bits in a PHY register
1092  * @phydev: the phy_device struct
1093  * @regnum: register number to write
1094  * @val: bits to set
1095  *
1096  * The caller must have taken the MDIO bus lock.
1097  */
1098 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1099 {
1100         return __phy_modify(phydev, regnum, 0, val);
1101 }
1102
1103 /**
1104  * __phy_clear_bits - Convenience function for clearing bits in a PHY register
1105  * @phydev: the phy_device struct
1106  * @regnum: register number to write
1107  * @val: bits to clear
1108  *
1109  * The caller must have taken the MDIO bus lock.
1110  */
1111 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
1112                                    u16 val)
1113 {
1114         return __phy_modify(phydev, regnum, val, 0);
1115 }
1116
1117 /**
1118  * phy_set_bits - Convenience function for setting bits in a PHY register
1119  * @phydev: the phy_device struct
1120  * @regnum: register number to write
1121  * @val: bits to set
1122  */
1123 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1124 {
1125         return phy_modify(phydev, regnum, 0, val);
1126 }
1127
1128 /**
1129  * phy_clear_bits - Convenience function for clearing bits in a PHY register
1130  * @phydev: the phy_device struct
1131  * @regnum: register number to write
1132  * @val: bits to clear
1133  */
1134 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
1135 {
1136         return phy_modify(phydev, regnum, val, 0);
1137 }
1138
1139 /**
1140  * __phy_set_bits_mmd - Convenience function for setting bits in a register
1141  * on MMD
1142  * @phydev: the phy_device struct
1143  * @devad: the MMD containing register to modify
1144  * @regnum: register number to modify
1145  * @val: bits to set
1146  *
1147  * The caller must have taken the MDIO bus lock.
1148  */
1149 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
1150                 u32 regnum, u16 val)
1151 {
1152         return __phy_modify_mmd(phydev, devad, regnum, 0, val);
1153 }
1154
1155 /**
1156  * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
1157  * on MMD
1158  * @phydev: the phy_device struct
1159  * @devad: the MMD containing register to modify
1160  * @regnum: register number to modify
1161  * @val: bits to clear
1162  *
1163  * The caller must have taken the MDIO bus lock.
1164  */
1165 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1166                 u32 regnum, u16 val)
1167 {
1168         return __phy_modify_mmd(phydev, devad, regnum, val, 0);
1169 }
1170
1171 /**
1172  * phy_set_bits_mmd - Convenience function for setting bits in a register
1173  * on MMD
1174  * @phydev: the phy_device struct
1175  * @devad: the MMD containing register to modify
1176  * @regnum: register number to modify
1177  * @val: bits to set
1178  */
1179 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
1180                 u32 regnum, u16 val)
1181 {
1182         return phy_modify_mmd(phydev, devad, regnum, 0, val);
1183 }
1184
1185 /**
1186  * phy_clear_bits_mmd - Convenience function for clearing bits in a register
1187  * on MMD
1188  * @phydev: the phy_device struct
1189  * @devad: the MMD containing register to modify
1190  * @regnum: register number to modify
1191  * @val: bits to clear
1192  */
1193 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1194                 u32 regnum, u16 val)
1195 {
1196         return phy_modify_mmd(phydev, devad, regnum, val, 0);
1197 }
1198
1199 /**
1200  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
1201  * @phydev: the phy_device struct
1202  *
1203  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
1204  * PHY_IGNORE_INTERRUPT
1205  */
1206 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
1207 {
1208         return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
1209 }
1210
1211 /**
1212  * phy_polling_mode - Convenience function for testing whether polling is
1213  * used to detect PHY status changes
1214  * @phydev: the phy_device struct
1215  */
1216 static inline bool phy_polling_mode(struct phy_device *phydev)
1217 {
1218         if (phydev->state == PHY_CABLETEST)
1219                 if (phydev->drv->flags & PHY_POLL_CABLE_TEST)
1220                         return true;
1221
1222         return phydev->irq == PHY_POLL;
1223 }
1224
1225 /**
1226  * phy_has_hwtstamp - Tests whether a PHY time stamp configuration.
1227  * @phydev: the phy_device struct
1228  */
1229 static inline bool phy_has_hwtstamp(struct phy_device *phydev)
1230 {
1231         return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp;
1232 }
1233
1234 /**
1235  * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping.
1236  * @phydev: the phy_device struct
1237  */
1238 static inline bool phy_has_rxtstamp(struct phy_device *phydev)
1239 {
1240         return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp;
1241 }
1242
1243 /**
1244  * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or
1245  * PTP hardware clock capabilities.
1246  * @phydev: the phy_device struct
1247  */
1248 static inline bool phy_has_tsinfo(struct phy_device *phydev)
1249 {
1250         return phydev && phydev->mii_ts && phydev->mii_ts->ts_info;
1251 }
1252
1253 /**
1254  * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping.
1255  * @phydev: the phy_device struct
1256  */
1257 static inline bool phy_has_txtstamp(struct phy_device *phydev)
1258 {
1259         return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp;
1260 }
1261
1262 static inline int phy_hwtstamp(struct phy_device *phydev, struct ifreq *ifr)
1263 {
1264         return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
1265 }
1266
1267 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb,
1268                                 int type)
1269 {
1270         return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type);
1271 }
1272
1273 static inline int phy_ts_info(struct phy_device *phydev,
1274                               struct ethtool_ts_info *tsinfo)
1275 {
1276         return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo);
1277 }
1278
1279 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb,
1280                                 int type)
1281 {
1282         phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type);
1283 }
1284
1285 /**
1286  * phy_is_internal - Convenience function for testing if a PHY is internal
1287  * @phydev: the phy_device struct
1288  */
1289 static inline bool phy_is_internal(struct phy_device *phydev)
1290 {
1291         return phydev->is_internal;
1292 }
1293
1294 /**
1295  * phy_interface_mode_is_rgmii - Convenience function for testing if a
1296  * PHY interface mode is RGMII (all variants)
1297  * @mode: the &phy_interface_t enum
1298  */
1299 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
1300 {
1301         return mode >= PHY_INTERFACE_MODE_RGMII &&
1302                 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
1303 };
1304
1305 /**
1306  * phy_interface_mode_is_8023z() - does the PHY interface mode use 802.3z
1307  *   negotiation
1308  * @mode: one of &enum phy_interface_t
1309  *
1310  * Returns true if the PHY interface mode uses the 16-bit negotiation
1311  * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
1312  */
1313 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
1314 {
1315         return mode == PHY_INTERFACE_MODE_1000BASEX ||
1316                mode == PHY_INTERFACE_MODE_2500BASEX;
1317 }
1318
1319 /**
1320  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
1321  * is RGMII (all variants)
1322  * @phydev: the phy_device struct
1323  */
1324 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
1325 {
1326         return phy_interface_mode_is_rgmii(phydev->interface);
1327 };
1328
1329 /**
1330  * phy_is_pseudo_fixed_link - Convenience function for testing if this
1331  * PHY is the CPU port facing side of an Ethernet switch, or similar.
1332  * @phydev: the phy_device struct
1333  */
1334 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
1335 {
1336         return phydev->is_pseudo_fixed_link;
1337 }
1338
1339 int phy_save_page(struct phy_device *phydev);
1340 int phy_select_page(struct phy_device *phydev, int page);
1341 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
1342 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
1343 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
1344 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum,
1345                              u16 mask, u16 set);
1346 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
1347                      u16 mask, u16 set);
1348
1349 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
1350                                      bool is_c45,
1351                                      struct phy_c45_device_ids *c45_ids);
1352 #if IS_ENABLED(CONFIG_PHYLIB)
1353 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
1354 int phy_device_register(struct phy_device *phy);
1355 void phy_device_free(struct phy_device *phydev);
1356 #else
1357 static inline
1358 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1359 {
1360         return NULL;
1361 }
1362
1363 static inline int phy_device_register(struct phy_device *phy)
1364 {
1365         return 0;
1366 }
1367
1368 static inline void phy_device_free(struct phy_device *phydev) { }
1369 #endif /* CONFIG_PHYLIB */
1370 void phy_device_remove(struct phy_device *phydev);
1371 int phy_init_hw(struct phy_device *phydev);
1372 int phy_suspend(struct phy_device *phydev);
1373 int phy_resume(struct phy_device *phydev);
1374 int __phy_resume(struct phy_device *phydev);
1375 int phy_loopback(struct phy_device *phydev, bool enable);
1376 void phy_sfp_attach(void *upstream, struct sfp_bus *bus);
1377 void phy_sfp_detach(void *upstream, struct sfp_bus *bus);
1378 int phy_sfp_probe(struct phy_device *phydev,
1379                   const struct sfp_upstream_ops *ops);
1380 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1381                               phy_interface_t interface);
1382 struct phy_device *phy_find_first(struct mii_bus *bus);
1383 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1384                       u32 flags, phy_interface_t interface);
1385 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1386                        void (*handler)(struct net_device *),
1387                        phy_interface_t interface);
1388 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1389                                void (*handler)(struct net_device *),
1390                                phy_interface_t interface);
1391 void phy_disconnect(struct phy_device *phydev);
1392 void phy_detach(struct phy_device *phydev);
1393 void phy_start(struct phy_device *phydev);
1394 void phy_stop(struct phy_device *phydev);
1395 int phy_start_aneg(struct phy_device *phydev);
1396 int phy_aneg_done(struct phy_device *phydev);
1397 int phy_speed_down(struct phy_device *phydev, bool sync);
1398 int phy_speed_up(struct phy_device *phydev);
1399
1400 int phy_restart_aneg(struct phy_device *phydev);
1401 int phy_reset_after_clk_enable(struct phy_device *phydev);
1402
1403 #if IS_ENABLED(CONFIG_PHYLIB)
1404 int phy_start_cable_test(struct phy_device *phydev,
1405                          struct netlink_ext_ack *extack);
1406 int phy_start_cable_test_tdr(struct phy_device *phydev,
1407                              struct netlink_ext_ack *extack,
1408                              const struct phy_tdr_config *config);
1409 #else
1410 static inline
1411 int phy_start_cable_test(struct phy_device *phydev,
1412                          struct netlink_ext_ack *extack)
1413 {
1414         NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1415         return -EOPNOTSUPP;
1416 }
1417 static inline
1418 int phy_start_cable_test_tdr(struct phy_device *phydev,
1419                              struct netlink_ext_ack *extack,
1420                              const struct phy_tdr_config *config)
1421 {
1422         NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1423         return -EOPNOTSUPP;
1424 }
1425 #endif
1426
1427 int phy_cable_test_result(struct phy_device *phydev, u8 pair, u16 result);
1428 int phy_cable_test_fault_length(struct phy_device *phydev, u8 pair,
1429                                 u16 cm);
1430
1431 static inline void phy_device_reset(struct phy_device *phydev, int value)
1432 {
1433         mdio_device_reset(&phydev->mdio, value);
1434 }
1435
1436 #define phydev_err(_phydev, format, args...)    \
1437         dev_err(&_phydev->mdio.dev, format, ##args)
1438
1439 #define phydev_info(_phydev, format, args...)   \
1440         dev_info(&_phydev->mdio.dev, format, ##args)
1441
1442 #define phydev_warn(_phydev, format, args...)   \
1443         dev_warn(&_phydev->mdio.dev, format, ##args)
1444
1445 #define phydev_dbg(_phydev, format, args...)    \
1446         dev_dbg(&_phydev->mdio.dev, format, ##args)
1447
1448 static inline const char *phydev_name(const struct phy_device *phydev)
1449 {
1450         return dev_name(&phydev->mdio.dev);
1451 }
1452
1453 static inline void phy_lock_mdio_bus(struct phy_device *phydev)
1454 {
1455         mutex_lock(&phydev->mdio.bus->mdio_lock);
1456 }
1457
1458 static inline void phy_unlock_mdio_bus(struct phy_device *phydev)
1459 {
1460         mutex_unlock(&phydev->mdio.bus->mdio_lock);
1461 }
1462
1463 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1464         __printf(2, 3);
1465 char *phy_attached_info_irq(struct phy_device *phydev)
1466         __malloc;
1467 void phy_attached_info(struct phy_device *phydev);
1468
1469 /* Clause 22 PHY */
1470 int genphy_read_abilities(struct phy_device *phydev);
1471 int genphy_setup_forced(struct phy_device *phydev);
1472 int genphy_restart_aneg(struct phy_device *phydev);
1473 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1474 int genphy_config_eee_advert(struct phy_device *phydev);
1475 int __genphy_config_aneg(struct phy_device *phydev, bool changed);
1476 int genphy_aneg_done(struct phy_device *phydev);
1477 int genphy_update_link(struct phy_device *phydev);
1478 int genphy_read_lpa(struct phy_device *phydev);
1479 int genphy_read_status_fixed(struct phy_device *phydev);
1480 int genphy_read_status(struct phy_device *phydev);
1481 int genphy_suspend(struct phy_device *phydev);
1482 int genphy_resume(struct phy_device *phydev);
1483 int genphy_loopback(struct phy_device *phydev, bool enable);
1484 int genphy_soft_reset(struct phy_device *phydev);
1485
1486 static inline int genphy_config_aneg(struct phy_device *phydev)
1487 {
1488         return __genphy_config_aneg(phydev, false);
1489 }
1490
1491 static inline int genphy_no_ack_interrupt(struct phy_device *phydev)
1492 {
1493         return 0;
1494 }
1495 static inline int genphy_no_config_intr(struct phy_device *phydev)
1496 {
1497         return 0;
1498 }
1499 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1500                                 u16 regnum);
1501 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1502                                  u16 regnum, u16 val);
1503
1504 /* Clause 37 */
1505 int genphy_c37_config_aneg(struct phy_device *phydev);
1506 int genphy_c37_read_status(struct phy_device *phydev);
1507
1508 /* Clause 45 PHY */
1509 int genphy_c45_restart_aneg(struct phy_device *phydev);
1510 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1511 int genphy_c45_aneg_done(struct phy_device *phydev);
1512 int genphy_c45_read_link(struct phy_device *phydev);
1513 int genphy_c45_read_lpa(struct phy_device *phydev);
1514 int genphy_c45_read_pma(struct phy_device *phydev);
1515 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1516 int genphy_c45_an_config_aneg(struct phy_device *phydev);
1517 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1518 int genphy_c45_read_mdix(struct phy_device *phydev);
1519 int genphy_c45_pma_read_abilities(struct phy_device *phydev);
1520 int genphy_c45_read_status(struct phy_device *phydev);
1521 int genphy_c45_config_aneg(struct phy_device *phydev);
1522
1523 /* Generic C45 PHY driver */
1524 extern struct phy_driver genphy_c45_driver;
1525
1526 /* The gen10g_* functions are the old Clause 45 stub */
1527 int gen10g_config_aneg(struct phy_device *phydev);
1528
1529 static inline int phy_read_status(struct phy_device *phydev)
1530 {
1531         if (!phydev->drv)
1532                 return -EIO;
1533
1534         if (phydev->drv->read_status)
1535                 return phydev->drv->read_status(phydev);
1536         else
1537                 return genphy_read_status(phydev);
1538 }
1539
1540 void phy_driver_unregister(struct phy_driver *drv);
1541 void phy_drivers_unregister(struct phy_driver *drv, int n);
1542 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1543 int phy_drivers_register(struct phy_driver *new_driver, int n,
1544                          struct module *owner);
1545 void phy_state_machine(struct work_struct *work);
1546 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies);
1547 void phy_mac_interrupt(struct phy_device *phydev);
1548 void phy_start_machine(struct phy_device *phydev);
1549 void phy_stop_machine(struct phy_device *phydev);
1550 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1551                                struct ethtool_link_ksettings *cmd);
1552 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1553                               const struct ethtool_link_ksettings *cmd);
1554 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1555 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
1556 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd);
1557 int phy_disable_interrupts(struct phy_device *phydev);
1558 void phy_request_interrupt(struct phy_device *phydev);
1559 void phy_free_interrupt(struct phy_device *phydev);
1560 void phy_print_status(struct phy_device *phydev);
1561 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1562 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1563 void phy_advertise_supported(struct phy_device *phydev);
1564 void phy_support_sym_pause(struct phy_device *phydev);
1565 void phy_support_asym_pause(struct phy_device *phydev);
1566 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1567                        bool autoneg);
1568 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1569 bool phy_validate_pause(struct phy_device *phydev,
1570                         struct ethtool_pauseparam *pp);
1571 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause);
1572
1573 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
1574                            const int *delay_values, int size, bool is_rx);
1575
1576 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv,
1577                        bool *tx_pause, bool *rx_pause);
1578
1579 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1580                        int (*run)(struct phy_device *));
1581 int phy_register_fixup_for_id(const char *bus_id,
1582                               int (*run)(struct phy_device *));
1583 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1584                                int (*run)(struct phy_device *));
1585
1586 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1587 int phy_unregister_fixup_for_id(const char *bus_id);
1588 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1589
1590 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1591 int phy_get_eee_err(struct phy_device *phydev);
1592 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1593 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1594 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1595 void phy_ethtool_get_wol(struct phy_device *phydev,
1596                          struct ethtool_wolinfo *wol);
1597 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1598                                    struct ethtool_link_ksettings *cmd);
1599 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1600                                    const struct ethtool_link_ksettings *cmd);
1601 int phy_ethtool_nway_reset(struct net_device *ndev);
1602 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size);
1603 void phy_package_leave(struct phy_device *phydev);
1604 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1605                           int addr, size_t priv_size);
1606
1607 #if IS_ENABLED(CONFIG_PHYLIB)
1608 int __init mdio_bus_init(void);
1609 void mdio_bus_exit(void);
1610 #endif
1611
1612 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data);
1613 int phy_ethtool_get_sset_count(struct phy_device *phydev);
1614 int phy_ethtool_get_stats(struct phy_device *phydev,
1615                           struct ethtool_stats *stats, u64 *data);
1616
1617 static inline int phy_package_read(struct phy_device *phydev, u32 regnum)
1618 {
1619         struct phy_package_shared *shared = phydev->shared;
1620
1621         if (!shared)
1622                 return -EIO;
1623
1624         return mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1625 }
1626
1627 static inline int __phy_package_read(struct phy_device *phydev, u32 regnum)
1628 {
1629         struct phy_package_shared *shared = phydev->shared;
1630
1631         if (!shared)
1632                 return -EIO;
1633
1634         return __mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1635 }
1636
1637 static inline int phy_package_write(struct phy_device *phydev,
1638                                     u32 regnum, u16 val)
1639 {
1640         struct phy_package_shared *shared = phydev->shared;
1641
1642         if (!shared)
1643                 return -EIO;
1644
1645         return mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1646 }
1647
1648 static inline int __phy_package_write(struct phy_device *phydev,
1649                                       u32 regnum, u16 val)
1650 {
1651         struct phy_package_shared *shared = phydev->shared;
1652
1653         if (!shared)
1654                 return -EIO;
1655
1656         return __mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1657 }
1658
1659 static inline bool __phy_package_set_once(struct phy_device *phydev,
1660                                           unsigned int b)
1661 {
1662         struct phy_package_shared *shared = phydev->shared;
1663
1664         if (!shared)
1665                 return false;
1666
1667         return !test_and_set_bit(b, &shared->flags);
1668 }
1669
1670 static inline bool phy_package_init_once(struct phy_device *phydev)
1671 {
1672         return __phy_package_set_once(phydev, PHY_SHARED_F_INIT_DONE);
1673 }
1674
1675 static inline bool phy_package_probe_once(struct phy_device *phydev)
1676 {
1677         return __phy_package_set_once(phydev, PHY_SHARED_F_PROBE_DONE);
1678 }
1679
1680 extern struct bus_type mdio_bus_type;
1681
1682 struct mdio_board_info {
1683         const char      *bus_id;
1684         char            modalias[MDIO_NAME_SIZE];
1685         int             mdio_addr;
1686         const void      *platform_data;
1687 };
1688
1689 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1690 int mdiobus_register_board_info(const struct mdio_board_info *info,
1691                                 unsigned int n);
1692 #else
1693 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1694                                               unsigned int n)
1695 {
1696         return 0;
1697 }
1698 #endif
1699
1700
1701 /**
1702  * phy_module_driver() - Helper macro for registering PHY drivers
1703  * @__phy_drivers: array of PHY drivers to register
1704  * @__count: Numbers of members in array
1705  *
1706  * Helper macro for PHY drivers which do not do anything special in module
1707  * init/exit. Each module may only use this macro once, and calling it
1708  * replaces module_init() and module_exit().
1709  */
1710 #define phy_module_driver(__phy_drivers, __count)                       \
1711 static int __init phy_module_init(void)                                 \
1712 {                                                                       \
1713         return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1714 }                                                                       \
1715 module_init(phy_module_init);                                           \
1716 static void __exit phy_module_exit(void)                                \
1717 {                                                                       \
1718         phy_drivers_unregister(__phy_drivers, __count);                 \
1719 }                                                                       \
1720 module_exit(phy_module_exit)
1721
1722 #define module_phy_driver(__phy_drivers)                                \
1723         phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1724
1725 bool phy_driver_is_genphy(struct phy_device *phydev);
1726 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
1727
1728 #endif /* __PHY_H */