include/linux/phy.h

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