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