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_100BT1_FEATURES     (SUPPORTED_TP | \
  55                                  SUPPORTED_MII | \
  56                                  SUPPORTED_100baseT_Full)
  57
  58 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
  59                                  PHY_1000BT_FEATURES)
  60
  61 #define PHY_10G_FEATURES        (PHY_GBIT_FEATURES | \
  62                                 SUPPORTED_10000baseT_Full)
  63
  64 #ifndef PHY_ANEG_TIMEOUT
  65 #define PHY_ANEG_TIMEOUT        4000
  66 #endif
  67
  68
  69 struct phy_device;
  70
  71 #define MDIO_NAME_LEN 32
  72
  73 struct mii_dev {
  74         struct list_head link;
  75         char name[MDIO_NAME_LEN];
  76         void *priv;
  77         int (*read)(struct mii_dev *bus, int addr, int devad, int reg);
  78         int (*write)(struct mii_dev *bus, int addr, int devad, int reg,
  79                         u16 val);
  80         int (*reset)(struct mii_dev *bus);
  81         struct phy_device *phymap[PHY_MAX_ADDR];
  82         u32 phy_mask;
  83 };
  84
  85 /* struct phy_driver: a structure which defines PHY behavior
  86  *
  87  * uid will contain a number which represents the PHY.  During
  88  * startup, the driver will poll the PHY to find out what its
  89  * UID--as defined by registers 2 and 3--is.  The 32-bit result
  90  * gotten from the PHY will be masked to
  91  * discard any bits which may change based on revision numbers
  92  * unimportant to functionality
  93  *
  94  */
  95 struct phy_driver {
  96         char *name;
  97         unsigned int uid;
  98         unsigned int mask;
  99         unsigned int mmds;
 100
 101         u32 features;
 102
 103         /* Called to do any driver startup necessities */
 104         /* Will be called during phy_connect */
 105         int (*probe)(struct phy_device *phydev);
 106
 107         /* Called to configure the PHY, and modify the controller
 108          * based on the results.  Should be called after phy_connect */
 109         int (*config)(struct phy_device *phydev);
 110
 111         /* Called when starting up the controller */
 112         int (*startup)(struct phy_device *phydev);
 113
 114         /* Called when bringing down the controller */
 115         int (*shutdown)(struct phy_device *phydev);
 116
 117         int (*readext)(struct phy_device *phydev, int addr, int devad, int reg);
 118         int (*writeext)(struct phy_device *phydev, int addr, int devad, int reg,
 119                         u16 val);
 120
 121         /* Phy specific driver override for reading a MMD register */
 122         int (*read_mmd)(struct phy_device *phydev, int devad, int reg);
 123
 124         /* Phy specific driver override for writing a MMD register */
 125         int (*write_mmd)(struct phy_device *phydev, int devad, int reg,
 126                          u16 val);
 127
 128         /* driver private data */
 129         ulong data;
 130 };
 131
 132 struct phy_device {
 133         /* Information about the PHY type */
 134         /* And management functions */
 135         struct mii_dev *bus;
 136         struct phy_driver *drv;
 137         void *priv;
 138
 139         struct udevice *dev;
 140         ofnode node;
 141
 142         /* forced speed & duplex (no autoneg)
 143          * partner speed & duplex & pause (autoneg)
 144          */
 145         int speed;
 146         int duplex;
 147
 148         /* The most recently read link state */
 149         int link;
 150         int port;
 151         phy_interface_t interface;
 152
 153         u32 advertising;
 154         u32 supported;
 155         u32 mmds;
 156
 157         int autoneg;
 158         int addr;
 159         int pause;
 160         int asym_pause;
 161         u32 phy_id;
 162         bool is_c45;
 163         u32 flags;
 164 };
 165
 166 struct fixed_link {
 167         int phy_id;
 168         int duplex;
 169         int link_speed;
 170         int pause;
 171         int asym_pause;
 172 };
 173
 174 /**
 175  * phy_init() - Initializes the PHY drivers
 176  * This function registers all available PHY drivers
 177  *
 178  * @return: 0 if OK, -ve on error
 179  */
 180 int phy_init(void);
 181
 182 /**
 183  * phy_reset() - Resets the specified PHY
 184  * Issues a reset of the PHY and waits for it to complete
 185  *
 186  * @phydev:     PHY to reset
 187  * @return: 0 if OK, -ve on error
 188  */
 189 int phy_reset(struct phy_device *phydev);
 190
 191 /**
 192  * phy_find_by_mask() - Searches for a PHY on the specified MDIO bus
 193  * The function checks the PHY addresses flagged in phy_mask and returns a
 194  * phy_device pointer if it detects a PHY.
 195  * This function should only be called if just one PHY is expected to be present
 196  * in the set of addresses flagged in phy_mask.  If multiple PHYs are present,
 197  * it is undefined which of these PHYs is returned.
 198  *
 199  * @bus:        MII/MDIO bus to scan
 200  * @phy_mask:   bitmap of PYH addresses to scan
 201  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 202  */
 203 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask);
 204
 205 #ifdef CONFIG_PHY_FIXED
 206
 207 /**
 208  * fixed_phy_create() - create an unconnected fixed-link pseudo-PHY device
 209  * @node: OF node for the container of the fixed-link node
 210  *
 211  * Description: Creates a struct phy_device based on a fixed-link of_node
 212  * description. Can be used without phy_connect by drivers which do not expose
 213  * a UCLASS_ETH udevice.
 214  */
 215 struct phy_device *fixed_phy_create(ofnode node);
 216
 217 #else
 218
 219 static inline struct phy_device *fixed_phy_create(ofnode node)
 220 {
 221         return NULL;
 222 }
 223
 224 #endif
 225
 226 /**
 227  * phy_connect_dev() - Associates the given pair of PHY and Ethernet devices
 228  * @phydev:     PHY device
 229  * @dev:        Ethernet device
 230  * @interface:  type of MAC-PHY interface
 231  */
 232 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev,
 233                      phy_interface_t interface);
 234
 235 /**
 236  * phy_connect() - Creates a PHY device for the Ethernet interface
 237  * Creates a PHY device for the PHY at the given address, if one doesn't exist
 238  * already, and associates it with the Ethernet device.
 239  * The function may be called with addr <= 0, in this case addr value is ignored
 240  * and the bus is scanned to detect a PHY.  Scanning should only be used if only
 241  * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
 242  * which PHY is returned.
 243  *
 244  * @bus:        MII/MDIO bus that hosts the PHY
 245  * @addr:       PHY address on MDIO bus
 246  * @dev:        Ethernet device to associate to the PHY
 247  * @interface:  type of MAC-PHY interface
 248  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 249  */
 250 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
 251                                 struct udevice *dev,
 252                                 phy_interface_t interface);
 253 /**
 254  * phy_device_create() - Create a PHY device
 255  *
 256  * @bus:                MII/MDIO bus that hosts the PHY
 257  * @addr:               PHY address on MDIO bus
 258  * @phy_id:             where to store the ID retrieved
 259  * @is_c45:             Device Identifiers if is_c45
 260  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 261  */
 262 struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
 263                                      u32 phy_id, bool is_c45);
 264
 265 /**
 266  * phy_connect_phy_id() - Connect to phy device by reading PHY id
 267  *                        from phy node.
 268  *
 269  * @bus:                MII/MDIO bus that hosts the PHY
 270  * @dev:                Ethernet device to associate to the PHY
 271  * @return:             pointer to phy_device if a PHY is found,
 272  *                      or NULL otherwise
 273  */
 274 struct phy_device *phy_connect_phy_id(struct mii_dev *bus, struct udevice *dev,
 275                                       int phyaddr);
 276
 277 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 278 {
 279         if (ofnode_valid(phydev->node))
 280                 return phydev->node;
 281         else
 282                 return dev_ofnode(phydev->dev);
 283 }
 284
 285 /**
 286  * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
 287  *                             condition is met or a timeout occurs
 288  *
 289  * @phydev: The phy_device struct
 290  * @devaddr: The MMD to read from
 291  * @regnum: The register on the MMD to read
 292  * @val: Variable to read the register into
 293  * @cond: Break condition (usually involving @val)
 294  * @sleep_us: Maximum time to sleep between reads in us (0
 295  *            tight-loops).  Should be less than ~20ms since usleep_range
 296  *            is used (see Documentation/timers/timers-howto.rst).
 297  * @timeout_us: Timeout in us, 0 means never timeout
 298  * @sleep_before_read: if it is true, sleep @sleep_us before read.
 299  * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
 300  * case, the last read value at @args is stored in @val. Must not
 301  * be called from atomic context if sleep_us or timeout_us are used.
 302  */
 303 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
 304                                   sleep_us, timeout_us, sleep_before_read) \
 305 ({ \
 306         int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
 307                                   sleep_us, timeout_us, \
 308                                   phydev, devaddr, regnum); \
 309         if (val <  0) \
 310                 __ret = val; \
 311         if (__ret) \
 312                 dev_err(phydev->dev, "%s failed: %d\n", __func__, __ret); \
 313         __ret; \
 314 })
 315
 316 int phy_read(struct phy_device *phydev, int devad, int regnum);
 317 int phy_write(struct phy_device *phydev, int devad, int regnum, u16 val);
 318 void phy_mmd_start_indirect(struct phy_device *phydev, int devad, int regnum);
 319 int phy_read_mmd(struct phy_device *phydev, int devad, int regnum);
 320 int phy_write_mmd(struct phy_device *phydev, int devad, int regnum, u16 val);
 321 int phy_set_bits_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
 322 int phy_clear_bits_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
 323 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
 324                            u16 mask, u16 set);
 325 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
 326                    u16 mask, u16 set);
 327
 328 int phy_startup(struct phy_device *phydev);
 329 int phy_config(struct phy_device *phydev);
 330 int phy_shutdown(struct phy_device *phydev);
 331 int phy_set_supported(struct phy_device *phydev, u32 max_speed);
 332 int phy_modify(struct phy_device *phydev, int devad, int regnum, u16 mask,
 333                u16 set);
 334 int genphy_config_aneg(struct phy_device *phydev);
 335 int genphy_restart_aneg(struct phy_device *phydev);
 336 int genphy_update_link(struct phy_device *phydev);
 337 int genphy_parse_link(struct phy_device *phydev);
 338 int genphy_config(struct phy_device *phydev);
 339 int genphy_startup(struct phy_device *phydev);
 340 int genphy_shutdown(struct phy_device *phydev);
 341 int gen10g_config(struct phy_device *phydev);
 342 int gen10g_startup(struct phy_device *phydev);
 343 int gen10g_shutdown(struct phy_device *phydev);
 344 int gen10g_discover_mmds(struct phy_device *phydev);
 345
 346 /**
 347  * U_BOOT_PHY_DRIVER() - Declare a new U-Boot driver
 348  * @__name: name of the driver
 349  */
 350 #define U_BOOT_PHY_DRIVER(__name)                                       \
 351         ll_entry_declare(struct phy_driver, __name, phy_driver)
 352
 353 int board_phy_config(struct phy_device *phydev);
 354 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);
 355
 356 /**
 357  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
 358  * is RGMII (all variants)
 359  * @phydev: the phy_device struct
 360  * @return: true if MII bus is RGMII or false if it is not
 361  */
 362 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
 363 {
 364         return phydev->interface >= PHY_INTERFACE_MODE_RGMII &&
 365                 phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID;
 366 }
 367
 368 /**
 369  * phy_interface_is_sgmii - Convenience function for testing if a PHY interface
 370  * is SGMII (all variants)
 371  * @phydev: the phy_device struct
 372  * @return: true if MII bus is SGMII or false if it is not
 373  */
 374 static inline bool phy_interface_is_sgmii(struct phy_device *phydev)
 375 {
 376         return phydev->interface >= PHY_INTERFACE_MODE_SGMII &&
 377                 phydev->interface <= PHY_INTERFACE_MODE_QSGMII;
 378 }
 379
 380 bool phy_interface_is_ncsi(void);
 381
 382 /* PHY UIDs for various PHYs that are referenced in external code */
 383 #define PHY_UID_CS4340          0x13e51002
 384 #define PHY_UID_CS4223          0x03e57003
 385 #define PHY_UID_TN2020          0x00a19410
 386 #define PHY_UID_IN112525_S03    0x02107440
 387
 388 #endif