1 /* 2 * Copyright 2011 Freescale Semiconductor, Inc. 3 * Andy Fleming <afleming@gmail.com> 4 * 5 * SPDX-License-Identifier: GPL-2.0+ 6 * 7 * This file pretty much stolen from Linux's mii.h/ethtool.h/phy.h 8 */ 9 10 #ifndef _PHY_H 11 #define _PHY_H 12 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 #else 117 struct eth_device *dev; 118 #endif 119 120 /* forced speed & duplex (no autoneg) 121 * partner speed & duplex & pause (autoneg) 122 */ 123 int speed; 124 int duplex; 125 126 /* The most recently read link state */ 127 int link; 128 int port; 129 phy_interface_t interface; 130 131 u32 advertising; 132 u32 supported; 133 u32 mmds; 134 135 int autoneg; 136 int addr; 137 int pause; 138 int asym_pause; 139 u32 phy_id; 140 u32 flags; 141 }; 142 143 struct fixed_link { 144 int phy_id; 145 int duplex; 146 int link_speed; 147 int pause; 148 int asym_pause; 149 }; 150 151 static inline int phy_read(struct phy_device *phydev, int devad, int regnum) 152 { 153 struct mii_dev *bus = phydev->bus; 154 155 return bus->read(bus, phydev->addr, devad, regnum); 156 } 157 158 static inline int phy_write(struct phy_device *phydev, int devad, int regnum, 159 u16 val) 160 { 161 struct mii_dev *bus = phydev->bus; 162 163 return bus->write(bus, phydev->addr, devad, regnum, val); 164 } 165 166 #ifdef CONFIG_PHYLIB_10G 167 extern struct phy_driver gen10g_driver; 168 169 /* For now, XGMII is the only 10G interface */ 170 static inline int is_10g_interface(phy_interface_t interface) 171 { 172 return interface == PHY_INTERFACE_MODE_XGMII; 173 } 174 175 #endif 176 177 int phy_init(void); 178 int phy_reset(struct phy_device *phydev); 179 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask, 180 phy_interface_t interface); 181 #ifdef CONFIG_DM_ETH 182 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev); 183 struct phy_device *phy_connect(struct mii_dev *bus, int addr, 184 struct udevice *dev, 185 phy_interface_t interface); 186 #else 187 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev); 188 struct phy_device *phy_connect(struct mii_dev *bus, int addr, 189 struct eth_device *dev, 190 phy_interface_t interface); 191 #endif 192 int phy_startup(struct phy_device *phydev); 193 int phy_config(struct phy_device *phydev); 194 int phy_shutdown(struct phy_device *phydev); 195 int phy_register(struct phy_driver *drv); 196 int phy_set_supported(struct phy_device *phydev, u32 max_speed); 197 int genphy_config_aneg(struct phy_device *phydev); 198 int genphy_restart_aneg(struct phy_device *phydev); 199 int genphy_update_link(struct phy_device *phydev); 200 int genphy_parse_link(struct phy_device *phydev); 201 int genphy_config(struct phy_device *phydev); 202 int genphy_startup(struct phy_device *phydev); 203 int genphy_shutdown(struct phy_device *phydev); 204 int gen10g_config(struct phy_device *phydev); 205 int gen10g_startup(struct phy_device *phydev); 206 int gen10g_shutdown(struct phy_device *phydev); 207 int gen10g_discover_mmds(struct phy_device *phydev); 208 209 int phy_mv88e61xx_init(void); 210 int phy_aquantia_init(void); 211 int phy_atheros_init(void); 212 int phy_broadcom_init(void); 213 int phy_cortina_init(void); 214 int phy_davicom_init(void); 215 int phy_et1011c_init(void); 216 int phy_lxt_init(void); 217 int phy_marvell_init(void); 218 int phy_micrel_ksz8xxx_init(void); 219 int phy_micrel_ksz90x1_init(void); 220 int phy_natsemi_init(void); 221 int phy_realtek_init(void); 222 int phy_smsc_init(void); 223 int phy_teranetics_init(void); 224 int phy_ti_init(void); 225 int phy_vitesse_init(void); 226 int phy_xilinx_init(void); 227 int phy_mscc_init(void); 228 int phy_fixed_init(void); 229 230 int board_phy_config(struct phy_device *phydev); 231 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id); 232 233 /** 234 * phy_get_interface_by_name() - Look up a PHY interface name 235 * 236 * @str: PHY interface name, e.g. "mii" 237 * @return PHY_INTERFACE_MODE_... value, or -1 if not found 238 */ 239 int phy_get_interface_by_name(const char *str); 240 241 /** 242 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface 243 * is RGMII (all variants) 244 * @phydev: the phy_device struct 245 */ 246 static inline bool phy_interface_is_rgmii(struct phy_device *phydev) 247 { 248 return phydev->interface >= PHY_INTERFACE_MODE_RGMII && 249 phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID; 250 } 251 252 /** 253 * phy_interface_is_sgmii - Convenience function for testing if a PHY interface 254 * is SGMII (all variants) 255 * @phydev: the phy_device struct 256 */ 257 static inline bool phy_interface_is_sgmii(struct phy_device *phydev) 258 { 259 return phydev->interface >= PHY_INTERFACE_MODE_SGMII && 260 phydev->interface <= PHY_INTERFACE_MODE_QSGMII; 261 } 262 263 /* PHY UIDs for various PHYs that are referenced in external code */ 264 #define PHY_UID_CS4340 0x13e51002 265 #define PHY_UID_TN2020 0x00a19410 266 267 #endif 268