include/phy.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright 2011 Freescale Semiconductor, Inc.
   4  *      Andy Fleming <[email protected]>
   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         /* driver private data */
 125         ulong data;
 126 };
 127
 128 struct phy_device {
 129         /* Information about the PHY type */
 130         /* And management functions */
 131         struct mii_dev *bus;
 132         struct phy_driver *drv;
 133         void *priv;
 134
 135         struct udevice *dev;
 136         ofnode node;
 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 /**
 171  * phy_reset() - Resets the specified PHY
 172  * Issues a reset of the PHY and waits for it to complete
 173  *
 174  * @phydev:     PHY to reset
 175  * @return: 0 if OK, -ve on error
 176  */
 177 int phy_reset(struct phy_device *phydev);
 178
 179 /**
 180  * phy_find_by_mask() - Searches for a PHY on the specified MDIO bus
 181  * The function checks the PHY addresses flagged in phy_mask and returns a
 182  * phy_device pointer if it detects a PHY.
 183  * This function should only be called if just one PHY is expected to be present
 184  * in the set of addresses flagged in phy_mask.  If multiple PHYs are present,
 185  * it is undefined which of these PHYs is returned.
 186  *
 187  * @bus:        MII/MDIO bus to scan
 188  * @phy_mask:   bitmap of PYH addresses to scan
 189  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 190  */
 191 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask);
 192
 193 #ifdef CONFIG_PHY_FIXED
 194
 195 /**
 196  * fixed_phy_create() - create an unconnected fixed-link pseudo-PHY device
 197  * @node: OF node for the container of the fixed-link node
 198  *
 199  * Description: Creates a struct phy_device based on a fixed-link of_node
 200  * description. Can be used without phy_connect by drivers which do not expose
 201  * a UCLASS_ETH udevice.
 202  */
 203 struct phy_device *fixed_phy_create(ofnode node);
 204
 205 #else
 206
 207 static inline struct phy_device *fixed_phy_create(ofnode node)
 208 {
 209         return NULL;
 210 }
 211
 212 #endif
 213
 214 /**
 215  * phy_connect() - Creates a PHY device for the Ethernet interface
 216  * Creates a PHY device for the PHY at the given address, if one doesn't exist
 217  * already, and associates it with the Ethernet device.
 218  * The function may be called with addr <= 0, in this case addr value is ignored
 219  * and the bus is scanned to detect a PHY.  Scanning should only be used if only
 220  * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
 221  * which PHY is returned.
 222  *
 223  * @bus:        MII/MDIO bus that hosts the PHY
 224  * @addr:       PHY address on MDIO bus
 225  * @dev:        Ethernet device to associate to the PHY
 226  * @interface:  type of MAC-PHY interface
 227  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 228  */
 229 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
 230                                 struct udevice *dev,
 231                                 phy_interface_t interface);
 232 /**
 233  * phy_device_create() - Create a PHY device
 234  *
 235  * @bus:                MII/MDIO bus that hosts the PHY
 236  * @addr:               PHY address on MDIO bus
 237  * @phy_id:             where to store the ID retrieved
 238  * @is_c45:             Device Identifiers if is_c45
 239  * @return: pointer to phy_device if a PHY is found, or NULL otherwise
 240  */
 241 struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
 242                                      u32 phy_id, bool is_c45);
 243
 244 /**
 245  * phy_connect_phy_id() - Connect to phy device by reading PHY id
 246  *                        from phy node.
 247  *
 248  * @bus:                MII/MDIO bus that hosts the PHY
 249  * @dev:                Ethernet device to associate to the PHY
 250  * @return:             pointer to phy_device if a PHY is found,
 251  *                      or NULL otherwise
 252  */
 253 struct phy_device *phy_connect_phy_id(struct mii_dev *bus, struct udevice *dev,
 254                                       int phyaddr);
 255
 256 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 257 {
 258         if (ofnode_valid(phydev->node))
 259                 return phydev->node;
 260         else
 261                 return dev_ofnode(phydev->dev);
 262 }
 263
 264 /**
 265  * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
 266  *                             condition is met or a timeout occurs
 267  *
 268  * @phydev: The phy_device struct
 269  * @devaddr: The MMD to read from
 270  * @regnum: The register on the MMD to read
 271  * @val: Variable to read the register into
 272  * @cond: Break condition (usually involving @val)
 273  * @sleep_us: Maximum time to sleep between reads in us (0
 274  *            tight-loops).  Should be less than ~20ms since usleep_range
 275  *            is used (see Documentation/timers/timers-howto.rst).
 276  * @timeout_us: Timeout in us, 0 means never timeout
 277  * @sleep_before_read: if it is true, sleep @sleep_us before read.
 278  * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
 279  * case, the last read value at @args is stored in @val. Must not
 280  * be called from atomic context if sleep_us or timeout_us are used.
 281  */
 282 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
 283                                   sleep_us, timeout_us, sleep_before_read) \
 284 ({ \
 285         int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
 286                                   sleep_us, timeout_us, \
 287                                   phydev, devaddr, regnum); \
 288         if (val <  0) \
 289                 __ret = val; \
 290         if (__ret) \
 291                 dev_err(phydev->dev, "%s failed: %d\n", __func__, __ret); \
 292         __ret; \
 293 })
 294
 295 int phy_read(struct phy_device *phydev, int devad, int regnum);
 296 int phy_write(struct phy_device *phydev, int devad, int regnum, u16 val);
 297 void phy_mmd_start_indirect(struct phy_device *phydev, int devad, int regnum);
 298 int phy_read_mmd(struct phy_device *phydev, int devad, int regnum);
 299 int phy_write_mmd(struct phy_device *phydev, int devad, int regnum, u16 val);
 300 int phy_set_bits_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
 301 int phy_clear_bits_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
 302 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
 303                            u16 mask, u16 set);
 304 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
 305                    u16 mask, u16 set);
 306
 307 int phy_startup(struct phy_device *phydev);
 308 int phy_config(struct phy_device *phydev);
 309 int phy_shutdown(struct phy_device *phydev);
 310 int phy_set_supported(struct phy_device *phydev, u32 max_speed);
 311 int phy_modify(struct phy_device *phydev, int devad, int regnum, u16 mask,
 312                u16 set);
 313 int genphy_config_aneg(struct phy_device *phydev);
 314 int genphy_restart_aneg(struct phy_device *phydev);
 315 int genphy_update_link(struct phy_device *phydev);
 316 int genphy_parse_link(struct phy_device *phydev);
 317 int genphy_config(struct phy_device *phydev);
 318 int genphy_startup(struct phy_device *phydev);
 319 int genphy_shutdown(struct phy_device *phydev);
 320 int gen10g_config(struct phy_device *phydev);
 321 int gen10g_startup(struct phy_device *phydev);
 322 int gen10g_shutdown(struct phy_device *phydev);
 323 int gen10g_discover_mmds(struct phy_device *phydev);
 324
 325 /**
 326  * U_BOOT_PHY_DRIVER() - Declare a new U-Boot driver
 327  * @__name: name of the driver
 328  */
 329 #define U_BOOT_PHY_DRIVER(__name)                                       \
 330         ll_entry_declare(struct phy_driver, __name, phy_driver)
 331
 332 int board_phy_config(struct phy_device *phydev);
 333 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);
 334
 335 /**
 336  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
 337  * is RGMII (all variants)
 338  * @phydev: the phy_device struct
 339  * @return: true if MII bus is RGMII or false if it is not
 340  */
 341 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
 342 {
 343         switch (phydev->interface) {
 344         case PHY_INTERFACE_MODE_RGMII:
 345         case PHY_INTERFACE_MODE_RGMII_ID:
 346         case PHY_INTERFACE_MODE_RGMII_RXID:
 347         case PHY_INTERFACE_MODE_RGMII_TXID:
 348                 return 1;
 349         default:
 350                 return 0;
 351         }
 352 }
 353
 354 bool phy_interface_is_ncsi(void);
 355
 356 /* PHY UIDs for various PHYs that are referenced in external code */
 357 #define PHY_UID_CS4340          0x13e51002
 358 #define PHY_UID_CS4223          0x03e57003
 359 #define PHY_UID_TN2020          0x00a19410
 360 #define PHY_UID_IN112525_S03    0x02107440
 361
 362 #endif