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