1 /* 2 * Framework and drivers for configuring and reading different PHYs 3 * Based on code in sungem_phy.c and (long-removed) 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/linkmode.h> 23 #include <linux/mdio.h> 24 #include <linux/mii.h> 25 #include <linux/module.h> 26 #include <linux/timer.h> 27 #include <linux/workqueue.h> 28 #include <linux/mod_devicetable.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 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init; 46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init; 47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init; 48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init; 49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init; 50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init; 51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init; 52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init; 53 54 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features) 55 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features) 56 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features) 57 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features) 58 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features) 59 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features) 60 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features) 61 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features) 62 63 extern const int phy_10_100_features_array[4]; 64 extern const int phy_basic_t1_features_array[2]; 65 extern const int phy_gbit_features_array[2]; 66 extern const int phy_10gbit_features_array[1]; 67 68 /* 69 * Set phydev->irq to PHY_POLL if interrupts are not supported, 70 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if 71 * the attached driver handles the interrupt 72 */ 73 #define PHY_POLL -1 74 #define PHY_IGNORE_INTERRUPT -2 75 76 #define PHY_IS_INTERNAL 0x00000001 77 #define PHY_RST_AFTER_CLK_EN 0x00000002 78 #define MDIO_DEVICE_IS_PHY 0x80000000 79 80 /* Interface Mode definitions */ 81 typedef enum { 82 PHY_INTERFACE_MODE_NA, 83 PHY_INTERFACE_MODE_INTERNAL, 84 PHY_INTERFACE_MODE_MII, 85 PHY_INTERFACE_MODE_GMII, 86 PHY_INTERFACE_MODE_SGMII, 87 PHY_INTERFACE_MODE_TBI, 88 PHY_INTERFACE_MODE_REVMII, 89 PHY_INTERFACE_MODE_RMII, 90 PHY_INTERFACE_MODE_RGMII, 91 PHY_INTERFACE_MODE_RGMII_ID, 92 PHY_INTERFACE_MODE_RGMII_RXID, 93 PHY_INTERFACE_MODE_RGMII_TXID, 94 PHY_INTERFACE_MODE_RTBI, 95 PHY_INTERFACE_MODE_SMII, 96 PHY_INTERFACE_MODE_XGMII, 97 PHY_INTERFACE_MODE_MOCA, 98 PHY_INTERFACE_MODE_QSGMII, 99 PHY_INTERFACE_MODE_TRGMII, 100 PHY_INTERFACE_MODE_1000BASEX, 101 PHY_INTERFACE_MODE_2500BASEX, 102 PHY_INTERFACE_MODE_RXAUI, 103 PHY_INTERFACE_MODE_XAUI, 104 /* 10GBASE-KR, XFI, SFI - single lane 10G Serdes */ 105 PHY_INTERFACE_MODE_10GKR, 106 PHY_INTERFACE_MODE_MAX, 107 } phy_interface_t; 108 109 /** 110 * phy_supported_speeds - return all speeds currently supported by a phy device 111 * @phy: The phy device to return supported speeds of. 112 * @speeds: buffer to store supported speeds in. 113 * @size: size of speeds buffer. 114 * 115 * Description: Returns the number of supported speeds, and fills 116 * the speeds buffer with the supported speeds. If speeds buffer is 117 * too small to contain all currently supported speeds, will return as 118 * many speeds as can fit. 119 */ 120 unsigned int phy_supported_speeds(struct phy_device *phy, 121 unsigned int *speeds, 122 unsigned int size); 123 124 /** 125 * phy_modes - map phy_interface_t enum to device tree binding of phy-mode 126 * @interface: enum phy_interface_t value 127 * 128 * Description: maps 'enum phy_interface_t' defined in this file 129 * into the device tree binding of 'phy-mode', so that Ethernet 130 * device driver can get phy interface from device tree. 131 */ 132 static inline const char *phy_modes(phy_interface_t interface) 133 { 134 switch (interface) { 135 case PHY_INTERFACE_MODE_NA: 136 return ""; 137 case PHY_INTERFACE_MODE_INTERNAL: 138 return "internal"; 139 case PHY_INTERFACE_MODE_MII: 140 return "mii"; 141 case PHY_INTERFACE_MODE_GMII: 142 return "gmii"; 143 case PHY_INTERFACE_MODE_SGMII: 144 return "sgmii"; 145 case PHY_INTERFACE_MODE_TBI: 146 return "tbi"; 147 case PHY_INTERFACE_MODE_REVMII: 148 return "rev-mii"; 149 case PHY_INTERFACE_MODE_RMII: 150 return "rmii"; 151 case PHY_INTERFACE_MODE_RGMII: 152 return "rgmii"; 153 case PHY_INTERFACE_MODE_RGMII_ID: 154 return "rgmii-id"; 155 case PHY_INTERFACE_MODE_RGMII_RXID: 156 return "rgmii-rxid"; 157 case PHY_INTERFACE_MODE_RGMII_TXID: 158 return "rgmii-txid"; 159 case PHY_INTERFACE_MODE_RTBI: 160 return "rtbi"; 161 case PHY_INTERFACE_MODE_SMII: 162 return "smii"; 163 case PHY_INTERFACE_MODE_XGMII: 164 return "xgmii"; 165 case PHY_INTERFACE_MODE_MOCA: 166 return "moca"; 167 case PHY_INTERFACE_MODE_QSGMII: 168 return "qsgmii"; 169 case PHY_INTERFACE_MODE_TRGMII: 170 return "trgmii"; 171 case PHY_INTERFACE_MODE_1000BASEX: 172 return "1000base-x"; 173 case PHY_INTERFACE_MODE_2500BASEX: 174 return "2500base-x"; 175 case PHY_INTERFACE_MODE_RXAUI: 176 return "rxaui"; 177 case PHY_INTERFACE_MODE_XAUI: 178 return "xaui"; 179 case PHY_INTERFACE_MODE_10GKR: 180 return "10gbase-kr"; 181 default: 182 return "unknown"; 183 } 184 } 185 186 187 #define PHY_INIT_TIMEOUT 100000 188 #define PHY_STATE_TIME 1 189 #define PHY_FORCE_TIMEOUT 10 190 191 #define PHY_MAX_ADDR 32 192 193 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */ 194 #define PHY_ID_FMT "%s:%02x" 195 196 #define MII_BUS_ID_SIZE 61 197 198 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit 199 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */ 200 #define MII_ADDR_C45 (1<<30) 201 202 struct device; 203 struct phylink; 204 struct sk_buff; 205 206 /* 207 * The Bus class for PHYs. Devices which provide access to 208 * PHYs should register using this structure 209 */ 210 struct mii_bus { 211 struct module *owner; 212 const char *name; 213 char id[MII_BUS_ID_SIZE]; 214 void *priv; 215 int (*read)(struct mii_bus *bus, int addr, int regnum); 216 int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val); 217 int (*reset)(struct mii_bus *bus); 218 219 /* 220 * A lock to ensure that only one thing can read/write 221 * the MDIO bus at a time 222 */ 223 struct mutex mdio_lock; 224 225 struct device *parent; 226 enum { 227 MDIOBUS_ALLOCATED = 1, 228 MDIOBUS_REGISTERED, 229 MDIOBUS_UNREGISTERED, 230 MDIOBUS_RELEASED, 231 } state; 232 struct device dev; 233 234 /* list of all PHYs on bus */ 235 struct mdio_device *mdio_map[PHY_MAX_ADDR]; 236 237 /* PHY addresses to be ignored when probing */ 238 u32 phy_mask; 239 240 /* PHY addresses to ignore the TA/read failure */ 241 u32 phy_ignore_ta_mask; 242 243 /* 244 * An array of interrupts, each PHY's interrupt at the index 245 * matching its address 246 */ 247 int irq[PHY_MAX_ADDR]; 248 249 /* GPIO reset pulse width in microseconds */ 250 int reset_delay_us; 251 /* RESET GPIO descriptor pointer */ 252 struct gpio_desc *reset_gpiod; 253 }; 254 #define to_mii_bus(d) container_of(d, struct mii_bus, dev) 255 256 struct mii_bus *mdiobus_alloc_size(size_t); 257 static inline struct mii_bus *mdiobus_alloc(void) 258 { 259 return mdiobus_alloc_size(0); 260 } 261 262 int __mdiobus_register(struct mii_bus *bus, struct module *owner); 263 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE) 264 void mdiobus_unregister(struct mii_bus *bus); 265 void mdiobus_free(struct mii_bus *bus); 266 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv); 267 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev) 268 { 269 return devm_mdiobus_alloc_size(dev, 0); 270 } 271 272 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus); 273 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr); 274 275 #define PHY_INTERRUPT_DISABLED false 276 #define PHY_INTERRUPT_ENABLED true 277 278 /* PHY state machine states: 279 * 280 * DOWN: PHY device and driver are not ready for anything. probe 281 * should be called if and only if the PHY is in this state, 282 * given that the PHY device exists. 283 * - PHY driver probe function will set the state to READY 284 * 285 * READY: PHY is ready to send and receive packets, but the 286 * controller is not. By default, PHYs which do not implement 287 * probe will be set to this state by phy_probe(). 288 * - start will set the state to UP 289 * 290 * UP: The PHY and attached device are ready to do work. 291 * Interrupts should be started here. 292 * - timer moves to NOLINK or RUNNING 293 * 294 * NOLINK: PHY is up, but not currently plugged in. 295 * - irq or timer will set RUNNING if link comes back 296 * - phy_stop moves to HALTED 297 * 298 * FORCING: PHY is being configured with forced settings 299 * - if link is up, move to RUNNING 300 * - If link is down, we drop to the next highest setting, and 301 * retry (FORCING) after a timeout 302 * - phy_stop moves to HALTED 303 * 304 * RUNNING: PHY is currently up, running, and possibly sending 305 * and/or receiving packets 306 * - irq or timer will set NOLINK if link goes down 307 * - phy_stop moves to HALTED 308 * 309 * CHANGELINK: PHY experienced a change in link state 310 * - timer moves to RUNNING if link 311 * - timer moves to NOLINK if the link is down 312 * - phy_stop moves to HALTED 313 * 314 * HALTED: PHY is up, but no polling or interrupts are done. Or 315 * PHY is in an error state. 316 * 317 * - phy_start moves to RESUMING 318 * 319 * RESUMING: PHY was halted, but now wants to run again. 320 * - If we are forcing, or aneg is done, timer moves to RUNNING 321 * - If aneg is not done, timer moves to AN 322 * - phy_stop moves to HALTED 323 */ 324 enum phy_state { 325 PHY_DOWN = 0, 326 PHY_READY, 327 PHY_HALTED, 328 PHY_UP, 329 PHY_RUNNING, 330 PHY_NOLINK, 331 PHY_FORCING, 332 PHY_CHANGELINK, 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 * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal. 357 * loopback_enabled: Set true if this phy has been loopbacked successfully. 358 * state: state of the PHY for management purposes 359 * dev_flags: Device-specific flags used by the PHY driver. 360 * link_timeout: The number of timer firings to wait before the 361 * giving up on the current attempt at acquiring a link 362 * irq: IRQ number of the PHY's interrupt (-1 if none) 363 * phy_timer: The timer for handling the state machine 364 * attached_dev: The attached enet driver's device instance ptr 365 * adjust_link: Callback for the enet controller to respond to 366 * changes in the link state. 367 * 368 * speed, duplex, pause, supported, advertising, lp_advertising, 369 * and autoneg are used like in mii_if_info 370 * 371 * interrupts currently only supports enabled or disabled, 372 * but could be changed in the future to support enabling 373 * and disabling specific interrupts 374 * 375 * Contains some infrastructure for polling and interrupt 376 * handling, as well as handling shifts in PHY hardware state 377 */ 378 struct phy_device { 379 struct mdio_device mdio; 380 381 /* Information about the PHY type */ 382 /* And management functions */ 383 struct phy_driver *drv; 384 385 u32 phy_id; 386 387 struct phy_c45_device_ids c45_ids; 388 unsigned is_c45:1; 389 unsigned is_internal:1; 390 unsigned is_pseudo_fixed_link:1; 391 unsigned has_fixups:1; 392 unsigned suspended:1; 393 unsigned sysfs_links:1; 394 unsigned loopback_enabled:1; 395 396 unsigned autoneg:1; 397 /* The most recently read link state */ 398 unsigned link:1; 399 400 /* Interrupts are enabled */ 401 unsigned interrupts:1; 402 403 enum phy_state state; 404 405 u32 dev_flags; 406 407 phy_interface_t interface; 408 409 /* 410 * forced speed & duplex (no autoneg) 411 * partner speed & duplex & pause (autoneg) 412 */ 413 int speed; 414 int duplex; 415 int pause; 416 int asym_pause; 417 418 /* Union of PHY and Attached devices' supported link modes */ 419 /* See ethtool.h for more info */ 420 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 421 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 422 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 423 424 /* Energy efficient ethernet modes which should be prohibited */ 425 u32 eee_broken_modes; 426 427 int link_timeout; 428 429 #ifdef CONFIG_LED_TRIGGER_PHY 430 struct phy_led_trigger *phy_led_triggers; 431 unsigned int phy_num_led_triggers; 432 struct phy_led_trigger *last_triggered; 433 434 struct phy_led_trigger *led_link_trigger; 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 delayed_work state_queue; 449 450 struct mutex lock; 451 452 struct phylink *phylink; 453 struct net_device *attached_dev; 454 455 u8 mdix; 456 u8 mdix_ctrl; 457 458 void (*phy_link_change)(struct phy_device *, bool up, bool do_carrier); 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 mandatory list of features (speed, duplex, etc) 473 * supported by this PHY 474 * flags: A bitfield defining certain other features this PHY 475 * supports (like interrupts) 476 * 477 * All functions are optional. If config_aneg or read_status 478 * are not implemented, the phy core uses the genphy versions. 479 * Note that none of these functions should be called from 480 * interrupt time. The goal is for the bus read/write functions 481 * to be able to block when the bus transaction is happening, 482 * and be freed up by an interrupt (The MPC85xx has this ability, 483 * though it is not currently supported in the driver). 484 */ 485 struct phy_driver { 486 struct mdio_driver_common mdiodrv; 487 u32 phy_id; 488 char *name; 489 u32 phy_id_mask; 490 const unsigned long * const 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 /* 591 * Phy specific driver override for reading a MMD register. 592 * This function is optional for PHY specific drivers. When 593 * not provided, the default MMD read function will be used 594 * by phy_read_mmd(), which will use either a direct read for 595 * Clause 45 PHYs or an indirect read for Clause 22 PHYs. 596 * devnum is the MMD device number within the PHY device, 597 * regnum is the register within the selected MMD device. 598 */ 599 int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum); 600 601 /* 602 * Phy specific driver override for writing a MMD register. 603 * This function is optional for PHY specific drivers. When 604 * not provided, the default MMD write function will be used 605 * by phy_write_mmd(), which will use either a direct write for 606 * Clause 45 PHYs, or an indirect write for Clause 22 PHYs. 607 * devnum is the MMD device number within the PHY device, 608 * regnum is the register within the selected MMD device. 609 * val is the value to be written. 610 */ 611 int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum, 612 u16 val); 613 614 int (*read_page)(struct phy_device *dev); 615 int (*write_page)(struct phy_device *dev, int page); 616 617 /* Get the size and type of the eeprom contained within a plug-in 618 * module */ 619 int (*module_info)(struct phy_device *dev, 620 struct ethtool_modinfo *modinfo); 621 622 /* Get the eeprom information from the plug-in module */ 623 int (*module_eeprom)(struct phy_device *dev, 624 struct ethtool_eeprom *ee, u8 *data); 625 626 /* Get statistics from the phy using ethtool */ 627 int (*get_sset_count)(struct phy_device *dev); 628 void (*get_strings)(struct phy_device *dev, u8 *data); 629 void (*get_stats)(struct phy_device *dev, 630 struct ethtool_stats *stats, u64 *data); 631 632 /* Get and Set PHY tunables */ 633 int (*get_tunable)(struct phy_device *dev, 634 struct ethtool_tunable *tuna, void *data); 635 int (*set_tunable)(struct phy_device *dev, 636 struct ethtool_tunable *tuna, 637 const void *data); 638 int (*set_loopback)(struct phy_device *dev, bool enable); 639 }; 640 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \ 641 struct phy_driver, mdiodrv) 642 643 #define PHY_ANY_ID "MATCH ANY PHY" 644 #define PHY_ANY_UID 0xffffffff 645 646 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0) 647 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4) 648 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10) 649 650 /* A Structure for boards to register fixups with the PHY Lib */ 651 struct phy_fixup { 652 struct list_head list; 653 char bus_id[MII_BUS_ID_SIZE + 3]; 654 u32 phy_uid; 655 u32 phy_uid_mask; 656 int (*run)(struct phy_device *phydev); 657 }; 658 659 const char *phy_speed_to_str(int speed); 660 const char *phy_duplex_to_str(unsigned int duplex); 661 662 /* A structure for mapping a particular speed and duplex 663 * combination to a particular SUPPORTED and ADVERTISED value 664 */ 665 struct phy_setting { 666 u32 speed; 667 u8 duplex; 668 u8 bit; 669 }; 670 671 const struct phy_setting * 672 phy_lookup_setting(int speed, int duplex, const unsigned long *mask, 673 bool exact); 674 size_t phy_speeds(unsigned int *speeds, size_t size, 675 unsigned long *mask); 676 677 /** 678 * phy_is_started - Convenience function to check whether PHY is started 679 * @phydev: The phy_device struct 680 */ 681 static inline bool phy_is_started(struct phy_device *phydev) 682 { 683 return phydev->state >= PHY_UP; 684 } 685 686 void phy_resolve_aneg_linkmode(struct phy_device *phydev); 687 688 /** 689 * phy_read_mmd - Convenience function for reading a register 690 * from an MMD on a given PHY. 691 * @phydev: The phy_device struct 692 * @devad: The MMD to read from 693 * @regnum: The register on the MMD to read 694 * 695 * Same rules as for phy_read(); 696 */ 697 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); 698 699 /** 700 * phy_read - Convenience function for reading a given PHY register 701 * @phydev: the phy_device struct 702 * @regnum: register number to read 703 * 704 * NOTE: MUST NOT be called from interrupt context, 705 * because the bus read/write functions may wait for an interrupt 706 * to conclude the operation. 707 */ 708 static inline int phy_read(struct phy_device *phydev, u32 regnum) 709 { 710 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); 711 } 712 713 /** 714 * __phy_read - convenience function for reading a given PHY register 715 * @phydev: the phy_device struct 716 * @regnum: register number to read 717 * 718 * The caller must have taken the MDIO bus lock. 719 */ 720 static inline int __phy_read(struct phy_device *phydev, u32 regnum) 721 { 722 return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); 723 } 724 725 /** 726 * phy_write - Convenience function for writing a given PHY register 727 * @phydev: the phy_device struct 728 * @regnum: register number to write 729 * @val: value to write to @regnum 730 * 731 * NOTE: MUST NOT be called from interrupt context, 732 * because the bus read/write functions may wait for an interrupt 733 * to conclude the operation. 734 */ 735 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) 736 { 737 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val); 738 } 739 740 /** 741 * __phy_write - Convenience function for writing a given PHY register 742 * @phydev: the phy_device struct 743 * @regnum: register number to write 744 * @val: value to write to @regnum 745 * 746 * The caller must have taken the MDIO bus lock. 747 */ 748 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val) 749 { 750 return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, 751 val); 752 } 753 754 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); 755 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); 756 757 /** 758 * __phy_set_bits - Convenience function for setting bits in a PHY register 759 * @phydev: the phy_device struct 760 * @regnum: register number to write 761 * @val: bits to set 762 * 763 * The caller must have taken the MDIO bus lock. 764 */ 765 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) 766 { 767 return __phy_modify(phydev, regnum, 0, val); 768 } 769 770 /** 771 * __phy_clear_bits - Convenience function for clearing bits in a PHY register 772 * @phydev: the phy_device struct 773 * @regnum: register number to write 774 * @val: bits to clear 775 * 776 * The caller must have taken the MDIO bus lock. 777 */ 778 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum, 779 u16 val) 780 { 781 return __phy_modify(phydev, regnum, val, 0); 782 } 783 784 /** 785 * phy_set_bits - Convenience function for setting bits in a PHY register 786 * @phydev: the phy_device struct 787 * @regnum: register number to write 788 * @val: bits to set 789 */ 790 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) 791 { 792 return phy_modify(phydev, regnum, 0, val); 793 } 794 795 /** 796 * phy_clear_bits - Convenience function for clearing bits in a PHY register 797 * @phydev: the phy_device struct 798 * @regnum: register number to write 799 * @val: bits to clear 800 */ 801 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val) 802 { 803 return phy_modify(phydev, regnum, val, 0); 804 } 805 806 /** 807 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq 808 * @phydev: the phy_device struct 809 * 810 * NOTE: must be kept in sync with addition/removal of PHY_POLL and 811 * PHY_IGNORE_INTERRUPT 812 */ 813 static inline bool phy_interrupt_is_valid(struct phy_device *phydev) 814 { 815 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT; 816 } 817 818 /** 819 * phy_polling_mode - Convenience function for testing whether polling is 820 * used to detect PHY status changes 821 * @phydev: the phy_device struct 822 */ 823 static inline bool phy_polling_mode(struct phy_device *phydev) 824 { 825 return phydev->irq == PHY_POLL; 826 } 827 828 /** 829 * phy_is_internal - Convenience function for testing if a PHY is internal 830 * @phydev: the phy_device struct 831 */ 832 static inline bool phy_is_internal(struct phy_device *phydev) 833 { 834 return phydev->is_internal; 835 } 836 837 /** 838 * phy_interface_mode_is_rgmii - Convenience function for testing if a 839 * PHY interface mode is RGMII (all variants) 840 * @mode: the phy_interface_t enum 841 */ 842 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode) 843 { 844 return mode >= PHY_INTERFACE_MODE_RGMII && 845 mode <= PHY_INTERFACE_MODE_RGMII_TXID; 846 }; 847 848 /** 849 * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z 850 * negotiation 851 * @mode: one of &enum phy_interface_t 852 * 853 * Returns true if the phy interface mode uses the 16-bit negotiation 854 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding) 855 */ 856 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode) 857 { 858 return mode == PHY_INTERFACE_MODE_1000BASEX || 859 mode == PHY_INTERFACE_MODE_2500BASEX; 860 } 861 862 /** 863 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface 864 * is RGMII (all variants) 865 * @phydev: the phy_device struct 866 */ 867 static inline bool phy_interface_is_rgmii(struct phy_device *phydev) 868 { 869 return phy_interface_mode_is_rgmii(phydev->interface); 870 }; 871 872 /* 873 * phy_is_pseudo_fixed_link - Convenience function for testing if this 874 * PHY is the CPU port facing side of an Ethernet switch, or similar. 875 * @phydev: the phy_device struct 876 */ 877 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev) 878 { 879 return phydev->is_pseudo_fixed_link; 880 } 881 882 /** 883 * phy_write_mmd - Convenience function for writing a register 884 * on an MMD on a given PHY. 885 * @phydev: The phy_device struct 886 * @devad: The MMD to read from 887 * @regnum: The register on the MMD to read 888 * @val: value to write to @regnum 889 * 890 * Same rules as for phy_write(); 891 */ 892 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val); 893 894 int phy_save_page(struct phy_device *phydev); 895 int phy_select_page(struct phy_device *phydev, int page); 896 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret); 897 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum); 898 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val); 899 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum, 900 u16 mask, u16 set); 901 902 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id, 903 bool is_c45, 904 struct phy_c45_device_ids *c45_ids); 905 #if IS_ENABLED(CONFIG_PHYLIB) 906 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); 907 int phy_device_register(struct phy_device *phy); 908 void phy_device_free(struct phy_device *phydev); 909 #else 910 static inline 911 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45) 912 { 913 return NULL; 914 } 915 916 static inline int phy_device_register(struct phy_device *phy) 917 { 918 return 0; 919 } 920 921 static inline void phy_device_free(struct phy_device *phydev) { } 922 #endif /* CONFIG_PHYLIB */ 923 void phy_device_remove(struct phy_device *phydev); 924 int phy_init_hw(struct phy_device *phydev); 925 int phy_suspend(struct phy_device *phydev); 926 int phy_resume(struct phy_device *phydev); 927 int __phy_resume(struct phy_device *phydev); 928 int phy_loopback(struct phy_device *phydev, bool enable); 929 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, 930 phy_interface_t interface); 931 struct phy_device *phy_find_first(struct mii_bus *bus); 932 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, 933 u32 flags, phy_interface_t interface); 934 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, 935 void (*handler)(struct net_device *), 936 phy_interface_t interface); 937 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, 938 void (*handler)(struct net_device *), 939 phy_interface_t interface); 940 void phy_disconnect(struct phy_device *phydev); 941 void phy_detach(struct phy_device *phydev); 942 void phy_start(struct phy_device *phydev); 943 void phy_stop(struct phy_device *phydev); 944 int phy_start_aneg(struct phy_device *phydev); 945 int phy_aneg_done(struct phy_device *phydev); 946 int phy_speed_down(struct phy_device *phydev, bool sync); 947 int phy_speed_up(struct phy_device *phydev); 948 949 int phy_stop_interrupts(struct phy_device *phydev); 950 int phy_restart_aneg(struct phy_device *phydev); 951 int phy_reset_after_clk_enable(struct phy_device *phydev); 952 953 static inline void phy_device_reset(struct phy_device *phydev, int value) 954 { 955 mdio_device_reset(&phydev->mdio, value); 956 } 957 958 #define phydev_err(_phydev, format, args...) \ 959 dev_err(&_phydev->mdio.dev, format, ##args) 960 961 #define phydev_info(_phydev, format, args...) \ 962 dev_info(&_phydev->mdio.dev, format, ##args) 963 964 #define phydev_warn(_phydev, format, args...) \ 965 dev_warn(&_phydev->mdio.dev, format, ##args) 966 967 #define phydev_dbg(_phydev, format, args...) \ 968 dev_dbg(&_phydev->mdio.dev, format, ##args) 969 970 static inline const char *phydev_name(const struct phy_device *phydev) 971 { 972 return dev_name(&phydev->mdio.dev); 973 } 974 975 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...) 976 __printf(2, 3); 977 void phy_attached_info(struct phy_device *phydev); 978 979 /* Clause 22 PHY */ 980 int genphy_config_init(struct phy_device *phydev); 981 int genphy_setup_forced(struct phy_device *phydev); 982 int genphy_restart_aneg(struct phy_device *phydev); 983 int genphy_config_aneg(struct phy_device *phydev); 984 int genphy_aneg_done(struct phy_device *phydev); 985 int genphy_update_link(struct phy_device *phydev); 986 int genphy_read_status(struct phy_device *phydev); 987 int genphy_suspend(struct phy_device *phydev); 988 int genphy_resume(struct phy_device *phydev); 989 int genphy_loopback(struct phy_device *phydev, bool enable); 990 int genphy_soft_reset(struct phy_device *phydev); 991 static inline int genphy_no_soft_reset(struct phy_device *phydev) 992 { 993 return 0; 994 } 995 static inline int genphy_no_ack_interrupt(struct phy_device *phydev) 996 { 997 return 0; 998 } 999 static inline int genphy_no_config_intr(struct phy_device *phydev) 1000 { 1001 return 0; 1002 } 1003 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, 1004 u16 regnum); 1005 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum, 1006 u16 regnum, u16 val); 1007 1008 /* Clause 45 PHY */ 1009 int genphy_c45_restart_aneg(struct phy_device *phydev); 1010 int genphy_c45_aneg_done(struct phy_device *phydev); 1011 int genphy_c45_read_link(struct phy_device *phydev, u32 mmd_mask); 1012 int genphy_c45_read_lpa(struct phy_device *phydev); 1013 int genphy_c45_read_pma(struct phy_device *phydev); 1014 int genphy_c45_pma_setup_forced(struct phy_device *phydev); 1015 int genphy_c45_an_disable_aneg(struct phy_device *phydev); 1016 int genphy_c45_read_mdix(struct phy_device *phydev); 1017 1018 /* The gen10g_* functions are the old Clause 45 stub */ 1019 int gen10g_config_aneg(struct phy_device *phydev); 1020 int gen10g_read_status(struct phy_device *phydev); 1021 int gen10g_no_soft_reset(struct phy_device *phydev); 1022 int gen10g_config_init(struct phy_device *phydev); 1023 int gen10g_suspend(struct phy_device *phydev); 1024 int gen10g_resume(struct phy_device *phydev); 1025 1026 static inline int phy_read_status(struct phy_device *phydev) 1027 { 1028 if (!phydev->drv) 1029 return -EIO; 1030 1031 if (phydev->drv->read_status) 1032 return phydev->drv->read_status(phydev); 1033 else 1034 return genphy_read_status(phydev); 1035 } 1036 1037 void phy_driver_unregister(struct phy_driver *drv); 1038 void phy_drivers_unregister(struct phy_driver *drv, int n); 1039 int phy_driver_register(struct phy_driver *new_driver, struct module *owner); 1040 int phy_drivers_register(struct phy_driver *new_driver, int n, 1041 struct module *owner); 1042 void phy_state_machine(struct work_struct *work); 1043 void phy_mac_interrupt(struct phy_device *phydev); 1044 void phy_start_machine(struct phy_device *phydev); 1045 void phy_stop_machine(struct phy_device *phydev); 1046 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd); 1047 void phy_ethtool_ksettings_get(struct phy_device *phydev, 1048 struct ethtool_link_ksettings *cmd); 1049 int phy_ethtool_ksettings_set(struct phy_device *phydev, 1050 const struct ethtool_link_ksettings *cmd); 1051 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); 1052 int phy_start_interrupts(struct phy_device *phydev); 1053 void phy_print_status(struct phy_device *phydev); 1054 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed); 1055 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode); 1056 void phy_support_sym_pause(struct phy_device *phydev); 1057 void phy_support_asym_pause(struct phy_device *phydev); 1058 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx, 1059 bool autoneg); 1060 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx); 1061 bool phy_validate_pause(struct phy_device *phydev, 1062 struct ethtool_pauseparam *pp); 1063 1064 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, 1065 int (*run)(struct phy_device *)); 1066 int phy_register_fixup_for_id(const char *bus_id, 1067 int (*run)(struct phy_device *)); 1068 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, 1069 int (*run)(struct phy_device *)); 1070 1071 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask); 1072 int phy_unregister_fixup_for_id(const char *bus_id); 1073 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask); 1074 1075 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); 1076 int phy_get_eee_err(struct phy_device *phydev); 1077 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); 1078 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); 1079 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); 1080 void phy_ethtool_get_wol(struct phy_device *phydev, 1081 struct ethtool_wolinfo *wol); 1082 int phy_ethtool_get_link_ksettings(struct net_device *ndev, 1083 struct ethtool_link_ksettings *cmd); 1084 int phy_ethtool_set_link_ksettings(struct net_device *ndev, 1085 const struct ethtool_link_ksettings *cmd); 1086 int phy_ethtool_nway_reset(struct net_device *ndev); 1087 1088 #if IS_ENABLED(CONFIG_PHYLIB) 1089 int __init mdio_bus_init(void); 1090 void mdio_bus_exit(void); 1091 #endif 1092 1093 /* Inline function for use within net/core/ethtool.c (built-in) */ 1094 static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data) 1095 { 1096 if (!phydev->drv) 1097 return -EIO; 1098 1099 mutex_lock(&phydev->lock); 1100 phydev->drv->get_strings(phydev, data); 1101 mutex_unlock(&phydev->lock); 1102 1103 return 0; 1104 } 1105 1106 static inline int phy_ethtool_get_sset_count(struct phy_device *phydev) 1107 { 1108 int ret; 1109 1110 if (!phydev->drv) 1111 return -EIO; 1112 1113 if (phydev->drv->get_sset_count && 1114 phydev->drv->get_strings && 1115 phydev->drv->get_stats) { 1116 mutex_lock(&phydev->lock); 1117 ret = phydev->drv->get_sset_count(phydev); 1118 mutex_unlock(&phydev->lock); 1119 1120 return ret; 1121 } 1122 1123 return -EOPNOTSUPP; 1124 } 1125 1126 static inline int phy_ethtool_get_stats(struct phy_device *phydev, 1127 struct ethtool_stats *stats, u64 *data) 1128 { 1129 if (!phydev->drv) 1130 return -EIO; 1131 1132 mutex_lock(&phydev->lock); 1133 phydev->drv->get_stats(phydev, stats, data); 1134 mutex_unlock(&phydev->lock); 1135 1136 return 0; 1137 } 1138 1139 extern struct bus_type mdio_bus_type; 1140 1141 struct mdio_board_info { 1142 const char *bus_id; 1143 char modalias[MDIO_NAME_SIZE]; 1144 int mdio_addr; 1145 const void *platform_data; 1146 }; 1147 1148 #if IS_ENABLED(CONFIG_MDIO_DEVICE) 1149 int mdiobus_register_board_info(const struct mdio_board_info *info, 1150 unsigned int n); 1151 #else 1152 static inline int mdiobus_register_board_info(const struct mdio_board_info *i, 1153 unsigned int n) 1154 { 1155 return 0; 1156 } 1157 #endif 1158 1159 1160 /** 1161 * module_phy_driver() - Helper macro for registering PHY drivers 1162 * @__phy_drivers: array of PHY drivers to register 1163 * 1164 * Helper macro for PHY drivers which do not do anything special in module 1165 * init/exit. Each module may only use this macro once, and calling it 1166 * replaces module_init() and module_exit(). 1167 */ 1168 #define phy_module_driver(__phy_drivers, __count) \ 1169 static int __init phy_module_init(void) \ 1170 { \ 1171 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \ 1172 } \ 1173 module_init(phy_module_init); \ 1174 static void __exit phy_module_exit(void) \ 1175 { \ 1176 phy_drivers_unregister(__phy_drivers, __count); \ 1177 } \ 1178 module_exit(phy_module_exit) 1179 1180 #define module_phy_driver(__phy_drivers) \ 1181 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) 1182 1183 #endif /* __PHY_H */ 1184