/*      $NetBSD: ncr53c9xreg.h,v 1.16 2009/09/07 13:31:44 tsutsui Exp $ */

/*
* Copyright (c) 1994 Peter Galbavy.  All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
*    must display the following acknowledgement:
*      This product includes software developed by Peter Galbavy.
* 4. The name of the author may not be used to endorse or promote products
*    derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/*
* Register addresses, relative to some base address
*/

#define NCR_TCL         0x00            /* RW - Transfer Count Low      */
#define NCR_TCM         0x01            /* RW - Transfer Count Mid      */
#define NCR_TCH         0x0e            /* RW - Transfer Count High     */
                                       /*      NOT on 53C90            */

#define NCR_FIFO        0x02            /* RW - FIFO data               */

#define NCR_CMD         0x03            /* RW - Command (2 deep)        */
#define  NCRCMD_DMA     0x80            /*      DMA Bit                 */
#define  NCRCMD_NOP     0x00            /*      No Operation            */
#define  NCRCMD_FLUSH   0x01            /*      Flush FIFO              */
#define  NCRCMD_RSTCHIP 0x02            /*      Reset Chip              */
#define  NCRCMD_RSTSCSI 0x03            /*      Reset SCSI Bus          */
#define  NCRCMD_RESEL   0x40            /*      Reselect Sequence       */
#define  NCRCMD_SELNATN 0x41            /*      Select without ATN      */
#define  NCRCMD_SELATN  0x42            /*      Select with ATN         */
#define  NCRCMD_SELATNS 0x43            /*      Select with ATN & Stop  */
#define  NCRCMD_ENSEL   0x44            /*      Enable (Re)Selection    */
#define  NCRCMD_DISSEL  0x45            /*      Disable (Re)Selection   */
#define  NCRCMD_SELATN3 0x46            /*      Select with ATN3        */
#define  NCRCMD_RESEL3  0x47            /*      Reselect3 Sequence      */
#define  NCRCMD_SNDMSG  0x20            /*      Send Message            */
#define  NCRCMD_SNDSTAT 0x21            /*      Send Status             */
#define  NCRCMD_SNDDATA 0x22            /*      Send Data               */
#define  NCRCMD_DISCSEQ 0x23            /*      Disconnect Sequence     */
#define  NCRCMD_TERMSEQ 0x24            /*      Terminate Sequence      */
#define  NCRCMD_TCCS    0x25            /*      Target Command Comp Seq */
#define  NCRCMD_DISC    0x27            /*      Disconnect              */
#define  NCRCMD_RECMSG  0x28            /*      Receive Message         */
#define  NCRCMD_RECCMD  0x29            /*      Receive Command         */
#define  NCRCMD_RECDATA 0x2a            /*      Receive Data            */
#define  NCRCMD_RECCSEQ 0x2b            /*      Receive Command Sequence*/
#define  NCRCMD_ABORT   0x04            /*      Target Abort DMA        */
#define  NCRCMD_TRANS   0x10            /*      Transfer Information    */
#define  NCRCMD_ICCS    0x11            /*      Initiator Cmd Comp Seq  */
#define  NCRCMD_MSGOK   0x12            /*      Message Accepted        */
#define  NCRCMD_TRPAD   0x18            /*      Transfer Pad            */
#define  NCRCMD_SETATN  0x1a            /*      Set ATN                 */
#define  NCRCMD_RSTATN  0x1b            /*      Reset ATN               */

#define NCR_STAT        0x04            /* RO - Status                  */
#define  NCRSTAT_INT    0x80            /*      Interrupt               */
#define  NCRSTAT_GE     0x40            /*      Gross Error             */
#define  NCRSTAT_PE     0x20            /*      Parity Error            */
#define  NCRSTAT_TC     0x10            /*      Terminal Count          */
#define  NCRSTAT_VGC    0x08            /*      Valid Group Code        */
#define  NCRSTAT_PHASE  0x07            /*      Phase bits              */

#define NCR_SELID       0x04            /* WO - Select/Reselect Bus ID  */
#define  NCR_BUSID_HME          0x10    /* XXX HME reselect ID          */
#define  NCR_BUSID_HME32        0x40    /* XXX HME to select more than 16 */

#define NCR_INTR        0x05            /* RO - Interrupt               */
#define  NCRINTR_SBR    0x80            /*      SCSI Bus Reset          */
#define  NCRINTR_ILL    0x40            /*      Illegal Command         */
#define  NCRINTR_DIS    0x20            /*      Disconnect              */
#define  NCRINTR_BS     0x10            /*      Bus Service             */
#define  NCRINTR_FC     0x08            /*      Function Complete       */
#define  NCRINTR_RESEL  0x04            /*      Reselected              */
#define  NCRINTR_SELATN 0x02            /*      Select with ATN         */
#define  NCRINTR_SEL    0x01            /*      Selected                */

#define NCR_TIMEOUT     0x05            /* WO - Select/Reselect Timeout */

#define NCR_STEP        0x06            /* RO - Sequence Step           */
#define  NCRSTEP_MASK   0x07            /*      the last 3 bits         */
#define  NCRSTEP_DONE   0x04            /*      command went out        */

#define NCR_SYNCTP      0x06            /* WO - Synch Transfer Period   */
                                       /*      Default 5 (53C9X)       */

#define NCR_FFLAG       0x07            /* RO - FIFO Flags              */
#define  NCRFIFO_SS     0xe0            /*      Sequence Step (Dup)     */
#define  NCRFIFO_FF     0x1f            /*      Bytes in FIFO           */

#define NCR_SYNCOFF     0x07            /* WO - Synch Offset            */
                                       /*      0 = ASYNC               */
                                       /*      1 - 15 = SYNC bytes     */

#define NCR_CFG1        0x08            /* RW - Configuration #1        */
#define  NCRCFG1_SLOW   0x80            /*      Slow Cable Mode         */
#define  NCRCFG1_SRR    0x40            /*      SCSI Reset Rep Int Dis  */
#define  NCRCFG1_PTEST  0x20            /*      Parity Test Mod         */
#define  NCRCFG1_PARENB 0x10            /*      Enable Parity Check     */
#define  NCRCFG1_CTEST  0x08            /*      Enable Chip Test        */
#define  NCRCFG1_BUSID  0x07            /*      Bus ID                  */

#define NCR_CCF         0x09            /* WO - Clock Conversion Factor */
                                       /*      0 = 35.01 - 40MHz       */
                                       /*      NEVER SET TO 1          */
                                       /*      2 = 10MHz               */
                                       /*      3 = 10.01 - 15MHz       */
                                       /*      4 = 15.01 - 20MHz       */
                                       /*      5 = 20.01 - 25MHz       */
                                       /*      6 = 25.01 - 30MHz       */
                                       /*      7 = 30.01 - 35MHz       */

#define NCR_TEST        0x0a            /* WO - Test (Chip Test Only)   */

#define NCR_CFG2        0x0b            /* RW - Configuration #2        */
#define  NCRCFG2_RSVD   0xa0            /*      reserved                */
#define  NCRCFG2_FE     0x40            /*      Features Enable         */
#define  NCRCFG2_DREQ   0x10            /*      DREQ High Impedance     */
#define  NCRCFG2_SCSI2  0x08            /*      SCSI-2 Enable           */
#define  NCRCFG2_BPA    0x04            /*      Target Bad Parity Abort */
#define  NCRCFG2_RPE    0x02            /*      Register Parity Error   */
#define  NCRCFG2_DPE    0x01            /*      DMA Parity Error        */

#define  NCRCFG2_HMEFE  0x10            /*      HME feature enable      */
#define  NCRCFG2_HME32  0x80            /*      HME 32 extended         */

/* Config #3 only on 53C9X */
#define NCR_CFG3        0x0c            /* RW - Configuration #3        */
#define  NCRCFG3_RSVD   0xe0            /*      reserved                */
#define  NCRCFG3_IDM    0x10            /*      ID Message Res Check    */
#define  NCRCFG3_QTE    0x08            /*      Queue Tag Enable        */
#define  NCRCFG3_CDB    0x04            /*      CDB 10-bytes OK         */
#define  NCRCFG3_FSCSI  0x02            /*      Fast SCSI               */
#define  NCRCFG3_FCLK   0x01            /*      Fast Clock (>25MHz)     */

/*
* For some unknown reason, the ESP406/FAS408 looks like every
* other ncr53c9x, except for configuration #3 register.  At any
* rate, if you're dealing with these chips, you need to use these
* defines instead.
*/

/* Config #3 different on ESP406/FAS408 */
#define NCR_ESPCFG3             0x0c    /* RW - Configuration #3        */
#define  NCRESPCFG3_IDM         0x80    /*      ID Message Res Check    */
#define  NCRESPCFG3_QTE         0x40    /*      Queue Tag Enable        */
#define  NCRESPCFG3_CDB         0x20    /*      CDB 10-bytes OK         */
#define  NCRESPCFG3_FSCSI       0x10    /*      Fast SCSI               */
#define  NCRESPCFG3_SRESB       0x08    /*      Save Residual Byte      */
#define  NCRESPCFG3_FCLK        0x04    /*      Fast Clock (>25MHz)     */
#define  NCRESPCFG3_ADMA        0x02    /*      Alternate DMA Mode      */
#define  NCRESPCFG3_T8M         0x01    /*      Threshold 8 Mode        */

/* Config #3 also different on NCR53CF9x/FAS216 */
#define NCR_F9XCFG3             0x0c    /* RW - Configuration #3        */
#define  NCRF9XCFG3_IDM         0x80    /*      ID Message Res Check    */
#define  NCRF9XCFG3_QTE         0x40    /*      Queue Tag Enable        */
#define  NCRF9XCFG3_CDB         0x20    /*      CDB 10-bytes OK         */
#define  NCRF9XCFG3_FSCSI       0x10    /*      Fast SCSI               */
#define  NCRF9XCFG3_FCLK        0x08    /*      Fast Clock (>25MHz)     */
#define  NCRF9XCFG3_SRESB       0x04    /*      Save Residual Byte      */
#define  NCRF9XCFG3_ADMA        0x02    /*      Alternate DMA Mode      */
#define  NCRF9XCFG3_T8M         0x01    /*      Threshold 8 Mode        */

/* Config #3 on FAS366 */
#define  NCRFASCFG3_OBAUTO      0x80    /*      auto push odd-byte to DMA */
#define  NCRFASCFG3_EWIDE       0x40    /*      Enable Wide-SCSI     */
#define  NCRFASCFG3_IDBIT3      0x20    /*      Bit 3 of HME SCSI-ID */
#define  NCRFASCFG3_IDRESCHK    0x10    /*      ID message checking */
#define  NCRFASCFG3_QUENB       0x08    /*      3-byte msg support */
#define  NCRFASCFG3_CDB10       0x04    /*      group 2 scsi-2 support */
#define  NCRFASCFG3_FASTSCSI    0x02    /*      10 MB/S fast scsi mode */
#define  NCRFASCFG3_FASTCLK     0x01    /*      fast clock mode */

/* Config #4 only on ESP406/FAS408 */
#define NCR_CFG4        0x0d            /* RW - Configuration #4        */
#define  NCRCFG4_CRS1   0x80            /*      Select register set #1  */
#define  NCRCFG4_RSVD   0x7b            /*      reserved                */
#define  NCRCFG4_ACTNEG 0x04            /*      Active negation         */

/*
  The following registers are only on the ESP406/FAS408.  The
  documentation refers to them as "Control Register Set #1".
  These are the registers that are visible when bit 7 of
  register 0x0d is set.  This bit is common to both register sets.
*/

#define NCR_JMP         0x00            /* RO - Jumper Sense Register   */
#define  NCRJMP_RSVD    0xc0            /*      reserved                */
#define  NCRJMP_ROMSZ   0x20            /*      ROM Size 1=16K, 0=32K   */
#define  NCRJMP_J4      0x10            /*      Jumper #4               */
#define  NCRJMP_J3      0x08            /*      Jumper #3               */
#define  NCRJMP_J2      0x04            /*      Jumper #2               */
#define  NCRJMP_J1      0x02            /*      Jumper #1               */
#define  NCRJMP_J0      0x01            /*      Jumper #0               */

#define NCR_PIOFIFO     0x04            /* WO - PIO FIFO, 4 bytes deep  */

#define NCR_PSTAT       0x08            /* RW - PIO Status Register     */
#define  NCRPSTAT_PERR  0x80            /*      PIO Error               */
#define  NCRPSTAT_SIRQ  0x40            /*      Active High of SCSI IRQ */
#define  NCRPSTAT_ATAI  0x20            /*      ATA IRQ                 */
#define  NCRPSTAT_FEMPT 0x10            /*      PIO FIFO Empty          */
#define  NCRPSTAT_F13   0x08            /*      PIO FIFO 1/3            */
#define  NCRPSTAT_F23   0x04            /*      PIO FIFO 2/3            */
#define  NCRPSTAT_FFULL 0x02            /*      PIO FIFO Full           */
#define  NCRPSTAT_PIOM  0x01            /*      PIO/DMA Mode            */

#define NCR_PIOI        0x0b            /* RW - PIO Interrupt Enable    */
#define  NCRPIOI_RSVD   0xe0            /*      reserved                */
#define  NCRPIOI_EMPTY  0x10            /*      IRQ When Empty          */
#define  NCRPIOI_13     0x08            /*      IRQ When 1/3            */
#define  NCRPIOI_23     0x04            /*      IRQ When 2/3            */
#define  NCRPIOI_FULL   0x02            /*      IRQ When Full           */
#define  NCRPIOI_FINV   0x01            /*      Flag Invert             */

#define NCR_CFG5        0x0d            /* RW - Configuration #5        */
#define  NCRCFG5_CRS1   0x80            /*      Select Register Set #1  */
#define  NCRCFG5_SRAM   0x40            /*      SRAM Memory Map         */
#define  NCRCFG5_AADDR  0x20            /*      Auto Address            */
#define  NCRCFG5_PTRINC 0x10            /*      Pointer Increment       */
#define  NCRCFG5_LOWPWR 0x08            /*      Low Power Mode          */
#define  NCRCFG5_SINT   0x04            /*      SCSI Interrupt Enable   */
#define  NCRCFG5_INTP   0x02            /*      INT Polarity            */
#define  NCRCFG5_AINT   0x01            /*      ATA Interrupt Enable    */

#define NCR_SIGNTR      0x0e            /* RO - Signature               */

/* Am53c974 Config #3 */
#define NCR_AMDCFG3             0x0c    /* RW - Configuration #3        */
#define  NCRAMDCFG3_IDM         0x80    /*      ID Message Res Check    */
#define  NCRAMDCFG3_QTE         0x40    /*      Queue Tag Enable        */
#define  NCRAMDCFG3_CDB         0x20    /*      CDB 10-bytes OK         */
#define  NCRAMDCFG3_FSCSI       0x10    /*      Fast SCSI               */
#define  NCRAMDCFG3_FCLK        0x08    /*      Fast Clock (40MHz)      */
#define  NCRAMDCFG3_RSVD        0x07    /*      Reserved                */

/* Am53c974 Config #4 */
#define NCR_AMDCFG4             0x0d    /* RW - Configuration #4        */
#define  NCRAMDCFG4_GE          0xc0    /*      Glitch Eater            */
#define  NCRAMDCFG4_GE12NS      0x00    /*      Signal window 12ns      */
#define  NCRAMDCFG4_GE25NS      0x80    /*      Signal window 25ns      */
#define  NCRAMDCFG4_GE35NS      0x40    /*      Signal window 35ns      */
#define  NCRAMDCFG4_GE0NS       0xc0    /*      Signal window 0ns       */
#define  NCRAMDCFG4_PWD         0x20    /*      Reduced power feature   */
#define  NCRAMDCFG4_RSVD        0x13    /*      Reserved                */
#define  NCRAMDCFG4_RAE         0x08    /*      Active neg. REQ/ACK     */
#define  NCRAMDCFG4_RADE        0x04    /*      Active neg. REQ/ACK/DAT */

/*
* FAS366
*/
#define NCR_RCL         NCR_TCH /* Recommand counter low */
#define NCR_RCH         0xf     /* Recommand counter high */
#define NCR_UID         NCR_RCL /* fas366 part-uniq id */


/* status register #2 definitions (read only) */
#define NCR_STAT2       NCR_CCF
#define NCRFAS_STAT2_SEQCNT   0x01         /* Sequence counter bit 7-3 enabled */
#define NCRFAS_STAT2_FLATCHED 0x02         /* FIFO flags register latched */
#define NCRFAS_STAT2_CLATCHED 0x04         /* Xfer cntr & recommand ctr latched */
#define NCRFAS_STAT2_CACTIVE  0x08         /* Command register is active */
#define NCRFAS_STAT2_SCSI16   0x10         /* SCSI interface is wide */
#define NCRFAS_STAT2_ISHUTTLE 0x20         /* FIFO Top register contains 1 byte */
#define NCRFAS_STAT2_OSHUTTLE 0x40         /* next byte from FIFO is MSB */
#define NCRFAS_STAT2_EMPTY    0x80         /* FIFO is empty */