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