if_epreg.h revision 55834
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 without 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 * $FreeBSD: head/sys/dev/ep/if_epreg.h 55834 2000-01-12 06:42:49Z mdodd $ 23 */ 24 25/* 26 * DELAY_MULTIPLE: How much to boost "base" delays, except 27 * for the inter-bit delays in get_eeprom_data. A cyrix Media GX needed this. 28 */ 29#define DELAY_MULTIPLE 10 30#define BIT_DELAY_MULTIPLE 10 31 32/* 33 * Some global constants 34 */ 35#define TX_INIT_RATE 16 36#define TX_INIT_MAX_RATE 64 37#define RX_INIT_LATENCY 64 38#define RX_INIT_EARLY_THRESH 208 /* not less than MINCLSIZE */ 39#define RX_NEXT_EARLY_THRESH 500 40 41#define EEPROMSIZE 0x40 42#define MAX_EEPROMBUSY 1000 43#define EP_LAST_TAG 0xd7 44#define EP_MAX_BOARDS 16 45/* 46 * This `ID' port is a mere hack. There's currently no chance to register 47 * it with config's idea of the ports that are in use. 48 * 49 * "After the automatic configuration is completed, the IDS is in its initial 50 * state (ID-WAIT), and it monitors all write access to I/O port 01x0h, where 51 * 'x' is any hex digit. If a zero is written to any one of these ports, then 52 * that address is remembered and becomes the ID port. A second zero written 53 * to that port resets the ID sequence to its initial state. The IDS watches 54 * for the ID sequence to be written to the ID port." 55 * 56 * We prefer 0x110 over 0x100 so to not conflict with the Plaque&Pray 57 * ports. 58 */ 59#define EP_ID_PORT 0x110 60#define EP_IOSIZE 16 /* 16 bytes of I/O space used. */ 61 62/* 63 * some macros to acces long named fields 64 */ 65#define BASE (sc->ep_io_addr) 66 67/* 68 * Commands to read/write EEPROM trough EEPROM command register (Window 0, 69 * Offset 0xa) 70 */ 71#define EEPROM_CMD_RD 0x0080 /* Read: Address required (5 bits) */ 72#define EEPROM_CMD_WR 0x0040 /* Write: Address required (5 bits) */ 73#define EEPROM_CMD_ERASE 0x00c0 /* Erase: Address required (5 bits) */ 74#define EEPROM_CMD_EWEN 0x0030 /* Erase/Write Enable: No data required */ 75 76#define EEPROM_BUSY (1<<15) 77#define EEPROM_TST_MODE (1<<14) 78 79/* 80 * Some short functions, worth to let them be a macro 81 */ 82#define is_eeprom_busy(b) (inw((b)+EP_W0_EEPROM_COMMAND)&EEPROM_BUSY) 83#define GO_WINDOW(x) outw(BASE+EP_COMMAND, WINDOW_SELECT|(x)) 84 85/************************************************************************** 86 * * 87 * These define the EEPROM data structure. They are used in the probe 88 * function to verify the existence of the adapter after having sent 89 * the ID_Sequence. 90 * 91 **************************************************************************/ 92 93#define EEPROM_NODE_ADDR_0 0x0 /* Word */ 94#define EEPROM_NODE_ADDR_1 0x1 /* Word */ 95#define EEPROM_NODE_ADDR_2 0x2 /* Word */ 96#define EEPROM_PROD_ID 0x3 /* 0x9[0-f]50 */ 97#define EEPROM_MFG_DATE 0x4 /* Manufacturing date */ 98#define EEPROM_MFG_DIVSION 0x5 /* Manufacturing division */ 99#define EEPROM_MFG_PRODUCT 0x6 /* Product code */ 100#define EEPROM_MFG_ID 0x7 /* 0x6d50 */ 101#define EEPROM_ADDR_CFG 0x8 /* Base addr */ 102#define EEPROM_RESOURCE_CFG 0x9 /* IRQ. Bits 12-15 */ 103#define EEPROM_OEM_ADDR0 0xa 104#define EEPROM_OEM_ADDR1 0xb 105#define EEPROM_OEM_ADDR2 0xc 106#define EEPROM_SOFTINFO 0xd 107#define EEPROM_COMPAT 0xe 108#define EEPROM_SOFTINFO2 0xf 109#define EEPROM_CAP 0x10 110# define CAP_ISA 0x2083 111# define CAP_PCMCIA 0x2082 112#define EEPROM_INT_CONFIG_0 0x12 113#define EEPROM_INT_CONFIG_1 0x13 114/* RAM Partition TX FIFO/RX FIFO */ 115# define ICW1_RAM_PART_MASK 0x03 116# define ICW1_RAM_PART_35 0x00 /* 2:5 (only legal if RAM size == 000b default power-up/reset */ 117# define ICW1_RAM_PART_13 0x01 /* 1:3 (only legal if RAM size == 000b) */ 118# define ICW1_RAM_PART_11 0x10 /* 1:1 */ 119# define ICW1_RAM_PART_RESV 0x11 /* Reserved */ 120/* ISA Adapter Selection */ 121# define ICW1_IAS_MASK 0x0c 122# define ICW1_IAS_DIS 0x00 /* Both mechanisms disabled (default) */ 123# define ICW1_IAS_ISA 0x04 /* ISA contention only */ 124# define ICW1_IAS_PNP 0x08 /* ISA Plug and Play only */ 125# define ICW1_IAS_BOTH 0x0c /* Both mechanisms enabled */ 126 127#define EEPROM_CHECKSUM_EL3 0x17 128 129/************************************************************************** 130 * * 131 * These are the registers for the 3Com 3c509 and their bit patterns when * 132 * applicable. They have been taken out the the "EtherLink III Parallel * 133 * Tasking EISA and ISA Technical Reference" "Beta Draft 10/30/92" manual * 134 * from 3com. * 135 * * 136 **************************************************************************/ 137 138#define EP_COMMAND 0x0e /* Write. BASE+0x0e is always a 139 * command reg. */ 140#define EP_STATUS 0x0e /* Read. BASE+0x0e is always status 141 * reg. */ 142#define EP_WINDOW 0x0f /* Read. BASE+0x0f is always window 143 * reg. */ 144/* 145 * Window 0 registers. Setup. 146 */ 147/* Write */ 148#define EP_W0_EEPROM_DATA 0x0c 149#define EP_W0_EEPROM_COMMAND 0x0a 150#define EP_W0_RESOURCE_CFG 0x08 151#define EP_W0_ADDRESS_CFG 0x06 152#define EP_W0_CONFIG_CTRL 0x04 153/* Read */ 154#define EP_W0_PRODUCT_ID 0x02 155#define EP_W0_MFG_ID 0x00 156 157/* 158 * Window 1 registers. Operating Set. 159 */ 160/* Write */ 161#define EP_W1_TX_PIO_WR_2 0x02 162#define EP_W1_TX_PIO_WR_1 0x00 163/* Read */ 164#define EP_W1_FREE_TX 0x0c 165#define EP_W1_TX_STATUS 0x0b /* byte */ 166#define EP_W1_TIMER 0x0a /* byte */ 167#define EP_W1_RX_STATUS 0x08 168#define EP_W1_RX_PIO_RD_2 0x02 169#define EP_W1_RX_PIO_RD_1 0x00 170 171/* 172 * Window 2 registers. Station Address Setup/Read 173 */ 174/* Read/Write */ 175#define EP_W2_ADDR_5 0x05 176#define EP_W2_ADDR_4 0x04 177#define EP_W2_ADDR_3 0x03 178#define EP_W2_ADDR_2 0x02 179#define EP_W2_ADDR_1 0x01 180#define EP_W2_ADDR_0 0x00 181 182/* 183 * Window 3 registers. FIFO Management. 184 */ 185/* Read */ 186#define EP_W3_FREE_TX 0x0c 187#define EP_W3_FREE_RX 0x0a 188#define EP_W3_OPTIONS 0x08 189 190/* 191 * Window 4 registers. Diagnostics. 192 */ 193/* Read/Write */ 194#define EP_W4_MEDIA_TYPE 0x0a 195#define EP_W4_CTRLR_STATUS 0x08 196#define EP_W4_NET_DIAG 0x06 197#define EP_W4_FIFO_DIAG 0x04 198#define EP_W4_HOST_DIAG 0x02 199#define EP_W4_TX_DIAG 0x00 200 201/* 202 * Window 5 Registers. Results and Internal status. 203 */ 204/* Read */ 205#define EP_W5_READ_0_MASK 0x0c 206#define EP_W5_INTR_MASK 0x0a 207#define EP_W5_RX_FILTER 0x08 208#define EP_W5_RX_EARLY_THRESH 0x06 209#define EP_W5_TX_AVAIL_THRESH 0x02 210#define EP_W5_TX_START_THRESH 0x00 211 212/* 213 * Window 6 registers. Statistics. 214 */ 215/* Read/Write */ 216#define TX_TOTAL_OK 0x0c 217#define RX_TOTAL_OK 0x0a 218#define TX_DEFERRALS 0x08 219#define RX_FRAMES_OK 0x07 220#define TX_FRAMES_OK 0x06 221#define RX_OVERRUNS 0x05 222#define TX_COLLISIONS 0x04 223#define TX_AFTER_1_COLLISION 0x03 224#define TX_AFTER_X_COLLISIONS 0x02 225#define TX_NO_SQE 0x01 226#define TX_CD_LOST 0x00 227 228/**************************************** 229 * 230 * Register definitions. 231 * 232 ****************************************/ 233 234/* 235 * Command parameter that disables threshold interrupts 236 * PIO (3c509) cards use 2044. The fifo word-oriented and 2044--2047 work. 237 * "busmastering" cards need 8188. 238 * The implicit two-bit upshift done by busmastering cards means 239 * a value of 2047 disables threshold interrupts on both. 240 */ 241#define EP_THRESH_DISABLE 2047 242 243/* 244 * Command register. All windows. 245 * 246 * 16 bit register. 247 * 15-11: 5-bit code for command to be executed. 248 * 10-0: 11-bit arg if any. For commands with no args; 249 * this can be set to anything. 250 */ 251#define GLOBAL_RESET (u_short) 0x0000 /* Wait at least 1ms 252 * after issuing */ 253#define WINDOW_SELECT (u_short) (0x1<<11) 254#define START_TRANSCEIVER (u_short) (0x2<<11) /* Read ADDR_CFG reg to 255 * determine whether 256 * this is needed. If 257 * so; wait 800 uSec 258 * before using trans- 259 * ceiver. */ 260#define RX_DISABLE (u_short) (0x3<<11) /* state disabled on 261 * power-up */ 262#define RX_ENABLE (u_short) (0x4<<11) 263#define RX_RESET (u_short) (0x5<<11) 264#define RX_DISCARD_TOP_PACK (u_short) (0x8<<11) 265#define TX_ENABLE (u_short) (0x9<<11) 266#define TX_DISABLE (u_short) (0xa<<11) 267#define TX_RESET (u_short) (0xb<<11) 268#define REQ_INTR (u_short) (0xc<<11) 269#define SET_INTR_MASK (u_short) (0xe<<11) 270#define SET_RD_0_MASK (u_short) (0xf<<11) 271#define SET_RX_FILTER (u_short) (0x10<<11) 272#define FIL_INDIVIDUAL (u_short) (0x1) 273#define FIL_GROUP (u_short) (0x2) 274#define FIL_BRDCST (u_short) (0x4) 275#define FIL_ALL (u_short) (0x8) 276#define SET_RX_EARLY_THRESH (u_short) (0x11<<11) 277#define SET_TX_AVAIL_THRESH (u_short) (0x12<<11) 278#define SET_TX_START_THRESH (u_short) (0x13<<11) 279#define STATS_ENABLE (u_short) (0x15<<11) 280#define STATS_DISABLE (u_short) (0x16<<11) 281#define STOP_TRANSCEIVER (u_short) (0x17<<11) 282/* 283 * The following C_* acknowledge the various interrupts. Some of them don't 284 * do anything. See the manual. 285 */ 286#define ACK_INTR (u_short) (0x6800) 287#define C_INTR_LATCH (u_short) (ACK_INTR|0x1) 288#define C_CARD_FAILURE (u_short) (ACK_INTR|0x2) 289#define C_TX_COMPLETE (u_short) (ACK_INTR|0x4) 290#define C_TX_AVAIL (u_short) (ACK_INTR|0x8) 291#define C_RX_COMPLETE (u_short) (ACK_INTR|0x10) 292#define C_RX_EARLY (u_short) (ACK_INTR|0x20) 293#define C_INT_RQD (u_short) (ACK_INTR|0x40) 294#define C_UPD_STATS (u_short) (ACK_INTR|0x80) 295#define C_MASK (u_short) 0xFF /* mask of C_* */ 296 297/* 298 * Status register. All windows. 299 * 300 * 15-13: Window number(0-7). 301 * 12: Command_in_progress. 302 * 11: reserved. 303 * 10: reserved. 304 * 9: reserved. 305 * 8: reserved. 306 * 7: Update Statistics. 307 * 6: Interrupt Requested. 308 * 5: RX Early. 309 * 4: RX Complete. 310 * 3: TX Available. 311 * 2: TX Complete. 312 * 1: Adapter Failure. 313 * 0: Interrupt Latch. 314 */ 315#define S_INTR_LATCH (u_short) (0x1) 316#define S_CARD_FAILURE (u_short) (0x2) 317#define S_TX_COMPLETE (u_short) (0x4) 318#define S_TX_AVAIL (u_short) (0x8) 319#define S_RX_COMPLETE (u_short) (0x10) 320#define S_RX_EARLY (u_short) (0x20) 321#define S_INT_RQD (u_short) (0x40) 322#define S_UPD_STATS (u_short) (0x80) 323#define S_MASK (u_short) 0xFF /* mask of S_* */ 324#define S_5_INTS (S_CARD_FAILURE|S_TX_COMPLETE|\ 325 S_TX_AVAIL|S_RX_COMPLETE|S_RX_EARLY) 326#define S_COMMAND_IN_PROGRESS (u_short) (0x1000) 327 328/* Address Config. Register. 329 * Window 0/Port 06 330 */ 331 332#define ACF_CONNECTOR_BITS 14 333#define ACF_CONNECTOR_UTP 0 334#define ACF_CONNECTOR_AUI 1 335#define ACF_CONNECTOR_BNC 3 336 337/* Resource configuration register. 338 * Window 0/Port 08 339 * 340 */ 341 342#define SET_IRQ(base,irq) outw((base) + EP_W0_RESOURCE_CFG, \ 343 ((inw((base) + EP_W0_RESOURCE_CFG) & 0x0fff) | \ 344 ((u_short)(irq)<<12)) ) /* set IRQ i */ 345 346/* 347 * FIFO Registers. 348 * RX Status. Window 1/Port 08 349 * 350 * 15: Incomplete or FIFO empty. 351 * 14: 1: Error in RX Packet 0: Incomplete or no error. 352 * 13-11: Type of error. 353 * 1000 = Overrun. 354 * 1011 = Run Packet Error. 355 * 1100 = Alignment Error. 356 * 1101 = CRC Error. 357 * 1001 = Oversize Packet Error (>1514 bytes) 358 * 0010 = Dribble Bits. 359 * (all other error codes, no errors.) 360 * 361 * 10-0: RX Bytes (0-1514) 362 */ 363#define ERR_RX_INCOMPLETE (u_short) (0x1<<15) 364#define ERR_RX (u_short) (0x1<<14) 365#define ERR_RX_OVERRUN (u_short) (0x8<<11) 366#define ERR_RX_RUN_PKT (u_short) (0xb<<11) 367#define ERR_RX_ALIGN (u_short) (0xc<<11) 368#define ERR_RX_CRC (u_short) (0xd<<11) 369#define ERR_RX_OVERSIZE (u_short) (0x9<<11) 370#define ERR_RX_DRIBBLE (u_short) (0x2<<11) 371 372/* 373 * FIFO Registers. 374 * TX Status. Window 1/Port 0B 375 * 376 * Reports the transmit status of a completed transmission. Writing this 377 * register pops the transmit completion stack. 378 * 379 * Window 1/Port 0x0b. 380 * 381 * 7: Complete 382 * 6: Interrupt on successful transmission requested. 383 * 5: Jabber Error (TP Only, TX Reset required. ) 384 * 4: Underrun (TX Reset required. ) 385 * 3: Maximum Collisions. 386 * 2: TX Status Overflow. 387 * 1-0: Undefined. 388 * 389 */ 390#define TXS_COMPLETE 0x80 391#define TXS_SUCCES_INTR_REQ 0x40 392#define TXS_JABBER 0x20 393#define TXS_UNDERRUN 0x10 394#define TXS_MAX_COLLISION 0x8 395#define TXS_STATUS_OVERFLOW 0x4 396 397/* 398 * Configuration control register. 399 * Window 0/Port 04 400 */ 401/* Read */ 402#define IS_AUI (1<<13) 403#define IS_BNC (1<<12) 404#define IS_UTP (1<<9) 405/* Write */ 406#define ENABLE_DRQ_IRQ 0x0001 407#define W0_P4_CMD_RESET_ADAPTER 0x4 408#define W0_P4_CMD_ENABLE_ADAPTER 0x1 409/* 410 * Media type and status. 411 * Window 4/Port 0A 412 */ 413#define ENABLE_UTP 0xc0 414#define DISABLE_UTP 0x0 415 416/* 417 * Misc defines for various things. 418 */ 419#define ACTIVATE_ADAPTER_TO_CONFIG 0xff /* to the id_port */ 420#define MFG_ID 0x6d50 /* in EEPROM and W0 ADDR_CONFIG */ 421#define PROD_ID 0x9150 422 423#define AUI 0x1 424#define BNC 0x2 425#define UTP 0x4 426 427#define RX_BYTES_MASK (u_short) (0x07ff) 428 429/* 430 * Config flags 431 */ 432#define EP_FLAGS_100TX 0x1 433