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