kernel/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  * suspended: Set to true if this phy has been suspended successfully.
 332  * state: state of the PHY for management purposes
 333  * dev_flags: Device-specific flags used by the PHY driver.
 334  * addr: Bus address of PHY
 335  * link_timeout: The number of timer firings to wait before the
 336  * giving up on the current attempt at acquiring a link
 337  * irq: IRQ number of the PHY's interrupt (-1 if none)
 338  * phy_timer: The timer for handling the state machine
 339  * phy_queue: A work_queue for the interrupt
 340  * attached_dev: The attached enet driver's device instance ptr
 341  * adjust_link: Callback for the enet controller to respond to
 342  * changes in the link state.
 343  *
 344  * speed, duplex, pause, supported, advertising, lp_advertising,
 345  * and autoneg are used like in mii_if_info
 346  *
 347  * interrupts currently only supports enabled or disabled,
 348  * but could be changed in the future to support enabling
 349  * and disabling specific interrupts
 350  *
 351  * Contains some infrastructure for polling and interrupt
 352  * handling, as well as handling shifts in PHY hardware state
 353  */
 354 struct phy_device {
 355         /* Information about the PHY type */
 356         /* And management functions */
 357         struct phy_driver *drv;
 358
 359         struct mii_bus *bus;
 360
 361         struct device dev;
 362
 363         u32 phy_id;
 364
 365         struct phy_c45_device_ids c45_ids;
 366         bool is_c45;
 367         bool is_internal;
 368         bool has_fixups;
 369         bool suspended;
 370
 371         enum phy_state state;
 372
 373         u32 dev_flags;
 374
 375         phy_interface_t interface;
 376
 377         /* Bus address of the PHY (0-31) */
 378         int addr;
 379
 380         /*
 381          * forced speed & duplex (no autoneg)
 382          * partner speed & duplex & pause (autoneg)
 383          */
 384         int speed;
 385         int duplex;
 386         int pause;
 387         int asym_pause;
 388
 389         /* The most recently read link state */
 390         int link;
 391
 392         /* Enabled Interrupts */
 393         u32 interrupts;
 394
 395         /* Union of PHY and Attached devices' supported modes */
 396         /* See mii.h for more info */
 397         u32 supported;
 398         u32 advertising;
 399         u32 lp_advertising;
 400
 401         int autoneg;
 402
 403         int link_timeout;
 404
 405         /*
 406          * Interrupt number for this PHY
 407          * -1 means no interrupt
 408          */
 409         int irq;
 410
 411         /* private data pointer */
 412         /* For use by PHYs to maintain extra state */
 413         void *priv;
 414
 415         /* Interrupt and Polling infrastructure */
 416         struct work_struct phy_queue;
 417         struct delayed_work state_queue;
 418         atomic_t irq_disable;
 419
 420         struct mutex lock;
 421
 422         struct net_device *attached_dev;
 423
 424         void (*adjust_link)(struct net_device *dev);
 425 };
 426 #define to_phy_device(d) container_of(d, struct phy_device, dev)
 427
 428 /* struct phy_driver: Driver structure for a particular PHY type
 429  *
 430  * phy_id: The result of reading the UID registers of this PHY
 431  *   type, and ANDing them with the phy_id_mask.  This driver
 432  *   only works for PHYs with IDs which match this field
 433  * name: The friendly name of this PHY type
 434  * phy_id_mask: Defines the important bits of the phy_id
 435  * features: A list of features (speed, duplex, etc) supported
 436  *   by this PHY
 437  * flags: A bitfield defining certain other features this PHY
 438  *   supports (like interrupts)
 439  * driver_data: static driver data
 440  *
 441  * The drivers must implement config_aneg and read_status.  All
 442  * other functions are optional. Note that none of these
 443  * functions should be called from interrupt time.  The goal is
 444  * for the bus read/write functions to be able to block when the
 445  * bus transaction is happening, and be freed up by an interrupt
 446  * (The MPC85xx has this ability, though it is not currently
 447  * supported in the driver).
 448  */
 449 struct phy_driver {
 450         u32 phy_id;
 451         char *name;
 452         unsigned int phy_id_mask;
 453         u32 features;
 454         u32 flags;
 455         const void *driver_data;
 456
 457         /*
 458          * Called to issue a PHY software reset
 459          */
 460         int (*soft_reset)(struct phy_device *phydev);
 461
 462         /*
 463          * Called to initialize the PHY,
 464          * including after a reset
 465          */
 466         int (*config_init)(struct phy_device *phydev);
 467
 468         /*
 469          * Called during discovery.  Used to set
 470          * up device-specific structures, if any
 471          */
 472         int (*probe)(struct phy_device *phydev);
 473
 474         /* PHY Power Management */
 475         int (*suspend)(struct phy_device *phydev);
 476         int (*resume)(struct phy_device *phydev);
 477
 478         /*
 479          * Configures the advertisement and resets
 480          * autonegotiation if phydev->autoneg is on,
 481          * forces the speed to the current settings in phydev
 482          * if phydev->autoneg is off
 483          */
 484         int (*config_aneg)(struct phy_device *phydev);
 485
 486         /* Determines the auto negotiation result */
 487         int (*aneg_done)(struct phy_device *phydev);
 488
 489         /* Determines the negotiated speed and duplex */
 490         int (*read_status)(struct phy_device *phydev);
 491
 492         /* Clears any pending interrupts */
 493         int (*ack_interrupt)(struct phy_device *phydev);
 494
 495         /* Enables or disables interrupts */
 496         int (*config_intr)(struct phy_device *phydev);
 497
 498         /*
 499          * Checks if the PHY generated an interrupt.
 500          * For multi-PHY devices with shared PHY interrupt pin
 501          */
 502         int (*did_interrupt)(struct phy_device *phydev);
 503
 504         /* Clears up any memory if needed */
 505         void (*remove)(struct phy_device *phydev);
 506
 507         /* Returns true if this is a suitable driver for the given
 508          * phydev.  If NULL, matching is based on phy_id and
 509          * phy_id_mask.
 510          */
 511         int (*match_phy_device)(struct phy_device *phydev);
 512
 513         /* Handles ethtool queries for hardware time stamping. */
 514         int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
 515
 516         /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
 517         int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
 518
 519         /*
 520          * Requests a Rx timestamp for 'skb'. If the skb is accepted,
 521          * the phy driver promises to deliver it using netif_rx() as
 522          * soon as a timestamp becomes available. One of the
 523          * PTP_CLASS_ values is passed in 'type'. The function must
 524          * return true if the skb is accepted for delivery.
 525          */
 526         bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 527
 528         /*
 529          * Requests a Tx timestamp for 'skb'. The phy driver promises
 530          * to deliver it using skb_complete_tx_timestamp() as soon as a
 531          * timestamp becomes available. One of the PTP_CLASS_ values
 532          * is passed in 'type'.
 533          */
 534         void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 535
 536         /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
 537          * enable Wake on LAN, so set_wol is provided to be called in the
 538          * ethernet driver's set_wol function. */
 539         int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 540
 541         /* See set_wol, but for checking whether Wake on LAN is enabled. */
 542         void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 543
 544         /*
 545          * Called to inform a PHY device driver when the core is about to
 546          * change the link state. This callback is supposed to be used as
 547          * fixup hook for drivers that need to take action when the link
 548          * state changes. Drivers are by no means allowed to mess with the
 549          * PHY device structure in their implementations.
 550          */
 551         void (*link_change_notify)(struct phy_device *dev);
 552
 553         /* A function provided by a phy specific driver to override the
 554          * the PHY driver framework support for reading a MMD register
 555          * from the PHY. If not supported, return -1. This function is
 556          * optional for PHY specific drivers, if not provided then the
 557          * default MMD read function is used by the PHY framework.
 558          */
 559         int (*read_mmd_indirect)(struct phy_device *dev, int ptrad,
 560                                  int devnum, int regnum);
 561
 562         /* A function provided by a phy specific driver to override the
 563          * the PHY driver framework support for writing a MMD register
 564          * from the PHY. This function is optional for PHY specific drivers,
 565          * if not provided then the default MMD read function is used by
 566          * the PHY framework.
 567          */
 568         void (*write_mmd_indirect)(struct phy_device *dev, int ptrad,
 569                                    int devnum, int regnum, u32 val);
 570
 571         /* Get the size and type of the eeprom contained within a plug-in
 572          * module */
 573         int (*module_info)(struct phy_device *dev,
 574                            struct ethtool_modinfo *modinfo);
 575
 576         /* Get the eeprom information from the plug-in module */
 577         int (*module_eeprom)(struct phy_device *dev,
 578                              struct ethtool_eeprom *ee, u8 *data);
 579
 580         struct device_driver driver;
 581 };
 582 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
 583
 584 #define PHY_ANY_ID "MATCH ANY PHY"
 585 #define PHY_ANY_UID 0xffffffff
 586
 587 /* A Structure for boards to register fixups with the PHY Lib */
 588 struct phy_fixup {
 589         struct list_head list;
 590         char bus_id[20];
 591         u32 phy_uid;
 592         u32 phy_uid_mask;
 593         int (*run)(struct phy_device *phydev);
 594 };
 595
 596 /**
 597  * phy_read_mmd - Convenience function for reading a register
 598  * from an MMD on a given PHY.
 599  * @phydev: The phy_device struct
 600  * @devad: The MMD to read from
 601  * @regnum: The register on the MMD to read
 602  *
 603  * Same rules as for phy_read();
 604  */
 605 static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum)
 606 {
 607         if (!phydev->is_c45)
 608                 return -EOPNOTSUPP;
 609
 610         return mdiobus_read(phydev->bus, phydev->addr,
 611                             MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff));
 612 }
 613
 614 /**
 615  * phy_read_mmd_indirect - reads data from the MMD registers
 616  * @phydev: The PHY device bus
 617  * @prtad: MMD Address
 618  * @devad: MMD DEVAD
 619  * @addr: PHY address on the MII bus
 620  *
 621  * Description: it reads data from the MMD registers (clause 22 to access to
 622  * clause 45) of the specified phy address.
 623  */
 624 int phy_read_mmd_indirect(struct phy_device *phydev, int prtad,
 625                           int devad, int addr);
 626
 627 /**
 628  * phy_read - Convenience function for reading a given PHY register
 629  * @phydev: the phy_device struct
 630  * @regnum: register number to read
 631  *
 632  * NOTE: MUST NOT be called from interrupt context,
 633  * because the bus read/write functions may wait for an interrupt
 634  * to conclude the operation.
 635  */
 636 static inline int phy_read(struct phy_device *phydev, u32 regnum)
 637 {
 638         return mdiobus_read(phydev->bus, phydev->addr, regnum);
 639 }
 640
 641 /**
 642  * phy_write - Convenience function for writing a given PHY register
 643  * @phydev: the phy_device struct
 644  * @regnum: register number to write
 645  * @val: value to write to @regnum
 646  *
 647  * NOTE: MUST NOT be called from interrupt context,
 648  * because the bus read/write functions may wait for an interrupt
 649  * to conclude the operation.
 650  */
 651 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 652 {
 653         return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
 654 }
 655
 656 /**
 657  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
 658  * @phydev: the phy_device struct
 659  *
 660  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
 661  * PHY_IGNORE_INTERRUPT
 662  */
 663 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
 664 {
 665         return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
 666 }
 667
 668 /**
 669  * phy_is_internal - Convenience function for testing if a PHY is internal
 670  * @phydev: the phy_device struct
 671  */
 672 static inline bool phy_is_internal(struct phy_device *phydev)
 673 {
 674         return phydev->is_internal;
 675 }
 676
 677 /**
 678  * phy_write_mmd - Convenience function for writing a register
 679  * on an MMD on a given PHY.
 680  * @phydev: The phy_device struct
 681  * @devad: The MMD to read from
 682  * @regnum: The register on the MMD to read
 683  * @val: value to write to @regnum
 684  *
 685  * Same rules as for phy_write();
 686  */
 687 static inline int phy_write_mmd(struct phy_device *phydev, int devad,
 688                                 u32 regnum, u16 val)
 689 {
 690         if (!phydev->is_c45)
 691                 return -EOPNOTSUPP;
 692
 693         regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
 694
 695         return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
 696 }
 697
 698 /**
 699  * phy_write_mmd_indirect - writes data to the MMD registers
 700  * @phydev: The PHY device
 701  * @prtad: MMD Address
 702  * @devad: MMD DEVAD
 703  * @addr: PHY address on the MII bus
 704  * @data: data to write in the MMD register
 705  *
 706  * Description: Write data from the MMD registers of the specified
 707  * phy address.
 708  */
 709 void phy_write_mmd_indirect(struct phy_device *phydev, int prtad,
 710                             int devad, int addr, u32 data);
 711
 712 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
 713                                      bool is_c45,
 714                                      struct phy_c45_device_ids *c45_ids);
 715 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
 716 int phy_device_register(struct phy_device *phy);
 717 int phy_init_hw(struct phy_device *phydev);
 718 int phy_suspend(struct phy_device *phydev);
 719 int phy_resume(struct phy_device *phydev);
 720 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
 721                               phy_interface_t interface);
 722 struct phy_device *phy_find_first(struct mii_bus *bus);
 723 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
 724                       u32 flags, phy_interface_t interface);
 725 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 726                        void (*handler)(struct net_device *),
 727                        phy_interface_t interface);
 728 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
 729                                void (*handler)(struct net_device *),
 730                                phy_interface_t interface);
 731 void phy_disconnect(struct phy_device *phydev);
 732 void phy_detach(struct phy_device *phydev);
 733 void phy_start(struct phy_device *phydev);
 734 void phy_stop(struct phy_device *phydev);
 735 int phy_start_aneg(struct phy_device *phydev);
 736
 737 int phy_stop_interrupts(struct phy_device *phydev);
 738
 739 static inline int phy_read_status(struct phy_device *phydev)
 740 {
 741         return phydev->drv->read_status(phydev);
 742 }
 743
 744 int genphy_config_init(struct phy_device *phydev);
 745 int genphy_setup_forced(struct phy_device *phydev);
 746 int genphy_restart_aneg(struct phy_device *phydev);
 747 int genphy_config_aneg(struct phy_device *phydev);
 748 int genphy_aneg_done(struct phy_device *phydev);
 749 int genphy_update_link(struct phy_device *phydev);
 750 int genphy_read_status(struct phy_device *phydev);
 751 int genphy_suspend(struct phy_device *phydev);
 752 int genphy_resume(struct phy_device *phydev);
 753 int genphy_soft_reset(struct phy_device *phydev);
 754 void phy_driver_unregister(struct phy_driver *drv);
 755 void phy_drivers_unregister(struct phy_driver *drv, int n);
 756 int phy_driver_register(struct phy_driver *new_driver);
 757 int phy_drivers_register(struct phy_driver *new_driver, int n);
 758 void phy_state_machine(struct work_struct *work);
 759 void phy_change(struct work_struct *work);
 760 void phy_mac_interrupt(struct phy_device *phydev, int new_link);
 761 void phy_start_machine(struct phy_device *phydev);
 762 void phy_stop_machine(struct phy_device *phydev);
 763 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 764 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 765 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
 766 int phy_start_interrupts(struct phy_device *phydev);
 767 void phy_print_status(struct phy_device *phydev);
 768 void phy_device_free(struct phy_device *phydev);
 769
 770 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
 771                        int (*run)(struct phy_device *));
 772 int phy_register_fixup_for_id(const char *bus_id,
 773                               int (*run)(struct phy_device *));
 774 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
 775                                int (*run)(struct phy_device *));
 776
 777 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
 778 int phy_get_eee_err(struct phy_device *phydev);
 779 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
 780 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
 781 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
 782 void phy_ethtool_get_wol(struct phy_device *phydev,
 783                          struct ethtool_wolinfo *wol);
 784
 785 int __init mdio_bus_init(void);
 786 void mdio_bus_exit(void);
 787
 788 extern struct bus_type mdio_bus_type;
 789
 790 /**
 791  * module_phy_driver() - Helper macro for registering PHY drivers
 792  * @__phy_drivers: array of PHY drivers to register
 793  *
 794  * Helper macro for PHY drivers which do not do anything special in module
 795  * init/exit. Each module may only use this macro once, and calling it
 796  * replaces module_init() and module_exit().
 797  */
 798 #define phy_module_driver(__phy_drivers, __count)                       \
 799 static int __init phy_module_init(void)                                 \
 800 {                                                                       \
 801         return phy_drivers_register(__phy_drivers, __count);            \
 802 }                                                                       \
 803 module_init(phy_module_init);                                           \
 804 static void __exit phy_module_exit(void)                                \
 805 {                                                                       \
 806         phy_drivers_unregister(__phy_drivers, __count);                 \
 807 }                                                                       \
 808 module_exit(phy_module_exit)
 809
 810 #define module_phy_driver(__phy_drivers)                                \
 811         phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
 812
 813 #endif /* __PHY_H */