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/compiler.h> 20 #include <linux/spinlock.h> 21 #include <linux/ethtool.h> 22 #include <linux/mdio.h> 23 #include <linux/mii.h> 24 #include <linux/module.h> 25 #include <linux/timer.h> 26 #include <linux/workqueue.h> 27 #include <linux/mod_devicetable.h> 28 29 #include <linux/atomic.h> 30 31 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \ 32 SUPPORTED_TP | \ 33 SUPPORTED_MII) 34 35 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \ 36 SUPPORTED_10baseT_Full) 37 38 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \ 39 SUPPORTED_100baseT_Full) 40 41 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \ 42 SUPPORTED_1000baseT_Full) 43 44 #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \ 45 PHY_100BT_FEATURES | \ 46 PHY_DEFAULT_FEATURES) 47 48 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \ 49 PHY_1000BT_FEATURES) 50 51 52 /* 53 * Set phydev->irq to PHY_POLL if interrupts are not supported, 54 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if 55 * the attached driver handles the interrupt 56 */ 57 #define PHY_POLL -1 58 #define PHY_IGNORE_INTERRUPT -2 59 60 #define PHY_HAS_INTERRUPT 0x00000001 61 #define PHY_HAS_MAGICANEG 0x00000002 62 #define PHY_IS_INTERNAL 0x00000004 63 #define MDIO_DEVICE_IS_PHY 0x80000000 64 65 /* Interface Mode definitions */ 66 typedef enum { 67 PHY_INTERFACE_MODE_NA, 68 PHY_INTERFACE_MODE_MII, 69 PHY_INTERFACE_MODE_GMII, 70 PHY_INTERFACE_MODE_SGMII, 71 PHY_INTERFACE_MODE_TBI, 72 PHY_INTERFACE_MODE_REVMII, 73 PHY_INTERFACE_MODE_RMII, 74 PHY_INTERFACE_MODE_RGMII, 75 PHY_INTERFACE_MODE_RGMII_ID, 76 PHY_INTERFACE_MODE_RGMII_RXID, 77 PHY_INTERFACE_MODE_RGMII_TXID, 78 PHY_INTERFACE_MODE_RTBI, 79 PHY_INTERFACE_MODE_SMII, 80 PHY_INTERFACE_MODE_XGMII, 81 PHY_INTERFACE_MODE_MOCA, 82 PHY_INTERFACE_MODE_QSGMII, 83 PHY_INTERFACE_MODE_MAX, 84 } phy_interface_t; 85 86 /** 87 * It maps 'enum phy_interface_t' found in include/linux/phy.h 88 * into the device tree binding of 'phy-mode', so that Ethernet 89 * device driver can get phy interface from device tree. 90 */ 91 static inline const char *phy_modes(phy_interface_t interface) 92 { 93 switch (interface) { 94 case PHY_INTERFACE_MODE_NA: 95 return ""; 96 case PHY_INTERFACE_MODE_MII: 97 return "mii"; 98 case PHY_INTERFACE_MODE_GMII: 99 return "gmii"; 100 case PHY_INTERFACE_MODE_SGMII: 101 return "sgmii"; 102 case PHY_INTERFACE_MODE_TBI: 103 return "tbi"; 104 case PHY_INTERFACE_MODE_REVMII: 105 return "rev-mii"; 106 case PHY_INTERFACE_MODE_RMII: 107 return "rmii"; 108 case PHY_INTERFACE_MODE_RGMII: 109 return "rgmii"; 110 case PHY_INTERFACE_MODE_RGMII_ID: 111 return "rgmii-id"; 112 case PHY_INTERFACE_MODE_RGMII_RXID: 113 return "rgmii-rxid"; 114 case PHY_INTERFACE_MODE_RGMII_TXID: 115 return "rgmii-txid"; 116 case PHY_INTERFACE_MODE_RTBI: 117 return "rtbi"; 118 case PHY_INTERFACE_MODE_SMII: 119 return "smii"; 120 case PHY_INTERFACE_MODE_XGMII: 121 return "xgmii"; 122 case PHY_INTERFACE_MODE_MOCA: 123 return "moca"; 124 case PHY_INTERFACE_MODE_QSGMII: 125 return "qsgmii"; 126 default: 127 return "unknown"; 128 } 129 } 130 131 132 #define PHY_INIT_TIMEOUT 100000 133 #define PHY_STATE_TIME 1 134 #define PHY_FORCE_TIMEOUT 10 135 #define PHY_AN_TIMEOUT 10 136 137 #define PHY_MAX_ADDR 32 138 139 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */ 140 #define PHY_ID_FMT "%s:%02x" 141 142 /* 143 * Need to be a little smaller than phydev->dev.bus_id to leave room 144 * for the ":%02x" 145 */ 146 #define MII_BUS_ID_SIZE (20 - 3) 147 148 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit 149 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */ 150 #define MII_ADDR_C45 (1<<30) 151 152 struct device; 153 struct sk_buff; 154 155 /* 156 * The Bus class for PHYs. Devices which provide access to 157 * PHYs should register using this structure 158 */ 159 struct mii_bus { 160 struct module *owner; 161 const char *name; 162 char id[MII_BUS_ID_SIZE]; 163 void *priv; 164 int (*read)(struct mii_bus *bus, int addr, int regnum); 165 int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val); 166 int (*reset)(struct mii_bus *bus); 167 168 /* 169 * A lock to ensure that only one thing can read/write 170 * the MDIO bus at a time 171 */ 172 struct mutex mdio_lock; 173 174 struct device *parent; 175 enum { 176 MDIOBUS_ALLOCATED = 1, 177 MDIOBUS_REGISTERED, 178 MDIOBUS_UNREGISTERED, 179 MDIOBUS_RELEASED, 180 } state; 181 struct device dev; 182 183 /* list of all PHYs on bus */ 184 struct mdio_device *mdio_map[PHY_MAX_ADDR]; 185 186 /* PHY addresses to be ignored when probing */ 187 u32 phy_mask; 188 189 /* PHY addresses to ignore the TA/read failure */ 190 u32 phy_ignore_ta_mask; 191 192 /* 193 * An array of interrupts, each PHY's interrupt at the index 194 * matching its address 195 */ 196 int irq[PHY_MAX_ADDR]; 197 }; 198 #define to_mii_bus(d) container_of(d, struct mii_bus, dev) 199 200 struct mii_bus *mdiobus_alloc_size(size_t); 201 static inline struct mii_bus *mdiobus_alloc(void) 202 { 203 return mdiobus_alloc_size(0); 204 } 205 206 int __mdiobus_register(struct mii_bus *bus, struct module *owner); 207 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE) 208 void mdiobus_unregister(struct mii_bus *bus); 209 void mdiobus_free(struct mii_bus *bus); 210 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv); 211 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev) 212 { 213 return devm_mdiobus_alloc_size(dev, 0); 214 } 215 216 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus); 217 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr); 218 219 #define PHY_INTERRUPT_DISABLED 0x0 220 #define PHY_INTERRUPT_ENABLED 0x80000000 221 222 /* PHY state machine states: 223 * 224 * DOWN: PHY device and driver are not ready for anything. probe 225 * should be called if and only if the PHY is in this state, 226 * given that the PHY device exists. 227 * - PHY driver probe function will, depending on the PHY, set 228 * the state to STARTING or READY 229 * 230 * STARTING: PHY device is coming up, and the ethernet driver is 231 * not ready. PHY drivers may set this in the probe function. 232 * If they do, they are responsible for making sure the state is 233 * eventually set to indicate whether the PHY is UP or READY, 234 * depending on the state when the PHY is done starting up. 235 * - PHY driver will set the state to READY 236 * - start will set the state to PENDING 237 * 238 * READY: PHY is ready to send and receive packets, but the 239 * controller is not. By default, PHYs which do not implement 240 * probe will be set to this state by phy_probe(). If the PHY 241 * driver knows the PHY is ready, and the PHY state is STARTING, 242 * then it sets this STATE. 243 * - start will set the state to UP 244 * 245 * PENDING: PHY device is coming up, but the ethernet driver is 246 * ready. phy_start will set this state if the PHY state is 247 * STARTING. 248 * - PHY driver will set the state to UP when the PHY is ready 249 * 250 * UP: The PHY and attached device are ready to do work. 251 * Interrupts should be started here. 252 * - timer moves to AN 253 * 254 * AN: The PHY is currently negotiating the link state. Link is 255 * therefore down for now. phy_timer will set this state when it 256 * detects the state is UP. config_aneg will set this state 257 * whenever called with phydev->autoneg set to AUTONEG_ENABLE. 258 * - If autonegotiation finishes, but there's no link, it sets 259 * the state to NOLINK. 260 * - If aneg finishes with link, it sets the state to RUNNING, 261 * and calls adjust_link 262 * - If autonegotiation did not finish after an arbitrary amount 263 * of time, autonegotiation should be tried again if the PHY 264 * supports "magic" autonegotiation (back to AN) 265 * - If it didn't finish, and no magic_aneg, move to FORCING. 266 * 267 * NOLINK: PHY is up, but not currently plugged in. 268 * - If the timer notes that the link comes back, we move to RUNNING 269 * - config_aneg moves to AN 270 * - phy_stop moves to HALTED 271 * 272 * FORCING: PHY is being configured with forced settings 273 * - if link is up, move to RUNNING 274 * - If link is down, we drop to the next highest setting, and 275 * retry (FORCING) after a timeout 276 * - phy_stop moves to HALTED 277 * 278 * RUNNING: PHY is currently up, running, and possibly sending 279 * and/or receiving packets 280 * - timer will set CHANGELINK if we're polling (this ensures the 281 * link state is polled every other cycle of this state machine, 282 * which makes it every other second) 283 * - irq will set CHANGELINK 284 * - config_aneg will set AN 285 * - phy_stop moves to HALTED 286 * 287 * CHANGELINK: PHY experienced a change in link state 288 * - timer moves to RUNNING if link 289 * - timer moves to NOLINK if the link is down 290 * - phy_stop moves to HALTED 291 * 292 * HALTED: PHY is up, but no polling or interrupts are done. Or 293 * PHY is in an error state. 294 * 295 * - phy_start moves to RESUMING 296 * 297 * RESUMING: PHY was halted, but now wants to run again. 298 * - If we are forcing, or aneg is done, timer moves to RUNNING 299 * - If aneg is not done, timer moves to AN 300 * - phy_stop moves to HALTED 301 */ 302 enum phy_state { 303 PHY_DOWN = 0, 304 PHY_STARTING, 305 PHY_READY, 306 PHY_PENDING, 307 PHY_UP, 308 PHY_AN, 309 PHY_RUNNING, 310 PHY_NOLINK, 311 PHY_FORCING, 312 PHY_CHANGELINK, 313 PHY_HALTED, 314 PHY_RESUMING 315 }; 316 317 /** 318 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers 319 * @devices_in_package: Bit vector of devices present. 320 * @device_ids: The device identifer for each present device. 321 */ 322 struct phy_c45_device_ids { 323 u32 devices_in_package; 324 u32 device_ids[8]; 325 }; 326 327 /* phy_device: An instance of a PHY 328 * 329 * drv: Pointer to the driver for this PHY instance 330 * bus: Pointer to the bus this PHY is on 331 * dev: driver model device structure for this PHY 332 * phy_id: UID for this device found during discovery 333 * c45_ids: 802.3-c45 Device Identifers if is_c45. 334 * is_c45: Set to true if this phy uses clause 45 addressing. 335 * is_internal: Set to true if this phy is internal to a MAC. 336 * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc. 337 * has_fixups: Set to true if this phy has fixups/quirks. 338 * suspended: Set to true if this phy has been suspended successfully. 339 * state: state of the PHY for management purposes 340 * dev_flags: Device-specific flags used by the PHY driver. 341 * addr: Bus address of PHY 342 * link_timeout: The number of timer firings to wait before the 343 * giving up on the current attempt at acquiring a link 344 * irq: IRQ number of the PHY's interrupt (-1 if none) 345 * phy_timer: The timer for handling the state machine 346 * phy_queue: A work_queue for the interrupt 347 * attached_dev: The attached enet driver's device instance ptr 348 * adjust_link: Callback for the enet controller to respond to 349 * changes in the link state. 350 * 351 * speed, duplex, pause, supported, advertising, lp_advertising, 352 * and autoneg are used like in mii_if_info 353 * 354 * interrupts currently only supports enabled or disabled, 355 * but could be changed in the future to support enabling 356 * and disabling specific interrupts 357 * 358 * Contains some infrastructure for polling and interrupt 359 * handling, as well as handling shifts in PHY hardware state 360 */ 361 struct phy_device { 362 struct mdio_device mdio; 363 364 /* Information about the PHY type */ 365 /* And management functions */ 366 struct phy_driver *drv; 367 368 u32 phy_id; 369 370 struct phy_c45_device_ids c45_ids; 371 bool is_c45; 372 bool is_internal; 373 bool is_pseudo_fixed_link; 374 bool has_fixups; 375 bool suspended; 376 377 enum phy_state state; 378 379 u32 dev_flags; 380 381 phy_interface_t interface; 382 383 /* 384 * forced speed & duplex (no autoneg) 385 * partner speed & duplex & pause (autoneg) 386 */ 387 int speed; 388 int duplex; 389 int pause; 390 int asym_pause; 391 392 /* The most recently read link state */ 393 int link; 394 395 /* Enabled Interrupts */ 396 u32 interrupts; 397 398 /* Union of PHY and Attached devices' supported modes */ 399 /* See mii.h for more info */ 400 u32 supported; 401 u32 advertising; 402 u32 lp_advertising; 403 404 int autoneg; 405 406 int link_timeout; 407 408 /* 409 * Interrupt number for this PHY 410 * -1 means no interrupt 411 */ 412 int irq; 413 414 /* private data pointer */ 415 /* For use by PHYs to maintain extra state */ 416 void *priv; 417 418 /* Interrupt and Polling infrastructure */ 419 struct work_struct phy_queue; 420 struct delayed_work state_queue; 421 atomic_t irq_disable; 422 423 struct mutex lock; 424 425 struct net_device *attached_dev; 426 427 u8 mdix; 428 429 void (*adjust_link)(struct net_device *dev); 430 }; 431 #define to_phy_device(d) container_of(to_mdio_device(d), \ 432 struct phy_device, mdio) 433 434 /* struct phy_driver: Driver structure for a particular PHY type 435 * 436 * driver_data: static driver data 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 * 447 * The drivers must implement config_aneg and read_status. All 448 * other functions are optional. Note that none of these 449 * functions should be called from interrupt time. The goal is 450 * for the bus read/write functions to be able to block when the 451 * bus transaction is happening, and be freed up by an interrupt 452 * (The MPC85xx has this ability, though it is not currently 453 * supported in the driver). 454 */ 455 struct phy_driver { 456 struct mdio_driver_common mdiodrv; 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 /* Get statistics from the phy using ethtool */ 588 int (*get_sset_count)(struct phy_device *dev); 589 void (*get_strings)(struct phy_device *dev, u8 *data); 590 void (*get_stats)(struct phy_device *dev, 591 struct ethtool_stats *stats, u64 *data); 592 }; 593 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \ 594 struct phy_driver, mdiodrv) 595 596 #define PHY_ANY_ID "MATCH ANY PHY" 597 #define PHY_ANY_UID 0xffffffff 598 599 /* A Structure for boards to register fixups with the PHY Lib */ 600 struct phy_fixup { 601 struct list_head list; 602 char bus_id[20]; 603 u32 phy_uid; 604 u32 phy_uid_mask; 605 int (*run)(struct phy_device *phydev); 606 }; 607 608 /** 609 * phy_read_mmd - Convenience function for reading a register 610 * from an MMD on a given PHY. 611 * @phydev: The phy_device struct 612 * @devad: The MMD to read from 613 * @regnum: The register on the MMD to read 614 * 615 * Same rules as for phy_read(); 616 */ 617 static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum) 618 { 619 if (!phydev->is_c45) 620 return -EOPNOTSUPP; 621 622 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, 623 MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff)); 624 } 625 626 /** 627 * phy_read_mmd_indirect - reads data from the MMD registers 628 * @phydev: The PHY device bus 629 * @prtad: MMD Address 630 * @addr: PHY address on the MII bus 631 * 632 * Description: it reads data from the MMD registers (clause 22 to access to 633 * clause 45) of the specified phy address. 634 */ 635 int phy_read_mmd_indirect(struct phy_device *phydev, int prtad, int devad); 636 637 /** 638 * phy_read - Convenience function for reading a given PHY register 639 * @phydev: the phy_device struct 640 * @regnum: register number to read 641 * 642 * NOTE: MUST NOT be called from interrupt context, 643 * because the bus read/write functions may wait for an interrupt 644 * to conclude the operation. 645 */ 646 static inline int phy_read(struct phy_device *phydev, u32 regnum) 647 { 648 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); 649 } 650 651 /** 652 * phy_write - Convenience function for writing a given PHY register 653 * @phydev: the phy_device struct 654 * @regnum: register number to write 655 * @val: value to write to @regnum 656 * 657 * NOTE: MUST NOT be called from interrupt context, 658 * because the bus read/write functions may wait for an interrupt 659 * to conclude the operation. 660 */ 661 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) 662 { 663 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val); 664 } 665 666 /** 667 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq 668 * @phydev: the phy_device struct 669 * 670 * NOTE: must be kept in sync with addition/removal of PHY_POLL and 671 * PHY_IGNORE_INTERRUPT 672 */ 673 static inline bool phy_interrupt_is_valid(struct phy_device *phydev) 674 { 675 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT; 676 } 677 678 /** 679 * phy_is_internal - Convenience function for testing if a PHY is internal 680 * @phydev: the phy_device struct 681 */ 682 static inline bool phy_is_internal(struct phy_device *phydev) 683 { 684 return phydev->is_internal; 685 } 686 687 /** 688 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface 689 * is RGMII (all variants) 690 * @phydev: the phy_device struct 691 */ 692 static inline bool phy_interface_is_rgmii(struct phy_device *phydev) 693 { 694 return phydev->interface >= PHY_INTERFACE_MODE_RGMII && 695 phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID; 696 }; 697 698 /* 699 * phy_is_pseudo_fixed_link - Convenience function for testing if this 700 * PHY is the CPU port facing side of an Ethernet switch, or similar. 701 * @phydev: the phy_device struct 702 */ 703 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev) 704 { 705 return phydev->is_pseudo_fixed_link; 706 } 707 708 /** 709 * phy_write_mmd - Convenience function for writing a register 710 * on an MMD on a given PHY. 711 * @phydev: The phy_device struct 712 * @devad: The MMD to read from 713 * @regnum: The register on the MMD to read 714 * @val: value to write to @regnum 715 * 716 * Same rules as for phy_write(); 717 */ 718 static inline int phy_write_mmd(struct phy_device *phydev, int devad, 719 u32 regnum, u16 val) 720 { 721 if (!phydev->is_c45) 722 return -EOPNOTSUPP; 723 724 regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff); 725 726 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val); 727 } 728 729 /** 730 * phy_write_mmd_indirect - writes data to the MMD registers 731 * @phydev: The PHY device 732 * @prtad: MMD Address 733 * @devad: MMD DEVAD 734 * @data: data to write in the MMD register 735 * 736 * Description: Write data from the MMD registers of the specified 737 * phy address. 738 */ 739 void phy_write_mmd_indirect(struct phy_device *phydev, int prtad, 740 int devad, u32 data); 741 742 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id, 743 bool is_c45, 744 struct phy_c45_device_ids *c45_ids); 745 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); 746 int phy_device_register(struct phy_device *phy); 747 void phy_device_remove(struct phy_device *phydev); 748 int phy_init_hw(struct phy_device *phydev); 749 int phy_suspend(struct phy_device *phydev); 750 int phy_resume(struct phy_device *phydev); 751 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, 752 phy_interface_t interface); 753 struct phy_device *phy_find_first(struct mii_bus *bus); 754 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, 755 u32 flags, phy_interface_t interface); 756 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, 757 void (*handler)(struct net_device *), 758 phy_interface_t interface); 759 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, 760 void (*handler)(struct net_device *), 761 phy_interface_t interface); 762 void phy_disconnect(struct phy_device *phydev); 763 void phy_detach(struct phy_device *phydev); 764 void phy_start(struct phy_device *phydev); 765 void phy_stop(struct phy_device *phydev); 766 int phy_start_aneg(struct phy_device *phydev); 767 768 int phy_stop_interrupts(struct phy_device *phydev); 769 770 static inline int phy_read_status(struct phy_device *phydev) 771 { 772 return phydev->drv->read_status(phydev); 773 } 774 775 #define phydev_err(_phydev, format, args...) \ 776 dev_err(&_phydev->mdio.dev, format, ##args) 777 778 #define phydev_dbg(_phydev, format, args...) \ 779 dev_dbg(&_phydev->mdio.dev, format, ##args); 780 781 static inline const char *phydev_name(const struct phy_device *phydev) 782 { 783 return dev_name(&phydev->mdio.dev); 784 } 785 786 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...) 787 __printf(2, 3); 788 void phy_attached_info(struct phy_device *phydev); 789 int genphy_config_init(struct phy_device *phydev); 790 int genphy_setup_forced(struct phy_device *phydev); 791 int genphy_restart_aneg(struct phy_device *phydev); 792 int genphy_config_aneg(struct phy_device *phydev); 793 int genphy_aneg_done(struct phy_device *phydev); 794 int genphy_update_link(struct phy_device *phydev); 795 int genphy_read_status(struct phy_device *phydev); 796 int genphy_suspend(struct phy_device *phydev); 797 int genphy_resume(struct phy_device *phydev); 798 int genphy_soft_reset(struct phy_device *phydev); 799 void phy_driver_unregister(struct phy_driver *drv); 800 void phy_drivers_unregister(struct phy_driver *drv, int n); 801 int phy_driver_register(struct phy_driver *new_driver, struct module *owner); 802 int phy_drivers_register(struct phy_driver *new_driver, int n, 803 struct module *owner); 804 void phy_state_machine(struct work_struct *work); 805 void phy_change(struct work_struct *work); 806 void phy_mac_interrupt(struct phy_device *phydev, int new_link); 807 void phy_start_machine(struct phy_device *phydev); 808 void phy_stop_machine(struct phy_device *phydev); 809 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd); 810 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd); 811 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); 812 int phy_start_interrupts(struct phy_device *phydev); 813 void phy_print_status(struct phy_device *phydev); 814 void phy_device_free(struct phy_device *phydev); 815 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed); 816 817 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, 818 int (*run)(struct phy_device *)); 819 int phy_register_fixup_for_id(const char *bus_id, 820 int (*run)(struct phy_device *)); 821 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, 822 int (*run)(struct phy_device *)); 823 824 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); 825 int phy_get_eee_err(struct phy_device *phydev); 826 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); 827 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); 828 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); 829 void phy_ethtool_get_wol(struct phy_device *phydev, 830 struct ethtool_wolinfo *wol); 831 832 int __init mdio_bus_init(void); 833 void mdio_bus_exit(void); 834 835 extern struct bus_type mdio_bus_type; 836 837 /** 838 * module_phy_driver() - Helper macro for registering PHY drivers 839 * @__phy_drivers: array of PHY drivers to register 840 * 841 * Helper macro for PHY drivers which do not do anything special in module 842 * init/exit. Each module may only use this macro once, and calling it 843 * replaces module_init() and module_exit(). 844 */ 845 #define phy_module_driver(__phy_drivers, __count) \ 846 static int __init phy_module_init(void) \ 847 { \ 848 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \ 849 } \ 850 module_init(phy_module_init); \ 851 static void __exit phy_module_exit(void) \ 852 { \ 853 phy_drivers_unregister(__phy_drivers, __count); \ 854 } \ 855 module_exit(phy_module_exit) 856 857 #define module_phy_driver(__phy_drivers) \ 858 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) 859 860 #endif /* __PHY_H */ 861