1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Framework and drivers for configuring and reading different PHYs 4 * Based on code in sungem_phy.c and (long-removed) gianfar_phy.c 5 * 6 * Author: Andy Fleming 7 * 8 * Copyright (c) 2004 Freescale Semiconductor, Inc. 9 */ 10 11 #ifndef __PHY_H 12 #define __PHY_H 13 14 #include <linux/compiler.h> 15 #include <linux/spinlock.h> 16 #include <linux/ethtool.h> 17 #include <linux/linkmode.h> 18 #include <linux/netlink.h> 19 #include <linux/mdio.h> 20 #include <linux/mii.h> 21 #include <linux/mii_timestamper.h> 22 #include <linux/module.h> 23 #include <linux/timer.h> 24 #include <linux/workqueue.h> 25 #include <linux/mod_devicetable.h> 26 #include <linux/u64_stats_sync.h> 27 #include <linux/irqreturn.h> 28 #include <linux/iopoll.h> 29 #include <linux/refcount.h> 30 31 #include <linux/atomic.h> 32 33 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \ 34 SUPPORTED_TP | \ 35 SUPPORTED_MII) 36 37 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \ 38 SUPPORTED_10baseT_Full) 39 40 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \ 41 SUPPORTED_100baseT_Full) 42 43 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \ 44 SUPPORTED_1000baseT_Full) 45 46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init; 47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init; 48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init; 49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init; 50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init; 51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init; 52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init; 53 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init; 54 55 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features) 56 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features) 57 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features) 58 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features) 59 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features) 60 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features) 61 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features) 62 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features) 63 64 extern const int phy_basic_ports_array[3]; 65 extern const int phy_fibre_port_array[1]; 66 extern const int phy_all_ports_features_array[7]; 67 extern const int phy_10_100_features_array[4]; 68 extern const int phy_basic_t1_features_array[2]; 69 extern const int phy_gbit_features_array[2]; 70 extern const int phy_10gbit_features_array[1]; 71 72 /* 73 * Set phydev->irq to PHY_POLL if interrupts are not supported, 74 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if 75 * the attached driver handles the interrupt 76 */ 77 #define PHY_POLL -1 78 #define PHY_IGNORE_INTERRUPT -2 79 80 #define PHY_IS_INTERNAL 0x00000001 81 #define PHY_RST_AFTER_CLK_EN 0x00000002 82 #define PHY_POLL_CABLE_TEST 0x00000004 83 #define MDIO_DEVICE_IS_PHY 0x80000000 84 85 /* Interface Mode definitions */ 86 typedef enum { 87 PHY_INTERFACE_MODE_NA, 88 PHY_INTERFACE_MODE_INTERNAL, 89 PHY_INTERFACE_MODE_MII, 90 PHY_INTERFACE_MODE_GMII, 91 PHY_INTERFACE_MODE_SGMII, 92 PHY_INTERFACE_MODE_TBI, 93 PHY_INTERFACE_MODE_REVMII, 94 PHY_INTERFACE_MODE_RMII, 95 PHY_INTERFACE_MODE_RGMII, 96 PHY_INTERFACE_MODE_RGMII_ID, 97 PHY_INTERFACE_MODE_RGMII_RXID, 98 PHY_INTERFACE_MODE_RGMII_TXID, 99 PHY_INTERFACE_MODE_RTBI, 100 PHY_INTERFACE_MODE_SMII, 101 PHY_INTERFACE_MODE_XGMII, 102 PHY_INTERFACE_MODE_XLGMII, 103 PHY_INTERFACE_MODE_MOCA, 104 PHY_INTERFACE_MODE_QSGMII, 105 PHY_INTERFACE_MODE_TRGMII, 106 PHY_INTERFACE_MODE_1000BASEX, 107 PHY_INTERFACE_MODE_2500BASEX, 108 PHY_INTERFACE_MODE_RXAUI, 109 PHY_INTERFACE_MODE_XAUI, 110 /* 10GBASE-R, XFI, SFI - single lane 10G Serdes */ 111 PHY_INTERFACE_MODE_10GBASER, 112 PHY_INTERFACE_MODE_USXGMII, 113 /* 10GBASE-KR - with Clause 73 AN */ 114 PHY_INTERFACE_MODE_10GKR, 115 PHY_INTERFACE_MODE_MAX, 116 } phy_interface_t; 117 118 /** 119 * phy_supported_speeds - return all speeds currently supported by a phy device 120 * @phy: The phy device to return supported speeds of. 121 * @speeds: buffer to store supported speeds in. 122 * @size: size of speeds buffer. 123 * 124 * Description: Returns the number of supported speeds, and fills 125 * the speeds buffer with the supported speeds. If speeds buffer is 126 * too small to contain all currently supported speeds, will return as 127 * many speeds as can fit. 128 */ 129 unsigned int phy_supported_speeds(struct phy_device *phy, 130 unsigned int *speeds, 131 unsigned int size); 132 133 /** 134 * phy_modes - map phy_interface_t enum to device tree binding of phy-mode 135 * @interface: enum phy_interface_t value 136 * 137 * Description: maps 'enum phy_interface_t' defined in this file 138 * into the device tree binding of 'phy-mode', so that Ethernet 139 * device driver can get phy interface from device tree. 140 */ 141 static inline const char *phy_modes(phy_interface_t interface) 142 { 143 switch (interface) { 144 case PHY_INTERFACE_MODE_NA: 145 return ""; 146 case PHY_INTERFACE_MODE_INTERNAL: 147 return "internal"; 148 case PHY_INTERFACE_MODE_MII: 149 return "mii"; 150 case PHY_INTERFACE_MODE_GMII: 151 return "gmii"; 152 case PHY_INTERFACE_MODE_SGMII: 153 return "sgmii"; 154 case PHY_INTERFACE_MODE_TBI: 155 return "tbi"; 156 case PHY_INTERFACE_MODE_REVMII: 157 return "rev-mii"; 158 case PHY_INTERFACE_MODE_RMII: 159 return "rmii"; 160 case PHY_INTERFACE_MODE_RGMII: 161 return "rgmii"; 162 case PHY_INTERFACE_MODE_RGMII_ID: 163 return "rgmii-id"; 164 case PHY_INTERFACE_MODE_RGMII_RXID: 165 return "rgmii-rxid"; 166 case PHY_INTERFACE_MODE_RGMII_TXID: 167 return "rgmii-txid"; 168 case PHY_INTERFACE_MODE_RTBI: 169 return "rtbi"; 170 case PHY_INTERFACE_MODE_SMII: 171 return "smii"; 172 case PHY_INTERFACE_MODE_XGMII: 173 return "xgmii"; 174 case PHY_INTERFACE_MODE_XLGMII: 175 return "xlgmii"; 176 case PHY_INTERFACE_MODE_MOCA: 177 return "moca"; 178 case PHY_INTERFACE_MODE_QSGMII: 179 return "qsgmii"; 180 case PHY_INTERFACE_MODE_TRGMII: 181 return "trgmii"; 182 case PHY_INTERFACE_MODE_1000BASEX: 183 return "1000base-x"; 184 case PHY_INTERFACE_MODE_2500BASEX: 185 return "2500base-x"; 186 case PHY_INTERFACE_MODE_RXAUI: 187 return "rxaui"; 188 case PHY_INTERFACE_MODE_XAUI: 189 return "xaui"; 190 case PHY_INTERFACE_MODE_10GBASER: 191 return "10gbase-r"; 192 case PHY_INTERFACE_MODE_USXGMII: 193 return "usxgmii"; 194 case PHY_INTERFACE_MODE_10GKR: 195 return "10gbase-kr"; 196 default: 197 return "unknown"; 198 } 199 } 200 201 202 #define PHY_INIT_TIMEOUT 100000 203 #define PHY_FORCE_TIMEOUT 10 204 205 #define PHY_MAX_ADDR 32 206 207 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */ 208 #define PHY_ID_FMT "%s:%02x" 209 210 #define MII_BUS_ID_SIZE 61 211 212 struct device; 213 struct phylink; 214 struct sfp_bus; 215 struct sfp_upstream_ops; 216 struct sk_buff; 217 218 struct mdio_bus_stats { 219 u64_stats_t transfers; 220 u64_stats_t errors; 221 u64_stats_t writes; 222 u64_stats_t reads; 223 /* Must be last, add new statistics above */ 224 struct u64_stats_sync syncp; 225 }; 226 227 /* Represents a shared structure between different phydev's in the same 228 * package, for example a quad PHY. See phy_package_join() and 229 * phy_package_leave(). 230 */ 231 struct phy_package_shared { 232 int addr; 233 refcount_t refcnt; 234 unsigned long flags; 235 size_t priv_size; 236 237 /* private data pointer */ 238 /* note that this pointer is shared between different phydevs and 239 * the user has to take care of appropriate locking. It is allocated 240 * and freed automatically by phy_package_join() and 241 * phy_package_leave(). 242 */ 243 void *priv; 244 }; 245 246 /* used as bit number in atomic bitops */ 247 #define PHY_SHARED_F_INIT_DONE 0 248 #define PHY_SHARED_F_PROBE_DONE 1 249 250 /* 251 * The Bus class for PHYs. Devices which provide access to 252 * PHYs should register using this structure 253 */ 254 struct mii_bus { 255 struct module *owner; 256 const char *name; 257 char id[MII_BUS_ID_SIZE]; 258 void *priv; 259 int (*read)(struct mii_bus *bus, int addr, int regnum); 260 int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val); 261 int (*reset)(struct mii_bus *bus); 262 struct mdio_bus_stats stats[PHY_MAX_ADDR]; 263 264 unsigned int is_managed:1; /* is device-managed */ 265 unsigned int is_managed_registered:1; 266 267 /* 268 * A lock to ensure that only one thing can read/write 269 * the MDIO bus at a time 270 */ 271 struct mutex mdio_lock; 272 273 struct device *parent; 274 enum { 275 MDIOBUS_ALLOCATED = 1, 276 MDIOBUS_REGISTERED, 277 MDIOBUS_UNREGISTERED, 278 MDIOBUS_RELEASED, 279 } state; 280 struct device dev; 281 282 /* list of all PHYs on bus */ 283 struct mdio_device *mdio_map[PHY_MAX_ADDR]; 284 285 /* PHY addresses to be ignored when probing */ 286 u32 phy_mask; 287 288 /* PHY addresses to ignore the TA/read failure */ 289 u32 phy_ignore_ta_mask; 290 291 /* 292 * An array of interrupts, each PHY's interrupt at the index 293 * matching its address 294 */ 295 int irq[PHY_MAX_ADDR]; 296 297 /* GPIO reset pulse width in microseconds */ 298 int reset_delay_us; 299 /* RESET GPIO descriptor pointer */ 300 struct gpio_desc *reset_gpiod; 301 302 /* bus capabilities, used for probing */ 303 enum { 304 MDIOBUS_NO_CAP = 0, 305 MDIOBUS_C22, 306 MDIOBUS_C45, 307 MDIOBUS_C22_C45, 308 } probe_capabilities; 309 310 /* protect access to the shared element */ 311 struct mutex shared_lock; 312 313 /* shared state across different PHYs */ 314 struct phy_package_shared *shared[PHY_MAX_ADDR]; 315 }; 316 #define to_mii_bus(d) container_of(d, struct mii_bus, dev) 317 318 struct mii_bus *mdiobus_alloc_size(size_t); 319 static inline struct mii_bus *mdiobus_alloc(void) 320 { 321 return mdiobus_alloc_size(0); 322 } 323 324 int __mdiobus_register(struct mii_bus *bus, struct module *owner); 325 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE) 326 static inline int devm_mdiobus_register(struct mii_bus *bus) 327 { 328 int ret; 329 330 if (!bus->is_managed) 331 return -EPERM; 332 333 ret = mdiobus_register(bus); 334 if (!ret) 335 bus->is_managed_registered = 1; 336 337 return ret; 338 } 339 340 void mdiobus_unregister(struct mii_bus *bus); 341 void mdiobus_free(struct mii_bus *bus); 342 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv); 343 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev) 344 { 345 return devm_mdiobus_alloc_size(dev, 0); 346 } 347 348 struct mii_bus *mdio_find_bus(const char *mdio_name); 349 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus); 350 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr); 351 352 #define PHY_INTERRUPT_DISABLED false 353 #define PHY_INTERRUPT_ENABLED true 354 355 /* PHY state machine states: 356 * 357 * DOWN: PHY device and driver are not ready for anything. probe 358 * should be called if and only if the PHY is in this state, 359 * given that the PHY device exists. 360 * - PHY driver probe function will set the state to READY 361 * 362 * READY: PHY is ready to send and receive packets, but the 363 * controller is not. By default, PHYs which do not implement 364 * probe will be set to this state by phy_probe(). 365 * - start will set the state to UP 366 * 367 * UP: The PHY and attached device are ready to do work. 368 * Interrupts should be started here. 369 * - timer moves to NOLINK or RUNNING 370 * 371 * NOLINK: PHY is up, but not currently plugged in. 372 * - irq or timer will set RUNNING if link comes back 373 * - phy_stop moves to HALTED 374 * 375 * RUNNING: PHY is currently up, running, and possibly sending 376 * and/or receiving packets 377 * - irq or timer will set NOLINK if link goes down 378 * - phy_stop moves to HALTED 379 * 380 * CABLETEST: PHY is performing a cable test. Packet reception/sending 381 * is not expected to work, carrier will be indicated as down. PHY will be 382 * poll once per second, or on interrupt for it current state. 383 * Once complete, move to UP to restart the PHY. 384 * - phy_stop aborts the running test and moves to HALTED 385 * 386 * HALTED: PHY is up, but no polling or interrupts are done. Or 387 * PHY is in an error state. 388 * - phy_start moves to UP 389 */ 390 enum phy_state { 391 PHY_DOWN = 0, 392 PHY_READY, 393 PHY_HALTED, 394 PHY_UP, 395 PHY_RUNNING, 396 PHY_NOLINK, 397 PHY_CABLETEST, 398 }; 399 400 #define MDIO_MMD_NUM 32 401 402 /** 403 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers 404 * @devices_in_package: IEEE 802.3 devices in package register value. 405 * @mmds_present: bit vector of MMDs present. 406 * @device_ids: The device identifer for each present device. 407 */ 408 struct phy_c45_device_ids { 409 u32 devices_in_package; 410 u32 mmds_present; 411 u32 device_ids[MDIO_MMD_NUM]; 412 }; 413 414 struct macsec_context; 415 struct macsec_ops; 416 417 /* phy_device: An instance of a PHY 418 * 419 * drv: Pointer to the driver for this PHY instance 420 * phy_id: UID for this device found during discovery 421 * c45_ids: 802.3-c45 Device Identifers if is_c45. 422 * is_c45: Set to true if this phy uses clause 45 addressing. 423 * is_internal: Set to true if this phy is internal to a MAC. 424 * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc. 425 * is_gigabit_capable: Set to true if PHY supports 1000Mbps 426 * has_fixups: Set to true if this phy has fixups/quirks. 427 * suspended: Set to true if this phy has been suspended successfully. 428 * suspended_by_mdio_bus: Set to true if this phy was suspended by MDIO bus. 429 * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal. 430 * loopback_enabled: Set true if this phy has been loopbacked successfully. 431 * downshifted_rate: Set true if link speed has been downshifted. 432 * state: state of the PHY for management purposes 433 * dev_flags: Device-specific flags used by the PHY driver. 434 * irq: IRQ number of the PHY's interrupt (-1 if none) 435 * phy_timer: The timer for handling the state machine 436 * sfp_bus_attached: flag indicating whether the SFP bus has been attached 437 * sfp_bus: SFP bus attached to this PHY's fiber port 438 * attached_dev: The attached enet driver's device instance ptr 439 * adjust_link: Callback for the enet controller to respond to 440 * changes in the link state. 441 * macsec_ops: MACsec offloading ops. 442 * 443 * speed, duplex, pause, supported, advertising, lp_advertising, 444 * and autoneg are used like in mii_if_info 445 * 446 * interrupts currently only supports enabled or disabled, 447 * but could be changed in the future to support enabling 448 * and disabling specific interrupts 449 * 450 * Contains some infrastructure for polling and interrupt 451 * handling, as well as handling shifts in PHY hardware state 452 */ 453 struct phy_device { 454 struct mdio_device mdio; 455 456 /* Information about the PHY type */ 457 /* And management functions */ 458 struct phy_driver *drv; 459 460 u32 phy_id; 461 462 struct phy_c45_device_ids c45_ids; 463 unsigned is_c45:1; 464 unsigned is_internal:1; 465 unsigned is_pseudo_fixed_link:1; 466 unsigned is_gigabit_capable:1; 467 unsigned has_fixups:1; 468 unsigned suspended:1; 469 unsigned suspended_by_mdio_bus:1; 470 unsigned sysfs_links:1; 471 unsigned loopback_enabled:1; 472 unsigned downshifted_rate:1; 473 474 unsigned autoneg:1; 475 /* The most recently read link state */ 476 unsigned link:1; 477 unsigned autoneg_complete:1; 478 479 /* Interrupts are enabled */ 480 unsigned interrupts:1; 481 482 enum phy_state state; 483 484 u32 dev_flags; 485 486 phy_interface_t interface; 487 488 /* 489 * forced speed & duplex (no autoneg) 490 * partner speed & duplex & pause (autoneg) 491 */ 492 int speed; 493 int duplex; 494 int pause; 495 int asym_pause; 496 u8 master_slave_get; 497 u8 master_slave_set; 498 u8 master_slave_state; 499 500 /* Union of PHY and Attached devices' supported link modes */ 501 /* See ethtool.h for more info */ 502 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 503 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 504 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 505 /* used with phy_speed_down */ 506 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old); 507 508 /* Energy efficient ethernet modes which should be prohibited */ 509 u32 eee_broken_modes; 510 511 #ifdef CONFIG_LED_TRIGGER_PHY 512 struct phy_led_trigger *phy_led_triggers; 513 unsigned int phy_num_led_triggers; 514 struct phy_led_trigger *last_triggered; 515 516 struct phy_led_trigger *led_link_trigger; 517 #endif 518 519 /* 520 * Interrupt number for this PHY 521 * -1 means no interrupt 522 */ 523 int irq; 524 525 /* private data pointer */ 526 /* For use by PHYs to maintain extra state */ 527 void *priv; 528 529 /* shared data pointer */ 530 /* For use by PHYs inside the same package that need a shared state. */ 531 struct phy_package_shared *shared; 532 533 /* Reporting cable test results */ 534 struct sk_buff *skb; 535 void *ehdr; 536 struct nlattr *nest; 537 538 /* Interrupt and Polling infrastructure */ 539 struct delayed_work state_queue; 540 541 struct mutex lock; 542 543 /* This may be modified under the rtnl lock */ 544 bool sfp_bus_attached; 545 struct sfp_bus *sfp_bus; 546 struct phylink *phylink; 547 struct net_device *attached_dev; 548 struct mii_timestamper *mii_ts; 549 550 u8 mdix; 551 u8 mdix_ctrl; 552 553 void (*phy_link_change)(struct phy_device *phydev, bool up); 554 void (*adjust_link)(struct net_device *dev); 555 556 #if IS_ENABLED(CONFIG_MACSEC) 557 /* MACsec management functions */ 558 const struct macsec_ops *macsec_ops; 559 #endif 560 }; 561 #define to_phy_device(d) container_of(to_mdio_device(d), \ 562 struct phy_device, mdio) 563 564 /* A structure containing possible configuration parameters 565 * for a TDR cable test. The driver does not need to implement 566 * all the parameters, but should report what is actually used. 567 */ 568 struct phy_tdr_config { 569 u32 first; 570 u32 last; 571 u32 step; 572 s8 pair; 573 }; 574 #define PHY_PAIR_ALL -1 575 576 /* struct phy_driver: Driver structure for a particular PHY type 577 * 578 * driver_data: static driver data 579 * phy_id: The result of reading the UID registers of this PHY 580 * type, and ANDing them with the phy_id_mask. This driver 581 * only works for PHYs with IDs which match this field 582 * name: The friendly name of this PHY type 583 * phy_id_mask: Defines the important bits of the phy_id 584 * features: A mandatory list of features (speed, duplex, etc) 585 * supported by this PHY 586 * flags: A bitfield defining certain other features this PHY 587 * supports (like interrupts) 588 * 589 * All functions are optional. If config_aneg or read_status 590 * are not implemented, the phy core uses the genphy versions. 591 * Note that none of these functions should be called from 592 * interrupt time. The goal is for the bus read/write functions 593 * to be able to block when the bus transaction is happening, 594 * and be freed up by an interrupt (The MPC85xx has this ability, 595 * though it is not currently supported in the driver). 596 */ 597 struct phy_driver { 598 struct mdio_driver_common mdiodrv; 599 u32 phy_id; 600 char *name; 601 u32 phy_id_mask; 602 const unsigned long * const features; 603 u32 flags; 604 const void *driver_data; 605 606 /* 607 * Called to issue a PHY software reset 608 */ 609 int (*soft_reset)(struct phy_device *phydev); 610 611 /* 612 * Called to initialize the PHY, 613 * including after a reset 614 */ 615 int (*config_init)(struct phy_device *phydev); 616 617 /* 618 * Called during discovery. Used to set 619 * up device-specific structures, if any 620 */ 621 int (*probe)(struct phy_device *phydev); 622 623 /* 624 * Probe the hardware to determine what abilities it has. 625 * Should only set phydev->supported. 626 */ 627 int (*get_features)(struct phy_device *phydev); 628 629 /* PHY Power Management */ 630 int (*suspend)(struct phy_device *phydev); 631 int (*resume)(struct phy_device *phydev); 632 633 /* 634 * Configures the advertisement and resets 635 * autonegotiation if phydev->autoneg is on, 636 * forces the speed to the current settings in phydev 637 * if phydev->autoneg is off 638 */ 639 int (*config_aneg)(struct phy_device *phydev); 640 641 /* Determines the auto negotiation result */ 642 int (*aneg_done)(struct phy_device *phydev); 643 644 /* Determines the negotiated speed and duplex */ 645 int (*read_status)(struct phy_device *phydev); 646 647 /* Clears any pending interrupts */ 648 int (*ack_interrupt)(struct phy_device *phydev); 649 650 /* Enables or disables interrupts */ 651 int (*config_intr)(struct phy_device *phydev); 652 653 /* 654 * Checks if the PHY generated an interrupt. 655 * For multi-PHY devices with shared PHY interrupt pin 656 * Set interrupt bits have to be cleared. 657 */ 658 int (*did_interrupt)(struct phy_device *phydev); 659 660 /* Override default interrupt handling */ 661 irqreturn_t (*handle_interrupt)(struct phy_device *phydev); 662 663 /* Clears up any memory if needed */ 664 void (*remove)(struct phy_device *phydev); 665 666 /* Returns true if this is a suitable driver for the given 667 * phydev. If NULL, matching is based on phy_id and 668 * phy_id_mask. 669 */ 670 int (*match_phy_device)(struct phy_device *phydev); 671 672 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to 673 * enable Wake on LAN, so set_wol is provided to be called in the 674 * ethernet driver's set_wol function. */ 675 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); 676 677 /* See set_wol, but for checking whether Wake on LAN is enabled. */ 678 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); 679 680 /* 681 * Called to inform a PHY device driver when the core is about to 682 * change the link state. This callback is supposed to be used as 683 * fixup hook for drivers that need to take action when the link 684 * state changes. Drivers are by no means allowed to mess with the 685 * PHY device structure in their implementations. 686 */ 687 void (*link_change_notify)(struct phy_device *dev); 688 689 /* 690 * Phy specific driver override for reading a MMD register. 691 * This function is optional for PHY specific drivers. When 692 * not provided, the default MMD read function will be used 693 * by phy_read_mmd(), which will use either a direct read for 694 * Clause 45 PHYs or an indirect read for Clause 22 PHYs. 695 * devnum is the MMD device number within the PHY device, 696 * regnum is the register within the selected MMD device. 697 */ 698 int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum); 699 700 /* 701 * Phy specific driver override for writing a MMD register. 702 * This function is optional for PHY specific drivers. When 703 * not provided, the default MMD write function will be used 704 * by phy_write_mmd(), which will use either a direct write for 705 * Clause 45 PHYs, or an indirect write for Clause 22 PHYs. 706 * devnum is the MMD device number within the PHY device, 707 * regnum is the register within the selected MMD device. 708 * val is the value to be written. 709 */ 710 int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum, 711 u16 val); 712 713 int (*read_page)(struct phy_device *dev); 714 int (*write_page)(struct phy_device *dev, int page); 715 716 /* Get the size and type of the eeprom contained within a plug-in 717 * module */ 718 int (*module_info)(struct phy_device *dev, 719 struct ethtool_modinfo *modinfo); 720 721 /* Get the eeprom information from the plug-in module */ 722 int (*module_eeprom)(struct phy_device *dev, 723 struct ethtool_eeprom *ee, u8 *data); 724 725 /* Start a cable test */ 726 int (*cable_test_start)(struct phy_device *dev); 727 728 /* Start a raw TDR cable test */ 729 int (*cable_test_tdr_start)(struct phy_device *dev, 730 const struct phy_tdr_config *config); 731 732 /* Once per second, or on interrupt, request the status of the 733 * test. 734 */ 735 int (*cable_test_get_status)(struct phy_device *dev, bool *finished); 736 737 /* Get statistics from the phy using ethtool */ 738 int (*get_sset_count)(struct phy_device *dev); 739 void (*get_strings)(struct phy_device *dev, u8 *data); 740 void (*get_stats)(struct phy_device *dev, 741 struct ethtool_stats *stats, u64 *data); 742 743 /* Get and Set PHY tunables */ 744 int (*get_tunable)(struct phy_device *dev, 745 struct ethtool_tunable *tuna, void *data); 746 int (*set_tunable)(struct phy_device *dev, 747 struct ethtool_tunable *tuna, 748 const void *data); 749 int (*set_loopback)(struct phy_device *dev, bool enable); 750 int (*get_sqi)(struct phy_device *dev); 751 int (*get_sqi_max)(struct phy_device *dev); 752 }; 753 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \ 754 struct phy_driver, mdiodrv) 755 756 #define PHY_ANY_ID "MATCH ANY PHY" 757 #define PHY_ANY_UID 0xffffffff 758 759 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0) 760 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4) 761 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10) 762 763 /* A Structure for boards to register fixups with the PHY Lib */ 764 struct phy_fixup { 765 struct list_head list; 766 char bus_id[MII_BUS_ID_SIZE + 3]; 767 u32 phy_uid; 768 u32 phy_uid_mask; 769 int (*run)(struct phy_device *phydev); 770 }; 771 772 const char *phy_speed_to_str(int speed); 773 const char *phy_duplex_to_str(unsigned int duplex); 774 775 /* A structure for mapping a particular speed and duplex 776 * combination to a particular SUPPORTED and ADVERTISED value 777 */ 778 struct phy_setting { 779 u32 speed; 780 u8 duplex; 781 u8 bit; 782 }; 783 784 const struct phy_setting * 785 phy_lookup_setting(int speed, int duplex, const unsigned long *mask, 786 bool exact); 787 size_t phy_speeds(unsigned int *speeds, size_t size, 788 unsigned long *mask); 789 void of_set_phy_supported(struct phy_device *phydev); 790 void of_set_phy_eee_broken(struct phy_device *phydev); 791 int phy_speed_down_core(struct phy_device *phydev); 792 793 /** 794 * phy_is_started - Convenience function to check whether PHY is started 795 * @phydev: The phy_device struct 796 */ 797 static inline bool phy_is_started(struct phy_device *phydev) 798 { 799 return phydev->state >= PHY_UP; 800 } 801 802 void phy_resolve_aneg_pause(struct phy_device *phydev); 803 void phy_resolve_aneg_linkmode(struct phy_device *phydev); 804 void phy_check_downshift(struct phy_device *phydev); 805 806 /** 807 * phy_read - Convenience function for reading a given PHY register 808 * @phydev: the phy_device struct 809 * @regnum: register number to read 810 * 811 * NOTE: MUST NOT be called from interrupt context, 812 * because the bus read/write functions may wait for an interrupt 813 * to conclude the operation. 814 */ 815 static inline int phy_read(struct phy_device *phydev, u32 regnum) 816 { 817 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); 818 } 819 820 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \ 821 timeout_us, sleep_before_read) \ 822 ({ \ 823 int __ret = read_poll_timeout(phy_read, val, (cond) || val < 0, \ 824 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \ 825 if (val < 0) \ 826 __ret = val; \ 827 if (__ret) \ 828 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \ 829 __ret; \ 830 }) 831 832 833 /** 834 * __phy_read - convenience function for reading a given PHY register 835 * @phydev: the phy_device struct 836 * @regnum: register number to read 837 * 838 * The caller must have taken the MDIO bus lock. 839 */ 840 static inline int __phy_read(struct phy_device *phydev, u32 regnum) 841 { 842 return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); 843 } 844 845 /** 846 * phy_write - Convenience function for writing a given PHY register 847 * @phydev: the phy_device struct 848 * @regnum: register number to write 849 * @val: value to write to @regnum 850 * 851 * NOTE: MUST NOT be called from interrupt context, 852 * because the bus read/write functions may wait for an interrupt 853 * to conclude the operation. 854 */ 855 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) 856 { 857 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val); 858 } 859 860 /** 861 * __phy_write - Convenience function for writing a given PHY register 862 * @phydev: the phy_device struct 863 * @regnum: register number to write 864 * @val: value to write to @regnum 865 * 866 * The caller must have taken the MDIO bus lock. 867 */ 868 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val) 869 { 870 return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, 871 val); 872 } 873 874 /** 875 * __phy_modify_changed() - Convenience function for modifying a PHY register 876 * @phydev: a pointer to a &struct phy_device 877 * @regnum: register number 878 * @mask: bit mask of bits to clear 879 * @set: bit mask of bits to set 880 * 881 * Unlocked helper function which allows a PHY register to be modified as 882 * new register value = (old register value & ~mask) | set 883 * 884 * Returns negative errno, 0 if there was no change, and 1 in case of change 885 */ 886 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum, 887 u16 mask, u16 set) 888 { 889 return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr, 890 regnum, mask, set); 891 } 892 893 /** 894 * phy_read_mmd - Convenience function for reading a register 895 * from an MMD on a given PHY. 896 * @phydev: The phy_device struct 897 * @devad: The MMD to read from 898 * @regnum: The register on the MMD to read 899 * 900 * Same rules as for phy_read(); 901 */ 902 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); 903 904 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \ 905 sleep_us, timeout_us, sleep_before_read) \ 906 ({ \ 907 int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \ 908 sleep_us, timeout_us, sleep_before_read, \ 909 phydev, devaddr, regnum); \ 910 if (val < 0) \ 911 __ret = val; \ 912 if (__ret) \ 913 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \ 914 __ret; \ 915 }) 916 917 /** 918 * __phy_read_mmd - Convenience function for reading a register 919 * from an MMD on a given PHY. 920 * @phydev: The phy_device struct 921 * @devad: The MMD to read from 922 * @regnum: The register on the MMD to read 923 * 924 * Same rules as for __phy_read(); 925 */ 926 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); 927 928 /** 929 * phy_write_mmd - Convenience function for writing a register 930 * on an MMD on a given PHY. 931 * @phydev: The phy_device struct 932 * @devad: The MMD to write to 933 * @regnum: The register on the MMD to read 934 * @val: value to write to @regnum 935 * 936 * Same rules as for phy_write(); 937 */ 938 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val); 939 940 /** 941 * __phy_write_mmd - Convenience function for writing a register 942 * on an MMD on a given PHY. 943 * @phydev: The phy_device struct 944 * @devad: The MMD to write to 945 * @regnum: The register on the MMD to read 946 * @val: value to write to @regnum 947 * 948 * Same rules as for __phy_write(); 949 */ 950 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val); 951 952 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask, 953 u16 set); 954 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask, 955 u16 set); 956 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); 957 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); 958 959 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum, 960 u16 mask, u16 set); 961 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum, 962 u16 mask, u16 set); 963 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum, 964 u16 mask, u16 set); 965 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum, 966 u16 mask, u16 set); 967 968 /** 969 * __phy_set_bits - Convenience function for setting bits in a PHY register 970 * @phydev: the phy_device struct 971 * @regnum: register number to write 972 * @val: bits to set 973 * 974 * The caller must have taken the MDIO bus lock. 975 */ 976 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) 977 { 978 return __phy_modify(phydev, regnum, 0, val); 979 } 980 981 /** 982 * __phy_clear_bits - Convenience function for clearing bits in a PHY register 983 * @phydev: the phy_device struct 984 * @regnum: register number to write 985 * @val: bits to clear 986 * 987 * The caller must have taken the MDIO bus lock. 988 */ 989 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum, 990 u16 val) 991 { 992 return __phy_modify(phydev, regnum, val, 0); 993 } 994 995 /** 996 * phy_set_bits - Convenience function for setting bits in a PHY register 997 * @phydev: the phy_device struct 998 * @regnum: register number to write 999 * @val: bits to set 1000 */ 1001 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) 1002 { 1003 return phy_modify(phydev, regnum, 0, val); 1004 } 1005 1006 /** 1007 * phy_clear_bits - Convenience function for clearing bits in a PHY register 1008 * @phydev: the phy_device struct 1009 * @regnum: register number to write 1010 * @val: bits to clear 1011 */ 1012 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val) 1013 { 1014 return phy_modify(phydev, regnum, val, 0); 1015 } 1016 1017 /** 1018 * __phy_set_bits_mmd - Convenience function for setting bits in a register 1019 * on MMD 1020 * @phydev: the phy_device struct 1021 * @devad: the MMD containing register to modify 1022 * @regnum: register number to modify 1023 * @val: bits to set 1024 * 1025 * The caller must have taken the MDIO bus lock. 1026 */ 1027 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad, 1028 u32 regnum, u16 val) 1029 { 1030 return __phy_modify_mmd(phydev, devad, regnum, 0, val); 1031 } 1032 1033 /** 1034 * __phy_clear_bits_mmd - Convenience function for clearing bits in a register 1035 * on MMD 1036 * @phydev: the phy_device struct 1037 * @devad: the MMD containing register to modify 1038 * @regnum: register number to modify 1039 * @val: bits to clear 1040 * 1041 * The caller must have taken the MDIO bus lock. 1042 */ 1043 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad, 1044 u32 regnum, u16 val) 1045 { 1046 return __phy_modify_mmd(phydev, devad, regnum, val, 0); 1047 } 1048 1049 /** 1050 * phy_set_bits_mmd - Convenience function for setting bits in a register 1051 * on MMD 1052 * @phydev: the phy_device struct 1053 * @devad: the MMD containing register to modify 1054 * @regnum: register number to modify 1055 * @val: bits to set 1056 */ 1057 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad, 1058 u32 regnum, u16 val) 1059 { 1060 return phy_modify_mmd(phydev, devad, regnum, 0, val); 1061 } 1062 1063 /** 1064 * phy_clear_bits_mmd - Convenience function for clearing bits in a register 1065 * on MMD 1066 * @phydev: the phy_device struct 1067 * @devad: the MMD containing register to modify 1068 * @regnum: register number to modify 1069 * @val: bits to clear 1070 */ 1071 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad, 1072 u32 regnum, u16 val) 1073 { 1074 return phy_modify_mmd(phydev, devad, regnum, val, 0); 1075 } 1076 1077 /** 1078 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq 1079 * @phydev: the phy_device struct 1080 * 1081 * NOTE: must be kept in sync with addition/removal of PHY_POLL and 1082 * PHY_IGNORE_INTERRUPT 1083 */ 1084 static inline bool phy_interrupt_is_valid(struct phy_device *phydev) 1085 { 1086 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT; 1087 } 1088 1089 /** 1090 * phy_polling_mode - Convenience function for testing whether polling is 1091 * used to detect PHY status changes 1092 * @phydev: the phy_device struct 1093 */ 1094 static inline bool phy_polling_mode(struct phy_device *phydev) 1095 { 1096 if (phydev->state == PHY_CABLETEST) 1097 if (phydev->drv->flags & PHY_POLL_CABLE_TEST) 1098 return true; 1099 1100 return phydev->irq == PHY_POLL; 1101 } 1102 1103 /** 1104 * phy_has_hwtstamp - Tests whether a PHY time stamp configuration. 1105 * @phydev: the phy_device struct 1106 */ 1107 static inline bool phy_has_hwtstamp(struct phy_device *phydev) 1108 { 1109 return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp; 1110 } 1111 1112 /** 1113 * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping. 1114 * @phydev: the phy_device struct 1115 */ 1116 static inline bool phy_has_rxtstamp(struct phy_device *phydev) 1117 { 1118 return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp; 1119 } 1120 1121 /** 1122 * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or 1123 * PTP hardware clock capabilities. 1124 * @phydev: the phy_device struct 1125 */ 1126 static inline bool phy_has_tsinfo(struct phy_device *phydev) 1127 { 1128 return phydev && phydev->mii_ts && phydev->mii_ts->ts_info; 1129 } 1130 1131 /** 1132 * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping. 1133 * @phydev: the phy_device struct 1134 */ 1135 static inline bool phy_has_txtstamp(struct phy_device *phydev) 1136 { 1137 return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp; 1138 } 1139 1140 static inline int phy_hwtstamp(struct phy_device *phydev, struct ifreq *ifr) 1141 { 1142 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr); 1143 } 1144 1145 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb, 1146 int type) 1147 { 1148 return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type); 1149 } 1150 1151 static inline int phy_ts_info(struct phy_device *phydev, 1152 struct ethtool_ts_info *tsinfo) 1153 { 1154 return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo); 1155 } 1156 1157 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb, 1158 int type) 1159 { 1160 phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type); 1161 } 1162 1163 /** 1164 * phy_is_internal - Convenience function for testing if a PHY is internal 1165 * @phydev: the phy_device struct 1166 */ 1167 static inline bool phy_is_internal(struct phy_device *phydev) 1168 { 1169 return phydev->is_internal; 1170 } 1171 1172 /** 1173 * phy_interface_mode_is_rgmii - Convenience function for testing if a 1174 * PHY interface mode is RGMII (all variants) 1175 * @mode: the phy_interface_t enum 1176 */ 1177 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode) 1178 { 1179 return mode >= PHY_INTERFACE_MODE_RGMII && 1180 mode <= PHY_INTERFACE_MODE_RGMII_TXID; 1181 }; 1182 1183 /** 1184 * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z 1185 * negotiation 1186 * @mode: one of &enum phy_interface_t 1187 * 1188 * Returns true if the phy interface mode uses the 16-bit negotiation 1189 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding) 1190 */ 1191 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode) 1192 { 1193 return mode == PHY_INTERFACE_MODE_1000BASEX || 1194 mode == PHY_INTERFACE_MODE_2500BASEX; 1195 } 1196 1197 /** 1198 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface 1199 * is RGMII (all variants) 1200 * @phydev: the phy_device struct 1201 */ 1202 static inline bool phy_interface_is_rgmii(struct phy_device *phydev) 1203 { 1204 return phy_interface_mode_is_rgmii(phydev->interface); 1205 }; 1206 1207 /* 1208 * phy_is_pseudo_fixed_link - Convenience function for testing if this 1209 * PHY is the CPU port facing side of an Ethernet switch, or similar. 1210 * @phydev: the phy_device struct 1211 */ 1212 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev) 1213 { 1214 return phydev->is_pseudo_fixed_link; 1215 } 1216 1217 int phy_save_page(struct phy_device *phydev); 1218 int phy_select_page(struct phy_device *phydev, int page); 1219 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret); 1220 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum); 1221 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val); 1222 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum, 1223 u16 mask, u16 set); 1224 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum, 1225 u16 mask, u16 set); 1226 1227 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id, 1228 bool is_c45, 1229 struct phy_c45_device_ids *c45_ids); 1230 #if IS_ENABLED(CONFIG_PHYLIB) 1231 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); 1232 int phy_device_register(struct phy_device *phy); 1233 void phy_device_free(struct phy_device *phydev); 1234 #else 1235 static inline 1236 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45) 1237 { 1238 return NULL; 1239 } 1240 1241 static inline int phy_device_register(struct phy_device *phy) 1242 { 1243 return 0; 1244 } 1245 1246 static inline void phy_device_free(struct phy_device *phydev) { } 1247 #endif /* CONFIG_PHYLIB */ 1248 void phy_device_remove(struct phy_device *phydev); 1249 int phy_init_hw(struct phy_device *phydev); 1250 int phy_suspend(struct phy_device *phydev); 1251 int phy_resume(struct phy_device *phydev); 1252 int __phy_resume(struct phy_device *phydev); 1253 int phy_loopback(struct phy_device *phydev, bool enable); 1254 void phy_sfp_attach(void *upstream, struct sfp_bus *bus); 1255 void phy_sfp_detach(void *upstream, struct sfp_bus *bus); 1256 int phy_sfp_probe(struct phy_device *phydev, 1257 const struct sfp_upstream_ops *ops); 1258 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, 1259 phy_interface_t interface); 1260 struct phy_device *phy_find_first(struct mii_bus *bus); 1261 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, 1262 u32 flags, phy_interface_t interface); 1263 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, 1264 void (*handler)(struct net_device *), 1265 phy_interface_t interface); 1266 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, 1267 void (*handler)(struct net_device *), 1268 phy_interface_t interface); 1269 void phy_disconnect(struct phy_device *phydev); 1270 void phy_detach(struct phy_device *phydev); 1271 void phy_start(struct phy_device *phydev); 1272 void phy_stop(struct phy_device *phydev); 1273 int phy_start_aneg(struct phy_device *phydev); 1274 int phy_aneg_done(struct phy_device *phydev); 1275 int phy_speed_down(struct phy_device *phydev, bool sync); 1276 int phy_speed_up(struct phy_device *phydev); 1277 1278 int phy_restart_aneg(struct phy_device *phydev); 1279 int phy_reset_after_clk_enable(struct phy_device *phydev); 1280 1281 #if IS_ENABLED(CONFIG_PHYLIB) 1282 int phy_start_cable_test(struct phy_device *phydev, 1283 struct netlink_ext_ack *extack); 1284 int phy_start_cable_test_tdr(struct phy_device *phydev, 1285 struct netlink_ext_ack *extack, 1286 const struct phy_tdr_config *config); 1287 #else 1288 static inline 1289 int phy_start_cable_test(struct phy_device *phydev, 1290 struct netlink_ext_ack *extack) 1291 { 1292 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support"); 1293 return -EOPNOTSUPP; 1294 } 1295 static inline 1296 int phy_start_cable_test_tdr(struct phy_device *phydev, 1297 struct netlink_ext_ack *extack, 1298 const struct phy_tdr_config *config) 1299 { 1300 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support"); 1301 return -EOPNOTSUPP; 1302 } 1303 #endif 1304 1305 int phy_cable_test_result(struct phy_device *phydev, u8 pair, u16 result); 1306 int phy_cable_test_fault_length(struct phy_device *phydev, u8 pair, 1307 u16 cm); 1308 1309 static inline void phy_device_reset(struct phy_device *phydev, int value) 1310 { 1311 mdio_device_reset(&phydev->mdio, value); 1312 } 1313 1314 #define phydev_err(_phydev, format, args...) \ 1315 dev_err(&_phydev->mdio.dev, format, ##args) 1316 1317 #define phydev_info(_phydev, format, args...) \ 1318 dev_info(&_phydev->mdio.dev, format, ##args) 1319 1320 #define phydev_warn(_phydev, format, args...) \ 1321 dev_warn(&_phydev->mdio.dev, format, ##args) 1322 1323 #define phydev_dbg(_phydev, format, args...) \ 1324 dev_dbg(&_phydev->mdio.dev, format, ##args) 1325 1326 static inline const char *phydev_name(const struct phy_device *phydev) 1327 { 1328 return dev_name(&phydev->mdio.dev); 1329 } 1330 1331 static inline void phy_lock_mdio_bus(struct phy_device *phydev) 1332 { 1333 mutex_lock(&phydev->mdio.bus->mdio_lock); 1334 } 1335 1336 static inline void phy_unlock_mdio_bus(struct phy_device *phydev) 1337 { 1338 mutex_unlock(&phydev->mdio.bus->mdio_lock); 1339 } 1340 1341 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...) 1342 __printf(2, 3); 1343 char *phy_attached_info_irq(struct phy_device *phydev) 1344 __malloc; 1345 void phy_attached_info(struct phy_device *phydev); 1346 1347 /* Clause 22 PHY */ 1348 int genphy_read_abilities(struct phy_device *phydev); 1349 int genphy_setup_forced(struct phy_device *phydev); 1350 int genphy_restart_aneg(struct phy_device *phydev); 1351 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart); 1352 int genphy_config_eee_advert(struct phy_device *phydev); 1353 int __genphy_config_aneg(struct phy_device *phydev, bool changed); 1354 int genphy_aneg_done(struct phy_device *phydev); 1355 int genphy_update_link(struct phy_device *phydev); 1356 int genphy_read_lpa(struct phy_device *phydev); 1357 int genphy_read_status_fixed(struct phy_device *phydev); 1358 int genphy_read_status(struct phy_device *phydev); 1359 int genphy_suspend(struct phy_device *phydev); 1360 int genphy_resume(struct phy_device *phydev); 1361 int genphy_loopback(struct phy_device *phydev, bool enable); 1362 int genphy_soft_reset(struct phy_device *phydev); 1363 1364 static inline int genphy_config_aneg(struct phy_device *phydev) 1365 { 1366 return __genphy_config_aneg(phydev, false); 1367 } 1368 1369 static inline int genphy_no_ack_interrupt(struct phy_device *phydev) 1370 { 1371 return 0; 1372 } 1373 static inline int genphy_no_config_intr(struct phy_device *phydev) 1374 { 1375 return 0; 1376 } 1377 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, 1378 u16 regnum); 1379 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum, 1380 u16 regnum, u16 val); 1381 1382 /* Clause 37 */ 1383 int genphy_c37_config_aneg(struct phy_device *phydev); 1384 int genphy_c37_read_status(struct phy_device *phydev); 1385 1386 /* Clause 45 PHY */ 1387 int genphy_c45_restart_aneg(struct phy_device *phydev); 1388 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart); 1389 int genphy_c45_aneg_done(struct phy_device *phydev); 1390 int genphy_c45_read_link(struct phy_device *phydev); 1391 int genphy_c45_read_lpa(struct phy_device *phydev); 1392 int genphy_c45_read_pma(struct phy_device *phydev); 1393 int genphy_c45_pma_setup_forced(struct phy_device *phydev); 1394 int genphy_c45_an_config_aneg(struct phy_device *phydev); 1395 int genphy_c45_an_disable_aneg(struct phy_device *phydev); 1396 int genphy_c45_read_mdix(struct phy_device *phydev); 1397 int genphy_c45_pma_read_abilities(struct phy_device *phydev); 1398 int genphy_c45_read_status(struct phy_device *phydev); 1399 int genphy_c45_config_aneg(struct phy_device *phydev); 1400 1401 /* The gen10g_* functions are the old Clause 45 stub */ 1402 int gen10g_config_aneg(struct phy_device *phydev); 1403 1404 static inline int phy_read_status(struct phy_device *phydev) 1405 { 1406 if (!phydev->drv) 1407 return -EIO; 1408 1409 if (phydev->drv->read_status) 1410 return phydev->drv->read_status(phydev); 1411 else 1412 return genphy_read_status(phydev); 1413 } 1414 1415 void phy_driver_unregister(struct phy_driver *drv); 1416 void phy_drivers_unregister(struct phy_driver *drv, int n); 1417 int phy_driver_register(struct phy_driver *new_driver, struct module *owner); 1418 int phy_drivers_register(struct phy_driver *new_driver, int n, 1419 struct module *owner); 1420 void phy_state_machine(struct work_struct *work); 1421 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies); 1422 void phy_mac_interrupt(struct phy_device *phydev); 1423 void phy_start_machine(struct phy_device *phydev); 1424 void phy_stop_machine(struct phy_device *phydev); 1425 void phy_ethtool_ksettings_get(struct phy_device *phydev, 1426 struct ethtool_link_ksettings *cmd); 1427 int phy_ethtool_ksettings_set(struct phy_device *phydev, 1428 const struct ethtool_link_ksettings *cmd); 1429 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); 1430 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd); 1431 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd); 1432 void phy_request_interrupt(struct phy_device *phydev); 1433 void phy_free_interrupt(struct phy_device *phydev); 1434 void phy_print_status(struct phy_device *phydev); 1435 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed); 1436 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode); 1437 void phy_advertise_supported(struct phy_device *phydev); 1438 void phy_support_sym_pause(struct phy_device *phydev); 1439 void phy_support_asym_pause(struct phy_device *phydev); 1440 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx, 1441 bool autoneg); 1442 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx); 1443 bool phy_validate_pause(struct phy_device *phydev, 1444 struct ethtool_pauseparam *pp); 1445 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause); 1446 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv, 1447 bool *tx_pause, bool *rx_pause); 1448 1449 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, 1450 int (*run)(struct phy_device *)); 1451 int phy_register_fixup_for_id(const char *bus_id, 1452 int (*run)(struct phy_device *)); 1453 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, 1454 int (*run)(struct phy_device *)); 1455 1456 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask); 1457 int phy_unregister_fixup_for_id(const char *bus_id); 1458 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask); 1459 1460 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); 1461 int phy_get_eee_err(struct phy_device *phydev); 1462 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); 1463 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); 1464 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); 1465 void phy_ethtool_get_wol(struct phy_device *phydev, 1466 struct ethtool_wolinfo *wol); 1467 int phy_ethtool_get_link_ksettings(struct net_device *ndev, 1468 struct ethtool_link_ksettings *cmd); 1469 int phy_ethtool_set_link_ksettings(struct net_device *ndev, 1470 const struct ethtool_link_ksettings *cmd); 1471 int phy_ethtool_nway_reset(struct net_device *ndev); 1472 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size); 1473 void phy_package_leave(struct phy_device *phydev); 1474 int devm_phy_package_join(struct device *dev, struct phy_device *phydev, 1475 int addr, size_t priv_size); 1476 1477 #if IS_ENABLED(CONFIG_PHYLIB) 1478 int __init mdio_bus_init(void); 1479 void mdio_bus_exit(void); 1480 #endif 1481 1482 /* Inline function for use within net/core/ethtool.c (built-in) */ 1483 static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data) 1484 { 1485 if (!phydev->drv) 1486 return -EIO; 1487 1488 mutex_lock(&phydev->lock); 1489 phydev->drv->get_strings(phydev, data); 1490 mutex_unlock(&phydev->lock); 1491 1492 return 0; 1493 } 1494 1495 static inline int phy_ethtool_get_sset_count(struct phy_device *phydev) 1496 { 1497 int ret; 1498 1499 if (!phydev->drv) 1500 return -EIO; 1501 1502 if (phydev->drv->get_sset_count && 1503 phydev->drv->get_strings && 1504 phydev->drv->get_stats) { 1505 mutex_lock(&phydev->lock); 1506 ret = phydev->drv->get_sset_count(phydev); 1507 mutex_unlock(&phydev->lock); 1508 1509 return ret; 1510 } 1511 1512 return -EOPNOTSUPP; 1513 } 1514 1515 static inline int phy_ethtool_get_stats(struct phy_device *phydev, 1516 struct ethtool_stats *stats, u64 *data) 1517 { 1518 if (!phydev->drv) 1519 return -EIO; 1520 1521 mutex_lock(&phydev->lock); 1522 phydev->drv->get_stats(phydev, stats, data); 1523 mutex_unlock(&phydev->lock); 1524 1525 return 0; 1526 } 1527 1528 static inline int phy_package_read(struct phy_device *phydev, u32 regnum) 1529 { 1530 struct phy_package_shared *shared = phydev->shared; 1531 1532 if (!shared) 1533 return -EIO; 1534 1535 return mdiobus_read(phydev->mdio.bus, shared->addr, regnum); 1536 } 1537 1538 static inline int __phy_package_read(struct phy_device *phydev, u32 regnum) 1539 { 1540 struct phy_package_shared *shared = phydev->shared; 1541 1542 if (!shared) 1543 return -EIO; 1544 1545 return __mdiobus_read(phydev->mdio.bus, shared->addr, regnum); 1546 } 1547 1548 static inline int phy_package_write(struct phy_device *phydev, 1549 u32 regnum, u16 val) 1550 { 1551 struct phy_package_shared *shared = phydev->shared; 1552 1553 if (!shared) 1554 return -EIO; 1555 1556 return mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val); 1557 } 1558 1559 static inline int __phy_package_write(struct phy_device *phydev, 1560 u32 regnum, u16 val) 1561 { 1562 struct phy_package_shared *shared = phydev->shared; 1563 1564 if (!shared) 1565 return -EIO; 1566 1567 return __mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val); 1568 } 1569 1570 static inline bool __phy_package_set_once(struct phy_device *phydev, 1571 unsigned int b) 1572 { 1573 struct phy_package_shared *shared = phydev->shared; 1574 1575 if (!shared) 1576 return false; 1577 1578 return !test_and_set_bit(b, &shared->flags); 1579 } 1580 1581 static inline bool phy_package_init_once(struct phy_device *phydev) 1582 { 1583 return __phy_package_set_once(phydev, PHY_SHARED_F_INIT_DONE); 1584 } 1585 1586 static inline bool phy_package_probe_once(struct phy_device *phydev) 1587 { 1588 return __phy_package_set_once(phydev, PHY_SHARED_F_PROBE_DONE); 1589 } 1590 1591 extern struct bus_type mdio_bus_type; 1592 1593 struct mdio_board_info { 1594 const char *bus_id; 1595 char modalias[MDIO_NAME_SIZE]; 1596 int mdio_addr; 1597 const void *platform_data; 1598 }; 1599 1600 #if IS_ENABLED(CONFIG_MDIO_DEVICE) 1601 int mdiobus_register_board_info(const struct mdio_board_info *info, 1602 unsigned int n); 1603 #else 1604 static inline int mdiobus_register_board_info(const struct mdio_board_info *i, 1605 unsigned int n) 1606 { 1607 return 0; 1608 } 1609 #endif 1610 1611 1612 /** 1613 * module_phy_driver() - Helper macro for registering PHY drivers 1614 * @__phy_drivers: array of PHY drivers to register 1615 * 1616 * Helper macro for PHY drivers which do not do anything special in module 1617 * init/exit. Each module may only use this macro once, and calling it 1618 * replaces module_init() and module_exit(). 1619 */ 1620 #define phy_module_driver(__phy_drivers, __count) \ 1621 static int __init phy_module_init(void) \ 1622 { \ 1623 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \ 1624 } \ 1625 module_init(phy_module_init); \ 1626 static void __exit phy_module_exit(void) \ 1627 { \ 1628 phy_drivers_unregister(__phy_drivers, __count); \ 1629 } \ 1630 module_exit(phy_module_exit) 1631 1632 #define module_phy_driver(__phy_drivers) \ 1633 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) 1634 1635 bool phy_driver_is_genphy(struct phy_device *phydev); 1636 bool phy_driver_is_genphy_10g(struct phy_device *phydev); 1637 1638 #endif /* __PHY_H */ 1639