include/linux/phy.h

   1 /*
   2  * include/linux/phy.h
   3  *
   4  * Framework and drivers for configuring and reading different PHYs
   5  * Based on code in sungem_phy.c and gianfar_phy.c
   6  *
   7  * Author: Andy Fleming
   8  *
   9  * Copyright (c) 2004 Freescale Semiconductor, Inc.
  10  *
  11  * This program is free software; you can redistribute  it and/or modify it
  12  * under  the terms of  the GNU General  Public License as published by the
  13  * Free Software Foundation;  either version 2 of the  License, or (at your
  14  * option) any later version.
  15  *
  16  */
  17
  18 #ifndef __PHY_H
  19 #define __PHY_H
  20
  21 #include <linux/spinlock.h>
  22 #include <linux/device.h>
  23 #include <linux/ethtool.h>
  24 #include <linux/mii.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_BASIC_FEATURES      (SUPPORTED_10baseT_Half | \
  32                                  SUPPORTED_10baseT_Full | \
  33                                  SUPPORTED_100baseT_Half | \
  34                                  SUPPORTED_100baseT_Full | \
  35                                  SUPPORTED_Autoneg | \
  36                                  SUPPORTED_TP | \
  37                                  SUPPORTED_MII)
  38
  39 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
  40                                  SUPPORTED_1000baseT_Half | \
  41                                  SUPPORTED_1000baseT_Full)
  42
  43 /*
  44  * Set phydev->irq to PHY_POLL if interrupts are not supported,
  45  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
  46  * the attached driver handles the interrupt
  47  */
  48 #define PHY_POLL                -1
  49 #define PHY_IGNORE_INTERRUPT    -2
  50
  51 #define PHY_HAS_INTERRUPT       0x00000001
  52 #define PHY_HAS_MAGICANEG       0x00000002
  53
  54 /* Interface Mode definitions */
  55 typedef enum {
  56         PHY_INTERFACE_MODE_MII,
  57         PHY_INTERFACE_MODE_GMII,
  58         PHY_INTERFACE_MODE_SGMII,
  59         PHY_INTERFACE_MODE_TBI,
  60         PHY_INTERFACE_MODE_RMII,
  61         PHY_INTERFACE_MODE_RGMII,
  62         PHY_INTERFACE_MODE_RGMII_ID,
  63         PHY_INTERFACE_MODE_RGMII_RXID,
  64         PHY_INTERFACE_MODE_RGMII_TXID,
  65         PHY_INTERFACE_MODE_RTBI
  66 } phy_interface_t;
  67
  68
  69 #define PHY_INIT_TIMEOUT        100000
  70 #define PHY_STATE_TIME          1
  71 #define PHY_FORCE_TIMEOUT       10
  72 #define PHY_AN_TIMEOUT          10
  73
  74 #define PHY_MAX_ADDR    32
  75
  76 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
  77 #define PHY_ID_FMT "%s:%02x"
  78
  79 /*
  80  * Need to be a little smaller than phydev->dev.bus_id to leave room
  81  * for the ":%02x"
  82  */
  83 #define MII_BUS_ID_SIZE (20 - 3)
  84
  85 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
  86    IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
  87 #define MII_ADDR_C45 (1<<30)
  88
  89 /*
  90  * The Bus class for PHYs.  Devices which provide access to
  91  * PHYs should register using this structure
  92  */
  93 struct mii_bus {
  94         const char *name;
  95         char id[MII_BUS_ID_SIZE];
  96         void *priv;
  97         int (*read)(struct mii_bus *bus, int phy_id, int regnum);
  98         int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
  99         int (*reset)(struct mii_bus *bus);
 100
 101         /*
 102          * A lock to ensure that only one thing can read/write
 103          * the MDIO bus at a time
 104          */
 105         struct mutex mdio_lock;
 106
 107         struct device *parent;
 108         enum {
 109                 MDIOBUS_ALLOCATED = 1,
 110                 MDIOBUS_REGISTERED,
 111                 MDIOBUS_UNREGISTERED,
 112                 MDIOBUS_RELEASED,
 113         } state;
 114         struct device dev;
 115
 116         /* list of all PHYs on bus */
 117         struct phy_device *phy_map[PHY_MAX_ADDR];
 118
 119         /* PHY addresses to be ignored when probing */
 120         u32 phy_mask;
 121
 122         /*
 123          * Pointer to an array of interrupts, each PHY's
 124          * interrupt at the index matching its address
 125          */
 126         int *irq;
 127 };
 128 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
 129
 130 struct mii_bus *mdiobus_alloc(void);
 131 int mdiobus_register(struct mii_bus *bus);
 132 void mdiobus_unregister(struct mii_bus *bus);
 133 void mdiobus_free(struct mii_bus *bus);
 134 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
 135 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
 136 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
 137
 138
 139 #define PHY_INTERRUPT_DISABLED  0x0
 140 #define PHY_INTERRUPT_ENABLED   0x80000000
 141
 142 /* PHY state machine states:
 143  *
 144  * DOWN: PHY device and driver are not ready for anything.  probe
 145  * should be called if and only if the PHY is in this state,
 146  * given that the PHY device exists.
 147  * - PHY driver probe function will, depending on the PHY, set
 148  * the state to STARTING or READY
 149  *
 150  * STARTING:  PHY device is coming up, and the ethernet driver is
 151  * not ready.  PHY drivers may set this in the probe function.
 152  * If they do, they are responsible for making sure the state is
 153  * eventually set to indicate whether the PHY is UP or READY,
 154  * depending on the state when the PHY is done starting up.
 155  * - PHY driver will set the state to READY
 156  * - start will set the state to PENDING
 157  *
 158  * READY: PHY is ready to send and receive packets, but the
 159  * controller is not.  By default, PHYs which do not implement
 160  * probe will be set to this state by phy_probe().  If the PHY
 161  * driver knows the PHY is ready, and the PHY state is STARTING,
 162  * then it sets this STATE.
 163  * - start will set the state to UP
 164  *
 165  * PENDING: PHY device is coming up, but the ethernet driver is
 166  * ready.  phy_start will set this state if the PHY state is
 167  * STARTING.
 168  * - PHY driver will set the state to UP when the PHY is ready
 169  *
 170  * UP: The PHY and attached device are ready to do work.
 171  * Interrupts should be started here.
 172  * - timer moves to AN
 173  *
 174  * AN: The PHY is currently negotiating the link state.  Link is
 175  * therefore down for now.  phy_timer will set this state when it
 176  * detects the state is UP.  config_aneg will set this state
 177  * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
 178  * - If autonegotiation finishes, but there's no link, it sets
 179  *   the state to NOLINK.
 180  * - If aneg finishes with link, it sets the state to RUNNING,
 181  *   and calls adjust_link
 182  * - If autonegotiation did not finish after an arbitrary amount
 183  *   of time, autonegotiation should be tried again if the PHY
 184  *   supports "magic" autonegotiation (back to AN)
 185  * - If it didn't finish, and no magic_aneg, move to FORCING.
 186  *
 187  * NOLINK: PHY is up, but not currently plugged in.
 188  * - If the timer notes that the link comes back, we move to RUNNING
 189  * - config_aneg moves to AN
 190  * - phy_stop moves to HALTED
 191  *
 192  * FORCING: PHY is being configured with forced settings
 193  * - if link is up, move to RUNNING
 194  * - If link is down, we drop to the next highest setting, and
 195  *   retry (FORCING) after a timeout
 196  * - phy_stop moves to HALTED
 197  *
 198  * RUNNING: PHY is currently up, running, and possibly sending
 199  * and/or receiving packets
 200  * - timer will set CHANGELINK if we're polling (this ensures the
 201  *   link state is polled every other cycle of this state machine,
 202  *   which makes it every other second)
 203  * - irq will set CHANGELINK
 204  * - config_aneg will set AN
 205  * - phy_stop moves to HALTED
 206  *
 207  * CHANGELINK: PHY experienced a change in link state
 208  * - timer moves to RUNNING if link
 209  * - timer moves to NOLINK if the link is down
 210  * - phy_stop moves to HALTED
 211  *
 212  * HALTED: PHY is up, but no polling or interrupts are done. Or
 213  * PHY is in an error state.
 214  *
 215  * - phy_start moves to RESUMING
 216  *
 217  * RESUMING: PHY was halted, but now wants to run again.
 218  * - If we are forcing, or aneg is done, timer moves to RUNNING
 219  * - If aneg is not done, timer moves to AN
 220  * - phy_stop moves to HALTED
 221  */
 222 enum phy_state {
 223         PHY_DOWN=0,
 224         PHY_STARTING,
 225         PHY_READY,
 226         PHY_PENDING,
 227         PHY_UP,
 228         PHY_AN,
 229         PHY_RUNNING,
 230         PHY_NOLINK,
 231         PHY_FORCING,
 232         PHY_CHANGELINK,
 233         PHY_HALTED,
 234         PHY_RESUMING
 235 };
 236
 237 struct sk_buff;
 238
 239 /* phy_device: An instance of a PHY
 240  *
 241  * drv: Pointer to the driver for this PHY instance
 242  * bus: Pointer to the bus this PHY is on
 243  * dev: driver model device structure for this PHY
 244  * phy_id: UID for this device found during discovery
 245  * state: state of the PHY for management purposes
 246  * dev_flags: Device-specific flags used by the PHY driver.
 247  * addr: Bus address of PHY
 248  * link_timeout: The number of timer firings to wait before the
 249  * giving up on the current attempt at acquiring a link
 250  * irq: IRQ number of the PHY's interrupt (-1 if none)
 251  * phy_timer: The timer for handling the state machine
 252  * phy_queue: A work_queue for the interrupt
 253  * attached_dev: The attached enet driver's device instance ptr
 254  * adjust_link: Callback for the enet controller to respond to
 255  * changes in the link state.
 256  * adjust_state: Callback for the enet driver to respond to
 257  * changes in the state machine.
 258  *
 259  * speed, duplex, pause, supported, advertising, and
 260  * autoneg are used like in mii_if_info
 261  *
 262  * interrupts currently only supports enabled or disabled,
 263  * but could be changed in the future to support enabling
 264  * and disabling specific interrupts
 265  *
 266  * Contains some infrastructure for polling and interrupt
 267  * handling, as well as handling shifts in PHY hardware state
 268  */
 269 struct phy_device {
 270         /* Information about the PHY type */
 271         /* And management functions */
 272         struct phy_driver *drv;
 273
 274         struct mii_bus *bus;
 275
 276         struct device dev;
 277
 278         u32 phy_id;
 279
 280         enum phy_state state;
 281
 282         u32 dev_flags;
 283
 284         phy_interface_t interface;
 285
 286         /* Bus address of the PHY (0-31) */
 287         int addr;
 288
 289         /*
 290          * forced speed & duplex (no autoneg)
 291          * partner speed & duplex & pause (autoneg)
 292          */
 293         int speed;
 294         int duplex;
 295         int pause;
 296         int asym_pause;
 297
 298         /* The most recently read link state */
 299         int link;
 300
 301         /* Enabled Interrupts */
 302         u32 interrupts;
 303
 304         /* Union of PHY and Attached devices' supported modes */
 305         /* See mii.h for more info */
 306         u32 supported;
 307         u32 advertising;
 308
 309         int autoneg;
 310
 311         int link_timeout;
 312
 313         /*
 314          * Interrupt number for this PHY
 315          * -1 means no interrupt
 316          */
 317         int irq;
 318
 319         /* private data pointer */
 320         /* For use by PHYs to maintain extra state */
 321         void *priv;
 322
 323         /* Interrupt and Polling infrastructure */
 324         struct work_struct phy_queue;
 325         struct delayed_work state_queue;
 326         atomic_t irq_disable;
 327
 328         struct mutex lock;
 329
 330         struct net_device *attached_dev;
 331
 332         void (*adjust_link)(struct net_device *dev);
 333
 334         void (*adjust_state)(struct net_device *dev);
 335 };
 336 #define to_phy_device(d) container_of(d, struct phy_device, dev)
 337
 338 /* struct phy_driver: Driver structure for a particular PHY type
 339  *
 340  * phy_id: The result of reading the UID registers of this PHY
 341  *   type, and ANDing them with the phy_id_mask.  This driver
 342  *   only works for PHYs with IDs which match this field
 343  * name: The friendly name of this PHY type
 344  * phy_id_mask: Defines the important bits of the phy_id
 345  * features: A list of features (speed, duplex, etc) supported
 346  *   by this PHY
 347  * flags: A bitfield defining certain other features this PHY
 348  *   supports (like interrupts)
 349  *
 350  * The drivers must implement config_aneg and read_status.  All
 351  * other functions are optional. Note that none of these
 352  * functions should be called from interrupt time.  The goal is
 353  * for the bus read/write functions to be able to block when the
 354  * bus transaction is happening, and be freed up by an interrupt
 355  * (The MPC85xx has this ability, though it is not currently
 356  * supported in the driver).
 357  */
 358 struct phy_driver {
 359         u32 phy_id;
 360         char *name;
 361         unsigned int phy_id_mask;
 362         u32 features;
 363         u32 flags;
 364
 365         /*
 366          * Called to initialize the PHY,
 367          * including after a reset
 368          */
 369         int (*config_init)(struct phy_device *phydev);
 370
 371         /*
 372          * Called during discovery.  Used to set
 373          * up device-specific structures, if any
 374          */
 375         int (*probe)(struct phy_device *phydev);
 376
 377         /* PHY Power Management */
 378         int (*suspend)(struct phy_device *phydev);
 379         int (*resume)(struct phy_device *phydev);
 380
 381         /*
 382          * Configures the advertisement and resets
 383          * autonegotiation if phydev->autoneg is on,
 384          * forces the speed to the current settings in phydev
 385          * if phydev->autoneg is off
 386          */
 387         int (*config_aneg)(struct phy_device *phydev);
 388
 389         /* Determines the negotiated speed and duplex */
 390         int (*read_status)(struct phy_device *phydev);
 391
 392         /* Clears any pending interrupts */
 393         int (*ack_interrupt)(struct phy_device *phydev);
 394
 395         /* Enables or disables interrupts */
 396         int (*config_intr)(struct phy_device *phydev);
 397
 398         /*
 399          * Checks if the PHY generated an interrupt.
 400          * For multi-PHY devices with shared PHY interrupt pin
 401          */
 402         int (*did_interrupt)(struct phy_device *phydev);
 403
 404         /* Clears up any memory if needed */
 405         void (*remove)(struct phy_device *phydev);
 406
 407         /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
 408         int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
 409
 410         /*
 411          * Requests a Rx timestamp for 'skb'. If the skb is accepted,
 412          * the phy driver promises to deliver it using netif_rx() as
 413          * soon as a timestamp becomes available. One of the
 414          * PTP_CLASS_ values is passed in 'type'. The function must
 415          * return true if the skb is accepted for delivery.
 416          */
 417         bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 418
 419         /*
 420          * Requests a Tx timestamp for 'skb'. The phy driver promises
 421          * to deliver it to the socket's error queue as soon as a
 422          * timestamp becomes available. One of the PTP_CLASS_ values
 423          * is passed in 'type'.
 424          */
 425         void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
 426
 427         struct device_driver driver;
 428 };
 429 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
 430
 431 #define PHY_ANY_ID "MATCH ANY PHY"
 432 #define PHY_ANY_UID 0xffffffff
 433
 434 /* A Structure for boards to register fixups with the PHY Lib */
 435 struct phy_fixup {
 436         struct list_head list;
 437         char bus_id[20];
 438         u32 phy_uid;
 439         u32 phy_uid_mask;
 440         int (*run)(struct phy_device *phydev);
 441 };
 442
 443 /**
 444  * phy_read - Convenience function for reading a given PHY register
 445  * @phydev: the phy_device struct
 446  * @regnum: register number to read
 447  *
 448  * NOTE: MUST NOT be called from interrupt context,
 449  * because the bus read/write functions may wait for an interrupt
 450  * to conclude the operation.
 451  */
 452 static inline int phy_read(struct phy_device *phydev, u32 regnum)
 453 {
 454         return mdiobus_read(phydev->bus, phydev->addr, regnum);
 455 }
 456
 457 /**
 458  * phy_write - Convenience function for writing a given PHY register
 459  * @phydev: the phy_device struct
 460  * @regnum: register number to write
 461  * @val: value to write to @regnum
 462  *
 463  * NOTE: MUST NOT be called from interrupt context,
 464  * because the bus read/write functions may wait for an interrupt
 465  * to conclude the operation.
 466  */
 467 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
 468 {
 469         return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
 470 }
 471
 472 int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id);
 473 struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
 474 int phy_device_register(struct phy_device *phy);
 475 int phy_init_hw(struct phy_device *phydev);
 476 struct phy_device * phy_attach(struct net_device *dev,
 477                 const char *bus_id, u32 flags, phy_interface_t interface);
 478 struct phy_device *phy_find_first(struct mii_bus *bus);
 479 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 480                 void (*handler)(struct net_device *), u32 flags,
 481                 phy_interface_t interface);
 482 struct phy_device * phy_connect(struct net_device *dev, const char *bus_id,
 483                 void (*handler)(struct net_device *), u32 flags,
 484                 phy_interface_t interface);
 485 void phy_disconnect(struct phy_device *phydev);
 486 void phy_detach(struct phy_device *phydev);
 487 void phy_start(struct phy_device *phydev);
 488 void phy_stop(struct phy_device *phydev);
 489 int phy_start_aneg(struct phy_device *phydev);
 490
 491 int phy_stop_interrupts(struct phy_device *phydev);
 492
 493 static inline int phy_read_status(struct phy_device *phydev) {
 494         return phydev->drv->read_status(phydev);
 495 }
 496
 497 int genphy_restart_aneg(struct phy_device *phydev);
 498 int genphy_config_aneg(struct phy_device *phydev);
 499 int genphy_update_link(struct phy_device *phydev);
 500 int genphy_read_status(struct phy_device *phydev);
 501 int genphy_suspend(struct phy_device *phydev);
 502 int genphy_resume(struct phy_device *phydev);
 503 void phy_driver_unregister(struct phy_driver *drv);
 504 int phy_driver_register(struct phy_driver *new_driver);
 505 void phy_state_machine(struct work_struct *work);
 506 void phy_start_machine(struct phy_device *phydev,
 507                 void (*handler)(struct net_device *));
 508 void phy_stop_machine(struct phy_device *phydev);
 509 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 510 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 511 int phy_mii_ioctl(struct phy_device *phydev,
 512                 struct ifreq *ifr, int cmd);
 513 int phy_start_interrupts(struct phy_device *phydev);
 514 void phy_print_status(struct phy_device *phydev);
 515 void phy_device_free(struct phy_device *phydev);
 516
 517 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
 518                 int (*run)(struct phy_device *));
 519 int phy_register_fixup_for_id(const char *bus_id,
 520                 int (*run)(struct phy_device *));
 521 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
 522                 int (*run)(struct phy_device *));
 523 int phy_scan_fixups(struct phy_device *phydev);
 524
 525 int __init mdio_bus_init(void);
 526 void mdio_bus_exit(void);
 527
 528 extern struct bus_type mdio_bus_type;
 529 #endif /* __PHY_H */