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
  24 #define PHY_BASIC_FEATURES      (SUPPORTED_10baseT_Half | \
  25                                  SUPPORTED_10baseT_Full | \
  26                                  SUPPORTED_100baseT_Half | \
  27                                  SUPPORTED_100baseT_Full | \
  28                                  SUPPORTED_Autoneg | \
  29                                  SUPPORTED_TP | \
  30                                  SUPPORTED_MII)
  31
  32 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
  33                                  SUPPORTED_1000baseT_Half | \
  34                                  SUPPORTED_1000baseT_Full)
  35
  36 /* Set phydev->irq to PHY_POLL if interrupts are not supported,
  37  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
  38  * the attached driver handles the interrupt
  39  */
  40 #define PHY_POLL                -1
  41 #define PHY_IGNORE_INTERRUPT    -2
  42
  43 #define PHY_HAS_INTERRUPT       0x00000001
  44 #define PHY_HAS_MAGICANEG       0x00000002
  45
  46 #define MII_BUS_MAX 4
  47
  48
  49 #define PHY_INIT_TIMEOUT 100000
  50 #define PHY_STATE_TIME          1
  51 #define PHY_FORCE_TIMEOUT       10
  52 #define PHY_AN_TIMEOUT          10
  53
  54 #define PHY_MAX_ADDR 32
  55
  56 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
  57 #define PHY_ID_FMT "%x:%02x"
  58
  59 /* The Bus class for PHYs.  Devices which provide access to
  60  * PHYs should register using this structure */
  61 struct mii_bus {
  62         const char *name;
  63         int id;
  64         void *priv;
  65         int (*read)(struct mii_bus *bus, int phy_id, int regnum);
  66         int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
  67         int (*reset)(struct mii_bus *bus);
  68
  69         /* A lock to ensure that only one thing can read/write
  70          * the MDIO bus at a time */
  71         spinlock_t mdio_lock;
  72
  73         struct device *dev;
  74
  75         /* list of all PHYs on bus */
  76         struct phy_device *phy_map[PHY_MAX_ADDR];
  77
  78         /* Phy addresses to be ignored when probing */
  79         u32 phy_mask;
  80
  81         /* Pointer to an array of interrupts, each PHY's
  82          * interrupt at the index matching its address */
  83         int *irq;
  84 };
  85
  86 #define PHY_INTERRUPT_DISABLED 0x0
  87 #define PHY_INTERRUPT_ENABLED 0x80000000
  88
  89 /* PHY state machine states:
  90  *
  91  * DOWN: PHY device and driver are not ready for anything.  probe
  92  * should be called if and only if the PHY is in this state,
  93  * given that the PHY device exists.
  94  * - PHY driver probe function will, depending on the PHY, set
  95  * the state to STARTING or READY
  96  *
  97  * STARTING:  PHY device is coming up, and the ethernet driver is
  98  * not ready.  PHY drivers may set this in the probe function.
  99  * If they do, they are responsible for making sure the state is
 100  * eventually set to indicate whether the PHY is UP or READY,
 101  * depending on the state when the PHY is done starting up.
 102  * - PHY driver will set the state to READY
 103  * - start will set the state to PENDING
 104  *
 105  * READY: PHY is ready to send and receive packets, but the
 106  * controller is not.  By default, PHYs which do not implement
 107  * probe will be set to this state by phy_probe().  If the PHY
 108  * driver knows the PHY is ready, and the PHY state is STARTING,
 109  * then it sets this STATE.
 110  * - start will set the state to UP
 111  *
 112  * PENDING: PHY device is coming up, but the ethernet driver is
 113  * ready.  phy_start will set this state if the PHY state is
 114  * STARTING.
 115  * - PHY driver will set the state to UP when the PHY is ready
 116  *
 117  * UP: The PHY and attached device are ready to do work.
 118  * Interrupts should be started here.
 119  * - timer moves to AN
 120  *
 121  * AN: The PHY is currently negotiating the link state.  Link is
 122  * therefore down for now.  phy_timer will set this state when it
 123  * detects the state is UP.  config_aneg will set this state
 124  * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
 125  * - If autonegotiation finishes, but there's no link, it sets
 126  *   the state to NOLINK.
 127  * - If aneg finishes with link, it sets the state to RUNNING,
 128  *   and calls adjust_link
 129  * - If autonegotiation did not finish after an arbitrary amount
 130  *   of time, autonegotiation should be tried again if the PHY
 131  *   supports "magic" autonegotiation (back to AN)
 132  * - If it didn't finish, and no magic_aneg, move to FORCING.
 133  *
 134  * NOLINK: PHY is up, but not currently plugged in.
 135  * - If the timer notes that the link comes back, we move to RUNNING
 136  * - config_aneg moves to AN
 137  * - phy_stop moves to HALTED
 138  *
 139  * FORCING: PHY is being configured with forced settings
 140  * - if link is up, move to RUNNING
 141  * - If link is down, we drop to the next highest setting, and
 142  *   retry (FORCING) after a timeout
 143  * - phy_stop moves to HALTED
 144  *
 145  * RUNNING: PHY is currently up, running, and possibly sending
 146  * and/or receiving packets
 147  * - timer will set CHANGELINK if we're polling (this ensures the
 148  *   link state is polled every other cycle of this state machine,
 149  *   which makes it every other second)
 150  * - irq will set CHANGELINK
 151  * - config_aneg will set AN
 152  * - phy_stop moves to HALTED
 153  *
 154  * CHANGELINK: PHY experienced a change in link state
 155  * - timer moves to RUNNING if link
 156  * - timer moves to NOLINK if the link is down
 157  * - phy_stop moves to HALTED
 158  *
 159  * HALTED: PHY is up, but no polling or interrupts are done. Or
 160  * PHY is in an error state.
 161  *
 162  * - phy_start moves to RESUMING
 163  *
 164  * RESUMING: PHY was halted, but now wants to run again.
 165  * - If we are forcing, or aneg is done, timer moves to RUNNING
 166  * - If aneg is not done, timer moves to AN
 167  * - phy_stop moves to HALTED
 168  */
 169 enum phy_state {
 170         PHY_DOWN=0,
 171         PHY_STARTING,
 172         PHY_READY,
 173         PHY_PENDING,
 174         PHY_UP,
 175         PHY_AN,
 176         PHY_RUNNING,
 177         PHY_NOLINK,
 178         PHY_FORCING,
 179         PHY_CHANGELINK,
 180         PHY_HALTED,
 181         PHY_RESUMING
 182 };
 183
 184 /* phy_device: An instance of a PHY
 185  *
 186  * drv: Pointer to the driver for this PHY instance
 187  * bus: Pointer to the bus this PHY is on
 188  * dev: driver model device structure for this PHY
 189  * phy_id: UID for this device found during discovery
 190  * state: state of the PHY for management purposes
 191  * dev_flags: Device-specific flags used by the PHY driver.
 192  * addr: Bus address of PHY
 193  * link_timeout: The number of timer firings to wait before the
 194  * giving up on the current attempt at acquiring a link
 195  * irq: IRQ number of the PHY's interrupt (-1 if none)
 196  * phy_timer: The timer for handling the state machine
 197  * phy_queue: A work_queue for the interrupt
 198  * attached_dev: The attached enet driver's device instance ptr
 199  * adjust_link: Callback for the enet controller to respond to
 200  * changes in the link state.
 201  * adjust_state: Callback for the enet driver to respond to
 202  * changes in the state machine.
 203  *
 204  * speed, duplex, pause, supported, advertising, and
 205  * autoneg are used like in mii_if_info
 206  *
 207  * interrupts currently only supports enabled or disabled,
 208  * but could be changed in the future to support enabling
 209  * and disabling specific interrupts
 210  *
 211  * Contains some infrastructure for polling and interrupt
 212  * handling, as well as handling shifts in PHY hardware state
 213  */
 214 struct phy_device {
 215         /* Information about the PHY type */
 216         /* And management functions */
 217         struct phy_driver *drv;
 218
 219         struct mii_bus *bus;
 220
 221         struct device dev;
 222
 223         u32 phy_id;
 224
 225         enum phy_state state;
 226
 227         u32 dev_flags;
 228
 229         /* Bus address of the PHY (0-32) */
 230         int addr;
 231
 232         /* forced speed & duplex (no autoneg)
 233          * partner speed & duplex & pause (autoneg)
 234          */
 235         int speed;
 236         int duplex;
 237         int pause;
 238         int asym_pause;
 239
 240         /* The most recently read link state */
 241         int link;
 242
 243         /* Enabled Interrupts */
 244         u32 interrupts;
 245
 246         /* Union of PHY and Attached devices' supported modes */
 247         /* See mii.h for more info */
 248         u32 supported;
 249         u32 advertising;
 250
 251         int autoneg;
 252
 253         int link_timeout;
 254
 255         /* Interrupt number for this PHY
 256          * -1 means no interrupt */
 257         int irq;
 258
 259         /* private data pointer */
 260         /* For use by PHYs to maintain extra state */
 261         void *priv;
 262
 263         /* Interrupt and Polling infrastructure */
 264         struct work_struct phy_queue;
 265         struct timer_list phy_timer;
 266
 267         spinlock_t lock;
 268
 269         struct net_device *attached_dev;
 270
 271         void (*adjust_link)(struct net_device *dev);
 272
 273         void (*adjust_state)(struct net_device *dev);
 274 };
 275 #define to_phy_device(d) container_of(d, struct phy_device, dev)
 276
 277 /* struct phy_driver: Driver structure for a particular PHY type
 278  *
 279  * phy_id: The result of reading the UID registers of this PHY
 280  *   type, and ANDing them with the phy_id_mask.  This driver
 281  *   only works for PHYs with IDs which match this field
 282  * name: The friendly name of this PHY type
 283  * phy_id_mask: Defines the important bits of the phy_id
 284  * features: A list of features (speed, duplex, etc) supported
 285  *   by this PHY
 286  * flags: A bitfield defining certain other features this PHY
 287  *   supports (like interrupts)
 288  *
 289  * The drivers must implement config_aneg and read_status.  All
 290  * other functions are optional. Note that none of these
 291  * functions should be called from interrupt time.  The goal is
 292  * for the bus read/write functions to be able to block when the
 293  * bus transaction is happening, and be freed up by an interrupt
 294  * (The MPC85xx has this ability, though it is not currently
 295  * supported in the driver).
 296  */
 297 struct phy_driver {
 298         u32 phy_id;
 299         char *name;
 300         unsigned int phy_id_mask;
 301         u32 features;
 302         u32 flags;
 303
 304         /* Called to initialize the PHY,
 305          * including after a reset */
 306         int (*config_init)(struct phy_device *phydev);
 307
 308         /* Called during discovery.  Used to set
 309          * up device-specific structures, if any */
 310         int (*probe)(struct phy_device *phydev);
 311
 312         /* PHY Power Management */
 313         int (*suspend)(struct phy_device *phydev);
 314         int (*resume)(struct phy_device *phydev);
 315
 316         /* Configures the advertisement and resets
 317          * autonegotiation if phydev->autoneg is on,
 318          * forces the speed to the current settings in phydev
 319          * if phydev->autoneg is off */
 320         int (*config_aneg)(struct phy_device *phydev);
 321
 322         /* Determines the negotiated speed and duplex */
 323         int (*read_status)(struct phy_device *phydev);
 324
 325         /* Clears any pending interrupts */
 326         int (*ack_interrupt)(struct phy_device *phydev);
 327
 328         /* Enables or disables interrupts */
 329         int (*config_intr)(struct phy_device *phydev);
 330
 331         /* Clears up any memory if needed */
 332         void (*remove)(struct phy_device *phydev);
 333
 334         struct device_driver driver;
 335 };
 336 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
 337
 338 int phy_read(struct phy_device *phydev, u16 regnum);
 339 int phy_write(struct phy_device *phydev, u16 regnum, u16 val);
 340 struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
 341 int phy_clear_interrupt(struct phy_device *phydev);
 342 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts);
 343 struct phy_device * phy_attach(struct net_device *dev,
 344                 const char *phy_id, u32 flags);
 345 struct phy_device * phy_connect(struct net_device *dev, const char *phy_id,
 346                 void (*handler)(struct net_device *), u32 flags);
 347 void phy_disconnect(struct phy_device *phydev);
 348 void phy_detach(struct phy_device *phydev);
 349 void phy_start(struct phy_device *phydev);
 350 void phy_stop(struct phy_device *phydev);
 351 int phy_start_aneg(struct phy_device *phydev);
 352
 353 int mdiobus_register(struct mii_bus *bus);
 354 void mdiobus_unregister(struct mii_bus *bus);
 355 void phy_sanitize_settings(struct phy_device *phydev);
 356 int phy_stop_interrupts(struct phy_device *phydev);
 357
 358 static inline int phy_read_status(struct phy_device *phydev) {
 359         return phydev->drv->read_status(phydev);
 360 }
 361
 362 int genphy_config_advert(struct phy_device *phydev);
 363 int genphy_setup_forced(struct phy_device *phydev);
 364 int genphy_restart_aneg(struct phy_device *phydev);
 365 int genphy_config_aneg(struct phy_device *phydev);
 366 int genphy_update_link(struct phy_device *phydev);
 367 int genphy_read_status(struct phy_device *phydev);
 368 void phy_driver_unregister(struct phy_driver *drv);
 369 int phy_driver_register(struct phy_driver *new_driver);
 370 void phy_prepare_link(struct phy_device *phydev,
 371                 void (*adjust_link)(struct net_device *));
 372 void phy_start_machine(struct phy_device *phydev,
 373                 void (*handler)(struct net_device *));
 374 void phy_stop_machine(struct phy_device *phydev);
 375 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 376 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
 377 int phy_mii_ioctl(struct phy_device *phydev,
 378                 struct mii_ioctl_data *mii_data, int cmd);
 379 int phy_start_interrupts(struct phy_device *phydev);
 380 void phy_print_status(struct phy_device *phydev);
 381
 382 extern struct bus_type mdio_bus_type;
 383 #endif /* __PHY_H */