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