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/spinlock.h>
  20 #include <linux/ethtool.h>
  21 #include <linux/mii.h>
  22 #include <linux/timer.h>
  23 #include <linux/workqueue.h>
  24 #include <linux/mod_devicetable.h>
  25
  26 #include <linux/atomic.h>
  27
  28 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
  29                                  SUPPORTED_TP | \
  30                                  SUPPORTED_MII)
  31
  32 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
  33                                  SUPPORTED_10baseT_Full)
  34
  35 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
  36                                  SUPPORTED_100baseT_Full)
  37
  38 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
  39                                  SUPPORTED_1000baseT_Full)
  40
  41 #define PHY_BASIC_FEATURES      (PHY_10BT_FEATURES | \
  42                                  PHY_100BT_FEATURES | \
  43                                  PHY_DEFAULT_FEATURES)
  44
  45 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
  46                                  PHY_1000BT_FEATURES)
  47
  48
  49 /*
  50  * Set phydev->irq to PHY_POLL if interrupts are not supported,
  51  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
  52  * the attached driver handles the interrupt
  53  */
  54 #define PHY_POLL                -1
  55 #define PHY_IGNORE_INTERRUPT    -2
  56
  57 #define PHY_HAS_INTERRUPT       0x00000001
  58 #define PHY_HAS_MAGICANEG       0x00000002
  59 #define PHY_IS_INTERNAL         0x00000004
  60
  61 /* Interface Mode definitions */
  62 typedef enum {
  63         PHY_INTERFACE_MODE_NA,
  64         PHY_INTERFACE_MODE_MII,
  65         PHY_INTERFACE_MODE_GMII,
  66         PHY_INTERFACE_MODE_SGMII,
  67         PHY_INTERFACE_MODE_TBI,
  68         PHY_INTERFACE_MODE_REVMII,
  69         PHY_INTERFACE_MODE_RMII,
  70         PHY_INTERFACE_MODE_RGMII,
  71         PHY_INTERFACE_MODE_RGMII_ID,
  72         PHY_INTERFACE_MODE_RGMII_RXID,
  73         PHY_INTERFACE_MODE_RGMII_TXID,
  74         PHY_INTERFACE_MODE_RTBI,
  75         PHY_INTERFACE_MODE_SMII,
  76         PHY_INTERFACE_MODE_XGMII,
  77         PHY_INTERFACE_MODE_MOCA,
  78         PHY_INTERFACE_MODE_QSGMII,
  79         PHY_INTERFACE_MODE_MAX,
  80 } phy_interface_t;
  81
  82 /**
  83  * It maps 'enum phy_interface_t' found in include/linux/phy.h
  84  * into the device tree binding of 'phy-mode', so that Ethernet
  85  * device driver can get phy interface from device tree.
  86  */
  87 static inline const char *phy_modes(phy_interface_t interface)
  88 {
  89         switch (interface) {
  90         case PHY_INTERFACE_MODE_NA:
  91                 return "";
  92         case PHY_INTERFACE_MODE_MII:
  93                 return "mii";
  94         case PHY_INTERFACE_MODE_GMII:
  95                 return "gmii";
  96         case PHY_INTERFACE_MODE_SGMII:
  97                 return "sgmii";
  98         case PHY_INTERFACE_MODE_TBI:
  99                 return "tbi";
 100         case PHY_INTERFACE_MODE_REVMII:
 101                 return "rev-mii";
 102         case PHY_INTERFACE_MODE_RMII:
 103                 return "rmii";
 104         case PHY_INTERFACE_MODE_RGMII:
 105                 return "rgmii";
 106         case PHY_INTERFACE_MODE_RGMII_ID:
 107                 return "rgmii-id";
 108         case PHY_INTERFACE_MODE_RGMII_RXID:
 109                 return "rgmii-rxid";
 110         case PHY_INTERFACE_MODE_RGMII_TXID:
 111                 return "rgmii-txid";
 112         case PHY_INTERFACE_MODE_RTBI:
 113                 return "rtbi";
 114         case PHY_INTERFACE_MODE_SMII:
 115                 return "smii";
 116         case PHY_INTERFACE_MODE_XGMII:
 117                 return "xgmii";
 118         case PHY_INTERFACE_MODE_MOCA:
 119                 return "moca";
 120         case PHY_INTERFACE_MODE_QSGMII:
 121                 return "qsgmii";
 122         default:
 123                 return "unknown";
 124         }
 125 }
 126
 127
 128 #define PHY_INIT_TIMEOUT        100000
 129 #define PHY_STATE_TIME          1
 130 #define PHY_FORCE_TIMEOUT       10
 131 #define PHY_AN_TIMEOUT          10
 132
 133 #define PHY_MAX_ADDR    32
 134
 135 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
 136 #define PHY_ID_FMT "%s:%02x"
 137
 138 /*
 139  * Need to be a little smaller than phydev->dev.bus_id to leave room
 140  * for the ":%02x"
 141  */
 142 #define MII_BUS_ID_SIZE (20 - 3)
 143
 144 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
 145    IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
 146 #define MII_ADDR_C45 (1<<30)
 147
 148 struct device;
 149 struct sk_buff;
 150
 151 /*
 152  * The Bus class for PHYs.  Devices which provide access to
 153  * PHYs should register using this structure
 154  */
 155 struct mii_bus {
 156         const char *name;
 157         char id[MII_BUS_ID_SIZE];
 158         void *priv;
 159         int (*read)(struct mii_bus *bus, int phy_id, int regnum);
 160         int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
 161         int (*reset)(struct mii_bus *bus);
 162
 163         /*
 164          * A lock to ensure that only one thing can read/write
 165          * the MDIO bus at a time
 166          */
 167         struct mutex mdio_lock;
 168
 169         struct device *parent;
 170         enum {
 171                 MDIOBUS_ALLOCATED = 1,
 172                 MDIOBUS_REGISTERED,
 173                 MDIOBUS_UNREGISTERED,
 174                 MDIOBUS_RELEASED,
 175         } state;
 176         struct device dev;
 177
 178         /* list of all PHYs on bus */
 179         struct phy_device *phy_map[PHY_MAX_ADDR];
 180
 181         /* PHY addresses to be ignored when probing */
 182         u32 phy_mask;
 183
 184         /*
 185          * Pointer to an array of interrupts, each PHY's
 186          * interrupt at the index matching its address
 187          */
 188         int *irq;
 189 };
 190 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
 191
 192 struct mii_bus *mdiobus_alloc_size(size_t);
 193 static inline struct mii_bus *mdiobus_alloc(void)
 194 {
 195         return mdiobus_alloc_size(0);
 196 }
 197
 198 int mdiobus_register(struct mii_bus *bus);
 199 void mdiobus_unregister(struct mii_bus *bus);
 200 void mdiobus_free(struct mii_bus *bus);
 201 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
 202 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
 203 {
 204         return devm_mdiobus_alloc_size(dev, 0);
 205 }
 206
 207 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
 208 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
 209 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
 210 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
 211
 212
 213 #define PHY_INTERRUPT_DISABLED  0x0
 214 #define PHY_INTERRUPT_ENABLED   0x80000000
 215
 216 /* PHY state machine states:
 217  *
 218  * DOWN: PHY device and driver are not ready for anything.  probe
 219  * should be called if and only if the PHY is in this state,
 220  * given that the PHY device exists.
 221  * - PHY driver probe function will, depending on the PHY, set
 222  * the state to STARTING or READY
 223  *
 224  * STARTING:  PHY device is coming up, and the ethernet driver is
 225  * not ready.  PHY drivers may set this in the probe function.
 226  * If they do, they are responsible for making sure the state is
 227  * eventually set to indicate whether the PHY is UP or READY,
 228  * depending on the state when the PHY is done starting up.
 229  * - PHY driver will set the state to READY
 230  * - start will set the state to PENDING
 231  *
 232  * READY: PHY is ready to send and receive packets, but the
 233  * controller is not.  By default, PHYs which do not implement
 234  * probe will be set to this state by phy_probe().  If the PHY
 235  * driver knows the PHY is ready, and the PHY state is STARTING,
 236  * then it sets this STATE.
 237  * - start will set the state to UP
 238  *
 239  * PENDING: PHY device is coming up, but the ethernet driver is
 240  * ready.  phy_start will set this state if the PHY state is
 241  * STARTING.
 242  * - PHY driver will set the state to UP when the PHY is ready
 243  *
 244  * UP: The PHY and attached device are ready to do work.
 245  * Interrupts should be started here.
 246  * - timer moves to AN
 247  *
 248  * AN: The PHY is currently negotiating the link state.  Link is
 249  * therefore down for now.  phy_timer will set this state when it
 250  * detects the state is UP.  config_aneg will set this state
 251  * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
 252  * - If autonegotiation finishes, but there's no link, it sets
 253  *   the state to NOLINK.
 254  * - If aneg finishes with link, it sets the state to RUNNING,
 255  *   and calls adjust_link
 256  * - If autonegotiation did not finish after an arbitrary amount
 257  *   of time, autonegotiation should be tried again if the PHY
 258  *   supports "magic" autonegotiation (back to AN)
 259  * - If it didn't finish, and no magic_aneg, move to FORCING.
 260  *
 261  * NOLINK: PHY is up, but not currently plugged in.
 262  * - If the timer notes that the link comes back, we move to RUNNING
 263  * - config_aneg moves to AN
 264  * - phy_stop moves to HALTED
 265  *
 266  * FORCING: PHY is being configured with forced settings
 267  * - if link is up, move to RUNNING
 268  * - If link is down, we drop to the next highest setting, and
 269  *   retry (FORCING) after a timeout
 270  * - phy_stop moves to HALTED
 271  *
 272  * RUNNING: PHY is currently up, running, and possibly sending
 273  * and/or receiving packets
 274  * - timer will set CHANGELINK if we're polling (this ensures the
 275  *   link state is polled every other cycle of this state machine,
 276  *   which makes it every other second)
 277  * - irq will set CHANGELINK
 278  * - config_aneg will set AN
 279  * - phy_stop moves to HALTED
 280  *
 281  * CHANGELINK: PHY experienced a change in link state
 282  * - timer moves to RUNNING if link
 283  * - timer moves to NOLINK if the link is down
 284  * - phy_stop moves to HALTED
 285  *
 286  * HALTED: PHY is up, but no polling or interrupts are done. Or
 287  * PHY is in an error state.
 288  *
 289  * - phy_start moves to RESUMING
 290  *
 291  * RESUMING: PHY was halted, but now wants to run again.
 292  * - If we are forcing, or aneg is done, timer moves to RUNNING
 293  * - If aneg is not done, timer moves to AN
 294  * - phy_stop moves to HALTED
 295  */
 296 enum phy_state {
 297         PHY_DOWN = 0,
 298         PHY_STARTING,
 299         PHY_READY,
 300         PHY_PENDING,
 301         PHY_UP,
 302         PHY_AN,
 303         PHY_RUNNING,
 304         PHY_NOLINK,
 305         PHY_FORCING,
 306         PHY_CHANGELINK,
 307         PHY_HALTED,
 308         PHY_RESUMING
 309 };
 310
 311 /**
 312  * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
 313  * @devices_in_package: Bit vector of devices present.
 314  * @device_ids: The device identifer for each present device.
 315  */
 316 struct phy_c45_device_ids {
 317         u32 devices_in_package;
 318         u32 device_ids[8];
 319 };
 320
 321 /* phy_device: An instance of a PHY
 322  *
 323  * drv: Pointer to the driver for this PHY instance
 324  * bus: Pointer to the bus this PHY is on
 325  * dev: driver model device structure for this PHY
 326  * phy_id: UID for this device found during discovery
 327  * c45_ids: 802.3-c45 Device Identifers if is_c45.
 328  * is_c45:  Set to true if this phy uses clause 45 addressing.
 329  * is_internal: Set to true if this phy is internal to a MAC.
 330  * has_fixups: Set to true if this phy has fixups/quirks.
 331  * state: state of the PHY for management purposes
 332  * dev_flags: Device-specific flags used by the PHY driver.
 333  * addr: Bus address of PHY
 334  * link_timeout: The number of timer firings to wait before the
 335  * giving up on the current attempt at acquiring a link
 336  * irq: IRQ number of the PHY's interrupt (-1 if none)
 337  * phy_timer: The timer for handling the state machine
 338  * phy_queue: A work_queue for the interrupt
 339  * attached_dev: The attached enet driver's device instance ptr
 340  * adjust_link: Callback for the enet controller to respond to
 341  * changes in the link state.
 342  *
 343  * speed, duplex, pause, supported, advertising, lp_advertising,
 344  * and autoneg are used like in mii_if_info
 345  *
 346  * interrupts currently only supports enabled or disabled,
 347  * but could be changed in the future to support enabling
 348  * and disabling specific interrupts
 349  *
 350  * Contains some infrastructure for polling and interrupt
 351  * handling, as well as handling shifts in PHY hardware state
 352  */
 353 struct phy_device {
 354         /* Information about the PHY type */
 355         /* And management functions */
 356         struct phy_driver *drv;
 357
 358         struct mii_bus *bus;
 359
 360         struct device dev;
 361
 362         u32 phy_id;
 363
 364         struct phy_c45_device_ids c45_ids;
 365         bool is_c45;
 366         bool is_internal;
 367         bool has_fixups;
 368
 369         enum phy_state state;
 370
 371         u32 dev_flags;
 372
 373         phy_interface_t interface;
 374
 375         /* Bus address of the PHY (0-31) */
 376         int addr;
 377
 378         /*
 379          * forced speed & duplex (no autoneg)
 380          * partner speed & duplex & pause (autoneg)
 381          */
 382         int speed;
 383         int duplex;
 384         int pause;
 385         int asym_pause;
 386
 387         /* The most recently read link state */
 388         int link;
 389
 390         /* Enabled Interrupts */
 391         u32 interrupts;
 392
 393         /* Union of PHY and Attached devices' supported modes */
 394         /* See mii.h for more info */
 395         u32 supported;
 396         u32 advertising;
 397         u32 lp_advertising;
 398
 399         int autoneg;
 400
 401         int link_timeout;
 402
 403         /*
 404          * Interrupt number for this PHY
 405          * -1 means no interrupt
 406          */
 407         int irq;
 408
 409         /* private data pointer */
 410         /* For use by PHYs to maintain extra state */
 411         void *priv;
 412
 413         /* Interrupt and Polling infrastructure */
 414         struct work_struct phy_queue;
 415         struct delayed_work state_queue;
 416         atomic_t irq_disable;
 417
 418         struct mutex lock;
 419
 420         struct net_device *attached_dev;
 421
 422         void (*adjust_link)(struct net_device *dev);
 423 };
 424 #define to_phy_device(d) container_of(d, struct phy_device, dev)
 425
 426 /* struct phy_driver: Driver structure for a particular PHY type
 427  *
 428  * phy_id: The result of reading the UID registers of this PHY
 429  *   type, and ANDing them with the phy_id_mask.  This driver
 430  *   only works for PHYs with IDs which match this field
 431  * name: The friendly name of this PHY type
 432  * phy_id_mask: Defines the important bits of the phy_id
 433  * features: A list of features (speed, duplex, etc) supported
 434  *   by this PHY
 435  * flags: A bitfield defining certain other features this PHY
 436  *   supports (like interrupts)
 437  * driver_data: static driver data
 438  *
 439  * The drivers must implement config_aneg and read_status.  All
 440  * other functions are optional. Note that none of these
 441  * functions should be called from interrupt time.  The goal is
 442  * for the bus read/write functions to be able to block when the
 443  * bus transaction is happening, and be freed up by an interrupt
 444  * (The MPC85xx has this ability, though it is not currently
 445  * supported in the driver).
 446  */
 447 struct phy_driver {
 448         u32 phy_id;
 449         char *name;
 450         unsigned int phy_id_mask;
 451         u32 features;
 452         u32 flags;
 453         const void *driver_data;
 454
 455         /*
 456          * Called to issue a PHY software reset
 457          */
 458         int (*soft_reset)(struct phy_device *phydev);
 459
 460         /*
 461          * Called to initialize the PHY,
 462          * including after a reset
 463          */
 464         int (*config_init)(struct phy_device *phydev);
 465
 466         /*
 467          * Called during discovery.  Used to set
 468          * up device-specific structures, if any
 469          */
 470         int (*probe)(struct phy_device *phydev);
 471
 472         /* PHY Power Management */
 473         int (*suspend)(struct phy_device *phydev);
 474         int (*resume)(struct phy_device *phydev);
 475
 476         /*
 477          * Configures the advertisement and resets
 478          * autonegotiation if phydev->autoneg is on,
 479          * forces the speed to the current settings in phydev
 480          * if phydev->autoneg is off
 481          */
 482         int (*config_aneg)(struct phy_device *phydev);
 483
 484         /* Determines the auto negotiation result */
 485         int (*aneg_done)(struct phy_device *phydev);
 486
 487         /* Determines the negotiated speed and duplex */
 488         int (*read_status)(struct phy_device *phydev);
 489
 490         /* Clears any pending interrupts */
 491         int (*ack_interrupt)(struct phy_device *phydev);
 492
 493         /* Enables or disables interrupts */
 494         int (*config_intr)(struct phy_device *phydev);
 495
 496         /*
 497          * Checks if the PHY generated an interrupt.
 498          * For multi-PHY devices with shared PHY interrupt pin
 499          */
 500         int (*did_interrupt)(struct phy_device *phydev);
 501
 502         /* Clears up any memory if needed */
 503         void (*remove)(struct phy_device *phydev);
 504
 505         /* Returns true if this is a suitable driver for the given
 506          * phydev.  If NULL, matching is based on phy_id and
 507          * phy_id_mask.
 508          */
 509         int (*match_phy_device)(struct phy_device *phydev);
 510
 511         /* Handles ethtool queries for hardware time stamping. */
 512         int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
 513
 514         /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
 515         int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
 516
 517         /*
 518          * Requests a Rx timestamp for 'skb'. If the skb is accepted,
 519          * the phy driver promises to deliver it using netif_rx() as
 520          * soon as a timestamp becomes available. One of the
 521          * PTP_CLASS_ values is passed in 'type'. The function must
 522          * return true if the skb is accepted for delivery.
 523          */
 524         bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 525
 526         /*
 527          * Requests a Tx timestamp for 'skb'. The phy driver promises
 528          * to deliver it using skb_complete_tx_timestamp() as soon as a
 529          * timestamp becomes available. One of the PTP_CLASS_ values
 530          * is passed in 'type'.
 531          */
 532         void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 533
 534         /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
 535          * enable Wake on LAN, so set_wol is provided to be called in the
 536          * ethernet driver's set_wol function. */
 537         int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 538
 539         /* See set_wol, but for checking whether Wake on LAN is enabled. */
 540         void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 541
 542         /*
 543          * Called to inform a PHY device driver when the core is about to
 544          * change the link state. This callback is supposed to be used as
 545          * fixup hook for drivers that need to take action when the link
 546          * state changes. Drivers are by no means allowed to mess with the
 547          * PHY device structure in their implementations.
 548          */
 549         void (*link_change_notify)(struct phy_device *dev);
 550
 551         /* A function provided by a phy specific driver to override the
 552          * the PHY driver framework support for reading a MMD register
 553          * from the PHY. If not supported, return -1. This function is
 554          * optional for PHY specific drivers, if not provided then the
 555          * default MMD read function is used by the PHY framework.
 556          */
 557         int (*read_mmd_indirect)(struct phy_device *dev, int ptrad,
 558                                  int devnum, int regnum);
 559
 560         /* A function provided by a phy specific driver to override the
 561          * the PHY driver framework support for writing a MMD register
 562          * from the PHY. This function is optional for PHY specific drivers,
 563          * if not provided then the default MMD read function is used by
 564          * the PHY framework.
 565          */
 566         void (*write_mmd_indirect)(struct phy_device *dev, int ptrad,
 567                                    int devnum, int regnum, u32 val);
 568
 569         /* Get the size and type of the eeprom contained within a plug-in
 570          * module */
 571         int (*module_info)(struct phy_device *dev,
 572                            struct ethtool_modinfo *modinfo);
 573
 574         /* Get the eeprom information from the plug-in module */
 575         int (*module_eeprom)(struct phy_device *dev,
 576                              struct ethtool_eeprom *ee, u8 *data);
 577
 578         struct device_driver driver;
 579 };
 580 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
 581
 582 #define PHY_ANY_ID "MATCH ANY PHY"
 583 #define PHY_ANY_UID 0xffffffff
 584
 585 /* A Structure for boards to register fixups with the PHY Lib */
 586 struct phy_fixup {
 587         struct list_head list;
 588         char bus_id[20];
 589         u32 phy_uid;
 590         u32 phy_uid_mask;
 591         int (*run)(struct phy_device *phydev);
 592 };
 593
 594 /**
 595  * phy_read_mmd - Convenience function for reading a register
 596  * from an MMD on a given PHY.
 597  * @phydev: The phy_device struct
 598  * @devad: The MMD to read from
 599  * @regnum: The register on the MMD to read
 600  *
 601  * Same rules as for phy_read();
 602  */
 603 static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum)
 604 {
 605         if (!phydev->is_c45)
 606                 return -EOPNOTSUPP;
 607
 608         return mdiobus_read(phydev->bus, phydev->addr,
 609                             MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff));
 610 }
 611
 612 /**
 613  * phy_read_mmd_indirect - reads data from the MMD registers
 614  * @phydev: The PHY device bus
 615  * @prtad: MMD Address
 616  * @devad: MMD DEVAD
 617  * @addr: PHY address on the MII bus
 618  *
 619  * Description: it reads data from the MMD registers (clause 22 to access to
 620  * clause 45) of the specified phy address.
 621  */
 622 int phy_read_mmd_indirect(struct phy_device *phydev, int prtad,
 623                           int devad, int addr);
 624
 625 /**
 626  * phy_read - Convenience function for reading a given PHY register
 627  * @phydev: the phy_device struct
 628  * @regnum: register number to read
 629  *
 630  * NOTE: MUST NOT be called from interrupt context,
 631  * because the bus read/write functions may wait for an interrupt
 632  * to conclude the operation.
 633  */
 634 static inline int phy_read(struct phy_device *phydev, u32 regnum)
 635 {
 636         return mdiobus_read(phydev->bus, phydev->addr, regnum);
 637 }
 638
 639 /**
 640  * phy_write - Convenience function for writing a given PHY register
 641  * @phydev: the phy_device struct
 642  * @regnum: register number to write
 643  * @val: value to write to @regnum
 644  *
 645  * NOTE: MUST NOT be called from interrupt context,
 646  * because the bus read/write functions may wait for an interrupt
 647  * to conclude the operation.
 648  */
 649 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 650 {
 651         return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
 652 }
 653
 654 /**
 655  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
 656  * @phydev: the phy_device struct
 657  *
 658  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
 659  * PHY_IGNORE_INTERRUPT
 660  */
 661 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
 662 {
 663         return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
 664 }
 665
 666 /**
 667  * phy_is_internal - Convenience function for testing if a PHY is internal
 668  * @phydev: the phy_device struct
 669  */
 670 static inline bool phy_is_internal(struct phy_device *phydev)
 671 {
 672         return phydev->is_internal;
 673 }
 674
 675 /**
 676  * phy_write_mmd - Convenience function for writing a register
 677  * on an MMD on a given PHY.
 678  * @phydev: The phy_device struct
 679  * @devad: The MMD to read from
 680  * @regnum: The register on the MMD to read
 681  * @val: value to write to @regnum
 682  *
 683  * Same rules as for phy_write();
 684  */
 685 static inline int phy_write_mmd(struct phy_device *phydev, int devad,
 686                                 u32 regnum, u16 val)
 687 {
 688         if (!phydev->is_c45)
 689                 return -EOPNOTSUPP;
 690
 691         regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
 692
 693         return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
 694 }
 695
 696 /**
 697  * phy_write_mmd_indirect - writes data to the MMD registers
 698  * @phydev: The PHY device
 699  * @prtad: MMD Address
 700  * @devad: MMD DEVAD
 701  * @addr: PHY address on the MII bus
 702  * @data: data to write in the MMD register
 703  *
 704  * Description: Write data from the MMD registers of the specified
 705  * phy address.
 706  */
 707 void phy_write_mmd_indirect(struct phy_device *phydev, int prtad,
 708                             int devad, int addr, u32 data);
 709
 710 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
 711                                      bool is_c45,
 712                                      struct phy_c45_device_ids *c45_ids);
 713 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
 714 int phy_device_register(struct phy_device *phy);
 715 int phy_init_hw(struct phy_device *phydev);
 716 int phy_suspend(struct phy_device *phydev);
 717 int phy_resume(struct phy_device *phydev);
 718 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
 719                               phy_interface_t interface);
 720 struct phy_device *phy_find_first(struct mii_bus *bus);
 721 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
 722                       u32 flags, phy_interface_t interface);
 723 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 724                        void (*handler)(struct net_device *),
 725                        phy_interface_t interface);
 726 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
 727                                void (*handler)(struct net_device *),
 728                                phy_interface_t interface);
 729 void phy_disconnect(struct phy_device *phydev);
 730 void phy_detach(struct phy_device *phydev);
 731 void phy_start(struct phy_device *phydev);
 732 void phy_stop(struct phy_device *phydev);
 733 int phy_start_aneg(struct phy_device *phydev);
 734
 735 int phy_stop_interrupts(struct phy_device *phydev);
 736
 737 static inline int phy_read_status(struct phy_device *phydev)
 738 {
 739         return phydev->drv->read_status(phydev);
 740 }
 741
 742 int genphy_config_init(struct phy_device *phydev);
 743 int genphy_setup_forced(struct phy_device *phydev);
 744 int genphy_restart_aneg(struct phy_device *phydev);
 745 int genphy_config_aneg(struct phy_device *phydev);
 746 int genphy_aneg_done(struct phy_device *phydev);
 747 int genphy_update_link(struct phy_device *phydev);
 748 int genphy_read_status(struct phy_device *phydev);
 749 int genphy_suspend(struct phy_device *phydev);
 750 int genphy_resume(struct phy_device *phydev);
 751 int genphy_soft_reset(struct phy_device *phydev);
 752 void phy_driver_unregister(struct phy_driver *drv);
 753 void phy_drivers_unregister(struct phy_driver *drv, int n);
 754 int phy_driver_register(struct phy_driver *new_driver);
 755 int phy_drivers_register(struct phy_driver *new_driver, int n);
 756 void phy_state_machine(struct work_struct *work);
 757 void phy_change(struct work_struct *work);
 758 void phy_mac_interrupt(struct phy_device *phydev, int new_link);
 759 void phy_start_machine(struct phy_device *phydev);
 760 void phy_stop_machine(struct phy_device *phydev);
 761 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 762 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 763 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
 764 int phy_start_interrupts(struct phy_device *phydev);
 765 void phy_print_status(struct phy_device *phydev);
 766 void phy_device_free(struct phy_device *phydev);
 767
 768 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
 769                        int (*run)(struct phy_device *));
 770 int phy_register_fixup_for_id(const char *bus_id,
 771                               int (*run)(struct phy_device *));
 772 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
 773                                int (*run)(struct phy_device *));
 774
 775 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
 776 int phy_get_eee_err(struct phy_device *phydev);
 777 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
 778 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
 779 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
 780 void phy_ethtool_get_wol(struct phy_device *phydev,
 781                          struct ethtool_wolinfo *wol);
 782
 783 int __init mdio_bus_init(void);
 784 void mdio_bus_exit(void);
 785
 786 extern struct bus_type mdio_bus_type;
 787
 788 /**
 789  * module_phy_driver() - Helper macro for registering PHY drivers
 790  * @__phy_drivers: array of PHY drivers to register
 791  *
 792  * Helper macro for PHY drivers which do not do anything special in module
 793  * init/exit. Each module may only use this macro once, and calling it
 794  * replaces module_init() and module_exit().
 795  */
 796 #define phy_module_driver(__phy_drivers, __count)                       \
 797 static int __init phy_module_init(void)                                 \
 798 {                                                                       \
 799         return phy_drivers_register(__phy_drivers, __count);            \
 800 }                                                                       \
 801 module_init(phy_module_init);                                           \
 802 static void __exit phy_module_exit(void)                                \
 803 {                                                                       \
 804         phy_drivers_unregister(__phy_drivers, __count);                 \
 805 }                                                                       \
 806 module_exit(phy_module_exit)
 807
 808 #define module_phy_driver(__phy_drivers)                                \
 809         phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
 810
 811 #endif /* __PHY_H */