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 #define PHY_MAX_ADDR 32
  22
  23 #define PHY_FLAG_BROKEN_RESET   (1 << 0) /* soft reset not supported */
  24
  25 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
  26                                  SUPPORTED_TP | \
  27                                  SUPPORTED_MII)
  28
  29 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
  30                                  SUPPORTED_10baseT_Full)
  31
  32 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
  33                                  SUPPORTED_100baseT_Full)
  34
  35 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
  36                                  SUPPORTED_1000baseT_Full)
  37
  38 #define PHY_BASIC_FEATURES      (PHY_10BT_FEATURES | \
  39                                  PHY_100BT_FEATURES | \
  40                                  PHY_DEFAULT_FEATURES)
  41
  42 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
  43                                  PHY_1000BT_FEATURES)
  44
  45 #define PHY_10G_FEATURES        (PHY_GBIT_FEATURES | \
  46                                 SUPPORTED_10000baseT_Full)
  47
  48 #ifndef PHY_ANEG_TIMEOUT
  49 #define PHY_ANEG_TIMEOUT        4000
  50 #endif
  51
  52
  53 struct phy_device;
  54
  55 #define MDIO_NAME_LEN 32
  56
  57 struct mii_dev {
  58         struct list_head link;
  59         char name[MDIO_NAME_LEN];
  60         void *priv;
  61         int (*read)(struct mii_dev *bus, int addr, int devad, int reg);
  62         int (*write)(struct mii_dev *bus, int addr, int devad, int reg,
  63                         u16 val);
  64         int (*reset)(struct mii_dev *bus);
  65         struct phy_device *phymap[PHY_MAX_ADDR];
  66         u32 phy_mask;
  67 };
  68
  69 /* struct phy_driver: a structure which defines PHY behavior
  70  *
  71  * uid will contain a number which represents the PHY.  During
  72  * startup, the driver will poll the PHY to find out what its
  73  * UID--as defined by registers 2 and 3--is.  The 32-bit result
  74  * gotten from the PHY will be masked to
  75  * discard any bits which may change based on revision numbers
  76  * unimportant to functionality
  77  *
  78  */
  79 struct phy_driver {
  80         char *name;
  81         unsigned int uid;
  82         unsigned int mask;
  83         unsigned int mmds;
  84
  85         u32 features;
  86
  87         /* Called to do any driver startup necessities */
  88         /* Will be called during phy_connect */
  89         int (*probe)(struct phy_device *phydev);
  90
  91         /* Called to configure the PHY, and modify the controller
  92          * based on the results.  Should be called after phy_connect */
  93         int (*config)(struct phy_device *phydev);
  94
  95         /* Called when starting up the controller */
  96         int (*startup)(struct phy_device *phydev);
  97
  98         /* Called when bringing down the controller */
  99         int (*shutdown)(struct phy_device *phydev);
 100
 101         int (*readext)(struct phy_device *phydev, int addr, int devad, int reg);
 102         int (*writeext)(struct phy_device *phydev, int addr, int devad, int reg,
 103                         u16 val);
 104         struct list_head list;
 105 };
 106
 107 struct phy_device {
 108         /* Information about the PHY type */
 109         /* And management functions */
 110         struct mii_dev *bus;
 111         struct phy_driver *drv;
 112         void *priv;
 113
 114 #ifdef CONFIG_DM_ETH
 115         struct udevice *dev;
 116         ofnode node;
 117 #else
 118         struct eth_device *dev;
 119 #endif
 120
 121         /* forced speed & duplex (no autoneg)
 122          * partner speed & duplex & pause (autoneg)
 123          */
 124         int speed;
 125         int duplex;
 126
 127         /* The most recently read link state */
 128         int link;
 129         int port;
 130         phy_interface_t interface;
 131
 132         u32 advertising;
 133         u32 supported;
 134         u32 mmds;
 135
 136         int autoneg;
 137         int addr;
 138         int pause;
 139         int asym_pause;
 140         u32 phy_id;
 141         u32 flags;
 142 };
 143
 144 struct fixed_link {
 145         int phy_id;
 146         int duplex;
 147         int link_speed;
 148         int pause;
 149         int asym_pause;
 150 };
 151
 152 static inline int phy_read(struct phy_device *phydev, int devad, int regnum)
 153 {
 154         struct mii_dev *bus = phydev->bus;
 155
 156         return bus->read(bus, phydev->addr, devad, regnum);
 157 }
 158
 159 static inline int phy_write(struct phy_device *phydev, int devad, int regnum,
 160                         u16 val)
 161 {
 162         struct mii_dev *bus = phydev->bus;
 163
 164         return bus->write(bus, phydev->addr, devad, regnum, val);
 165 }
 166
 167 #ifdef CONFIG_PHYLIB_10G
 168 extern struct phy_driver gen10g_driver;
 169
 170 /* For now, XGMII is the only 10G interface */
 171 static inline int is_10g_interface(phy_interface_t interface)
 172 {
 173         return interface == PHY_INTERFACE_MODE_XGMII;
 174 }
 175
 176 #endif
 177
 178 int phy_init(void);
 179 int phy_reset(struct phy_device *phydev);
 180 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
 181                 phy_interface_t interface);
 182 #ifdef CONFIG_DM_ETH
 183 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev);
 184 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
 185                                 struct udevice *dev,
 186                                 phy_interface_t interface);
 187 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 188 {
 189         if (ofnode_valid(phydev->node))
 190                 return phydev->node;
 191         else
 192                 return dev_ofnode(phydev->dev);
 193 }
 194 #else
 195 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev);
 196 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
 197                                 struct eth_device *dev,
 198                                 phy_interface_t interface);
 199 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 200 {
 201         return ofnode_null();
 202 }
 203 #endif
 204 int phy_startup(struct phy_device *phydev);
 205 int phy_config(struct phy_device *phydev);
 206 int phy_shutdown(struct phy_device *phydev);
 207 int phy_register(struct phy_driver *drv);
 208 int phy_set_supported(struct phy_device *phydev, u32 max_speed);
 209 int genphy_config_aneg(struct phy_device *phydev);
 210 int genphy_restart_aneg(struct phy_device *phydev);
 211 int genphy_update_link(struct phy_device *phydev);
 212 int genphy_parse_link(struct phy_device *phydev);
 213 int genphy_config(struct phy_device *phydev);
 214 int genphy_startup(struct phy_device *phydev);
 215 int genphy_shutdown(struct phy_device *phydev);
 216 int gen10g_config(struct phy_device *phydev);
 217 int gen10g_startup(struct phy_device *phydev);
 218 int gen10g_shutdown(struct phy_device *phydev);
 219 int gen10g_discover_mmds(struct phy_device *phydev);
 220
 221 int phy_b53_init(void);
 222 int phy_mv88e61xx_init(void);
 223 int phy_aquantia_init(void);
 224 int phy_atheros_init(void);
 225 int phy_broadcom_init(void);
 226 int phy_cortina_init(void);
 227 int phy_davicom_init(void);
 228 int phy_et1011c_init(void);
 229 int phy_lxt_init(void);
 230 int phy_marvell_init(void);
 231 int phy_micrel_ksz8xxx_init(void);
 232 int phy_micrel_ksz90x1_init(void);
 233 int phy_meson_gxl_init(void);
 234 int phy_natsemi_init(void);
 235 int phy_realtek_init(void);
 236 int phy_smsc_init(void);
 237 int phy_teranetics_init(void);
 238 int phy_ti_init(void);
 239 int phy_vitesse_init(void);
 240 int phy_xilinx_init(void);
 241 int phy_mscc_init(void);
 242 int phy_fixed_init(void);
 243
 244 int board_phy_config(struct phy_device *phydev);
 245 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);
 246
 247 /**
 248  * phy_get_interface_by_name() - Look up a PHY interface name
 249  *
 250  * @str:        PHY interface name, e.g. "mii"
 251  * @return PHY_INTERFACE_MODE_... value, or -1 if not found
 252  */
 253 int phy_get_interface_by_name(const char *str);
 254
 255 /**
 256  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
 257  * is RGMII (all variants)
 258  * @phydev: the phy_device struct
 259  */
 260 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
 261 {
 262         return phydev->interface >= PHY_INTERFACE_MODE_RGMII &&
 263                 phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID;
 264 }
 265
 266 /**
 267  * phy_interface_is_sgmii - Convenience function for testing if a PHY interface
 268  * is SGMII (all variants)
 269  * @phydev: the phy_device struct
 270  */
 271 static inline bool phy_interface_is_sgmii(struct phy_device *phydev)
 272 {
 273         return phydev->interface >= PHY_INTERFACE_MODE_SGMII &&
 274                 phydev->interface <= PHY_INTERFACE_MODE_QSGMII;
 275 }
 276
 277 /* PHY UIDs for various PHYs that are referenced in external code */
 278 #define PHY_UID_CS4340  0x13e51002
 279 #define PHY_UID_CS4223  0x03e57003
 280 #define PHY_UID_TN2020  0x00a19410
 281
 282 #endif