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