sys/dev/sym/sym_defs.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  *  Device driver optimized for the Symbios/LSI 53C896/53C895A/53C1010
   5  *  PCI-SCSI controllers.
   6  *
   7  *  Copyright (C) 1999-2001  Gerard Roudier <groudier@free.fr>
   8  *
   9  *  This driver also supports the following Symbios/LSI PCI-SCSI chips:
  10  *      53C810A, 53C825A, 53C860, 53C875, 53C876, 53C885, 53C895,
  11  *      53C810,  53C815,  53C825 and the 53C1510D is 53C8XX mode.
  12  *
  13  *
  14  *  This driver for FreeBSD-CAM is derived from the Linux sym53c8xx driver.
  15  *  Copyright (C) 1998-1999  Gerard Roudier
  16  *
  17  *  The sym53c8xx driver is derived from the ncr53c8xx driver that had been
  18  *  a port of the FreeBSD ncr driver to Linux-1.2.13.
  19  *
  20  *  The original ncr driver has been written for 386bsd and FreeBSD by
  21  *          Wolfgang Stanglmeier        <wolf@cologne.de>
  22  *          Stefan Esser                <se@mi.Uni-Koeln.de>
  23  *  Copyright (C) 1994  Wolfgang Stanglmeier
  24  *
  25  *  The initialisation code, and part of the code that addresses
  26  *  FreeBSD-CAM services is based on the aic7xxx driver for FreeBSD-CAM
  27  *  written by Justin T. Gibbs.
  28  *
  29  *  Other major contributions:
  30  *
  31  *  NVRAM detection and reading.
  32  *  Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
  33  *
  34  *-----------------------------------------------------------------------------
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. The name of the author may not be used to endorse or promote products
  45  *    derived from this software without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  48  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  51  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  52  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  53  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  54  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  55  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  56  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  57  * SUCH DAMAGE.
  58  */
  59
  60 /* $FreeBSD$ */
  61
  62 #ifndef SYM_DEFS_H
  63 #define SYM_DEFS_H
  64
  65 /*
  66  *  Vendor.
  67  */
  68 #define PCI_VENDOR_NCR          0x1000
  69
  70 /*
  71  *  PCI device identifier of SYMBIOS chips.
  72  */
  73 #define PCI_ID_SYM53C810        1
  74 #define PCI_ID_SYM53C810AP      5
  75 #define PCI_ID_SYM53C815        4
  76 #define PCI_ID_SYM53C820        2
  77 #define PCI_ID_SYM53C825        3
  78 #define PCI_ID_SYM53C860        6
  79 #define PCI_ID_SYM53C875        0xf
  80 #define PCI_ID_SYM53C875_2      0x8f
  81 #define PCI_ID_SYM53C885        0xd
  82 #define PCI_ID_SYM53C895        0xc
  83 #define PCI_ID_SYM53C896        0xb
  84 #define PCI_ID_SYM53C895A       0x12
  85 #define PCI_ID_LSI53C1010       0x20
  86 #define PCI_ID_LSI53C1010_2     0x21
  87 #define PCI_ID_LSI53C1510D      0xa
  88
  89 /*
  90  *      SYM53C8XX device features descriptor.
  91  */
  92 struct sym_pci_chip {
  93         u_short device_id;
  94         unsigned short  revision_id;
  95         const char *name;
  96         u_char  burst_max;      /* log-base-2 of max burst */
  97         u_char  offset_max;
  98         u_char  nr_divisor;
  99         u_char  lp_probe_bit;
 100         u_int   features;
 101 #define FE_LED0         (1<<0)
 102 #define FE_WIDE         (1<<1)    /* Wide data transfers */
 103 #define FE_ULTRA        (1<<2)    /* Ultra speed 20Mtrans/sec */
 104 #define FE_ULTRA2       (1<<3)    /* Ultra 2 - 40 Mtrans/sec */
 105 #define FE_DBLR         (1<<4)    /* Clock doubler present */
 106 #define FE_QUAD         (1<<5)    /* Clock quadrupler present */
 107 #define FE_ERL          (1<<6)    /* Enable read line */
 108 #define FE_CLSE         (1<<7)    /* Cache line size enable */
 109 #define FE_WRIE         (1<<8)    /* Write & Invalidate enable */
 110 #define FE_ERMP         (1<<9)    /* Enable read multiple */
 111 #define FE_BOF          (1<<10)   /* Burst opcode fetch */
 112 #define FE_DFS          (1<<11)   /* DMA fifo size */
 113 #define FE_PFEN         (1<<12)   /* Prefetch enable */
 114 #define FE_LDSTR        (1<<13)   /* Load/Store supported */
 115 #define FE_RAM          (1<<14)   /* On chip RAM present */
 116 #define FE_CLK80        (1<<15)   /* Board clock is 80 MHz */
 117 #define FE_RAM8K        (1<<16)   /* On chip RAM sized 8Kb */
 118 #define FE_64BIT        (1<<17)   /* 64-bit PCI BUS interface */
 119 #define FE_IO256        (1<<18)   /* Requires full 256 bytes in PCI space */
 120 #define FE_NOPM         (1<<19)   /* Scripts handles phase mismatch */
 121 #define FE_LEDC         (1<<20)   /* Hardware control of LED */
 122 #define FE_ULTRA3       (1<<21)   /* Ultra 3 - 80 Mtrans/sec DT */
 123 #define FE_66MHZ        (1<<22)   /* 66MHz PCI support */
 124 #define FE_CRC          (1<<23)   /* CRC support */
 125 #define FE_DIFF         (1<<24)   /* SCSI HVD support */
 126 #define FE_DFBC         (1<<25)   /* Have DFBC register */
 127 #define FE_LCKFRQ       (1<<26)   /* Have LCKFRQ */
 128 #define FE_C10          (1<<27)   /* Various C10 core (mis)features */
 129 #define FE_U3EN         (1<<28)   /* U3EN bit usable */
 130 #define FE_DAC          (1<<29)   /* Support PCI DAC (64 bit addressing) */
 131
 132 #define FE_CACHE_SET    (FE_ERL|FE_CLSE|FE_WRIE|FE_ERMP)
 133 #define FE_CACHE0_SET   (FE_CACHE_SET & ~FE_ERL)
 134 #define FE_SPECIAL_SET  (FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|FE_RAM)
 135 };
 136
 137 /*
 138  *      Symbios NVRAM data format
 139  */
 140 #define SYMBIOS_NVRAM_SIZE 368
 141 #define SYMBIOS_NVRAM_ADDRESS 0x100
 142
 143 struct Symbios_nvram {
 144 /* Header 6 bytes */
 145         u_short type;           /* 0x0000 */
 146         u_short byte_count;     /* excluding header/trailer */
 147         u_short checksum;
 148
 149 /* Controller set up 20 bytes */
 150         u_char  v_major;        /* 0x00 */
 151         u_char  v_minor;        /* 0x30 */
 152         u32     boot_crc;
 153         u_short flags;
 154 #define SYMBIOS_SCAM_ENABLE     (1)
 155 #define SYMBIOS_PARITY_ENABLE   (1<<1)
 156 #define SYMBIOS_VERBOSE_MSGS    (1<<2)
 157 #define SYMBIOS_CHS_MAPPING     (1<<3)
 158 #define SYMBIOS_NO_NVRAM        (1<<3)  /* ??? */
 159         u_short flags1;
 160 #define SYMBIOS_SCAN_HI_LO      (1)
 161         u_short term_state;
 162 #define SYMBIOS_TERM_CANT_PROGRAM       (0)
 163 #define SYMBIOS_TERM_ENABLED            (1)
 164 #define SYMBIOS_TERM_DISABLED           (2)
 165         u_short rmvbl_flags;
 166 #define SYMBIOS_RMVBL_NO_SUPPORT        (0)
 167 #define SYMBIOS_RMVBL_BOOT_DEVICE       (1)
 168 #define SYMBIOS_RMVBL_MEDIA_INSTALLED   (2)
 169         u_char  host_id;
 170         u_char  num_hba;        /* 0x04 */
 171         u_char  num_devices;    /* 0x10 */
 172         u_char  max_scam_devices;       /* 0x04 */
 173         u_char  num_valid_scam_devices; /* 0x00 */
 174         u_char  flags2;
 175 #define SYMBIOS_AVOID_BUS_RESET         (1<<2)
 176
 177 /* Boot order 14 bytes * 4 */
 178         struct Symbios_host{
 179                 u_short type;           /* 4:8xx / 0:nok */
 180                 u_short device_id;      /* PCI device id */
 181                 u_short vendor_id;      /* PCI vendor id */
 182                 u_char  bus_nr;         /* PCI bus number */
 183                 u_char  device_fn;      /* PCI device/function number << 3*/
 184                 u_short word8;
 185                 u_short flags;
 186 #define SYMBIOS_INIT_SCAN_AT_BOOT       (1)
 187                 u_short io_port;        /* PCI io_port address */
 188         } host[4];
 189
 190 /* Targets 8 bytes * 16 */
 191         struct Symbios_target {
 192                 u_char  flags;
 193 #define SYMBIOS_DISCONNECT_ENABLE       (1)
 194 #define SYMBIOS_SCAN_AT_BOOT_TIME       (1<<1)
 195 #define SYMBIOS_SCAN_LUNS               (1<<2)
 196 #define SYMBIOS_QUEUE_TAGS_ENABLED      (1<<3)
 197                 u_char  rsvd;
 198                 u_char  bus_width;      /* 0x08/0x10 */
 199                 u_char  sync_offset;
 200                 u_short sync_period;    /* 4*period factor */
 201                 u_short timeout;
 202         } target[16];
 203 /* Scam table 8 bytes * 4 */
 204         struct Symbios_scam {
 205                 u_short id;
 206                 u_short method;
 207 #define SYMBIOS_SCAM_DEFAULT_METHOD     (0)
 208 #define SYMBIOS_SCAM_DONT_ASSIGN        (1)
 209 #define SYMBIOS_SCAM_SET_SPECIFIC_ID    (2)
 210 #define SYMBIOS_SCAM_USE_ORDER_GIVEN    (3)
 211                 u_short status;
 212 #define SYMBIOS_SCAM_UNKNOWN            (0)
 213 #define SYMBIOS_SCAM_DEVICE_NOT_FOUND   (1)
 214 #define SYMBIOS_SCAM_ID_NOT_SET         (2)
 215 #define SYMBIOS_SCAM_ID_VALID           (3)
 216                 u_char  target_id;
 217                 u_char  rsvd;
 218         } scam[4];
 219
 220         u_char  spare_devices[15*8];
 221         u_char  trailer[6];             /* 0xfe 0xfe 0x00 0x00 0x00 0x00 */
 222 };
 223 typedef struct Symbios_nvram    Symbios_nvram;
 224 typedef struct Symbios_host     Symbios_host;
 225 typedef struct Symbios_target   Symbios_target;
 226 typedef struct Symbios_scam     Symbios_scam;
 227
 228 /*
 229  *      Tekram NvRAM data format.
 230  */
 231 #define TEKRAM_NVRAM_SIZE 64
 232 #define TEKRAM_93C46_NVRAM_ADDRESS 0
 233 #define TEKRAM_24C16_NVRAM_ADDRESS 0x40
 234
 235 struct Tekram_nvram {
 236         struct Tekram_target {
 237                 u_char  flags;
 238 #define TEKRAM_PARITY_CHECK             (1)
 239 #define TEKRAM_SYNC_NEGO                (1<<1)
 240 #define TEKRAM_DISCONNECT_ENABLE        (1<<2)
 241 #define TEKRAM_START_CMD                (1<<3)
 242 #define TEKRAM_TAGGED_COMMANDS          (1<<4)
 243 #define TEKRAM_WIDE_NEGO                (1<<5)
 244                 u_char  sync_index;
 245                 u_short word2;
 246         } target[16];
 247         u_char  host_id;
 248         u_char  flags;
 249 #define TEKRAM_MORE_THAN_2_DRIVES       (1)
 250 #define TEKRAM_DRIVES_SUP_1GB           (1<<1)
 251 #define TEKRAM_RESET_ON_POWER_ON        (1<<2)
 252 #define TEKRAM_ACTIVE_NEGATION          (1<<3)
 253 #define TEKRAM_IMMEDIATE_SEEK           (1<<4)
 254 #define TEKRAM_SCAN_LUNS                (1<<5)
 255 #define TEKRAM_REMOVABLE_FLAGS          (3<<6)  /* 0: disable; 1: boot device; 2:all */
 256         u_char  boot_delay_index;
 257         u_char  max_tags_index;
 258         u_short flags1;
 259 #define TEKRAM_F2_F6_ENABLED            (1)
 260         u_short spare[29];
 261 };
 262 typedef struct Tekram_nvram     Tekram_nvram;
 263 typedef struct Tekram_target    Tekram_target;
 264
 265 /*
 266  *      SYM53C8XX IO register data structure.
 267  */
 268 struct sym_reg {
 269 /*00*/  u8      nc_scntl0;      /* full arb., ena parity, par->ATN  */
 270
 271 /*01*/  u8      nc_scntl1;      /* no reset                         */
 272         #define   ISCON   0x10  /* connected to scsi                */
 273         #define   CRST    0x08  /* force reset                      */
 274         #define   IARB    0x02  /* immediate arbitration            */
 275
 276 /*02*/  u8      nc_scntl2;      /* no disconnect expected           */
 277         #define   SDU     0x80  /* cmd: disconnect will raise error */
 278         #define   CHM     0x40  /* sta: chained mode                */
 279         #define   WSS     0x08  /* sta: wide scsi send           [W]*/
 280         #define   WSR     0x01  /* sta: wide scsi received       [W]*/
 281
 282 /*03*/  u8      nc_scntl3;      /* cnf system clock dependent       */
 283         #define   EWS     0x08  /* cmd: enable wide scsi         [W]*/
 284         #define   ULTRA   0x80  /* cmd: ULTRA enable                */
 285                                 /* bits 0-2, 7 rsvd for C1010       */
 286
 287 /*04*/  u8      nc_scid;        /* cnf host adapter scsi address    */
 288         #define   RRE     0x40  /* r/w:e enable response to resel.  */
 289         #define   SRE     0x20  /* r/w:e enable response to select  */
 290
 291 /*05*/  u8      nc_sxfer;       /* ### Sync speed and count         */
 292                                 /* bits 6-7 rsvd for C1010          */
 293
 294 /*06*/  u8      nc_sdid;        /* ### Destination-ID               */
 295
 296 /*07*/  u8      nc_gpreg;       /* ??? IO-Pins                      */
 297
 298 /*08*/  u8      nc_sfbr;        /* ### First byte received          */
 299
 300 /*09*/  u8      nc_socl;
 301         #define   CREQ    0x80  /* r/w: SCSI-REQ                    */
 302         #define   CACK    0x40  /* r/w: SCSI-ACK                    */
 303         #define   CBSY    0x20  /* r/w: SCSI-BSY                    */
 304         #define   CSEL    0x10  /* r/w: SCSI-SEL                    */
 305         #define   CATN    0x08  /* r/w: SCSI-ATN                    */
 306         #define   CMSG    0x04  /* r/w: SCSI-MSG                    */
 307         #define   CC_D    0x02  /* r/w: SCSI-C_D                    */
 308         #define   CI_O    0x01  /* r/w: SCSI-I_O                    */
 309
 310 /*0a*/  u8      nc_ssid;
 311
 312 /*0b*/  u8      nc_sbcl;
 313
 314 /*0c*/  u8      nc_dstat;
 315         #define   DFE     0x80  /* sta: dma fifo empty              */
 316         #define   MDPE    0x40  /* int: master data parity error    */
 317         #define   BF      0x20  /* int: script: bus fault           */
 318         #define   ABRT    0x10  /* int: script: command aborted     */
 319         #define   SSI     0x08  /* int: script: single step         */
 320         #define   SIR     0x04  /* int: script: interrupt instruct. */
 321         #define   IID     0x01  /* int: script: illegal instruct.   */
 322
 323 /*0d*/  u8      nc_sstat0;
 324         #define   ILF     0x80  /* sta: data in SIDL register lsb   */
 325         #define   ORF     0x40  /* sta: data in SODR register lsb   */
 326         #define   OLF     0x20  /* sta: data in SODL register lsb   */
 327         #define   AIP     0x10  /* sta: arbitration in progress     */
 328         #define   LOA     0x08  /* sta: arbitration lost            */
 329         #define   WOA     0x04  /* sta: arbitration won             */
 330         #define   IRST    0x02  /* sta: scsi reset signal           */
 331         #define   SDP     0x01  /* sta: scsi parity signal          */
 332
 333 /*0e*/  u8      nc_sstat1;
 334         #define   FF3210  0xf0  /* sta: bytes in the scsi fifo      */
 335
 336 /*0f*/  u8      nc_sstat2;
 337         #define   ILF1    0x80  /* sta: data in SIDL register msb[W]*/
 338         #define   ORF1    0x40  /* sta: data in SODR register msb[W]*/
 339         #define   OLF1    0x20  /* sta: data in SODL register msb[W]*/
 340         #define   DM      0x04  /* sta: DIFFSENS mismatch (895/6 only) */
 341         #define   LDSC    0x02  /* sta: disconnect & reconnect      */
 342
 343 /*10*/  u8      nc_dsa;         /* --> Base page                    */
 344 /*11*/  u8      nc_dsa1;
 345 /*12*/  u8      nc_dsa2;
 346 /*13*/  u8      nc_dsa3;
 347
 348 /*14*/  u8      nc_istat;       /* --> Main Command and status      */
 349         #define   CABRT   0x80  /* cmd: abort current operation     */
 350         #define   SRST    0x40  /* mod: reset chip                  */
 351         #define   SIGP    0x20  /* r/w: message from host to script */
 352         #define   SEM     0x10  /* r/w: message between host + script  */
 353         #define   CON     0x08  /* sta: connected to scsi           */
 354         #define   INTF    0x04  /* sta: int on the fly (reset by wr)*/
 355         #define   SIP     0x02  /* sta: scsi-interrupt              */
 356         #define   DIP     0x01  /* sta: host/script interrupt       */
 357
 358 /*15*/  u8      nc_istat1;      /* 896 only */
 359 /*16*/  u8      nc_mbox0;       /* 896 only */
 360 /*17*/  u8      nc_mbox1;       /* 896 only */
 361
 362 /*18*/  u8      nc_ctest0;
 363 /*19*/  u8      nc_ctest1;
 364
 365 /*1a*/  u8      nc_ctest2;
 366         #define   CSIGP   0x40
 367                                 /* bits 0-2,7 rsvd for C1010        */
 368
 369 /*1b*/  u8      nc_ctest3;
 370         #define   FLF     0x08  /* cmd: flush dma fifo              */
 371         #define   CLF     0x04  /* cmd: clear dma fifo              */
 372         #define   FM      0x02  /* mod: fetch pin mode              */
 373         #define   WRIE    0x01  /* mod: write and invalidate enable */
 374                                 /* bits 4-7 rsvd for C1010          */
 375
 376 /*1c*/  u32     nc_temp;        /* ### Temporary stack              */
 377
 378 /*20*/  u8      nc_dfifo;
 379 /*21*/  u8      nc_ctest4;
 380         #define   BDIS    0x80  /* mod: burst disable               */
 381         #define   MPEE    0x08  /* mod: master parity error enable  */
 382
 383 /*22*/  u8      nc_ctest5;
 384         #define   DFS     0x20  /* mod: dma fifo size               */
 385                                 /* bits 0-1, 3-7 rsvd for C1010     */
 386
 387 /*23*/  u8      nc_ctest6;
 388
 389 /*24*/  u32     nc_dbc;         /* ### Byte count and command       */
 390 /*28*/  u32     nc_dnad;        /* ### Next command register        */
 391 /*2c*/  u32     nc_dsp;         /* --> Script Pointer               */
 392 /*30*/  u32     nc_dsps;        /* --> Script pointer save/opcode#2 */
 393
 394 /*34*/  u8      nc_scratcha;    /* Temporary register a            */
 395 /*35*/  u8      nc_scratcha1;
 396 /*36*/  u8      nc_scratcha2;
 397 /*37*/  u8      nc_scratcha3;
 398
 399 /*38*/  u8      nc_dmode;
 400         #define   BL_2    0x80  /* mod: burst length shift value +2 */
 401         #define   BL_1    0x40  /* mod: burst length shift value +1 */
 402         #define   ERL     0x08  /* mod: enable read line            */
 403         #define   ERMP    0x04  /* mod: enable read multiple        */
 404         #define   BOF     0x02  /* mod: burst op code fetch         */
 405
 406 /*39*/  u8      nc_dien;
 407 /*3a*/  u8      nc_sbr;
 408
 409 /*3b*/  u8      nc_dcntl;       /* --> Script execution control     */
 410         #define   CLSE    0x80  /* mod: cache line size enable      */
 411         #define   PFF     0x40  /* cmd: pre-fetch flush             */
 412         #define   PFEN    0x20  /* mod: pre-fetch enable            */
 413         #define   SSM     0x10  /* mod: single step mode            */
 414         #define   IRQM    0x08  /* mod: irq mode (1 = totem pole !) */
 415         #define   STD     0x04  /* cmd: start dma mode              */
 416         #define   IRQD    0x02  /* mod: irq disable                 */
 417         #define   NOCOM   0x01  /* cmd: protect sfbr while reselect */
 418                                 /* bits 0-1 rsvd for C1010          */
 419
 420 /*3c*/  u32     nc_adder;
 421
 422 /*40*/  u16     nc_sien;        /* -->: interrupt enable            */
 423 /*42*/  u16     nc_sist;        /* <--: interrupt status            */
 424         #define   SBMC    0x1000/* sta: SCSI Bus Mode Change (895/6 only) */
 425         #define   STO     0x0400/* sta: timeout (select)            */
 426         #define   GEN     0x0200/* sta: timeout (general)           */
 427         #define   HTH     0x0100/* sta: timeout (handshake)         */
 428         #define   MA      0x80  /* sta: phase mismatch              */
 429         #define   CMP     0x40  /* sta: arbitration complete        */
 430         #define   SEL     0x20  /* sta: selected by another device  */
 431         #define   RSL     0x10  /* sta: reselected by another device*/
 432         #define   SGE     0x08  /* sta: gross error (over/underflow)*/
 433         #define   UDC     0x04  /* sta: unexpected disconnect       */
 434         #define   RST     0x02  /* sta: scsi bus reset detected     */
 435         #define   PAR     0x01  /* sta: scsi parity error           */
 436
 437 /*44*/  u8      nc_slpar;
 438 /*45*/  u8      nc_swide;
 439 /*46*/  u8      nc_macntl;
 440 /*47*/  u8      nc_gpcntl;
 441 /*48*/  u8      nc_stime0;      /* cmd: timeout for select&handshake*/
 442 /*49*/  u8      nc_stime1;      /* cmd: timeout user defined        */
 443 /*4a*/  u16     nc_respid;      /* sta: Reselect-IDs                */
 444
 445 /*4c*/  u8      nc_stest0;
 446
 447 /*4d*/  u8      nc_stest1;
 448         #define   SCLK    0x80  /* Use the PCI clock as SCSI clock      */
 449         #define   DBLEN   0x08  /* clock doubler running                */
 450         #define   DBLSEL  0x04  /* clock doubler selected               */
 451
 452
 453 /*4e*/  u8      nc_stest2;
 454         #define   ROF     0x40  /* reset scsi offset (after gross error!) */
 455         #define   EXT     0x02  /* extended filtering                     */
 456
 457 /*4f*/  u8      nc_stest3;
 458         #define   TE     0x80   /* c: tolerAnt enable */
 459         #define   HSC    0x20   /* c: Halt SCSI Clock */
 460         #define   CSF    0x02   /* c: clear scsi fifo */
 461
 462 /*50*/  u16     nc_sidl;        /* Lowlevel: latched from scsi data */
 463 /*52*/  u8      nc_stest4;
 464         #define   SMODE  0xc0   /* SCSI bus mode      (895/6 only) */
 465         #define    SMODE_HVD 0x40       /* High Voltage Differential       */
 466         #define    SMODE_SE  0x80       /* Single Ended                    */
 467         #define    SMODE_LVD 0xc0       /* Low Voltage Differential        */
 468         #define   LCKFRQ 0x20   /* Frequency Lock (895/6 only)     */
 469                                 /* bits 0-5 rsvd for C1010         */
 470
 471 /*53*/  u8      nc_53_;
 472 /*54*/  u16     nc_sodl;        /* Lowlevel: data out to scsi data  */
 473 /*56*/  u8      nc_ccntl0;      /* Chip Control 0 (896)             */
 474         #define   ENPMJ  0x80   /* Enable Phase Mismatch Jump       */
 475         #define   PMJCTL 0x40   /* Phase Mismatch Jump Control      */
 476         #define   ENNDJ  0x20   /* Enable Non Data PM Jump          */
 477         #define   DISFC  0x10   /* Disable Auto FIFO Clear          */
 478         #define   DILS   0x02   /* Disable Internal Load/Store      */
 479         #define   DPR    0x01   /* Disable Pipe Req                 */
 480
 481 /*57*/  u8      nc_ccntl1;      /* Chip Control 1 (896)             */
 482         #define   ZMOD   0x80   /* High Impedance Mode              */
 483         #define   DDAC   0x08   /* Disable Dual Address Cycle       */
 484         #define   XTIMOD 0x04   /* 64-bit Table Ind. Indexing Mode  */
 485         #define   EXTIBMV 0x02  /* Enable 64-bit Table Ind. BMOV    */
 486         #define   EXDBMV 0x01   /* Enable 64-bit Direct BMOV        */
 487
 488 /*58*/  u16     nc_sbdl;        /* Lowlevel: data from scsi data    */
 489 /*5a*/  u16     nc_5a_;
 490
 491 /*5c*/  u8      nc_scr0;        /* Working register B               */
 492 /*5d*/  u8      nc_scr1;
 493 /*5e*/  u8      nc_scr2;
 494 /*5f*/  u8      nc_scr3;
 495
 496 /*60*/  u8      nc_scrx[64];    /* Working register C-R             */
 497 /*a0*/  u32     nc_mmrs;        /* Memory Move Read Selector        */
 498 /*a4*/  u32     nc_mmws;        /* Memory Move Write Selector       */
 499 /*a8*/  u32     nc_sfs;         /* Script Fetch Selector            */
 500 /*ac*/  u32     nc_drs;         /* DSA Relative Selector            */
 501 /*b0*/  u32     nc_sbms;        /* Static Block Move Selector       */
 502 /*b4*/  u32     nc_dbms;        /* Dynamic Block Move Selector      */
 503 /*b8*/  u32     nc_dnad64;      /* DMA Next Address 64              */
 504 /*bc*/  u16     nc_scntl4;      /* C1010 only                       */
 505         #define   U3EN    0x80  /* Enable Ultra 3                   */
 506         #define   AIPCKEN 0x40  /* AIP checking enable              */
 507                                 /* Also enable AIP generation on C10-33*/
 508         #define   XCLKH_DT 0x08 /* Extra clock of data hold on DT edge */
 509         #define   XCLKH_ST 0x04 /* Extra clock of data hold on ST edge */
 510         #define   XCLKS_DT 0x02 /* Extra clock of data set  on DT edge */
 511         #define   XCLKS_ST 0x01 /* Extra clock of data set  on ST edge */
 512 /*be*/  u8      nc_aipcntl0;    /* AIP Control 0 C1010 only         */
 513 /*bf*/  u8      nc_aipcntl1;    /* AIP Control 1 C1010 only         */
 514         #define DISAIP  0x08    /* Disable AIP generation C10-66 only  */
 515 /*c0*/  u32     nc_pmjad1;      /* Phase Mismatch Jump Address 1    */
 516 /*c4*/  u32     nc_pmjad2;      /* Phase Mismatch Jump Address 2    */
 517 /*c8*/  u8      nc_rbc;         /* Remaining Byte Count             */
 518 /*c9*/  u8      nc_rbc1;
 519 /*ca*/  u8      nc_rbc2;
 520 /*cb*/  u8      nc_rbc3;
 521
 522 /*cc*/  u8      nc_ua;          /* Updated Address                  */
 523 /*cd*/  u8      nc_ua1;
 524 /*ce*/  u8      nc_ua2;
 525 /*cf*/  u8      nc_ua3;
 526 /*d0*/  u32     nc_esa;         /* Entry Storage Address            */
 527 /*d4*/  u8      nc_ia;          /* Instruction Address              */
 528 /*d5*/  u8      nc_ia1;
 529 /*d6*/  u8      nc_ia2;
 530 /*d7*/  u8      nc_ia3;
 531 /*d8*/  u32     nc_sbc;         /* SCSI Byte Count (3 bytes only)   */
 532 /*dc*/  u32     nc_csbc;        /* Cumulative SCSI Byte Count       */
 533                                 /* Following for C1010 only         */
 534 /*e0*/  u16    nc_crcpad;       /* CRC Value                        */
 535 /*e2*/  u8     nc_crccntl0;     /* CRC control register             */
 536         #define   SNDCRC  0x10  /* Send CRC Request                 */
 537 /*e3*/  u8     nc_crccntl1;     /* CRC control register             */
 538 /*e4*/  u32    nc_crcdata;      /* CRC data register                */
 539 /*e8*/  u32    nc_e8_;
 540 /*ec*/  u32    nc_ec_;
 541 /*f0*/  u16    nc_dfbc;         /* DMA FIFO byte count              */
 542 };
 543
 544 /*-----------------------------------------------------------
 545  *
 546  *      Utility macros for the script.
 547  *
 548  *-----------------------------------------------------------
 549  */
 550
 551 #define REGJ(p,r) (offsetof(struct sym_reg, p ## r))
 552 #define REG(r) REGJ (nc_, r)
 553
 554 typedef u32 symcmd;
 555
 556 /*-----------------------------------------------------------
 557  *
 558  *      SCSI phases
 559  *
 560  *-----------------------------------------------------------
 561  */
 562
 563 #define SCR_DATA_OUT    0x00000000
 564 #define SCR_DATA_IN     0x01000000
 565 #define SCR_COMMAND     0x02000000
 566 #define SCR_STATUS      0x03000000
 567 #define SCR_DT_DATA_OUT 0x04000000
 568 #define SCR_DT_DATA_IN  0x05000000
 569 #define SCR_MSG_OUT     0x06000000
 570 #define SCR_MSG_IN      0x07000000
 571 /* DT phases are illegal for non Ultra3 mode */
 572 #define SCR_ILG_OUT     0x04000000
 573 #define SCR_ILG_IN      0x05000000
 574
 575 /*-----------------------------------------------------------
 576  *
 577  *      Data transfer via SCSI.
 578  *
 579  *-----------------------------------------------------------
 580  *
 581  *      MOVE_ABS (LEN)
 582  *      <<start address>>
 583  *
 584  *      MOVE_IND (LEN)
 585  *      <<dnad_offset>>
 586  *
 587  *      MOVE_TBL
 588  *      <<dnad_offset>>
 589  *
 590  *-----------------------------------------------------------
 591  */
 592
 593 #define OPC_MOVE          0x08000000
 594
 595 #define SCR_MOVE_ABS(l) ((0x00000000 | OPC_MOVE) | (l))
 596 #define SCR_MOVE_IND(l) ((0x20000000 | OPC_MOVE) | (l))
 597 #define SCR_MOVE_TBL     (0x10000000 | OPC_MOVE)
 598
 599 #define SCR_CHMOV_ABS(l) ((0x00000000) | (l))
 600 #define SCR_CHMOV_IND(l) ((0x20000000) | (l))
 601 #define SCR_CHMOV_TBL     (0x10000000)
 602
 603 struct sym_tblmove {
 604         u32  size;
 605         u32  addr;
 606 };
 607
 608 /*-----------------------------------------------------------
 609  *
 610  *      Selection
 611  *
 612  *-----------------------------------------------------------
 613  *
 614  *      SEL_ABS | SCR_ID (0..15)    [ | REL_JMP]
 615  *      <<alternate_address>>
 616  *
 617  *      SEL_TBL | << dnad_offset>>  [ | REL_JMP]
 618  *      <<alternate_address>>
 619  *
 620  *-----------------------------------------------------------
 621  */
 622
 623 #define SCR_SEL_ABS     0x40000000
 624 #define SCR_SEL_ABS_ATN 0x41000000
 625 #define SCR_SEL_TBL     0x42000000
 626 #define SCR_SEL_TBL_ATN 0x43000000
 627
 628 struct sym_tblsel {
 629         u_char  sel_scntl4;     /* C1010 only */
 630         u_char  sel_sxfer;
 631         u_char  sel_id;
 632         u_char  sel_scntl3;
 633 };
 634
 635 #define SCR_JMP_REL     0x04000000
 636 #define SCR_ID(id)      (((u32)(id)) << 16)
 637
 638 /*-----------------------------------------------------------
 639  *
 640  *      Waiting for Disconnect or Reselect
 641  *
 642  *-----------------------------------------------------------
 643  *
 644  *      WAIT_DISC
 645  *      dummy: <<alternate_address>>
 646  *
 647  *      WAIT_RESEL
 648  *      <<alternate_address>>
 649  *
 650  *-----------------------------------------------------------
 651  */
 652
 653 #define SCR_WAIT_DISC   0x48000000
 654 #define SCR_WAIT_RESEL  0x50000000
 655
 656 /*-----------------------------------------------------------
 657  *
 658  *      Bit Set / Reset
 659  *
 660  *-----------------------------------------------------------
 661  *
 662  *      SET (flags {|.. })
 663  *
 664  *      CLR (flags {|.. })
 665  *
 666  *-----------------------------------------------------------
 667  */
 668
 669 #define SCR_SET(f)     (0x58000000 | (f))
 670 #define SCR_CLR(f)     (0x60000000 | (f))
 671
 672 #define SCR_CARRY       0x00000400
 673 #define SCR_TRG         0x00000200
 674 #define SCR_ACK         0x00000040
 675 #define SCR_ATN         0x00000008
 676
 677
 678 /*-----------------------------------------------------------
 679  *
 680  *      Memory to memory move
 681  *
 682  *-----------------------------------------------------------
 683  *
 684  *      COPY (bytecount)
 685  *      << source_address >>
 686  *      << destination_address >>
 687  *
 688  *      SCR_COPY   sets the NO FLUSH option by default.
 689  *      SCR_COPY_F does not set this option.
 690  *
 691  *      For chips which do not support this option,
 692  *      sym_copy_and_bind() will remove this bit.
 693  *
 694  *-----------------------------------------------------------
 695  */
 696
 697 #define SCR_NO_FLUSH 0x01000000
 698
 699 #define SCR_COPY(n) (0xc0000000 | SCR_NO_FLUSH | (n))
 700 #define SCR_COPY_F(n) (0xc0000000 | (n))
 701
 702 /*-----------------------------------------------------------
 703  *
 704  *      Register move and binary operations
 705  *
 706  *-----------------------------------------------------------
 707  *
 708  *      SFBR_REG (reg, op, data)        reg  = SFBR op data
 709  *      << 0 >>
 710  *
 711  *      REG_SFBR (reg, op, data)        SFBR = reg op data
 712  *      << 0 >>
 713  *
 714  *      REG_REG  (reg, op, data)        reg  = reg op data
 715  *      << 0 >>
 716  *
 717  *-----------------------------------------------------------
 718  *
 719  *      On 825A, 875, 895 and 896 chips the content
 720  *      of SFBR register can be used as data (SCR_SFBR_DATA).
 721  *      The 896 has additionnal IO registers starting at
 722  *      offset 0x80. Bit 7 of register offset is stored in
 723  *      bit 7 of the SCRIPTS instruction first DWORD.
 724  *
 725  *-----------------------------------------------------------
 726  */
 727
 728 #define SCR_REG_OFS(ofs) ((((ofs) & 0x7f) << 16ul) + ((ofs) & 0x80))
 729
 730 #define SCR_SFBR_REG(reg,op,data) \
 731         (0x68000000 | (SCR_REG_OFS(REG(reg))) | (op) | (((data)&0xff)<<8ul))
 732
 733 #define SCR_REG_SFBR(reg,op,data) \
 734         (0x70000000 | (SCR_REG_OFS(REG(reg))) | (op) | (((data)&0xff)<<8ul))
 735
 736 #define SCR_REG_REG(reg,op,data) \
 737         (0x78000000 | (SCR_REG_OFS(REG(reg))) | (op) | (((data)&0xff)<<8ul))
 738
 739
 740 #define      SCR_LOAD   0x00000000
 741 #define      SCR_SHL    0x01000000
 742 #define      SCR_OR     0x02000000
 743 #define      SCR_XOR    0x03000000
 744 #define      SCR_AND    0x04000000
 745 #define      SCR_SHR    0x05000000
 746 #define      SCR_ADD    0x06000000
 747 #define      SCR_ADDC   0x07000000
 748
 749 #define      SCR_SFBR_DATA   (0x00800000>>8ul)  /* Use SFBR as data */
 750
 751 /*-----------------------------------------------------------
 752  *
 753  *      FROM_REG (reg)            SFBR = reg
 754  *      << 0 >>
 755  *
 756  *      TO_REG   (reg)            reg  = SFBR
 757  *      << 0 >>
 758  *
 759  *      LOAD_REG (reg, data)      reg  = <data>
 760  *      << 0 >>
 761  *
 762  *      LOAD_SFBR(data)           SFBR = <data>
 763  *      << 0 >>
 764  *
 765  *-----------------------------------------------------------
 766  */
 767
 768 #define SCR_FROM_REG(reg) \
 769         SCR_REG_SFBR(reg,SCR_OR,0)
 770
 771 #define SCR_TO_REG(reg) \
 772         SCR_SFBR_REG(reg,SCR_OR,0)
 773
 774 #define SCR_LOAD_REG(reg,data) \
 775         SCR_REG_REG(reg,SCR_LOAD,data)
 776
 777 #define SCR_LOAD_SFBR(data) \
 778         (SCR_REG_SFBR (gpreg, SCR_LOAD, data))
 779
 780 /*-----------------------------------------------------------
 781  *
 782  *      LOAD  from memory   to register.
 783  *      STORE from register to memory.
 784  *
 785  *      Only supported by 810A, 860, 825A, 875, 895 and 896.
 786  *
 787  *-----------------------------------------------------------
 788  *
 789  *      LOAD_ABS (LEN)
 790  *      <<start address>>
 791  *
 792  *      LOAD_REL (LEN)        (DSA relative)
 793  *      <<dsa_offset>>
 794  *
 795  *-----------------------------------------------------------
 796  */
 797
 798 #define SCR_REG_OFS2(ofs) (((ofs) & 0xff) << 16ul)
 799 #define SCR_NO_FLUSH2   0x02000000
 800 #define SCR_DSA_REL2    0x10000000
 801
 802 #define SCR_LOAD_R(reg, how, n) \
 803         (0xe1000000 | (how) | (SCR_REG_OFS2(REG(reg))) | (n))
 804
 805 #define SCR_STORE_R(reg, how, n) \
 806         (0xe0000000 | (how) | (SCR_REG_OFS2(REG(reg))) | (n))
 807
 808 #define SCR_LOAD_ABS(reg, n)    SCR_LOAD_R(reg, SCR_NO_FLUSH2, n)
 809 #define SCR_LOAD_REL(reg, n)    SCR_LOAD_R(reg, SCR_NO_FLUSH2|SCR_DSA_REL2, n)
 810 #define SCR_LOAD_ABS_F(reg, n)  SCR_LOAD_R(reg, 0, n)
 811 #define SCR_LOAD_REL_F(reg, n)  SCR_LOAD_R(reg, SCR_DSA_REL2, n)
 812
 813 #define SCR_STORE_ABS(reg, n)   SCR_STORE_R(reg, SCR_NO_FLUSH2, n)
 814 #define SCR_STORE_REL(reg, n)   SCR_STORE_R(reg, SCR_NO_FLUSH2|SCR_DSA_REL2,n)
 815 #define SCR_STORE_ABS_F(reg, n) SCR_STORE_R(reg, 0, n)
 816 #define SCR_STORE_REL_F(reg, n) SCR_STORE_R(reg, SCR_DSA_REL2, n)
 817
 818
 819 /*-----------------------------------------------------------
 820  *
 821  *      Waiting for Disconnect or Reselect
 822  *
 823  *-----------------------------------------------------------
 824  *
 825  *      JUMP            [ | IFTRUE/IFFALSE ( ... ) ]
 826  *      <<address>>
 827  *
 828  *      JUMPR           [ | IFTRUE/IFFALSE ( ... ) ]
 829  *      <<distance>>
 830  *
 831  *      CALL            [ | IFTRUE/IFFALSE ( ... ) ]
 832  *      <<address>>
 833  *
 834  *      CALLR           [ | IFTRUE/IFFALSE ( ... ) ]
 835  *      <<distance>>
 836  *
 837  *      RETURN          [ | IFTRUE/IFFALSE ( ... ) ]
 838  *      <<dummy>>
 839  *
 840  *      INT             [ | IFTRUE/IFFALSE ( ... ) ]
 841  *      <<ident>>
 842  *
 843  *      INT_FLY         [ | IFTRUE/IFFALSE ( ... ) ]
 844  *      <<ident>>
 845  *
 846  *      Conditions:
 847  *           WHEN (phase)
 848  *           IF   (phase)
 849  *           CARRYSET
 850  *           DATA (data, mask)
 851  *
 852  *-----------------------------------------------------------
 853  */
 854
 855 #define SCR_NO_OP       0x80000000
 856 #define SCR_JUMP        0x80080000
 857 #define SCR_JUMP64      0x80480000
 858 #define SCR_JUMPR       0x80880000
 859 #define SCR_CALL        0x88080000
 860 #define SCR_CALLR       0x88880000
 861 #define SCR_RETURN      0x90080000
 862 #define SCR_INT         0x98080000
 863 #define SCR_INT_FLY     0x98180000
 864
 865 #define IFFALSE(arg)   (0x00080000 | (arg))
 866 #define IFTRUE(arg)    (0x00000000 | (arg))
 867
 868 #define WHEN(phase)    (0x00030000 | (phase))
 869 #define IF(phase)      (0x00020000 | (phase))
 870
 871 #define DATA(D)        (0x00040000 | ((D) & 0xff))
 872 #define MASK(D,M)      (0x00040000 | (((M ^ 0xff) & 0xff) << 8ul)|((D) & 0xff))
 873
 874 #define CARRYSET       (0x00200000)
 875
 876 /*-----------------------------------------------------------
 877  *
 878  *      SCSI  constants.
 879  *
 880  *-----------------------------------------------------------
 881  */
 882
 883 /*
 884  *      Messages
 885  */
 886
 887 #define M_COMPLETE      (0x00)
 888 #define M_EXTENDED      (0x01)
 889 #define M_SAVE_DP       (0x02)
 890 #define M_RESTORE_DP    (0x03)
 891 #define M_DISCONNECT    (0x04)
 892 #define M_ID_ERROR      (0x05)
 893 #define M_ABORT         (0x06)
 894 #define M_REJECT        (0x07)
 895 #define M_NOOP          (0x08)
 896 #define M_PARITY        (0x09)
 897 #define M_LCOMPLETE     (0x0a)
 898 #define M_FCOMPLETE     (0x0b)
 899 #define M_RESET         (0x0c)
 900 #define M_ABORT_TAG     (0x0d)
 901 #define M_CLEAR_QUEUE   (0x0e)
 902 #define M_INIT_REC      (0x0f)
 903 #define M_REL_REC       (0x10)
 904 #define M_TERMINATE     (0x11)
 905 #define M_SIMPLE_TAG    (0x20)
 906 #define M_HEAD_TAG      (0x21)
 907 #define M_ORDERED_TAG   (0x22)
 908 #define M_IGN_RESIDUE   (0x23)
 909 #define M_IDENTIFY      (0x80)
 910
 911 #define M_X_MODIFY_DP   (0x00)
 912 #define M_X_SYNC_REQ    (0x01)
 913 #define M_X_WIDE_REQ    (0x03)
 914 #define M_X_PPR_REQ     (0x04)
 915
 916 /*
 917  *      PPR protocol options
 918  */
 919 #define PPR_OPT_IU      (0x01)
 920 #define PPR_OPT_DT      (0x02)
 921 #define PPR_OPT_QAS     (0x04)
 922 #define PPR_OPT_MASK    (0x07)
 923
 924 /*
 925  *      Status
 926  */
 927
 928 #define S_GOOD          (0x00)
 929 #define S_CHECK_COND    (0x02)
 930 #define S_COND_MET      (0x04)
 931 #define S_BUSY          (0x08)
 932 #define S_INT           (0x10)
 933 #define S_INT_COND_MET  (0x14)
 934 #define S_CONFLICT      (0x18)
 935 #define S_TERMINATED    (0x20)
 936 #define S_QUEUE_FULL    (0x28)
 937 #define S_ILLEGAL       (0xff)
 938
 939 #endif /* defined SYM_DEFS_H */