include/phy.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright 2011 Freescale Semiconductor, Inc.
   4  *      Andy Fleming <afleming@gmail.com>
   5  *
   6  * This file pretty much stolen from Linux's mii.h/ethtool.h/phy.h
   7  */
   8
   9 #ifndef _PHY_H
  10 #define _PHY_H
  11
  12 #include <dm.h>
  13 #include <linux/errno.h>
  14 #include <linux/list.h>
  15 #include <linux/mii.h>
  16 #include <linux/ethtool.h>
  17 #include <linux/mdio.h>
  18 #include <log.h>
  19 #include <phy_interface.h>
  20
  21 #define PHY_FIXED_ID            0xa5a55a5a
  22 #define PHY_NCSI_ID            0xbeefcafe
  23
  24 /*
  25  * There is no actual id for this.
  26  * This is just a dummy id for gmii2rgmmi converter.
  27  */
  28 #define PHY_GMII2RGMII_ID       0x5a5a5a5a
  29
  30 #define PHY_MAX_ADDR 32
  31
  32 #define PHY_FLAG_BROKEN_RESET   (1 << 0) /* soft reset not supported */
  33
  34 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
  35                                  SUPPORTED_TP | \
  36                                  SUPPORTED_MII)
  37
  38 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
  39                                  SUPPORTED_10baseT_Full)
  40
  41 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
  42                                  SUPPORTED_100baseT_Full)
  43
  44 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
  45                                  SUPPORTED_1000baseT_Full)
  46
  47 #define PHY_BASIC_FEATURES      (PHY_10BT_FEATURES | \
  48                                  PHY_100BT_FEATURES | \
  49                                  PHY_DEFAULT_FEATURES)
  50
  51 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
  52                                  PHY_1000BT_FEATURES)
  53
  54 #define PHY_10G_FEATURES        (PHY_GBIT_FEATURES | \
  55                                 SUPPORTED_10000baseT_Full)
  56
  57 #ifndef PHY_ANEG_TIMEOUT
  58 #define PHY_ANEG_TIMEOUT        4000
  59 #endif
  60
  61
  62 struct phy_device;
  63
  64 #define MDIO_NAME_LEN 32
  65
  66 struct mii_dev {
  67         struct list_head link;
  68         char name[MDIO_NAME_LEN];
  69         void *priv;
  70         int (*read)(struct mii_dev *bus, int addr, int devad, int reg);
  71         int (*write)(struct mii_dev *bus, int addr, int devad, int reg,
  72                         u16 val);
  73         int (*reset)(struct mii_dev *bus);
  74         struct phy_device *phymap[PHY_MAX_ADDR];
  75         u32 phy_mask;
  76 };
  77
  78 /* struct phy_driver: a structure which defines PHY behavior
  79  *
  80  * uid will contain a number which represents the PHY.  During
  81  * startup, the driver will poll the PHY to find out what its
  82  * UID--as defined by registers 2 and 3--is.  The 32-bit result
  83  * gotten from the PHY will be masked to
  84  * discard any bits which may change based on revision numbers
  85  * unimportant to functionality
  86  *
  87  */
  88 struct phy_driver {
  89         char *name;
  90         unsigned int uid;
  91         unsigned int mask;
  92         unsigned int mmds;
  93
  94         u32 features;
  95
  96         /* Called to do any driver startup necessities */
  97         /* Will be called during phy_connect */
  98         int (*probe)(struct phy_device *phydev);
  99
 100         /* Called to configure the PHY, and modify the controller
 101          * based on the results.  Should be called after phy_connect */
 102         int (*config)(struct phy_device *phydev);
 103
 104         /* Called when starting up the controller */
 105         int (*startup)(struct phy_device *phydev);
 106
 107         /* Called when bringing down the controller */
 108         int (*shutdown)(struct phy_device *phydev);
 109
 110         int (*readext)(struct phy_device *phydev, int addr, int devad, int reg);
 111         int (*writeext)(struct phy_device *phydev, int addr, int devad, int reg,
 112                         u16 val);
 113
 114         /* Phy specific driver override for reading a MMD register */
 115         int (*read_mmd)(struct phy_device *phydev, int devad, int reg);
 116
 117         /* Phy specific driver override for writing a MMD register */
 118         int (*write_mmd)(struct phy_device *phydev, int devad, int reg,
 119                          u16 val);
 120
 121         struct list_head list;
 122
 123         /* driver private data */
 124         ulong data;
 125 };
 126
 127 struct phy_device {
 128         /* Information about the PHY type */
 129         /* And management functions */
 130         struct mii_dev *bus;
 131         struct phy_driver *drv;
 132         void *priv;
 133
 134 #ifdef CONFIG_DM_ETH
 135         struct udevice *dev;
 136         ofnode node;
 137 #else
 138         struct eth_device *dev;
 139 #endif
 140
 141         /* forced speed & duplex (no autoneg)
 142          * partner speed & duplex & pause (autoneg)
 143          */
 144         int speed;
 145         int duplex;
 146
 147         /* The most recently read link state */
 148         int link;
 149         int port;
 150         phy_interface_t interface;
 151
 152         u32 advertising;
 153         u32 supported;
 154         u32 mmds;
 155
 156         int autoneg;
 157         int addr;
 158         int pause;
 159         int asym_pause;
 160         u32 phy_id;
 161         bool is_c45;
 162         u32 flags;
 163 };
 164
 165 struct fixed_link {
 166         int phy_id;
 167         int duplex;
 168         int link_speed;
 169         int pause;
 170         int asym_pause;
 171 };
 172
 173 /**
 174  * phy_read - Convenience function for reading a given PHY register
 175  * @phydev: the phy_device struct
 176  * @devad: The MMD to read from
 177  * @regnum: register number to read
 178  * @return: value for success or negative errno for failure
 179  */
 180 static inline int phy_read(struct phy_device *phydev, int devad, int regnum)
 181 {
 182         struct mii_dev *bus = phydev->bus;
 183
 184         if (!bus || !bus->read) {
 185                 debug("%s: No bus configured\n", __func__);
 186                 return -1;
 187         }
 188
 189         return bus->read(bus, phydev->addr, devad, regnum);
 190 }
 191
 192 /**
 193  * phy_write - Convenience function for writing a given PHY register
 194  * @phydev: the phy_device struct
 195  * @devad: The MMD to read from
 196  * @regnum: register number to write
 197  * @val: value to write to @regnum
 198  * @return: 0 for success or negative errno for failure
 199  */
 200 static inline int phy_write(struct phy_device *phydev, int devad, int regnum,
 201                         u16 val)
 202 {
 203         struct mii_dev *bus = phydev->bus;
 204
 205         if (!bus || !bus->read) {
 206                 debug("%s: No bus configured\n", __func__);
 207                 return -1;
 208         }
 209
 210         return bus->write(bus, phydev->addr, devad, regnum, val);
 211 }
 212
 213 /**
 214  * phy_mmd_start_indirect - Convenience function for writing MMD registers
 215  * @phydev: the phy_device struct
 216  * @devad: The MMD to read from
 217  * @regnum: register number to write
 218  * @return: None
 219  */
 220 static inline void phy_mmd_start_indirect(struct phy_device *phydev, int devad,
 221                                           int regnum)
 222 {
 223         /* Write the desired MMD Devad */
 224         phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_CTRL, devad);
 225
 226         /* Write the desired MMD register address */
 227         phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_DATA, regnum);
 228
 229         /* Select the Function : DATA with no post increment */
 230         phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_CTRL,
 231                   (devad | MII_MMD_CTRL_NOINCR));
 232 }
 233
 234 /**
 235  * phy_read_mmd - Convenience function for reading a register
 236  * from an MMD on a given PHY.
 237  * @phydev: The phy_device struct
 238  * @devad: The MMD to read from
 239  * @regnum: The register on the MMD to read
 240  * @return: Value for success or negative errno for failure
 241  */
 242 static inline int phy_read_mmd(struct phy_device *phydev, int devad,
 243                                int regnum)
 244 {
 245         struct phy_driver *drv = phydev->drv;
 246
 247         if (regnum > (u16)~0 || devad > 32)
 248                 return -EINVAL;
 249
 250         /* driver-specific access */
 251         if (drv->read_mmd)
 252                 return drv->read_mmd(phydev, devad, regnum);
 253
 254         /* direct C45 / C22 access */
 255         if ((drv->features & PHY_10G_FEATURES) == PHY_10G_FEATURES ||
 256             devad == MDIO_DEVAD_NONE || !devad)
 257                 return phy_read(phydev, devad, regnum);
 258
 259         /* indirect C22 access */
 260         phy_mmd_start_indirect(phydev, devad, regnum);
 261
 262         /* Read the content of the MMD's selected register */
 263         return phy_read(phydev, MDIO_DEVAD_NONE, MII_MMD_DATA);
 264 }
 265
 266 /**
 267  * phy_write_mmd - Convenience function for writing a register
 268  * on an MMD on a given PHY.
 269  * @phydev: The phy_device struct
 270  * @devad: The MMD to read from
 271  * @regnum: The register on the MMD to read
 272  * @val: value to write to @regnum
 273  * @return: 0 for success or negative errno for failure
 274  */
 275 static inline int phy_write_mmd(struct phy_device *phydev, int devad,
 276                                 int regnum, u16 val)
 277 {
 278         struct phy_driver *drv = phydev->drv;
 279
 280         if (regnum > (u16)~0 || devad > 32)
 281                 return -EINVAL;
 282
 283         /* driver-specific access */
 284         if (drv->write_mmd)
 285                 return drv->write_mmd(phydev, devad, regnum, val);
 286
 287         /* direct C45 / C22 access */
 288         if ((drv->features & PHY_10G_FEATURES) == PHY_10G_FEATURES ||
 289             devad == MDIO_DEVAD_NONE || !devad)
 290                 return phy_write(phydev, devad, regnum, val);
 291
 292         /* indirect C22 access */
 293         phy_mmd_start_indirect(phydev, devad, regnum);
 294
 295         /* Write the data into MMD's selected register */
 296         return phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_DATA, val);
 297 }
 298
 299 /**
 300  * phy_set_bits_mmd - Convenience function for setting bits in a register
 301  * on MMD
 302  * @phydev: the phy_device struct
 303  * @devad: the MMD containing register to modify
 304  * @regnum: register number to modify
 305  * @val: bits to set
 306  * @return: 0 for success or negative errno for failure
 307  */
 308 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
 309                                    u32 regnum, u16 val)
 310 {
 311         int value, ret;
 312
 313         value = phy_read_mmd(phydev, devad, regnum);
 314         if (value < 0)
 315                 return value;
 316
 317         value |= val;
 318
 319         ret = phy_write_mmd(phydev, devad, regnum, value);
 320         if (ret < 0)
 321                 return ret;
 322
 323         return 0;
 324 }
 325
 326 /**
 327  * phy_clear_bits_mmd - Convenience function for clearing bits in a register
 328  * on MMD
 329  * @phydev: the phy_device struct
 330  * @devad: the MMD containing register to modify
 331  * @regnum: register number to modify
 332  * @val: bits to clear
 333  * @return: 0 for success or negative errno for failure
 334  */
 335 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
 336                                      u32 regnum, u16 val)
 337 {
 338         int value, ret;
 339
 340         value = phy_read_mmd(phydev, devad, regnum);
 341         if (value < 0)
 342                 return value;
 343
 344         value &= ~val;
 345
 346         ret = phy_write_mmd(phydev, devad, regnum, value);
 347         if (ret < 0)
 348                 return ret;
 349
 350         return 0;
 351 }
 352
 353 #ifdef CONFIG_PHYLIB_10G
 354 extern struct phy_driver gen10g_driver;
 355
 356 /*
 357  * List all 10G interfaces here, the assumption being that PHYs on these
 358  * interfaces are C45
 359  */
 360 static inline int is_10g_interface(phy_interface_t interface)
 361 {
 362         return interface == PHY_INTERFACE_MODE_XGMII ||
 363                interface == PHY_INTERFACE_MODE_USXGMII ||
 364                interface == PHY_INTERFACE_MODE_XFI;
 365 }
 366
 367 #endif
 368
 369 /**
 370  * phy_init() - Initializes the PHY drivers
 371  * This function registers all available PHY drivers
 372  *
 373  * @return: 0 if OK, -ve on error
 374  */
 375 int phy_init(void);
 376
 377 /**
 378  * phy_reset() - Resets the specified PHY
 379  * Issues a reset of the PHY and waits for it to complete
 380  *
 381  * @phydev:     PHY to reset
 382  * @return: 0 if OK, -ve on error
 383  */
 384 int phy_reset(struct phy_device *phydev);
 385
 386 /**
 387  * phy_find_by_mask() - Searches for a PHY on the specified MDIO bus
 388  * The function checks the PHY addresses flagged in phy_mask and returns a
 389  * phy_device pointer if it detects a PHY.
 390  * This function should only be called if just one PHY is expected to be present
 391  * in the set of addresses flagged in phy_mask.  If multiple PHYs are present,
 392  * it is undefined which of these PHYs is returned.
 393  *
 394  * @bus:        MII/MDIO bus to scan
 395  * @phy_mask:   bitmap of PYH addresses to scan
 396  * @interface:  type of MAC-PHY interface
 397  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 398  */
 399 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
 400                 phy_interface_t interface);
 401
 402 #ifdef CONFIG_DM_ETH
 403
 404 /**
 405  * phy_connect_dev() - Associates the given pair of PHY and Ethernet devices
 406  * @phydev:     PHY device
 407  * @dev:        Ethernet device
 408  */
 409 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev);
 410
 411 /**
 412  * phy_connect() - Creates a PHY device for the Ethernet interface
 413  * Creates a PHY device for the PHY at the given address, if one doesn't exist
 414  * already, and associates it with the Ethernet device.
 415  * The function may be called with addr <= 0, in this case addr value is ignored
 416  * and the bus is scanned to detect a PHY.  Scanning should only be used if only
 417  * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
 418  * which PHY is returned.
 419  *
 420  * @bus:        MII/MDIO bus that hosts the PHY
 421  * @addr:       PHY address on MDIO bus
 422  * @dev:        Ethernet device to associate to the PHY
 423  * @interface:  type of MAC-PHY interface
 424  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 425  */
 426 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
 427                                 struct udevice *dev,
 428                                 phy_interface_t interface);
 429
 430 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 431 {
 432         if (ofnode_valid(phydev->node))
 433                 return phydev->node;
 434         else
 435                 return dev_ofnode(phydev->dev);
 436 }
 437 #else
 438
 439 /**
 440  * phy_connect_dev() - Associates the given pair of PHY and Ethernet devices
 441  * @phydev:     PHY device
 442  * @dev:        Ethernet device
 443  */
 444 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev);
 445
 446 /**
 447  * phy_connect() - Creates a PHY device for the Ethernet interface
 448  * Creates a PHY device for the PHY at the given address, if one doesn't exist
 449  * already, and associates it with the Ethernet device.
 450  * The function may be called with addr <= 0, in this case addr value is ignored
 451  * and the bus is scanned to detect a PHY.  Scanning should only be used if only
 452  * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
 453  * which PHY is returned.
 454  *
 455  * @bus:        MII/MDIO bus that hosts the PHY
 456  * @addr:       PHY address on MDIO bus
 457  * @dev:        Ethernet device to associate to the PHY
 458  * @interface:  type of MAC-PHY interface
 459  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 460  */
 461 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
 462                                 struct eth_device *dev,
 463                                 phy_interface_t interface);
 464
 465 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 466 {
 467         return ofnode_null();
 468 }
 469 #endif
 470 int phy_startup(struct phy_device *phydev);
 471 int phy_config(struct phy_device *phydev);
 472 int phy_shutdown(struct phy_device *phydev);
 473 int phy_register(struct phy_driver *drv);
 474 int phy_set_supported(struct phy_device *phydev, u32 max_speed);
 475 int genphy_config_aneg(struct phy_device *phydev);
 476 int genphy_restart_aneg(struct phy_device *phydev);
 477 int genphy_update_link(struct phy_device *phydev);
 478 int genphy_parse_link(struct phy_device *phydev);
 479 int genphy_config(struct phy_device *phydev);
 480 int genphy_startup(struct phy_device *phydev);
 481 int genphy_shutdown(struct phy_device *phydev);
 482 int gen10g_config(struct phy_device *phydev);
 483 int gen10g_startup(struct phy_device *phydev);
 484 int gen10g_shutdown(struct phy_device *phydev);
 485 int gen10g_discover_mmds(struct phy_device *phydev);
 486
 487 int phy_b53_init(void);
 488 int phy_mv88e61xx_init(void);
 489 int phy_aquantia_init(void);
 490 int phy_atheros_init(void);
 491 int phy_broadcom_init(void);
 492 int phy_cortina_init(void);
 493 int phy_davicom_init(void);
 494 int phy_et1011c_init(void);
 495 int phy_lxt_init(void);
 496 int phy_marvell_init(void);
 497 int phy_micrel_ksz8xxx_init(void);
 498 int phy_micrel_ksz90x1_init(void);
 499 int phy_meson_gxl_init(void);
 500 int phy_natsemi_init(void);
 501 int phy_realtek_init(void);
 502 int phy_smsc_init(void);
 503 int phy_teranetics_init(void);
 504 int phy_ti_init(void);
 505 int phy_vitesse_init(void);
 506 int phy_xilinx_init(void);
 507 int phy_mscc_init(void);
 508 int phy_fixed_init(void);
 509 int phy_ncsi_init(void);
 510 int phy_xilinx_gmii2rgmii_init(void);
 511
 512 int board_phy_config(struct phy_device *phydev);
 513 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);
 514
 515 /**
 516  * phy_get_interface_by_name() - Look up a PHY interface name
 517  *
 518  * @str:        PHY interface name, e.g. "mii"
 519  * @return: PHY_INTERFACE_MODE_... value, or -1 if not found
 520  */
 521 int phy_get_interface_by_name(const char *str);
 522
 523 /**
 524  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
 525  * is RGMII (all variants)
 526  * @phydev: the phy_device struct
 527  * @return: true if MII bus is RGMII or false if it is not
 528  */
 529 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
 530 {
 531         return phydev->interface >= PHY_INTERFACE_MODE_RGMII &&
 532                 phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID;
 533 }
 534
 535 /**
 536  * phy_interface_is_sgmii - Convenience function for testing if a PHY interface
 537  * is SGMII (all variants)
 538  * @phydev: the phy_device struct
 539  * @return: true if MII bus is SGMII or false if it is not
 540  */
 541 static inline bool phy_interface_is_sgmii(struct phy_device *phydev)
 542 {
 543         return phydev->interface >= PHY_INTERFACE_MODE_SGMII &&
 544                 phydev->interface <= PHY_INTERFACE_MODE_QSGMII;
 545 }
 546
 547 /* PHY UIDs for various PHYs that are referenced in external code */
 548 #define PHY_UID_CS4340          0x13e51002
 549 #define PHY_UID_CS4223          0x03e57003
 550 #define PHY_UID_TN2020          0x00a19410
 551 #define PHY_UID_IN112525_S03    0x02107440
 552
 553 #endif