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