include/linux/phy.h

   1 /*
   2  * Framework and drivers for configuring and reading different PHYs
   3  * Based on code in sungem_phy.c and gianfar_phy.c
   4  *
   5  * Author: Andy Fleming
   6  *
   7  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   8  *
   9  * This program is free software; you can redistribute  it and/or modify it
  10  * under  the terms of  the GNU General  Public License as published by the
  11  * Free Software Foundation;  either version 2 of the  License, or (at your
  12  * option) any later version.
  13  *
  14  */
  15
  16 #ifndef __PHY_H
  17 #define __PHY_H
  18
  19 #include <linux/compiler.h>
  20 #include <linux/spinlock.h>
  21 #include <linux/ethtool.h>
  22 #include <linux/mdio.h>
  23 #include <linux/mii.h>
  24 #include <linux/module.h>
  25 #include <linux/timer.h>
  26 #include <linux/workqueue.h>
  27 #include <linux/mod_devicetable.h>
  28
  29 #include <linux/atomic.h>
  30
  31 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
  32                                  SUPPORTED_TP | \
  33                                  SUPPORTED_MII)
  34
  35 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
  36                                  SUPPORTED_10baseT_Full)
  37
  38 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
  39                                  SUPPORTED_100baseT_Full)
  40
  41 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
  42                                  SUPPORTED_1000baseT_Full)
  43
  44 #define PHY_BASIC_FEATURES      (PHY_10BT_FEATURES | \
  45                                  PHY_100BT_FEATURES | \
  46                                  PHY_DEFAULT_FEATURES)
  47
  48 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
  49                                  PHY_1000BT_FEATURES)
  50
  51
  52 /*
  53  * Set phydev->irq to PHY_POLL if interrupts are not supported,
  54  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
  55  * the attached driver handles the interrupt
  56  */
  57 #define PHY_POLL                -1
  58 #define PHY_IGNORE_INTERRUPT    -2
  59
  60 #define PHY_HAS_INTERRUPT       0x00000001
  61 #define PHY_HAS_MAGICANEG       0x00000002
  62 #define PHY_IS_INTERNAL         0x00000004
  63
  64 /* Interface Mode definitions */
  65 typedef enum {
  66         PHY_INTERFACE_MODE_NA,
  67         PHY_INTERFACE_MODE_MII,
  68         PHY_INTERFACE_MODE_GMII,
  69         PHY_INTERFACE_MODE_SGMII,
  70         PHY_INTERFACE_MODE_TBI,
  71         PHY_INTERFACE_MODE_REVMII,
  72         PHY_INTERFACE_MODE_RMII,
  73         PHY_INTERFACE_MODE_RGMII,
  74         PHY_INTERFACE_MODE_RGMII_ID,
  75         PHY_INTERFACE_MODE_RGMII_RXID,
  76         PHY_INTERFACE_MODE_RGMII_TXID,
  77         PHY_INTERFACE_MODE_RTBI,
  78         PHY_INTERFACE_MODE_SMII,
  79         PHY_INTERFACE_MODE_XGMII,
  80         PHY_INTERFACE_MODE_MOCA,
  81         PHY_INTERFACE_MODE_QSGMII,
  82         PHY_INTERFACE_MODE_MAX,
  83 } phy_interface_t;
  84
  85 /**
  86  * It maps 'enum phy_interface_t' found in include/linux/phy.h
  87  * into the device tree binding of 'phy-mode', so that Ethernet
  88  * device driver can get phy interface from device tree.
  89  */
  90 static inline const char *phy_modes(phy_interface_t interface)
  91 {
  92         switch (interface) {
  93         case PHY_INTERFACE_MODE_NA:
  94                 return "";
  95         case PHY_INTERFACE_MODE_MII:
  96                 return "mii";
  97         case PHY_INTERFACE_MODE_GMII:
  98                 return "gmii";
  99         case PHY_INTERFACE_MODE_SGMII:
 100                 return "sgmii";
 101         case PHY_INTERFACE_MODE_TBI:
 102                 return "tbi";
 103         case PHY_INTERFACE_MODE_REVMII:
 104                 return "rev-mii";
 105         case PHY_INTERFACE_MODE_RMII:
 106                 return "rmii";
 107         case PHY_INTERFACE_MODE_RGMII:
 108                 return "rgmii";
 109         case PHY_INTERFACE_MODE_RGMII_ID:
 110                 return "rgmii-id";
 111         case PHY_INTERFACE_MODE_RGMII_RXID:
 112                 return "rgmii-rxid";
 113         case PHY_INTERFACE_MODE_RGMII_TXID:
 114                 return "rgmii-txid";
 115         case PHY_INTERFACE_MODE_RTBI:
 116                 return "rtbi";
 117         case PHY_INTERFACE_MODE_SMII:
 118                 return "smii";
 119         case PHY_INTERFACE_MODE_XGMII:
 120                 return "xgmii";
 121         case PHY_INTERFACE_MODE_MOCA:
 122                 return "moca";
 123         case PHY_INTERFACE_MODE_QSGMII:
 124                 return "qsgmii";
 125         default:
 126                 return "unknown";
 127         }
 128 }
 129
 130
 131 #define PHY_INIT_TIMEOUT        100000
 132 #define PHY_STATE_TIME          1
 133 #define PHY_FORCE_TIMEOUT       10
 134 #define PHY_AN_TIMEOUT          10
 135
 136 #define PHY_MAX_ADDR    32
 137
 138 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
 139 #define PHY_ID_FMT "%s:%02x"
 140
 141 /*
 142  * Need to be a little smaller than phydev->dev.bus_id to leave room
 143  * for the ":%02x"
 144  */
 145 #define MII_BUS_ID_SIZE (20 - 3)
 146
 147 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
 148    IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
 149 #define MII_ADDR_C45 (1<<30)
 150
 151 struct device;
 152 struct sk_buff;
 153
 154 /*
 155  * The Bus class for PHYs.  Devices which provide access to
 156  * PHYs should register using this structure
 157  */
 158 struct mii_bus {
 159         struct module *owner;
 160         const char *name;
 161         char id[MII_BUS_ID_SIZE];
 162         void *priv;
 163         int (*read)(struct mii_bus *bus, int addr, int regnum);
 164         int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
 165         int (*reset)(struct mii_bus *bus);
 166
 167         /*
 168          * A lock to ensure that only one thing can read/write
 169          * the MDIO bus at a time
 170          */
 171         struct mutex mdio_lock;
 172
 173         struct device *parent;
 174         enum {
 175                 MDIOBUS_ALLOCATED = 1,
 176                 MDIOBUS_REGISTERED,
 177                 MDIOBUS_UNREGISTERED,
 178                 MDIOBUS_RELEASED,
 179         } state;
 180         struct device dev;
 181
 182         /* list of all PHYs on bus */
 183         struct mdio_device *mdio_map[PHY_MAX_ADDR];
 184
 185         /* PHY addresses to be ignored when probing */
 186         u32 phy_mask;
 187
 188         /* PHY addresses to ignore the TA/read failure */
 189         u32 phy_ignore_ta_mask;
 190
 191         /*
 192          * An array of interrupts, each PHY's interrupt at the index
 193          * matching its address
 194          */
 195         int irq[PHY_MAX_ADDR];
 196 };
 197 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
 198
 199 struct mii_bus *mdiobus_alloc_size(size_t);
 200 static inline struct mii_bus *mdiobus_alloc(void)
 201 {
 202         return mdiobus_alloc_size(0);
 203 }
 204
 205 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
 206 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
 207 void mdiobus_unregister(struct mii_bus *bus);
 208 void mdiobus_free(struct mii_bus *bus);
 209 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
 210 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
 211 {
 212         return devm_mdiobus_alloc_size(dev, 0);
 213 }
 214
 215 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
 216 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
 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         u32 phy_id;
 368
 369         struct phy_c45_device_ids c45_ids;
 370         bool is_c45;
 371         bool is_internal;
 372         bool is_pseudo_fixed_link;
 373         bool has_fixups;
 374         bool suspended;
 375
 376         enum phy_state state;
 377
 378         u32 dev_flags;
 379
 380         phy_interface_t interface;
 381
 382         /*
 383          * forced speed & duplex (no autoneg)
 384          * partner speed & duplex & pause (autoneg)
 385          */
 386         int speed;
 387         int duplex;
 388         int pause;
 389         int asym_pause;
 390
 391         /* The most recently read link state */
 392         int link;
 393
 394         /* Enabled Interrupts */
 395         u32 interrupts;
 396
 397         /* Union of PHY and Attached devices' supported modes */
 398         /* See mii.h for more info */
 399         u32 supported;
 400         u32 advertising;
 401         u32 lp_advertising;
 402
 403         int autoneg;
 404
 405         int link_timeout;
 406
 407         /*
 408          * Interrupt number for this PHY
 409          * -1 means no interrupt
 410          */
 411         int irq;
 412
 413         /* private data pointer */
 414         /* For use by PHYs to maintain extra state */
 415         void *priv;
 416
 417         /* Interrupt and Polling infrastructure */
 418         struct work_struct phy_queue;
 419         struct delayed_work state_queue;
 420         atomic_t irq_disable;
 421
 422         struct mutex lock;
 423
 424         struct net_device *attached_dev;
 425
 426         u8 mdix;
 427
 428         void (*adjust_link)(struct net_device *dev);
 429 };
 430 #define to_phy_device(d) container_of(to_mdio_device(d), \
 431                                       struct phy_device, mdio)
 432
 433 /* struct phy_driver: Driver structure for a particular PHY type
 434  *
 435  * phy_id: The result of reading the UID registers of this PHY
 436  *   type, and ANDing them with the phy_id_mask.  This driver
 437  *   only works for PHYs with IDs which match this field
 438  * name: The friendly name of this PHY type
 439  * phy_id_mask: Defines the important bits of the phy_id
 440  * features: A list of features (speed, duplex, etc) supported
 441  *   by this PHY
 442  * flags: A bitfield defining certain other features this PHY
 443  *   supports (like interrupts)
 444  * driver_data: static driver data
 445  *
 446  * The drivers must implement config_aneg and read_status.  All
 447  * other functions are optional. Note that none of these
 448  * functions should be called from interrupt time.  The goal is
 449  * for the bus read/write functions to be able to block when the
 450  * bus transaction is happening, and be freed up by an interrupt
 451  * (The MPC85xx has this ability, though it is not currently
 452  * supported in the driver).
 453  */
 454 struct phy_driver {
 455         u32 phy_id;
 456         char *name;
 457         unsigned int phy_id_mask;
 458         u32 features;
 459         u32 flags;
 460         const void *driver_data;
 461
 462         /*
 463          * Called to issue a PHY software reset
 464          */
 465         int (*soft_reset)(struct phy_device *phydev);
 466
 467         /*
 468          * Called to initialize the PHY,
 469          * including after a reset
 470          */
 471         int (*config_init)(struct phy_device *phydev);
 472
 473         /*
 474          * Called during discovery.  Used to set
 475          * up device-specific structures, if any
 476          */
 477         int (*probe)(struct phy_device *phydev);
 478
 479         /* PHY Power Management */
 480         int (*suspend)(struct phy_device *phydev);
 481         int (*resume)(struct phy_device *phydev);
 482
 483         /*
 484          * Configures the advertisement and resets
 485          * autonegotiation if phydev->autoneg is on,
 486          * forces the speed to the current settings in phydev
 487          * if phydev->autoneg is off
 488          */
 489         int (*config_aneg)(struct phy_device *phydev);
 490
 491         /* Determines the auto negotiation result */
 492         int (*aneg_done)(struct phy_device *phydev);
 493
 494         /* Determines the negotiated speed and duplex */
 495         int (*read_status)(struct phy_device *phydev);
 496
 497         /* Clears any pending interrupts */
 498         int (*ack_interrupt)(struct phy_device *phydev);
 499
 500         /* Enables or disables interrupts */
 501         int (*config_intr)(struct phy_device *phydev);
 502
 503         /*
 504          * Checks if the PHY generated an interrupt.
 505          * For multi-PHY devices with shared PHY interrupt pin
 506          */
 507         int (*did_interrupt)(struct phy_device *phydev);
 508
 509         /* Clears up any memory if needed */
 510         void (*remove)(struct phy_device *phydev);
 511
 512         /* Returns true if this is a suitable driver for the given
 513          * phydev.  If NULL, matching is based on phy_id and
 514          * phy_id_mask.
 515          */
 516         int (*match_phy_device)(struct phy_device *phydev);
 517
 518         /* Handles ethtool queries for hardware time stamping. */
 519         int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
 520
 521         /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
 522         int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
 523
 524         /*
 525          * Requests a Rx timestamp for 'skb'. If the skb is accepted,
 526          * the phy driver promises to deliver it using netif_rx() as
 527          * soon as a timestamp becomes available. One of the
 528          * PTP_CLASS_ values is passed in 'type'. The function must
 529          * return true if the skb is accepted for delivery.
 530          */
 531         bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 532
 533         /*
 534          * Requests a Tx timestamp for 'skb'. The phy driver promises
 535          * to deliver it using skb_complete_tx_timestamp() as soon as a
 536          * timestamp becomes available. One of the PTP_CLASS_ values
 537          * is passed in 'type'.
 538          */
 539         void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 540
 541         /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
 542          * enable Wake on LAN, so set_wol is provided to be called in the
 543          * ethernet driver's set_wol function. */
 544         int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 545
 546         /* See set_wol, but for checking whether Wake on LAN is enabled. */
 547         void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
 548
 549         /*
 550          * Called to inform a PHY device driver when the core is about to
 551          * change the link state. This callback is supposed to be used as
 552          * fixup hook for drivers that need to take action when the link
 553          * state changes. Drivers are by no means allowed to mess with the
 554          * PHY device structure in their implementations.
 555          */
 556         void (*link_change_notify)(struct phy_device *dev);
 557
 558         /* A function provided by a phy specific driver to override the
 559          * the PHY driver framework support for reading a MMD register
 560          * from the PHY. If not supported, return -1. This function is
 561          * optional for PHY specific drivers, if not provided then the
 562          * default MMD read function is used by the PHY framework.
 563          */
 564         int (*read_mmd_indirect)(struct phy_device *dev, int ptrad,
 565                                  int devnum, int regnum);
 566
 567         /* A function provided by a phy specific driver to override the
 568          * the PHY driver framework support for writing a MMD register
 569          * from the PHY. This function is optional for PHY specific drivers,
 570          * if not provided then the default MMD read function is used by
 571          * the PHY framework.
 572          */
 573         void (*write_mmd_indirect)(struct phy_device *dev, int ptrad,
 574                                    int devnum, int regnum, u32 val);
 575
 576         /* Get the size and type of the eeprom contained within a plug-in
 577          * module */
 578         int (*module_info)(struct phy_device *dev,
 579                            struct ethtool_modinfo *modinfo);
 580
 581         /* Get the eeprom information from the plug-in module */
 582         int (*module_eeprom)(struct phy_device *dev,
 583                              struct ethtool_eeprom *ee, u8 *data);
 584
 585         /* Get statistics from the phy using ethtool */
 586         int (*get_sset_count)(struct phy_device *dev);
 587         void (*get_strings)(struct phy_device *dev, u8 *data);
 588         void (*get_stats)(struct phy_device *dev,
 589                           struct ethtool_stats *stats, u64 *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[20];
 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->mdio.bus, phydev->mdio.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  * @addr: PHY address on the MII bus
 630  *
 631  * Description: it reads data from the MMD registers (clause 22 to access to
 632  * clause 45) of the specified phy address.
 633  */
 634 int phy_read_mmd_indirect(struct phy_device *phydev, int prtad, int devad);
 635
 636 /**
 637  * phy_read - Convenience function for reading a given PHY register
 638  * @phydev: the phy_device struct
 639  * @regnum: register number to read
 640  *
 641  * NOTE: MUST NOT be called from interrupt context,
 642  * because the bus read/write functions may wait for an interrupt
 643  * to conclude the operation.
 644  */
 645 static inline int phy_read(struct phy_device *phydev, u32 regnum)
 646 {
 647         return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
 648 }
 649
 650 /**
 651  * phy_write - Convenience function for writing a given PHY register
 652  * @phydev: the phy_device struct
 653  * @regnum: register number to write
 654  * @val: value to write to @regnum
 655  *
 656  * NOTE: MUST NOT be called from interrupt context,
 657  * because the bus read/write functions may wait for an interrupt
 658  * to conclude the operation.
 659  */
 660 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 661 {
 662         return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
 663 }
 664
 665 /**
 666  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
 667  * @phydev: the phy_device struct
 668  *
 669  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
 670  * PHY_IGNORE_INTERRUPT
 671  */
 672 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
 673 {
 674         return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
 675 }
 676
 677 /**
 678  * phy_is_internal - Convenience function for testing if a PHY is internal
 679  * @phydev: the phy_device struct
 680  */
 681 static inline bool phy_is_internal(struct phy_device *phydev)
 682 {
 683         return phydev->is_internal;
 684 }
 685
 686 /**
 687  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
 688  * is RGMII (all variants)
 689  * @phydev: the phy_device struct
 690  */
 691 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
 692 {
 693         return phydev->interface >= PHY_INTERFACE_MODE_RGMII &&
 694                 phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID;
 695 };
 696
 697 /*
 698  * phy_is_pseudo_fixed_link - Convenience function for testing if this
 699  * PHY is the CPU port facing side of an Ethernet switch, or similar.
 700  * @phydev: the phy_device struct
 701  */
 702 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
 703 {
 704         return phydev->is_pseudo_fixed_link;
 705 }
 706
 707 /**
 708  * phy_write_mmd - Convenience function for writing a register
 709  * on an MMD on a given PHY.
 710  * @phydev: The phy_device struct
 711  * @devad: The MMD to read from
 712  * @regnum: The register on the MMD to read
 713  * @val: value to write to @regnum
 714  *
 715  * Same rules as for phy_write();
 716  */
 717 static inline int phy_write_mmd(struct phy_device *phydev, int devad,
 718                                 u32 regnum, u16 val)
 719 {
 720         if (!phydev->is_c45)
 721                 return -EOPNOTSUPP;
 722
 723         regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
 724
 725         return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
 726 }
 727
 728 /**
 729  * phy_write_mmd_indirect - writes data to the MMD registers
 730  * @phydev: The PHY device
 731  * @prtad: MMD Address
 732  * @devad: MMD DEVAD
 733  * @data: data to write in the MMD register
 734  *
 735  * Description: Write data from the MMD registers of the specified
 736  * phy address.
 737  */
 738 void phy_write_mmd_indirect(struct phy_device *phydev, int prtad,
 739                             int devad, u32 data);
 740
 741 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
 742                                      bool is_c45,
 743                                      struct phy_c45_device_ids *c45_ids);
 744 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
 745 int phy_device_register(struct phy_device *phy);
 746 void phy_device_remove(struct phy_device *phydev);
 747 int phy_init_hw(struct phy_device *phydev);
 748 int phy_suspend(struct phy_device *phydev);
 749 int phy_resume(struct phy_device *phydev);
 750 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
 751                               phy_interface_t interface);
 752 struct phy_device *phy_find_first(struct mii_bus *bus);
 753 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
 754                       u32 flags, phy_interface_t interface);
 755 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 756                        void (*handler)(struct net_device *),
 757                        phy_interface_t interface);
 758 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
 759                                void (*handler)(struct net_device *),
 760                                phy_interface_t interface);
 761 void phy_disconnect(struct phy_device *phydev);
 762 void phy_detach(struct phy_device *phydev);
 763 void phy_start(struct phy_device *phydev);
 764 void phy_stop(struct phy_device *phydev);
 765 int phy_start_aneg(struct phy_device *phydev);
 766
 767 int phy_stop_interrupts(struct phy_device *phydev);
 768
 769 static inline int phy_read_status(struct phy_device *phydev)
 770 {
 771         return phydev->drv->read_status(phydev);
 772 }
 773
 774 #define phydev_err(_phydev, format, args...)    \
 775         dev_err(&_phydev->mdio.dev, format, ##args)
 776
 777 #define phydev_dbg(_phydev, format, args...)    \
 778         dev_dbg(&_phydev->mdio.dev, format, ##args);
 779
 780 static inline const char *phydev_name(const struct phy_device *phydev)
 781 {
 782         return dev_name(&phydev->mdio.dev);
 783 }
 784
 785 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
 786         __printf(2, 3);
 787 void phy_attached_info(struct phy_device *phydev);
 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 void phy_driver_unregister(struct phy_driver *drv);
 799 void phy_drivers_unregister(struct phy_driver *drv, int n);
 800 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
 801 int phy_drivers_register(struct phy_driver *new_driver, int n,
 802                          struct module *owner);
 803 void phy_state_machine(struct work_struct *work);
 804 void phy_change(struct work_struct *work);
 805 void phy_mac_interrupt(struct phy_device *phydev, int new_link);
 806 void phy_start_machine(struct phy_device *phydev);
 807 void phy_stop_machine(struct phy_device *phydev);
 808 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 809 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 810 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
 811 int phy_start_interrupts(struct phy_device *phydev);
 812 void phy_print_status(struct phy_device *phydev);
 813 void phy_device_free(struct phy_device *phydev);
 814 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
 815
 816 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
 817                        int (*run)(struct phy_device *));
 818 int phy_register_fixup_for_id(const char *bus_id,
 819                               int (*run)(struct phy_device *));
 820 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
 821                                int (*run)(struct phy_device *));
 822
 823 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
 824 int phy_get_eee_err(struct phy_device *phydev);
 825 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
 826 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
 827 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
 828 void phy_ethtool_get_wol(struct phy_device *phydev,
 829                          struct ethtool_wolinfo *wol);
 830
 831 int __init mdio_bus_init(void);
 832 void mdio_bus_exit(void);
 833
 834 extern struct bus_type mdio_bus_type;
 835
 836 /**
 837  * module_phy_driver() - Helper macro for registering PHY drivers
 838  * @__phy_drivers: array of PHY drivers to register
 839  *
 840  * Helper macro for PHY drivers which do not do anything special in module
 841  * init/exit. Each module may only use this macro once, and calling it
 842  * replaces module_init() and module_exit().
 843  */
 844 #define phy_module_driver(__phy_drivers, __count)                       \
 845 static int __init phy_module_init(void)                                 \
 846 {                                                                       \
 847         return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
 848 }                                                                       \
 849 module_init(phy_module_init);                                           \
 850 static void __exit phy_module_exit(void)                                \
 851 {                                                                       \
 852         phy_drivers_unregister(__phy_drivers, __count);                 \
 853 }                                                                       \
 854 module_exit(phy_module_exit)
 855
 856 #define module_phy_driver(__phy_drivers)                                \
 857         phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
 858
 859 #endif /* __PHY_H */