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