include/linux/mdio.h

   1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   2 /*
   3  * linux/mdio.h: definitions for MDIO (clause 45) transceivers
   4  * Copyright 2006-2009 Solarflare Communications Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published
   8  * by the Free Software Foundation, incorporated herein by reference.
   9  */
  10
  11 #ifndef __LINUX_MDIO_H__
  12 #define __LINUX_MDIO_H__
  13
  14 #include <linux/mii.h>
  15
  16 /* MDIO Manageable Devices (MMDs). */
  17 #define MDIO_MMD_PMAPMD         1       /* Physical Medium Attachment/
  18                                          * Physical Medium Dependent */
  19 #define MDIO_MMD_WIS            2       /* WAN Interface Sublayer */
  20 #define MDIO_MMD_PCS            3       /* Physical Coding Sublayer */
  21 #define MDIO_MMD_PHYXS          4       /* PHY Extender Sublayer */
  22 #define MDIO_MMD_DTEXS          5       /* DTE Extender Sublayer */
  23 #define MDIO_MMD_TC             6       /* Transmission Convergence */
  24 #define MDIO_MMD_AN             7       /* Auto-Negotiation */
  25 #define MDIO_MMD_C22EXT         29      /* Clause 22 extension */
  26 #define MDIO_MMD_VEND1          30      /* Vendor specific 1 */
  27 #define MDIO_MMD_VEND2          31      /* Vendor specific 2 */
  28
  29 /* Generic MDIO registers. */
  30 #define MDIO_CTRL1              MII_BMCR
  31 #define MDIO_STAT1              MII_BMSR
  32 #define MDIO_DEVID1             MII_PHYSID1
  33 #define MDIO_DEVID2             MII_PHYSID2
  34 #define MDIO_SPEED              4       /* Speed ability */
  35 #define MDIO_DEVS1              5       /* Devices in package */
  36 #define MDIO_DEVS2              6
  37 #define MDIO_CTRL2              7       /* 10G control 2 */
  38 #define MDIO_STAT2              8       /* 10G status 2 */
  39 #define MDIO_PMA_TXDIS          9       /* 10G PMA/PMD transmit disable */
  40 #define MDIO_PMA_RXDET          10      /* 10G PMA/PMD receive signal detect */
  41 #define MDIO_PMA_EXTABLE        11      /* 10G PMA/PMD extended ability */
  42 #define MDIO_PKGID1             14      /* Package identifier */
  43 #define MDIO_PKGID2             15
  44 #define MDIO_AN_ADVERTISE       16      /* AN advertising (base page) */
  45 #define MDIO_AN_LPA             19      /* AN LP abilities (base page) */
  46 #define MDIO_PCS_EEE_ABLE       20      /* EEE Capability register */
  47 #define MDIO_PCS_EEE_WK_ERR     22      /* EEE wake error counter */
  48 #define MDIO_PHYXS_LNSTAT       24      /* PHY XGXS lane state */
  49 #define MDIO_AN_EEE_ADV         60      /* EEE advertisement */
  50 #define MDIO_AN_EEE_LPABLE      61      /* EEE link partner ability */
  51
  52 /* Media-dependent registers. */
  53 #define MDIO_PMA_10GBT_SWAPPOL  130     /* 10GBASE-T pair swap & polarity */
  54 #define MDIO_PMA_10GBT_TXPWR    131     /* 10GBASE-T TX power control */
  55 #define MDIO_PMA_10GBT_SNR      133     /* 10GBASE-T SNR margin, lane A.
  56                                          * Lanes B-D are numbered 134-136. */
  57 #define MDIO_PMA_10GBR_FECABLE  170     /* 10GBASE-R FEC ability */
  58 #define MDIO_PCS_10GBX_STAT1    24      /* 10GBASE-X PCS status 1 */
  59 #define MDIO_PCS_10GBRT_STAT1   32      /* 10GBASE-R/-T PCS status 1 */
  60 #define MDIO_PCS_10GBRT_STAT2   33      /* 10GBASE-R/-T PCS status 2 */
  61 #define MDIO_AN_10GBT_CTRL      32      /* 10GBASE-T auto-negotiation control */
  62 #define MDIO_AN_10GBT_STAT      33      /* 10GBASE-T auto-negotiation status */
  63
  64 /* LASI (Link Alarm Status Interrupt) registers, defined by XENPAK MSA. */
  65 #define MDIO_PMA_LASI_RXCTRL    0x9000  /* RX_ALARM control */
  66 #define MDIO_PMA_LASI_TXCTRL    0x9001  /* TX_ALARM control */
  67 #define MDIO_PMA_LASI_CTRL      0x9002  /* LASI control */
  68 #define MDIO_PMA_LASI_RXSTAT    0x9003  /* RX_ALARM status */
  69 #define MDIO_PMA_LASI_TXSTAT    0x9004  /* TX_ALARM status */
  70 #define MDIO_PMA_LASI_STAT      0x9005  /* LASI status */
  71
  72 /* Control register 1. */
  73 /* Enable extended speed selection */
  74 #define MDIO_CTRL1_SPEEDSELEXT          (BMCR_SPEED1000 | BMCR_SPEED100)
  75 /* All speed selection bits */
  76 #define MDIO_CTRL1_SPEEDSEL             (MDIO_CTRL1_SPEEDSELEXT | 0x003c)
  77 #define MDIO_CTRL1_FULLDPLX             BMCR_FULLDPLX
  78 #define MDIO_CTRL1_LPOWER               BMCR_PDOWN
  79 #define MDIO_CTRL1_RESET                BMCR_RESET
  80 #define MDIO_PMA_CTRL1_LOOPBACK         0x0001
  81 #define MDIO_PMA_CTRL1_SPEED1000        BMCR_SPEED1000
  82 #define MDIO_PMA_CTRL1_SPEED100         BMCR_SPEED100
  83 #define MDIO_PCS_CTRL1_LOOPBACK         BMCR_LOOPBACK
  84 #define MDIO_PHYXS_CTRL1_LOOPBACK       BMCR_LOOPBACK
  85 #define MDIO_AN_CTRL1_RESTART           BMCR_ANRESTART
  86 #define MDIO_AN_CTRL1_ENABLE            BMCR_ANENABLE
  87 #define MDIO_AN_CTRL1_XNP               0x2000  /* Enable extended next page */
  88 #define MDIO_PCS_CTRL1_CLKSTOP_EN       0x400   /* Stop the clock during LPI */
  89
  90 /* 10 Gb/s */
  91 #define MDIO_CTRL1_SPEED10G             (MDIO_CTRL1_SPEEDSELEXT | 0x00)
  92 /* 10PASS-TS/2BASE-TL */
  93 #define MDIO_CTRL1_SPEED10P2B           (MDIO_CTRL1_SPEEDSELEXT | 0x04)
  94
  95 /* Status register 1. */
  96 #define MDIO_STAT1_LPOWERABLE           0x0002  /* Low-power ability */
  97 #define MDIO_STAT1_LSTATUS              BMSR_LSTATUS
  98 #define MDIO_STAT1_FAULT                0x0080  /* Fault */
  99 #define MDIO_AN_STAT1_LPABLE            0x0001  /* Link partner AN ability */
 100 #define MDIO_AN_STAT1_ABLE              BMSR_ANEGCAPABLE
 101 #define MDIO_AN_STAT1_RFAULT            BMSR_RFAULT
 102 #define MDIO_AN_STAT1_COMPLETE          BMSR_ANEGCOMPLETE
 103 #define MDIO_AN_STAT1_PAGE              0x0040  /* Page received */
 104 #define MDIO_AN_STAT1_XNP               0x0080  /* Extended next page status */
 105
 106 /* Speed register. */
 107 #define MDIO_SPEED_10G                  0x0001  /* 10G capable */
 108 #define MDIO_PMA_SPEED_2B               0x0002  /* 2BASE-TL capable */
 109 #define MDIO_PMA_SPEED_10P              0x0004  /* 10PASS-TS capable */
 110 #define MDIO_PMA_SPEED_1000             0x0010  /* 1000M capable */
 111 #define MDIO_PMA_SPEED_100              0x0020  /* 100M capable */
 112 #define MDIO_PMA_SPEED_10               0x0040  /* 10M capable */
 113 #define MDIO_PCS_SPEED_10P2B            0x0002  /* 10PASS-TS/2BASE-TL capable */
 114
 115 /* Device present registers. */
 116 #define MDIO_DEVS_PRESENT(devad)        (1 << (devad))
 117 #define MDIO_DEVS_PMAPMD                MDIO_DEVS_PRESENT(MDIO_MMD_PMAPMD)
 118 #define MDIO_DEVS_WIS                   MDIO_DEVS_PRESENT(MDIO_MMD_WIS)
 119 #define MDIO_DEVS_PCS                   MDIO_DEVS_PRESENT(MDIO_MMD_PCS)
 120 #define MDIO_DEVS_PHYXS                 MDIO_DEVS_PRESENT(MDIO_MMD_PHYXS)
 121 #define MDIO_DEVS_DTEXS                 MDIO_DEVS_PRESENT(MDIO_MMD_DTEXS)
 122 #define MDIO_DEVS_TC                    MDIO_DEVS_PRESENT(MDIO_MMD_TC)
 123 #define MDIO_DEVS_AN                    MDIO_DEVS_PRESENT(MDIO_MMD_AN)
 124 #define MDIO_DEVS_C22EXT                MDIO_DEVS_PRESENT(MDIO_MMD_C22EXT)
 125 #define MDIO_DEVS_VEND1                 MDIO_DEVS_PRESENT(MDIO_MMD_VEND1)
 126 #define MDIO_DEVS_VEND2                 MDIO_DEVS_PRESENT(MDIO_MMD_VEND2)
 127
 128 #define MDIO_DEVS_LINK                  (MDIO_DEVS_PMAPMD | \
 129                                         MDIO_DEVS_WIS | \
 130                                         MDIO_DEVS_PCS | \
 131                                         MDIO_DEVS_PHYXS | \
 132                                         MDIO_DEVS_DTEXS | \
 133                                         MDIO_DEVS_AN)
 134
 135 /* Control register 2. */
 136 #define MDIO_PMA_CTRL2_TYPE             0x000f  /* PMA/PMD type selection */
 137 #define MDIO_PMA_CTRL2_10GBCX4          0x0000  /* 10GBASE-CX4 type */
 138 #define MDIO_PMA_CTRL2_10GBEW           0x0001  /* 10GBASE-EW type */
 139 #define MDIO_PMA_CTRL2_10GBLW           0x0002  /* 10GBASE-LW type */
 140 #define MDIO_PMA_CTRL2_10GBSW           0x0003  /* 10GBASE-SW type */
 141 #define MDIO_PMA_CTRL2_10GBLX4          0x0004  /* 10GBASE-LX4 type */
 142 #define MDIO_PMA_CTRL2_10GBER           0x0005  /* 10GBASE-ER type */
 143 #define MDIO_PMA_CTRL2_10GBLR           0x0006  /* 10GBASE-LR type */
 144 #define MDIO_PMA_CTRL2_10GBSR           0x0007  /* 10GBASE-SR type */
 145 #define MDIO_PMA_CTRL2_10GBLRM          0x0008  /* 10GBASE-LRM type */
 146 #define MDIO_PMA_CTRL2_10GBT            0x0009  /* 10GBASE-T type */
 147 #define MDIO_PMA_CTRL2_10GBKX4          0x000a  /* 10GBASE-KX4 type */
 148 #define MDIO_PMA_CTRL2_10GBKR           0x000b  /* 10GBASE-KR type */
 149 #define MDIO_PMA_CTRL2_1000BT           0x000c  /* 1000BASE-T type */
 150 #define MDIO_PMA_CTRL2_1000BKX          0x000d  /* 1000BASE-KX type */
 151 #define MDIO_PMA_CTRL2_100BTX           0x000e  /* 100BASE-TX type */
 152 #define MDIO_PMA_CTRL2_10BT             0x000f  /* 10BASE-T type */
 153 #define MDIO_PCS_CTRL2_TYPE             0x0003  /* PCS type selection */
 154 #define MDIO_PCS_CTRL2_10GBR            0x0000  /* 10GBASE-R type */
 155 #define MDIO_PCS_CTRL2_10GBX            0x0001  /* 10GBASE-X type */
 156 #define MDIO_PCS_CTRL2_10GBW            0x0002  /* 10GBASE-W type */
 157 #define MDIO_PCS_CTRL2_10GBT            0x0003  /* 10GBASE-T type */
 158
 159 /* Status register 2. */
 160 #define MDIO_STAT2_RXFAULT              0x0400  /* Receive fault */
 161 #define MDIO_STAT2_TXFAULT              0x0800  /* Transmit fault */
 162 #define MDIO_STAT2_DEVPRST              0xc000  /* Device present */
 163 #define MDIO_STAT2_DEVPRST_VAL          0x8000  /* Device present value */
 164 #define MDIO_PMA_STAT2_LBABLE           0x0001  /* PMA loopback ability */
 165 #define MDIO_PMA_STAT2_10GBEW           0x0002  /* 10GBASE-EW ability */
 166 #define MDIO_PMA_STAT2_10GBLW           0x0004  /* 10GBASE-LW ability */
 167 #define MDIO_PMA_STAT2_10GBSW           0x0008  /* 10GBASE-SW ability */
 168 #define MDIO_PMA_STAT2_10GBLX4          0x0010  /* 10GBASE-LX4 ability */
 169 #define MDIO_PMA_STAT2_10GBER           0x0020  /* 10GBASE-ER ability */
 170 #define MDIO_PMA_STAT2_10GBLR           0x0040  /* 10GBASE-LR ability */
 171 #define MDIO_PMA_STAT2_10GBSR           0x0080  /* 10GBASE-SR ability */
 172 #define MDIO_PMD_STAT2_TXDISAB          0x0100  /* PMD TX disable ability */
 173 #define MDIO_PMA_STAT2_EXTABLE          0x0200  /* Extended abilities */
 174 #define MDIO_PMA_STAT2_RXFLTABLE        0x1000  /* Receive fault ability */
 175 #define MDIO_PMA_STAT2_TXFLTABLE        0x2000  /* Transmit fault ability */
 176 #define MDIO_PCS_STAT2_10GBR            0x0001  /* 10GBASE-R capable */
 177 #define MDIO_PCS_STAT2_10GBX            0x0002  /* 10GBASE-X capable */
 178 #define MDIO_PCS_STAT2_10GBW            0x0004  /* 10GBASE-W capable */
 179 #define MDIO_PCS_STAT2_RXFLTABLE        0x1000  /* Receive fault ability */
 180 #define MDIO_PCS_STAT2_TXFLTABLE        0x2000  /* Transmit fault ability */
 181
 182 /* Transmit disable register. */
 183 #define MDIO_PMD_TXDIS_GLOBAL           0x0001  /* Global PMD TX disable */
 184 #define MDIO_PMD_TXDIS_0                0x0002  /* PMD TX disable 0 */
 185 #define MDIO_PMD_TXDIS_1                0x0004  /* PMD TX disable 1 */
 186 #define MDIO_PMD_TXDIS_2                0x0008  /* PMD TX disable 2 */
 187 #define MDIO_PMD_TXDIS_3                0x0010  /* PMD TX disable 3 */
 188
 189 /* Receive signal detect register. */
 190 #define MDIO_PMD_RXDET_GLOBAL           0x0001  /* Global PMD RX signal detect */
 191 #define MDIO_PMD_RXDET_0                0x0002  /* PMD RX signal detect 0 */
 192 #define MDIO_PMD_RXDET_1                0x0004  /* PMD RX signal detect 1 */
 193 #define MDIO_PMD_RXDET_2                0x0008  /* PMD RX signal detect 2 */
 194 #define MDIO_PMD_RXDET_3                0x0010  /* PMD RX signal detect 3 */
 195
 196 /* Extended abilities register. */
 197 #define MDIO_PMA_EXTABLE_10GCX4         0x0001  /* 10GBASE-CX4 ability */
 198 #define MDIO_PMA_EXTABLE_10GBLRM        0x0002  /* 10GBASE-LRM ability */
 199 #define MDIO_PMA_EXTABLE_10GBT          0x0004  /* 10GBASE-T ability */
 200 #define MDIO_PMA_EXTABLE_10GBKX4        0x0008  /* 10GBASE-KX4 ability */
 201 #define MDIO_PMA_EXTABLE_10GBKR         0x0010  /* 10GBASE-KR ability */
 202 #define MDIO_PMA_EXTABLE_1000BT         0x0020  /* 1000BASE-T ability */
 203 #define MDIO_PMA_EXTABLE_1000BKX        0x0040  /* 1000BASE-KX ability */
 204 #define MDIO_PMA_EXTABLE_100BTX         0x0080  /* 100BASE-TX ability */
 205 #define MDIO_PMA_EXTABLE_10BT           0x0100  /* 10BASE-T ability */
 206
 207 /* PHY XGXS lane state register. */
 208 #define MDIO_PHYXS_LNSTAT_SYNC0         0x0001
 209 #define MDIO_PHYXS_LNSTAT_SYNC1         0x0002
 210 #define MDIO_PHYXS_LNSTAT_SYNC2         0x0004
 211 #define MDIO_PHYXS_LNSTAT_SYNC3         0x0008
 212 #define MDIO_PHYXS_LNSTAT_ALIGN         0x1000
 213
 214 /* PMA 10GBASE-T pair swap & polarity */
 215 #define MDIO_PMA_10GBT_SWAPPOL_ABNX     0x0001  /* Pair A/B uncrossed */
 216 #define MDIO_PMA_10GBT_SWAPPOL_CDNX     0x0002  /* Pair C/D uncrossed */
 217 #define MDIO_PMA_10GBT_SWAPPOL_AREV     0x0100  /* Pair A polarity reversed */
 218 #define MDIO_PMA_10GBT_SWAPPOL_BREV     0x0200  /* Pair B polarity reversed */
 219 #define MDIO_PMA_10GBT_SWAPPOL_CREV     0x0400  /* Pair C polarity reversed */
 220 #define MDIO_PMA_10GBT_SWAPPOL_DREV     0x0800  /* Pair D polarity reversed */
 221
 222 /* PMA 10GBASE-T TX power register. */
 223 #define MDIO_PMA_10GBT_TXPWR_SHORT      0x0001  /* Short-reach mode */
 224
 225 /* PMA 10GBASE-T SNR registers. */
 226 /* Value is SNR margin in dB, clamped to range [-127, 127], plus 0x8000. */
 227 #define MDIO_PMA_10GBT_SNR_BIAS         0x8000
 228 #define MDIO_PMA_10GBT_SNR_MAX          127
 229
 230 /* PMA 10GBASE-R FEC ability register. */
 231 #define MDIO_PMA_10GBR_FECABLE_ABLE     0x0001  /* FEC ability */
 232 #define MDIO_PMA_10GBR_FECABLE_ERRABLE  0x0002  /* FEC error indic. ability */
 233
 234 /* PCS 10GBASE-R/-T status register 1. */
 235 #define MDIO_PCS_10GBRT_STAT1_BLKLK     0x0001  /* Block lock attained */
 236
 237 /* PCS 10GBASE-R/-T status register 2. */
 238 #define MDIO_PCS_10GBRT_STAT2_ERR       0x00ff
 239 #define MDIO_PCS_10GBRT_STAT2_BER       0x3f00
 240
 241 /* AN 10GBASE-T control register. */
 242 #define MDIO_AN_10GBT_CTRL_ADV10G       0x1000  /* Advertise 10GBASE-T */
 243
 244 /* AN 10GBASE-T status register. */
 245 #define MDIO_AN_10GBT_STAT_LPTRR        0x0200  /* LP training reset req. */
 246 #define MDIO_AN_10GBT_STAT_LPLTABLE     0x0400  /* LP loop timing ability */
 247 #define MDIO_AN_10GBT_STAT_LP10G        0x0800  /* LP is 10GBT capable */
 248 #define MDIO_AN_10GBT_STAT_REMOK        0x1000  /* Remote OK */
 249 #define MDIO_AN_10GBT_STAT_LOCOK        0x2000  /* Local OK */
 250 #define MDIO_AN_10GBT_STAT_MS           0x4000  /* Master/slave config */
 251 #define MDIO_AN_10GBT_STAT_MSFLT        0x8000  /* Master/slave config fault */
 252
 253 /* EEE Supported/Advertisement/LP Advertisement registers.
 254  *
 255  * EEE capability Register (3.20), Advertisement (7.60) and
 256  * Link partner ability (7.61) registers have and can use the same identical
 257  * bit masks.
 258  */
 259 #define MDIO_AN_EEE_ADV_100TX   0x0002  /* Advertise 100TX EEE cap */
 260 #define MDIO_AN_EEE_ADV_1000T   0x0004  /* Advertise 1000T EEE cap */
 261 /* Note: the two defines above can be potentially used by the user-land
 262  * and cannot remove them now.
 263  * So, we define the new generic MDIO_EEE_100TX and MDIO_EEE_1000T macros
 264  * using the previous ones (that can be considered obsolete).
 265  */
 266 #define MDIO_EEE_100TX          MDIO_AN_EEE_ADV_100TX   /* 100TX EEE cap */
 267 #define MDIO_EEE_1000T          MDIO_AN_EEE_ADV_1000T   /* 1000T EEE cap */
 268 #define MDIO_EEE_10GT           0x0008  /* 10GT EEE cap */
 269 #define MDIO_EEE_1000KX         0x0010  /* 1000KX EEE cap */
 270 #define MDIO_EEE_10GKX4         0x0020  /* 10G KX4 EEE cap */
 271 #define MDIO_EEE_10GKR          0x0040  /* 10G KR EEE cap */
 272
 273 /* LASI RX_ALARM control/status registers. */
 274 #define MDIO_PMA_LASI_RX_PHYXSLFLT      0x0001  /* PHY XS RX local fault */
 275 #define MDIO_PMA_LASI_RX_PCSLFLT        0x0008  /* PCS RX local fault */
 276 #define MDIO_PMA_LASI_RX_PMALFLT        0x0010  /* PMA/PMD RX local fault */
 277 #define MDIO_PMA_LASI_RX_OPTICPOWERFLT  0x0020  /* RX optical power fault */
 278 #define MDIO_PMA_LASI_RX_WISLFLT        0x0200  /* WIS local fault */
 279
 280 /* LASI TX_ALARM control/status registers. */
 281 #define MDIO_PMA_LASI_TX_PHYXSLFLT      0x0001  /* PHY XS TX local fault */
 282 #define MDIO_PMA_LASI_TX_PCSLFLT        0x0008  /* PCS TX local fault */
 283 #define MDIO_PMA_LASI_TX_PMALFLT        0x0010  /* PMA/PMD TX local fault */
 284 #define MDIO_PMA_LASI_TX_LASERPOWERFLT  0x0080  /* Laser output power fault */
 285 #define MDIO_PMA_LASI_TX_LASERTEMPFLT   0x0100  /* Laser temperature fault */
 286 #define MDIO_PMA_LASI_TX_LASERBICURRFLT 0x0200  /* Laser bias current fault */
 287
 288 /* LASI control/status registers. */
 289 #define MDIO_PMA_LASI_LSALARM           0x0001  /* LS_ALARM enable/status */
 290 #define MDIO_PMA_LASI_TXALARM           0x0002  /* TX_ALARM enable/status */
 291 #define MDIO_PMA_LASI_RXALARM           0x0004  /* RX_ALARM enable/status */
 292
 293 /* Mapping between MDIO PRTAD/DEVAD and mii_ioctl_data::phy_id */
 294
 295 #define MDIO_PHY_ID_C45                 0x8000
 296 #define MDIO_PHY_ID_PRTAD               0x03e0
 297 #define MDIO_PHY_ID_DEVAD               0x001f
 298 #define MDIO_PHY_ID_C45_MASK                                            \
 299         (MDIO_PHY_ID_C45 | MDIO_PHY_ID_PRTAD | MDIO_PHY_ID_DEVAD)
 300
 301 #define MDIO_PRTAD_NONE                 (-1)
 302 #define MDIO_DEVAD_NONE                 (-1)
 303 #define MDIO_EMULATE_C22                4
 304
 305 static inline __u16 mdio_phy_id_c45(int prtad, int devad)
 306 {
 307         return MDIO_PHY_ID_C45 | (prtad << 5) | devad;
 308 }
 309
 310 #endif /* __LINUX_MDIO_H__ */