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