| 1 | |
| 2 | * Framework and drivers for configuring and reading different PHYs
|
| 3 | * Based on code in sungem_phy.c and gianfar_phy.c
|
| 4 | *
|
| 5 | * Author: Andy Fleming
|
| 6 | *
|
| 7 | * Copyright (c) 2004 Freescale Semiconductor, Inc.
|
| 8 | *
|
| 9 | * This program is free software; you can redistribute it and/or modify it
|
| 10 | * under the terms of the GNU General Public License as published by the
|
| 11 | * Free Software Foundation; either version 2 of the License, or (at your
|
| 12 | * option) any later version.
|
| 13 | *
|
| 14 |
|
| 15 |
|
| 16 | #ifndef __PHY_H
|
| 17 | #define __PHY_H
|
| 18 |
|
| 19 | #include <linux/spinlock.h>
|
| 20 | #include <linux/ethtool.h>
|
| 21 | #include <linux/mii.h>
|
| 22 | #include <linux/timer.h>
|
| 23 | #include <linux/workqueue.h>
|
| 24 | #include <linux/mod_devicetable.h>
|
| 25 |
|
| 26 | #include <linux/atomic.h>
|
| 27 |
|
| 28 | #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
|
| 29 | SUPPORTED_TP | \
|
| 30 | SUPPORTED_MII)
|
| 31 |
|
| 32 | #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
|
| 33 | SUPPORTED_10baseT_Full)
|
| 34 |
|
| 35 | #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
|
| 36 | SUPPORTED_100baseT_Full)
|
| 37 |
|
| 38 | #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
|
| 39 | SUPPORTED_1000baseT_Full)
|
| 40 |
|
| 41 | #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
|
| 42 | PHY_100BT_FEATURES | \
|
| 43 | PHY_DEFAULT_FEATURES)
|
| 44 |
|
| 45 | #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
|
| 46 | PHY_1000BT_FEATURES)
|
| 47 |
|
| 48 |
|
| 49 | |
| 50 | * Set phydev->irq to PHY_POLL if interrupts are not supported,
|
| 51 | * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
|
| 52 | * the attached driver handles the interrupt
|
| 53 |
|
| 54 | #define PHY_POLL -1
|
| 55 | #define PHY_IGNORE_INTERRUPT -2
|
| 56 |
|
| 57 | #define PHY_HAS_INTERRUPT 0x00000001
|
| 58 | #define PHY_HAS_MAGICANEG 0x00000002
|
| 59 | #define PHY_IS_INTERNAL 0x00000004
|
| 60 |
|
| 61 |
|
| 62 | typedef enum {
|
| 63 | PHY_INTERFACE_MODE_NA,
|
| 64 | PHY_INTERFACE_MODE_MII,
|
| 65 | PHY_INTERFACE_MODE_GMII,
|
| 66 | PHY_INTERFACE_MODE_SGMII,
|
| 67 | PHY_INTERFACE_MODE_TBI,
|
| 68 | PHY_INTERFACE_MODE_REVMII,
|
| 69 | PHY_INTERFACE_MODE_RMII,
|
| 70 | PHY_INTERFACE_MODE_RGMII,
|
| 71 | PHY_INTERFACE_MODE_RGMII_ID,
|
| 72 | PHY_INTERFACE_MODE_RGMII_RXID,
|
| 73 | PHY_INTERFACE_MODE_RGMII_TXID,
|
| 74 | PHY_INTERFACE_MODE_RTBI,
|
| 75 | PHY_INTERFACE_MODE_SMII,
|
| 76 | PHY_INTERFACE_MODE_XGMII,
|
| 77 | PHY_INTERFACE_MODE_MOCA,
|
| 78 | PHY_INTERFACE_MODE_QSGMII,
|
| 79 | PHY_INTERFACE_MODE_MAX,
|
| 80 | } phy_interface_t;
|
| 81 |
|
| 82 | |
| 83 | * It maps 'enum phy_interface_t' found in include/linux/phy.h
|
| 84 | * into the device tree binding of 'phy-mode', so that Ethernet
|
| 85 | * device driver can get phy interface from device tree.
|
| 86 |
|
| 87 | static inline const char *phy_modes(phy_interface_t interface)
|
| 88 | {
|
| 89 | switch (interface) {
|
| 90 | case PHY_INTERFACE_MODE_NA:
|
| 91 | return "";
|
| 92 | case PHY_INTERFACE_MODE_MII:
|
| 93 | return "mii";
|
| 94 | case PHY_INTERFACE_MODE_GMII:
|
| 95 | return "gmii";
|
| 96 | case PHY_INTERFACE_MODE_SGMII:
|
| 97 | return "sgmii";
|
| 98 | case PHY_INTERFACE_MODE_TBI:
|
| 99 | return "tbi";
|
| 100 | case PHY_INTERFACE_MODE_REVMII:
|
| 101 | return "rev-mii";
|
| 102 | case PHY_INTERFACE_MODE_RMII:
|
| 103 | return "rmii";
|
| 104 | case PHY_INTERFACE_MODE_RGMII:
|
| 105 | return "rgmii";
|
| 106 | case PHY_INTERFACE_MODE_RGMII_ID:
|
| 107 | return "rgmii-id";
|
| 108 | case PHY_INTERFACE_MODE_RGMII_RXID:
|
| 109 | return "rgmii-rxid";
|
| 110 | case PHY_INTERFACE_MODE_RGMII_TXID:
|
| 111 | return "rgmii-txid";
|
| 112 | case PHY_INTERFACE_MODE_RTBI:
|
| 113 | return "rtbi";
|
| 114 | case PHY_INTERFACE_MODE_SMII:
|
| 115 | return "smii";
|
| 116 | case PHY_INTERFACE_MODE_XGMII:
|
| 117 | return "xgmii";
|
| 118 | case PHY_INTERFACE_MODE_MOCA:
|
| 119 | return "moca";
|
| 120 | case PHY_INTERFACE_MODE_QSGMII:
|
| 121 | return "qsgmii";
|
| 122 | default:
|
| 123 | return "unknown";
|
| 124 | }
|
| 125 | }
|
| 126 |
|
| 127 |
|
| 128 | #define PHY_INIT_TIMEOUT 100000
|
| 129 | #define PHY_STATE_TIME 1
|
| 130 | #define PHY_FORCE_TIMEOUT 10
|
| 131 | #define PHY_AN_TIMEOUT 10
|
| 132 |
|
| 133 | #define PHY_MAX_ADDR 32
|
| 134 |
|
| 135 |
|
| 136 | #define PHY_ID_FMT "%s:%02x"
|
| 137 |
|
| 138 | |
| 139 | * Need to be a little smaller than phydev->dev.bus_id to leave room
|
| 140 | * for the ":%02x"
|
| 141 |
|
| 142 | #define MII_BUS_ID_SIZE (20 - 3)
|
| 143 |
|
| 144 | |
| 145 | IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips.
|
| 146 | #define MII_ADDR_C45 (1<<30)
|
| 147 |
|
| 148 | struct device;
|
| 149 | struct sk_buff;
|
| 150 |
|
| 151 | |
| 152 | * The Bus class for PHYs. Devices which provide access to
|
| 153 | * PHYs should register using this structure
|
| 154 |
|
| 155 | struct mii_bus {
|
| 156 | const char *name;
|
| 157 | char id[MII_BUS_ID_SIZE];
|
| 158 | void *priv;
|
| 159 | int (*read)(struct mii_bus *bus, int phy_id, int regnum);
|
| 160 | int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
|
| 161 | int (*reset)(struct mii_bus *bus);
|
| 162 |
|
| 163 | |
| 164 | * A lock to ensure that only one thing can read/write
|
| 165 | * the MDIO bus at a time
|
| 166 |
|
| 167 | struct mutex mdio_lock;
|
| 168 |
|
| 169 | struct device *parent;
|
| 170 | enum {
|
| 171 | MDIOBUS_ALLOCATED = 1,
|
| 172 | MDIOBUS_REGISTERED,
|
| 173 | MDIOBUS_UNREGISTERED,
|
| 174 | MDIOBUS_RELEASED,
|
| 175 | } state;
|
| 176 | struct device dev;
|
| 177 |
|
| 178 |
|
| 179 | struct phy_device *phy_map[PHY_MAX_ADDR];
|
| 180 |
|
| 181 |
|
| 182 | u32 phy_mask;
|
| 183 |
|
| 184 | |
| 185 | * Pointer to an array of interrupts, each PHY's
|
| 186 | * interrupt at the index matching its address
|
| 187 |
|
| 188 | int *irq;
|
| 189 | };
|
| 190 | #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
|
| 191 |
|
| 192 | struct mii_bus *mdiobus_alloc_size(size_t);
|
| 193 | static inline struct mii_bus *mdiobus_alloc(void)
|
| 194 | {
|
| 195 | return mdiobus_alloc_size(0);
|
| 196 | }
|
| 197 |
|
| 198 | int mdiobus_register(struct mii_bus *bus);
|
| 199 | void mdiobus_unregister(struct mii_bus *bus);
|
| 200 | void mdiobus_free(struct mii_bus *bus);
|
| 201 | struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
|
| 202 | static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
|
| 203 | {
|
| 204 | return devm_mdiobus_alloc_size(dev, 0);
|
| 205 | }
|
| 206 |
|
| 207 | void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
|
| 208 | struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
|
| 209 | int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
|
| 210 | int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
|
| 211 |
|
| 212 |
|
| 213 | #define PHY_INTERRUPT_DISABLED 0x0
|
| 214 | #define PHY_INTERRUPT_ENABLED 0x80000000
|
| 215 |
|
| 216 | |
| 217 | *
|
| 218 | * DOWN: PHY device and driver are not ready for anything. probe
|
| 219 | * should be called if and only if the PHY is in this state,
|
| 220 | * given that the PHY device exists.
|
| 221 | * - PHY driver probe function will, depending on the PHY, set
|
| 222 | * the state to STARTING or READY
|
| 223 | *
|
| 224 | * STARTING: PHY device is coming up, and the ethernet driver is
|
| 225 | * not ready. PHY drivers may set this in the probe function.
|
| 226 | * If they do, they are responsible for making sure the state is
|
| 227 | * eventually set to indicate whether the PHY is UP or READY,
|
| 228 | * depending on the state when the PHY is done starting up.
|
| 229 | * - PHY driver will set the state to READY
|
| 230 | * - start will set the state to PENDING
|
| 231 | *
|
| 232 | * READY: PHY is ready to send and receive packets, but the
|
| 233 | * controller is not. By default, PHYs which do not implement
|
| 234 | * probe will be set to this state by phy_probe(). If the PHY
|
| 235 | * driver knows the PHY is ready, and the PHY state is STARTING,
|
| 236 | * then it sets this STATE.
|
| 237 | * - start will set the state to UP
|
| 238 | *
|
| 239 | * PENDING: PHY device is coming up, but the ethernet driver is
|
| 240 | * ready. phy_start will set this state if the PHY state is
|
| 241 | * STARTING.
|
| 242 | * - PHY driver will set the state to UP when the PHY is ready
|
| 243 | *
|
| 244 | * UP: The PHY and attached device are ready to do work.
|
| 245 | * Interrupts should be started here.
|
| 246 | * - timer moves to AN
|
| 247 | *
|
| 248 | * AN: The PHY is currently negotiating the link state. Link is
|
| 249 | * therefore down for now. phy_timer will set this state when it
|
| 250 | * detects the state is UP. config_aneg will set this state
|
| 251 | * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
|
| 252 | * - If autonegotiation finishes, but there's no link, it sets
|
| 253 | * the state to NOLINK.
|
| 254 | * - If aneg finishes with link, it sets the state to RUNNING,
|
| 255 | * and calls adjust_link
|
| 256 | * - If autonegotiation did not finish after an arbitrary amount
|
| 257 | * of time, autonegotiation should be tried again if the PHY
|
| 258 | * supports "magic" autonegotiation (back to AN)
|
| 259 | * - If it didn't finish, and no magic_aneg, move to FORCING.
|
| 260 | *
|
| 261 | * NOLINK: PHY is up, but not currently plugged in.
|
| 262 | * - If the timer notes that the link comes back, we move to RUNNING
|
| 263 | * - config_aneg moves to AN
|
| 264 | * - phy_stop moves to HALTED
|
| 265 | *
|
| 266 | * FORCING: PHY is being configured with forced settings
|
| 267 | * - if link is up, move to RUNNING
|
| 268 | * - If link is down, we drop to the next highest setting, and
|
| 269 | * retry (FORCING) after a timeout
|
| 270 | * - phy_stop moves to HALTED
|
| 271 | *
|
| 272 | * RUNNING: PHY is currently up, running, and possibly sending
|
| 273 | * and/or receiving packets
|
| 274 | * - timer will set CHANGELINK if we're polling (this ensures the
|
| 275 | * link state is polled every other cycle of this state machine,
|
| 276 | * which makes it every other second)
|
| 277 | * - irq will set CHANGELINK
|
| 278 | * - config_aneg will set AN
|
| 279 | * - phy_stop moves to HALTED
|
| 280 | *
|
| 281 | * CHANGELINK: PHY experienced a change in link state
|
| 282 | * - timer moves to RUNNING if link
|
| 283 | * - timer moves to NOLINK if the link is down
|
| 284 | * - phy_stop moves to HALTED
|
| 285 | *
|
| 286 | * HALTED: PHY is up, but no polling or interrupts are done. Or
|
| 287 | * PHY is in an error state.
|
| 288 | *
|
| 289 | * - phy_start moves to RESUMING
|
| 290 | *
|
| 291 | * RESUMING: PHY was halted, but now wants to run again.
|
| 292 | * - If we are forcing, or aneg is done, timer moves to RUNNING
|
| 293 | * - If aneg is not done, timer moves to AN
|
| 294 | * - phy_stop moves to HALTED
|
| 295 |
|
| 296 | enum phy_state {
|
| 297 | PHY_DOWN = 0,
|
| 298 | PHY_STARTING,
|
| 299 | PHY_READY,
|
| 300 | PHY_PENDING,
|
| 301 | PHY_UP,
|
| 302 | PHY_AN,
|
| 303 | PHY_RUNNING,
|
| 304 | PHY_NOLINK,
|
| 305 | PHY_FORCING,
|
| 306 | PHY_CHANGELINK,
|
| 307 | PHY_HALTED,
|
| 308 | PHY_RESUMING
|
| 309 | };
|
| 310 |
|
| 311 | |
| 312 | * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
|
| 313 | * @devices_in_package: Bit vector of devices present.
|
| 314 | * @device_ids: The device identifer for each present device.
|
| 315 |
|
| 316 | struct phy_c45_device_ids {
|
| 317 | u32 devices_in_package;
|
| 318 | u32 device_ids[8];
|
| 319 | };
|
| 320 |
|
| 321 | |
| 322 | *
|
| 323 | * drv: Pointer to the driver for this PHY instance
|
| 324 | * bus: Pointer to the bus this PHY is on
|
| 325 | * dev: driver model device structure for this PHY
|
| 326 | * phy_id: UID for this device found during discovery
|
| 327 | * c45_ids: 802.3-c45 Device Identifers if is_c45.
|
| 328 | * is_c45: Set to true if this phy uses clause 45 addressing.
|
| 329 | * is_internal: Set to true if this phy is internal to a MAC.
|
| 330 | * state: state of the PHY for management purposes
|
| 331 | * dev_flags: Device-specific flags used by the PHY driver.
|
| 332 | * addr: Bus address of PHY
|
| 333 | * link_timeout: The number of timer firings to wait before the
|
| 334 | * giving up on the current attempt at acquiring a link
|
| 335 | * irq: IRQ number of the PHY's interrupt (-1 if none)
|
| 336 | * phy_timer: The timer for handling the state machine
|
| 337 | * phy_queue: A work_queue for the interrupt
|
| 338 | * attached_dev: The attached enet driver's device instance ptr
|
| 339 | * adjust_link: Callback for the enet controller to respond to
|
| 340 | * changes in the link state.
|
| 341 | *
|
| 342 | * speed, duplex, pause, supported, advertising, lp_advertising,
|
| 343 | * and autoneg are used like in mii_if_info
|
| 344 | *
|
| 345 | * interrupts currently only supports enabled or disabled,
|
| 346 | * but could be changed in the future to support enabling
|
| 347 | * and disabling specific interrupts
|
| 348 | *
|
| 349 | * Contains some infrastructure for polling and interrupt
|
| 350 | * handling, as well as handling shifts in PHY hardware state
|
| 351 |
|
| 352 | struct phy_device {
|
| 353 |
|
| 354 |
|
| 355 | struct phy_driver *drv;
|
| 356 |
|
| 357 | struct mii_bus *bus;
|
| 358 |
|
| 359 | struct device dev;
|
| 360 |
|
| 361 | u32 phy_id;
|
| 362 |
|
| 363 | struct phy_c45_device_ids c45_ids;
|
| 364 | bool is_c45;
|
| 365 | bool is_internal;
|
| 366 | bool has_fixups;
|
| 367 |
|
| 368 | enum phy_state state;
|
| 369 |
|
| 370 | u32 dev_flags;
|
| 371 |
|
| 372 | phy_interface_t interface;
|
| 373 |
|
| 374 |
|
| 375 | int addr;
|
| 376 |
|
| 377 | |
| 378 | * forced speed & duplex (no autoneg)
|
| 379 | * partner speed & duplex & pause (autoneg)
|
| 380 |
|
| 381 | int speed;
|
| 382 | int duplex;
|
| 383 | int pause;
|
| 384 | int asym_pause;
|
| 385 |
|
| 386 |
|
| 387 | int link;
|
| 388 |
|
| 389 |
|
| 390 | u32 interrupts;
|
| 391 |
|
| 392 |
|
| 393 |
|
| 394 | u32 supported;
|
| 395 | u32 advertising;
|
| 396 | u32 lp_advertising;
|
| 397 |
|
| 398 | int autoneg;
|
| 399 |
|
| 400 | int link_timeout;
|
| 401 |
|
| 402 | |
| 403 | * Interrupt number for this PHY
|
| 404 | * -1 means no interrupt
|
| 405 |
|
| 406 | int irq;
|
| 407 |
|
| 408 |
|
| 409 |
|
| 410 | void *priv;
|
| 411 |
|
| 412 |
|
| 413 | struct work_struct phy_queue;
|
| 414 | struct delayed_work state_queue;
|
| 415 | atomic_t irq_disable;
|
| 416 |
|
| 417 | struct mutex lock;
|
| 418 |
|
| 419 | struct net_device *attached_dev;
|
| 420 |
|
| 421 | void (*adjust_link)(struct net_device *dev);
|
| 422 | };
|
| 423 | #define to_phy_device(d) container_of(d, struct phy_device, dev)
|
| 424 |
|
| 425 | |
| 426 | *
|
| 427 | * phy_id: The result of reading the UID registers of this PHY
|
| 428 | * type, and ANDing them with the phy_id_mask. This driver
|
| 429 | * only works for PHYs with IDs which match this field
|
| 430 | * name: The friendly name of this PHY type
|
| 431 | * phy_id_mask: Defines the important bits of the phy_id
|
| 432 | * features: A list of features (speed, duplex, etc) supported
|
| 433 | * by this PHY
|
| 434 | * flags: A bitfield defining certain other features this PHY
|
| 435 | * supports (like interrupts)
|
| 436 | *
|
| 437 | * The drivers must implement config_aneg and read_status. All
|
| 438 | * other functions are optional. Note that none of these
|
| 439 | * functions should be called from interrupt time. The goal is
|
| 440 | * for the bus read/write functions to be able to block when the
|
| 441 | * bus transaction is happening, and be freed up by an interrupt
|
| 442 | * (The MPC85xx has this ability, though it is not currently
|
| 443 | * supported in the driver).
|
| 444 |
|
| 445 | struct phy_driver {
|
| 446 | u32 phy_id;
|
| 447 | char *name;
|
| 448 | unsigned int phy_id_mask;
|
| 449 | u32 features;
|
| 450 | u32 flags;
|
| 451 |
|
| 452 | |
| 453 | * Called to issue a PHY software reset
|
| 454 |
|
| 455 | int (*soft_reset)(struct phy_device *phydev);
|
| 456 |
|
| 457 | |
| 458 | * Called to initialize the PHY,
|
| 459 | * including after a reset
|
| 460 |
|
| 461 | int (*config_init)(struct phy_device *phydev);
|
| 462 |
|
| 463 | |
| 464 | * Called during discovery. Used to set
|
| 465 | * up device-specific structures, if any
|
| 466 |
|
| 467 | int (*probe)(struct phy_device *phydev);
|
| 468 |
|
| 469 |
|
| 470 | int (*suspend)(struct phy_device *phydev);
|
| 471 | int (*resume)(struct phy_device *phydev);
|
| 472 |
|
| 473 | |
| 474 | * Configures the advertisement and resets
|
| 475 | * autonegotiation if phydev->autoneg is on,
|
| 476 | * forces the speed to the current settings in phydev
|
| 477 | * if phydev->autoneg is off
|
| 478 |
|
| 479 | int (*config_aneg)(struct phy_device *phydev);
|
| 480 |
|
| 481 |
|
| 482 | int (*aneg_done)(struct phy_device *phydev);
|
| 483 |
|
| 484 |
|
| 485 | int (*read_status)(struct phy_device *phydev);
|
| 486 |
|
| 487 |
|
| 488 | int (*ack_interrupt)(struct phy_device *phydev);
|
| 489 |
|
| 490 |
|
| 491 | int (*config_intr)(struct phy_device *phydev);
|
| 492 |
|
| 493 | |
| 494 | * Checks if the PHY generated an interrupt.
|
| 495 | * For multi-PHY devices with shared PHY interrupt pin
|
| 496 |
|
| 497 | int (*did_interrupt)(struct phy_device *phydev);
|
| 498 |
|
| 499 |
|
| 500 | void (*remove)(struct phy_device *phydev);
|
| 501 |
|
| 502 | |
| 503 | * phydev. If NULL, matching is based on phy_id and
|
| 504 | * phy_id_mask.
|
| 505 |
|
| 506 | int (*match_phy_device)(struct phy_device *phydev);
|
| 507 |
|
| 508 |
|
| 509 | int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
|
| 510 |
|
| 511 |
|
| 512 | int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
|
| 513 |
|
| 514 | |
| 515 | * Requests a Rx timestamp for 'skb'. If the skb is accepted,
|
| 516 | * the phy driver promises to deliver it using netif_rx() as
|
| 517 | * soon as a timestamp becomes available. One of the
|
| 518 | * PTP_CLASS_ values is passed in 'type'. The function must
|
| 519 | * return true if the skb is accepted for delivery.
|
| 520 |
|
| 521 | bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
|
| 522 |
|
| 523 | |
| 524 | * Requests a Tx timestamp for 'skb'. The phy driver promises
|
| 525 | * to deliver it using skb_complete_tx_timestamp() as soon as a
|
| 526 | * timestamp becomes available. One of the PTP_CLASS_ values
|
| 527 | * is passed in 'type'.
|
| 528 |
|
| 529 | void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
|
| 530 |
|
| 531 | |
| 532 | * enable Wake on LAN, so set_wol is provided to be called in the
|
| 533 | * ethernet driver's set_wol function.
|
| 534 | int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
|
| 535 |
|
| 536 |
|
| 537 | void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
|
| 538 |
|
| 539 | |
| 540 | * Called to inform a PHY device driver when the core is about to
|
| 541 | * change the link state. This callback is supposed to be used as
|
| 542 | * fixup hook for drivers that need to take action when the link
|
| 543 | * state changes. Drivers are by no means allowed to mess with the
|
| 544 | * PHY device structure in their implementations.
|
| 545 |
|
| 546 | void (*link_change_notify)(struct phy_device *dev);
|
| 547 |
|
| 548 | struct device_driver driver;
|
| 549 | };
|
| 550 | #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
|
| 551 |
|
| 552 | #define PHY_ANY_ID "MATCH ANY PHY"
|
| 553 | #define PHY_ANY_UID 0xffffffff
|
| 554 |
|
| 555 |
|
| 556 | struct phy_fixup {
|
| 557 | struct list_head list;
|
| 558 | char bus_id[20];
|
| 559 | u32 phy_uid;
|
| 560 | u32 phy_uid_mask;
|
| 561 | int (*run)(struct phy_device *phydev);
|
| 562 | };
|
| 563 |
|
| 564 | |
| 565 | * phy_read_mmd - Convenience function for reading a register
|
| 566 | * from an MMD on a given PHY.
|
| 567 | * @phydev: The phy_device struct
|
| 568 | * @devad: The MMD to read from
|
| 569 | * @regnum: The register on the MMD to read
|
| 570 | *
|
| 571 | * Same rules as for phy_read();
|
| 572 |
|
| 573 | static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum)
|
| 574 | {
|
| 575 | if (!phydev->is_c45)
|
| 576 | return -EOPNOTSUPP;
|
| 577 |
|
| 578 | return mdiobus_read(phydev->bus, phydev->addr,
|
| 579 | MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff));
|
| 580 | }
|
| 581 |
|
| 582 | |
| 583 | * phy_read - Convenience function for reading a given PHY register
|
| 584 | * @phydev: the phy_device struct
|
| 585 | * @regnum: register number to read
|
| 586 | *
|
| 587 | * NOTE: MUST NOT be called from interrupt context,
|
| 588 | * because the bus read/write functions may wait for an interrupt
|
| 589 | * to conclude the operation.
|
| 590 |
|
| 591 | static inline int phy_read(struct phy_device *phydev, u32 regnum)
|
| 592 | {
|
| 593 | return mdiobus_read(phydev->bus, phydev->addr, regnum);
|
| 594 | }
|
| 595 |
|
| 596 | |
| 597 | * phy_write - Convenience function for writing a given PHY register
|
| 598 | * @phydev: the phy_device struct
|
| 599 | * @regnum: register number to write
|
| 600 | * @val: value to write to @regnum
|
| 601 | *
|
| 602 | * NOTE: MUST NOT be called from interrupt context,
|
| 603 | * because the bus read/write functions may wait for an interrupt
|
| 604 | * to conclude the operation.
|
| 605 |
|
| 606 | static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
|
| 607 | {
|
| 608 | return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
|
| 609 | }
|
| 610 |
|
| 611 | |
| 612 | * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
|
| 613 | * @phydev: the phy_device struct
|
| 614 | *
|
| 615 | * NOTE: must be kept in sync with addition/removal of PHY_POLL and
|
| 616 | * PHY_IGNORE_INTERRUPT
|
| 617 |
|
| 618 | static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
|
| 619 | {
|
| 620 | return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
|
| 621 | }
|
| 622 |
|
| 623 | |
| 624 | * phy_is_internal - Convenience function for testing if a PHY is internal
|
| 625 | * @phydev: the phy_device struct
|
| 626 |
|
| 627 | static inline bool phy_is_internal(struct phy_device *phydev)
|
| 628 | {
|
| 629 | return phydev->is_internal;
|
| 630 | }
|
| 631 |
|
| 632 | |
| 633 | * phy_write_mmd - Convenience function for writing a register
|
| 634 | * on an MMD on a given PHY.
|
| 635 | * @phydev: The phy_device struct
|
| 636 | * @devad: The MMD to read from
|
| 637 | * @regnum: The register on the MMD to read
|
| 638 | * @val: value to write to @regnum
|
| 639 | *
|
| 640 | * Same rules as for phy_write();
|
| 641 |
|
| 642 | static inline int phy_write_mmd(struct phy_device *phydev, int devad,
|
| 643 | u32 regnum, u16 val)
|
| 644 | {
|
| 645 | if (!phydev->is_c45)
|
| 646 | return -EOPNOTSUPP;
|
| 647 |
|
| 648 | regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
|
| 649 |
|
| 650 | return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
|
| 651 | }
|
| 652 |
|
| 653 | struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
|
| 654 | bool is_c45,
|
| 655 | struct phy_c45_device_ids *c45_ids);
|
| 656 | struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
|
| 657 | int phy_device_register(struct phy_device *phy);
|
| 658 | int phy_init_hw(struct phy_device *phydev);
|
| 659 | int phy_suspend(struct phy_device *phydev);
|
| 660 | int phy_resume(struct phy_device *phydev);
|
| 661 | struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
|
| 662 | phy_interface_t interface);
|
| 663 | struct phy_device *phy_find_first(struct mii_bus *bus);
|
| 664 | int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
|
| 665 | u32 flags, phy_interface_t interface);
|
| 666 | int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
|
| 667 | void (*handler)(struct net_device *),
|
| 668 | phy_interface_t interface);
|
| 669 | struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
|
| 670 | void (*handler)(struct net_device *),
|
| 671 | phy_interface_t interface);
|
| 672 | void phy_disconnect(struct phy_device *phydev);
|
| 673 | void phy_detach(struct phy_device *phydev);
|
| 674 | void phy_start(struct phy_device *phydev);
|
| 675 | void phy_stop(struct phy_device *phydev);
|
| 676 | int phy_start_aneg(struct phy_device *phydev);
|
| 677 |
|
| 678 | int phy_stop_interrupts(struct phy_device *phydev);
|
| 679 |
|
| 680 | static inline int phy_read_status(struct phy_device *phydev)
|
| 681 | {
|
| 682 | return phydev->drv->read_status(phydev);
|
| 683 | }
|
| 684 |
|
| 685 | int genphy_config_init(struct phy_device *phydev);
|
| 686 | int genphy_setup_forced(struct phy_device *phydev);
|
| 687 | int genphy_restart_aneg(struct phy_device *phydev);
|
| 688 | int genphy_config_aneg(struct phy_device *phydev);
|
| 689 | int genphy_aneg_done(struct phy_device *phydev);
|
| 690 | int genphy_update_link(struct phy_device *phydev);
|
| 691 | int genphy_read_status(struct phy_device *phydev);
|
| 692 | int genphy_suspend(struct phy_device *phydev);
|
| 693 | int genphy_resume(struct phy_device *phydev);
|
| 694 | int genphy_soft_reset(struct phy_device *phydev);
|
| 695 | void phy_driver_unregister(struct phy_driver *drv);
|
| 696 | void phy_drivers_unregister(struct phy_driver *drv, int n);
|
| 697 | int phy_driver_register(struct phy_driver *new_driver);
|
| 698 | int phy_drivers_register(struct phy_driver *new_driver, int n);
|
| 699 | void phy_state_machine(struct work_struct *work);
|
| 700 | void phy_change(struct work_struct *work);
|
| 701 | void phy_mac_interrupt(struct phy_device *phydev, int new_link);
|
| 702 | void phy_start_machine(struct phy_device *phydev);
|
| 703 | void phy_stop_machine(struct phy_device *phydev);
|
| 704 | int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
|
| 705 | int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
|
| 706 | int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
|
| 707 | int phy_start_interrupts(struct phy_device *phydev);
|
| 708 | void phy_print_status(struct phy_device *phydev);
|
| 709 | void phy_device_free(struct phy_device *phydev);
|
| 710 |
|
| 711 | int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
|
| 712 | int (*run)(struct phy_device *));
|
| 713 | int phy_register_fixup_for_id(const char *bus_id,
|
| 714 | int (*run)(struct phy_device *));
|
| 715 | int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
|
| 716 | int (*run)(struct phy_device *));
|
| 717 |
|
| 718 | int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
|
| 719 | int phy_get_eee_err(struct phy_device *phydev);
|
| 720 | int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
|
| 721 | int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
|
| 722 | int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
|
| 723 | void phy_ethtool_get_wol(struct phy_device *phydev,
|
| 724 | struct ethtool_wolinfo *wol);
|
| 725 |
|
| 726 | int __init mdio_bus_init(void);
|
| 727 | void mdio_bus_exit(void);
|
| 728 |
|
| 729 | extern struct bus_type mdio_bus_type;
|
| 730 | #endif
|