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