183d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */ 25f184715SAndy Fleming /* 35f184715SAndy Fleming * Copyright 2011 Freescale Semiconductor, Inc. 4b21f87a3SAndy Fleming * Andy Fleming <afleming@gmail.com> 55f184715SAndy Fleming * 65f184715SAndy Fleming * This file pretty much stolen from Linux's mii.h/ethtool.h/phy.h 75f184715SAndy Fleming */ 85f184715SAndy Fleming 95f184715SAndy Fleming #ifndef _PHY_H 105f184715SAndy Fleming #define _PHY_H 115f184715SAndy Fleming 12eef0b8a9SGrygorii Strashko #include <dm.h> 135f184715SAndy Fleming #include <linux/list.h> 145f184715SAndy Fleming #include <linux/mii.h> 155f184715SAndy Fleming #include <linux/ethtool.h> 165f184715SAndy Fleming #include <linux/mdio.h> 17f070b1a2SJoe Hershberger #include <phy_interface.h> 185f184715SAndy Fleming 19db40c1aaSHannes Schmelzer #define PHY_FIXED_ID 0xa5a55a5a 209ab23354SDylan Hung #define PHY_NCSI_ID 0xbeefcafe 21db40c1aaSHannes Schmelzer 225f184715SAndy Fleming #define PHY_MAX_ADDR 32 235f184715SAndy Fleming 24ddcd1f30SShaohui Xie #define PHY_FLAG_BROKEN_RESET (1 << 0) /* soft reset not supported */ 25ddcd1f30SShaohui Xie 264dae610bSFlorian Fainelli #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \ 275f184715SAndy Fleming SUPPORTED_TP | \ 285f184715SAndy Fleming SUPPORTED_MII) 295f184715SAndy Fleming 304dae610bSFlorian Fainelli #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \ 314dae610bSFlorian Fainelli SUPPORTED_10baseT_Full) 324dae610bSFlorian Fainelli 334dae610bSFlorian Fainelli #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \ 344dae610bSFlorian Fainelli SUPPORTED_100baseT_Full) 354dae610bSFlorian Fainelli 364dae610bSFlorian Fainelli #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \ 375f184715SAndy Fleming SUPPORTED_1000baseT_Full) 385f184715SAndy Fleming 394dae610bSFlorian Fainelli #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \ 404dae610bSFlorian Fainelli PHY_100BT_FEATURES | \ 414dae610bSFlorian Fainelli PHY_DEFAULT_FEATURES) 424dae610bSFlorian Fainelli 434dae610bSFlorian Fainelli #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \ 444dae610bSFlorian Fainelli PHY_1000BT_FEATURES) 454dae610bSFlorian Fainelli 465f184715SAndy Fleming #define PHY_10G_FEATURES (PHY_GBIT_FEATURES | \ 475f184715SAndy Fleming SUPPORTED_10000baseT_Full) 485f184715SAndy Fleming 494fb3f0c8SStefan Roese #ifndef PHY_ANEG_TIMEOUT 505f184715SAndy Fleming #define PHY_ANEG_TIMEOUT 4000 514fb3f0c8SStefan Roese #endif 525f184715SAndy Fleming 535f184715SAndy Fleming 545f184715SAndy Fleming struct phy_device; 555f184715SAndy Fleming 565f184715SAndy Fleming #define MDIO_NAME_LEN 32 575f184715SAndy Fleming 585f184715SAndy Fleming struct mii_dev { 595f184715SAndy Fleming struct list_head link; 605f184715SAndy Fleming char name[MDIO_NAME_LEN]; 615f184715SAndy Fleming void *priv; 625f184715SAndy Fleming int (*read)(struct mii_dev *bus, int addr, int devad, int reg); 635f184715SAndy Fleming int (*write)(struct mii_dev *bus, int addr, int devad, int reg, 645f184715SAndy Fleming u16 val); 655f184715SAndy Fleming int (*reset)(struct mii_dev *bus); 665f184715SAndy Fleming struct phy_device *phymap[PHY_MAX_ADDR]; 675f184715SAndy Fleming u32 phy_mask; 685f184715SAndy Fleming }; 695f184715SAndy Fleming 705f184715SAndy Fleming /* struct phy_driver: a structure which defines PHY behavior 715f184715SAndy Fleming * 725f184715SAndy Fleming * uid will contain a number which represents the PHY. During 735f184715SAndy Fleming * startup, the driver will poll the PHY to find out what its 745f184715SAndy Fleming * UID--as defined by registers 2 and 3--is. The 32-bit result 755f184715SAndy Fleming * gotten from the PHY will be masked to 765f184715SAndy Fleming * discard any bits which may change based on revision numbers 775f184715SAndy Fleming * unimportant to functionality 785f184715SAndy Fleming * 795f184715SAndy Fleming */ 805f184715SAndy Fleming struct phy_driver { 815f184715SAndy Fleming char *name; 825f184715SAndy Fleming unsigned int uid; 835f184715SAndy Fleming unsigned int mask; 845f184715SAndy Fleming unsigned int mmds; 855f184715SAndy Fleming 865f184715SAndy Fleming u32 features; 875f184715SAndy Fleming 885f184715SAndy Fleming /* Called to do any driver startup necessities */ 895f184715SAndy Fleming /* Will be called during phy_connect */ 905f184715SAndy Fleming int (*probe)(struct phy_device *phydev); 915f184715SAndy Fleming 925f184715SAndy Fleming /* Called to configure the PHY, and modify the controller 935f184715SAndy Fleming * based on the results. Should be called after phy_connect */ 945f184715SAndy Fleming int (*config)(struct phy_device *phydev); 955f184715SAndy Fleming 965f184715SAndy Fleming /* Called when starting up the controller */ 975f184715SAndy Fleming int (*startup)(struct phy_device *phydev); 985f184715SAndy Fleming 995f184715SAndy Fleming /* Called when bringing down the controller */ 1005f184715SAndy Fleming int (*shutdown)(struct phy_device *phydev); 1015f184715SAndy Fleming 102b71841b9SStefano Babic int (*readext)(struct phy_device *phydev, int addr, int devad, int reg); 103b71841b9SStefano Babic int (*writeext)(struct phy_device *phydev, int addr, int devad, int reg, 104b71841b9SStefano Babic u16 val); 1055f184715SAndy Fleming struct list_head list; 1065f184715SAndy Fleming }; 1075f184715SAndy Fleming 1085f184715SAndy Fleming struct phy_device { 1095f184715SAndy Fleming /* Information about the PHY type */ 1105f184715SAndy Fleming /* And management functions */ 1115f184715SAndy Fleming struct mii_dev *bus; 1125f184715SAndy Fleming struct phy_driver *drv; 1135f184715SAndy Fleming void *priv; 1145f184715SAndy Fleming 115c74c8e66SSimon Glass #ifdef CONFIG_DM_ETH 116c74c8e66SSimon Glass struct udevice *dev; 117eef0b8a9SGrygorii Strashko ofnode node; 118c74c8e66SSimon Glass #else 1195f184715SAndy Fleming struct eth_device *dev; 120c74c8e66SSimon Glass #endif 1215f184715SAndy Fleming 1225f184715SAndy Fleming /* forced speed & duplex (no autoneg) 1235f184715SAndy Fleming * partner speed & duplex & pause (autoneg) 1245f184715SAndy Fleming */ 1255f184715SAndy Fleming int speed; 1265f184715SAndy Fleming int duplex; 1275f184715SAndy Fleming 1285f184715SAndy Fleming /* The most recently read link state */ 1295f184715SAndy Fleming int link; 1305f184715SAndy Fleming int port; 1315f184715SAndy Fleming phy_interface_t interface; 1325f184715SAndy Fleming 1335f184715SAndy Fleming u32 advertising; 1345f184715SAndy Fleming u32 supported; 1355f184715SAndy Fleming u32 mmds; 1365f184715SAndy Fleming 1375f184715SAndy Fleming int autoneg; 1385f184715SAndy Fleming int addr; 1395f184715SAndy Fleming int pause; 1405f184715SAndy Fleming int asym_pause; 1415f184715SAndy Fleming u32 phy_id; 142b3eabd82SPankaj Bansal bool is_c45; 1435f184715SAndy Fleming u32 flags; 1445f184715SAndy Fleming }; 1455f184715SAndy Fleming 146f55a776cSShaohui Xie struct fixed_link { 147f55a776cSShaohui Xie int phy_id; 148f55a776cSShaohui Xie int duplex; 149f55a776cSShaohui Xie int link_speed; 150f55a776cSShaohui Xie int pause; 151f55a776cSShaohui Xie int asym_pause; 152f55a776cSShaohui Xie }; 153f55a776cSShaohui Xie 1545f184715SAndy Fleming static inline int phy_read(struct phy_device *phydev, int devad, int regnum) 1555f184715SAndy Fleming { 1565f184715SAndy Fleming struct mii_dev *bus = phydev->bus; 1575f184715SAndy Fleming 1589ab23354SDylan Hung if (!bus || !bus->read) { 1599ab23354SDylan Hung debug("%s: No bus configured\n", __func__); 1609ab23354SDylan Hung return -1; 1619ab23354SDylan Hung } 1629ab23354SDylan Hung 1635f184715SAndy Fleming return bus->read(bus, phydev->addr, devad, regnum); 1645f184715SAndy Fleming } 1655f184715SAndy Fleming 1665f184715SAndy Fleming static inline int phy_write(struct phy_device *phydev, int devad, int regnum, 1675f184715SAndy Fleming u16 val) 1685f184715SAndy Fleming { 1695f184715SAndy Fleming struct mii_dev *bus = phydev->bus; 1705f184715SAndy Fleming 17117cff748SRyan Chen if (!bus || !bus->write) { 1729ab23354SDylan Hung debug("%s: No bus configured\n", __func__); 1739ab23354SDylan Hung return -1; 1749ab23354SDylan Hung } 1759ab23354SDylan Hung 1765f184715SAndy Fleming return bus->write(bus, phydev->addr, devad, regnum, val); 1775f184715SAndy Fleming } 1785f184715SAndy Fleming 1795f184715SAndy Fleming #ifdef CONFIG_PHYLIB_10G 1805f184715SAndy Fleming extern struct phy_driver gen10g_driver; 1815f184715SAndy Fleming 1825f184715SAndy Fleming /* For now, XGMII is the only 10G interface */ 1835f184715SAndy Fleming static inline int is_10g_interface(phy_interface_t interface) 1845f184715SAndy Fleming { 1855f184715SAndy Fleming return interface == PHY_INTERFACE_MODE_XGMII; 1865f184715SAndy Fleming } 1875f184715SAndy Fleming 1885f184715SAndy Fleming #endif 1895f184715SAndy Fleming 1905f184715SAndy Fleming int phy_init(void); 1915f184715SAndy Fleming int phy_reset(struct phy_device *phydev); 1921adb406bSTroy Kisky struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask, 1931adb406bSTroy Kisky phy_interface_t interface); 194c74c8e66SSimon Glass #ifdef CONFIG_DM_ETH 195c74c8e66SSimon Glass void phy_connect_dev(struct phy_device *phydev, struct udevice *dev); 196c74c8e66SSimon Glass struct phy_device *phy_connect(struct mii_dev *bus, int addr, 197c74c8e66SSimon Glass struct udevice *dev, 198c74c8e66SSimon Glass phy_interface_t interface); 199eef0b8a9SGrygorii Strashko static inline ofnode phy_get_ofnode(struct phy_device *phydev) 200eef0b8a9SGrygorii Strashko { 201eef0b8a9SGrygorii Strashko if (ofnode_valid(phydev->node)) 202eef0b8a9SGrygorii Strashko return phydev->node; 203eef0b8a9SGrygorii Strashko else 204eef0b8a9SGrygorii Strashko return dev_ofnode(phydev->dev); 205eef0b8a9SGrygorii Strashko } 206c74c8e66SSimon Glass #else 2071adb406bSTroy Kisky void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev); 2085f184715SAndy Fleming struct phy_device *phy_connect(struct mii_dev *bus, int addr, 2095f184715SAndy Fleming struct eth_device *dev, 2105f184715SAndy Fleming phy_interface_t interface); 211eef0b8a9SGrygorii Strashko static inline ofnode phy_get_ofnode(struct phy_device *phydev) 212eef0b8a9SGrygorii Strashko { 213eef0b8a9SGrygorii Strashko return ofnode_null(); 214eef0b8a9SGrygorii Strashko } 215c74c8e66SSimon Glass #endif 2165f184715SAndy Fleming int phy_startup(struct phy_device *phydev); 2175f184715SAndy Fleming int phy_config(struct phy_device *phydev); 2185f184715SAndy Fleming int phy_shutdown(struct phy_device *phydev); 2195f184715SAndy Fleming int phy_register(struct phy_driver *drv); 220b18acb0aSAlexey Brodkin int phy_set_supported(struct phy_device *phydev, u32 max_speed); 2215f184715SAndy Fleming int genphy_config_aneg(struct phy_device *phydev); 2228682aba7STroy Kisky int genphy_restart_aneg(struct phy_device *phydev); 2235f184715SAndy Fleming int genphy_update_link(struct phy_device *phydev); 224e2043f5cSYegor Yefremov int genphy_parse_link(struct phy_device *phydev); 2255f184715SAndy Fleming int genphy_config(struct phy_device *phydev); 2265f184715SAndy Fleming int genphy_startup(struct phy_device *phydev); 2275f184715SAndy Fleming int genphy_shutdown(struct phy_device *phydev); 2285f184715SAndy Fleming int gen10g_config(struct phy_device *phydev); 2295f184715SAndy Fleming int gen10g_startup(struct phy_device *phydev); 2305f184715SAndy Fleming int gen10g_shutdown(struct phy_device *phydev); 2315f184715SAndy Fleming int gen10g_discover_mmds(struct phy_device *phydev); 2325f184715SAndy Fleming 233137963d7SFlorian Fainelli int phy_b53_init(void); 23424ae3961SKevin Smith int phy_mv88e61xx_init(void); 235f7c38cf8SShaohui Xie int phy_aquantia_init(void); 2369082eeacSAndy Fleming int phy_atheros_init(void); 2379082eeacSAndy Fleming int phy_broadcom_init(void); 2389b18e519SShengzhou Liu int phy_cortina_init(void); 2399082eeacSAndy Fleming int phy_davicom_init(void); 240f485c8a3SMatt Porter int phy_et1011c_init(void); 2419082eeacSAndy Fleming int phy_lxt_init(void); 2429082eeacSAndy Fleming int phy_marvell_init(void); 243d397f7c4SAlexandru Gagniuc int phy_micrel_ksz8xxx_init(void); 244d397f7c4SAlexandru Gagniuc int phy_micrel_ksz90x1_init(void); 2458995a96dSNeil Armstrong int phy_meson_gxl_init(void); 2469082eeacSAndy Fleming int phy_natsemi_init(void); 2479082eeacSAndy Fleming int phy_realtek_init(void); 248b6abf555SVladimir Zapolskiy int phy_smsc_init(void); 2499082eeacSAndy Fleming int phy_teranetics_init(void); 250721aed79SEdgar E. Iglesias int phy_ti_init(void); 2519082eeacSAndy Fleming int phy_vitesse_init(void); 252ed6fad3eSSiva Durga Prasad Paladugu int phy_xilinx_init(void); 253a5fd13adSJohn Haechten int phy_mscc_init(void); 254db40c1aaSHannes Schmelzer int phy_fixed_init(void); 2559ab23354SDylan Hung int phy_ncsi_init(void); 256a836626cSTimur Tabi 2572fb63964SFabio Estevam int board_phy_config(struct phy_device *phydev); 2585707d5ffSShengzhou Liu int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id); 2592fb63964SFabio Estevam 260c74c8e66SSimon Glass /** 261c74c8e66SSimon Glass * phy_get_interface_by_name() - Look up a PHY interface name 262c74c8e66SSimon Glass * 263c74c8e66SSimon Glass * @str: PHY interface name, e.g. "mii" 264c74c8e66SSimon Glass * @return PHY_INTERFACE_MODE_... value, or -1 if not found 265c74c8e66SSimon Glass */ 266c74c8e66SSimon Glass int phy_get_interface_by_name(const char *str); 267c74c8e66SSimon Glass 2683ab72fe8SDan Murphy /** 2693ab72fe8SDan Murphy * phy_interface_is_rgmii - Convenience function for testing if a PHY interface 2703ab72fe8SDan Murphy * is RGMII (all variants) 2713ab72fe8SDan Murphy * @phydev: the phy_device struct 2723ab72fe8SDan Murphy */ 2733ab72fe8SDan Murphy static inline bool phy_interface_is_rgmii(struct phy_device *phydev) 2743ab72fe8SDan Murphy { 2753ab72fe8SDan Murphy return phydev->interface >= PHY_INTERFACE_MODE_RGMII && 2763ab72fe8SDan Murphy phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID; 2773ab72fe8SDan Murphy } 2783ab72fe8SDan Murphy 2793c221af3SDan Murphy /** 2803c221af3SDan Murphy * phy_interface_is_sgmii - Convenience function for testing if a PHY interface 2813c221af3SDan Murphy * is SGMII (all variants) 2823c221af3SDan Murphy * @phydev: the phy_device struct 2833c221af3SDan Murphy */ 2843c221af3SDan Murphy static inline bool phy_interface_is_sgmii(struct phy_device *phydev) 2853c221af3SDan Murphy { 2863c221af3SDan Murphy return phydev->interface >= PHY_INTERFACE_MODE_SGMII && 2873c221af3SDan Murphy phydev->interface <= PHY_INTERFACE_MODE_QSGMII; 2883c221af3SDan Murphy } 2893c221af3SDan Murphy 290*8731f296SCédric Le Goater bool phy_interface_is_ncsi(void); 291*8731f296SCédric Le Goater 292a836626cSTimur Tabi /* PHY UIDs for various PHYs that are referenced in external code */ 2939b18e519SShengzhou Liu #define PHY_UID_CS4340 0x13e51002 294552e7c57SVicentiu Galanopulo #define PHY_UID_CS4223 0x03e57003 295a836626cSTimur Tabi #define PHY_UID_TN2020 0x00a19410 2961ddcf5edSPriyanka Jain #define PHY_UID_IN112525_S03 0x02107440 297a836626cSTimur Tabi 2985f184715SAndy Fleming #endif 299