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 /* Interface Mode definitions */ 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 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */ 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 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit 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 /* list of all PHYs on bus */ 179 struct phy_device *phy_map[PHY_MAX_ADDR]; 180 181 /* PHY addresses to be ignored when probing */ 182 u32 phy_mask; 183 184 /* PHY addresses to ignore the TA/read failure */ 185 u32 phy_ignore_ta_mask; 186 187 /* 188 * Pointer to an array of interrupts, each PHY's 189 * interrupt at the index matching its address 190 */ 191 int *irq; 192 }; 193 #define to_mii_bus(d) container_of(d, struct mii_bus, dev) 194 195 struct mii_bus *mdiobus_alloc_size(size_t); 196 static inline struct mii_bus *mdiobus_alloc(void) 197 { 198 return mdiobus_alloc_size(0); 199 } 200 201 int mdiobus_register(struct mii_bus *bus); 202 void mdiobus_unregister(struct mii_bus *bus); 203 void mdiobus_free(struct mii_bus *bus); 204 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv); 205 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev) 206 { 207 return devm_mdiobus_alloc_size(dev, 0); 208 } 209 210 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus); 211 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr); 212 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum); 213 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val); 214 215 216 #define PHY_INTERRUPT_DISABLED 0x0 217 #define PHY_INTERRUPT_ENABLED 0x80000000 218 219 /* PHY state machine states: 220 * 221 * DOWN: PHY device and driver are not ready for anything. probe 222 * should be called if and only if the PHY is in this state, 223 * given that the PHY device exists. 224 * - PHY driver probe function will, depending on the PHY, set 225 * the state to STARTING or READY 226 * 227 * STARTING: PHY device is coming up, and the ethernet driver is 228 * not ready. PHY drivers may set this in the probe function. 229 * If they do, they are responsible for making sure the state is 230 * eventually set to indicate whether the PHY is UP or READY, 231 * depending on the state when the PHY is done starting up. 232 * - PHY driver will set the state to READY 233 * - start will set the state to PENDING 234 * 235 * READY: PHY is ready to send and receive packets, but the 236 * controller is not. By default, PHYs which do not implement 237 * probe will be set to this state by phy_probe(). If the PHY 238 * driver knows the PHY is ready, and the PHY state is STARTING, 239 * then it sets this STATE. 240 * - start will set the state to UP 241 * 242 * PENDING: PHY device is coming up, but the ethernet driver is 243 * ready. phy_start will set this state if the PHY state is 244 * STARTING. 245 * - PHY driver will set the state to UP when the PHY is ready 246 * 247 * UP: The PHY and attached device are ready to do work. 248 * Interrupts should be started here. 249 * - timer moves to AN 250 * 251 * AN: The PHY is currently negotiating the link state. Link is 252 * therefore down for now. phy_timer will set this state when it 253 * detects the state is UP. config_aneg will set this state 254 * whenever called with phydev->autoneg set to AUTONEG_ENABLE. 255 * - If autonegotiation finishes, but there's no link, it sets 256 * the state to NOLINK. 257 * - If aneg finishes with link, it sets the state to RUNNING, 258 * and calls adjust_link 259 * - If autonegotiation did not finish after an arbitrary amount 260 * of time, autonegotiation should be tried again if the PHY 261 * supports "magic" autonegotiation (back to AN) 262 * - If it didn't finish, and no magic_aneg, move to FORCING. 263 * 264 * NOLINK: PHY is up, but not currently plugged in. 265 * - If the timer notes that the link comes back, we move to RUNNING 266 * - config_aneg moves to AN 267 * - phy_stop moves to HALTED 268 * 269 * FORCING: PHY is being configured with forced settings 270 * - if link is up, move to RUNNING 271 * - If link is down, we drop to the next highest setting, and 272 * retry (FORCING) after a timeout 273 * - phy_stop moves to HALTED 274 * 275 * RUNNING: PHY is currently up, running, and possibly sending 276 * and/or receiving packets 277 * - timer will set CHANGELINK if we're polling (this ensures the 278 * link state is polled every other cycle of this state machine, 279 * which makes it every other second) 280 * - irq will set CHANGELINK 281 * - config_aneg will set AN 282 * - phy_stop moves to HALTED 283 * 284 * CHANGELINK: PHY experienced a change in link state 285 * - timer moves to RUNNING if link 286 * - timer moves to NOLINK if the link is down 287 * - phy_stop moves to HALTED 288 * 289 * HALTED: PHY is up, but no polling or interrupts are done. Or 290 * PHY is in an error state. 291 * 292 * - phy_start moves to RESUMING 293 * 294 * RESUMING: PHY was halted, but now wants to run again. 295 * - If we are forcing, or aneg is done, timer moves to RUNNING 296 * - If aneg is not done, timer moves to AN 297 * - phy_stop moves to HALTED 298 */ 299 enum phy_state { 300 PHY_DOWN = 0, 301 PHY_STARTING, 302 PHY_READY, 303 PHY_PENDING, 304 PHY_UP, 305 PHY_AN, 306 PHY_RUNNING, 307 PHY_NOLINK, 308 PHY_FORCING, 309 PHY_CHANGELINK, 310 PHY_HALTED, 311 PHY_RESUMING 312 }; 313 314 /** 315 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers 316 * @devices_in_package: Bit vector of devices present. 317 * @device_ids: The device identifer for each present device. 318 */ 319 struct phy_c45_device_ids { 320 u32 devices_in_package; 321 u32 device_ids[8]; 322 }; 323 324 /* phy_device: An instance of a PHY 325 * 326 * drv: Pointer to the driver for this PHY instance 327 * bus: Pointer to the bus this PHY is on 328 * dev: driver model device structure for this PHY 329 * phy_id: UID for this device found during discovery 330 * c45_ids: 802.3-c45 Device Identifers if is_c45. 331 * is_c45: Set to true if this phy uses clause 45 addressing. 332 * is_internal: Set to true if this phy is internal to a MAC. 333 * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc. 334 * has_fixups: Set to true if this phy has fixups/quirks. 335 * suspended: Set to true if this phy has been suspended successfully. 336 * state: state of the PHY for management purposes 337 * dev_flags: Device-specific flags used by the PHY driver. 338 * addr: Bus address of PHY 339 * link_timeout: The number of timer firings to wait before the 340 * giving up on the current attempt at acquiring a link 341 * irq: IRQ number of the PHY's interrupt (-1 if none) 342 * phy_timer: The timer for handling the state machine 343 * phy_queue: A work_queue for the interrupt 344 * attached_dev: The attached enet driver's device instance ptr 345 * adjust_link: Callback for the enet controller to respond to 346 * changes in the link state. 347 * 348 * speed, duplex, pause, supported, advertising, lp_advertising, 349 * and autoneg are used like in mii_if_info 350 * 351 * interrupts currently only supports enabled or disabled, 352 * but could be changed in the future to support enabling 353 * and disabling specific interrupts 354 * 355 * Contains some infrastructure for polling and interrupt 356 * handling, as well as handling shifts in PHY hardware state 357 */ 358 struct phy_device { 359 /* Information about the PHY type */ 360 /* And management functions */ 361 struct phy_driver *drv; 362 363 struct mii_bus *bus; 364 365 struct device dev; 366 367 u32 phy_id; 368 369 struct phy_c45_device_ids c45_ids; 370 bool is_c45; 371 bool is_internal; 372 bool is_pseudo_fixed_link; 373 bool has_fixups; 374 bool suspended; 375 376 enum phy_state state; 377 378 u32 dev_flags; 379 380 phy_interface_t interface; 381 382 /* Bus address of the PHY (0-31) */ 383 int addr; 384 385 /* 386 * forced speed & duplex (no autoneg) 387 * partner speed & duplex & pause (autoneg) 388 */ 389 int speed; 390 int duplex; 391 int pause; 392 int asym_pause; 393 394 /* The most recently read link state */ 395 int link; 396 397 /* Enabled Interrupts */ 398 u32 interrupts; 399 400 /* Union of PHY and Attached devices' supported modes */ 401 /* See mii.h for more info */ 402 u32 supported; 403 u32 advertising; 404 u32 lp_advertising; 405 406 int autoneg; 407 408 int link_timeout; 409 410 /* 411 * Interrupt number for this PHY 412 * -1 means no interrupt 413 */ 414 int irq; 415 416 /* private data pointer */ 417 /* For use by PHYs to maintain extra state */ 418 void *priv; 419 420 /* Interrupt and Polling infrastructure */ 421 struct work_struct phy_queue; 422 struct delayed_work state_queue; 423 atomic_t irq_disable; 424 425 struct mutex lock; 426 427 struct net_device *attached_dev; 428 429 u8 mdix; 430 431 void (*adjust_link)(struct net_device *dev); 432 }; 433 #define to_phy_device(d) container_of(d, struct phy_device, dev) 434 435 /* struct phy_driver: Driver structure for a particular PHY type 436 * 437 * phy_id: The result of reading the UID registers of this PHY 438 * type, and ANDing them with the phy_id_mask. This driver 439 * only works for PHYs with IDs which match this field 440 * name: The friendly name of this PHY type 441 * phy_id_mask: Defines the important bits of the phy_id 442 * features: A list of features (speed, duplex, etc) supported 443 * by this PHY 444 * flags: A bitfield defining certain other features this PHY 445 * supports (like interrupts) 446 * driver_data: static driver data 447 * 448 * The drivers must implement config_aneg and read_status. All 449 * other functions are optional. Note that none of these 450 * functions should be called from interrupt time. The goal is 451 * for the bus read/write functions to be able to block when the 452 * bus transaction is happening, and be freed up by an interrupt 453 * (The MPC85xx has this ability, though it is not currently 454 * supported in the driver). 455 */ 456 struct phy_driver { 457 u32 phy_id; 458 char *name; 459 unsigned int phy_id_mask; 460 u32 features; 461 u32 flags; 462 const void *driver_data; 463 464 /* 465 * Called to issue a PHY software reset 466 */ 467 int (*soft_reset)(struct phy_device *phydev); 468 469 /* 470 * Called to initialize the PHY, 471 * including after a reset 472 */ 473 int (*config_init)(struct phy_device *phydev); 474 475 /* 476 * Called during discovery. Used to set 477 * up device-specific structures, if any 478 */ 479 int (*probe)(struct phy_device *phydev); 480 481 /* PHY Power Management */ 482 int (*suspend)(struct phy_device *phydev); 483 int (*resume)(struct phy_device *phydev); 484 485 /* 486 * Configures the advertisement and resets 487 * autonegotiation if phydev->autoneg is on, 488 * forces the speed to the current settings in phydev 489 * if phydev->autoneg is off 490 */ 491 int (*config_aneg)(struct phy_device *phydev); 492 493 /* Determines the auto negotiation result */ 494 int (*aneg_done)(struct phy_device *phydev); 495 496 /* Determines the negotiated speed and duplex */ 497 int (*read_status)(struct phy_device *phydev); 498 499 /* Clears any pending interrupts */ 500 int (*ack_interrupt)(struct phy_device *phydev); 501 502 /* Enables or disables interrupts */ 503 int (*config_intr)(struct phy_device *phydev); 504 505 /* 506 * Checks if the PHY generated an interrupt. 507 * For multi-PHY devices with shared PHY interrupt pin 508 */ 509 int (*did_interrupt)(struct phy_device *phydev); 510 511 /* Clears up any memory if needed */ 512 void (*remove)(struct phy_device *phydev); 513 514 /* Returns true if this is a suitable driver for the given 515 * phydev. If NULL, matching is based on phy_id and 516 * phy_id_mask. 517 */ 518 int (*match_phy_device)(struct phy_device *phydev); 519 520 /* Handles ethtool queries for hardware time stamping. */ 521 int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti); 522 523 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */ 524 int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr); 525 526 /* 527 * Requests a Rx timestamp for 'skb'. If the skb is accepted, 528 * the phy driver promises to deliver it using netif_rx() as 529 * soon as a timestamp becomes available. One of the 530 * PTP_CLASS_ values is passed in 'type'. The function must 531 * return true if the skb is accepted for delivery. 532 */ 533 bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); 534 535 /* 536 * Requests a Tx timestamp for 'skb'. The phy driver promises 537 * to deliver it using skb_complete_tx_timestamp() as soon as a 538 * timestamp becomes available. One of the PTP_CLASS_ values 539 * is passed in 'type'. 540 */ 541 void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); 542 543 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to 544 * enable Wake on LAN, so set_wol is provided to be called in the 545 * ethernet driver's set_wol function. */ 546 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); 547 548 /* See set_wol, but for checking whether Wake on LAN is enabled. */ 549 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); 550 551 /* 552 * Called to inform a PHY device driver when the core is about to 553 * change the link state. This callback is supposed to be used as 554 * fixup hook for drivers that need to take action when the link 555 * state changes. Drivers are by no means allowed to mess with the 556 * PHY device structure in their implementations. 557 */ 558 void (*link_change_notify)(struct phy_device *dev); 559 560 /* A function provided by a phy specific driver to override the 561 * the PHY driver framework support for reading a MMD register 562 * from the PHY. If not supported, return -1. This function is 563 * optional for PHY specific drivers, if not provided then the 564 * default MMD read function is used by the PHY framework. 565 */ 566 int (*read_mmd_indirect)(struct phy_device *dev, int ptrad, 567 int devnum, int regnum); 568 569 /* A function provided by a phy specific driver to override the 570 * the PHY driver framework support for writing a MMD register 571 * from the PHY. This function is optional for PHY specific drivers, 572 * if not provided then the default MMD read function is used by 573 * the PHY framework. 574 */ 575 void (*write_mmd_indirect)(struct phy_device *dev, int ptrad, 576 int devnum, int regnum, u32 val); 577 578 /* Get the size and type of the eeprom contained within a plug-in 579 * module */ 580 int (*module_info)(struct phy_device *dev, 581 struct ethtool_modinfo *modinfo); 582 583 /* Get the eeprom information from the plug-in module */ 584 int (*module_eeprom)(struct phy_device *dev, 585 struct ethtool_eeprom *ee, u8 *data); 586 587 struct device_driver driver; 588 }; 589 #define to_phy_driver(d) container_of(d, struct phy_driver, driver) 590 591 #define PHY_ANY_ID "MATCH ANY PHY" 592 #define PHY_ANY_UID 0xffffffff 593 594 /* A Structure for boards to register fixups with the PHY Lib */ 595 struct phy_fixup { 596 struct list_head list; 597 char bus_id[20]; 598 u32 phy_uid; 599 u32 phy_uid_mask; 600 int (*run)(struct phy_device *phydev); 601 }; 602 603 /** 604 * phy_read_mmd - Convenience function for reading a register 605 * from an MMD on a given PHY. 606 * @phydev: The phy_device struct 607 * @devad: The MMD to read from 608 * @regnum: The register on the MMD to read 609 * 610 * Same rules as for phy_read(); 611 */ 612 static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum) 613 { 614 if (!phydev->is_c45) 615 return -EOPNOTSUPP; 616 617 return mdiobus_read(phydev->bus, phydev->addr, 618 MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff)); 619 } 620 621 /** 622 * phy_read_mmd_indirect - reads data from the MMD registers 623 * @phydev: The PHY device bus 624 * @prtad: MMD Address 625 * @devad: MMD DEVAD 626 * @addr: PHY address on the MII bus 627 * 628 * Description: it reads data from the MMD registers (clause 22 to access to 629 * clause 45) of the specified phy address. 630 */ 631 int phy_read_mmd_indirect(struct phy_device *phydev, int prtad, 632 int devad, int addr); 633 634 /** 635 * phy_read - Convenience function for reading a given PHY register 636 * @phydev: the phy_device struct 637 * @regnum: register number to read 638 * 639 * NOTE: MUST NOT be called from interrupt context, 640 * because the bus read/write functions may wait for an interrupt 641 * to conclude the operation. 642 */ 643 static inline int phy_read(struct phy_device *phydev, u32 regnum) 644 { 645 return mdiobus_read(phydev->bus, phydev->addr, regnum); 646 } 647 648 /** 649 * phy_write - Convenience function for writing a given PHY register 650 * @phydev: the phy_device struct 651 * @regnum: register number to write 652 * @val: value to write to @regnum 653 * 654 * NOTE: MUST NOT be called from interrupt context, 655 * because the bus read/write functions may wait for an interrupt 656 * to conclude the operation. 657 */ 658 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) 659 { 660 return mdiobus_write(phydev->bus, phydev->addr, regnum, val); 661 } 662 663 /** 664 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq 665 * @phydev: the phy_device struct 666 * 667 * NOTE: must be kept in sync with addition/removal of PHY_POLL and 668 * PHY_IGNORE_INTERRUPT 669 */ 670 static inline bool phy_interrupt_is_valid(struct phy_device *phydev) 671 { 672 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT; 673 } 674 675 /** 676 * phy_is_internal - Convenience function for testing if a PHY is internal 677 * @phydev: the phy_device struct 678 */ 679 static inline bool phy_is_internal(struct phy_device *phydev) 680 { 681 return phydev->is_internal; 682 } 683 684 /** 685 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface 686 * is RGMII (all variants) 687 * @phydev: the phy_device struct 688 */ 689 static inline bool phy_interface_is_rgmii(struct phy_device *phydev) 690 { 691 return phydev->interface >= PHY_INTERFACE_MODE_RGMII && 692 phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID; 693 }; 694 695 /* 696 * phy_is_pseudo_fixed_link - Convenience function for testing if this 697 * PHY is the CPU port facing side of an Ethernet switch, or similar. 698 * @phydev: the phy_device struct 699 */ 700 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev) 701 { 702 return phydev->is_pseudo_fixed_link; 703 } 704 705 /** 706 * phy_write_mmd - Convenience function for writing a register 707 * on an MMD on a given PHY. 708 * @phydev: The phy_device struct 709 * @devad: The MMD to read from 710 * @regnum: The register on the MMD to read 711 * @val: value to write to @regnum 712 * 713 * Same rules as for phy_write(); 714 */ 715 static inline int phy_write_mmd(struct phy_device *phydev, int devad, 716 u32 regnum, u16 val) 717 { 718 if (!phydev->is_c45) 719 return -EOPNOTSUPP; 720 721 regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff); 722 723 return mdiobus_write(phydev->bus, phydev->addr, regnum, val); 724 } 725 726 /** 727 * phy_write_mmd_indirect - writes data to the MMD registers 728 * @phydev: The PHY device 729 * @prtad: MMD Address 730 * @devad: MMD DEVAD 731 * @addr: PHY address on the MII bus 732 * @data: data to write in the MMD register 733 * 734 * Description: Write data from the MMD registers of the specified 735 * phy address. 736 */ 737 void phy_write_mmd_indirect(struct phy_device *phydev, int prtad, 738 int devad, int addr, u32 data); 739 740 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id, 741 bool is_c45, 742 struct phy_c45_device_ids *c45_ids); 743 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); 744 int phy_device_register(struct phy_device *phy); 745 int phy_init_hw(struct phy_device *phydev); 746 int phy_suspend(struct phy_device *phydev); 747 int phy_resume(struct phy_device *phydev); 748 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, 749 phy_interface_t interface); 750 struct phy_device *phy_find_first(struct mii_bus *bus); 751 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, 752 u32 flags, phy_interface_t interface); 753 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, 754 void (*handler)(struct net_device *), 755 phy_interface_t interface); 756 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, 757 void (*handler)(struct net_device *), 758 phy_interface_t interface); 759 void phy_disconnect(struct phy_device *phydev); 760 void phy_detach(struct phy_device *phydev); 761 void phy_start(struct phy_device *phydev); 762 void phy_stop(struct phy_device *phydev); 763 int phy_start_aneg(struct phy_device *phydev); 764 765 int phy_stop_interrupts(struct phy_device *phydev); 766 767 static inline int phy_read_status(struct phy_device *phydev) 768 { 769 return phydev->drv->read_status(phydev); 770 } 771 772 int genphy_config_init(struct phy_device *phydev); 773 int genphy_setup_forced(struct phy_device *phydev); 774 int genphy_restart_aneg(struct phy_device *phydev); 775 int genphy_config_aneg(struct phy_device *phydev); 776 int genphy_aneg_done(struct phy_device *phydev); 777 int genphy_update_link(struct phy_device *phydev); 778 int genphy_read_status(struct phy_device *phydev); 779 int genphy_suspend(struct phy_device *phydev); 780 int genphy_resume(struct phy_device *phydev); 781 int genphy_soft_reset(struct phy_device *phydev); 782 void phy_driver_unregister(struct phy_driver *drv); 783 void phy_drivers_unregister(struct phy_driver *drv, int n); 784 int phy_driver_register(struct phy_driver *new_driver); 785 int phy_drivers_register(struct phy_driver *new_driver, int n); 786 void phy_state_machine(struct work_struct *work); 787 void phy_change(struct work_struct *work); 788 void phy_mac_interrupt(struct phy_device *phydev, int new_link); 789 void phy_start_machine(struct phy_device *phydev); 790 void phy_stop_machine(struct phy_device *phydev); 791 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd); 792 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd); 793 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); 794 int phy_start_interrupts(struct phy_device *phydev); 795 void phy_print_status(struct phy_device *phydev); 796 void phy_device_free(struct phy_device *phydev); 797 798 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, 799 int (*run)(struct phy_device *)); 800 int phy_register_fixup_for_id(const char *bus_id, 801 int (*run)(struct phy_device *)); 802 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, 803 int (*run)(struct phy_device *)); 804 805 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); 806 int phy_get_eee_err(struct phy_device *phydev); 807 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); 808 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); 809 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); 810 void phy_ethtool_get_wol(struct phy_device *phydev, 811 struct ethtool_wolinfo *wol); 812 813 int __init mdio_bus_init(void); 814 void mdio_bus_exit(void); 815 816 extern struct bus_type mdio_bus_type; 817 818 /** 819 * module_phy_driver() - Helper macro for registering PHY drivers 820 * @__phy_drivers: array of PHY drivers to register 821 * 822 * Helper macro for PHY drivers which do not do anything special in module 823 * init/exit. Each module may only use this macro once, and calling it 824 * replaces module_init() and module_exit(). 825 */ 826 #define phy_module_driver(__phy_drivers, __count) \ 827 static int __init phy_module_init(void) \ 828 { \ 829 return phy_drivers_register(__phy_drivers, __count); \ 830 } \ 831 module_init(phy_module_init); \ 832 static void __exit phy_module_exit(void) \ 833 { \ 834 phy_drivers_unregister(__phy_drivers, __count); \ 835 } \ 836 module_exit(phy_module_exit) 837 838 #define module_phy_driver(__phy_drivers) \ 839 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) 840 841 #endif /* __PHY_H */ 842