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