gpxe/src/drivers/net/3c509.h

   1 /*
   2  * Copyright (c) 1993 Herb Peyerl (hpeyerl@novatel.ca) All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met: 1. Redistributions of source code must retain the above copyright
   7  * notice, this list of conditions and the following disclaimer. 2. The name
   8  * of the author may not be used to endorse or promote products derived from
   9  * this software withough specific prior written permission
  10  *
  11  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  12  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  14  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  15  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  16  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  17  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  18  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  19  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  20  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  21  *
  22  * if_epreg.h,v 1.4 1994/11/13 10:12:37 gibbs Exp Modified by:
  23  *
  24  October 2, 1994
  25
  26  Modified by: Andres Vega Garcia
  27
  28  INRIA - Sophia Antipolis, France
  29  e-mail: avega@sophia.inria.fr
  30  finger: avega@pax.inria.fr
  31
  32  */
  33
  34 #include "nic.h"
  35
  36 /*
  37  * Ethernet software status per interface.
  38  */
  39 /*
  40  * Some global constants
  41  */
  42
  43 #define TX_INIT_RATE            16
  44 #define TX_INIT_MAX_RATE        64
  45 #define RX_INIT_LATENCY         64
  46 #define RX_INIT_EARLY_THRESH    64
  47 #define MIN_RX_EARLY_THRESHF    16      /* not less than ether_header */
  48 #define MIN_RX_EARLY_THRESHL    4
  49
  50 #define EEPROMSIZE      0x40
  51 #define MAX_EEPROMBUSY  1000
  52 #define EP_ID_PORT_START 0x110  /* avoid 0x100 to avoid conflict with SB16 */
  53 #define EP_ID_PORT_INC 0x10
  54 #define EP_ID_PORT_END 0x200
  55 #define EP_TAG_MAX              0x7 /* must be 2^n - 1 */
  56
  57 /*
  58  * Commands to read/write EEPROM trough EEPROM command register (Window 0,
  59  * Offset 0xa)
  60  */
  61 #define EEPROM_CMD_RD   0x0080  /* Read:  Address required (5 bits) */
  62 #define EEPROM_CMD_WR   0x0040  /* Write: Address required (5 bits) */
  63 #define EEPROM_CMD_ERASE 0x00c0 /* Erase: Address required (5 bits) */
  64 #define EEPROM_CMD_EWEN 0x0030  /* Erase/Write Enable: No data required */
  65
  66 #define EEPROM_BUSY             (1<<15)
  67 #define EEPROM_TST_MODE         (1<<14)
  68
  69 /*
  70  * Some short functions, worth to let them be a macro
  71  */
  72 #define is_eeprom_busy(b) (inw((b)+EP_W0_EEPROM_COMMAND)&EEPROM_BUSY)
  73 #define GO_WINDOW(b,x)  outw(WINDOW_SELECT|(x), (b)+EP_COMMAND)
  74
  75 /**************************************************************************
  76  *
  77  * These define the EEPROM data structure.  They are used in the probe
  78  * function to verify the existance of the adapter after having sent
  79  * the ID_Sequence.
  80  *
  81  * There are others but only the ones we use are defined here.
  82  *
  83  **************************************************************************/
  84
  85 #define EEPROM_NODE_ADDR_0      0x0     /* Word */
  86 #define EEPROM_NODE_ADDR_1      0x1     /* Word */
  87 #define EEPROM_NODE_ADDR_2      0x2     /* Word */
  88 #define EEPROM_PROD_ID          0x3     /* 0x9[0-f]50 */
  89 #define EEPROM_MFG_ID           0x7     /* 0x6d50 */
  90 #define EEPROM_ADDR_CFG         0x8     /* Base addr */
  91 #define EEPROM_RESOURCE_CFG     0x9     /* IRQ. Bits 12-15 */
  92
  93 /**************************************************************************
  94  *
  95  * These are the registers for the 3Com 3c509 and their bit patterns when
  96  * applicable.  They have been taken out the the "EtherLink III Parallel
  97  * Tasking EISA and ISA Technical Reference" "Beta Draft 10/30/92" manual
  98  * from 3com.
  99  *
 100  * Getting this document out of 3Com is almost impossible.  However,
 101  * archived copies are available at
 102  * http://www.osdever.net/cottontail/downloads/docs/3c5x9b.zip and
 103  * several other places on the web (search for 3c5x9b.pdf).
 104  *
 105  **************************************************************************/
 106
 107 #define EP_COMMAND              0x0e    /* Write. BASE+0x0e is always a
 108                                          * command reg. */
 109 #define EP_STATUS               0x0e    /* Read. BASE+0x0e is always status
 110                                          * reg. */
 111 #define EP_WINDOW               0x0f    /* Read. BASE+0x0f is always window
 112                                          * reg. */
 113 /*
 114  * Window 0 registers. Setup.
 115  */
 116 /* Write */
 117 #define EP_W0_EEPROM_DATA       0x0c
 118 #define EP_W0_EEPROM_COMMAND    0x0a
 119 #define EP_W0_RESOURCE_CFG      0x08
 120 #define EP_W0_ADDRESS_CFG       0x06
 121 #define EP_W0_CONFIG_CTRL       0x04
 122 /* Read */
 123 #define EP_W0_PRODUCT_ID        0x02
 124 #define EP_W0_MFG_ID            0x00
 125
 126 /*
 127  * Window 1 registers. Operating Set.
 128  */
 129 /* Write */
 130 #define EP_W1_TX_PIO_WR_2       0x02
 131 #define EP_W1_TX_PIO_WR_1       0x00
 132 /* Read */
 133 #define EP_W1_FREE_TX           0x0c
 134 #define EP_W1_TX_STATUS         0x0b    /* byte */
 135 #define EP_W1_TIMER             0x0a    /* byte */
 136 #define EP_W1_RX_STATUS         0x08
 137 #define EP_W1_RX_PIO_RD_2       0x02
 138 #define EP_W1_RX_PIO_RD_1       0x00
 139
 140 /*
 141  * Window 2 registers. Station Address Setup/Read
 142  */
 143 /* Read/Write */
 144 #define EP_W2_ADDR_5            0x05
 145 #define EP_W2_ADDR_4            0x04
 146 #define EP_W2_ADDR_3            0x03
 147 #define EP_W2_ADDR_2            0x02
 148 #define EP_W2_ADDR_1            0x01
 149 #define EP_W2_ADDR_0            0x00
 150
 151 /*
 152  * Window 3 registers.  FIFO Management.
 153  */
 154 /* Read */
 155 #define EP_W3_FREE_TX           0x0c
 156 #define EP_W3_FREE_RX           0x0a
 157
 158 /*
 159  * Window 4 registers. Diagnostics.
 160  */
 161 /* Read/Write */
 162 #define EP_W4_MEDIA_TYPE        0x0a
 163 #define EP_W4_CTRLR_STATUS      0x08
 164 #define EP_W4_NET_DIAG          0x06
 165 #define EP_W4_FIFO_DIAG         0x04
 166 #define EP_W4_HOST_DIAG         0x02
 167 #define EP_W4_TX_DIAG           0x00
 168
 169 /*
 170  * Window 5 Registers.  Results and Internal status.
 171  */
 172 /* Read */
 173 #define EP_W5_READ_0_MASK       0x0c
 174 #define EP_W5_INTR_MASK         0x0a
 175 #define EP_W5_RX_FILTER         0x08
 176 #define EP_W5_RX_EARLY_THRESH   0x06
 177 #define EP_W5_TX_AVAIL_THRESH   0x02
 178 #define EP_W5_TX_START_THRESH   0x00
 179
 180 /*
 181  * Window 6 registers. Statistics.
 182  */
 183 /* Read/Write */
 184 #define TX_TOTAL_OK             0x0c
 185 #define RX_TOTAL_OK             0x0a
 186 #define TX_DEFERRALS            0x08
 187 #define RX_FRAMES_OK            0x07
 188 #define TX_FRAMES_OK            0x06
 189 #define RX_OVERRUNS             0x05
 190 #define TX_COLLISIONS           0x04
 191 #define TX_AFTER_1_COLLISION    0x03
 192 #define TX_AFTER_X_COLLISIONS   0x02
 193 #define TX_NO_SQE               0x01
 194 #define TX_CD_LOST              0x00
 195
 196 /****************************************
 197  *
 198  * Register definitions.
 199  *
 200  ****************************************/
 201
 202 /*
 203  * Command register. All windows.
 204  *
 205  * 16 bit register.
 206  *     15-11:  5-bit code for command to be executed.
 207  *     10-0:   11-bit arg if any. For commands with no args;
 208  *            this can be set to anything.
 209  */
 210 #define GLOBAL_RESET            (unsigned short) 0x0000 /* Wait at least 1ms
 211                                                          * after issuing */
 212 #define WINDOW_SELECT           (unsigned short) (0x1<<11)
 213 #define START_TRANSCEIVER       (unsigned short) (0x2<<11)      /* Read ADDR_CFG reg to
 214                                                          * determine whether
 215                                                          * this is needed. If
 216                                                          * so; wait 800 uSec
 217                                                          * before using trans-
 218                                                          * ceiver. */
 219 #define RX_DISABLE              (unsigned short) (0x3<<11)      /* state disabled on
 220                                                          * power-up */
 221 #define RX_ENABLE               (unsigned short) (0x4<<11)
 222 #define RX_RESET                (unsigned short) (0x5<<11)
 223 #define RX_DISCARD_TOP_PACK     (unsigned short) (0x8<<11)
 224 #define TX_ENABLE               (unsigned short) (0x9<<11)
 225 #define TX_DISABLE              (unsigned short) (0xa<<11)
 226 #define TX_RESET                (unsigned short) (0xb<<11)
 227 #define REQ_INTR                (unsigned short) (0xc<<11)
 228 #define SET_INTR_MASK           (unsigned short) (0xe<<11)
 229 #define SET_RD_0_MASK           (unsigned short) (0xf<<11)
 230 #define SET_RX_FILTER           (unsigned short) (0x10<<11)
 231 #define FIL_INDIVIDUAL  (unsigned short) (0x1)
 232 #define FIL_GROUP               (unsigned short) (0x2)
 233 #define FIL_BRDCST      (unsigned short) (0x4)
 234 #define FIL_ALL         (unsigned short) (0x8)
 235 #define SET_RX_EARLY_THRESH     (unsigned short) (0x11<<11)
 236 #define SET_TX_AVAIL_THRESH     (unsigned short) (0x12<<11)
 237 #define SET_TX_START_THRESH     (unsigned short) (0x13<<11)
 238 #define STATS_ENABLE            (unsigned short) (0x15<<11)
 239 #define STATS_DISABLE           (unsigned short) (0x16<<11)
 240 #define STOP_TRANSCEIVER        (unsigned short) (0x17<<11)
 241 /*
 242  * The following C_* acknowledge the various interrupts. Some of them don't
 243  * do anything.  See the manual.
 244  */
 245 #define ACK_INTR                (unsigned short) (0x6800)
 246 #define C_INTR_LATCH    (unsigned short) (ACK_INTR|0x1)
 247 #define C_CARD_FAILURE  (unsigned short) (ACK_INTR|0x2)
 248 #define C_TX_COMPLETE   (unsigned short) (ACK_INTR|0x4)
 249 #define C_TX_AVAIL      (unsigned short) (ACK_INTR|0x8)
 250 #define C_RX_COMPLETE   (unsigned short) (ACK_INTR|0x10)
 251 #define C_RX_EARLY      (unsigned short) (ACK_INTR|0x20)
 252 #define C_INT_RQD               (unsigned short) (ACK_INTR|0x40)
 253 #define C_UPD_STATS     (unsigned short) (ACK_INTR|0x80)
 254
 255 /*
 256  * Status register. All windows.
 257  *
 258  *     15-13:  Window number(0-7).
 259  *     12:     Command_in_progress.
 260  *     11:     reserved.
 261  *     10:     reserved.
 262  *     9:      reserved.
 263  *     8:      reserved.
 264  *     7:      Update Statistics.
 265  *     6:      Interrupt Requested.
 266  *     5:      RX Early.
 267  *     4:      RX Complete.
 268  *     3:      TX Available.
 269  *     2:      TX Complete.
 270  *     1:      Adapter Failure.
 271  *     0:      Interrupt Latch.
 272  */
 273 #define S_INTR_LATCH            (unsigned short) (0x1)
 274 #define S_CARD_FAILURE          (unsigned short) (0x2)
 275 #define S_TX_COMPLETE           (unsigned short) (0x4)
 276 #define S_TX_AVAIL              (unsigned short) (0x8)
 277 #define S_RX_COMPLETE           (unsigned short) (0x10)
 278 #define S_RX_EARLY              (unsigned short) (0x20)
 279 #define S_INT_RQD               (unsigned short) (0x40)
 280 #define S_UPD_STATS             (unsigned short) (0x80)
 281 #define S_5_INTS                (S_CARD_FAILURE|S_TX_COMPLETE|\
 282                                  S_TX_AVAIL|S_RX_COMPLETE|S_RX_EARLY)
 283 #define S_COMMAND_IN_PROGRESS   (unsigned short) (0x1000)
 284
 285 /*
 286  * FIFO Registers.
 287  * RX Status. Window 1/Port 08
 288  *
 289  *     15:     Incomplete or FIFO empty.
 290  *     14:     1: Error in RX Packet   0: Incomplete or no error.
 291  *     13-11:  Type of error.
 292  *            1000 = Overrun.
 293  *            1011 = Run Packet Error.
 294  *            1100 = Alignment Error.
 295  *            1101 = CRC Error.
 296  *            1001 = Oversize Packet Error (>1514 bytes)
 297  *            0010 = Dribble Bits.
 298  *            (all other error codes, no errors.)
 299  *
 300  *     10-0:   RX Bytes (0-1514)
 301  */
 302 #define ERR_RX_INCOMPLETE       (unsigned short) (0x1<<15)
 303 #define ERR_RX                  (unsigned short) (0x1<<14)
 304 #define ERR_RX_OVERRUN          (unsigned short) (0x8<<11)
 305 #define ERR_RX_RUN_PKT          (unsigned short) (0xb<<11)
 306 #define ERR_RX_ALIGN            (unsigned short) (0xc<<11)
 307 #define ERR_RX_CRC              (unsigned short) (0xd<<11)
 308 #define ERR_RX_OVERSIZE         (unsigned short) (0x9<<11)
 309 #define ERR_RX_DRIBBLE          (unsigned short) (0x2<<11)
 310
 311 /*
 312  * FIFO Registers.
 313  * TX Status. Window 1/Port 0B
 314  *
 315  *   Reports the transmit status of a completed transmission. Writing this
 316  *   register pops the transmit completion stack.
 317  *
 318  *   Window 1/Port 0x0b.
 319  *
 320  *     7:      Complete
 321  *     6:      Interrupt on successful transmission requested.
 322  *     5:      Jabber Error (TP Only, TX Reset required. )
 323  *     4:      Underrun (TX Reset required. )
 324  *     3:      Maximum Collisions.
 325  *     2:      TX Status Overflow.
 326  *     1-0:    Undefined.
 327  *
 328  */
 329 #define TXS_COMPLETE            0x80
 330 #define TXS_SUCCES_INTR_REQ             0x40
 331 #define TXS_JABBER              0x20
 332 #define TXS_UNDERRUN            0x10
 333 #define TXS_MAX_COLLISION       0x8
 334 #define TXS_STATUS_OVERFLOW     0x4
 335
 336 /*
 337  * Configuration control register.
 338  * Window 0/Port 04
 339  */
 340 /* Read */
 341 #define IS_AUI                          (1<<13)
 342 #define IS_BNC                          (1<<12)
 343 #define IS_UTP                          (1<<9)
 344 /* Write */
 345 #define ENABLE_DRQ_IRQ                  0x0001
 346 #define W0_P4_CMD_RESET_ADAPTER         0x4
 347 #define W0_P4_CMD_ENABLE_ADAPTER        0x1
 348 /*
 349  * Media type and status.
 350  * Window 4/Port 0A
 351  */
 352 #define ENABLE_UTP                      0xc0
 353 #define DISABLE_UTP                     0x0
 354
 355 /*
 356  * Resource control register
 357  */
 358
 359 #define SET_IRQ(i)      ( ((i)<<12) | 0xF00) /* set IRQ i */
 360
 361 /*
 362  * Receive status register
 363  */
 364
 365 #define RX_BYTES_MASK                   (unsigned short) (0x07ff)
 366 #define RX_ERROR        0x4000
 367 #define RX_INCOMPLETE   0x8000
 368
 369 /*
 370  * Misc defines for various things.
 371  */
 372 #define MFG_ID                          0x6d50 /* in EEPROM and W0 ADDR_CONFIG */
 373 #define PROD_ID                         0x9150
 374
 375 #define AUI                             0x1
 376 #define BNC                             0x2
 377 #define UTP                             0x4
 378
 379 #define RX_BYTES_MASK                   (unsigned short) (0x07ff)
 380
 381 /*
 382  * Function shared between 3c509.c and 3c529.c
 383  */
 384 extern int t5x9_probe ( struct nic *nic,
 385                         uint16_t prod_id_check, uint16_t prod_id_mask );
 386 extern void t5x9_disable ( struct nic *nic );
 387
 388 /*
 389  * Local variables:
 390  *  c-basic-offset: 8
 391  * End:
 392  */