sys/dev/trm/trm.h

   1 /*-
   2  *      File Name : trm.h
   3  *
   4  *      Tekram DC395U/UW/F ,DC315/U
   5  *   PCI SCSI Bus Master Host Adapter Device Driver
   6  *   (SCSI chip set used Tekram ASIC TRM-S1040)
   7  *
   8  * (C)Copyright 1995-2001 Tekram Technology Co.,Ltd.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. The name of the author may not be used to endorse or promote products
  19  *    derived from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef trm_H
  36 #define trm_H
  37
  38 /* SCSI CAM */
  39
  40 #define TRM_TRANS_CUR           0x01    /* Modify current neogtiation status */
  41 #define TRM_TRANS_ACTIVE        0x03    /* Assume this is the active target */
  42 #define TRM_TRANS_GOAL          0x04    /* Modify negotiation goal */
  43 #define TRM_TRANS_USER          0x08    /* Modify user negotiation settings */
  44
  45 struct trm_transinfo {
  46         u_int8_t width;
  47         u_int8_t period;
  48         u_int8_t offset;
  49 };
  50
  51 struct trm_target_info {
  52         u_int8_t                        disc_tag;   /* bits define..... */
  53 #define TRM_CUR_DISCENB 0x01 /* current setting disconnect enable */
  54 #define TRM_CUR_TAGENB 0x02  /* current setting tag command Q enable */
  55 #define TRM_USR_DISCENB 0x04 /* user adapter device setting disconnect enable */
  56 #define TRM_USR_TAGENB 0x08  /* user adapter device setting tag command Q enable*/
  57         struct trm_transinfo    current; /* info of current */
  58         struct trm_transinfo    goal;    /* info of after negotiating */
  59         struct trm_transinfo    user;    /* info of user adapter device setting  */
  60 };
  61 /*
  62  * SCSI CAM  **
  63  */
  64
  65 /*
  66  *      bus_dma_segment_t
  67  *
  68  *      Describes a single contiguous DMA transaction.  Values
  69  *      are suitable for programming into DMA registers.
  70  *
  71  *typedef struct bus_dma_segment
  72  *{
  73  *      bus_addr_t      ds_addr;        // DMA address
  74  *      bus_size_t      ds_len;         // length of transfer
  75  *} bus_dma_segment_t;
  76  */
  77
  78 /*;----------------------Segment Entry------------------------------------*/
  79 typedef  struct  _SGentry {
  80        u_int32_t        address;
  81        u_int32_t        length;
  82 } SGentry, *PSEG;
  83 /*
  84  *-----------------------------------------------------------------------
  85  *     feature of chip set MAX value
  86  *-----------------------------------------------------------------------
  87  */
  88
  89 #define TRM_MAX_ADAPTER_NUM     4
  90 #define TRM_MAX_DEVICES         16
  91 #define TRM_MAX_SG_LISTENTRY    32
  92 #define TRM_MAX_TARGETS         16
  93 #define TRM_MAX_TAGS_CMD_QUEUE  256 /* MAX_CMD_QUEUE    20*/
  94 #define TRM_MAX_CMD_PER_LUN     32
  95 #define TRM_MAX_SRB_CNT         256
  96 #define TRM_MAX_START_JOB       256
  97 #define TRM_NSEG                (btoc(MAXPHYS) + 1)
  98 #define TRM_MAXTRANSFER_SIZE    0xFFFFFF /* restricted by 24 bit counter */
  99 #define PAGELEN                 4096
 100
 101 #define SEL_TIMEOUT             153     /* 250 ms selection timeout (@ 40MHz) */
 102
 103 /*
 104  *  CAM ccb
 105  * Union of all CCB types for kernel space allocation.  This union should
 106  * never be used for manipulating CCBs - its only use is for the allocation
 107  * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
 108  * and the argument to xpt_ccb_free.
 109  *
 110  *union ccb {
 111  *      struct  ccb_hdr                     ccb_h;      // For convenience
 112  *      struct  ccb_scsiio              csio;
 113  *      struct  ccb_getdev              cgd;
 114  *      struct  ccb_getdevlist          cgdl;
 115  *      struct  ccb_pathinq                 cpi;
 116  *      struct  ccb_relsim              crs;
 117  *      struct  ccb_setasync            csa;
 118  *      struct  ccb_setdev              csd;
 119  *      struct  ccb_dev_match           cdm;
 120  *      struct  ccb_trans_settings      cts;
 121  *      struct  ccb_calc_geometry       ccg;
 122  *      struct  ccb_abort               cab;
 123  *      struct  ccb_resetbus            crb;
 124  *      struct  ccb_resetdev            crd;
 125  *      struct  ccb_termio              tio;
 126  *      struct  ccb_accept_tio          atio;
 127  *      struct  ccb_scsiio              ctio;
 128  *      struct  ccb_en_lun              cel;
 129  *      struct  ccb_immed_notify        cin;
 130  *      struct  ccb_notify_ack          cna;
 131  *      struct  ccb_eng_inq             cei;
 132  *      struct  ccb_eng_exec            cee;
 133  *      struct  ccb_rescan              crcn;
 134  *      struct  ccb_debug               cdbg;
 135  *  };
 136  */
 137
 138 /*
 139  *-----------------------------------------------------------------------
 140  *               SCSI Request Block
 141  *-----------------------------------------------------------------------
 142  */
 143 struct  _SRB {
 144         u_int8_t        CmdBlock[12];
 145         u_long          Segment0[2];
 146         u_long          Segment1[2];
 147         struct _SRB     *pNextSRB;
 148         struct _DCB     *pSRBDCB;
 149         SGentry         SgSenseTemp;
 150
 151         PSEG            pSRBSGL;        /* scatter gather list */
 152
 153         u_int32_t       SRBSGPhyAddr;   /* a segment starting address */
 154         u_int32_t       SRBTotalXferLength;
 155
 156         /*
 157          *                CAM ccb
 158          */
 159         union  ccb      *pccb;
 160         bus_dmamap_t    sg_dmamap;
 161         bus_dmamap_t     dmamap;
 162         u_int16_t       SRBState;
 163         u_int8_t *      pMsgPtr;
 164
 165         u_int8_t        SRBSGCount;
 166         u_int8_t        SRBSGIndex;
 167         u_int8_t        MsgInBuf[6];
 168         u_int8_t        MsgOutBuf[6];
 169
 170         u_int8_t        AdaptStatus;
 171         u_int8_t        TargetStatus;
 172         u_int8_t        MsgCnt;
 173         u_int8_t        TagNumber;
 174
 175         u_int8_t        SRBStatus;
 176         u_int8_t        RetryCnt;
 177         u_int8_t        SRBFlag;
 178         u_int8_t        ScsiCmdLen;
 179         u_int8_t        ScsiPhase;
 180         u_int8_t        Reserved[3]; /*;for dword alignment */
 181 };
 182 typedef struct _SRB     TRM_SRB, *PSRB;
 183
 184 /*
 185  *-----------------------------------------------------------------------
 186  *                   Device Control Block
 187  *-----------------------------------------------------------------------
 188  */
 189 struct  _DCB
 190 {
 191         PSRB            pWaitingSRB;
 192         PSRB            pWaitingLastSRB;
 193
 194         PSRB            pGoingSRB;
 195         PSRB            pGoingLastSRB;
 196
 197         PSRB            pActiveSRB;
 198
 199         u_int16_t       GoingSRBCnt;
 200         u_int16_t       MaxActiveCommandCnt;
 201
 202         u_int8_t        TargetID;       /*; SCSI Target ID  (SCSI Only) */
 203         u_int8_t        TargetLUN;      /*; SCSI Log.  Unit (SCSI Only) */
 204         u_int8_t        DCBFlag;
 205         u_int8_t        DevType;
 206
 207         u_int8_t        SyncMode;       /* mode ? (1 sync):(0 async)  */
 208         u_int8_t        MaxNegoPeriod;  /* for nego. */
 209         u_int8_t        SyncPeriod;     /* for reg. */
 210         u_int8_t        SyncOffset;     /* for reg. and nego.(low nibble) */
 211
 212         u_int8_t        DevMode;
 213         u_int8_t        AdpMode;
 214
 215         u_int8_t        IdentifyMsg;
 216         u_int8_t        DCBstatus;      /* DCB status */
 217         /*u_int8_t      Reserved[3];    for dword alignment */
 218         struct          trm_target_info tinfo; /* 10 bytes */
 219         struct _DCB     *pNextDCB;
 220 };
 221 typedef struct _DCB     TRM_DCB, *PDCB;
 222
 223 /*
 224  *-----------------------------------------------------------------------
 225  *                  Adapter Control Block
 226  *-----------------------------------------------------------------------
 227  */
 228 struct  _ACB
 229 {
 230         device_t                dev;
 231
 232         bus_space_tag_t         tag;
 233         bus_space_handle_t      bsh;
 234         bus_dma_tag_t           parent_dmat;
 235         bus_dma_tag_t           buffer_dmat;   /* dmat for buffer I/O */
 236         bus_dma_tag_t           srb_dmat;
 237         bus_dma_tag_t           sense_dmat; /* dmat for sense buffer */
 238         bus_dma_tag_t           sg_dmat;
 239         bus_dmamap_t            sense_dmamap;
 240         bus_dmamap_t            srb_dmamap;
 241         bus_addr_t              sense_busaddr;
 242         struct scsi_sense_data  *sense_buffers;
 243         struct resource         *iores, *irq;
 244         void                    *ih;
 245     /*
 246      *            CAM SIM/XPT
 247      */
 248         struct                  cam_sim  *psim;
 249         struct                  cam_path *ppath;
 250
 251         TRM_SRB                 TmpSRB;
 252         TRM_DCB                 DCBarray[16][8];
 253
 254         u_int32_t               srb_physbase;
 255
 256         PSRB                    pFreeSRB;
 257         PDCB                    pActiveDCB;
 258
 259         PDCB                    pLinkDCB;
 260         PDCB                    pDCBRunRobin;
 261
 262         u_int16_t               max_id;
 263         u_int16_t               max_lun;
 264
 265         u_int8_t                msgin123[4];
 266
 267         u_int8_t                scan_devices[16][8];
 268
 269         u_int8_t                AdaptSCSIID;    /*; Adapter SCSI Target ID */
 270         u_int8_t                AdaptSCSILUN;   /*; Adapter SCSI LUN */
 271         u_int8_t                DeviceCnt;
 272         u_int8_t                ACBFlag;
 273
 274         u_int8_t                TagMaxNum;
 275         u_int8_t                Config;
 276         u_int8_t                AdaptType;
 277         u_int8_t                AdapterUnit;    /* nth Adapter this driver */
 278 };
 279 typedef struct  _ACB             TRM_ACB, *PACB;
 280 /*
 281  *   ----SRB State machine definition
 282  */
 283 #define SRB_FREE                        0x0000
 284 #define SRB_WAIT                        0x0001
 285 #define SRB_READY                       0x0002
 286 #define SRB_MSGOUT                      0x0004  /*arbitration+msg_out 1st byte*/
 287 #define SRB_MSGIN                       0x0008
 288 #define SRB_EXTEND_MSGIN                0x0010
 289 #define SRB_COMMAND                     0x0020
 290 #define SRB_START_                      0x0040  /*arbitration+msg_out+command_out*/
 291 #define SRB_DISCONNECT                  0x0080
 292 #define SRB_DATA_XFER                   0x0100
 293 #define SRB_XFERPAD                     0x0200
 294 #define SRB_STATUS                      0x0400
 295 #define SRB_COMPLETED                   0x0800
 296 #define SRB_ABORT_SENT                  0x1000
 297 #define SRB_DO_SYNC_NEGO                0x2000
 298 #define SRB_DO_WIDE_NEGO                0x4000
 299 #define SRB_UNEXPECT_RESEL              0x8000
 300 /*
 301  *
 302  *      ACB Config
 303  *
 304  */
 305 #define HCC_WIDE_CARD                   0x20
 306 #define HCC_SCSI_RESET                  0x10
 307 #define HCC_PARITY                      0x08
 308 #define HCC_AUTOTERM                    0x04
 309 #define HCC_LOW8TERM                    0x02
 310 #define HCC_UP8TERM                     0x01
 311 /*
 312  *   ---ACB Flag
 313  */
 314 #define RESET_DEV                       0x00000001
 315 #define RESET_DETECT                    0x00000002
 316 #define RESET_DONE                      0x00000004
 317
 318 /*
 319  *   ---DCB Flag
 320  */
 321 #define ABORT_DEV_                      0x00000001
 322
 323 /*
 324  *   ---DCB status
 325  */
 326 #define DS_IN_QUEUE                     0x00000001
 327
 328 /*
 329  *   ---SRB status
 330  */
 331 #define SRB_OK                          0x00000001
 332 #define ABORTION                        0x00000002
 333 #define OVER_RUN                        0x00000004
 334 #define UNDER_RUN                       0x00000008
 335 #define PARITY_ERROR                    0x00000010
 336 #define SRB_ERROR                       0x00000020
 337
 338 /*
 339  *   ---SRB Flag
 340  */
 341 #define DATAOUT                         0x00000080
 342 #define DATAIN                          0x00000040
 343 #define RESIDUAL_VALID                  0x00000020
 344 #define ENABLE_TIMER                    0x00000010
 345 #define RESET_DEV0                      0x00000004
 346 #define ABORT_DEV                       0x00000002
 347 #define AUTO_REQSENSE                   0x00000001
 348
 349 /*
 350  *   ---Adapter status
 351  */
 352 #define H_STATUS_GOOD                   0x00
 353 #define H_SEL_TIMEOUT                   0x11
 354 #define H_OVER_UNDER_RUN                0x12
 355 #define H_UNEXP_BUS_FREE                0x13
 356 #define H_TARGET_PHASE_F                0x14
 357 #define H_INVALID_CCB_OP                0x16
 358 #define H_LINK_CCB_BAD                  0x17
 359 #define H_BAD_TARGET_DIR                0x18
 360 #define H_DUPLICATE_CCB                 0x19
 361 #define H_BAD_CCB_OR_SG                 0x1A
 362 #define H_ABORT                         0x0FF
 363
 364 /*
 365  *   ---SCSI Status byte codes
 366  */
 367 #define SCSI_STAT_GOOD                  0x00    /*;  Good status */
 368 #define SCSI_STAT_CHECKCOND             0x02    /*;  SCSI Check Condition */
 369 #define SCSI_STAT_CONDMET               0x04    /*;  Condition Met */
 370 #define SCSI_STAT_BUSY                  0x08    /*;  Target busy status */
 371 #define SCSI_STAT_INTER                 0x10    /*;  Intermediate status */
 372 #define SCSI_STAT_INTERCONDMET          0x14    /*;  Intermediate condition met */
 373 #define SCSI_STAT_RESCONFLICT           0x18    /*;  Reservation conflict */
 374 #define SCSI_STAT_CMDTERM               0x22    /*;  Command Terminated */
 375 #define SCSI_STAT_QUEUEFULL             0x28    /*;  Queue Full */
 376 #define SCSI_STAT_UNEXP_BUS_F           0xFD    /*;  Unexpect Bus Free */
 377 #define SCSI_STAT_BUS_RST_DETECT        0xFE    /*;  Scsi Bus Reset detected */
 378 #define SCSI_STAT_SEL_TIMEOUT           0xFF    /*;  Selection Time out */
 379
 380 /*
 381  *   ---Sync_Mode
 382  */
 383 #define SYNC_WIDE_TAG_ATNT_DISABLE      0x00000000
 384 #define SYNC_NEGO_ENABLE                0x00000001
 385 #define SYNC_NEGO_DONE                  0x00000002
 386 #define WIDE_NEGO_ENABLE                0x00000004
 387 #define WIDE_NEGO_DONE                  0x00000008
 388 #define EN_TAG_QUEUING                  0x00000010
 389 #define EN_ATN_STOP                     0x00000020
 390
 391 #define SYNC_NEGO_OFFSET                15
 392 /*
 393  *    ---SCSI bus phase
 394  */
 395 #define SCSI_DATA_OUT_                  0
 396 #define SCSI_DATA_IN_                   1
 397 #define SCSI_COMMAND                    2
 398 #define SCSI_STATUS_                    3
 399 #define SCSI_NOP0                       4
 400 #define SCSI_NOP1                       5
 401 #define SCSI_MSG_OUT                    6
 402 #define SCSI_MSG_IN                     7
 403
 404 /*
 405  *     ----SCSI MSG u_int8_t
 406  */
 407 #define MSG_COMPLETE                    0x00
 408 #define MSG_EXTENDED                    0x01
 409 #define MSG_SAVE_PTR                    0x02
 410 #define MSG_RESTORE_PTR                 0x03
 411 #define MSG_DISCONNECT                  0x04
 412 #define MSG_INITIATOR_ERROR             0x05
 413 #define MSG_ABORT                       0x06
 414 #define MSG_REJECT_                     0x07
 415 #define MSG_NOP                         0x08
 416 #define MSG_PARITY_ERROR                0x09
 417 #define MSG_LINK_CMD_COMPL              0x0A
 418 #define MSG_LINK_CMD_COMPL_FLG          0x0B
 419 #define MSG_BUS_RESET                   0x0C
 420 /* #define MSG_ABORT_TAG                0x0D */
 421 #define MSG_SIMPLE_QTAG                 0x20
 422 #define MSG_HEAD_QTAG                   0x21
 423 #define MSG_ORDER_QTAG                  0x22
 424 #define MSG_IGNOREWIDE                  0x23
 425 /* #define MSG_IDENTIFY                 0x80 */
 426 #define MSG_HOST_ID                     0xC0
 427 /*     bus wide length     */
 428 #define MSG_EXT_WDTR_BUS_8_BIT          0x00
 429 #define MSG_EXT_WDTR_BUS_16_BIT         0x01
 430 #define MSG_EXT_WDTR_BUS_32_BIT         0x02
 431 /*
 432  *     ----SCSI STATUS u_int8_t
 433  */
 434 #define STATUS_GOOD                     0x00
 435 #define CHECK_CONDITION_                0x02
 436 #define STATUS_BUSY                     0x08
 437 #define STATUS_INTERMEDIATE             0x10
 438 #define RESERVE_CONFLICT                0x18
 439
 440 /*
 441  *     ---- cmd->result
 442  */
 443 #define STATUS_MASK_                    0xFF
 444 #define MSG_MASK                        0xFF00
 445 #define RETURN_MASK                     0xFF0000
 446
 447 /*
 448  *  Inquiry Data format
 449  */
 450
 451 typedef struct  _SCSIInqData { /* INQ */
 452
 453         u_int8_t         DevType;       /* Periph Qualifier & Periph Dev Type */
 454         u_int8_t         RMB_TypeMod;   /* rem media bit & Dev Type Modifier  */
 455         u_int8_t         Vers;          /* ISO, ECMA, & ANSI versions         */
 456         u_int8_t         RDF;           /* AEN, TRMIOP, & response data format*/
 457         u_int8_t         AddLen;        /* length of additional data          */
 458         u_int8_t         Res1;          /* reserved                           */
 459         u_int8_t         Res2;          /* reserved                           */
 460         u_int8_t         Flags;         /* RelADr,Wbus32,Wbus16,Sync,etc.     */
 461         u_int8_t         VendorID[8];   /* Vendor Identification              */
 462         u_int8_t         ProductID[16]; /* Product Identification          */
 463         u_int8_t         ProductRev[4]; /* Product Revision              */
 464 } SCSI_INQDATA, *PSCSI_INQDATA;
 465
 466
 467 /*
 468  *      Inquiry byte 0 masks
 469  */
 470 #define SCSI_DEVTYPE              0x1F    /* Peripheral Device Type         */
 471 #define SCSI_PERIPHQUAL           0xE0      /* Peripheral Qualifier         */
 472 /*
 473  *      Inquiry byte 1 mask
 474  */
 475 #define SCSI_REMOVABLE_MEDIA      0x80    /* Removable Media bit (1=removable)  */
 476 /*
 477  *      Peripheral Device Type definitions
 478  */
 479 #define SCSI_DASD                 0x00     /* Direct-access Device        */
 480 #define SCSI_SEQACESS             0x01     /* Sequential-access device    */
 481 #define SCSI_PRINTER              0x02     /* Printer device              */
 482 #define SCSI_PROCESSOR            0x03     /* Processor device            */
 483 #define SCSI_WRITEONCE            0x04     /* Write-once device           */
 484 #define SCSI_CDROM                0x05     /* CD-ROM device               */
 485 #define SCSI_SCANNER              0x06     /* Scanner device              */
 486 #define SCSI_OPTICAL              0x07     /* Optical memory device       */
 487 #define SCSI_MEDCHGR              0x08     /* Medium changer device       */
 488 #define SCSI_COMM                 0x09     /* Communications device       */
 489 #define SCSI_NODEV                0x1F     /* Unknown or no device type   */
 490 /*
 491  *      Inquiry flag definitions (Inq data byte 7)
 492  */
 493 #define SCSI_INQ_RELADR       0x80    /* device supports relative addressing*/
 494 #define SCSI_INQ_WBUS32       0x40    /* device supports 32 bit data xfers  */
 495 #define SCSI_INQ_WBUS16       0x20    /* device supports 16 bit data xfers  */
 496 #define SCSI_INQ_SYNC         0x10    /* device supports synchronous xfer   */
 497 #define SCSI_INQ_LINKED       0x08    /* device supports linked commands    */
 498 #define SCSI_INQ_CMDQUEUE     0x02    /* device supports command queueing   */
 499 #define SCSI_INQ_SFTRE        0x01    /* device supports soft resets */
 500 /*
 501  *==========================================================
 502  *                EEPROM byte offset
 503  *==========================================================
 504  */
 505 typedef  struct  _EEprom {
 506         u_int8_t        EE_MODE1;
 507         u_int8_t        EE_SPEED;
 508         u_int8_t        xx1;
 509         u_int8_t        xx2;
 510 } EEprom, *PEEprom;
 511
 512 #define EE_ADAPT_SCSI_ID        64
 513 #define EE_MODE2                65
 514 #define EE_DELAY                66
 515 #define EE_TAG_CMD_NUM          67
 516
 517 /*
 518  *    EE_MODE1 bits definition
 519  */
 520 #define PARITY_CHK_             0x00000001
 521 #define SYNC_NEGO_              0x00000002
 522 #define EN_DISCONNECT_          0x00000004
 523 #define SEND_START_             0x00000008
 524 #define TAG_QUEUING_            0x00000010
 525
 526 /*
 527  *    EE_MODE2 bits definition
 528  */
 529 #define MORE2_DRV               0x00000001
 530 #define GREATER_1G              0x00000002
 531 #define RST_SCSI_BUS            0x00000004
 532 #define ACTIVE_NEGATION         0x00000008
 533 #define NO_SEEK                 0x00000010
 534 #define LUN_CHECK               0x00000020
 535
 536 #define ENABLE_CE               0x01
 537 #define DISABLE_CE              0x00
 538 #define EEPROM_READ             0x80
 539
 540 /*
 541  * The PCI configuration register offset for TRM_S1040
 542  *                  Registers bit Definition
 543  */
 544 #define     TRMREG_ID           0x00    /* Vendor and Device ID         */
 545 #define     TRMREG_COMMAND      0x04    /* PCI command register         */
 546 #define     TRMREG_IOBASE       0x10    /* I/O Space base address       */
 547 #define     TRMREG_ROMBASE      0x30    /* Expansion ROM Base Address   */
 548 #define     TRMREG_INTLINE      0x3C    /* Interrupt line               */
 549
 550 /*
 551  *
 552  * The SCSI register offset for TRM_S1040
 553  *
 554  */
 555 #define TRMREG_SCSI_STATUS      0x80    /* SCSI Status (R)              */
 556 /* ######### */
 557 #define     COMMANDPHASEDONE    0x2000  /* SCSI command phase done      */
 558 #define     SCSIXFERDONE            0x0800  /* SCSI SCSI transfer done  */
 559 #define     SCSIXFERCNT_2_ZERO  0x0100  /* SCSI SCSI transfer count to zero*/
 560 #define     SCSIINTERRUPT       0x0080  /* SCSI interrupt pending       */
 561 #define     COMMANDABORT        0x0040  /* SCSI command abort           */
 562 #define     SEQUENCERACTIVE     0x0020  /* SCSI sequencer active        */
 563 #define     PHASEMISMATCH       0x0010  /* SCSI phase mismatch          */
 564 #define     PARITYERROR         0x0008  /* SCSI parity error            */
 565
 566 #define     PHASEMASK           0x0007  /* Phase MSG/CD/IO              */
 567 #define         PH_DATA_OUT             0x00    /* Data out phase       */
 568 #define         PH_DATA_IN              0x01    /* Data in phase        */
 569 #define         PH_COMMAND              0x02    /* Command phase        */
 570 #define         PH_STATUS               0x03    /* Status phase         */
 571 #define         PH_BUS_FREE             0x05    /* Invalid phase used as bus free       */
 572 #define         PH_MSG_OUT              0x06    /* Message out phase    */
 573 #define         PH_MSG_IN               0x07    /* Message in phase     */
 574
 575 #define TRMREG_SCSI_CONTROL     0x80    /* SCSI Control (W)             */
 576 /* ######### */
 577 #define     DO_CLRATN           0x0400  /* Clear ATN                    */
 578 #define     DO_SETATN           0x0200  /* Set ATN                      */
 579 #define     DO_CMDABORT         0x0100  /* Abort SCSI command           */
 580 #define     DO_RSTMODULE        0x0010  /* Reset SCSI chip              */
 581 #define     DO_RSTSCSI          0x0008  /* Reset SCSI bus               */
 582 #define     DO_CLRFIFO          0x0004  /* Clear SCSI transfer FIFO     */
 583 #define     DO_DATALATCH        0x0002  /* Enable SCSI bus data latch   */
 584 #define     DO_HWRESELECT       0x0001  /* Enable hardware reselection  */
 585 #define TRMREG_SCSI_FIFOCNT     0x82    /* SCSI FIFO Counter 5bits(R)   */
 586 #define TRMREG_SCSI_SIGNAL      0x83    /* SCSI low level signal (R/W)  */
 587 #define TRMREG_SCSI_INTSTATUS   0x84    /* SCSI Interrupt Status (R)    */
 588 /* ######### */
 589 #define     INT_SCAM            0x80    /* SCAM selection interrupt     */
 590 #define     INT_SELECT          0x40    /* Selection interrupt          */
 591 #define     INT_SELTIMEOUT      0x20    /* Selection timeout interrupt  */
 592 #define     INT_DISCONNECT      0x10    /* Bus disconnected interrupt   */
 593 #define     INT_RESELECTED      0x08    /* Reselected interrupt         */
 594 #define     INT_SCSIRESET       0x04    /* SCSI reset detected interrupt*/
 595 #define     INT_BUSSERVICE      0x02    /* Bus service interrupt        */
 596 #define     INT_CMDDONE         0x01    /* SCSI command done interrupt  */
 597 #define TRMREG_SCSI_OFFSET      0x84    /* SCSI Offset Count (W)        */
 598 /*
 599  *   Bit                Name            Definition
 600  *   07-05      0       RSVD            Reversed. Always 0.
 601  *   04         0       OFFSET4         Reversed for LVDS. Always 0.
 602  *   03-00      0       OFFSET[03:00]   Offset number from 0 to 15
 603  */
 604 #define TRMREG_SCSI_SYNC        0x85    /* SCSI Synchronous Control (R/W)*/
 605 /* ######### */
 606 #define     LVDS_SYNC           0x20    /* Enable LVDS synchronous       */
 607 #define     WIDE_SYNC           0x10    /* Enable WIDE synchronous       */
 608 #define     ALT_SYNC            0x08    /* Enable Fast-20 alternate synchronous */
 609 /*
 610  * SYNCM        7    6    5        4    3       2       1       0
 611  * Name         RSVD RSVD LVDS WIDE     ALTPERD PERIOD2 PERIOD1 PERIOD0
 612  * Default      0        0        0        0    0           0       0       0
 613  *
 614  *
 615  * Bit              Name                        Definition
 616  * 07-06        0       RSVD                    Reversed. Always read 0
 617  * 05           0       LVDS                    Reversed. Always read 0
 618  * 04           0       WIDE/WSCSI              Enable wide (16-bits) SCSI transfer.
 619  * 03           0       ALTPERD/ALTPD           Alternate (Sync./Period) mode.
 620  *
 621  *                                      @@ When this bit is set,
 622  *                                         the synchronous period bits 2:0
 623  *                                         in the Synchronous Mode register
 624  *                                         are used to transfer data
 625  *                                         at the Fast-20 rate.
 626  *                                      @@ When this bit is reset,
 627  *                                         the synchronous period bits 2:0
 628  *                                         in the Synchronous Mode Register
 629  *                                         are used to transfer data
 630  *                                         at the Fast-40 rate.
 631  *
 632  * 02-00        0       PERIOD[2:0]/SXPD[02:00] Synchronous SCSI Transfer Rate.
 633  *                                      These 3 bits specify
 634  *                                      the Synchronous SCSI Transfer Rate
 635  *                                      for Fast-20 and Fast-10.
 636  *                                      These bits are also reset
 637  *                                      by a SCSI Bus reset.
 638  *
 639  * For Fast-10 bit ALTPD = 0 and LVDS = 0
 640  *     and 0x00000004,0x00000002,0x00000001 is defined as follows :
 641  *
 642  *         000  100ns, 10.0 Mbytes/s
 643  *         001  150ns,  6.6 Mbytes/s
 644  *         010  200ns,  5.0 Mbytes/s
 645  *         011  250ns,  4.0 Mbytes/s
 646  *         100  300ns,  3.3 Mbytes/s
 647  *         101  350ns,  2.8 Mbytes/s
 648  *             110      400ns,  2.5 Mbytes/s
 649  *             111      450ns,  2.2 Mbytes/s
 650  *
 651  * For Fast-20 bit ALTPD = 1 and LVDS = 0
 652  *     and 0x00000004,0x00000002,0x00000001 is defined as follows :
 653  *
 654  *             000       50ns, 20.0 Mbytes/s
 655  *             001       75ns, 13.3 Mbytes/s
 656  *             010      100ns, 10.0 Mbytes/s
 657  *             011      125ns,  8.0 Mbytes/s
 658  *             100      150ns,  6.6 Mbytes/s
 659  *             101      175ns,  5.7 Mbytes/s
 660  *             110      200ns,  5.0 Mbytes/s
 661  *             111      250ns,  4.0 Mbytes/s
 662  *
 663  * For Fast-40 bit ALTPD = 0 and LVDS = 1
 664  *     and 0x00000004,0x00000002,0x00000001 is defined as follows :
 665  *
 666  *             000       25ns, 40.0 Mbytes/s
 667  *             001       50ns, 20.0 Mbytes/s
 668  *             010       75ns, 13.3 Mbytes/s
 669  *             011      100ns, 10.0 Mbytes/s
 670  *             100      125ns,  8.0 Mbytes/s
 671  *             101      150ns,  6.6 Mbytes/s
 672  *             110      175ns,  5.7 Mbytes/s
 673  *             111      200ns,  5.0 Mbytes/s
 674  */
 675
 676 /*
 677  ***************************************
 678  */
 679 #define TRMREG_SCSI_TARGETID    0x86    /* SCSI Target ID (R/W)         */
 680 /*
 681  ***************************************
 682  */
 683 #define TRMREG_SCSI_IDMSG       0x87    /* SCSI Identify Message (R)    */
 684 /*
 685  ***************************************
 686  */
 687 #define TRMREG_SCSI_HOSTID      0x87    /* SCSI Host ID (W)             */
 688 /*
 689  ***************************************
 690  */
 691 #define TRMREG_SCSI_COUNTER     0x88    /* SCSI Transfer Counter 24bits(R/W)*/
 692 /*
 693  ***************************************
 694  */
 695 #define TRMREG_SCSI_INTEN       0x8C    /* SCSI Interrupt Enable (R/W)   */
 696 /* ######### */
 697 #define     EN_SCAM             0x80    /* Enable SCAM selection interrupt*/
 698 #define     EN_SELECT           0x40    /* Enable selection interrupt     */
 699 #define     EN_SELTIMEOUT       0x20    /* Enable selection timeout interrupt*/
 700 #define     EN_DISCONNECT       0x10    /* Enable bus disconnected interrupt*/
 701 #define     EN_RESELECTED       0x08    /* Enable reselected interrupt   */
 702 #define     EN_SCSIRESET        0x04    /* Enable SCSI reset detected interrupt*/
 703 #define     EN_BUSSERVICE       0x02    /* Enable bus service interrupt  */
 704 #define     EN_CMDDONE          0x01    /* Enable SCSI command done interrupt*/
 705 /*
 706  ***************************************
 707  */
 708 #define TRMREG_SCSI_CONFIG0     0x8D    /* SCSI Configuration 0 (R/W)   */
 709 /* ######### */
 710 #define     PHASELATCH          0x40    /* Enable phase latch           */
 711 #define     INITIATOR           0x20    /* Enable initiator mode        */
 712 #define     PARITYCHECK         0x10    /* Enable parity check          */
 713 #define     BLOCKRST            0x01    /* Disable SCSI reset1          */
 714 /*
 715  ***************************************
 716  */
 717 #define TRMREG_SCSI_CONFIG1     0x8E    /* SCSI Configuration 1 (R/W)   */
 718 /* ######### */
 719 #define     ACTIVE_NEGPLUS      0x10    /* Enhance active negation      */
 720 #define     FILTER_DISABLE      0x08    /* Disable SCSI data filter     */
 721 #define     ACTIVE_NEG          0x02    /* Enable active negation       */
 722 #define     ACTIVE_HISLEW       0x01    /* Enable high slew rate (3/6 ns) */
 723 /*
 724  ***************************************
 725  */
 726 #define TRMREG_SCSI_CONFIG2     0x8F    /* SCSI Configuration 2 (R/W)   */
 727 /*
 728  ***************************************
 729  */
 730 #define TRMREG_SCSI_COMMAND     0x90    /* SCSI Command (R/W)           */
 731 /* ######### */
 732 #define     SCMD_COMP           0x12    /* Command complete             */
 733 #define     SCMD_SEL_ATN        0x60    /* Selection with ATN           */
 734 #define     SCMD_SEL_ATN3       0x64    /* Selection with ATN3          */
 735 #define     SCMD_SEL_ATNSTOP    0xB8    /* Selection with ATN and Stop  */
 736 #define     SCMD_FIFO_OUT       0xC0    /* SCSI FIFO transfer out       */
 737 #define     SCMD_DMA_OUT        0xC1    /* SCSI DMA transfer out        */
 738 #define     SCMD_FIFO_IN        0xC2    /* SCSI FIFO transfer in        */
 739 #define     SCMD_DMA_IN         0xC3    /* SCSI DMA transfer in         */
 740 #define     SCMD_MSGACCEPT      0xD8    /* Message accept               */
 741 /*
 742  *  Code        Command Description
 743  *
 744  *  02      Enable reselection with FIFO
 745  *  40          Select without ATN with FIFO
 746  *  60          Select with ATN with FIFO
 747  *  64          Select with ATN3 with FIFO
 748  *  A0          Select with ATN and stop with FIFO
 749  *  C0          Transfer information out with FIFO
 750  *  C1          Transfer information out with DMA
 751  *  C2          Transfer information in with FIFO
 752  *  C3          Transfer information in with DMA
 753  *  12          Initiator command complete with FIFO
 754  *  50          Initiator transfer information out sequence without ATN with FIFO
 755  *  70          Initiator transfer information out sequence with ATN with FIFO
 756  *  74          Initiator transfer information out sequence with ATN3 with FIFO
 757  *  52          Initiator transfer information in sequence without ATN with FIFO
 758  *  72          Initiator transfer information in sequence with ATN with FIFO
 759  *  76      Initiator transfer information in sequence with ATN3 with FIFO
 760  *  90          Initiator transfer information out command complete with FIFO
 761  *  92          Initiator transfer information in command complete with FIFO
 762  *  D2          Enable selection
 763  *  08          Reselection
 764  *  48          Disconnect command with FIFO
 765  *  88          Terminate command with FIFO
 766  *  C8          Target command complete with FIFO
 767  *  18          SCAM Arbitration/ Selection
 768  *  5A          Enable reselection
 769  *  98          Select without ATN with FIFO
 770  *  B8          Select with ATN with FIFO
 771  *  D8          Message Accepted
 772  *  58          NOP
 773  */
 774 /*
 775  ***************************************
 776  */
 777 #define TRMREG_SCSI_TIMEOUT     0x91    /* SCSI Time Out Value (R/W)    */
 778 /*
 779  ***************************************
 780  */
 781 #define TRMREG_SCSI_FIFO        0x98    /* SCSI FIFO (R/W)              */
 782 /*
 783  ***************************************
 784  */
 785 #define     TRMREG_SCSI_TCR00           0x9C    /* SCSI Target Control 0 (R/W)  */
 786 /* ######### */
 787 #define     TCR0_DO_WIDE_NEGO           0x80    /* Do wide NEGO                 */
 788 #define     TCR0_DO_SYNC_NEGO           0x40    /* Do sync NEGO                 */
 789 #define     TCR0_DISCONNECT_EN          0x20    /* Disconnection enable         */
 790 #define     TCR0_OFFSET_MASK            0x1F    /* Offset number                */
 791 /*
 792  ***************************************
 793  */
 794 #define     TRMREG_SCSI_TCR01           0x9D    /* SCSI Target Control 0 (R/W)  */
 795 /* ######### */
 796 #define     TCR0_ENABLE_LVDS            0xF8    /* LVD                          */
 797 #define     TCR0_ENABLE_WIDE            0xF9    /* SE                           */
 798 /*
 799 ****************************************
 800 */
 801
 802 /*
 803  ***************************************
 804  */
 805 #define TRMREG_SCSI_TCR1        0x9E    /* SCSI Target Control 1 (R/W)  */
 806 /* ######### */
 807 #define     MAXTAG_MASK         0x7F00  /* Maximum tags (127)           */
 808 #define     NON_TAG_BUSY        0x0080  /* Non tag command active       */
 809 #define     ACTTAG_MASK         0x007F  /* Active tags                  */
 810 /*
 811  *
 812  * The DMA register offset for TRM_S1040
 813  *
 814  */
 815 #define TRMREG_DMA_COMMAND      0xA0    /* DMA Command (R/W)                    */
 816 /* ######### */
 817 #define     XFERDATAIN          0x0103  /* Transfer data in             */
 818 #define     XFERDATAOUT         0x0102  /* Transfer data out            */
 819 /*
 820  ***************************************
 821  */
 822 #define TRMREG_DMA_FIFOCNT      0xA1    /* DMA FIFO Counter (R)         */
 823 /*
 824  ***************************************
 825  */
 826 #define TRMREG_DMA_CONTROL      0xA1    /* DMA Control (W)              */
 827 /* ######### */
 828 #define     STOPDMAXFER         0x08    /* Stop  DMA transfer           */
 829 #define     ABORTXFER           0x04    /* Abort DMA transfer           */
 830 #define     CLRXFIFO            0x02    /* Clear DMA transfer FIFO      */
 831 #define     STARTDMAXFER        0x01    /* Start DMA transfer           */
 832 /*
 833  ***************************************
 834  */
 835 #define TRMREG_DMA_STATUS       0xA3    /* DMA Interrupt Status (R/W)   */
 836 /* ######### */
 837 #define     XFERPENDING         0x80    /* Transfer pending             */
 838 #define     DMAXFERCOMP         0x02    /* Bus Master XFER Complete status  */
 839 #define     SCSICOMP            0x01    /* SCSI complete interrupt      */
 840 /*
 841  ***************************************
 842  */
 843 #define TRMREG_DMA_INTEN            0xA4        /* DMA Interrupt Enable (R/W)*/
 844 /* ######### */
 845 #define     EN_SCSIINTR         0x01    /* Enable SCSI complete interrupt   */
 846 /*
 847  ***************************************
 848  */
 849 #define TRMREG_DMA_CONFIG       0xA6    /* DMA Configuration (R/W)      */
 850 /* ######### */
 851 #define     DMA_ENHANCE         0x8000  /* Enable DMA enhance feature   */
 852 /*
 853  ***************************************
 854  */
 855 #define TRMREG_DMA_XCNT             0xA8        /* DMA Transfer Counter (R/W)*/
 856 /*
 857  ***************************************
 858  */
 859 #define TRMREG_DMA_CXCNT            0xAC        /* DMA Current Transfer Counter (R) */
 860 /*
 861  ***************************************
 862  */
 863 #define TRMREG_DMA_XLOWADDR     0xB0    /* DMA Transfer Physical Low Address  */
 864 /*
 865  ***************************************
 866  */
 867 #define TRMREG_DMA_XHIGHADDR    0xB4    /* DMA Transfer Physical High Address */
 868
 869 /*
 870  *
 871  * The general register offset for TRM_S1040
 872  *
 873  */
 874 #define TRMREG_GEN_CONTROL      0xD4    /* Global Control               */
 875 /* ######### */
 876 #define     EN_EEPROM           0x10    /* Enable EEPROM programming    */
 877 #define     AUTOTERM            0x04    /* Enable Auto SCSI terminator  */
 878 #define     LOW8TERM            0x02    /* Enable Lower 8 bit SCSI terminator */
 879 #define     UP8TERM                 0x01        /* Enable Upper 8 bit SCSI terminator */
 880 /*
 881  ***************************************
 882  */
 883 #define TRMREG_GEN_STATUS       0xD5    /* Global Status                */
 884 /* ######### */
 885 #define     GTIMEOUT            0x80    /* Global timer reach 0         */
 886 #define     CON5068             0x10    /* External 50/68 pin connected */
 887 #define     CON68               0x08    /* Internal 68 pin connected    */
 888 #define     CON50               0x04    /* Internal 50 pin connected    */
 889 #define     WIDESCSI            0x02    /* Wide SCSI card               */
 890 /*
 891  ***************************************
 892  */
 893 #define TRMREG_GEN_NVRAM        0xD6    /* Serial NON-VOLATILE RAM port */
 894 /* ######### */
 895 #define     NVR_BITOUT          0x08    /* Serial data out              */
 896 #define     NVR_BITIN           0x04    /* Serial data in               */
 897 #define     NVR_CLOCK           0x02    /* Serial clock                 */
 898 #define     NVR_SELECT          0x01    /* Serial select                */
 899 /*
 900  ***************************************
 901  */
 902 #define TRMREG_GEN_EDATA        0xD7    /* Parallel EEPROM data port    */
 903 /*
 904  ***************************************
 905  */
 906 #define TRMREG_GEN_EADDRESS     0xD8    /* Parallel EEPROM address      */
 907 /*
 908  ***************************************
 909  */
 910 #define TRMREG_GEN_TIMER        0xDB    /* Global timer                 */
 911
 912 /*
 913  * The SEEPROM structure for TRM_S1040
 914  */
 915 typedef struct NVRAM_TARGET_STRUCT
 916 {
 917         u_int8_t        NvmTarCfg0;     /* Target configuration byte 0  */
 918         u_int8_t        NvmTarPeriod;   /* Target period                */
 919         u_int8_t        NvmTarCfg2;     /* Target configuration byte 2  */
 920         u_int8_t        NvmTarCfg3;     /* Target configuration byte 3  */
 921 } NVRAMTARGETTYPE;
 922 /*   NvmTarCfg0: Target configuration byte 0 :..pDCB->DevMode */
 923 #define NTC_DO_WIDE_NEGO            0x20    /* Wide negotiate           */
 924 #define NTC_DO_TAG_QUEUING      0x10    /* Enable SCSI tag queuing      */
 925 #define NTC_DO_SEND_START       0x08    /* Send start command SPINUP*/
 926 #define NTC_DO_DISCONNECT       0x04    /* Enable SCSI disconnect       */
 927 #define NTC_DO_SYNC_NEGO        0x02    /* Sync negotiation             */
 928 #define NTC_DO_PARITY_CHK       0x01    /* (it sould define at NAC )
 929                                            Parity check enable          */
 930
 931 /*
 932  *
 933  *
 934  *
 935  */
 936 typedef struct NVRAM_STRUC {
 937         u_int8_t        NvramSubVendorID[2];     /*0,1  Sub Vendor ID    */
 938         u_int8_t        NvramSubSysID[2];            /*2,3  Sub System ID*/
 939         u_int8_t        NvramSubClass;               /*4    Sub Class   */
 940         u_int8_t        NvramVendorID[2];            /*5,6  Vendor ID   */
 941         u_int8_t        NvramDeviceID[2];            /*7,8  Device ID   */
 942         u_int8_t        NvramReserved;               /*9    Reserved    */
 943         NVRAMTARGETTYPE NvramTarget[TRM_MAX_TARGETS];/*                                                                           *10,11,12,13
 944                                                   *14,15,16,17                                                                    * ....
 945                                                   * ....
 946                                                   *70,71,72,73
 947                                                   */
 948         u_int8_t        NvramScsiId;       /*74 Host Adapter SCSI ID    */
 949         u_int8_t        NvramChannelCfg;   /*75 Channel configuration   */
 950         u_int8_t        NvramDelayTime;    /*76 Power on delay time     */
 951         u_int8_t        NvramMaxTag;       /*77 Maximum tags            */
 952         u_int8_t        NvramReserved0;    /*78  */
 953         u_int8_t        NvramBootTarget;   /*79  */
 954         u_int8_t        NvramBootLun;      /*80  */
 955         u_int8_t        NvramReserved1;    /*81  */
 956         u_int16_t       Reserved[22];      /*82,..125 */
 957         u_int16_t       NvramCheckSum;     /*126,127*/
 958 } NVRAMTYPE,*PNVRAMTYPE;
 959 /* Nvram Initiater bits definition */
 960 #define MORE2_DRV               0x00000001
 961 #define GREATER_1G              0x00000002
 962 #define RST_SCSI_BUS            0x00000004
 963 #define ACTIVE_NEGATION         0x00000008
 964 #define NO_SEEK                 0x00000010
 965 #define LUN_CHECK               0x00000020
 966
 967 /* Nvram Adapter NvramChannelCfg bits definition */
 968 #define NAC_SCANLUN                     0x20    /* Include LUN as BIOS device*/
 969 #define NAC_POWERON_SCSI_RESET          0x04    /* Power on reset enable     */
 970 #define NAC_GREATER_1G                   0x02   /* > 1G support enable       */
 971 #define NAC_GT2DRIVES                   0x01    /* Support more than 2 drives*/
 972 /*
 973  *#define NAC_DO_PARITY_CHK             0x08    // Parity check enable
 974  */
 975
 976 #endif /* trm_H */