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