drivers/staging/wavelan/i82586.h

   1 /*
   2  * Intel 82586 IEEE 802.3 Ethernet LAN Coprocessor.
   3  *
   4  * See:
   5  *      Intel Microcommunications 1991
   6  *      p1-1 to p1-37
   7  *      Intel order No. 231658
   8  *      ISBN 1-55512-119-5
   9  *
  10  *     Unfortunately, the above chapter mentions neither
  11  * the System Configuration Pointer (SCP) nor the
  12  * Intermediate System Configuration Pointer (ISCP),
  13  * so we probably need to look elsewhere for the
  14  * whole story -- some recommend the "Intel LAN
  15  * Components manual" but I have neither a copy
  16  * nor a full reference.  But "elsewhere" may be
  17  * in the same publication...
  18  *     The description of a later device, the
  19  * "82596CA High-Performance 32-Bit Local Area Network
  20  * Coprocessor", (ibid. p1-38 to p1-109) does mention
  21  * the SCP and ISCP and also has an i82586 compatibility
  22  * mode.  Even more useful is "AP-235 An 82586 Data Link
  23  * Driver" (ibid. p1-337 to p1-417).
  24  */
  25
  26 #define I82586_MEMZ     (64 * 1024)
  27
  28 #define I82586_SCP_ADDR (I82586_MEMZ - sizeof(scp_t))
  29
  30 #define ADDR_LEN        6
  31 #define I82586NULL      0xFFFF
  32
  33 #define toff(t, p, f)   (unsigned short)((void *)(&((t *)((void *)0 + (p)))->f) - (void *)0)
  34
  35 /*
  36  * System Configuration Pointer (SCP).
  37  */
  38 typedef struct scp_t    scp_t;
  39 struct scp_t {
  40         unsigned short  scp_sysbus;     /* 82586 bus width:     */
  41 #define         SCP_SY_16BBUS   (0x0 << 0)      /* 16 bits */
  42 #define         SCP_SY_8BBUS    (0x1 << 0)      /*  8 bits. */
  43         unsigned short  scp_junk[2];    /* Unused */
  44         unsigned short  scp_iscpl;      /* lower 16 bits of ISCP_ADDR */
  45         unsigned short  scp_iscph;      /* upper 16 bits of ISCP_ADDR */
  46 };
  47
  48 /*
  49  * Intermediate System Configuration Pointer (ISCP).
  50  */
  51 typedef struct iscp_t   iscp_t;
  52 struct iscp_t {
  53         unsigned short  iscp_busy;      /* set by CPU before first CA,  */
  54                                         /* cleared by 82586 after read. */
  55         unsigned short  iscp_offset;    /* offset of SCB                */
  56         unsigned short  iscp_basel;     /* base of SCB                  */
  57         unsigned short  iscp_baseh;     /*  "                           */
  58 };
  59
  60 /*
  61  * System Control Block (SCB).
  62  *      The 82586 writes its status to scb_status and then
  63  *      raises an interrupt to alert the CPU.
  64  *      The CPU writes a command to scb_command and
  65  *      then issues a Channel Attention (CA) to alert the 82586.
  66  */
  67 typedef struct scb_t    scb_t;
  68 struct scb_t {
  69         unsigned short  scb_status;     /* Status of 82586              */
  70 #define         SCB_ST_INT      (0xF << 12)     /* Some of:             */
  71 #define         SCB_ST_CX       (0x1 << 15)     /* Cmd completed        */
  72 #define         SCB_ST_FR       (0x1 << 14)     /* Frame received       */
  73 #define         SCB_ST_CNA      (0x1 << 13)     /* Cmd unit not active  */
  74 #define         SCB_ST_RNR      (0x1 << 12)     /* Rcv unit not ready   */
  75 #define         SCB_ST_JUNK0    (0x1 << 11)     /* 0                    */
  76 #define         SCB_ST_CUS      (0x7 <<  8)     /* Cmd unit status      */
  77 #define                 SCB_ST_CUS_IDLE (0 << 8)        /* Idle         */
  78 #define                 SCB_ST_CUS_SUSP (1 << 8)        /* Suspended    */
  79 #define                 SCB_ST_CUS_ACTV (2 << 8)        /* Active       */
  80 #define         SCB_ST_JUNK1    (0x1 <<  7)     /* 0                    */
  81 #define         SCB_ST_RUS      (0x7 <<  4)     /* Rcv unit status      */
  82 #define                 SCB_ST_RUS_IDLE (0 << 4)        /* Idle         */
  83 #define                 SCB_ST_RUS_SUSP (1 << 4)        /* Suspended    */
  84 #define                 SCB_ST_RUS_NRES (2 << 4)        /* No resources */
  85 #define                 SCB_ST_RUS_RDY  (4 << 4)        /* Ready        */
  86         unsigned short  scb_command;    /* Next command                 */
  87 #define         SCB_CMD_ACK_CX  (0x1 << 15)     /* Ack cmd completion   */
  88 #define         SCB_CMD_ACK_FR  (0x1 << 14)     /* Ack frame received   */
  89 #define         SCB_CMD_ACK_CNA (0x1 << 13)     /* Ack CU not active    */
  90 #define         SCB_CMD_ACK_RNR (0x1 << 12)     /* Ack RU not ready     */
  91 #define         SCB_CMD_JUNKX   (0x1 << 11)     /* Unused               */
  92 #define         SCB_CMD_CUC     (0x7 <<  8)     /* Command Unit command */
  93 #define                 SCB_CMD_CUC_NOP (0 << 8)        /* Nop          */
  94 #define                 SCB_CMD_CUC_GO  (1 << 8)        /* Start cbl_offset */
  95 #define                 SCB_CMD_CUC_RES (2 << 8)        /* Resume execution */
  96 #define                 SCB_CMD_CUC_SUS (3 << 8)        /* Suspend   "  */
  97 #define                 SCB_CMD_CUC_ABT (4 << 8)        /* Abort     "  */
  98 #define         SCB_CMD_RESET   (0x1 <<  7)     /* Reset chip (hardware) */
  99 #define         SCB_CMD_RUC     (0x7 <<  4)     /* Receive Unit command */
 100 #define                 SCB_CMD_RUC_NOP (0 << 4)        /* Nop          */
 101 #define                 SCB_CMD_RUC_GO  (1 << 4)        /* Start rfa_offset */
 102 #define                 SCB_CMD_RUC_RES (2 << 4)        /* Resume reception */
 103 #define                 SCB_CMD_RUC_SUS (3 << 4)        /* Suspend   "  */
 104 #define                 SCB_CMD_RUC_ABT (4 << 4)        /* Abort     "  */
 105         unsigned short  scb_cbl_offset; /* Offset of first command unit */
 106                                         /* Action Command               */
 107         unsigned short  scb_rfa_offset; /* Offset of first Receive      */
 108                                         /* Frame Descriptor in the      */
 109                                         /* Receive Frame Area           */
 110         unsigned short  scb_crcerrs;    /* Properly aligned frames      */
 111                                         /* received with a CRC error    */
 112         unsigned short  scb_alnerrs;    /* Misaligned frames received   */
 113                                         /* with a CRC error             */
 114         unsigned short  scb_rscerrs;    /* Frames lost due to no space  */
 115         unsigned short  scb_ovrnerrs;   /* Frames lost due to slow bus  */
 116 };
 117
 118 #define scboff(p, f)    toff(scb_t, p, f)
 119
 120 /*
 121  * The eight Action Commands.
 122  */
 123 typedef enum acmd_e     acmd_e;
 124 enum acmd_e {
 125         acmd_nop        = 0,    /* Do nothing                           */
 126         acmd_ia_setup   = 1,    /* Load an (ethernet) address into the  */
 127                                 /* 82586                                */
 128         acmd_configure  = 2,    /* Update the 82586 operating parameters */
 129         acmd_mc_setup   = 3,    /* Load a list of (ethernet) multicast  */
 130                                 /* addresses into the 82586             */
 131         acmd_transmit   = 4,    /* Transmit a frame                     */
 132         acmd_tdr        = 5,    /* Perform a Time Domain Reflectometer  */
 133                                 /* test on the serial link              */
 134         acmd_dump       = 6,    /* Copy 82586 registers to memory       */
 135         acmd_diagnose   = 7,    /* Run an internal self test            */
 136 };
 137
 138 /*
 139  * Generic Action Command header.
 140  */
 141 typedef struct ach_t    ach_t;
 142 struct ach_t {
 143         unsigned short  ac_status;              /* Command status:      */
 144 #define         AC_SFLD_C       (0x1 << 15)     /* Command completed    */
 145 #define         AC_SFLD_B       (0x1 << 14)     /* Busy executing       */
 146 #define         AC_SFLD_OK      (0x1 << 13)     /* Completed error free */
 147 #define         AC_SFLD_A       (0x1 << 12)     /* Command aborted      */
 148 #define         AC_SFLD_FAIL    (0x1 << 11)     /* Selftest failed      */
 149 #define         AC_SFLD_S10     (0x1 << 10)     /* No carrier sense     */
 150                                                 /* during transmission  */
 151 #define         AC_SFLD_S9      (0x1 <<  9)     /* Tx unsuccessful:     */
 152                                                 /* (stopped) lost CTS   */
 153 #define         AC_SFLD_S8      (0x1 <<  8)     /* Tx unsuccessful:     */
 154                                                 /* (stopped) slow DMA   */
 155 #define         AC_SFLD_S7      (0x1 <<  7)     /* Tx deferred:         */
 156                                                 /* other link traffic   */
 157 #define         AC_SFLD_S6      (0x1 <<  6)     /* Heart Beat: collision */
 158                                                 /* detect after last tx */
 159 #define         AC_SFLD_S5      (0x1 <<  5)     /* Tx stopped:          */
 160                                                 /* excessive collisions */
 161 #define         AC_SFLD_MAXCOL  (0xF <<  0)     /* Collision count      */
 162         unsigned short  ac_command;             /* Command specifier:   */
 163 #define         AC_CFLD_EL      (0x1 << 15)     /* End of command list  */
 164 #define         AC_CFLD_S       (0x1 << 14)     /* Suspend on completion */
 165 #define         AC_CFLD_I       (0x1 << 13)     /* Interrupt on completion */
 166 #define         AC_CFLD_CMD     (0x7 <<  0)     /* acmd_e               */
 167         unsigned short  ac_link;                /* Next Action Command  */
 168 };
 169
 170 #define acoff(p, f)     toff(ach_t, p, f)
 171
 172 /*
 173  * The Nop Action Command.
 174  */
 175 typedef struct ac_nop_t ac_nop_t;
 176 struct ac_nop_t {
 177         ach_t   nop_h;
 178 };
 179
 180 /*
 181  * The IA-Setup Action Command.
 182  */
 183 typedef struct ac_ias_t ac_ias_t;
 184 struct ac_ias_t {
 185         ach_t           ias_h;
 186         unsigned char   ias_addr[ADDR_LEN]; /* The (ethernet) address   */
 187 };
 188
 189 /*
 190  * The Configure Action Command.
 191  */
 192 typedef struct ac_cfg_t ac_cfg_t;
 193 struct ac_cfg_t {
 194         ach_t           cfg_h;
 195         unsigned char   cfg_byte_cnt;   /* Size foll data: 4-12 */
 196 #define AC_CFG_BYTE_CNT(v)      (((v) & 0xF) << 0)
 197         unsigned char   cfg_fifolim;    /* FIFO threshold       */
 198 #define AC_CFG_FIFOLIM(v)       (((v) & 0xF) << 0)
 199         unsigned char   cfg_byte8;
 200 #define AC_CFG_SAV_BF(v)        (((v) & 0x1) << 7)      /* Save rxd bad frames  */
 201 #define AC_CFG_SRDY(v)          (((v) & 0x1) << 6)      /* SRDY/ARDY pin means  */
 202                                                         /* external sync.       */
 203         unsigned char   cfg_byte9;
 204 #define AC_CFG_ELPBCK(v)        (((v) & 0x1) << 7)      /* External loopback    */
 205 #define AC_CFG_ILPBCK(v)        (((v) & 0x1) << 6)      /* Internal loopback    */
 206 #define AC_CFG_PRELEN(v)        (((v) & 0x3) << 4)      /* Preamble length      */
 207 #define         AC_CFG_PLEN_2           0               /*  2 bytes     */
 208 #define         AC_CFG_PLEN_4           1               /*  4 bytes     */
 209 #define         AC_CFG_PLEN_8           2               /*  8 bytes     */
 210 #define         AC_CFG_PLEN_16          3               /* 16 bytes     */
 211 #define AC_CFG_ALOC(v)          (((v) & 0x1) << 3)      /* Addr/len data is     */
 212                                                         /* explicit in buffers  */
 213 #define AC_CFG_ADDRLEN(v)       (((v) & 0x7) << 0)      /* Bytes per address    */
 214         unsigned char   cfg_byte10;
 215 #define AC_CFG_BOFMET(v)        (((v) & 0x1) << 7)      /* Use alternate expo.  */
 216                                                         /* backoff method       */
 217 #define AC_CFG_ACR(v)           (((v) & 0x7) << 4)      /* Accelerated cont. res. */
 218 #define AC_CFG_LINPRIO(v)       (((v) & 0x7) << 0)      /* Linear priority      */
 219         unsigned char   cfg_ifs;        /* Interframe spacing           */
 220         unsigned char   cfg_slotl;      /* Slot time (low byte)         */
 221         unsigned char   cfg_byte13;
 222 #define AC_CFG_RETRYNUM(v)      (((v) & 0xF) << 4)      /* Max. collision retry */
 223 #define AC_CFG_SLTTMHI(v)       (((v) & 0x7) << 0)      /* Slot time (high bits) */
 224         unsigned char   cfg_byte14;
 225 #define AC_CFG_FLGPAD(v)        (((v) & 0x1) << 7)      /* Pad with HDLC flags  */
 226 #define AC_CFG_BTSTF(v)         (((v) & 0x1) << 6)      /* Do HDLC bitstuffing  */
 227 #define AC_CFG_CRC16(v)         (((v) & 0x1) << 5)      /* 16 bit CCITT CRC     */
 228 #define AC_CFG_NCRC(v)          (((v) & 0x1) << 4)      /* Insert no CRC        */
 229 #define AC_CFG_TNCRS(v)         (((v) & 0x1) << 3)      /* Tx even if no carrier */
 230 #define AC_CFG_MANCH(v)         (((v) & 0x1) << 2)      /* Manchester coding    */
 231 #define AC_CFG_BCDIS(v)         (((v) & 0x1) << 1)      /* Disable broadcast    */
 232 #define AC_CFG_PRM(v)           (((v) & 0x1) << 0)      /* Promiscuous mode     */
 233         unsigned char   cfg_byte15;
 234 #define AC_CFG_ICDS(v)          (((v) & 0x1) << 7)      /* Internal collision   */
 235                                                         /* detect source        */
 236 #define AC_CFG_CDTF(v)          (((v) & 0x7) << 4)      /* Collision detect     */
 237                                                         /* filter in bit times  */
 238 #define AC_CFG_ICSS(v)          (((v) & 0x1) << 3)      /* Internal carrier     */
 239                                                         /* sense source         */
 240 #define AC_CFG_CSTF(v)          (((v) & 0x7) << 0)      /* Carrier sense        */
 241                                                         /* filter in bit times  */
 242         unsigned short  cfg_min_frm_len;
 243 #define AC_CFG_MNFRM(v)         (((v) & 0xFF) << 0)     /* Min. bytes/frame (<= 255) */
 244 };
 245
 246 /*
 247  * The MC-Setup Action Command.
 248  */
 249 typedef struct ac_mcs_t ac_mcs_t;
 250 struct ac_mcs_t {
 251         ach_t           mcs_h;
 252         unsigned short  mcs_cnt;        /* No. of bytes of MC addresses */
 253 #if 0
 254         unsigned char   mcs_data[ADDR_LEN]; /* The first MC address ..  */
 255         ...
 256 #endif
 257 };
 258
 259 #define I82586_MAX_MULTICAST_ADDRESSES  128     /* Hardware hashed filter */
 260
 261 /*
 262  * The Transmit Action Command.
 263  */
 264 typedef struct ac_tx_t  ac_tx_t;
 265 struct ac_tx_t {
 266         ach_t           tx_h;
 267         unsigned short  tx_tbd_offset;  /* Address of list of buffers.  */
 268 #if     0
 269 Linux packets are passed down with the destination MAC address
 270 and length/type field already prepended to the data,
 271 so we do not need to insert it.  Consistent with this
 272 we must also set the AC_CFG_ALOC(..) flag during the
 273 ac_cfg_t action command.
 274         unsigned char   tx_addr[ADDR_LEN]; /* The frame dest. address   */
 275         unsigned short  tx_length;      /* The frame length             */
 276 #endif  /* 0 */
 277 };
 278
 279 /*
 280  * The Time Domain Reflectometer Action Command.
 281  */
 282 typedef struct ac_tdr_t ac_tdr_t;
 283 struct ac_tdr_t {
 284         ach_t           tdr_h;
 285         unsigned short  tdr_result;     /* Result.      */
 286 #define         AC_TDR_LNK_OK   (0x1 << 15)     /* No link problem      */
 287 #define         AC_TDR_XCVR_PRB (0x1 << 14)     /* Txcvr cable problem  */
 288 #define         AC_TDR_ET_OPN   (0x1 << 13)     /* Open on the link     */
 289 #define         AC_TDR_ET_SRT   (0x1 << 12)     /* Short on the link    */
 290 #define         AC_TDR_TIME     (0x7FF << 0)    /* Distance to problem  */
 291                                                 /* site in transmit     */
 292                                                 /* clock cycles         */
 293 };
 294
 295 /*
 296  * The Dump Action Command.
 297  */
 298 typedef struct ac_dmp_t ac_dmp_t;
 299 struct ac_dmp_t {
 300         ach_t           dmp_h;
 301         unsigned short  dmp_offset;     /* Result.      */
 302 };
 303
 304 /*
 305  * Size of the result of the dump command.
 306  */
 307 #define DUMPBYTES       170
 308
 309 /*
 310  * The Diagnose Action Command.
 311  */
 312 typedef struct ac_dgn_t ac_dgn_t;
 313 struct ac_dgn_t {
 314         ach_t           dgn_h;
 315 };
 316
 317 /*
 318  * Transmit Buffer Descriptor (TBD).
 319  */
 320 typedef struct tbd_t    tbd_t;
 321 struct tbd_t {
 322         unsigned short  tbd_status;             /* Written by the CPU   */
 323 #define         TBD_STATUS_EOF  (0x1 << 15)     /* This TBD is the      */
 324                                                 /* last for this frame  */
 325 #define         TBD_STATUS_ACNT (0x3FFF << 0)   /* Actual count of data */
 326                                                 /* bytes in this buffer */
 327         unsigned short  tbd_next_bd_offset;     /* Next in list         */
 328         unsigned short  tbd_bufl;               /* Buffer address (low) */
 329         unsigned short  tbd_bufh;               /*    "      "  (high)  */
 330 };
 331
 332 /*
 333  * Receive Buffer Descriptor (RBD).
 334  */
 335 typedef struct rbd_t    rbd_t;
 336 struct rbd_t {
 337         unsigned short  rbd_status;             /* Written by the 82586 */
 338 #define         RBD_STATUS_EOF  (0x1 << 15)     /* This RBD is the      */
 339                                                 /* last for this frame  */
 340 #define         RBD_STATUS_F    (0x1 << 14)     /* ACNT field is valid  */
 341 #define         RBD_STATUS_ACNT (0x3FFF << 0)   /* Actual no. of data   */
 342                                                 /* bytes in this buffer */
 343         unsigned short  rbd_next_rbd_offset;    /* Next rbd in list     */
 344         unsigned short  rbd_bufl;               /* Data pointer (low)   */
 345         unsigned short  rbd_bufh;               /*  "      "    (high)  */
 346         unsigned short  rbd_el_size;            /* EL+Data buf. size    */
 347 #define         RBD_EL  (0x1 << 15)             /* This BD is the       */
 348                                                 /* last in the list     */
 349 #define         RBD_SIZE (0x3FFF << 0)          /* No. of bytes the     */
 350                                                 /* buffer can hold      */
 351 };
 352
 353 #define rbdoff(p, f)    toff(rbd_t, p, f)
 354
 355 /*
 356  * Frame Descriptor (FD).
 357  */
 358 typedef struct fd_t     fd_t;
 359 struct fd_t {
 360         unsigned short  fd_status;              /* Written by the 82586 */
 361 #define         FD_STATUS_C     (0x1 << 15)     /* Completed storing frame */
 362 #define         FD_STATUS_B     (0x1 << 14)     /* FD was consumed by RU */
 363 #define         FD_STATUS_OK    (0x1 << 13)     /* Frame rxd successfully */
 364 #define         FD_STATUS_S11   (0x1 << 11)     /* CRC error            */
 365 #define         FD_STATUS_S10   (0x1 << 10)     /* Alignment error      */
 366 #define         FD_STATUS_S9    (0x1 <<  9)     /* Ran out of resources */
 367 #define         FD_STATUS_S8    (0x1 <<  8)     /* Rx DMA overrun       */
 368 #define         FD_STATUS_S7    (0x1 <<  7)     /* Frame too short      */
 369 #define         FD_STATUS_S6    (0x1 <<  6)     /* No EOF flag          */
 370         unsigned short  fd_command;             /* Command              */
 371 #define         FD_COMMAND_EL   (0x1 << 15)     /* Last FD in list      */
 372 #define         FD_COMMAND_S    (0x1 << 14)     /* Suspend RU after rx  */
 373         unsigned short  fd_link_offset;         /* Next FD              */
 374         unsigned short  fd_rbd_offset;          /* First RBD (data)     */
 375                                                 /* Prepared by CPU,     */
 376                                                 /* updated by 82586     */
 377 #if     0
 378 I think the rest is unused since we
 379 have set AC_CFG_ALOC(..).  However, just
 380 in case, we leave the space.
 381 #endif  /* 0 */
 382         unsigned char   fd_dest[ADDR_LEN];      /* Destination address  */
 383                                                 /* Written by 82586     */
 384         unsigned char   fd_src[ADDR_LEN];       /* Source address       */
 385                                                 /* Written by 82586     */
 386         unsigned short  fd_length;              /* Frame length or type */
 387                                                 /* Written by 82586     */
 388 };
 389
 390 #define fdoff(p, f)     toff(fd_t, p, f)
 391
 392 /*
 393  * This software may only be used and distributed
 394  * according to the terms of the GNU General Public License.
 395  *
 396  * For more details, see wavelan.c.
 397  */