include/linux/phy.h

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