drivers/net/e1000e/defines.h

   1 /*******************************************************************************
   2
   3   Intel PRO/1000 Linux driver
   4   Copyright(c) 1999 - 2008 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   Linux NICS <linux.nics@intel.com>
  24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  26
  27 *******************************************************************************/
  28
  29 #ifndef _E1000_DEFINES_H_
  30 #define _E1000_DEFINES_H_
  31
  32 #define E1000_TXD_POPTS_IXSM 0x01       /* Insert IP checksum */
  33 #define E1000_TXD_POPTS_TXSM 0x02       /* Insert TCP/UDP checksum */
  34 #define E1000_TXD_CMD_EOP    0x01000000 /* End of Packet */
  35 #define E1000_TXD_CMD_IFCS   0x02000000 /* Insert FCS (Ethernet CRC) */
  36 #define E1000_TXD_CMD_IC     0x04000000 /* Insert Checksum */
  37 #define E1000_TXD_CMD_RS     0x08000000 /* Report Status */
  38 #define E1000_TXD_CMD_RPS    0x10000000 /* Report Packet Sent */
  39 #define E1000_TXD_CMD_DEXT   0x20000000 /* Descriptor extension (0 = legacy) */
  40 #define E1000_TXD_CMD_VLE    0x40000000 /* Add VLAN tag */
  41 #define E1000_TXD_CMD_IDE    0x80000000 /* Enable Tidv register */
  42 #define E1000_TXD_STAT_DD    0x00000001 /* Descriptor Done */
  43 #define E1000_TXD_STAT_EC    0x00000002 /* Excess Collisions */
  44 #define E1000_TXD_STAT_LC    0x00000004 /* Late Collisions */
  45 #define E1000_TXD_STAT_TU    0x00000008 /* Transmit underrun */
  46 #define E1000_TXD_CMD_TCP    0x01000000 /* TCP packet */
  47 #define E1000_TXD_CMD_IP     0x02000000 /* IP packet */
  48 #define E1000_TXD_CMD_TSE    0x04000000 /* TCP Seg enable */
  49 #define E1000_TXD_STAT_TC    0x00000004 /* Tx Underrun */
  50
  51 /* Number of Transmit and Receive Descriptors must be a multiple of 8 */
  52 #define REQ_TX_DESCRIPTOR_MULTIPLE  8
  53 #define REQ_RX_DESCRIPTOR_MULTIPLE  8
  54
  55 /* Definitions for power management and wakeup registers */
  56 /* Wake Up Control */
  57 #define E1000_WUC_APME       0x00000001 /* APM Enable */
  58 #define E1000_WUC_PME_EN     0x00000002 /* PME Enable */
  59
  60 /* Wake Up Filter Control */
  61 #define E1000_WUFC_LNKC 0x00000001 /* Link Status Change Wakeup Enable */
  62 #define E1000_WUFC_MAG  0x00000002 /* Magic Packet Wakeup Enable */
  63 #define E1000_WUFC_EX   0x00000004 /* Directed Exact Wakeup Enable */
  64 #define E1000_WUFC_MC   0x00000008 /* Directed Multicast Wakeup Enable */
  65 #define E1000_WUFC_BC   0x00000010 /* Broadcast Wakeup Enable */
  66 #define E1000_WUFC_ARP  0x00000020 /* ARP Request Packet Wakeup Enable */
  67
  68 /* Extended Device Control */
  69 #define E1000_CTRL_EXT_SDP7_DATA 0x00000080 /* Value of SW Definable Pin 7 */
  70 #define E1000_CTRL_EXT_EE_RST    0x00002000 /* Reinitialize from EEPROM */
  71 #define E1000_CTRL_EXT_RO_DIS    0x00020000 /* Relaxed Ordering disable */
  72 #define E1000_CTRL_EXT_LINK_MODE_MASK 0x00C00000
  73 #define E1000_CTRL_EXT_LINK_MODE_PCIE_SERDES  0x00C00000
  74 #define E1000_CTRL_EXT_DRV_LOAD       0x10000000 /* Driver loaded bit for FW */
  75 #define E1000_CTRL_EXT_IAME           0x08000000 /* Interrupt acknowledge Auto-mask */
  76 #define E1000_CTRL_EXT_INT_TIMER_CLR  0x20000000 /* Clear Interrupt timers after IMS clear */
  77
  78 /* Receive Descriptor bit definitions */
  79 #define E1000_RXD_STAT_DD       0x01    /* Descriptor Done */
  80 #define E1000_RXD_STAT_EOP      0x02    /* End of Packet */
  81 #define E1000_RXD_STAT_IXSM     0x04    /* Ignore checksum */
  82 #define E1000_RXD_STAT_VP       0x08    /* IEEE VLAN Packet */
  83 #define E1000_RXD_STAT_UDPCS    0x10    /* UDP xsum calculated */
  84 #define E1000_RXD_STAT_TCPCS    0x20    /* TCP xsum calculated */
  85 #define E1000_RXD_ERR_CE        0x01    /* CRC Error */
  86 #define E1000_RXD_ERR_SE        0x02    /* Symbol Error */
  87 #define E1000_RXD_ERR_SEQ       0x04    /* Sequence Error */
  88 #define E1000_RXD_ERR_CXE       0x10    /* Carrier Extension Error */
  89 #define E1000_RXD_ERR_TCPE      0x20    /* TCP/UDP Checksum Error */
  90 #define E1000_RXD_ERR_RXE       0x80    /* Rx Data Error */
  91 #define E1000_RXD_SPC_VLAN_MASK 0x0FFF  /* VLAN ID is in lower 12 bits */
  92
  93 #define E1000_RXDEXT_STATERR_CE    0x01000000
  94 #define E1000_RXDEXT_STATERR_SE    0x02000000
  95 #define E1000_RXDEXT_STATERR_SEQ   0x04000000
  96 #define E1000_RXDEXT_STATERR_CXE   0x10000000
  97 #define E1000_RXDEXT_STATERR_RXE   0x80000000
  98
  99 /* mask to determine if packets should be dropped due to frame errors */
 100 #define E1000_RXD_ERR_FRAME_ERR_MASK ( \
 101     E1000_RXD_ERR_CE  |                \
 102     E1000_RXD_ERR_SE  |                \
 103     E1000_RXD_ERR_SEQ |                \
 104     E1000_RXD_ERR_CXE |                \
 105     E1000_RXD_ERR_RXE)
 106
 107 /* Same mask, but for extended and packet split descriptors */
 108 #define E1000_RXDEXT_ERR_FRAME_ERR_MASK ( \
 109     E1000_RXDEXT_STATERR_CE  |            \
 110     E1000_RXDEXT_STATERR_SE  |            \
 111     E1000_RXDEXT_STATERR_SEQ |            \
 112     E1000_RXDEXT_STATERR_CXE |            \
 113     E1000_RXDEXT_STATERR_RXE)
 114
 115 #define E1000_RXDPS_HDRSTAT_HDRSP              0x00008000
 116
 117 /* Management Control */
 118 #define E1000_MANC_SMBUS_EN      0x00000001 /* SMBus Enabled - RO */
 119 #define E1000_MANC_ASF_EN        0x00000002 /* ASF Enabled - RO */
 120 #define E1000_MANC_ARP_EN        0x00002000 /* Enable ARP Request Filtering */
 121 #define E1000_MANC_RCV_TCO_EN    0x00020000 /* Receive TCO Packets Enabled */
 122 #define E1000_MANC_BLK_PHY_RST_ON_IDE   0x00040000 /* Block phy resets */
 123 /* Enable MAC address filtering */
 124 #define E1000_MANC_EN_MAC_ADDR_FILTER   0x00100000
 125 /* Enable MNG packets to host memory */
 126 #define E1000_MANC_EN_MNG2HOST   0x00200000
 127
 128 /* Receive Control */
 129 #define E1000_RCTL_EN             0x00000002    /* enable */
 130 #define E1000_RCTL_SBP            0x00000004    /* store bad packet */
 131 #define E1000_RCTL_UPE            0x00000008    /* unicast promiscuous enable */
 132 #define E1000_RCTL_MPE            0x00000010    /* multicast promiscuous enab */
 133 #define E1000_RCTL_LPE            0x00000020    /* long packet enable */
 134 #define E1000_RCTL_LBM_NO         0x00000000    /* no loopback mode */
 135 #define E1000_RCTL_LBM_MAC        0x00000040    /* MAC loopback mode */
 136 #define E1000_RCTL_LBM_TCVR       0x000000C0    /* tcvr loopback mode */
 137 #define E1000_RCTL_DTYP_PS        0x00000400    /* Packet Split descriptor */
 138 #define E1000_RCTL_RDMTS_HALF     0x00000000    /* Rx desc min threshold size */
 139 #define E1000_RCTL_MO_SHIFT       12            /* multicast offset shift */
 140 #define E1000_RCTL_BAM            0x00008000    /* broadcast enable */
 141 /* these buffer sizes are valid if E1000_RCTL_BSEX is 0 */
 142 #define E1000_RCTL_SZ_2048        0x00000000    /* Rx buffer size 2048 */
 143 #define E1000_RCTL_SZ_1024        0x00010000    /* Rx buffer size 1024 */
 144 #define E1000_RCTL_SZ_512         0x00020000    /* Rx buffer size 512 */
 145 #define E1000_RCTL_SZ_256         0x00030000    /* Rx buffer size 256 */
 146 /* these buffer sizes are valid if E1000_RCTL_BSEX is 1 */
 147 #define E1000_RCTL_SZ_16384       0x00010000    /* Rx buffer size 16384 */
 148 #define E1000_RCTL_SZ_8192        0x00020000    /* Rx buffer size 8192 */
 149 #define E1000_RCTL_SZ_4096        0x00030000    /* Rx buffer size 4096 */
 150 #define E1000_RCTL_VFE            0x00040000    /* vlan filter enable */
 151 #define E1000_RCTL_CFIEN          0x00080000    /* canonical form enable */
 152 #define E1000_RCTL_CFI            0x00100000    /* canonical form indicator */
 153 #define E1000_RCTL_BSEX           0x02000000    /* Buffer size extension */
 154 #define E1000_RCTL_SECRC          0x04000000    /* Strip Ethernet CRC */
 155
 156 /*
 157  * Use byte values for the following shift parameters
 158  * Usage:
 159  *     psrctl |= (((ROUNDUP(value0, 128) >> E1000_PSRCTL_BSIZE0_SHIFT) &
 160  *                  E1000_PSRCTL_BSIZE0_MASK) |
 161  *                ((ROUNDUP(value1, 1024) >> E1000_PSRCTL_BSIZE1_SHIFT) &
 162  *                  E1000_PSRCTL_BSIZE1_MASK) |
 163  *                ((ROUNDUP(value2, 1024) << E1000_PSRCTL_BSIZE2_SHIFT) &
 164  *                  E1000_PSRCTL_BSIZE2_MASK) |
 165  *                ((ROUNDUP(value3, 1024) << E1000_PSRCTL_BSIZE3_SHIFT) |;
 166  *                  E1000_PSRCTL_BSIZE3_MASK))
 167  * where value0 = [128..16256],  default=256
 168  *       value1 = [1024..64512], default=4096
 169  *       value2 = [0..64512],    default=4096
 170  *       value3 = [0..64512],    default=0
 171  */
 172
 173 #define E1000_PSRCTL_BSIZE0_MASK   0x0000007F
 174 #define E1000_PSRCTL_BSIZE1_MASK   0x00003F00
 175 #define E1000_PSRCTL_BSIZE2_MASK   0x003F0000
 176 #define E1000_PSRCTL_BSIZE3_MASK   0x3F000000
 177
 178 #define E1000_PSRCTL_BSIZE0_SHIFT  7            /* Shift _right_ 7 */
 179 #define E1000_PSRCTL_BSIZE1_SHIFT  2            /* Shift _right_ 2 */
 180 #define E1000_PSRCTL_BSIZE2_SHIFT  6            /* Shift _left_ 6 */
 181 #define E1000_PSRCTL_BSIZE3_SHIFT 14            /* Shift _left_ 14 */
 182
 183 /* SWFW_SYNC Definitions */
 184 #define E1000_SWFW_EEP_SM   0x1
 185 #define E1000_SWFW_PHY0_SM  0x2
 186 #define E1000_SWFW_PHY1_SM  0x4
 187
 188 /* Device Control */
 189 #define E1000_CTRL_FD       0x00000001  /* Full duplex.0=half; 1=full */
 190 #define E1000_CTRL_GIO_MASTER_DISABLE 0x00000004 /*Blocks new Master requests */
 191 #define E1000_CTRL_LRST     0x00000008  /* Link reset. 0=normal,1=reset */
 192 #define E1000_CTRL_ASDE     0x00000020  /* Auto-speed detect enable */
 193 #define E1000_CTRL_SLU      0x00000040  /* Set link up (Force Link) */
 194 #define E1000_CTRL_ILOS     0x00000080  /* Invert Loss-Of Signal */
 195 #define E1000_CTRL_SPD_SEL  0x00000300  /* Speed Select Mask */
 196 #define E1000_CTRL_SPD_10   0x00000000  /* Force 10Mb */
 197 #define E1000_CTRL_SPD_100  0x00000100  /* Force 100Mb */
 198 #define E1000_CTRL_SPD_1000 0x00000200  /* Force 1Gb */
 199 #define E1000_CTRL_FRCSPD   0x00000800  /* Force Speed */
 200 #define E1000_CTRL_FRCDPX   0x00001000  /* Force Duplex */
 201 #define E1000_CTRL_SWDPIN0  0x00040000  /* SWDPIN 0 value */
 202 #define E1000_CTRL_SWDPIN1  0x00080000  /* SWDPIN 1 value */
 203 #define E1000_CTRL_SWDPIO0  0x00400000  /* SWDPIN 0 Input or output */
 204 #define E1000_CTRL_RST      0x04000000  /* Global reset */
 205 #define E1000_CTRL_RFCE     0x08000000  /* Receive Flow Control enable */
 206 #define E1000_CTRL_TFCE     0x10000000  /* Transmit flow control enable */
 207 #define E1000_CTRL_VME      0x40000000  /* IEEE VLAN mode enable */
 208 #define E1000_CTRL_PHY_RST  0x80000000  /* PHY Reset */
 209
 210 /*
 211  * Bit definitions for the Management Data IO (MDIO) and Management Data
 212  * Clock (MDC) pins in the Device Control Register.
 213  */
 214
 215 /* Device Status */
 216 #define E1000_STATUS_FD         0x00000001      /* Full duplex.0=half,1=full */
 217 #define E1000_STATUS_LU         0x00000002      /* Link up.0=no,1=link */
 218 #define E1000_STATUS_FUNC_MASK  0x0000000C      /* PCI Function Mask */
 219 #define E1000_STATUS_FUNC_SHIFT 2
 220 #define E1000_STATUS_FUNC_1     0x00000004      /* Function 1 */
 221 #define E1000_STATUS_TXOFF      0x00000010      /* transmission paused */
 222 #define E1000_STATUS_SPEED_10   0x00000000      /* Speed 10Mb/s */
 223 #define E1000_STATUS_SPEED_100  0x00000040      /* Speed 100Mb/s */
 224 #define E1000_STATUS_SPEED_1000 0x00000080      /* Speed 1000Mb/s */
 225 #define E1000_STATUS_LAN_INIT_DONE 0x00000200   /* Lan Init Completion by NVM */
 226 #define E1000_STATUS_GIO_MASTER_ENABLE 0x00080000 /* Status of Master requests. */
 227
 228 /* Constants used to interpret the masked PCI-X bus speed. */
 229
 230 #define HALF_DUPLEX 1
 231 #define FULL_DUPLEX 2
 232
 233
 234 #define ADVERTISE_10_HALF                 0x0001
 235 #define ADVERTISE_10_FULL                 0x0002
 236 #define ADVERTISE_100_HALF                0x0004
 237 #define ADVERTISE_100_FULL                0x0008
 238 #define ADVERTISE_1000_HALF               0x0010 /* Not used, just FYI */
 239 #define ADVERTISE_1000_FULL               0x0020
 240
 241 /* 1000/H is not supported, nor spec-compliant. */
 242 #define E1000_ALL_SPEED_DUPLEX ( ADVERTISE_10_HALF |   ADVERTISE_10_FULL | \
 243                                 ADVERTISE_100_HALF |  ADVERTISE_100_FULL | \
 244                                                      ADVERTISE_1000_FULL)
 245 #define E1000_ALL_NOT_GIG      ( ADVERTISE_10_HALF |   ADVERTISE_10_FULL | \
 246                                 ADVERTISE_100_HALF |  ADVERTISE_100_FULL)
 247 #define E1000_ALL_100_SPEED    (ADVERTISE_100_HALF |  ADVERTISE_100_FULL)
 248 #define E1000_ALL_10_SPEED      (ADVERTISE_10_HALF |   ADVERTISE_10_FULL)
 249 #define E1000_ALL_HALF_DUPLEX   (ADVERTISE_10_HALF |  ADVERTISE_100_HALF)
 250
 251 #define AUTONEG_ADVERTISE_SPEED_DEFAULT   E1000_ALL_SPEED_DUPLEX
 252
 253 /* LED Control */
 254 #define E1000_LEDCTL_LED0_MODE_MASK       0x0000000F
 255 #define E1000_LEDCTL_LED0_MODE_SHIFT      0
 256 #define E1000_LEDCTL_LED0_IVRT            0x00000040
 257 #define E1000_LEDCTL_LED0_BLINK           0x00000080
 258
 259 #define E1000_LEDCTL_MODE_LED_ON        0xE
 260 #define E1000_LEDCTL_MODE_LED_OFF       0xF
 261
 262 /* Transmit Descriptor bit definitions */
 263 #define E1000_TXD_DTYP_D     0x00100000 /* Data Descriptor */
 264 #define E1000_TXD_POPTS_IXSM 0x01       /* Insert IP checksum */
 265 #define E1000_TXD_POPTS_TXSM 0x02       /* Insert TCP/UDP checksum */
 266 #define E1000_TXD_CMD_EOP    0x01000000 /* End of Packet */
 267 #define E1000_TXD_CMD_IFCS   0x02000000 /* Insert FCS (Ethernet CRC) */
 268 #define E1000_TXD_CMD_IC     0x04000000 /* Insert Checksum */
 269 #define E1000_TXD_CMD_RS     0x08000000 /* Report Status */
 270 #define E1000_TXD_CMD_RPS    0x10000000 /* Report Packet Sent */
 271 #define E1000_TXD_CMD_DEXT   0x20000000 /* Descriptor extension (0 = legacy) */
 272 #define E1000_TXD_CMD_VLE    0x40000000 /* Add VLAN tag */
 273 #define E1000_TXD_CMD_IDE    0x80000000 /* Enable Tidv register */
 274 #define E1000_TXD_STAT_DD    0x00000001 /* Descriptor Done */
 275 #define E1000_TXD_STAT_EC    0x00000002 /* Excess Collisions */
 276 #define E1000_TXD_STAT_LC    0x00000004 /* Late Collisions */
 277 #define E1000_TXD_STAT_TU    0x00000008 /* Transmit underrun */
 278 #define E1000_TXD_CMD_TCP    0x01000000 /* TCP packet */
 279 #define E1000_TXD_CMD_IP     0x02000000 /* IP packet */
 280 #define E1000_TXD_CMD_TSE    0x04000000 /* TCP Seg enable */
 281 #define E1000_TXD_STAT_TC    0x00000004 /* Tx Underrun */
 282
 283 /* Transmit Control */
 284 #define E1000_TCTL_EN     0x00000002    /* enable Tx */
 285 #define E1000_TCTL_PSP    0x00000008    /* pad short packets */
 286 #define E1000_TCTL_CT     0x00000ff0    /* collision threshold */
 287 #define E1000_TCTL_COLD   0x003ff000    /* collision distance */
 288 #define E1000_TCTL_RTLC   0x01000000    /* Re-transmit on late collision */
 289 #define E1000_TCTL_MULR   0x10000000    /* Multiple request support */
 290
 291 /* Transmit Arbitration Count */
 292
 293 /* SerDes Control */
 294 #define E1000_SCTL_DISABLE_SERDES_LOOPBACK 0x0400
 295
 296 /* Receive Checksum Control */
 297 #define E1000_RXCSUM_TUOFL     0x00000200   /* TCP / UDP checksum offload */
 298 #define E1000_RXCSUM_IPPCSE    0x00001000   /* IP payload checksum enable */
 299
 300 /* Header split receive */
 301 #define E1000_RFCTL_EXTEN               0x00008000
 302 #define E1000_RFCTL_IPV6_EX_DIS         0x00010000
 303 #define E1000_RFCTL_NEW_IPV6_EXT_DIS    0x00020000
 304
 305 /* Collision related configuration parameters */
 306 #define E1000_COLLISION_THRESHOLD       15
 307 #define E1000_CT_SHIFT                  4
 308 #define E1000_COLLISION_DISTANCE        63
 309 #define E1000_COLD_SHIFT                12
 310
 311 /* Default values for the transmit IPG register */
 312 #define DEFAULT_82543_TIPG_IPGT_COPPER 8
 313
 314 #define E1000_TIPG_IPGT_MASK  0x000003FF
 315
 316 #define DEFAULT_82543_TIPG_IPGR1 8
 317 #define E1000_TIPG_IPGR1_SHIFT  10
 318
 319 #define DEFAULT_82543_TIPG_IPGR2 6
 320 #define DEFAULT_80003ES2LAN_TIPG_IPGR2 7
 321 #define E1000_TIPG_IPGR2_SHIFT  20
 322
 323 #define MAX_JUMBO_FRAME_SIZE    0x3F00
 324
 325 /* Extended Configuration Control and Size */
 326 #define E1000_EXTCNF_CTRL_MDIO_SW_OWNERSHIP      0x00000020
 327 #define E1000_EXTCNF_CTRL_LCD_WRITE_ENABLE       0x00000001
 328 #define E1000_EXTCNF_CTRL_SWFLAG                 0x00000020
 329 #define E1000_EXTCNF_SIZE_EXT_PCIE_LENGTH_MASK   0x00FF0000
 330 #define E1000_EXTCNF_SIZE_EXT_PCIE_LENGTH_SHIFT          16
 331 #define E1000_EXTCNF_CTRL_EXT_CNF_POINTER_MASK   0x0FFF0000
 332 #define E1000_EXTCNF_CTRL_EXT_CNF_POINTER_SHIFT          16
 333
 334 #define E1000_PHY_CTRL_D0A_LPLU           0x00000002
 335 #define E1000_PHY_CTRL_NOND0A_LPLU        0x00000004
 336 #define E1000_PHY_CTRL_NOND0A_GBE_DISABLE 0x00000008
 337 #define E1000_PHY_CTRL_GBE_DISABLE        0x00000040
 338
 339 #define E1000_KABGTXD_BGSQLBIAS           0x00050000
 340
 341 /* PBA constants */
 342 #define E1000_PBA_8K  0x0008    /* 8KB */
 343 #define E1000_PBA_16K 0x0010    /* 16KB */
 344
 345 #define E1000_PBS_16K E1000_PBA_16K
 346
 347 #define IFS_MAX       80
 348 #define IFS_MIN       40
 349 #define IFS_RATIO     4
 350 #define IFS_STEP      10
 351 #define MIN_NUM_XMITS 1000
 352
 353 /* SW Semaphore Register */
 354 #define E1000_SWSM_SMBI         0x00000001 /* Driver Semaphore bit */
 355 #define E1000_SWSM_SWESMBI      0x00000002 /* FW Semaphore bit */
 356 #define E1000_SWSM_DRV_LOAD     0x00000008 /* Driver Loaded Bit */
 357
 358 /* Interrupt Cause Read */
 359 #define E1000_ICR_TXDW          0x00000001 /* Transmit desc written back */
 360 #define E1000_ICR_LSC           0x00000004 /* Link Status Change */
 361 #define E1000_ICR_RXSEQ         0x00000008 /* Rx sequence error */
 362 #define E1000_ICR_RXDMT0        0x00000010 /* Rx desc min. threshold (0) */
 363 #define E1000_ICR_RXT0          0x00000080 /* Rx timer intr (ring 0) */
 364 #define E1000_ICR_INT_ASSERTED  0x80000000 /* If this bit asserted, the driver should claim the interrupt */
 365
 366 /*
 367  * This defines the bits that are set in the Interrupt Mask
 368  * Set/Read Register.  Each bit is documented below:
 369  *   o RXT0   = Receiver Timer Interrupt (ring 0)
 370  *   o TXDW   = Transmit Descriptor Written Back
 371  *   o RXDMT0 = Receive Descriptor Minimum Threshold hit (ring 0)
 372  *   o RXSEQ  = Receive Sequence Error
 373  *   o LSC    = Link Status Change
 374  */
 375 #define IMS_ENABLE_MASK ( \
 376     E1000_IMS_RXT0   |    \
 377     E1000_IMS_TXDW   |    \
 378     E1000_IMS_RXDMT0 |    \
 379     E1000_IMS_RXSEQ  |    \
 380     E1000_IMS_LSC)
 381
 382 /* Interrupt Mask Set */
 383 #define E1000_IMS_TXDW      E1000_ICR_TXDW      /* Transmit desc written back */
 384 #define E1000_IMS_LSC       E1000_ICR_LSC       /* Link Status Change */
 385 #define E1000_IMS_RXSEQ     E1000_ICR_RXSEQ     /* Rx sequence error */
 386 #define E1000_IMS_RXDMT0    E1000_ICR_RXDMT0    /* Rx desc min. threshold */
 387 #define E1000_IMS_RXT0      E1000_ICR_RXT0      /* Rx timer intr */
 388
 389 /* Interrupt Cause Set */
 390 #define E1000_ICS_LSC       E1000_ICR_LSC       /* Link Status Change */
 391 #define E1000_ICS_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
 392 #define E1000_ICS_RXDMT0    E1000_ICR_RXDMT0    /* Rx desc min. threshold */
 393
 394 /* Transmit Descriptor Control */
 395 #define E1000_TXDCTL_PTHRESH 0x0000003F /* TXDCTL Prefetch Threshold */
 396 #define E1000_TXDCTL_WTHRESH 0x003F0000 /* TXDCTL Writeback Threshold */
 397 #define E1000_TXDCTL_FULL_TX_DESC_WB 0x01010000 /* GRAN=1, WTHRESH=1 */
 398 #define E1000_TXDCTL_MAX_TX_DESC_PREFETCH 0x0100001F /* GRAN=1, PTHRESH=31 */
 399 /* Enable the counting of desc. still to be processed. */
 400 #define E1000_TXDCTL_COUNT_DESC 0x00400000
 401
 402 /* Flow Control Constants */
 403 #define FLOW_CONTROL_ADDRESS_LOW  0x00C28001
 404 #define FLOW_CONTROL_ADDRESS_HIGH 0x00000100
 405 #define FLOW_CONTROL_TYPE         0x8808
 406
 407 /* 802.1q VLAN Packet Size */
 408 #define E1000_VLAN_FILTER_TBL_SIZE 128  /* VLAN Filter Table (4096 bits) */
 409
 410 /* Receive Address */
 411 /*
 412  * Number of high/low register pairs in the RAR. The RAR (Receive Address
 413  * Registers) holds the directed and multicast addresses that we monitor.
 414  * Technically, we have 16 spots.  However, we reserve one of these spots
 415  * (RAR[15]) for our directed address used by controllers with
 416  * manageability enabled, allowing us room for 15 multicast addresses.
 417  */
 418 #define E1000_RAR_ENTRIES     15
 419 #define E1000_RAH_AV  0x80000000        /* Receive descriptor valid */
 420
 421 /* Error Codes */
 422 #define E1000_ERR_NVM      1
 423 #define E1000_ERR_PHY      2
 424 #define E1000_ERR_CONFIG   3
 425 #define E1000_ERR_PARAM    4
 426 #define E1000_ERR_MAC_INIT 5
 427 #define E1000_ERR_PHY_TYPE 6
 428 #define E1000_ERR_RESET   9
 429 #define E1000_ERR_MASTER_REQUESTS_PENDING 10
 430 #define E1000_ERR_HOST_INTERFACE_COMMAND 11
 431 #define E1000_BLK_PHY_RESET   12
 432 #define E1000_ERR_SWFW_SYNC 13
 433 #define E1000_NOT_IMPLEMENTED 14
 434
 435 /* Loop limit on how long we wait for auto-negotiation to complete */
 436 #define FIBER_LINK_UP_LIMIT               50
 437 #define COPPER_LINK_UP_LIMIT              10
 438 #define PHY_AUTO_NEG_LIMIT                45
 439 #define PHY_FORCE_LIMIT                   20
 440 /* Number of 100 microseconds we wait for PCI Express master disable */
 441 #define MASTER_DISABLE_TIMEOUT      800
 442 /* Number of milliseconds we wait for PHY configuration done after MAC reset */
 443 #define PHY_CFG_TIMEOUT             100
 444 /* Number of 2 milliseconds we wait for acquiring MDIO ownership. */
 445 #define MDIO_OWNERSHIP_TIMEOUT      10
 446 /* Number of milliseconds for NVM auto read done after MAC reset. */
 447 #define AUTO_READ_DONE_TIMEOUT      10
 448
 449 /* Flow Control */
 450 #define E1000_FCRTL_XONE 0x80000000     /* Enable XON frame transmission */
 451
 452 /* Transmit Configuration Word */
 453 #define E1000_TXCW_FD         0x00000020        /* TXCW full duplex */
 454 #define E1000_TXCW_PAUSE      0x00000080        /* TXCW sym pause request */
 455 #define E1000_TXCW_ASM_DIR    0x00000100        /* TXCW astm pause direction */
 456 #define E1000_TXCW_PAUSE_MASK 0x00000180        /* TXCW pause request mask */
 457 #define E1000_TXCW_ANE        0x80000000        /* Auto-neg enable */
 458
 459 /* Receive Configuration Word */
 460 #define E1000_RXCW_IV         0x08000000        /* Receive config invalid */
 461 #define E1000_RXCW_C          0x20000000        /* Receive config */
 462 #define E1000_RXCW_SYNCH      0x40000000        /* Receive config synch */
 463
 464 /* PCI Express Control */
 465 #define E1000_GCR_RXD_NO_SNOOP          0x00000001
 466 #define E1000_GCR_RXDSCW_NO_SNOOP       0x00000002
 467 #define E1000_GCR_RXDSCR_NO_SNOOP       0x00000004
 468 #define E1000_GCR_TXD_NO_SNOOP          0x00000008
 469 #define E1000_GCR_TXDSCW_NO_SNOOP       0x00000010
 470 #define E1000_GCR_TXDSCR_NO_SNOOP       0x00000020
 471
 472 #define PCIE_NO_SNOOP_ALL (E1000_GCR_RXD_NO_SNOOP         | \
 473                            E1000_GCR_RXDSCW_NO_SNOOP      | \
 474                            E1000_GCR_RXDSCR_NO_SNOOP      | \
 475                            E1000_GCR_TXD_NO_SNOOP         | \
 476                            E1000_GCR_TXDSCW_NO_SNOOP      | \
 477                            E1000_GCR_TXDSCR_NO_SNOOP)
 478
 479 /* PHY Control Register */
 480 #define MII_CR_FULL_DUPLEX      0x0100  /* FDX =1, half duplex =0 */
 481 #define MII_CR_RESTART_AUTO_NEG 0x0200  /* Restart auto negotiation */
 482 #define MII_CR_POWER_DOWN       0x0800  /* Power down */
 483 #define MII_CR_AUTO_NEG_EN      0x1000  /* Auto Neg Enable */
 484 #define MII_CR_LOOPBACK         0x4000  /* 0 = normal, 1 = loopback */
 485 #define MII_CR_RESET            0x8000  /* 0 = normal, 1 = PHY reset */
 486 #define MII_CR_SPEED_1000       0x0040
 487 #define MII_CR_SPEED_100        0x2000
 488 #define MII_CR_SPEED_10         0x0000
 489
 490 /* PHY Status Register */
 491 #define MII_SR_LINK_STATUS       0x0004 /* Link Status 1 = link */
 492 #define MII_SR_AUTONEG_COMPLETE  0x0020 /* Auto Neg Complete */
 493
 494 /* Autoneg Advertisement Register */
 495 #define NWAY_AR_10T_HD_CAPS      0x0020   /* 10T   Half Duplex Capable */
 496 #define NWAY_AR_10T_FD_CAPS      0x0040   /* 10T   Full Duplex Capable */
 497 #define NWAY_AR_100TX_HD_CAPS    0x0080   /* 100TX Half Duplex Capable */
 498 #define NWAY_AR_100TX_FD_CAPS    0x0100   /* 100TX Full Duplex Capable */
 499 #define NWAY_AR_PAUSE            0x0400   /* Pause operation desired */
 500 #define NWAY_AR_ASM_DIR          0x0800   /* Asymmetric Pause Direction bit */
 501
 502 /* Link Partner Ability Register (Base Page) */
 503 #define NWAY_LPAR_PAUSE          0x0400 /* LP Pause operation desired */
 504 #define NWAY_LPAR_ASM_DIR        0x0800 /* LP Asymmetric Pause Direction bit */
 505
 506 /* Autoneg Expansion Register */
 507
 508 /* 1000BASE-T Control Register */
 509 #define CR_1000T_HD_CAPS         0x0100 /* Advertise 1000T HD capability */
 510 #define CR_1000T_FD_CAPS         0x0200 /* Advertise 1000T FD capability  */
 511                                         /* 0=DTE device */
 512 #define CR_1000T_MS_VALUE        0x0800 /* 1=Configure PHY as Master */
 513                                         /* 0=Configure PHY as Slave */
 514 #define CR_1000T_MS_ENABLE       0x1000 /* 1=Master/Slave manual config value */
 515                                         /* 0=Automatic Master/Slave config */
 516
 517 /* 1000BASE-T Status Register */
 518 #define SR_1000T_REMOTE_RX_STATUS 0x1000 /* Remote receiver OK */
 519 #define SR_1000T_LOCAL_RX_STATUS  0x2000 /* Local receiver OK */
 520
 521
 522 /* PHY 1000 MII Register/Bit Definitions */
 523 /* PHY Registers defined by IEEE */
 524 #define PHY_CONTROL      0x00 /* Control Register */
 525 #define PHY_STATUS       0x01 /* Status Register */
 526 #define PHY_ID1          0x02 /* Phy Id Reg (word 1) */
 527 #define PHY_ID2          0x03 /* Phy Id Reg (word 2) */
 528 #define PHY_AUTONEG_ADV  0x04 /* Autoneg Advertisement */
 529 #define PHY_LP_ABILITY   0x05 /* Link Partner Ability (Base Page) */
 530 #define PHY_1000T_CTRL   0x09 /* 1000Base-T Control Reg */
 531 #define PHY_1000T_STATUS 0x0A /* 1000Base-T Status Reg */
 532
 533 /* NVM Control */
 534 #define E1000_EECD_SK        0x00000001 /* NVM Clock */
 535 #define E1000_EECD_CS        0x00000002 /* NVM Chip Select */
 536 #define E1000_EECD_DI        0x00000004 /* NVM Data In */
 537 #define E1000_EECD_DO        0x00000008 /* NVM Data Out */
 538 #define E1000_EECD_REQ       0x00000040 /* NVM Access Request */
 539 #define E1000_EECD_GNT       0x00000080 /* NVM Access Grant */
 540 #define E1000_EECD_SIZE      0x00000200 /* NVM Size (0=64 word 1=256 word) */
 541 /* NVM Addressing bits based on type (0-small, 1-large) */
 542 #define E1000_EECD_ADDR_BITS 0x00000400
 543 #define E1000_NVM_GRANT_ATTEMPTS   1000 /* NVM # attempts to gain grant */
 544 #define E1000_EECD_AUTO_RD          0x00000200  /* NVM Auto Read done */
 545 #define E1000_EECD_SIZE_EX_MASK     0x00007800  /* NVM Size */
 546 #define E1000_EECD_SIZE_EX_SHIFT     11
 547 #define E1000_EECD_FLUPD     0x00080000 /* Update FLASH */
 548 #define E1000_EECD_AUPDEN    0x00100000 /* Enable Autonomous FLASH update */
 549 #define E1000_EECD_SEC1VAL   0x00400000 /* Sector One Valid */
 550
 551 #define E1000_NVM_RW_REG_DATA   16   /* Offset to data in NVM read/write registers */
 552 #define E1000_NVM_RW_REG_DONE   2    /* Offset to READ/WRITE done bit */
 553 #define E1000_NVM_RW_REG_START  1    /* Start operation */
 554 #define E1000_NVM_RW_ADDR_SHIFT 2    /* Shift to the address bits */
 555 #define E1000_NVM_POLL_WRITE    1    /* Flag for polling for write complete */
 556 #define E1000_NVM_POLL_READ     0    /* Flag for polling for read complete */
 557 #define E1000_FLASH_UPDATES  2000
 558
 559 /* NVM Word Offsets */
 560 #define NVM_ID_LED_SETTINGS        0x0004
 561 #define NVM_INIT_CONTROL2_REG      0x000F
 562 #define NVM_INIT_CONTROL3_PORT_B   0x0014
 563 #define NVM_INIT_3GIO_3            0x001A
 564 #define NVM_INIT_CONTROL3_PORT_A   0x0024
 565 #define NVM_CFG                    0x0012
 566 #define NVM_ALT_MAC_ADDR_PTR       0x0037
 567 #define NVM_CHECKSUM_REG           0x003F
 568
 569 #define E1000_NVM_CFG_DONE_PORT_0  0x40000 /* MNG config cycle done */
 570 #define E1000_NVM_CFG_DONE_PORT_1  0x80000 /* ...for second port */
 571
 572 /* Mask bits for fields in Word 0x0f of the NVM */
 573 #define NVM_WORD0F_PAUSE_MASK       0x3000
 574 #define NVM_WORD0F_PAUSE            0x1000
 575 #define NVM_WORD0F_ASM_DIR          0x2000
 576
 577 /* Mask bits for fields in Word 0x1a of the NVM */
 578 #define NVM_WORD1A_ASPM_MASK  0x000C
 579
 580 /* For checksumming, the sum of all words in the NVM should equal 0xBABA. */
 581 #define NVM_SUM                    0xBABA
 582
 583 /* PBA (printed board assembly) number words */
 584 #define NVM_PBA_OFFSET_0           8
 585 #define NVM_PBA_OFFSET_1           9
 586
 587 #define NVM_WORD_SIZE_BASE_SHIFT   6
 588
 589 /* NVM Commands - SPI */
 590 #define NVM_MAX_RETRY_SPI          5000 /* Max wait of 5ms, for RDY signal */
 591 #define NVM_READ_OPCODE_SPI        0x03 /* NVM read opcode */
 592 #define NVM_WRITE_OPCODE_SPI       0x02 /* NVM write opcode */
 593 #define NVM_A8_OPCODE_SPI          0x08 /* opcode bit-3 = address bit-8 */
 594 #define NVM_WREN_OPCODE_SPI        0x06 /* NVM set Write Enable latch */
 595 #define NVM_RDSR_OPCODE_SPI        0x05 /* NVM read Status register */
 596
 597 /* SPI NVM Status Register */
 598 #define NVM_STATUS_RDY_SPI         0x01
 599
 600 /* Word definitions for ID LED Settings */
 601 #define ID_LED_RESERVED_0000 0x0000
 602 #define ID_LED_RESERVED_FFFF 0xFFFF
 603 #define ID_LED_DEFAULT       ((ID_LED_OFF1_ON2  << 12) | \
 604                               (ID_LED_OFF1_OFF2 <<  8) | \
 605                               (ID_LED_DEF1_DEF2 <<  4) | \
 606                               (ID_LED_DEF1_DEF2))
 607 #define ID_LED_DEF1_DEF2     0x1
 608 #define ID_LED_DEF1_ON2      0x2
 609 #define ID_LED_DEF1_OFF2     0x3
 610 #define ID_LED_ON1_DEF2      0x4
 611 #define ID_LED_ON1_ON2       0x5
 612 #define ID_LED_ON1_OFF2      0x6
 613 #define ID_LED_OFF1_DEF2     0x7
 614 #define ID_LED_OFF1_ON2      0x8
 615 #define ID_LED_OFF1_OFF2     0x9
 616
 617 #define IGP_ACTIVITY_LED_MASK   0xFFFFF0FF
 618 #define IGP_ACTIVITY_LED_ENABLE 0x0300
 619 #define IGP_LED3_MODE           0x07000000
 620
 621 /* PCI/PCI-X/PCI-EX Config space */
 622 #define PCI_HEADER_TYPE_REGISTER     0x0E
 623 #define PCIE_LINK_STATUS             0x12
 624
 625 #define PCI_HEADER_TYPE_MULTIFUNC    0x80
 626 #define PCIE_LINK_WIDTH_MASK         0x3F0
 627 #define PCIE_LINK_WIDTH_SHIFT        4
 628
 629 #define PHY_REVISION_MASK      0xFFFFFFF0
 630 #define MAX_PHY_REG_ADDRESS    0x1F  /* 5 bit address bus (0-0x1F) */
 631 #define MAX_PHY_MULTI_PAGE_REG 0xF
 632
 633 /* Bit definitions for valid PHY IDs. */
 634 /*
 635  * I = Integrated
 636  * E = External
 637  */
 638 #define M88E1000_E_PHY_ID    0x01410C50
 639 #define M88E1000_I_PHY_ID    0x01410C30
 640 #define M88E1011_I_PHY_ID    0x01410C20
 641 #define IGP01E1000_I_PHY_ID  0x02A80380
 642 #define M88E1111_I_PHY_ID    0x01410CC0
 643 #define GG82563_E_PHY_ID     0x01410CA0
 644 #define IGP03E1000_E_PHY_ID  0x02A80390
 645 #define IFE_E_PHY_ID         0x02A80330
 646 #define IFE_PLUS_E_PHY_ID    0x02A80320
 647 #define IFE_C_E_PHY_ID       0x02A80310
 648
 649 /* M88E1000 Specific Registers */
 650 #define M88E1000_PHY_SPEC_CTRL     0x10  /* PHY Specific Control Register */
 651 #define M88E1000_PHY_SPEC_STATUS   0x11  /* PHY Specific Status Register */
 652 #define M88E1000_EXT_PHY_SPEC_CTRL 0x14  /* Extended PHY Specific Control */
 653
 654 #define M88E1000_PHY_PAGE_SELECT   0x1D  /* Reg 29 for page number setting */
 655 #define M88E1000_PHY_GEN_CONTROL   0x1E  /* Its meaning depends on reg 29 */
 656
 657 /* M88E1000 PHY Specific Control Register */
 658 #define M88E1000_PSCR_POLARITY_REVERSAL 0x0002 /* 1=Polarity Reversal enabled */
 659 #define M88E1000_PSCR_MDI_MANUAL_MODE  0x0000  /* MDI Crossover Mode bits 6:5 */
 660                                                /* Manual MDI configuration */
 661 #define M88E1000_PSCR_MDIX_MANUAL_MODE 0x0020  /* Manual MDIX configuration */
 662 /* 1000BASE-T: Auto crossover, 100BASE-TX/10BASE-T: MDI Mode */
 663 #define M88E1000_PSCR_AUTO_X_1000T     0x0040
 664 /* Auto crossover enabled all speeds */
 665 #define M88E1000_PSCR_AUTO_X_MODE      0x0060
 666 /*
 667  * 1=Enable Extended 10BASE-T distance (Lower 10BASE-T Rx Threshold)
 668  * 0=Normal 10BASE-T Rx Threshold
 669  */
 670 #define M88E1000_PSCR_ASSERT_CRS_ON_TX 0x0800 /* 1=Assert CRS on Transmit */
 671
 672 /* M88E1000 PHY Specific Status Register */
 673 #define M88E1000_PSSR_REV_POLARITY       0x0002 /* 1=Polarity reversed */
 674 #define M88E1000_PSSR_DOWNSHIFT          0x0020 /* 1=Downshifted */
 675 #define M88E1000_PSSR_MDIX               0x0040 /* 1=MDIX; 0=MDI */
 676 /* 0=<50M; 1=50-80M; 2=80-110M; 3=110-140M; 4=>140M */
 677 #define M88E1000_PSSR_CABLE_LENGTH       0x0380
 678 #define M88E1000_PSSR_SPEED              0xC000 /* Speed, bits 14:15 */
 679 #define M88E1000_PSSR_1000MBS            0x8000 /* 10=1000Mbs */
 680
 681 #define M88E1000_PSSR_CABLE_LENGTH_SHIFT 7
 682
 683 /*
 684  * Number of times we will attempt to autonegotiate before downshifting if we
 685  * are the master
 686  */
 687 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_MASK 0x0C00
 688 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_1X   0x0000
 689 /*
 690  * Number of times we will attempt to autonegotiate before downshifting if we
 691  * are the slave
 692  */
 693 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_MASK  0x0300
 694 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_1X    0x0100
 695 #define M88E1000_EPSCR_TX_CLK_25      0x0070 /* 25  MHz TX_CLK */
 696
 697 /* M88EC018 Rev 2 specific DownShift settings */
 698 #define M88EC018_EPSCR_DOWNSHIFT_COUNTER_MASK  0x0E00
 699 #define M88EC018_EPSCR_DOWNSHIFT_COUNTER_5X    0x0800
 700
 701 /*
 702  * Bits...
 703  * 15-5: page
 704  * 4-0: register offset
 705  */
 706 #define GG82563_PAGE_SHIFT        5
 707 #define GG82563_REG(page, reg)    \
 708         (((page) << GG82563_PAGE_SHIFT) | ((reg) & MAX_PHY_REG_ADDRESS))
 709 #define GG82563_MIN_ALT_REG       30
 710
 711 /* GG82563 Specific Registers */
 712 #define GG82563_PHY_SPEC_CTRL           \
 713         GG82563_REG(0, 16) /* PHY Specific Control */
 714 #define GG82563_PHY_PAGE_SELECT         \
 715         GG82563_REG(0, 22) /* Page Select */
 716 #define GG82563_PHY_SPEC_CTRL_2         \
 717         GG82563_REG(0, 26) /* PHY Specific Control 2 */
 718 #define GG82563_PHY_PAGE_SELECT_ALT     \
 719         GG82563_REG(0, 29) /* Alternate Page Select */
 720
 721 #define GG82563_PHY_MAC_SPEC_CTRL       \
 722         GG82563_REG(2, 21) /* MAC Specific Control Register */
 723
 724 #define GG82563_PHY_DSP_DISTANCE    \
 725         GG82563_REG(5, 26) /* DSP Distance */
 726
 727 /* Page 193 - Port Control Registers */
 728 #define GG82563_PHY_KMRN_MODE_CTRL   \
 729         GG82563_REG(193, 16) /* Kumeran Mode Control */
 730 #define GG82563_PHY_PWR_MGMT_CTRL       \
 731         GG82563_REG(193, 20) /* Power Management Control */
 732
 733 /* Page 194 - KMRN Registers */
 734 #define GG82563_PHY_INBAND_CTRL         \
 735         GG82563_REG(194, 18) /* Inband Control */
 736
 737 /* MDI Control */
 738 #define E1000_MDIC_REG_SHIFT 16
 739 #define E1000_MDIC_PHY_SHIFT 21
 740 #define E1000_MDIC_OP_WRITE  0x04000000
 741 #define E1000_MDIC_OP_READ   0x08000000
 742 #define E1000_MDIC_READY     0x10000000
 743 #define E1000_MDIC_ERROR     0x40000000
 744
 745 /* SerDes Control */
 746 #define E1000_GEN_POLL_TIMEOUT          640
 747
 748 #endif /* _E1000_DEFINES_H_ */