/***********************************************************************
;*      File Name : TMSCSIM.H                                          *
;*                  TEKRAM DC-390(T) PCI SCSI Bus Master Host Adapter  *
;*                  Device Driver                                      *
;***********************************************************************/
/* $Id: tmscsim.h,v 2.15.2.3 2000/11/17 20:52:27 garloff Exp $ */

#ifndef _TMSCSIM_H
#define _TMSCSIM_H

#include <linux/types.h>

#define SCSI_IRQ_NONE 255

#define MAX_ADAPTER_NUM         4
#define MAX_SG_LIST_BUF         16      /* Not used */
#define MAX_SCSI_ID             8
#define MAX_SRB_CNT             50      /* Max number of started commands */

#define SEL_TIMEOUT             153     /* 250 ms selection timeout (@ 40 MHz) */

/*
;-----------------------------------------------------------------------
; SCSI Request Block
;-----------------------------------------------------------------------
*/
struct dc390_srb
{
//u8            CmdBlock[12];

struct dc390_srb        *pNextSRB;
struct dc390_dcb        *pSRBDCB;
struct scsi_cmnd        *pcmd;
struct scatterlist      *pSegmentList;

struct scatterlist Segmentx;    /* make a one entry of S/G list table */

unsigned long   SGBusAddr;      /*;a segment starting address as seen by AM53C974A
                                  in CPU endianness. We're only getting 32-bit bus
                                  addresses by default */
unsigned long   SGToBeXferLen;  /*; to be xfer length */
unsigned long   TotalXferredLen;
unsigned long   SavedTotXLen;
unsigned long   Saved_Ptr;
u32             SRBState;

u8              SRBStatus;
u8              SRBFlag;        /*; b0-AutoReqSense,b6-Read,b7-write */
                                /*; b4-settimeout,b5-Residual valid */
u8              AdaptStatus;
u8              TargetStatus;

u8              ScsiPhase;
s8              TagNumber;
u8              SGIndex;
u8              SGcount;

u8              MsgCnt;
u8              EndMessage;

u8              MsgInBuf[6];
u8              MsgOutBuf[6];

//u8            IORBFlag;       /*;81h-Reset, 2-retry */
};


/*
;-----------------------------------------------------------------------
; Device Control Block
;-----------------------------------------------------------------------
*/
struct dc390_dcb
{
struct dc390_dcb        *pNextDCB;
struct dc390_acb        *pDCBACB;

/* Queued SRBs */
struct dc390_srb        *pGoingSRB;
struct dc390_srb        *pGoingLast;
struct dc390_srb        *pActiveSRB;
u8              GoingSRBCnt;

u32             TagMask;

u8              TargetID;       /*; SCSI Target ID  (SCSI Only) */
u8              TargetLUN;      /*; SCSI Log.  Unit (SCSI Only) */
u8              DevMode;
u8              DCBFlag;

u8              CtrlR1;
u8              CtrlR3;
u8              CtrlR4;

u8              SyncMode;       /*; 0:async mode */
u8              NegoPeriod;     /*;for nego. */
u8              SyncPeriod;     /*;for reg. */
u8              SyncOffset;     /*;for reg. and nego.(low nibble) */
};


/*
;-----------------------------------------------------------------------
; Adapter Control Block
;-----------------------------------------------------------------------
*/
struct dc390_acb
{
struct Scsi_Host *pScsiHost;
u16             IOPortBase;
u8              IRQLevel;
u8              status;

u8              SRBCount;
u8              AdapterIndex;   /*; nth Adapter this driver */
u8              DCBCnt;

u8              TagMaxNum;
u8              ACBFlag;
u8              Gmode2;
u8              scan_devices;

struct dc390_dcb        *pLinkDCB;
struct dc390_dcb        *pLastDCB;
struct dc390_dcb        *pDCBRunRobin;

struct dc390_dcb        *pActiveDCB;
struct dc390_srb        *pFreeSRB;
struct dc390_srb        *pTmpSRB;

u8              msgin123[4];
u8              Connected;
u8              pad;

#if defined(USE_SPINLOCKS) && USE_SPINLOCKS > 1 && (defined(CONFIG_SMP) || DEBUG_SPINLOCKS > 0)
spinlock_t      lock;
#endif
u8              sel_timeout;
u8              glitch_cfg;

u8              MsgLen;
u8              Ignore_IRQ;     /* Not used */

struct pci_dev  *pdev;

unsigned long   last_reset;
unsigned long   Cmds;
u32             SelLost;
u32             SelConn;
u32             CmdInQ;
u32             CmdOutOfSRB;

struct dc390_srb        TmpSRB;
struct dc390_srb        SRB_array[MAX_SRB_CNT];         /* 50 SRBs */
};


/*;-----------------------------------------------------------------------*/


#define BIT31   0x80000000
#define BIT30   0x40000000
#define BIT29   0x20000000
#define BIT28   0x10000000
#define BIT27   0x08000000
#define BIT26   0x04000000
#define BIT25   0x02000000
#define BIT24   0x01000000
#define BIT23   0x00800000
#define BIT22   0x00400000
#define BIT21   0x00200000
#define BIT20   0x00100000
#define BIT19   0x00080000
#define BIT18   0x00040000
#define BIT17   0x00020000
#define BIT16   0x00010000
#define BIT15   0x00008000
#define BIT14   0x00004000
#define BIT13   0x00002000
#define BIT12   0x00001000
#define BIT11   0x00000800
#define BIT10   0x00000400
#define BIT9    0x00000200
#define BIT8    0x00000100
#define BIT7    0x00000080
#define BIT6    0x00000040
#define BIT5    0x00000020
#define BIT4    0x00000010
#define BIT3    0x00000008
#define BIT2    0x00000004
#define BIT1    0x00000002
#define BIT0    0x00000001

/*;---UnitCtrlFlag */
#define UNIT_ALLOCATED  BIT0
#define UNIT_INFO_CHANGED BIT1
#define FORMATING_MEDIA BIT2
#define UNIT_RETRY      BIT3

/*;---UnitFlags */
#define DASD_SUPPORT    BIT0
#define SCSI_SUPPORT    BIT1
#define ASPI_SUPPORT    BIT2

/*;----SRBState machine definition */
#define SRB_FREE        0
#define SRB_WAIT        BIT0
#define SRB_READY       BIT1
#define SRB_MSGOUT      BIT2    /*;arbitration+msg_out 1st byte*/
#define SRB_MSGIN       BIT3
#define SRB_MSGIN_MULTI BIT4
#define SRB_COMMAND     BIT5
#define SRB_START_      BIT6    /*;arbitration+msg_out+command_out*/
#define SRB_DISCONNECT  BIT7
#define SRB_DATA_XFER   BIT8
#define SRB_XFERPAD     BIT9
#define SRB_STATUS      BIT10
#define SRB_COMPLETED   BIT11
#define SRB_ABORT_SENT  BIT12
#define DO_SYNC_NEGO    BIT13
#define SRB_UNEXPECT_RESEL BIT14

/*;---SRBstatus */
#define SRB_OK          BIT0
#define ABORTION        BIT1
#define OVER_RUN        BIT2
#define UNDER_RUN       BIT3
#define PARITY_ERROR    BIT4
#define SRB_ERROR       BIT5

/*;---ACBFlag */
#define RESET_DEV       BIT0
#define RESET_DETECT    BIT1
#define RESET_DONE      BIT2

/*;---DCBFlag */
#define ABORT_DEV_      BIT0

/*;---SRBFlag */
#define DATAOUT         BIT7
#define DATAIN          BIT6
#define RESIDUAL_VALID  BIT5
#define ENABLE_TIMER    BIT4
#define RESET_DEV0      BIT2
#define ABORT_DEV       BIT1
#define AUTO_REQSENSE   BIT0

/*;---Adapter status */
#define H_STATUS_GOOD    0
#define H_SEL_TIMEOUT    0x11
#define H_OVER_UNDER_RUN 0x12
#define H_UNEXP_BUS_FREE 0x13
#define H_TARGET_PHASE_F 0x14
#define H_INVALID_CCB_OP 0x16
#define H_LINK_CCB_BAD   0x17
#define H_BAD_TARGET_DIR 0x18
#define H_DUPLICATE_CCB  0x19
#define H_BAD_CCB_OR_SG  0x1A
#define H_ABORT          0x0FF

/* cmd->result */
#define RES_TARGET              0x000000FF      /* Target State */
#define RES_TARGET_LNX          STATUS_MASK     /* Only official ... */
#define RES_ENDMSG              0x0000FF00      /* End Message */
#define RES_DID                 0x00FF0000      /* DID_ codes */
#define RES_DRV                 0xFF000000      /* DRIVER_ codes */

#define MK_RES(drv,did,msg,tgt) ((int)(drv)<<24 | (int)(did)<<16 | (int)(msg)<<8 | (int)(tgt))
#define MK_RES_LNX(drv,did,msg,tgt) ((int)(drv)<<24 | (int)(did)<<16 | (int)(msg)<<8 | (int)(tgt))

#define SET_RES_TARGET(who, tgt) do { who &= ~RES_TARGET; who |= (int)(tgt); } while (0)
#define SET_RES_TARGET_LNX(who, tgt) do { who &= ~RES_TARGET_LNX; who |= (int)(tgt) << 1; } while (0)
#define SET_RES_MSG(who, msg) do { who &= ~RES_ENDMSG; who |= (int)(msg) << 8; } while (0)
#define SET_RES_DID(who, did) do { who &= ~RES_DID; who |= (int)(did) << 16; } while (0)
#define SET_RES_DRV(who, drv) do { who &= ~RES_DRV; who |= (int)(drv) << 24; } while (0)

/*;---Sync_Mode */
#define SYNC_DISABLE    0
#define SYNC_ENABLE     BIT0
#define SYNC_NEGO_DONE  BIT1
#define WIDE_ENABLE     BIT2    /* Not used ;-) */
#define WIDE_NEGO_DONE  BIT3    /* Not used ;-) */
#define EN_TAG_QUEUEING BIT4
#define EN_ATN_STOP     BIT5

#define SYNC_NEGO_OFFSET 15

/*;---SCSI bus phase*/
#define SCSI_DATA_OUT   0
#define SCSI_DATA_IN    1
#define SCSI_COMMAND    2
#define SCSI_STATUS_    3
#define SCSI_NOP0       4
#define SCSI_NOP1       5
#define SCSI_MSG_OUT    6
#define SCSI_MSG_IN     7

/*;----SCSI MSG BYTE*/ /* see scsi/scsi.h */ /* One is missing ! */
#define ABORT_TAG       0x0d

/*
 *      SISC query queue
 */
typedef struct {
        dma_addr_t              saved_dma_handle;
} dc390_cmd_scp_t;

/*
;==========================================================
; EEPROM byte offset
;==========================================================
*/
typedef  struct  _EEprom
{
u8      EE_MODE1;
u8      EE_SPEED;
u8      xx1;
u8      xx2;
} EEprom, *PEEprom;

#define REAL_EE_ADAPT_SCSI_ID 64
#define REAL_EE_MODE2   65
#define REAL_EE_DELAY   66
#define REAL_EE_TAG_CMD_NUM     67

#define EE_ADAPT_SCSI_ID 32
#define EE_MODE2        33
#define EE_DELAY        34
#define EE_TAG_CMD_NUM  35

#define EE_LEN          40

/*; EE_MODE1 bits definition*/
#define PARITY_CHK_     BIT0
#define SYNC_NEGO_      BIT1
#define EN_DISCONNECT_  BIT2
#define SEND_START_     BIT3
#define TAG_QUEUEING_   BIT4

/*; EE_MODE2 bits definition*/
#define MORE2_DRV       BIT0
#define GREATER_1G      BIT1
#define RST_SCSI_BUS    BIT2
#define ACTIVE_NEGATION BIT3
#define NO_SEEK         BIT4
#define LUN_CHECK       BIT5

#define ENABLE_CE       1
#define DISABLE_CE      0
#define EEPROM_READ     0x80

/*
;==========================================================
;       AMD 53C974 Registers bit Definition
;==========================================================
*/
/*
;====================
; SCSI Register
;====================
*/

/*; Command Reg.(+0CH) (rw) */
#define DMA_COMMAND             BIT7
#define NOP_CMD                 0
#define CLEAR_FIFO_CMD          1
#define RST_DEVICE_CMD          2
#define RST_SCSI_BUS_CMD        3

#define INFO_XFER_CMD           0x10
#define INITIATOR_CMD_CMPLTE    0x11
#define MSG_ACCEPTED_CMD        0x12
#define XFER_PAD_BYTE           0x18
#define SET_ATN_CMD             0x1A
#define RESET_ATN_CMD           0x1B

#define SEL_WO_ATN              0x41    /* currently not used */
#define SEL_W_ATN               0x42
#define SEL_W_ATN_STOP          0x43
#define SEL_W_ATN3              0x46
#define EN_SEL_RESEL            0x44
#define DIS_SEL_RESEL           0x45    /* currently not used */
#define RESEL                   0x40    /* " */
#define RESEL_ATN3              0x47    /* " */

#define DATA_XFER_CMD           INFO_XFER_CMD


/*; SCSI Status Reg.(+10H) (r) */
#define INTERRUPT               BIT7
#define ILLEGAL_OP_ERR          BIT6
#define PARITY_ERR              BIT5
#define COUNT_2_ZERO            BIT4
#define GROUP_CODE_VALID        BIT3
#define SCSI_PHASE_MASK         (BIT2+BIT1+BIT0) 
/* BIT2: MSG phase; BIT1: C/D physe; BIT0: I/O phase */

/*; Interrupt Status Reg.(+14H) (r) */
#define SCSI_RESET              BIT7
#define INVALID_CMD             BIT6
#define DISCONNECTED            BIT5
#define SERVICE_REQUEST         BIT4
#define SUCCESSFUL_OP           BIT3
#define RESELECTED              BIT2
#define SEL_ATTENTION           BIT1
#define SELECTED                BIT0

/*; Internal State Reg.(+18H) (r) */
#define SYNC_OFFSET_FLAG        BIT3
#define INTRN_STATE_MASK        (BIT2+BIT1+BIT0)
/* 0x04: Sel. successful (w/o stop), 0x01: Sel. successful (w/ stop) */

/*; Clock Factor Reg.(+24H) (w) */
#define CLK_FREQ_40MHZ          0
#define CLK_FREQ_35MHZ          (BIT2+BIT1+BIT0)
#define CLK_FREQ_30MHZ          (BIT2+BIT1)
#define CLK_FREQ_25MHZ          (BIT2+BIT0)
#define CLK_FREQ_20MHZ          BIT2
#define CLK_FREQ_15MHZ          (BIT1+BIT0)
#define CLK_FREQ_10MHZ          BIT1

/*; Control Reg. 1(+20H) (rw) */
#define EXTENDED_TIMING         BIT7
#define DIS_INT_ON_SCSI_RST     BIT6
#define PARITY_ERR_REPO         BIT4
#define SCSI_ID_ON_BUS          (BIT2+BIT1+BIT0) /* host adapter ID */

/*; Control Reg. 2(+2CH) (rw) */
#define EN_FEATURE              BIT6
#define EN_SCSI2_CMD            BIT3

/*; Control Reg. 3(+30H) (rw) */
#define ID_MSG_CHECK            BIT7
#define EN_QTAG_MSG             BIT6
#define EN_GRP2_CMD             BIT5
#define FAST_SCSI               BIT4    /* ;10MB/SEC */
#define FAST_CLK                BIT3    /* ;25 - 40 MHZ */

/*; Control Reg. 4(+34H) (rw) */
#define EATER_12NS              0
#define EATER_25NS              BIT7
#define EATER_35NS              BIT6
#define EATER_0NS               (BIT7+BIT6)
#define REDUCED_POWER           BIT5
#define CTRL4_RESERVED          BIT4    /* must be 1 acc. to AM53C974.c */
#define NEGATE_REQACKDATA       BIT2
#define NEGATE_REQACK           BIT3

#define GLITCH_TO_NS(x) (((~x>>6 & 2) >> 1) | ((x>>6 & 1) << 1 ^ (x>>6 & 2)))
#define NS_TO_GLITCH(y) (((~y<<7) | ~((y<<6) ^ ((y<<5 & 1<<6) | ~0x40))) & 0xc0)

/*
;====================
; DMA Register
;====================
*/
/*; DMA Command Reg.(+40H) (rw) */
#define READ_DIRECTION          BIT7
#define WRITE_DIRECTION         0
#define EN_DMA_INT              BIT6
#define EN_PAGE_INT             BIT5    /* page transfer interrupt enable */
#define MAP_TO_MDL              BIT4
#define DIAGNOSTIC              BIT2
#define DMA_IDLE_CMD            0
#define DMA_BLAST_CMD           BIT0
#define DMA_ABORT_CMD           BIT1
#define DMA_START_CMD           (BIT1+BIT0)

/*; DMA Status Reg.(+54H) (r) */
#define PCI_MS_ABORT            BIT6
#define BLAST_COMPLETE          BIT5
#define SCSI_INTERRUPT          BIT4
#define DMA_XFER_DONE           BIT3
#define DMA_XFER_ABORT          BIT2
#define DMA_XFER_ERROR          BIT1
#define POWER_DOWN              BIT0

/*; DMA SCSI Bus and Ctrl.(+70H) */
#define EN_INT_ON_PCI_ABORT     BIT25
#define WRT_ERASE_DMA_STAT      BIT24
#define PW_DOWN_CTRL            BIT21
#define SCSI_BUSY               BIT20
#define SCLK                    BIT19
#define SCAM                    BIT18
#define SCSI_LINES              0x0003ffff

/*
;==========================================================
; SCSI Chip register address offset
;==========================================================
;Registers are rw unless declared otherwise 
*/
#define CtcReg_Low      0x00    /* r    curr. transfer count */
#define CtcReg_Mid      0x04    /* r */
#define CtcReg_High     0x38    /* r */
#define ScsiFifo        0x08
#define ScsiCmd         0x0C
#define Scsi_Status     0x10    /* r */
#define INT_Status      0x14    /* r */
#define Sync_Period     0x18    /* w */
#define Sync_Offset     0x1C    /* w */
#define Clk_Factor      0x24    /* w */
#define CtrlReg1        0x20    
#define CtrlReg2        0x2C
#define CtrlReg3        0x30
#define CtrlReg4        0x34
#define DMA_Cmd         0x40
#define DMA_XferCnt     0x44    /* rw   starting transfer count (32 bit) */
#define DMA_XferAddr    0x48    /* rw   starting physical address (32 bit) */
#define DMA_Wk_ByteCntr 0x4C    /* r    working byte counter */
#define DMA_Wk_AddrCntr 0x50    /* r    working address counter */
#define DMA_Status      0x54    /* r */
#define DMA_MDL_Addr    0x58    /* rw   starting MDL address */
#define DMA_Wk_MDL_Cntr 0x5C    /* r    working MDL counter */
#define DMA_ScsiBusCtrl 0x70    /* rw   SCSI Bus, PCI/DMA Ctrl */

#define StcReg_Low      CtcReg_Low      /* w    start transfer count */
#define StcReg_Mid      CtcReg_Mid      /* w */
#define StcReg_High     CtcReg_High     /* w */
#define Scsi_Dest_ID    Scsi_Status     /* w */
#define Scsi_TimeOut    INT_Status      /* w */
#define Intern_State    Sync_Period     /* r */
#define Current_Fifo    Sync_Offset     /* r    Curr. FIFO / int. state */


#define DC390_read8(address)                    \
        (inb (pACB->IOPortBase + (address)))

#define DC390_read8_(address, base)             \
        (inb ((u16)(base) + (address)))

#define DC390_read16(address)                   \
        (inw (pACB->IOPortBase + (address)))

#define DC390_read32(address)                   \
        (inl (pACB->IOPortBase + (address)))

#define DC390_write8(address,value)             \
        outb ((value), pACB->IOPortBase + (address))

#define DC390_write8_(address,value,base)       \
        outb ((value), (u16)(base) + (address))

#define DC390_write16(address,value)            \
        outw ((value), pACB->IOPortBase + (address))

#define DC390_write32(address,value)            \
        outl ((value), pACB->IOPortBase + (address))


#endif /* _TMSCSIM_H */