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