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 * @eee_broken_modes: Energy efficient ethernet modes which should be prohibited 575 * @autoneg: Flag autoneg being used 576 * @rate_matching: Current rate matching mode 577 * @link: Current link state 578 * @autoneg_complete: Flag auto negotiation of the link has completed 579 * @mdix: Current crossover 580 * @mdix_ctrl: User setting of crossover 581 * @pma_extable: Cached value of PMA/PMD Extended Abilities Register 582 * @interrupts: Flag interrupts have been enabled 583 * @irq_suspended: Flag indicating PHY is suspended and therefore interrupt 584 * handling shall be postponed until PHY has resumed 585 * @irq_rerun: Flag indicating interrupts occurred while PHY was suspended, 586 * requiring a rerun of the interrupt handler after resume 587 * @interface: enum phy_interface_t value 588 * @skb: Netlink message for cable diagnostics 589 * @nest: Netlink nest used for cable diagnostics 590 * @ehdr: nNtlink header for cable diagnostics 591 * @phy_led_triggers: Array of LED triggers 592 * @phy_num_led_triggers: Number of triggers in @phy_led_triggers 593 * @led_link_trigger: LED trigger for link up/down 594 * @last_triggered: last LED trigger for link speed 595 * @master_slave_set: User requested master/slave configuration 596 * @master_slave_get: Current master/slave advertisement 597 * @master_slave_state: Current master/slave configuration 598 * @mii_ts: Pointer to time stamper callbacks 599 * @lock: Mutex for serialization access to PHY 600 * @state_queue: Work queue for state machine 601 * @shared: Pointer to private data shared by phys in one package 602 * @priv: Pointer to driver private data 603 * 604 * interrupts currently only supports enabled or disabled, 605 * but could be changed in the future to support enabling 606 * and disabling specific interrupts 607 * 608 * Contains some infrastructure for polling and interrupt 609 * handling, as well as handling shifts in PHY hardware state 610 */ 611 struct phy_device { 612 struct mdio_device mdio; 613 614 /* Information about the PHY type */ 615 /* And management functions */ 616 struct phy_driver *drv; 617 618 u32 phy_id; 619 620 struct phy_c45_device_ids c45_ids; 621 unsigned is_c45:1; 622 unsigned is_internal:1; 623 unsigned is_pseudo_fixed_link:1; 624 unsigned is_gigabit_capable:1; 625 unsigned has_fixups:1; 626 unsigned suspended:1; 627 unsigned suspended_by_mdio_bus:1; 628 unsigned sysfs_links:1; 629 unsigned loopback_enabled:1; 630 unsigned downshifted_rate:1; 631 unsigned is_on_sfp_module:1; 632 unsigned mac_managed_pm:1; 633 634 unsigned autoneg:1; 635 /* The most recently read link state */ 636 unsigned link:1; 637 unsigned autoneg_complete:1; 638 639 /* Interrupts are enabled */ 640 unsigned interrupts:1; 641 unsigned irq_suspended:1; 642 unsigned irq_rerun:1; 643 644 int rate_matching; 645 646 enum phy_state state; 647 648 u32 dev_flags; 649 650 phy_interface_t interface; 651 652 /* 653 * forced speed & duplex (no autoneg) 654 * partner speed & duplex & pause (autoneg) 655 */ 656 int speed; 657 int duplex; 658 int port; 659 int pause; 660 int asym_pause; 661 u8 master_slave_get; 662 u8 master_slave_set; 663 u8 master_slave_state; 664 665 /* Union of PHY and Attached devices' supported link modes */ 666 /* See ethtool.h for more info */ 667 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported); 668 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 669 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 670 /* used with phy_speed_down */ 671 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old); 672 673 /* Energy efficient ethernet modes which should be prohibited */ 674 u32 eee_broken_modes; 675 676 #ifdef CONFIG_LED_TRIGGER_PHY 677 struct phy_led_trigger *phy_led_triggers; 678 unsigned int phy_num_led_triggers; 679 struct phy_led_trigger *last_triggered; 680 681 struct phy_led_trigger *led_link_trigger; 682 #endif 683 684 /* 685 * Interrupt number for this PHY 686 * -1 means no interrupt 687 */ 688 int irq; 689 690 /* private data pointer */ 691 /* For use by PHYs to maintain extra state */ 692 void *priv; 693 694 /* shared data pointer */ 695 /* For use by PHYs inside the same package that need a shared state. */ 696 struct phy_package_shared *shared; 697 698 /* Reporting cable test results */ 699 struct sk_buff *skb; 700 void *ehdr; 701 struct nlattr *nest; 702 703 /* Interrupt and Polling infrastructure */ 704 struct delayed_work state_queue; 705 706 struct mutex lock; 707 708 /* This may be modified under the rtnl lock */ 709 bool sfp_bus_attached; 710 struct sfp_bus *sfp_bus; 711 struct phylink *phylink; 712 struct net_device *attached_dev; 713 struct mii_timestamper *mii_ts; 714 715 u8 mdix; 716 u8 mdix_ctrl; 717 718 int pma_extable; 719 720 void (*phy_link_change)(struct phy_device *phydev, bool up); 721 void (*adjust_link)(struct net_device *dev); 722 723 #if IS_ENABLED(CONFIG_MACSEC) 724 /* MACsec management functions */ 725 const struct macsec_ops *macsec_ops; 726 #endif 727 }; 728 729 static inline struct phy_device *to_phy_device(const struct device *dev) 730 { 731 return container_of(to_mdio_device(dev), struct phy_device, mdio); 732 } 733 734 /** 735 * struct phy_tdr_config - Configuration of a TDR raw test 736 * 737 * @first: Distance for first data collection point 738 * @last: Distance for last data collection point 739 * @step: Step between data collection points 740 * @pair: Bitmap of cable pairs to collect data for 741 * 742 * A structure containing possible configuration parameters 743 * for a TDR cable test. The driver does not need to implement 744 * all the parameters, but should report what is actually used. 745 * All distances are in centimeters. 746 */ 747 struct phy_tdr_config { 748 u32 first; 749 u32 last; 750 u32 step; 751 s8 pair; 752 }; 753 #define PHY_PAIR_ALL -1 754 755 /** 756 * struct phy_driver - Driver structure for a particular PHY type 757 * 758 * @mdiodrv: Data common to all MDIO devices 759 * @phy_id: The result of reading the UID registers of this PHY 760 * type, and ANDing them with the phy_id_mask. This driver 761 * only works for PHYs with IDs which match this field 762 * @name: The friendly name of this PHY type 763 * @phy_id_mask: Defines the important bits of the phy_id 764 * @features: A mandatory list of features (speed, duplex, etc) 765 * supported by this PHY 766 * @flags: A bitfield defining certain other features this PHY 767 * supports (like interrupts) 768 * @driver_data: Static driver data 769 * 770 * All functions are optional. If config_aneg or read_status 771 * are not implemented, the phy core uses the genphy versions. 772 * Note that none of these functions should be called from 773 * interrupt time. The goal is for the bus read/write functions 774 * to be able to block when the bus transaction is happening, 775 * and be freed up by an interrupt (The MPC85xx has this ability, 776 * though it is not currently supported in the driver). 777 */ 778 struct phy_driver { 779 struct mdio_driver_common mdiodrv; 780 u32 phy_id; 781 char *name; 782 u32 phy_id_mask; 783 const unsigned long * const features; 784 u32 flags; 785 const void *driver_data; 786 787 /** 788 * @soft_reset: Called to issue a PHY software reset 789 */ 790 int (*soft_reset)(struct phy_device *phydev); 791 792 /** 793 * @config_init: Called to initialize the PHY, 794 * including after a reset 795 */ 796 int (*config_init)(struct phy_device *phydev); 797 798 /** 799 * @probe: Called during discovery. Used to set 800 * up device-specific structures, if any 801 */ 802 int (*probe)(struct phy_device *phydev); 803 804 /** 805 * @get_features: Probe the hardware to determine what 806 * abilities it has. Should only set phydev->supported. 807 */ 808 int (*get_features)(struct phy_device *phydev); 809 810 /** 811 * @get_rate_matching: Get the supported type of rate matching for a 812 * particular phy interface. This is used by phy consumers to determine 813 * whether to advertise lower-speed modes for that interface. It is 814 * assumed that if a rate matching mode is supported on an interface, 815 * then that interface's rate can be adapted to all slower link speeds 816 * supported by the phy. If iface is %PHY_INTERFACE_MODE_NA, and the phy 817 * supports any kind of rate matching for any interface, then it must 818 * return that rate matching mode (preferring %RATE_MATCH_PAUSE to 819 * %RATE_MATCH_CRS). If the interface is not supported, this should 820 * return %RATE_MATCH_NONE. 821 */ 822 int (*get_rate_matching)(struct phy_device *phydev, 823 phy_interface_t iface); 824 825 /* PHY Power Management */ 826 /** @suspend: Suspend the hardware, saving state if needed */ 827 int (*suspend)(struct phy_device *phydev); 828 /** @resume: Resume the hardware, restoring state if needed */ 829 int (*resume)(struct phy_device *phydev); 830 831 /** 832 * @config_aneg: Configures the advertisement and resets 833 * autonegotiation if phydev->autoneg is on, 834 * forces the speed to the current settings in phydev 835 * if phydev->autoneg is off 836 */ 837 int (*config_aneg)(struct phy_device *phydev); 838 839 /** @aneg_done: Determines the auto negotiation result */ 840 int (*aneg_done)(struct phy_device *phydev); 841 842 /** @read_status: Determines the negotiated speed and duplex */ 843 int (*read_status)(struct phy_device *phydev); 844 845 /** 846 * @config_intr: Enables or disables interrupts. 847 * It should also clear any pending interrupts prior to enabling the 848 * IRQs and after disabling them. 849 */ 850 int (*config_intr)(struct phy_device *phydev); 851 852 /** @handle_interrupt: Override default interrupt handling */ 853 irqreturn_t (*handle_interrupt)(struct phy_device *phydev); 854 855 /** @remove: Clears up any memory if needed */ 856 void (*remove)(struct phy_device *phydev); 857 858 /** 859 * @match_phy_device: Returns true if this is a suitable 860 * driver for the given phydev. If NULL, matching is based on 861 * phy_id and phy_id_mask. 862 */ 863 int (*match_phy_device)(struct phy_device *phydev); 864 865 /** 866 * @set_wol: Some devices (e.g. qnap TS-119P II) require PHY 867 * register changes to enable Wake on LAN, so set_wol is 868 * provided to be called in the ethernet driver's set_wol 869 * function. 870 */ 871 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); 872 873 /** 874 * @get_wol: See set_wol, but for checking whether Wake on LAN 875 * is enabled. 876 */ 877 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); 878 879 /** 880 * @link_change_notify: Called to inform a PHY device driver 881 * when the core is about to change the link state. This 882 * callback is supposed to be used as fixup hook for drivers 883 * that need to take action when the link state 884 * changes. Drivers are by no means allowed to mess with the 885 * PHY device structure in their implementations. 886 */ 887 void (*link_change_notify)(struct phy_device *dev); 888 889 /** 890 * @read_mmd: PHY specific driver override for reading a MMD 891 * register. This function is optional for PHY specific 892 * drivers. When not provided, the default MMD read function 893 * will be used by phy_read_mmd(), which will use either a 894 * direct read for Clause 45 PHYs or an indirect read for 895 * Clause 22 PHYs. devnum is the MMD device number within the 896 * PHY device, regnum is the register within the selected MMD 897 * device. 898 */ 899 int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum); 900 901 /** 902 * @write_mmd: PHY specific driver override for writing a MMD 903 * register. This function is optional for PHY specific 904 * drivers. When not provided, the default MMD write function 905 * will be used by phy_write_mmd(), which will use either a 906 * direct write for Clause 45 PHYs, or an indirect write for 907 * Clause 22 PHYs. devnum is the MMD device number within the 908 * PHY device, regnum is the register within the selected MMD 909 * device. val is the value to be written. 910 */ 911 int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum, 912 u16 val); 913 914 /** @read_page: Return the current PHY register page number */ 915 int (*read_page)(struct phy_device *dev); 916 /** @write_page: Set the current PHY register page number */ 917 int (*write_page)(struct phy_device *dev, int page); 918 919 /** 920 * @module_info: Get the size and type of the eeprom contained 921 * within a plug-in module 922 */ 923 int (*module_info)(struct phy_device *dev, 924 struct ethtool_modinfo *modinfo); 925 926 /** 927 * @module_eeprom: Get the eeprom information from the plug-in 928 * module 929 */ 930 int (*module_eeprom)(struct phy_device *dev, 931 struct ethtool_eeprom *ee, u8 *data); 932 933 /** @cable_test_start: Start a cable test */ 934 int (*cable_test_start)(struct phy_device *dev); 935 936 /** @cable_test_tdr_start: Start a raw TDR cable test */ 937 int (*cable_test_tdr_start)(struct phy_device *dev, 938 const struct phy_tdr_config *config); 939 940 /** 941 * @cable_test_get_status: Once per second, or on interrupt, 942 * request the status of the test. 943 */ 944 int (*cable_test_get_status)(struct phy_device *dev, bool *finished); 945 946 /* Get statistics from the PHY using ethtool */ 947 /** @get_sset_count: Number of statistic counters */ 948 int (*get_sset_count)(struct phy_device *dev); 949 /** @get_strings: Names of the statistic counters */ 950 void (*get_strings)(struct phy_device *dev, u8 *data); 951 /** @get_stats: Return the statistic counter values */ 952 void (*get_stats)(struct phy_device *dev, 953 struct ethtool_stats *stats, u64 *data); 954 955 /* Get and Set PHY tunables */ 956 /** @get_tunable: Return the value of a tunable */ 957 int (*get_tunable)(struct phy_device *dev, 958 struct ethtool_tunable *tuna, void *data); 959 /** @set_tunable: Set the value of a tunable */ 960 int (*set_tunable)(struct phy_device *dev, 961 struct ethtool_tunable *tuna, 962 const void *data); 963 /** @set_loopback: Set the loopback mood of the PHY */ 964 int (*set_loopback)(struct phy_device *dev, bool enable); 965 /** @get_sqi: Get the signal quality indication */ 966 int (*get_sqi)(struct phy_device *dev); 967 /** @get_sqi_max: Get the maximum signal quality indication */ 968 int (*get_sqi_max)(struct phy_device *dev); 969 }; 970 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \ 971 struct phy_driver, mdiodrv) 972 973 #define PHY_ANY_ID "MATCH ANY PHY" 974 #define PHY_ANY_UID 0xffffffff 975 976 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0) 977 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4) 978 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10) 979 980 /* A Structure for boards to register fixups with the PHY Lib */ 981 struct phy_fixup { 982 struct list_head list; 983 char bus_id[MII_BUS_ID_SIZE + 3]; 984 u32 phy_uid; 985 u32 phy_uid_mask; 986 int (*run)(struct phy_device *phydev); 987 }; 988 989 const char *phy_speed_to_str(int speed); 990 const char *phy_duplex_to_str(unsigned int duplex); 991 const char *phy_rate_matching_to_str(int rate_matching); 992 993 int phy_interface_num_ports(phy_interface_t interface); 994 995 /* A structure for mapping a particular speed and duplex 996 * combination to a particular SUPPORTED and ADVERTISED value 997 */ 998 struct phy_setting { 999 u32 speed; 1000 u8 duplex; 1001 u8 bit; 1002 }; 1003 1004 const struct phy_setting * 1005 phy_lookup_setting(int speed, int duplex, const unsigned long *mask, 1006 bool exact); 1007 size_t phy_speeds(unsigned int *speeds, size_t size, 1008 unsigned long *mask); 1009 void of_set_phy_supported(struct phy_device *phydev); 1010 void of_set_phy_eee_broken(struct phy_device *phydev); 1011 int phy_speed_down_core(struct phy_device *phydev); 1012 1013 /** 1014 * phy_is_started - Convenience function to check whether PHY is started 1015 * @phydev: The phy_device struct 1016 */ 1017 static inline bool phy_is_started(struct phy_device *phydev) 1018 { 1019 return phydev->state >= PHY_UP; 1020 } 1021 1022 void phy_resolve_aneg_pause(struct phy_device *phydev); 1023 void phy_resolve_aneg_linkmode(struct phy_device *phydev); 1024 void phy_check_downshift(struct phy_device *phydev); 1025 1026 /** 1027 * phy_read - Convenience function for reading a given PHY register 1028 * @phydev: the phy_device struct 1029 * @regnum: register number to read 1030 * 1031 * NOTE: MUST NOT be called from interrupt context, 1032 * because the bus read/write functions may wait for an interrupt 1033 * to conclude the operation. 1034 */ 1035 static inline int phy_read(struct phy_device *phydev, u32 regnum) 1036 { 1037 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); 1038 } 1039 1040 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \ 1041 timeout_us, sleep_before_read) \ 1042 ({ \ 1043 int __ret = read_poll_timeout(phy_read, val, (cond) || val < 0, \ 1044 sleep_us, timeout_us, sleep_before_read, phydev, regnum); \ 1045 if (val < 0) \ 1046 __ret = val; \ 1047 if (__ret) \ 1048 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \ 1049 __ret; \ 1050 }) 1051 1052 1053 /** 1054 * __phy_read - convenience function for reading a given PHY register 1055 * @phydev: the phy_device struct 1056 * @regnum: register number to read 1057 * 1058 * The caller must have taken the MDIO bus lock. 1059 */ 1060 static inline int __phy_read(struct phy_device *phydev, u32 regnum) 1061 { 1062 return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); 1063 } 1064 1065 /** 1066 * phy_write - Convenience function for writing a given PHY register 1067 * @phydev: the phy_device struct 1068 * @regnum: register number to write 1069 * @val: value to write to @regnum 1070 * 1071 * NOTE: MUST NOT be called from interrupt context, 1072 * because the bus read/write functions may wait for an interrupt 1073 * to conclude the operation. 1074 */ 1075 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) 1076 { 1077 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val); 1078 } 1079 1080 /** 1081 * __phy_write - Convenience function for writing a given PHY register 1082 * @phydev: the phy_device struct 1083 * @regnum: register number to write 1084 * @val: value to write to @regnum 1085 * 1086 * The caller must have taken the MDIO bus lock. 1087 */ 1088 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val) 1089 { 1090 return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, 1091 val); 1092 } 1093 1094 /** 1095 * __phy_modify_changed() - Convenience function for modifying a PHY register 1096 * @phydev: a pointer to a &struct phy_device 1097 * @regnum: register number 1098 * @mask: bit mask of bits to clear 1099 * @set: bit mask of bits to set 1100 * 1101 * Unlocked helper function which allows a PHY register to be modified as 1102 * new register value = (old register value & ~mask) | set 1103 * 1104 * Returns negative errno, 0 if there was no change, and 1 in case of change 1105 */ 1106 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum, 1107 u16 mask, u16 set) 1108 { 1109 return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr, 1110 regnum, mask, set); 1111 } 1112 1113 /* 1114 * phy_read_mmd - Convenience function for reading a register 1115 * from an MMD on a given PHY. 1116 */ 1117 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); 1118 1119 /** 1120 * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a 1121 * condition is met or a timeout occurs 1122 * 1123 * @phydev: The phy_device struct 1124 * @devaddr: The MMD to read from 1125 * @regnum: The register on the MMD to read 1126 * @val: Variable to read the register into 1127 * @cond: Break condition (usually involving @val) 1128 * @sleep_us: Maximum time to sleep between reads in us (0 1129 * tight-loops). Should be less than ~20ms since usleep_range 1130 * is used (see Documentation/timers/timers-howto.rst). 1131 * @timeout_us: Timeout in us, 0 means never timeout 1132 * @sleep_before_read: if it is true, sleep @sleep_us before read. 1133 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either 1134 * case, the last read value at @args is stored in @val. Must not 1135 * be called from atomic context if sleep_us or timeout_us are used. 1136 */ 1137 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \ 1138 sleep_us, timeout_us, sleep_before_read) \ 1139 ({ \ 1140 int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \ 1141 sleep_us, timeout_us, sleep_before_read, \ 1142 phydev, devaddr, regnum); \ 1143 if (val < 0) \ 1144 __ret = val; \ 1145 if (__ret) \ 1146 phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \ 1147 __ret; \ 1148 }) 1149 1150 /* 1151 * __phy_read_mmd - Convenience function for reading a register 1152 * from an MMD on a given PHY. 1153 */ 1154 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); 1155 1156 /* 1157 * phy_write_mmd - Convenience function for writing a register 1158 * on an MMD on a given PHY. 1159 */ 1160 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val); 1161 1162 /* 1163 * __phy_write_mmd - Convenience function for writing a register 1164 * on an MMD on a given PHY. 1165 */ 1166 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val); 1167 1168 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask, 1169 u16 set); 1170 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask, 1171 u16 set); 1172 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); 1173 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); 1174 1175 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum, 1176 u16 mask, u16 set); 1177 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum, 1178 u16 mask, u16 set); 1179 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum, 1180 u16 mask, u16 set); 1181 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum, 1182 u16 mask, u16 set); 1183 1184 /** 1185 * __phy_set_bits - Convenience function for setting bits in a PHY register 1186 * @phydev: the phy_device struct 1187 * @regnum: register number to write 1188 * @val: bits to set 1189 * 1190 * The caller must have taken the MDIO bus lock. 1191 */ 1192 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) 1193 { 1194 return __phy_modify(phydev, regnum, 0, val); 1195 } 1196 1197 /** 1198 * __phy_clear_bits - Convenience function for clearing bits in a PHY register 1199 * @phydev: the phy_device struct 1200 * @regnum: register number to write 1201 * @val: bits to clear 1202 * 1203 * The caller must have taken the MDIO bus lock. 1204 */ 1205 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum, 1206 u16 val) 1207 { 1208 return __phy_modify(phydev, regnum, val, 0); 1209 } 1210 1211 /** 1212 * phy_set_bits - Convenience function for setting bits in a PHY register 1213 * @phydev: the phy_device struct 1214 * @regnum: register number to write 1215 * @val: bits to set 1216 */ 1217 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) 1218 { 1219 return phy_modify(phydev, regnum, 0, val); 1220 } 1221 1222 /** 1223 * phy_clear_bits - Convenience function for clearing bits in a PHY register 1224 * @phydev: the phy_device struct 1225 * @regnum: register number to write 1226 * @val: bits to clear 1227 */ 1228 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val) 1229 { 1230 return phy_modify(phydev, regnum, val, 0); 1231 } 1232 1233 /** 1234 * __phy_set_bits_mmd - Convenience function for setting bits in a register 1235 * on MMD 1236 * @phydev: the phy_device struct 1237 * @devad: the MMD containing register to modify 1238 * @regnum: register number to modify 1239 * @val: bits to set 1240 * 1241 * The caller must have taken the MDIO bus lock. 1242 */ 1243 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad, 1244 u32 regnum, u16 val) 1245 { 1246 return __phy_modify_mmd(phydev, devad, regnum, 0, val); 1247 } 1248 1249 /** 1250 * __phy_clear_bits_mmd - Convenience function for clearing bits in a register 1251 * on MMD 1252 * @phydev: the phy_device struct 1253 * @devad: the MMD containing register to modify 1254 * @regnum: register number to modify 1255 * @val: bits to clear 1256 * 1257 * The caller must have taken the MDIO bus lock. 1258 */ 1259 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad, 1260 u32 regnum, u16 val) 1261 { 1262 return __phy_modify_mmd(phydev, devad, regnum, val, 0); 1263 } 1264 1265 /** 1266 * phy_set_bits_mmd - Convenience function for setting bits in a register 1267 * on MMD 1268 * @phydev: the phy_device struct 1269 * @devad: the MMD containing register to modify 1270 * @regnum: register number to modify 1271 * @val: bits to set 1272 */ 1273 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad, 1274 u32 regnum, u16 val) 1275 { 1276 return phy_modify_mmd(phydev, devad, regnum, 0, val); 1277 } 1278 1279 /** 1280 * phy_clear_bits_mmd - Convenience function for clearing bits in a register 1281 * on MMD 1282 * @phydev: the phy_device struct 1283 * @devad: the MMD containing register to modify 1284 * @regnum: register number to modify 1285 * @val: bits to clear 1286 */ 1287 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad, 1288 u32 regnum, u16 val) 1289 { 1290 return phy_modify_mmd(phydev, devad, regnum, val, 0); 1291 } 1292 1293 /** 1294 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq 1295 * @phydev: the phy_device struct 1296 * 1297 * NOTE: must be kept in sync with addition/removal of PHY_POLL and 1298 * PHY_MAC_INTERRUPT 1299 */ 1300 static inline bool phy_interrupt_is_valid(struct phy_device *phydev) 1301 { 1302 return phydev->irq != PHY_POLL && phydev->irq != PHY_MAC_INTERRUPT; 1303 } 1304 1305 /** 1306 * phy_polling_mode - Convenience function for testing whether polling is 1307 * used to detect PHY status changes 1308 * @phydev: the phy_device struct 1309 */ 1310 static inline bool phy_polling_mode(struct phy_device *phydev) 1311 { 1312 if (phydev->state == PHY_CABLETEST) 1313 if (phydev->drv->flags & PHY_POLL_CABLE_TEST) 1314 return true; 1315 1316 return phydev->irq == PHY_POLL; 1317 } 1318 1319 /** 1320 * phy_has_hwtstamp - Tests whether a PHY time stamp configuration. 1321 * @phydev: the phy_device struct 1322 */ 1323 static inline bool phy_has_hwtstamp(struct phy_device *phydev) 1324 { 1325 return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp; 1326 } 1327 1328 /** 1329 * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping. 1330 * @phydev: the phy_device struct 1331 */ 1332 static inline bool phy_has_rxtstamp(struct phy_device *phydev) 1333 { 1334 return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp; 1335 } 1336 1337 /** 1338 * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or 1339 * PTP hardware clock capabilities. 1340 * @phydev: the phy_device struct 1341 */ 1342 static inline bool phy_has_tsinfo(struct phy_device *phydev) 1343 { 1344 return phydev && phydev->mii_ts && phydev->mii_ts->ts_info; 1345 } 1346 1347 /** 1348 * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping. 1349 * @phydev: the phy_device struct 1350 */ 1351 static inline bool phy_has_txtstamp(struct phy_device *phydev) 1352 { 1353 return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp; 1354 } 1355 1356 static inline int phy_hwtstamp(struct phy_device *phydev, struct ifreq *ifr) 1357 { 1358 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr); 1359 } 1360 1361 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb, 1362 int type) 1363 { 1364 return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type); 1365 } 1366 1367 static inline int phy_ts_info(struct phy_device *phydev, 1368 struct ethtool_ts_info *tsinfo) 1369 { 1370 return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo); 1371 } 1372 1373 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb, 1374 int type) 1375 { 1376 phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type); 1377 } 1378 1379 /** 1380 * phy_is_internal - Convenience function for testing if a PHY is internal 1381 * @phydev: the phy_device struct 1382 */ 1383 static inline bool phy_is_internal(struct phy_device *phydev) 1384 { 1385 return phydev->is_internal; 1386 } 1387 1388 /** 1389 * phy_on_sfp - Convenience function for testing if a PHY is on an SFP module 1390 * @phydev: the phy_device struct 1391 */ 1392 static inline bool phy_on_sfp(struct phy_device *phydev) 1393 { 1394 return phydev->is_on_sfp_module; 1395 } 1396 1397 /** 1398 * phy_interface_mode_is_rgmii - Convenience function for testing if a 1399 * PHY interface mode is RGMII (all variants) 1400 * @mode: the &phy_interface_t enum 1401 */ 1402 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode) 1403 { 1404 return mode >= PHY_INTERFACE_MODE_RGMII && 1405 mode <= PHY_INTERFACE_MODE_RGMII_TXID; 1406 }; 1407 1408 /** 1409 * phy_interface_mode_is_8023z() - does the PHY interface mode use 802.3z 1410 * negotiation 1411 * @mode: one of &enum phy_interface_t 1412 * 1413 * Returns true if the PHY interface mode uses the 16-bit negotiation 1414 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding) 1415 */ 1416 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode) 1417 { 1418 return mode == PHY_INTERFACE_MODE_1000BASEX || 1419 mode == PHY_INTERFACE_MODE_2500BASEX; 1420 } 1421 1422 /** 1423 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface 1424 * is RGMII (all variants) 1425 * @phydev: the phy_device struct 1426 */ 1427 static inline bool phy_interface_is_rgmii(struct phy_device *phydev) 1428 { 1429 return phy_interface_mode_is_rgmii(phydev->interface); 1430 }; 1431 1432 /** 1433 * phy_is_pseudo_fixed_link - Convenience function for testing if this 1434 * PHY is the CPU port facing side of an Ethernet switch, or similar. 1435 * @phydev: the phy_device struct 1436 */ 1437 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev) 1438 { 1439 return phydev->is_pseudo_fixed_link; 1440 } 1441 1442 int phy_save_page(struct phy_device *phydev); 1443 int phy_select_page(struct phy_device *phydev, int page); 1444 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret); 1445 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum); 1446 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val); 1447 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum, 1448 u16 mask, u16 set); 1449 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum, 1450 u16 mask, u16 set); 1451 1452 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id, 1453 bool is_c45, 1454 struct phy_c45_device_ids *c45_ids); 1455 #if IS_ENABLED(CONFIG_PHYLIB) 1456 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id); 1457 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode); 1458 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode); 1459 struct phy_device *device_phy_find_device(struct device *dev); 1460 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode); 1461 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); 1462 int phy_device_register(struct phy_device *phy); 1463 void phy_device_free(struct phy_device *phydev); 1464 #else 1465 static inline int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id) 1466 { 1467 return 0; 1468 } 1469 static inline 1470 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode) 1471 { 1472 return 0; 1473 } 1474 1475 static inline 1476 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode) 1477 { 1478 return NULL; 1479 } 1480 1481 static inline struct phy_device *device_phy_find_device(struct device *dev) 1482 { 1483 return NULL; 1484 } 1485 1486 static inline 1487 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode) 1488 { 1489 return NULL; 1490 } 1491 1492 static inline 1493 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45) 1494 { 1495 return NULL; 1496 } 1497 1498 static inline int phy_device_register(struct phy_device *phy) 1499 { 1500 return 0; 1501 } 1502 1503 static inline void phy_device_free(struct phy_device *phydev) { } 1504 #endif /* CONFIG_PHYLIB */ 1505 void phy_device_remove(struct phy_device *phydev); 1506 int phy_get_c45_ids(struct phy_device *phydev); 1507 int phy_init_hw(struct phy_device *phydev); 1508 int phy_suspend(struct phy_device *phydev); 1509 int phy_resume(struct phy_device *phydev); 1510 int __phy_resume(struct phy_device *phydev); 1511 int phy_loopback(struct phy_device *phydev, bool enable); 1512 void phy_sfp_attach(void *upstream, struct sfp_bus *bus); 1513 void phy_sfp_detach(void *upstream, struct sfp_bus *bus); 1514 int phy_sfp_probe(struct phy_device *phydev, 1515 const struct sfp_upstream_ops *ops); 1516 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, 1517 phy_interface_t interface); 1518 struct phy_device *phy_find_first(struct mii_bus *bus); 1519 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, 1520 u32 flags, phy_interface_t interface); 1521 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, 1522 void (*handler)(struct net_device *), 1523 phy_interface_t interface); 1524 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, 1525 void (*handler)(struct net_device *), 1526 phy_interface_t interface); 1527 void phy_disconnect(struct phy_device *phydev); 1528 void phy_detach(struct phy_device *phydev); 1529 void phy_start(struct phy_device *phydev); 1530 void phy_stop(struct phy_device *phydev); 1531 int phy_config_aneg(struct phy_device *phydev); 1532 int phy_start_aneg(struct phy_device *phydev); 1533 int phy_aneg_done(struct phy_device *phydev); 1534 int phy_speed_down(struct phy_device *phydev, bool sync); 1535 int phy_speed_up(struct phy_device *phydev); 1536 1537 int phy_restart_aneg(struct phy_device *phydev); 1538 int phy_reset_after_clk_enable(struct phy_device *phydev); 1539 1540 #if IS_ENABLED(CONFIG_PHYLIB) 1541 int phy_start_cable_test(struct phy_device *phydev, 1542 struct netlink_ext_ack *extack); 1543 int phy_start_cable_test_tdr(struct phy_device *phydev, 1544 struct netlink_ext_ack *extack, 1545 const struct phy_tdr_config *config); 1546 #else 1547 static inline 1548 int phy_start_cable_test(struct phy_device *phydev, 1549 struct netlink_ext_ack *extack) 1550 { 1551 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support"); 1552 return -EOPNOTSUPP; 1553 } 1554 static inline 1555 int phy_start_cable_test_tdr(struct phy_device *phydev, 1556 struct netlink_ext_ack *extack, 1557 const struct phy_tdr_config *config) 1558 { 1559 NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support"); 1560 return -EOPNOTSUPP; 1561 } 1562 #endif 1563 1564 int phy_cable_test_result(struct phy_device *phydev, u8 pair, u16 result); 1565 int phy_cable_test_fault_length(struct phy_device *phydev, u8 pair, 1566 u16 cm); 1567 1568 static inline void phy_device_reset(struct phy_device *phydev, int value) 1569 { 1570 mdio_device_reset(&phydev->mdio, value); 1571 } 1572 1573 #define phydev_err(_phydev, format, args...) \ 1574 dev_err(&_phydev->mdio.dev, format, ##args) 1575 1576 #define phydev_err_probe(_phydev, err, format, args...) \ 1577 dev_err_probe(&_phydev->mdio.dev, err, format, ##args) 1578 1579 #define phydev_info(_phydev, format, args...) \ 1580 dev_info(&_phydev->mdio.dev, format, ##args) 1581 1582 #define phydev_warn(_phydev, format, args...) \ 1583 dev_warn(&_phydev->mdio.dev, format, ##args) 1584 1585 #define phydev_dbg(_phydev, format, args...) \ 1586 dev_dbg(&_phydev->mdio.dev, format, ##args) 1587 1588 static inline const char *phydev_name(const struct phy_device *phydev) 1589 { 1590 return dev_name(&phydev->mdio.dev); 1591 } 1592 1593 static inline void phy_lock_mdio_bus(struct phy_device *phydev) 1594 { 1595 mutex_lock(&phydev->mdio.bus->mdio_lock); 1596 } 1597 1598 static inline void phy_unlock_mdio_bus(struct phy_device *phydev) 1599 { 1600 mutex_unlock(&phydev->mdio.bus->mdio_lock); 1601 } 1602 1603 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...) 1604 __printf(2, 3); 1605 char *phy_attached_info_irq(struct phy_device *phydev) 1606 __malloc; 1607 void phy_attached_info(struct phy_device *phydev); 1608 1609 /* Clause 22 PHY */ 1610 int genphy_read_abilities(struct phy_device *phydev); 1611 int genphy_setup_forced(struct phy_device *phydev); 1612 int genphy_restart_aneg(struct phy_device *phydev); 1613 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart); 1614 int genphy_config_eee_advert(struct phy_device *phydev); 1615 int __genphy_config_aneg(struct phy_device *phydev, bool changed); 1616 int genphy_aneg_done(struct phy_device *phydev); 1617 int genphy_update_link(struct phy_device *phydev); 1618 int genphy_read_lpa(struct phy_device *phydev); 1619 int genphy_read_status_fixed(struct phy_device *phydev); 1620 int genphy_read_status(struct phy_device *phydev); 1621 int genphy_read_master_slave(struct phy_device *phydev); 1622 int genphy_suspend(struct phy_device *phydev); 1623 int genphy_resume(struct phy_device *phydev); 1624 int genphy_loopback(struct phy_device *phydev, bool enable); 1625 int genphy_soft_reset(struct phy_device *phydev); 1626 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev); 1627 1628 static inline int genphy_config_aneg(struct phy_device *phydev) 1629 { 1630 return __genphy_config_aneg(phydev, false); 1631 } 1632 1633 static inline int genphy_no_config_intr(struct phy_device *phydev) 1634 { 1635 return 0; 1636 } 1637 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, 1638 u16 regnum); 1639 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum, 1640 u16 regnum, u16 val); 1641 1642 /* Clause 37 */ 1643 int genphy_c37_config_aneg(struct phy_device *phydev); 1644 int genphy_c37_read_status(struct phy_device *phydev); 1645 1646 /* Clause 45 PHY */ 1647 int genphy_c45_restart_aneg(struct phy_device *phydev); 1648 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart); 1649 int genphy_c45_aneg_done(struct phy_device *phydev); 1650 int genphy_c45_read_link(struct phy_device *phydev); 1651 int genphy_c45_read_lpa(struct phy_device *phydev); 1652 int genphy_c45_read_pma(struct phy_device *phydev); 1653 int genphy_c45_pma_setup_forced(struct phy_device *phydev); 1654 int genphy_c45_pma_baset1_setup_master_slave(struct phy_device *phydev); 1655 int genphy_c45_an_config_aneg(struct phy_device *phydev); 1656 int genphy_c45_an_disable_aneg(struct phy_device *phydev); 1657 int genphy_c45_read_mdix(struct phy_device *phydev); 1658 int genphy_c45_pma_read_abilities(struct phy_device *phydev); 1659 int genphy_c45_pma_baset1_read_master_slave(struct phy_device *phydev); 1660 int genphy_c45_read_status(struct phy_device *phydev); 1661 int genphy_c45_baset1_read_status(struct phy_device *phydev); 1662 int genphy_c45_config_aneg(struct phy_device *phydev); 1663 int genphy_c45_loopback(struct phy_device *phydev, bool enable); 1664 int genphy_c45_pma_resume(struct phy_device *phydev); 1665 int genphy_c45_pma_suspend(struct phy_device *phydev); 1666 int genphy_c45_fast_retrain(struct phy_device *phydev, bool enable); 1667 1668 /* Generic C45 PHY driver */ 1669 extern struct phy_driver genphy_c45_driver; 1670 1671 /* The gen10g_* functions are the old Clause 45 stub */ 1672 int gen10g_config_aneg(struct phy_device *phydev); 1673 1674 static inline int phy_read_status(struct phy_device *phydev) 1675 { 1676 if (!phydev->drv) 1677 return -EIO; 1678 1679 if (phydev->drv->read_status) 1680 return phydev->drv->read_status(phydev); 1681 else 1682 return genphy_read_status(phydev); 1683 } 1684 1685 void phy_driver_unregister(struct phy_driver *drv); 1686 void phy_drivers_unregister(struct phy_driver *drv, int n); 1687 int phy_driver_register(struct phy_driver *new_driver, struct module *owner); 1688 int phy_drivers_register(struct phy_driver *new_driver, int n, 1689 struct module *owner); 1690 void phy_error(struct phy_device *phydev); 1691 void phy_state_machine(struct work_struct *work); 1692 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies); 1693 void phy_trigger_machine(struct phy_device *phydev); 1694 void phy_mac_interrupt(struct phy_device *phydev); 1695 void phy_start_machine(struct phy_device *phydev); 1696 void phy_stop_machine(struct phy_device *phydev); 1697 void phy_ethtool_ksettings_get(struct phy_device *phydev, 1698 struct ethtool_link_ksettings *cmd); 1699 int phy_ethtool_ksettings_set(struct phy_device *phydev, 1700 const struct ethtool_link_ksettings *cmd); 1701 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); 1702 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd); 1703 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd); 1704 int phy_disable_interrupts(struct phy_device *phydev); 1705 void phy_request_interrupt(struct phy_device *phydev); 1706 void phy_free_interrupt(struct phy_device *phydev); 1707 void phy_print_status(struct phy_device *phydev); 1708 int phy_get_rate_matching(struct phy_device *phydev, 1709 phy_interface_t iface); 1710 void phy_set_max_speed(struct phy_device *phydev, u32 max_speed); 1711 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode); 1712 void phy_advertise_supported(struct phy_device *phydev); 1713 void phy_support_sym_pause(struct phy_device *phydev); 1714 void phy_support_asym_pause(struct phy_device *phydev); 1715 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx, 1716 bool autoneg); 1717 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx); 1718 bool phy_validate_pause(struct phy_device *phydev, 1719 struct ethtool_pauseparam *pp); 1720 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause); 1721 1722 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev, 1723 const int *delay_values, int size, bool is_rx); 1724 1725 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv, 1726 bool *tx_pause, bool *rx_pause); 1727 1728 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, 1729 int (*run)(struct phy_device *)); 1730 int phy_register_fixup_for_id(const char *bus_id, 1731 int (*run)(struct phy_device *)); 1732 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, 1733 int (*run)(struct phy_device *)); 1734 1735 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask); 1736 int phy_unregister_fixup_for_id(const char *bus_id); 1737 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask); 1738 1739 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); 1740 int phy_get_eee_err(struct phy_device *phydev); 1741 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); 1742 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); 1743 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); 1744 void phy_ethtool_get_wol(struct phy_device *phydev, 1745 struct ethtool_wolinfo *wol); 1746 int phy_ethtool_get_link_ksettings(struct net_device *ndev, 1747 struct ethtool_link_ksettings *cmd); 1748 int phy_ethtool_set_link_ksettings(struct net_device *ndev, 1749 const struct ethtool_link_ksettings *cmd); 1750 int phy_ethtool_nway_reset(struct net_device *ndev); 1751 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size); 1752 void phy_package_leave(struct phy_device *phydev); 1753 int devm_phy_package_join(struct device *dev, struct phy_device *phydev, 1754 int addr, size_t priv_size); 1755 1756 #if IS_ENABLED(CONFIG_PHYLIB) 1757 int __init mdio_bus_init(void); 1758 void mdio_bus_exit(void); 1759 #endif 1760 1761 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data); 1762 int phy_ethtool_get_sset_count(struct phy_device *phydev); 1763 int phy_ethtool_get_stats(struct phy_device *phydev, 1764 struct ethtool_stats *stats, u64 *data); 1765 1766 static inline int phy_package_read(struct phy_device *phydev, u32 regnum) 1767 { 1768 struct phy_package_shared *shared = phydev->shared; 1769 1770 if (!shared) 1771 return -EIO; 1772 1773 return mdiobus_read(phydev->mdio.bus, shared->addr, regnum); 1774 } 1775 1776 static inline int __phy_package_read(struct phy_device *phydev, u32 regnum) 1777 { 1778 struct phy_package_shared *shared = phydev->shared; 1779 1780 if (!shared) 1781 return -EIO; 1782 1783 return __mdiobus_read(phydev->mdio.bus, shared->addr, regnum); 1784 } 1785 1786 static inline int phy_package_write(struct phy_device *phydev, 1787 u32 regnum, u16 val) 1788 { 1789 struct phy_package_shared *shared = phydev->shared; 1790 1791 if (!shared) 1792 return -EIO; 1793 1794 return mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val); 1795 } 1796 1797 static inline int __phy_package_write(struct phy_device *phydev, 1798 u32 regnum, u16 val) 1799 { 1800 struct phy_package_shared *shared = phydev->shared; 1801 1802 if (!shared) 1803 return -EIO; 1804 1805 return __mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val); 1806 } 1807 1808 static inline bool __phy_package_set_once(struct phy_device *phydev, 1809 unsigned int b) 1810 { 1811 struct phy_package_shared *shared = phydev->shared; 1812 1813 if (!shared) 1814 return false; 1815 1816 return !test_and_set_bit(b, &shared->flags); 1817 } 1818 1819 static inline bool phy_package_init_once(struct phy_device *phydev) 1820 { 1821 return __phy_package_set_once(phydev, PHY_SHARED_F_INIT_DONE); 1822 } 1823 1824 static inline bool phy_package_probe_once(struct phy_device *phydev) 1825 { 1826 return __phy_package_set_once(phydev, PHY_SHARED_F_PROBE_DONE); 1827 } 1828 1829 extern struct bus_type mdio_bus_type; 1830 1831 struct mdio_board_info { 1832 const char *bus_id; 1833 char modalias[MDIO_NAME_SIZE]; 1834 int mdio_addr; 1835 const void *platform_data; 1836 }; 1837 1838 #if IS_ENABLED(CONFIG_MDIO_DEVICE) 1839 int mdiobus_register_board_info(const struct mdio_board_info *info, 1840 unsigned int n); 1841 #else 1842 static inline int mdiobus_register_board_info(const struct mdio_board_info *i, 1843 unsigned int n) 1844 { 1845 return 0; 1846 } 1847 #endif 1848 1849 1850 /** 1851 * phy_module_driver() - Helper macro for registering PHY drivers 1852 * @__phy_drivers: array of PHY drivers to register 1853 * @__count: Numbers of members in array 1854 * 1855 * Helper macro for PHY drivers which do not do anything special in module 1856 * init/exit. Each module may only use this macro once, and calling it 1857 * replaces module_init() and module_exit(). 1858 */ 1859 #define phy_module_driver(__phy_drivers, __count) \ 1860 static int __init phy_module_init(void) \ 1861 { \ 1862 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \ 1863 } \ 1864 module_init(phy_module_init); \ 1865 static void __exit phy_module_exit(void) \ 1866 { \ 1867 phy_drivers_unregister(__phy_drivers, __count); \ 1868 } \ 1869 module_exit(phy_module_exit) 1870 1871 #define module_phy_driver(__phy_drivers) \ 1872 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) 1873 1874 bool phy_driver_is_genphy(struct phy_device *phydev); 1875 bool phy_driver_is_genphy_10g(struct phy_device *phydev); 1876 1877 #endif /* __PHY_H */ 1878