include/linux/phy.h

   1 /*
   2  * Framework and drivers for configuring and reading different PHYs
   3  * Based on code in sungem_phy.c and (long-removed) gianfar_phy.c
   4  *
   5  * Author: Andy Fleming
   6  *
   7  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   8  *
   9  * This program is free software; you can redistribute  it and/or modify it
  10  * under  the terms of  the GNU General  Public License as published by the
  11  * Free Software Foundation;  either version 2 of the  License, or (at your
  12  * option) any later version.
  13  *
  14  */
  15
  16 #ifndef __PHY_H
  17 #define __PHY_H
  18
  19 #include <linux/compiler.h>
  20 #include <linux/spinlock.h>
  21 #include <linux/ethtool.h>
  22 #include <linux/linkmode.h>
  23 #include <linux/mdio.h>
  24 #include <linux/mii.h>
  25 #include <linux/module.h>
  26 #include <linux/timer.h>
  27 #include <linux/workqueue.h>
  28 #include <linux/mod_devicetable.h>
  29
  30 #include <linux/atomic.h>
  31
  32 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
  33                                  SUPPORTED_TP | \
  34                                  SUPPORTED_MII)
  35
  36 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
  37                                  SUPPORTED_10baseT_Full)
  38
  39 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
  40                                  SUPPORTED_100baseT_Full)
  41
  42 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
  43                                  SUPPORTED_1000baseT_Full)
  44
  45 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
  46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
  47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
  48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
  49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
  50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
  51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
  52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
  53
  54 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
  55 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
  56 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
  57 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
  58 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
  59 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
  60 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
  61 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
  62
  63 extern const int phy_10_100_features_array[4];
  64 extern const int phy_basic_t1_features_array[2];
  65 extern const int phy_gbit_features_array[2];
  66 extern const int phy_10gbit_features_array[1];
  67
  68 /*
  69  * Set phydev->irq to PHY_POLL if interrupts are not supported,
  70  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
  71  * the attached driver handles the interrupt
  72  */
  73 #define PHY_POLL                -1
  74 #define PHY_IGNORE_INTERRUPT    -2
  75
  76 #define PHY_IS_INTERNAL         0x00000001
  77 #define PHY_RST_AFTER_CLK_EN    0x00000002
  78 #define MDIO_DEVICE_IS_PHY      0x80000000
  79
  80 /* Interface Mode definitions */
  81 typedef enum {
  82         PHY_INTERFACE_MODE_NA,
  83         PHY_INTERFACE_MODE_INTERNAL,
  84         PHY_INTERFACE_MODE_MII,
  85         PHY_INTERFACE_MODE_GMII,
  86         PHY_INTERFACE_MODE_SGMII,
  87         PHY_INTERFACE_MODE_TBI,
  88         PHY_INTERFACE_MODE_REVMII,
  89         PHY_INTERFACE_MODE_RMII,
  90         PHY_INTERFACE_MODE_RGMII,
  91         PHY_INTERFACE_MODE_RGMII_ID,
  92         PHY_INTERFACE_MODE_RGMII_RXID,
  93         PHY_INTERFACE_MODE_RGMII_TXID,
  94         PHY_INTERFACE_MODE_RTBI,
  95         PHY_INTERFACE_MODE_SMII,
  96         PHY_INTERFACE_MODE_XGMII,
  97         PHY_INTERFACE_MODE_MOCA,
  98         PHY_INTERFACE_MODE_QSGMII,
  99         PHY_INTERFACE_MODE_TRGMII,
 100         PHY_INTERFACE_MODE_1000BASEX,
 101         PHY_INTERFACE_MODE_2500BASEX,
 102         PHY_INTERFACE_MODE_RXAUI,
 103         PHY_INTERFACE_MODE_XAUI,
 104         /* 10GBASE-KR, XFI, SFI - single lane 10G Serdes */
 105         PHY_INTERFACE_MODE_10GKR,
 106         PHY_INTERFACE_MODE_MAX,
 107 } phy_interface_t;
 108
 109 /**
 110  * phy_supported_speeds - return all speeds currently supported by a phy device
 111  * @phy: The phy device to return supported speeds of.
 112  * @speeds: buffer to store supported speeds in.
 113  * @size: size of speeds buffer.
 114  *
 115  * Description: Returns the number of supported speeds, and fills
 116  * the speeds buffer with the supported speeds. If speeds buffer is
 117  * too small to contain all currently supported speeds, will return as
 118  * many speeds as can fit.
 119  */
 120 unsigned int phy_supported_speeds(struct phy_device *phy,
 121                                       unsigned int *speeds,
 122                                       unsigned int size);
 123
 124 /**
 125  * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
 126  * @interface: enum phy_interface_t value
 127  *
 128  * Description: maps 'enum phy_interface_t' defined in this file
 129  * into the device tree binding of 'phy-mode', so that Ethernet
 130  * device driver can get phy interface from device tree.
 131  */
 132 static inline const char *phy_modes(phy_interface_t interface)
 133 {
 134         switch (interface) {
 135         case PHY_INTERFACE_MODE_NA:
 136                 return "";
 137         case PHY_INTERFACE_MODE_INTERNAL:
 138                 return "internal";
 139         case PHY_INTERFACE_MODE_MII:
 140                 return "mii";
 141         case PHY_INTERFACE_MODE_GMII:
 142                 return "gmii";
 143         case PHY_INTERFACE_MODE_SGMII:
 144                 return "sgmii";
 145         case PHY_INTERFACE_MODE_TBI:
 146                 return "tbi";
 147         case PHY_INTERFACE_MODE_REVMII:
 148                 return "rev-mii";
 149         case PHY_INTERFACE_MODE_RMII:
 150                 return "rmii";
 151         case PHY_INTERFACE_MODE_RGMII:
 152                 return "rgmii";
 153         case PHY_INTERFACE_MODE_RGMII_ID:
 154                 return "rgmii-id";
 155         case PHY_INTERFACE_MODE_RGMII_RXID:
 156                 return "rgmii-rxid";
 157         case PHY_INTERFACE_MODE_RGMII_TXID:
 158                 return "rgmii-txid";
 159         case PHY_INTERFACE_MODE_RTBI:
 160                 return "rtbi";
 161         case PHY_INTERFACE_MODE_SMII:
 162                 return "smii";
 163         case PHY_INTERFACE_MODE_XGMII:
 164                 return "xgmii";
 165         case PHY_INTERFACE_MODE_MOCA:
 166                 return "moca";
 167         case PHY_INTERFACE_MODE_QSGMII:
 168                 return "qsgmii";
 169         case PHY_INTERFACE_MODE_TRGMII:
 170                 return "trgmii";
 171         case PHY_INTERFACE_MODE_1000BASEX:
 172                 return "1000base-x";
 173         case PHY_INTERFACE_MODE_2500BASEX:
 174                 return "2500base-x";
 175         case PHY_INTERFACE_MODE_RXAUI:
 176                 return "rxaui";
 177         case PHY_INTERFACE_MODE_XAUI:
 178                 return "xaui";
 179         case PHY_INTERFACE_MODE_10GKR:
 180                 return "10gbase-kr";
 181         default:
 182                 return "unknown";
 183         }
 184 }
 185
 186
 187 #define PHY_INIT_TIMEOUT        100000
 188 #define PHY_STATE_TIME          1
 189 #define PHY_FORCE_TIMEOUT       10
 190
 191 #define PHY_MAX_ADDR    32
 192
 193 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
 194 #define PHY_ID_FMT "%s:%02x"
 195
 196 #define MII_BUS_ID_SIZE 61
 197
 198 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
 199    IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
 200 #define MII_ADDR_C45 (1<<30)
 201
 202 struct device;
 203 struct phylink;
 204 struct sk_buff;
 205
 206 /*
 207  * The Bus class for PHYs.  Devices which provide access to
 208  * PHYs should register using this structure
 209  */
 210 struct mii_bus {
 211         struct module *owner;
 212         const char *name;
 213         char id[MII_BUS_ID_SIZE];
 214         void *priv;
 215         int (*read)(struct mii_bus *bus, int addr, int regnum);
 216         int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
 217         int (*reset)(struct mii_bus *bus);
 218
 219         /*
 220          * A lock to ensure that only one thing can read/write
 221          * the MDIO bus at a time
 222          */
 223         struct mutex mdio_lock;
 224
 225         struct device *parent;
 226         enum {
 227                 MDIOBUS_ALLOCATED = 1,
 228                 MDIOBUS_REGISTERED,
 229                 MDIOBUS_UNREGISTERED,
 230                 MDIOBUS_RELEASED,
 231         } state;
 232         struct device dev;
 233
 234         /* list of all PHYs on bus */
 235         struct mdio_device *mdio_map[PHY_MAX_ADDR];
 236
 237         /* PHY addresses to be ignored when probing */
 238         u32 phy_mask;
 239
 240         /* PHY addresses to ignore the TA/read failure */
 241         u32 phy_ignore_ta_mask;
 242
 243         /*
 244          * An array of interrupts, each PHY's interrupt at the index
 245          * matching its address
 246          */
 247         int irq[PHY_MAX_ADDR];
 248
 249         /* GPIO reset pulse width in microseconds */
 250         int reset_delay_us;
 251         /* RESET GPIO descriptor pointer */
 252         struct gpio_desc *reset_gpiod;
 253 };
 254 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
 255
 256 struct mii_bus *mdiobus_alloc_size(size_t);
 257 static inline struct mii_bus *mdiobus_alloc(void)
 258 {
 259         return mdiobus_alloc_size(0);
 260 }
 261
 262 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
 263 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
 264 void mdiobus_unregister(struct mii_bus *bus);
 265 void mdiobus_free(struct mii_bus *bus);
 266 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
 267 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
 268 {
 269         return devm_mdiobus_alloc_size(dev, 0);
 270 }
 271
 272 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
 273 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
 274
 275 #define PHY_INTERRUPT_DISABLED  false
 276 #define PHY_INTERRUPT_ENABLED   true
 277
 278 /* PHY state machine states:
 279  *
 280  * DOWN: PHY device and driver are not ready for anything.  probe
 281  * should be called if and only if the PHY is in this state,
 282  * given that the PHY device exists.
 283  * - PHY driver probe function will set the state to READY
 284  *
 285  * READY: PHY is ready to send and receive packets, but the
 286  * controller is not.  By default, PHYs which do not implement
 287  * probe will be set to this state by phy_probe().
 288  * - start will set the state to UP
 289  *
 290  * UP: The PHY and attached device are ready to do work.
 291  * Interrupts should be started here.
 292  * - timer moves to NOLINK or RUNNING
 293  *
 294  * NOLINK: PHY is up, but not currently plugged in.
 295  * - irq or timer will set RUNNING if link comes back
 296  * - phy_stop moves to HALTED
 297  *
 298  * FORCING: PHY is being configured with forced settings
 299  * - if link is up, move to RUNNING
 300  * - If link is down, we drop to the next highest setting, and
 301  *   retry (FORCING) after a timeout
 302  * - phy_stop moves to HALTED
 303  *
 304  * RUNNING: PHY is currently up, running, and possibly sending
 305  * and/or receiving packets
 306  * - irq or timer will set NOLINK if link goes down
 307  * - phy_stop moves to HALTED
 308  *
 309  * HALTED: PHY is up, but no polling or interrupts are done. Or
 310  * PHY is in an error state.
 311  *
 312  * - phy_start moves to RESUMING
 313  *
 314  * RESUMING: PHY was halted, but now wants to run again.
 315  * - If we are forcing, or aneg is done, timer moves to RUNNING
 316  * - If aneg is not done, timer moves to AN
 317  * - phy_stop moves to HALTED
 318  */
 319 enum phy_state {
 320         PHY_DOWN = 0,
 321         PHY_READY,
 322         PHY_HALTED,
 323         PHY_UP,
 324         PHY_RUNNING,
 325         PHY_NOLINK,
 326         PHY_FORCING,
 327         PHY_RESUMING
 328 };
 329
 330 /**
 331  * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
 332  * @devices_in_package: Bit vector of devices present.
 333  * @device_ids: The device identifer for each present device.
 334  */
 335 struct phy_c45_device_ids {
 336         u32 devices_in_package;
 337         u32 device_ids[8];
 338 };
 339
 340 /* phy_device: An instance of a PHY
 341  *
 342  * drv: Pointer to the driver for this PHY instance
 343  * phy_id: UID for this device found during discovery
 344  * c45_ids: 802.3-c45 Device Identifers if is_c45.
 345  * is_c45:  Set to true if this phy uses clause 45 addressing.
 346  * is_internal: Set to true if this phy is internal to a MAC.
 347  * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc.
 348  * has_fixups: Set to true if this phy has fixups/quirks.
 349  * suspended: Set to true if this phy has been suspended successfully.
 350  * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
 351  * loopback_enabled: Set true if this phy has been loopbacked successfully.
 352  * state: state of the PHY for management purposes
 353  * dev_flags: Device-specific flags used by the PHY driver.
 354  * link_timeout: The number of timer firings to wait before the
 355  * giving up on the current attempt at acquiring a link
 356  * irq: IRQ number of the PHY's interrupt (-1 if none)
 357  * phy_timer: The timer for handling the state machine
 358  * attached_dev: The attached enet driver's device instance ptr
 359  * adjust_link: Callback for the enet controller to respond to
 360  * changes in the link state.
 361  *
 362  * speed, duplex, pause, supported, advertising, lp_advertising,
 363  * and autoneg are used like in mii_if_info
 364  *
 365  * interrupts currently only supports enabled or disabled,
 366  * but could be changed in the future to support enabling
 367  * and disabling specific interrupts
 368  *
 369  * Contains some infrastructure for polling and interrupt
 370  * handling, as well as handling shifts in PHY hardware state
 371  */
 372 struct phy_device {
 373         struct mdio_device mdio;
 374
 375         /* Information about the PHY type */
 376         /* And management functions */
 377         struct phy_driver *drv;
 378
 379         u32 phy_id;
 380
 381         struct phy_c45_device_ids c45_ids;
 382         unsigned is_c45:1;
 383         unsigned is_internal:1;
 384         unsigned is_pseudo_fixed_link:1;
 385         unsigned has_fixups:1;
 386         unsigned suspended:1;
 387         unsigned sysfs_links:1;
 388         unsigned loopback_enabled:1;
 389
 390         unsigned autoneg:1;
 391         /* The most recently read link state */
 392         unsigned link:1;
 393
 394         /* Interrupts are enabled */
 395         unsigned interrupts:1;
 396
 397         enum phy_state state;
 398
 399         u32 dev_flags;
 400
 401         phy_interface_t interface;
 402
 403         /*
 404          * forced speed & duplex (no autoneg)
 405          * partner speed & duplex & pause (autoneg)
 406          */
 407         int speed;
 408         int duplex;
 409         int pause;
 410         int asym_pause;
 411
 412         /* Union of PHY and Attached devices' supported link modes */
 413         /* See ethtool.h for more info */
 414         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 415         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 416         __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
 417
 418         /* Energy efficient ethernet modes which should be prohibited */
 419         u32 eee_broken_modes;
 420
 421         int link_timeout;
 422
 423 #ifdef CONFIG_LED_TRIGGER_PHY
 424         struct phy_led_trigger *phy_led_triggers;
 425         unsigned int phy_num_led_triggers;
 426         struct phy_led_trigger *last_triggered;
 427
 428         struct phy_led_trigger *led_link_trigger;
 429 #endif
 430
 431         /*
 432          * Interrupt number for this PHY
 433          * -1 means no interrupt
 434          */
 435         int irq;
 436
 437         /* private data pointer */
 438         /* For use by PHYs to maintain extra state */
 439         void *priv;
 440
 441         /* Interrupt and Polling infrastructure */
 442         struct delayed_work state_queue;
 443
 444         struct mutex lock;
 445
 446         struct phylink *phylink;
 447         struct net_device *attached_dev;
 448
 449         u8 mdix;
 450         u8 mdix_ctrl;
 451
 452         void (*phy_link_change)(struct phy_device *, bool up, bool do_carrier);
 453         void (*adjust_link)(struct net_device *dev);
 454 };
 455 #define to_phy_device(d) container_of(to_mdio_device(d), \
 456                                       struct phy_device, mdio)
 457
 458 /* struct phy_driver: Driver structure for a particular PHY type
 459  *
 460  * driver_data: static driver data
 461  * phy_id: The result of reading the UID registers of this PHY
 462  *   type, and ANDing them with the phy_id_mask.  This driver
 463  *   only works for PHYs with IDs which match this field
 464  * name: The friendly name of this PHY type
 465  * phy_id_mask: Defines the important bits of the phy_id
 466  * features: A mandatory list of features (speed, duplex, etc)
 467  *   supported by this PHY
 468  * flags: A bitfield defining certain other features this PHY
 469  *   supports (like interrupts)
 470  *
 471  * All functions are optional. If config_aneg or read_status
 472  * are not implemented, the phy core uses the genphy versions.
 473  * Note that none of these functions should be called from
 474  * interrupt time. The goal is for the bus read/write functions
 475  * to be able to block when the bus transaction is happening,
 476  * and be freed up by an interrupt (The MPC85xx has this ability,
 477  * though it is not currently supported in the driver).
 478  */
 479 struct phy_driver {
 480         struct mdio_driver_common mdiodrv;
 481         u32 phy_id;
 482         char *name;
 483         u32 phy_id_mask;
 484         const unsigned long * const features;
 485         u32 flags;
 486         const void *driver_data;
 487
 488         /*
 489          * Called to issue a PHY software reset
 490          */
 491         int (*soft_reset)(struct phy_device *phydev);
 492
 493         /*
 494          * Called to initialize the PHY,
 495          * including after a reset
 496          */
 497         int (*config_init)(struct phy_device *phydev);
 498
 499         /*
 500          * Called during discovery.  Used to set
 501          * up device-specific structures, if any
 502          */
 503         int (*probe)(struct phy_device *phydev);
 504
 505         /*
 506          * Probe the hardware to determine what abilities it has.
 507          * Should only set phydev->supported.
 508          */
 509         int (*get_features)(struct phy_device *phydev);
 510
 511         /* PHY Power Management */
 512         int (*suspend)(struct phy_device *phydev);
 513         int (*resume)(struct phy_device *phydev);
 514
 515         /*
 516          * Configures the advertisement and resets
 517          * autonegotiation if phydev->autoneg is on,
 518          * forces the speed to the current settings in phydev
 519          * if phydev->autoneg is off
 520          */
 521         int (*config_aneg)(struct phy_device *phydev);
 522
 523         /* Determines the auto negotiation result */
 524         int (*aneg_done)(struct phy_device *phydev);
 525
 526         /* Determines the negotiated speed and duplex */
 527         int (*read_status)(struct phy_device *phydev);
 528
 529         /* Clears any pending interrupts */
 530         int (*ack_interrupt)(struct phy_device *phydev);
 531
 532         /* Enables or disables interrupts */
 533         int (*config_intr)(struct phy_device *phydev);
 534
 535         /*
 536          * Checks if the PHY generated an interrupt.
 537          * For multi-PHY devices with shared PHY interrupt pin
 538          */
 539         int (*did_interrupt)(struct phy_device *phydev);
 540
 541         /* Clears up any memory if needed */
 542         void (*remove)(struct phy_device *phydev);
 543
 544         /* Returns true if this is a suitable driver for the given
 545          * phydev.  If NULL, matching is based on phy_id and
 546          * phy_id_mask.
 547          */
 548         int (*match_phy_device)(struct phy_device *phydev);
 549
 550         /* Handles ethtool queries for hardware time stamping. */
 551         int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
 552
 553         /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
 554         int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
 555
 556         /*
 557          * Requests a Rx timestamp for 'skb'. If the skb is accepted,
 558          * the phy driver promises to deliver it using netif_rx() as
 559          * soon as a timestamp becomes available. One of the
 560          * PTP_CLASS_ values is passed in 'type'. The function must
 561          * return true if the skb is accepted for delivery.
 562          */
 563         bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 564
 565         /*
 566          * Requests a Tx timestamp for 'skb'. The phy driver promises
 567          * to deliver it using skb_complete_tx_timestamp() as soon as a
 568          * timestamp becomes available. One of the PTP_CLASS_ values
 569          * is passed in 'type'.
 570          */
 571         void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 572
 573         /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
 574          * enable Wake on LAN, so set_wol is provided to be called in the
 575          * ethernet driver's set_wol function. */
 576         int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 577
 578         /* See set_wol, but for checking whether Wake on LAN is enabled. */
 579         void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 580
 581         /*
 582          * Called to inform a PHY device driver when the core is about to
 583          * change the link state. This callback is supposed to be used as
 584          * fixup hook for drivers that need to take action when the link
 585          * state changes. Drivers are by no means allowed to mess with the
 586          * PHY device structure in their implementations.
 587          */
 588         void (*link_change_notify)(struct phy_device *dev);
 589
 590         /*
 591          * Phy specific driver override for reading a MMD register.
 592          * This function is optional for PHY specific drivers.  When
 593          * not provided, the default MMD read function will be used
 594          * by phy_read_mmd(), which will use either a direct read for
 595          * Clause 45 PHYs or an indirect read for Clause 22 PHYs.
 596          *  devnum is the MMD device number within the PHY device,
 597          *  regnum is the register within the selected MMD device.
 598          */
 599         int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
 600
 601         /*
 602          * Phy specific driver override for writing a MMD register.
 603          * This function is optional for PHY specific drivers.  When
 604          * not provided, the default MMD write function will be used
 605          * by phy_write_mmd(), which will use either a direct write for
 606          * Clause 45 PHYs, or an indirect write for Clause 22 PHYs.
 607          *  devnum is the MMD device number within the PHY device,
 608          *  regnum is the register within the selected MMD device.
 609          *  val is the value to be written.
 610          */
 611         int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
 612                          u16 val);
 613
 614         int (*read_page)(struct phy_device *dev);
 615         int (*write_page)(struct phy_device *dev, int page);
 616
 617         /* Get the size and type of the eeprom contained within a plug-in
 618          * module */
 619         int (*module_info)(struct phy_device *dev,
 620                            struct ethtool_modinfo *modinfo);
 621
 622         /* Get the eeprom information from the plug-in module */
 623         int (*module_eeprom)(struct phy_device *dev,
 624                              struct ethtool_eeprom *ee, u8 *data);
 625
 626         /* Get statistics from the phy using ethtool */
 627         int (*get_sset_count)(struct phy_device *dev);
 628         void (*get_strings)(struct phy_device *dev, u8 *data);
 629         void (*get_stats)(struct phy_device *dev,
 630                           struct ethtool_stats *stats, u64 *data);
 631
 632         /* Get and Set PHY tunables */
 633         int (*get_tunable)(struct phy_device *dev,
 634                            struct ethtool_tunable *tuna, void *data);
 635         int (*set_tunable)(struct phy_device *dev,
 636                             struct ethtool_tunable *tuna,
 637                             const void *data);
 638         int (*set_loopback)(struct phy_device *dev, bool enable);
 639 };
 640 #define to_phy_driver(d) container_of(to_mdio_common_driver(d),         \
 641                                       struct phy_driver, mdiodrv)
 642
 643 #define PHY_ANY_ID "MATCH ANY PHY"
 644 #define PHY_ANY_UID 0xffffffff
 645
 646 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
 647 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
 648 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
 649
 650 /* A Structure for boards to register fixups with the PHY Lib */
 651 struct phy_fixup {
 652         struct list_head list;
 653         char bus_id[MII_BUS_ID_SIZE + 3];
 654         u32 phy_uid;
 655         u32 phy_uid_mask;
 656         int (*run)(struct phy_device *phydev);
 657 };
 658
 659 const char *phy_speed_to_str(int speed);
 660 const char *phy_duplex_to_str(unsigned int duplex);
 661
 662 /* A structure for mapping a particular speed and duplex
 663  * combination to a particular SUPPORTED and ADVERTISED value
 664  */
 665 struct phy_setting {
 666         u32 speed;
 667         u8 duplex;
 668         u8 bit;
 669 };
 670
 671 const struct phy_setting *
 672 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
 673                    bool exact);
 674 size_t phy_speeds(unsigned int *speeds, size_t size,
 675                   unsigned long *mask);
 676
 677 static inline bool __phy_is_started(struct phy_device *phydev)
 678 {
 679         WARN_ON(!mutex_is_locked(&phydev->lock));
 680
 681         return phydev->state >= PHY_UP;
 682 }
 683
 684 /**
 685  * phy_is_started - Convenience function to check whether PHY is started
 686  * @phydev: The phy_device struct
 687  */
 688 static inline bool phy_is_started(struct phy_device *phydev)
 689 {
 690         bool started;
 691
 692         mutex_lock(&phydev->lock);
 693         started = __phy_is_started(phydev);
 694         mutex_unlock(&phydev->lock);
 695
 696         return started;
 697 }
 698
 699 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
 700
 701 /**
 702  * phy_read - Convenience function for reading a given PHY register
 703  * @phydev: the phy_device struct
 704  * @regnum: register number to read
 705  *
 706  * NOTE: MUST NOT be called from interrupt context,
 707  * because the bus read/write functions may wait for an interrupt
 708  * to conclude the operation.
 709  */
 710 static inline int phy_read(struct phy_device *phydev, u32 regnum)
 711 {
 712         return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
 713 }
 714
 715 /**
 716  * __phy_read - convenience function for reading a given PHY register
 717  * @phydev: the phy_device struct
 718  * @regnum: register number to read
 719  *
 720  * The caller must have taken the MDIO bus lock.
 721  */
 722 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
 723 {
 724         return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
 725 }
 726
 727 /**
 728  * phy_write - Convenience function for writing a given PHY register
 729  * @phydev: the phy_device struct
 730  * @regnum: register number to write
 731  * @val: value to write to @regnum
 732  *
 733  * NOTE: MUST NOT be called from interrupt context,
 734  * because the bus read/write functions may wait for an interrupt
 735  * to conclude the operation.
 736  */
 737 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 738 {
 739         return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
 740 }
 741
 742 /**
 743  * __phy_write - Convenience function for writing a given PHY register
 744  * @phydev: the phy_device struct
 745  * @regnum: register number to write
 746  * @val: value to write to @regnum
 747  *
 748  * The caller must have taken the MDIO bus lock.
 749  */
 750 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 751 {
 752         return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
 753                                val);
 754 }
 755
 756 /**
 757  * phy_read_mmd - Convenience function for reading a register
 758  * from an MMD on a given PHY.
 759  * @phydev: The phy_device struct
 760  * @devad: The MMD to read from
 761  * @regnum: The register on the MMD to read
 762  *
 763  * Same rules as for phy_read();
 764  */
 765 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
 766
 767 /**
 768  * __phy_read_mmd - Convenience function for reading a register
 769  * from an MMD on a given PHY.
 770  * @phydev: The phy_device struct
 771  * @devad: The MMD to read from
 772  * @regnum: The register on the MMD to read
 773  *
 774  * Same rules as for __phy_read();
 775  */
 776 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
 777
 778 /**
 779  * phy_write_mmd - Convenience function for writing a register
 780  * on an MMD on a given PHY.
 781  * @phydev: The phy_device struct
 782  * @devad: The MMD to write to
 783  * @regnum: The register on the MMD to read
 784  * @val: value to write to @regnum
 785  *
 786  * Same rules as for phy_write();
 787  */
 788 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
 789
 790 /**
 791  * __phy_write_mmd - Convenience function for writing a register
 792  * on an MMD on a given PHY.
 793  * @phydev: The phy_device struct
 794  * @devad: The MMD to write to
 795  * @regnum: The register on the MMD to read
 796  * @val: value to write to @regnum
 797  *
 798  * Same rules as for __phy_write();
 799  */
 800 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
 801
 802 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
 803                          u16 set);
 804 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
 805                        u16 set);
 806 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
 807 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
 808
 809 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
 810                              u16 mask, u16 set);
 811 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
 812                            u16 mask, u16 set);
 813 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
 814                      u16 mask, u16 set);
 815 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
 816                    u16 mask, u16 set);
 817
 818 /**
 819  * __phy_set_bits - Convenience function for setting bits in a PHY register
 820  * @phydev: the phy_device struct
 821  * @regnum: register number to write
 822  * @val: bits to set
 823  *
 824  * The caller must have taken the MDIO bus lock.
 825  */
 826 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
 827 {
 828         return __phy_modify(phydev, regnum, 0, val);
 829 }
 830
 831 /**
 832  * __phy_clear_bits - Convenience function for clearing bits in a PHY register
 833  * @phydev: the phy_device struct
 834  * @regnum: register number to write
 835  * @val: bits to clear
 836  *
 837  * The caller must have taken the MDIO bus lock.
 838  */
 839 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
 840                                    u16 val)
 841 {
 842         return __phy_modify(phydev, regnum, val, 0);
 843 }
 844
 845 /**
 846  * phy_set_bits - Convenience function for setting bits in a PHY register
 847  * @phydev: the phy_device struct
 848  * @regnum: register number to write
 849  * @val: bits to set
 850  */
 851 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
 852 {
 853         return phy_modify(phydev, regnum, 0, val);
 854 }
 855
 856 /**
 857  * phy_clear_bits - Convenience function for clearing bits in a PHY register
 858  * @phydev: the phy_device struct
 859  * @regnum: register number to write
 860  * @val: bits to clear
 861  */
 862 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
 863 {
 864         return phy_modify(phydev, regnum, val, 0);
 865 }
 866
 867 /**
 868  * __phy_set_bits_mmd - Convenience function for setting bits in a register
 869  * on MMD
 870  * @phydev: the phy_device struct
 871  * @devad: the MMD containing register to modify
 872  * @regnum: register number to modify
 873  * @val: bits to set
 874  *
 875  * The caller must have taken the MDIO bus lock.
 876  */
 877 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
 878                 u32 regnum, u16 val)
 879 {
 880         return __phy_modify_mmd(phydev, devad, regnum, 0, val);
 881 }
 882
 883 /**
 884  * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
 885  * on MMD
 886  * @phydev: the phy_device struct
 887  * @devad: the MMD containing register to modify
 888  * @regnum: register number to modify
 889  * @val: bits to clear
 890  *
 891  * The caller must have taken the MDIO bus lock.
 892  */
 893 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
 894                 u32 regnum, u16 val)
 895 {
 896         return __phy_modify_mmd(phydev, devad, regnum, val, 0);
 897 }
 898
 899 /**
 900  * phy_set_bits_mmd - Convenience function for setting bits in a register
 901  * on MMD
 902  * @phydev: the phy_device struct
 903  * @devad: the MMD containing register to modify
 904  * @regnum: register number to modify
 905  * @val: bits to set
 906  */
 907 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
 908                 u32 regnum, u16 val)
 909 {
 910         return phy_modify_mmd(phydev, devad, regnum, 0, val);
 911 }
 912
 913 /**
 914  * phy_clear_bits_mmd - Convenience function for clearing bits in a register
 915  * on MMD
 916  * @phydev: the phy_device struct
 917  * @devad: the MMD containing register to modify
 918  * @regnum: register number to modify
 919  * @val: bits to clear
 920  */
 921 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
 922                 u32 regnum, u16 val)
 923 {
 924         return phy_modify_mmd(phydev, devad, regnum, val, 0);
 925 }
 926
 927 /**
 928  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
 929  * @phydev: the phy_device struct
 930  *
 931  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
 932  * PHY_IGNORE_INTERRUPT
 933  */
 934 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
 935 {
 936         return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
 937 }
 938
 939 /**
 940  * phy_polling_mode - Convenience function for testing whether polling is
 941  * used to detect PHY status changes
 942  * @phydev: the phy_device struct
 943  */
 944 static inline bool phy_polling_mode(struct phy_device *phydev)
 945 {
 946         return phydev->irq == PHY_POLL;
 947 }
 948
 949 /**
 950  * phy_is_internal - Convenience function for testing if a PHY is internal
 951  * @phydev: the phy_device struct
 952  */
 953 static inline bool phy_is_internal(struct phy_device *phydev)
 954 {
 955         return phydev->is_internal;
 956 }
 957
 958 /**
 959  * phy_interface_mode_is_rgmii - Convenience function for testing if a
 960  * PHY interface mode is RGMII (all variants)
 961  * @mode: the phy_interface_t enum
 962  */
 963 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
 964 {
 965         return mode >= PHY_INTERFACE_MODE_RGMII &&
 966                 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
 967 };
 968
 969 /**
 970  * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z
 971  *   negotiation
 972  * @mode: one of &enum phy_interface_t
 973  *
 974  * Returns true if the phy interface mode uses the 16-bit negotiation
 975  * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
 976  */
 977 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
 978 {
 979         return mode == PHY_INTERFACE_MODE_1000BASEX ||
 980                mode == PHY_INTERFACE_MODE_2500BASEX;
 981 }
 982
 983 /**
 984  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
 985  * is RGMII (all variants)
 986  * @phydev: the phy_device struct
 987  */
 988 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
 989 {
 990         return phy_interface_mode_is_rgmii(phydev->interface);
 991 };
 992
 993 /*
 994  * phy_is_pseudo_fixed_link - Convenience function for testing if this
 995  * PHY is the CPU port facing side of an Ethernet switch, or similar.
 996  * @phydev: the phy_device struct
 997  */
 998 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
 999 {
1000         return phydev->is_pseudo_fixed_link;
1001 }
1002
1003 int phy_save_page(struct phy_device *phydev);
1004 int phy_select_page(struct phy_device *phydev, int page);
1005 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
1006 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
1007 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
1008 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
1009                      u16 mask, u16 set);
1010
1011 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
1012                                      bool is_c45,
1013                                      struct phy_c45_device_ids *c45_ids);
1014 #if IS_ENABLED(CONFIG_PHYLIB)
1015 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
1016 int phy_device_register(struct phy_device *phy);
1017 void phy_device_free(struct phy_device *phydev);
1018 #else
1019 static inline
1020 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1021 {
1022         return NULL;
1023 }
1024
1025 static inline int phy_device_register(struct phy_device *phy)
1026 {
1027         return 0;
1028 }
1029
1030 static inline void phy_device_free(struct phy_device *phydev) { }
1031 #endif /* CONFIG_PHYLIB */
1032 void phy_device_remove(struct phy_device *phydev);
1033 int phy_init_hw(struct phy_device *phydev);
1034 int phy_suspend(struct phy_device *phydev);
1035 int phy_resume(struct phy_device *phydev);
1036 int __phy_resume(struct phy_device *phydev);
1037 int phy_loopback(struct phy_device *phydev, bool enable);
1038 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1039                               phy_interface_t interface);
1040 struct phy_device *phy_find_first(struct mii_bus *bus);
1041 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1042                       u32 flags, phy_interface_t interface);
1043 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1044                        void (*handler)(struct net_device *),
1045                        phy_interface_t interface);
1046 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1047                                void (*handler)(struct net_device *),
1048                                phy_interface_t interface);
1049 void phy_disconnect(struct phy_device *phydev);
1050 void phy_detach(struct phy_device *phydev);
1051 void phy_start(struct phy_device *phydev);
1052 void phy_stop(struct phy_device *phydev);
1053 int phy_start_aneg(struct phy_device *phydev);
1054 int phy_aneg_done(struct phy_device *phydev);
1055 int phy_speed_down(struct phy_device *phydev, bool sync);
1056 int phy_speed_up(struct phy_device *phydev);
1057
1058 int phy_restart_aneg(struct phy_device *phydev);
1059 int phy_reset_after_clk_enable(struct phy_device *phydev);
1060
1061 static inline void phy_device_reset(struct phy_device *phydev, int value)
1062 {
1063         mdio_device_reset(&phydev->mdio, value);
1064 }
1065
1066 #define phydev_err(_phydev, format, args...)    \
1067         dev_err(&_phydev->mdio.dev, format, ##args)
1068
1069 #define phydev_info(_phydev, format, args...)   \
1070         dev_info(&_phydev->mdio.dev, format, ##args)
1071
1072 #define phydev_warn(_phydev, format, args...)   \
1073         dev_warn(&_phydev->mdio.dev, format, ##args)
1074
1075 #define phydev_dbg(_phydev, format, args...)    \
1076         dev_dbg(&_phydev->mdio.dev, format, ##args)
1077
1078 static inline const char *phydev_name(const struct phy_device *phydev)
1079 {
1080         return dev_name(&phydev->mdio.dev);
1081 }
1082
1083 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1084         __printf(2, 3);
1085 void phy_attached_info(struct phy_device *phydev);
1086
1087 /* Clause 22 PHY */
1088 int genphy_config_init(struct phy_device *phydev);
1089 int genphy_setup_forced(struct phy_device *phydev);
1090 int genphy_restart_aneg(struct phy_device *phydev);
1091 int genphy_config_aneg(struct phy_device *phydev);
1092 int genphy_aneg_done(struct phy_device *phydev);
1093 int genphy_update_link(struct phy_device *phydev);
1094 int genphy_read_status(struct phy_device *phydev);
1095 int genphy_suspend(struct phy_device *phydev);
1096 int genphy_resume(struct phy_device *phydev);
1097 int genphy_loopback(struct phy_device *phydev, bool enable);
1098 int genphy_soft_reset(struct phy_device *phydev);
1099 static inline int genphy_no_soft_reset(struct phy_device *phydev)
1100 {
1101         return 0;
1102 }
1103 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1104                                 u16 regnum);
1105 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1106                                  u16 regnum, u16 val);
1107
1108 /* Clause 45 PHY */
1109 int genphy_c45_restart_aneg(struct phy_device *phydev);
1110 int genphy_c45_aneg_done(struct phy_device *phydev);
1111 int genphy_c45_read_link(struct phy_device *phydev);
1112 int genphy_c45_read_lpa(struct phy_device *phydev);
1113 int genphy_c45_read_pma(struct phy_device *phydev);
1114 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1115 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1116 int genphy_c45_read_mdix(struct phy_device *phydev);
1117
1118 /* The gen10g_* functions are the old Clause 45 stub */
1119 int gen10g_config_aneg(struct phy_device *phydev);
1120 int gen10g_read_status(struct phy_device *phydev);
1121 int gen10g_no_soft_reset(struct phy_device *phydev);
1122 int gen10g_config_init(struct phy_device *phydev);
1123 int gen10g_suspend(struct phy_device *phydev);
1124 int gen10g_resume(struct phy_device *phydev);
1125
1126 static inline int phy_read_status(struct phy_device *phydev)
1127 {
1128         if (!phydev->drv)
1129                 return -EIO;
1130
1131         if (phydev->drv->read_status)
1132                 return phydev->drv->read_status(phydev);
1133         else
1134                 return genphy_read_status(phydev);
1135 }
1136
1137 void phy_driver_unregister(struct phy_driver *drv);
1138 void phy_drivers_unregister(struct phy_driver *drv, int n);
1139 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1140 int phy_drivers_register(struct phy_driver *new_driver, int n,
1141                          struct module *owner);
1142 void phy_state_machine(struct work_struct *work);
1143 void phy_mac_interrupt(struct phy_device *phydev);
1144 void phy_start_machine(struct phy_device *phydev);
1145 void phy_stop_machine(struct phy_device *phydev);
1146 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
1147 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1148                                struct ethtool_link_ksettings *cmd);
1149 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1150                               const struct ethtool_link_ksettings *cmd);
1151 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1152 void phy_request_interrupt(struct phy_device *phydev);
1153 void phy_print_status(struct phy_device *phydev);
1154 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1155 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1156 void phy_support_sym_pause(struct phy_device *phydev);
1157 void phy_support_asym_pause(struct phy_device *phydev);
1158 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1159                        bool autoneg);
1160 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1161 bool phy_validate_pause(struct phy_device *phydev,
1162                         struct ethtool_pauseparam *pp);
1163
1164 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1165                        int (*run)(struct phy_device *));
1166 int phy_register_fixup_for_id(const char *bus_id,
1167                               int (*run)(struct phy_device *));
1168 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1169                                int (*run)(struct phy_device *));
1170
1171 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1172 int phy_unregister_fixup_for_id(const char *bus_id);
1173 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1174
1175 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1176 int phy_get_eee_err(struct phy_device *phydev);
1177 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1178 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1179 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1180 void phy_ethtool_get_wol(struct phy_device *phydev,
1181                          struct ethtool_wolinfo *wol);
1182 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1183                                    struct ethtool_link_ksettings *cmd);
1184 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1185                                    const struct ethtool_link_ksettings *cmd);
1186 int phy_ethtool_nway_reset(struct net_device *ndev);
1187
1188 #if IS_ENABLED(CONFIG_PHYLIB)
1189 int __init mdio_bus_init(void);
1190 void mdio_bus_exit(void);
1191 #endif
1192
1193 /* Inline function for use within net/core/ethtool.c (built-in) */
1194 static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
1195 {
1196         if (!phydev->drv)
1197                 return -EIO;
1198
1199         mutex_lock(&phydev->lock);
1200         phydev->drv->get_strings(phydev, data);
1201         mutex_unlock(&phydev->lock);
1202
1203         return 0;
1204 }
1205
1206 static inline int phy_ethtool_get_sset_count(struct phy_device *phydev)
1207 {
1208         int ret;
1209
1210         if (!phydev->drv)
1211                 return -EIO;
1212
1213         if (phydev->drv->get_sset_count &&
1214             phydev->drv->get_strings &&
1215             phydev->drv->get_stats) {
1216                 mutex_lock(&phydev->lock);
1217                 ret = phydev->drv->get_sset_count(phydev);
1218                 mutex_unlock(&phydev->lock);
1219
1220                 return ret;
1221         }
1222
1223         return -EOPNOTSUPP;
1224 }
1225
1226 static inline int phy_ethtool_get_stats(struct phy_device *phydev,
1227                                         struct ethtool_stats *stats, u64 *data)
1228 {
1229         if (!phydev->drv)
1230                 return -EIO;
1231
1232         mutex_lock(&phydev->lock);
1233         phydev->drv->get_stats(phydev, stats, data);
1234         mutex_unlock(&phydev->lock);
1235
1236         return 0;
1237 }
1238
1239 extern struct bus_type mdio_bus_type;
1240
1241 struct mdio_board_info {
1242         const char      *bus_id;
1243         char            modalias[MDIO_NAME_SIZE];
1244         int             mdio_addr;
1245         const void      *platform_data;
1246 };
1247
1248 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1249 int mdiobus_register_board_info(const struct mdio_board_info *info,
1250                                 unsigned int n);
1251 #else
1252 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1253                                               unsigned int n)
1254 {
1255         return 0;
1256 }
1257 #endif
1258
1259
1260 /**
1261  * module_phy_driver() - Helper macro for registering PHY drivers
1262  * @__phy_drivers: array of PHY drivers to register
1263  *
1264  * Helper macro for PHY drivers which do not do anything special in module
1265  * init/exit. Each module may only use this macro once, and calling it
1266  * replaces module_init() and module_exit().
1267  */
1268 #define phy_module_driver(__phy_drivers, __count)                       \
1269 static int __init phy_module_init(void)                                 \
1270 {                                                                       \
1271         return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1272 }                                                                       \
1273 module_init(phy_module_init);                                           \
1274 static void __exit phy_module_exit(void)                                \
1275 {                                                                       \
1276         phy_drivers_unregister(__phy_drivers, __count);                 \
1277 }                                                                       \
1278 module_exit(phy_module_exit)
1279
1280 #define module_phy_driver(__phy_drivers)                                \
1281         phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1282
1283 bool phy_driver_is_genphy(struct phy_device *phydev);
1284 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
1285
1286 #endif /* __PHY_H */