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