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