drivers/net/igb/e1000_defines.h

   1 /*******************************************************************************
   2
   3   Intel(R) Gigabit Ethernet Linux driver
   4   Copyright(c) 2007-2009 Intel Corporation.
   5
   6   This program is free software; you can redistribute it and/or modify it
   7   under the terms and conditions of the GNU General Public License,
   8   version 2, as published by the Free Software Foundation.
   9
  10   This program is distributed in the hope it will be useful, but WITHOUT
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13   more details.
  14
  15   You should have received a copy of the GNU General Public License along with
  16   this program; if not, write to the Free Software Foundation, Inc.,
  17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19   The full GNU General Public License is included in this distribution in
  20   the file called "COPYING".
  21
  22   Contact Information:
  23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25
  26 *******************************************************************************/
  27
  28 #ifndef _E1000_DEFINES_H_
  29 #define _E1000_DEFINES_H_
  30
  31 /* Number of Transmit and Receive Descriptors must be a multiple of 8 */
  32 #define REQ_TX_DESCRIPTOR_MULTIPLE  8
  33 #define REQ_RX_DESCRIPTOR_MULTIPLE  8
  34
  35 /* Definitions for power management and wakeup registers */
  36 /* Wake Up Control */
  37 #define E1000_WUC_PME_EN     0x00000002 /* PME Enable */
  38
  39 /* Wake Up Filter Control */
  40 #define E1000_WUFC_LNKC 0x00000001 /* Link Status Change Wakeup Enable */
  41 #define E1000_WUFC_MAG  0x00000002 /* Magic Packet Wakeup Enable */
  42 #define E1000_WUFC_EX   0x00000004 /* Directed Exact Wakeup Enable */
  43 #define E1000_WUFC_MC   0x00000008 /* Directed Multicast Wakeup Enable */
  44 #define E1000_WUFC_BC   0x00000010 /* Broadcast Wakeup Enable */
  45
  46 /* Extended Device Control */
  47 #define E1000_CTRL_EXT_SDP3_DATA 0x00000080 /* Value of SW Defineable Pin 3 */
  48 /* Physical Func Reset Done Indication */
  49 #define E1000_CTRL_EXT_PFRSTD    0x00004000
  50 #define E1000_CTRL_EXT_LINK_MODE_MASK 0x00C00000
  51 #define E1000_CTRL_EXT_LINK_MODE_PCIE_SERDES  0x00C00000
  52 #define E1000_CTRL_EXT_LINK_MODE_SGMII   0x00800000
  53 #define E1000_CTRL_EXT_EIAME          0x01000000
  54 #define E1000_CTRL_EXT_IRCA           0x00000001
  55 /* Interrupt delay cancellation */
  56 /* Driver loaded bit for FW */
  57 #define E1000_CTRL_EXT_DRV_LOAD       0x10000000
  58 /* Interrupt acknowledge Auto-mask */
  59 /* Clear Interrupt timers after IMS clear */
  60 /* packet buffer parity error detection enabled */
  61 /* descriptor FIFO parity error detection enable */
  62 #define E1000_CTRL_EXT_PBA_CLR        0x80000000 /* PBA Clear */
  63 #define E1000_I2CCMD_REG_ADDR_SHIFT   16
  64 #define E1000_I2CCMD_PHY_ADDR_SHIFT   24
  65 #define E1000_I2CCMD_OPCODE_READ      0x08000000
  66 #define E1000_I2CCMD_OPCODE_WRITE     0x00000000
  67 #define E1000_I2CCMD_READY            0x20000000
  68 #define E1000_I2CCMD_ERROR            0x80000000
  69 #define E1000_MAX_SGMII_PHY_REG_ADDR  255
  70 #define E1000_I2CCMD_PHY_TIMEOUT      200
  71 #define E1000_IVAR_VALID              0x80
  72 #define E1000_GPIE_NSICR              0x00000001
  73 #define E1000_GPIE_MSIX_MODE          0x00000010
  74 #define E1000_GPIE_EIAME              0x40000000
  75 #define E1000_GPIE_PBA                0x80000000
  76
  77 /* Receive Descriptor bit definitions */
  78 #define E1000_RXD_STAT_DD       0x01    /* Descriptor Done */
  79 #define E1000_RXD_STAT_EOP      0x02    /* End of Packet */
  80 #define E1000_RXD_STAT_IXSM     0x04    /* Ignore checksum */
  81 #define E1000_RXD_STAT_VP       0x08    /* IEEE VLAN Packet */
  82 #define E1000_RXD_STAT_UDPCS    0x10    /* UDP xsum calculated */
  83 #define E1000_RXD_STAT_TCPCS    0x20    /* TCP xsum calculated */
  84 #define E1000_RXD_STAT_TS       0x10000 /* Pkt was time stamped */
  85
  86 #define E1000_RXDEXT_STATERR_CE    0x01000000
  87 #define E1000_RXDEXT_STATERR_SE    0x02000000
  88 #define E1000_RXDEXT_STATERR_SEQ   0x04000000
  89 #define E1000_RXDEXT_STATERR_CXE   0x10000000
  90 #define E1000_RXDEXT_STATERR_TCPE  0x20000000
  91 #define E1000_RXDEXT_STATERR_IPE   0x40000000
  92 #define E1000_RXDEXT_STATERR_RXE   0x80000000
  93
  94 /* Same mask, but for extended and packet split descriptors */
  95 #define E1000_RXDEXT_ERR_FRAME_ERR_MASK ( \
  96     E1000_RXDEXT_STATERR_CE  |            \
  97     E1000_RXDEXT_STATERR_SE  |            \
  98     E1000_RXDEXT_STATERR_SEQ |            \
  99     E1000_RXDEXT_STATERR_CXE |            \
 100     E1000_RXDEXT_STATERR_RXE)
 101
 102 #define E1000_MRQC_RSS_FIELD_IPV4_TCP          0x00010000
 103 #define E1000_MRQC_RSS_FIELD_IPV4              0x00020000
 104 #define E1000_MRQC_RSS_FIELD_IPV6_TCP_EX       0x00040000
 105 #define E1000_MRQC_RSS_FIELD_IPV6              0x00100000
 106 #define E1000_MRQC_RSS_FIELD_IPV6_TCP          0x00200000
 107
 108
 109 /* Management Control */
 110 #define E1000_MANC_SMBUS_EN      0x00000001 /* SMBus Enabled - RO */
 111 #define E1000_MANC_ASF_EN        0x00000002 /* ASF Enabled - RO */
 112 /* Enable Neighbor Discovery Filtering */
 113 #define E1000_MANC_RCV_TCO_EN    0x00020000 /* Receive TCO Packets Enabled */
 114 #define E1000_MANC_BLK_PHY_RST_ON_IDE   0x00040000 /* Block phy resets */
 115 /* Enable MAC address filtering */
 116 #define E1000_MANC_EN_MAC_ADDR_FILTER   0x00100000
 117
 118 /* Receive Control */
 119 #define E1000_RCTL_EN             0x00000002    /* enable */
 120 #define E1000_RCTL_SBP            0x00000004    /* store bad packet */
 121 #define E1000_RCTL_UPE            0x00000008    /* unicast promiscuous enable */
 122 #define E1000_RCTL_MPE            0x00000010    /* multicast promiscuous enab */
 123 #define E1000_RCTL_LPE            0x00000020    /* long packet enable */
 124 #define E1000_RCTL_LBM_MAC        0x00000040    /* MAC loopback mode */
 125 #define E1000_RCTL_LBM_TCVR       0x000000C0    /* tcvr loopback mode */
 126 #define E1000_RCTL_RDMTS_HALF     0x00000000    /* rx desc min threshold size */
 127 #define E1000_RCTL_MO_SHIFT       12            /* multicast offset shift */
 128 #define E1000_RCTL_BAM            0x00008000    /* broadcast enable */
 129 #define E1000_RCTL_SZ_512         0x00020000    /* rx buffer size 512 */
 130 #define E1000_RCTL_SZ_256         0x00030000    /* rx buffer size 256 */
 131 #define E1000_RCTL_VFE            0x00040000    /* vlan filter enable */
 132 #define E1000_RCTL_CFIEN          0x00080000    /* canonical form enable */
 133 #define E1000_RCTL_SECRC          0x04000000    /* Strip Ethernet CRC */
 134
 135 /*
 136  * Use byte values for the following shift parameters
 137  * Usage:
 138  *     psrctl |= (((ROUNDUP(value0, 128) >> E1000_PSRCTL_BSIZE0_SHIFT) &
 139  *                  E1000_PSRCTL_BSIZE0_MASK) |
 140  *                ((ROUNDUP(value1, 1024) >> E1000_PSRCTL_BSIZE1_SHIFT) &
 141  *                  E1000_PSRCTL_BSIZE1_MASK) |
 142  *                ((ROUNDUP(value2, 1024) << E1000_PSRCTL_BSIZE2_SHIFT) &
 143  *                  E1000_PSRCTL_BSIZE2_MASK) |
 144  *                ((ROUNDUP(value3, 1024) << E1000_PSRCTL_BSIZE3_SHIFT) |;
 145  *                  E1000_PSRCTL_BSIZE3_MASK))
 146  * where value0 = [128..16256],  default=256
 147  *       value1 = [1024..64512], default=4096
 148  *       value2 = [0..64512],    default=4096
 149  *       value3 = [0..64512],    default=0
 150  */
 151
 152 #define E1000_PSRCTL_BSIZE0_MASK   0x0000007F
 153 #define E1000_PSRCTL_BSIZE1_MASK   0x00003F00
 154 #define E1000_PSRCTL_BSIZE2_MASK   0x003F0000
 155 #define E1000_PSRCTL_BSIZE3_MASK   0x3F000000
 156
 157 #define E1000_PSRCTL_BSIZE0_SHIFT  7            /* Shift _right_ 7 */
 158 #define E1000_PSRCTL_BSIZE1_SHIFT  2            /* Shift _right_ 2 */
 159 #define E1000_PSRCTL_BSIZE2_SHIFT  6            /* Shift _left_ 6 */
 160 #define E1000_PSRCTL_BSIZE3_SHIFT 14            /* Shift _left_ 14 */
 161
 162 /* SWFW_SYNC Definitions */
 163 #define E1000_SWFW_EEP_SM   0x1
 164 #define E1000_SWFW_PHY0_SM  0x2
 165 #define E1000_SWFW_PHY1_SM  0x4
 166
 167 /* FACTPS Definitions */
 168 /* Device Control */
 169 #define E1000_CTRL_FD       0x00000001  /* Full duplex.0=half; 1=full */
 170 #define E1000_CTRL_GIO_MASTER_DISABLE 0x00000004 /*Blocks new Master requests */
 171 #define E1000_CTRL_LRST     0x00000008  /* Link reset. 0=normal,1=reset */
 172 #define E1000_CTRL_ASDE     0x00000020  /* Auto-speed detect enable */
 173 #define E1000_CTRL_SLU      0x00000040  /* Set link up (Force Link) */
 174 #define E1000_CTRL_ILOS     0x00000080  /* Invert Loss-Of Signal */
 175 #define E1000_CTRL_SPD_SEL  0x00000300  /* Speed Select Mask */
 176 #define E1000_CTRL_SPD_100  0x00000100  /* Force 100Mb */
 177 #define E1000_CTRL_SPD_1000 0x00000200  /* Force 1Gb */
 178 #define E1000_CTRL_FRCSPD   0x00000800  /* Force Speed */
 179 #define E1000_CTRL_FRCDPX   0x00001000  /* Force Duplex */
 180 /* Defined polarity of Dock/Undock indication in SDP[0] */
 181 /* Reset both PHY ports, through PHYRST_N pin */
 182 /* enable link status from external LINK_0 and LINK_1 pins */
 183 #define E1000_CTRL_SWDPIN0  0x00040000  /* SWDPIN 0 value */
 184 #define E1000_CTRL_SWDPIN1  0x00080000  /* SWDPIN 1 value */
 185 #define E1000_CTRL_SWDPIO0  0x00400000  /* SWDPIN 0 Input or output */
 186 #define E1000_CTRL_RST      0x04000000  /* Global reset */
 187 #define E1000_CTRL_RFCE     0x08000000  /* Receive Flow Control enable */
 188 #define E1000_CTRL_TFCE     0x10000000  /* Transmit flow control enable */
 189 #define E1000_CTRL_VME      0x40000000  /* IEEE VLAN mode enable */
 190 #define E1000_CTRL_PHY_RST  0x80000000  /* PHY Reset */
 191 /* Initiate an interrupt to manageability engine */
 192 #define E1000_CTRL_I2C_ENA  0x02000000  /* I2C enable */
 193
 194 /* Bit definitions for the Management Data IO (MDIO) and Management Data
 195  * Clock (MDC) pins in the Device Control Register.
 196  */
 197
 198 #define E1000_CONNSW_ENRGSRC             0x4
 199 #define E1000_PCS_CFG_PCS_EN             8
 200 #define E1000_PCS_LCTL_FLV_LINK_UP       1
 201 #define E1000_PCS_LCTL_FSV_100           2
 202 #define E1000_PCS_LCTL_FSV_1000          4
 203 #define E1000_PCS_LCTL_FDV_FULL          8
 204 #define E1000_PCS_LCTL_FSD               0x10
 205 #define E1000_PCS_LCTL_FORCE_LINK        0x20
 206 #define E1000_PCS_LCTL_FORCE_FCTRL       0x80
 207 #define E1000_PCS_LCTL_AN_ENABLE         0x10000
 208 #define E1000_PCS_LCTL_AN_RESTART        0x20000
 209 #define E1000_PCS_LCTL_AN_TIMEOUT        0x40000
 210 #define E1000_ENABLE_SERDES_LOOPBACK     0x0410
 211
 212 #define E1000_PCS_LSTS_LINK_OK           1
 213 #define E1000_PCS_LSTS_SPEED_100         2
 214 #define E1000_PCS_LSTS_SPEED_1000        4
 215 #define E1000_PCS_LSTS_DUPLEX_FULL       8
 216 #define E1000_PCS_LSTS_SYNK_OK           0x10
 217
 218 /* Device Status */
 219 #define E1000_STATUS_FD         0x00000001      /* Full duplex.0=half,1=full */
 220 #define E1000_STATUS_LU         0x00000002      /* Link up.0=no,1=link */
 221 #define E1000_STATUS_FUNC_MASK  0x0000000C      /* PCI Function Mask */
 222 #define E1000_STATUS_FUNC_SHIFT 2
 223 #define E1000_STATUS_FUNC_1     0x00000004      /* Function 1 */
 224 #define E1000_STATUS_TXOFF      0x00000010      /* transmission paused */
 225 #define E1000_STATUS_SPEED_100  0x00000040      /* Speed 100Mb/s */
 226 #define E1000_STATUS_SPEED_1000 0x00000080      /* Speed 1000Mb/s */
 227 /* Change in Dock/Undock state. Clear on write '0'. */
 228 /* Status of Master requests. */
 229 #define E1000_STATUS_GIO_MASTER_ENABLE 0x00080000
 230 /* BMC external code execution disabled */
 231
 232 /* Constants used to intrepret the masked PCI-X bus speed. */
 233
 234 #define SPEED_10    10
 235 #define SPEED_100   100
 236 #define SPEED_1000  1000
 237 #define HALF_DUPLEX 1
 238 #define FULL_DUPLEX 2
 239
 240
 241 #define ADVERTISE_10_HALF                 0x0001
 242 #define ADVERTISE_10_FULL                 0x0002
 243 #define ADVERTISE_100_HALF                0x0004
 244 #define ADVERTISE_100_FULL                0x0008
 245 #define ADVERTISE_1000_HALF               0x0010 /* Not used, just FYI */
 246 #define ADVERTISE_1000_FULL               0x0020
 247
 248 /* 1000/H is not supported, nor spec-compliant. */
 249 #define E1000_ALL_SPEED_DUPLEX (ADVERTISE_10_HALF  |  ADVERTISE_10_FULL | \
 250                                 ADVERTISE_100_HALF |  ADVERTISE_100_FULL | \
 251                                                       ADVERTISE_1000_FULL)
 252 #define E1000_ALL_NOT_GIG      (ADVERTISE_10_HALF  |  ADVERTISE_10_FULL | \
 253                                 ADVERTISE_100_HALF |  ADVERTISE_100_FULL)
 254 #define E1000_ALL_100_SPEED    (ADVERTISE_100_HALF |  ADVERTISE_100_FULL)
 255 #define E1000_ALL_10_SPEED     (ADVERTISE_10_HALF  |  ADVERTISE_10_FULL)
 256 #define E1000_ALL_FULL_DUPLEX  (ADVERTISE_10_FULL  |  ADVERTISE_100_FULL | \
 257                                                       ADVERTISE_1000_FULL)
 258 #define E1000_ALL_HALF_DUPLEX  (ADVERTISE_10_HALF  |  ADVERTISE_100_HALF)
 259
 260 #define AUTONEG_ADVERTISE_SPEED_DEFAULT   E1000_ALL_SPEED_DUPLEX
 261
 262 /* LED Control */
 263 #define E1000_LEDCTL_LED0_MODE_SHIFT      0
 264 #define E1000_LEDCTL_LED0_BLINK           0x00000080
 265
 266 #define E1000_LEDCTL_MODE_LED_ON        0xE
 267 #define E1000_LEDCTL_MODE_LED_OFF       0xF
 268
 269 /* Transmit Descriptor bit definitions */
 270 #define E1000_TXD_POPTS_IXSM 0x01       /* Insert IP checksum */
 271 #define E1000_TXD_POPTS_TXSM 0x02       /* Insert TCP/UDP checksum */
 272 #define E1000_TXD_CMD_EOP    0x01000000 /* End of Packet */
 273 #define E1000_TXD_CMD_IFCS   0x02000000 /* Insert FCS (Ethernet CRC) */
 274 #define E1000_TXD_CMD_RS     0x08000000 /* Report Status */
 275 #define E1000_TXD_CMD_DEXT   0x20000000 /* Descriptor extension (0 = legacy) */
 276 #define E1000_TXD_STAT_DD    0x00000001 /* Descriptor Done */
 277 /* Extended desc bits for Linksec and timesync */
 278
 279 /* Transmit Control */
 280 #define E1000_TCTL_EN     0x00000002    /* enable tx */
 281 #define E1000_TCTL_PSP    0x00000008    /* pad short packets */
 282 #define E1000_TCTL_CT     0x00000ff0    /* collision threshold */
 283 #define E1000_TCTL_COLD   0x003ff000    /* collision distance */
 284 #define E1000_TCTL_RTLC   0x01000000    /* Re-transmit on late collision */
 285
 286 /* Transmit Arbitration Count */
 287
 288 /* SerDes Control */
 289 #define E1000_SCTL_DISABLE_SERDES_LOOPBACK 0x0400
 290
 291 /* Receive Checksum Control */
 292 #define E1000_RXCSUM_IPOFL     0x00000100   /* IPv4 checksum offload */
 293 #define E1000_RXCSUM_TUOFL     0x00000200   /* TCP / UDP checksum offload */
 294 #define E1000_RXCSUM_CRCOFL    0x00000800   /* CRC32 offload enable */
 295 #define E1000_RXCSUM_PCSD      0x00002000   /* packet checksum disabled */
 296
 297 /* Header split receive */
 298 #define E1000_RFCTL_LEF        0x00040000
 299
 300 /* Collision related configuration parameters */
 301 #define E1000_COLLISION_THRESHOLD       15
 302 #define E1000_CT_SHIFT                  4
 303 #define E1000_COLLISION_DISTANCE        63
 304 #define E1000_COLD_SHIFT                12
 305
 306 /* Ethertype field values */
 307 #define ETHERNET_IEEE_VLAN_TYPE 0x8100  /* 802.3ac packet */
 308
 309 #define MAX_JUMBO_FRAME_SIZE    0x3F00
 310
 311 /* PBA constants */
 312 #define E1000_PBA_34K 0x0022
 313 #define E1000_PBA_64K 0x0040    /* 64KB */
 314
 315 #define IFS_MAX       80
 316 #define IFS_MIN       40
 317 #define IFS_RATIO     4
 318 #define IFS_STEP      10
 319 #define MIN_NUM_XMITS 1000
 320
 321 /* SW Semaphore Register */
 322 #define E1000_SWSM_SMBI         0x00000001 /* Driver Semaphore bit */
 323 #define E1000_SWSM_SWESMBI      0x00000002 /* FW Semaphore bit */
 324
 325 /* Interrupt Cause Read */
 326 #define E1000_ICR_TXDW          0x00000001 /* Transmit desc written back */
 327 #define E1000_ICR_LSC           0x00000004 /* Link Status Change */
 328 #define E1000_ICR_RXSEQ         0x00000008 /* rx sequence error */
 329 #define E1000_ICR_RXDMT0        0x00000010 /* rx desc min. threshold (0) */
 330 #define E1000_ICR_RXT0          0x00000080 /* rx timer intr (ring 0) */
 331 #define E1000_ICR_VMMB          0x00000100 /* VM MB event */
 332 /* If this bit asserted, the driver should claim the interrupt */
 333 #define E1000_ICR_INT_ASSERTED  0x80000000
 334 /* LAN connected device generates an interrupt */
 335 #define E1000_ICR_DOUTSYNC      0x10000000 /* NIC DMA out of sync */
 336
 337 /* Extended Interrupt Cause Read */
 338 #define E1000_EICR_RX_QUEUE0    0x00000001 /* Rx Queue 0 Interrupt */
 339 #define E1000_EICR_RX_QUEUE1    0x00000002 /* Rx Queue 1 Interrupt */
 340 #define E1000_EICR_RX_QUEUE2    0x00000004 /* Rx Queue 2 Interrupt */
 341 #define E1000_EICR_RX_QUEUE3    0x00000008 /* Rx Queue 3 Interrupt */
 342 #define E1000_EICR_TX_QUEUE0    0x00000100 /* Tx Queue 0 Interrupt */
 343 #define E1000_EICR_TX_QUEUE1    0x00000200 /* Tx Queue 1 Interrupt */
 344 #define E1000_EICR_TX_QUEUE2    0x00000400 /* Tx Queue 2 Interrupt */
 345 #define E1000_EICR_TX_QUEUE3    0x00000800 /* Tx Queue 3 Interrupt */
 346 #define E1000_EICR_OTHER        0x80000000 /* Interrupt Cause Active */
 347 /* TCP Timer */
 348
 349 /*
 350  * This defines the bits that are set in the Interrupt Mask
 351  * Set/Read Register.  Each bit is documented below:
 352  *   o RXT0   = Receiver Timer Interrupt (ring 0)
 353  *   o TXDW   = Transmit Descriptor Written Back
 354  *   o RXDMT0 = Receive Descriptor Minimum Threshold hit (ring 0)
 355  *   o RXSEQ  = Receive Sequence Error
 356  *   o LSC    = Link Status Change
 357  */
 358 #define IMS_ENABLE_MASK ( \
 359     E1000_IMS_RXT0   |    \
 360     E1000_IMS_TXDW   |    \
 361     E1000_IMS_RXDMT0 |    \
 362     E1000_IMS_RXSEQ  |    \
 363     E1000_IMS_LSC    |    \
 364     E1000_IMS_DOUTSYNC)
 365
 366 /* Interrupt Mask Set */
 367 #define E1000_IMS_TXDW      E1000_ICR_TXDW      /* Transmit desc written back */
 368 #define E1000_IMS_LSC       E1000_ICR_LSC       /* Link Status Change */
 369 #define E1000_IMS_VMMB      E1000_ICR_VMMB      /* Mail box activity */
 370 #define E1000_IMS_RXSEQ     E1000_ICR_RXSEQ     /* rx sequence error */
 371 #define E1000_IMS_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
 372 #define E1000_IMS_RXT0      E1000_ICR_RXT0      /* rx timer intr */
 373 #define E1000_IMS_DOUTSYNC  E1000_ICR_DOUTSYNC /* NIC DMA out of sync */
 374
 375 /* Extended Interrupt Mask Set */
 376 #define E1000_EIMS_OTHER        E1000_EICR_OTHER   /* Interrupt Cause Active */
 377
 378 /* Interrupt Cause Set */
 379 #define E1000_ICS_LSC       E1000_ICR_LSC       /* Link Status Change */
 380 #define E1000_ICS_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
 381
 382 /* Extended Interrupt Cause Set */
 383
 384 /* Transmit Descriptor Control */
 385 /* Enable the counting of descriptors still to be processed. */
 386
 387 /* Flow Control Constants */
 388 #define FLOW_CONTROL_ADDRESS_LOW  0x00C28001
 389 #define FLOW_CONTROL_ADDRESS_HIGH 0x00000100
 390 #define FLOW_CONTROL_TYPE         0x8808
 391
 392 /* 802.1q VLAN Packet Size */
 393 #define VLAN_TAG_SIZE              4    /* 802.3ac tag (not DMA'd) */
 394 #define E1000_VLAN_FILTER_TBL_SIZE 128  /* VLAN Filter Table (4096 bits) */
 395
 396 /* Receive Address */
 397 /*
 398  * Number of high/low register pairs in the RAR. The RAR (Receive Address
 399  * Registers) holds the directed and multicast addresses that we monitor.
 400  * Technically, we have 16 spots.  However, we reserve one of these spots
 401  * (RAR[15]) for our directed address used by controllers with
 402  * manageability enabled, allowing us room for 15 multicast addresses.
 403  */
 404 #define E1000_RAH_AV  0x80000000        /* Receive descriptor valid */
 405 #define E1000_RAL_MAC_ADDR_LEN 4
 406 #define E1000_RAH_MAC_ADDR_LEN 2
 407 #define E1000_RAH_POOL_MASK 0x03FC0000
 408 #define E1000_RAH_POOL_1 0x00040000
 409
 410 /* Error Codes */
 411 #define E1000_ERR_NVM      1
 412 #define E1000_ERR_PHY      2
 413 #define E1000_ERR_CONFIG   3
 414 #define E1000_ERR_PARAM    4
 415 #define E1000_ERR_MAC_INIT 5
 416 #define E1000_ERR_RESET   9
 417 #define E1000_ERR_MASTER_REQUESTS_PENDING 10
 418 #define E1000_BLK_PHY_RESET   12
 419 #define E1000_ERR_SWFW_SYNC 13
 420 #define E1000_NOT_IMPLEMENTED 14
 421 #define E1000_ERR_MBX      15
 422
 423 /* Loop limit on how long we wait for auto-negotiation to complete */
 424 #define COPPER_LINK_UP_LIMIT              10
 425 #define PHY_AUTO_NEG_LIMIT                45
 426 #define PHY_FORCE_LIMIT                   20
 427 /* Number of 100 microseconds we wait for PCI Express master disable */
 428 #define MASTER_DISABLE_TIMEOUT      800
 429 /* Number of milliseconds we wait for PHY configuration done after MAC reset */
 430 #define PHY_CFG_TIMEOUT             100
 431 /* Number of 2 milliseconds we wait for acquiring MDIO ownership. */
 432 /* Number of milliseconds for NVM auto read done after MAC reset. */
 433 #define AUTO_READ_DONE_TIMEOUT      10
 434
 435 /* Flow Control */
 436 #define E1000_FCRTL_XONE 0x80000000     /* Enable XON frame transmission */
 437
 438 /* PCI Express Control */
 439 #define E1000_GCR_CMPL_TMOUT_MASK       0x0000F000
 440 #define E1000_GCR_CMPL_TMOUT_10ms       0x00001000
 441 #define E1000_GCR_CMPL_TMOUT_RESEND     0x00010000
 442 #define E1000_GCR_CAP_VER2              0x00040000
 443
 444 /* PHY Control Register */
 445 #define MII_CR_FULL_DUPLEX      0x0100  /* FDX =1, half duplex =0 */
 446 #define MII_CR_RESTART_AUTO_NEG 0x0200  /* Restart auto negotiation */
 447 #define MII_CR_AUTO_NEG_EN      0x1000  /* Auto Neg Enable */
 448 #define MII_CR_LOOPBACK         0x4000  /* 0 = normal, 1 = loopback */
 449 #define MII_CR_RESET            0x8000  /* 0 = normal, 1 = PHY reset */
 450 #define MII_CR_SPEED_1000       0x0040
 451 #define MII_CR_SPEED_100        0x2000
 452 #define MII_CR_SPEED_10         0x0000
 453
 454 /* PHY Status Register */
 455 #define MII_SR_LINK_STATUS       0x0004 /* Link Status 1 = link */
 456 #define MII_SR_AUTONEG_COMPLETE  0x0020 /* Auto Neg Complete */
 457
 458 /* Autoneg Advertisement Register */
 459 #define NWAY_AR_10T_HD_CAPS      0x0020   /* 10T   Half Duplex Capable */
 460 #define NWAY_AR_10T_FD_CAPS      0x0040   /* 10T   Full Duplex Capable */
 461 #define NWAY_AR_100TX_HD_CAPS    0x0080   /* 100TX Half Duplex Capable */
 462 #define NWAY_AR_100TX_FD_CAPS    0x0100   /* 100TX Full Duplex Capable */
 463 #define NWAY_AR_PAUSE            0x0400   /* Pause operation desired */
 464 #define NWAY_AR_ASM_DIR          0x0800   /* Asymmetric Pause Direction bit */
 465
 466 /* Link Partner Ability Register (Base Page) */
 467 #define NWAY_LPAR_PAUSE          0x0400 /* LP Pause operation desired */
 468 #define NWAY_LPAR_ASM_DIR        0x0800 /* LP Asymmetric Pause Direction bit */
 469
 470 /* Autoneg Expansion Register */
 471
 472 /* 1000BASE-T Control Register */
 473 #define CR_1000T_HD_CAPS         0x0100 /* Advertise 1000T HD capability */
 474 #define CR_1000T_FD_CAPS         0x0200 /* Advertise 1000T FD capability  */
 475 #define CR_1000T_MS_VALUE        0x0800 /* 1=Configure PHY as Master */
 476                                         /* 0=Configure PHY as Slave */
 477 #define CR_1000T_MS_ENABLE       0x1000 /* 1=Master/Slave manual config value */
 478                                         /* 0=Automatic Master/Slave config */
 479
 480 /* 1000BASE-T Status Register */
 481 #define SR_1000T_REMOTE_RX_STATUS 0x1000 /* Remote receiver OK */
 482 #define SR_1000T_LOCAL_RX_STATUS  0x2000 /* Local receiver OK */
 483
 484
 485 /* PHY 1000 MII Register/Bit Definitions */
 486 /* PHY Registers defined by IEEE */
 487 #define PHY_CONTROL      0x00 /* Control Register */
 488 #define PHY_STATUS       0x01 /* Status Register */
 489 #define PHY_ID1          0x02 /* Phy Id Reg (word 1) */
 490 #define PHY_ID2          0x03 /* Phy Id Reg (word 2) */
 491 #define PHY_AUTONEG_ADV  0x04 /* Autoneg Advertisement */
 492 #define PHY_LP_ABILITY   0x05 /* Link Partner Ability (Base Page) */
 493 #define PHY_1000T_CTRL   0x09 /* 1000Base-T Control Reg */
 494 #define PHY_1000T_STATUS 0x0A /* 1000Base-T Status Reg */
 495
 496 /* NVM Control */
 497 #define E1000_EECD_SK        0x00000001 /* NVM Clock */
 498 #define E1000_EECD_CS        0x00000002 /* NVM Chip Select */
 499 #define E1000_EECD_DI        0x00000004 /* NVM Data In */
 500 #define E1000_EECD_DO        0x00000008 /* NVM Data Out */
 501 #define E1000_EECD_REQ       0x00000040 /* NVM Access Request */
 502 #define E1000_EECD_GNT       0x00000080 /* NVM Access Grant */
 503 #define E1000_EECD_PRES      0x00000100 /* NVM Present */
 504 /* NVM Addressing bits based on type 0=small, 1=large */
 505 #define E1000_EECD_ADDR_BITS 0x00000400
 506 #define E1000_NVM_GRANT_ATTEMPTS   1000 /* NVM # attempts to gain grant */
 507 #define E1000_EECD_AUTO_RD          0x00000200  /* NVM Auto Read done */
 508 #define E1000_EECD_SIZE_EX_MASK     0x00007800  /* NVM Size */
 509 #define E1000_EECD_SIZE_EX_SHIFT     11
 510
 511 /* Offset to data in NVM read/write registers */
 512 #define E1000_NVM_RW_REG_DATA   16
 513 #define E1000_NVM_RW_REG_DONE   2    /* Offset to READ/WRITE done bit */
 514 #define E1000_NVM_RW_REG_START  1    /* Start operation */
 515 #define E1000_NVM_RW_ADDR_SHIFT 2    /* Shift to the address bits */
 516 #define E1000_NVM_POLL_READ     0    /* Flag for polling for read complete */
 517
 518 /* NVM Word Offsets */
 519 #define NVM_ID_LED_SETTINGS        0x0004
 520 /* For SERDES output amplitude adjustment. */
 521 #define NVM_INIT_CONTROL2_REG      0x000F
 522 #define NVM_INIT_CONTROL3_PORT_B   0x0014
 523 #define NVM_INIT_CONTROL3_PORT_A   0x0024
 524 #define NVM_ALT_MAC_ADDR_PTR       0x0037
 525 #define NVM_CHECKSUM_REG           0x003F
 526
 527 #define E1000_NVM_CFG_DONE_PORT_0  0x40000 /* MNG config cycle done */
 528 #define E1000_NVM_CFG_DONE_PORT_1  0x80000 /* ...for second port */
 529
 530 /* Mask bits for fields in Word 0x0f of the NVM */
 531 #define NVM_WORD0F_PAUSE_MASK       0x3000
 532 #define NVM_WORD0F_ASM_DIR          0x2000
 533
 534 /* Mask bits for fields in Word 0x1a of the NVM */
 535
 536 /* For checksumming, the sum of all words in the NVM should equal 0xBABA. */
 537 #define NVM_SUM                    0xBABA
 538
 539 #define NVM_PBA_OFFSET_0           8
 540 #define NVM_PBA_OFFSET_1           9
 541 #define NVM_WORD_SIZE_BASE_SHIFT   6
 542
 543 /* NVM Commands - Microwire */
 544
 545 /* NVM Commands - SPI */
 546 #define NVM_MAX_RETRY_SPI          5000 /* Max wait of 5ms, for RDY signal */
 547 #define NVM_WRITE_OPCODE_SPI       0x02 /* NVM write opcode */
 548 #define NVM_A8_OPCODE_SPI          0x08 /* opcode bit-3 = address bit-8 */
 549 #define NVM_WREN_OPCODE_SPI        0x06 /* NVM set Write Enable latch */
 550 #define NVM_RDSR_OPCODE_SPI        0x05 /* NVM read Status register */
 551
 552 /* SPI NVM Status Register */
 553 #define NVM_STATUS_RDY_SPI         0x01
 554
 555 /* Word definitions for ID LED Settings */
 556 #define ID_LED_RESERVED_0000 0x0000
 557 #define ID_LED_RESERVED_FFFF 0xFFFF
 558 #define ID_LED_DEFAULT       ((ID_LED_OFF1_ON2  << 12) | \
 559                               (ID_LED_OFF1_OFF2 <<  8) | \
 560                               (ID_LED_DEF1_DEF2 <<  4) | \
 561                               (ID_LED_DEF1_DEF2))
 562 #define ID_LED_DEF1_DEF2     0x1
 563 #define ID_LED_DEF1_ON2      0x2
 564 #define ID_LED_DEF1_OFF2     0x3
 565 #define ID_LED_ON1_DEF2      0x4
 566 #define ID_LED_ON1_ON2       0x5
 567 #define ID_LED_ON1_OFF2      0x6
 568 #define ID_LED_OFF1_DEF2     0x7
 569 #define ID_LED_OFF1_ON2      0x8
 570 #define ID_LED_OFF1_OFF2     0x9
 571
 572 #define IGP_ACTIVITY_LED_MASK   0xFFFFF0FF
 573 #define IGP_ACTIVITY_LED_ENABLE 0x0300
 574 #define IGP_LED3_MODE           0x07000000
 575
 576 /* PCI/PCI-X/PCI-EX Config space */
 577 #define PCIE_LINK_STATUS             0x12
 578 #define PCIE_DEVICE_CONTROL2         0x28
 579
 580 #define PCIE_LINK_WIDTH_MASK         0x3F0
 581 #define PCIE_LINK_WIDTH_SHIFT        4
 582 #define PCIE_DEVICE_CONTROL2_16ms    0x0005
 583
 584 #define PHY_REVISION_MASK      0xFFFFFFF0
 585 #define MAX_PHY_REG_ADDRESS    0x1F  /* 5 bit address bus (0-0x1F) */
 586 #define MAX_PHY_MULTI_PAGE_REG 0xF
 587
 588 /* Bit definitions for valid PHY IDs. */
 589 /*
 590  * I = Integrated
 591  * E = External
 592  */
 593 #define M88E1111_I_PHY_ID    0x01410CC0
 594 #define IGP03E1000_E_PHY_ID  0x02A80390
 595 #define M88_VENDOR           0x0141
 596
 597 /* M88E1000 Specific Registers */
 598 #define M88E1000_PHY_SPEC_CTRL     0x10  /* PHY Specific Control Register */
 599 #define M88E1000_PHY_SPEC_STATUS   0x11  /* PHY Specific Status Register */
 600 #define M88E1000_EXT_PHY_SPEC_CTRL 0x14  /* Extended PHY Specific Control */
 601
 602 #define M88E1000_PHY_PAGE_SELECT   0x1D  /* Reg 29 for page number setting */
 603 #define M88E1000_PHY_GEN_CONTROL   0x1E  /* Its meaning depends on reg 29 */
 604
 605 /* M88E1000 PHY Specific Control Register */
 606 #define M88E1000_PSCR_POLARITY_REVERSAL 0x0002 /* 1=Polarity Reversal enabled */
 607 /* 1=CLK125 low, 0=CLK125 toggling */
 608 #define M88E1000_PSCR_MDI_MANUAL_MODE  0x0000  /* MDI Crossover Mode bits 6:5 */
 609                                                /* Manual MDI configuration */
 610 #define M88E1000_PSCR_MDIX_MANUAL_MODE 0x0020  /* Manual MDIX configuration */
 611 /* 1000BASE-T: Auto crossover, 100BASE-TX/10BASE-T: MDI Mode */
 612 #define M88E1000_PSCR_AUTO_X_1000T     0x0040
 613 /* Auto crossover enabled all speeds */
 614 #define M88E1000_PSCR_AUTO_X_MODE      0x0060
 615 /*
 616  * 1=Enable Extended 10BASE-T distance (Lower 10BASE-T Rx Threshold
 617  * 0=Normal 10BASE-T Rx Threshold
 618  */
 619 /* 1=5-bit interface in 100BASE-TX, 0=MII interface in 100BASE-TX */
 620 #define M88E1000_PSCR_ASSERT_CRS_ON_TX     0x0800 /* 1=Assert CRS on Transmit */
 621
 622 /* M88E1000 PHY Specific Status Register */
 623 #define M88E1000_PSSR_REV_POLARITY       0x0002 /* 1=Polarity reversed */
 624 #define M88E1000_PSSR_DOWNSHIFT          0x0020 /* 1=Downshifted */
 625 #define M88E1000_PSSR_MDIX               0x0040 /* 1=MDIX; 0=MDI */
 626 /*
 627  * 0 = <50M
 628  * 1 = 50-80M
 629  * 2 = 80-110M
 630  * 3 = 110-140M
 631  * 4 = >140M
 632  */
 633 #define M88E1000_PSSR_CABLE_LENGTH       0x0380
 634 #define M88E1000_PSSR_SPEED              0xC000 /* Speed, bits 14:15 */
 635 #define M88E1000_PSSR_1000MBS            0x8000 /* 10=1000Mbs */
 636
 637 #define M88E1000_PSSR_CABLE_LENGTH_SHIFT 7
 638
 639 /* M88E1000 Extended PHY Specific Control Register */
 640 /*
 641  * 1 = Lost lock detect enabled.
 642  * Will assert lost lock and bring
 643  * link down if idle not seen
 644  * within 1ms in 1000BASE-T
 645  */
 646 /*
 647  * Number of times we will attempt to autonegotiate before downshifting if we
 648  * are the master
 649  */
 650 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_MASK 0x0C00
 651 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_1X   0x0000
 652 /*
 653  * Number of times we will attempt to autonegotiate before downshifting if we
 654  * are the slave
 655  */
 656 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_MASK  0x0300
 657 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_1X    0x0100
 658 #define M88E1000_EPSCR_TX_CLK_25      0x0070 /* 25  MHz TX_CLK */
 659
 660 /* M88EC018 Rev 2 specific DownShift settings */
 661 #define M88EC018_EPSCR_DOWNSHIFT_COUNTER_MASK  0x0E00
 662 #define M88EC018_EPSCR_DOWNSHIFT_COUNTER_5X    0x0800
 663
 664 /* MDI Control */
 665 #define E1000_MDIC_REG_SHIFT 16
 666 #define E1000_MDIC_PHY_SHIFT 21
 667 #define E1000_MDIC_OP_WRITE  0x04000000
 668 #define E1000_MDIC_OP_READ   0x08000000
 669 #define E1000_MDIC_READY     0x10000000
 670 #define E1000_MDIC_ERROR     0x40000000
 671
 672 /* SerDes Control */
 673 #define E1000_GEN_CTL_READY             0x80000000
 674 #define E1000_GEN_CTL_ADDRESS_SHIFT     8
 675 #define E1000_GEN_POLL_TIMEOUT          640
 676
 677 #define E1000_VFTA_ENTRY_SHIFT               5
 678 #define E1000_VFTA_ENTRY_MASK                0x7F
 679 #define E1000_VFTA_ENTRY_BIT_SHIFT_MASK      0x1F
 680
 681 #endif