include/linux/mii.h

   1 /*
   2  * linux/mii.h: definitions for MII-compatible transceivers
   3  * Originally drivers/net/sunhme.h.
   4  *
   5  * Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
   6  */
   7
   8 #ifndef __LINUX_MII_H__
   9 #define __LINUX_MII_H__
  10
  11 #include <linux/types.h>
  12
  13 /* Generic MII registers. */
  14 #define MII_BMCR                0x00    /* Basic mode control register */
  15 #define MII_BMSR                0x01    /* Basic mode status register  */
  16 #define MII_PHYSID1             0x02    /* PHYS ID 1                   */
  17 #define MII_PHYSID2             0x03    /* PHYS ID 2                   */
  18 #define MII_ADVERTISE           0x04    /* Advertisement control reg   */
  19 #define MII_LPA                 0x05    /* Link partner ability reg    */
  20 #define MII_EXPANSION           0x06    /* Expansion register          */
  21 #define MII_CTRL1000            0x09    /* 1000BASE-T control          */
  22 #define MII_STAT1000            0x0a    /* 1000BASE-T status           */
  23 #define MII_ESTATUS             0x0f    /* Extended Status             */
  24 #define MII_DCOUNTER            0x12    /* Disconnect counter          */
  25 #define MII_FCSCOUNTER          0x13    /* False carrier counter       */
  26 #define MII_NWAYTEST            0x14    /* N-way auto-neg test reg     */
  27 #define MII_RERRCOUNTER         0x15    /* Receive error counter       */
  28 #define MII_SREVISION           0x16    /* Silicon revision            */
  29 #define MII_RESV1               0x17    /* Reserved...                 */
  30 #define MII_LBRERROR            0x18    /* Lpback, rx, bypass error    */
  31 #define MII_PHYADDR             0x19    /* PHY address                 */
  32 #define MII_RESV2               0x1a    /* Reserved...                 */
  33 #define MII_TPISTATUS           0x1b    /* TPI status for 10mbps       */
  34 #define MII_NCONFIG             0x1c    /* Network interface config    */
  35
  36 /* Basic mode control register. */
  37 #define BMCR_RESV               0x003f  /* Unused...                   */
  38 #define BMCR_SPEED1000          0x0040  /* MSB of Speed (1000)         */
  39 #define BMCR_CTST               0x0080  /* Collision test              */
  40 #define BMCR_FULLDPLX           0x0100  /* Full duplex                 */
  41 #define BMCR_ANRESTART          0x0200  /* Auto negotiation restart    */
  42 #define BMCR_ISOLATE            0x0400  /* Isolate data paths from MII */
  43 #define BMCR_PDOWN              0x0800  /* Enable low power state      */
  44 #define BMCR_ANENABLE           0x1000  /* Enable auto negotiation     */
  45 #define BMCR_SPEED100           0x2000  /* Select 100Mbps              */
  46 #define BMCR_LOOPBACK           0x4000  /* TXD loopback bits           */
  47 #define BMCR_RESET              0x8000  /* Reset to default state      */
  48
  49 /* Basic mode status register. */
  50 #define BMSR_ERCAP              0x0001  /* Ext-reg capability          */
  51 #define BMSR_JCD                0x0002  /* Jabber detected             */
  52 #define BMSR_LSTATUS            0x0004  /* Link status                 */
  53 #define BMSR_ANEGCAPABLE        0x0008  /* Able to do auto-negotiation */
  54 #define BMSR_RFAULT             0x0010  /* Remote fault detected       */
  55 #define BMSR_ANEGCOMPLETE       0x0020  /* Auto-negotiation complete   */
  56 #define BMSR_RESV               0x00c0  /* Unused...                   */
  57 #define BMSR_ESTATEN            0x0100  /* Extended Status in R15      */
  58 #define BMSR_100HALF2           0x0200  /* Can do 100BASE-T2 HDX       */
  59 #define BMSR_100FULL2           0x0400  /* Can do 100BASE-T2 FDX       */
  60 #define BMSR_10HALF             0x0800  /* Can do 10mbps, half-duplex  */
  61 #define BMSR_10FULL             0x1000  /* Can do 10mbps, full-duplex  */
  62 #define BMSR_100HALF            0x2000  /* Can do 100mbps, half-duplex */
  63 #define BMSR_100FULL            0x4000  /* Can do 100mbps, full-duplex */
  64 #define BMSR_100BASE4           0x8000  /* Can do 100mbps, 4k packets  */
  65
  66 /* Advertisement control register. */
  67 #define ADVERTISE_SLCT          0x001f  /* Selector bits               */
  68 #define ADVERTISE_CSMA          0x0001  /* Only selector supported     */
  69 #define ADVERTISE_10HALF        0x0020  /* Try for 10mbps half-duplex  */
  70 #define ADVERTISE_1000XFULL     0x0020  /* Try for 1000BASE-X full-duplex */
  71 #define ADVERTISE_10FULL        0x0040  /* Try for 10mbps full-duplex  */
  72 #define ADVERTISE_1000XHALF     0x0040  /* Try for 1000BASE-X half-duplex */
  73 #define ADVERTISE_100HALF       0x0080  /* Try for 100mbps half-duplex */
  74 #define ADVERTISE_1000XPAUSE    0x0080  /* Try for 1000BASE-X pause    */
  75 #define ADVERTISE_100FULL       0x0100  /* Try for 100mbps full-duplex */
  76 #define ADVERTISE_1000XPSE_ASYM 0x0100  /* Try for 1000BASE-X asym pause */
  77 #define ADVERTISE_100BASE4      0x0200  /* Try for 100mbps 4k packets  */
  78 #define ADVERTISE_PAUSE_CAP     0x0400  /* Try for pause               */
  79 #define ADVERTISE_PAUSE_ASYM    0x0800  /* Try for asymetric pause     */
  80 #define ADVERTISE_RESV          0x1000  /* Unused...                   */
  81 #define ADVERTISE_RFAULT        0x2000  /* Say we can detect faults    */
  82 #define ADVERTISE_LPACK         0x4000  /* Ack link partners response  */
  83 #define ADVERTISE_NPAGE         0x8000  /* Next page bit               */
  84
  85 #define ADVERTISE_FULL          (ADVERTISE_100FULL | ADVERTISE_10FULL | \
  86                                   ADVERTISE_CSMA)
  87 #define ADVERTISE_ALL           (ADVERTISE_10HALF | ADVERTISE_10FULL | \
  88                                   ADVERTISE_100HALF | ADVERTISE_100FULL)
  89
  90 /* Link partner ability register. */
  91 #define LPA_SLCT                0x001f  /* Same as advertise selector  */
  92 #define LPA_10HALF              0x0020  /* Can do 10mbps half-duplex   */
  93 #define LPA_1000XFULL           0x0020  /* Can do 1000BASE-X full-duplex */
  94 #define LPA_10FULL              0x0040  /* Can do 10mbps full-duplex   */
  95 #define LPA_1000XHALF           0x0040  /* Can do 1000BASE-X half-duplex */
  96 #define LPA_100HALF             0x0080  /* Can do 100mbps half-duplex  */
  97 #define LPA_1000XPAUSE          0x0080  /* Can do 1000BASE-X pause     */
  98 #define LPA_100FULL             0x0100  /* Can do 100mbps full-duplex  */
  99 #define LPA_1000XPAUSE_ASYM     0x0100  /* Can do 1000BASE-X pause asym*/
 100 #define LPA_100BASE4            0x0200  /* Can do 100mbps 4k packets   */
 101 #define LPA_PAUSE_CAP           0x0400  /* Can pause                   */
 102 #define LPA_PAUSE_ASYM          0x0800  /* Can pause asymetrically     */
 103 #define LPA_RESV                0x1000  /* Unused...                   */
 104 #define LPA_RFAULT              0x2000  /* Link partner faulted        */
 105 #define LPA_LPACK               0x4000  /* Link partner acked us       */
 106 #define LPA_NPAGE               0x8000  /* Next page bit               */
 107
 108 #define LPA_DUPLEX              (LPA_10FULL | LPA_100FULL)
 109 #define LPA_100                 (LPA_100FULL | LPA_100HALF | LPA_100BASE4)
 110
 111 /* Expansion register for auto-negotiation. */
 112 #define EXPANSION_NWAY          0x0001  /* Can do N-way auto-nego      */
 113 #define EXPANSION_LCWP          0x0002  /* Got new RX page code word   */
 114 #define EXPANSION_ENABLENPAGE   0x0004  /* This enables npage words    */
 115 #define EXPANSION_NPCAPABLE     0x0008  /* Link partner supports npage */
 116 #define EXPANSION_MFAULTS       0x0010  /* Multiple faults detected    */
 117 #define EXPANSION_RESV          0xffe0  /* Unused...                   */
 118
 119 #define ESTATUS_1000_TFULL      0x2000  /* Can do 1000BT Full          */
 120 #define ESTATUS_1000_THALF      0x1000  /* Can do 1000BT Half          */
 121
 122 /* N-way test register. */
 123 #define NWAYTEST_RESV1          0x00ff  /* Unused...                   */
 124 #define NWAYTEST_LOOPBACK       0x0100  /* Enable loopback for N-way   */
 125 #define NWAYTEST_RESV2          0xfe00  /* Unused...                   */
 126
 127 /* 1000BASE-T Control register */
 128 #define ADVERTISE_1000FULL      0x0200  /* Advertise 1000BASE-T full duplex */
 129 #define ADVERTISE_1000HALF      0x0100  /* Advertise 1000BASE-T half duplex */
 130 #define CTL1000_AS_MASTER       0x0800
 131 #define CTL1000_ENABLE_MASTER   0x1000
 132
 133 /* 1000BASE-T Status register */
 134 #define LPA_1000LOCALRXOK       0x2000  /* Link partner local receiver status */
 135 #define LPA_1000REMRXOK         0x1000  /* Link partner remote receiver status */
 136 #define LPA_1000FULL            0x0800  /* Link partner 1000BASE-T full duplex */
 137 #define LPA_1000HALF            0x0400  /* Link partner 1000BASE-T half duplex */
 138
 139 /* Flow control flags */
 140 #define FLOW_CTRL_TX            0x01
 141 #define FLOW_CTRL_RX            0x02
 142
 143 /* This structure is used in all SIOCxMIIxxx ioctl calls */
 144 struct mii_ioctl_data {
 145         __u16           phy_id;
 146         __u16           reg_num;
 147         __u16           val_in;
 148         __u16           val_out;
 149 };
 150
 151 #ifdef __KERNEL__
 152
 153 #include <linux/if.h>
 154
 155 struct ethtool_cmd;
 156
 157 struct mii_if_info {
 158         int phy_id;
 159         int advertising;
 160         int phy_id_mask;
 161         int reg_num_mask;
 162
 163         unsigned int full_duplex : 1;   /* is full duplex? */
 164         unsigned int force_media : 1;   /* is autoneg. disabled? */
 165         unsigned int supports_gmii : 1; /* are GMII registers supported? */
 166
 167         struct net_device *dev;
 168         int (*mdio_read) (struct net_device *dev, int phy_id, int location);
 169         void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
 170 };
 171
 172 extern int mii_link_ok (struct mii_if_info *mii);
 173 extern int mii_nway_restart (struct mii_if_info *mii);
 174 extern int mii_ethtool_gset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
 175 extern int mii_ethtool_sset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
 176 extern int mii_check_gmii_support(struct mii_if_info *mii);
 177 extern void mii_check_link (struct mii_if_info *mii);
 178 extern unsigned int mii_check_media (struct mii_if_info *mii,
 179                                      unsigned int ok_to_print,
 180                                      unsigned int init_media);
 181 extern int generic_mii_ioctl(struct mii_if_info *mii_if,
 182                              struct mii_ioctl_data *mii_data, int cmd,
 183                              unsigned int *duplex_changed);
 184
 185
 186 static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
 187 {
 188         return (struct mii_ioctl_data *) &rq->ifr_ifru;
 189 }
 190
 191 /**
 192  * mii_nway_result
 193  * @negotiated: value of MII ANAR and'd with ANLPAR
 194  *
 195  * Given a set of MII abilities, check each bit and returns the
 196  * currently supported media, in the priority order defined by
 197  * IEEE 802.3u.  We use LPA_xxx constants but note this is not the
 198  * value of LPA solely, as described above.
 199  *
 200  * The one exception to IEEE 802.3u is that 100baseT4 is placed
 201  * between 100T-full and 100T-half.  If your phy does not support
 202  * 100T4 this is fine.  If your phy places 100T4 elsewhere in the
 203  * priority order, you will need to roll your own function.
 204  */
 205 static inline unsigned int mii_nway_result (unsigned int negotiated)
 206 {
 207         unsigned int ret;
 208
 209         if (negotiated & LPA_100FULL)
 210                 ret = LPA_100FULL;
 211         else if (negotiated & LPA_100BASE4)
 212                 ret = LPA_100BASE4;
 213         else if (negotiated & LPA_100HALF)
 214                 ret = LPA_100HALF;
 215         else if (negotiated & LPA_10FULL)
 216                 ret = LPA_10FULL;
 217         else
 218                 ret = LPA_10HALF;
 219
 220         return ret;
 221 }
 222
 223 /**
 224  * mii_duplex
 225  * @duplex_lock: Non-zero if duplex is locked at full
 226  * @negotiated: value of MII ANAR and'd with ANLPAR
 227  *
 228  * A small helper function for a common case.  Returns one
 229  * if the media is operating or locked at full duplex, and
 230  * returns zero otherwise.
 231  */
 232 static inline unsigned int mii_duplex (unsigned int duplex_lock,
 233                                        unsigned int negotiated)
 234 {
 235         if (duplex_lock)
 236                 return 1;
 237         if (mii_nway_result(negotiated) & LPA_DUPLEX)
 238                 return 1;
 239         return 0;
 240 }
 241
 242 /**
 243  * mii_advertise_flowctrl - get flow control advertisement flags
 244  * @cap: Flow control capabilities (FLOW_CTRL_RX, FLOW_CTRL_TX or both)
 245  */
 246 static inline u16 mii_advertise_flowctrl(int cap)
 247 {
 248         u16 adv = 0;
 249
 250         if (cap & FLOW_CTRL_RX)
 251                 adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
 252         if (cap & FLOW_CTRL_TX)
 253                 adv ^= ADVERTISE_PAUSE_ASYM;
 254
 255         return adv;
 256 }
 257
 258 /**
 259  * mii_resolve_flowctrl_fdx
 260  * @lcladv: value of MII ADVERTISE register
 261  * @rmtadv: value of MII LPA register
 262  *
 263  * Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
 264  */
 265 static inline u8 mii_resolve_flowctrl_fdx(u16 lcladv, u16 rmtadv)
 266 {
 267         u8 cap = 0;
 268
 269         if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
 270                 cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
 271         } else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
 272                 if (lcladv & ADVERTISE_PAUSE_CAP)
 273                         cap = FLOW_CTRL_RX;
 274                 else if (rmtadv & ADVERTISE_PAUSE_CAP)
 275                         cap = FLOW_CTRL_TX;
 276         }
 277
 278         return cap;
 279 }
 280
 281 #endif /* __KERNEL__ */
 282 #endif /* __LINUX_MII_H__ */