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