1/* SPDX-License-Identifier: GPL-2.0-or-later */ 2/* 3 * wd33c93.h - Linux device driver definitions for the 4 * Commodore Amiga A2091/590 SCSI controller card 5 * 6 * IMPORTANT: This file is for version 1.25 - 09/Jul/1997 7 * 8 * Copyright (c) 1996 John Shifflett, GeoLog Consulting 9 * john@geolog.com 10 * jshiffle@netcom.com 11 */ 12#ifndef WD33C93_H 13#define WD33C93_H 14 15 16#define PROC_INTERFACE /* add code for /proc/scsi/wd33c93/xxx interface */ 17#ifdef PROC_INTERFACE 18#define PROC_STATISTICS /* add code for keeping various real time stats */ 19#endif 20 21#define SYNC_DEBUG /* extra info on sync negotiation printed */ 22#define DEBUGGING_ON /* enable command-line debugging bitmask */ 23#define DEBUG_DEFAULTS 0 /* default debugging bitmask */ 24 25 26#ifdef DEBUGGING_ON 27#define DB(f,a) if (hostdata->args & (f)) a; 28#else 29#define DB(f,a) 30#endif 31 32#define uchar unsigned char 33 34 35/* wd register names */ 36#define WD_OWN_ID 0x00 37#define WD_CONTROL 0x01 38#define WD_TIMEOUT_PERIOD 0x02 39#define WD_CDB_1 0x03 40#define WD_CDB_2 0x04 41#define WD_CDB_3 0x05 42#define WD_CDB_4 0x06 43#define WD_CDB_5 0x07 44#define WD_CDB_6 0x08 45#define WD_CDB_7 0x09 46#define WD_CDB_8 0x0a 47#define WD_CDB_9 0x0b 48#define WD_CDB_10 0x0c 49#define WD_CDB_11 0x0d 50#define WD_CDB_12 0x0e 51#define WD_TARGET_LUN 0x0f 52#define WD_COMMAND_PHASE 0x10 53#define WD_SYNCHRONOUS_TRANSFER 0x11 54#define WD_TRANSFER_COUNT_MSB 0x12 55#define WD_TRANSFER_COUNT 0x13 56#define WD_TRANSFER_COUNT_LSB 0x14 57#define WD_DESTINATION_ID 0x15 58#define WD_SOURCE_ID 0x16 59#define WD_SCSI_STATUS 0x17 60#define WD_COMMAND 0x18 61#define WD_DATA 0x19 62#define WD_QUEUE_TAG 0x1a 63#define WD_AUXILIARY_STATUS 0x1f 64 65/* WD commands */ 66#define WD_CMD_RESET 0x00 67#define WD_CMD_ABORT 0x01 68#define WD_CMD_ASSERT_ATN 0x02 69#define WD_CMD_NEGATE_ACK 0x03 70#define WD_CMD_DISCONNECT 0x04 71#define WD_CMD_RESELECT 0x05 72#define WD_CMD_SEL_ATN 0x06 73#define WD_CMD_SEL 0x07 74#define WD_CMD_SEL_ATN_XFER 0x08 75#define WD_CMD_SEL_XFER 0x09 76#define WD_CMD_RESEL_RECEIVE 0x0a 77#define WD_CMD_RESEL_SEND 0x0b 78#define WD_CMD_WAIT_SEL_RECEIVE 0x0c 79#define WD_CMD_TRANS_ADDR 0x18 80#define WD_CMD_TRANS_INFO 0x20 81#define WD_CMD_TRANSFER_PAD 0x21 82#define WD_CMD_SBT_MODE 0x80 83 84/* ASR register */ 85#define ASR_INT (0x80) 86#define ASR_LCI (0x40) 87#define ASR_BSY (0x20) 88#define ASR_CIP (0x10) 89#define ASR_PE (0x02) 90#define ASR_DBR (0x01) 91 92/* SCSI Bus Phases */ 93#define PHS_DATA_OUT 0x00 94#define PHS_DATA_IN 0x01 95#define PHS_COMMAND 0x02 96#define PHS_STATUS 0x03 97#define PHS_MESS_OUT 0x06 98#define PHS_MESS_IN 0x07 99 100/* Command Status Register definitions */ 101 102 /* reset state interrupts */ 103#define CSR_RESET 0x00 104#define CSR_RESET_AF 0x01 105 106 /* successful completion interrupts */ 107#define CSR_RESELECT 0x10 108#define CSR_SELECT 0x11 109#define CSR_SEL_XFER_DONE 0x16 110#define CSR_XFER_DONE 0x18 111 112 /* paused or aborted interrupts */ 113#define CSR_MSGIN 0x20 114#define CSR_SDP 0x21 115#define CSR_SEL_ABORT 0x22 116#define CSR_RESEL_ABORT 0x25 117#define CSR_RESEL_ABORT_AM 0x27 118#define CSR_ABORT 0x28 119 120 /* terminated interrupts */ 121#define CSR_INVALID 0x40 122#define CSR_UNEXP_DISC 0x41 123#define CSR_TIMEOUT 0x42 124#define CSR_PARITY 0x43 125#define CSR_PARITY_ATN 0x44 126#define CSR_BAD_STATUS 0x45 127#define CSR_UNEXP 0x48 128 129 /* service required interrupts */ 130#define CSR_RESEL 0x80 131#define CSR_RESEL_AM 0x81 132#define CSR_DISC 0x85 133#define CSR_SRV_REQ 0x88 134 135 /* Own ID/CDB Size register */ 136#define OWNID_EAF 0x08 137#define OWNID_EHP 0x10 138#define OWNID_RAF 0x20 139#define OWNID_FS_8 0x00 140#define OWNID_FS_12 0x40 141#define OWNID_FS_16 0x80 142 143 /* define these so we don't have to change a2091.c, etc. */ 144#define WD33C93_FS_8_10 OWNID_FS_8 145#define WD33C93_FS_12_15 OWNID_FS_12 146#define WD33C93_FS_16_20 OWNID_FS_16 147 148 /* pass input-clock explicitly. accepted mhz values are 8-10,12-20 */ 149#define WD33C93_FS_MHZ(mhz) (mhz) 150 151 /* Control register */ 152#define CTRL_HSP 0x01 153#define CTRL_HA 0x02 154#define CTRL_IDI 0x04 155#define CTRL_EDI 0x08 156#define CTRL_HHP 0x10 157#define CTRL_POLLED 0x00 158#define CTRL_BURST 0x20 159#define CTRL_BUS 0x40 160#define CTRL_DMA 0x80 161 162 /* Timeout Period register */ 163#define TIMEOUT_PERIOD_VALUE 20 /* 20 = 200 ms */ 164 165 /* Synchronous Transfer Register */ 166#define STR_FSS 0x80 167 168 /* Destination ID register */ 169#define DSTID_DPD 0x40 170#define DATA_OUT_DIR 0 171#define DATA_IN_DIR 1 172#define DSTID_SCC 0x80 173 174 /* Source ID register */ 175#define SRCID_MASK 0x07 176#define SRCID_SIV 0x08 177#define SRCID_DSP 0x20 178#define SRCID_ES 0x40 179#define SRCID_ER 0x80 180 181 /* This is what the 3393 chip looks like to us */ 182typedef struct { 183 volatile unsigned char *SASR; 184 volatile unsigned char *SCMD; 185} wd33c93_regs; 186 187 188typedef int (*dma_setup_t) (struct scsi_cmnd *SCpnt, int dir_in); 189typedef void (*dma_stop_t) (struct Scsi_Host *instance, 190 struct scsi_cmnd *SCpnt, int status); 191 192 193#define ILLEGAL_STATUS_BYTE 0xff 194 195#define DEFAULT_SX_PER 376 /* (ns) fairly safe */ 196#define DEFAULT_SX_OFF 0 /* aka async */ 197 198#define OPTIMUM_SX_PER 252 /* (ns) best we can do (mult-of-4) */ 199#define OPTIMUM_SX_OFF 12 /* size of wd3393 fifo */ 200 201struct sx_period { 202 unsigned int period_ns; 203 uchar reg_value; 204 }; 205 206/* FEF: defines for hostdata->dma_buffer_pool */ 207 208#define BUF_CHIP_ALLOCED 0 209#define BUF_SCSI_ALLOCED 1 210 211struct WD33C93_hostdata { 212 struct Scsi_Host *next; 213 wd33c93_regs regs; 214 spinlock_t lock; 215 uchar clock_freq; 216 uchar chip; /* what kind of wd33c93? */ 217 uchar microcode; /* microcode rev */ 218 uchar dma_buffer_pool; /* FEF: buffer from chip_ram? */ 219 int dma_dir; /* data transfer dir. */ 220 dma_setup_t dma_setup; 221 dma_stop_t dma_stop; 222 unsigned int dma_xfer_mask; 223 uchar *dma_bounce_buffer; 224 unsigned int dma_bounce_len; 225 volatile uchar busy[8]; /* index = target, bit = lun */ 226 volatile struct scsi_cmnd *input_Q; /* commands waiting to be started */ 227 volatile struct scsi_cmnd *selecting; /* trying to select this command */ 228 volatile struct scsi_cmnd *connected; /* currently connected command */ 229 volatile struct scsi_cmnd *disconnected_Q;/* commands waiting for reconnect */ 230 uchar state; /* what we are currently doing */ 231 uchar dma; /* current state of DMA (on/off) */ 232 uchar level2; /* extent to which Level-2 commands are used */ 233 uchar disconnect; /* disconnect/reselect policy */ 234 unsigned int args; /* set from command-line argument */ 235 uchar incoming_msg[8]; /* filled during message_in phase */ 236 int incoming_ptr; /* mainly used with EXTENDED messages */ 237 uchar outgoing_msg[8]; /* send this during next message_out */ 238 int outgoing_len; /* length of outgoing message */ 239 unsigned int default_sx_per; /* default transfer period for SCSI bus */ 240 uchar sync_xfer[8]; /* sync_xfer reg settings per target */ 241 uchar sync_stat[8]; /* status of sync negotiation per target */ 242 uchar no_sync; /* bitmask: don't do sync on these targets */ 243 uchar no_dma; /* set this flag to disable DMA */ 244 uchar dma_mode; /* DMA Burst Mode or Single Byte DMA */ 245 uchar fast; /* set this flag to enable Fast SCSI */ 246 struct sx_period sx_table[9]; /* transfer periods for actual DTC-setting */ 247#ifdef PROC_INTERFACE 248 uchar proc; /* bitmask: what's in proc output */ 249#ifdef PROC_STATISTICS 250 unsigned long cmd_cnt[8]; /* # of commands issued per target */ 251 unsigned long int_cnt; /* # of interrupts serviced */ 252 unsigned long pio_cnt; /* # of pio data transfers */ 253 unsigned long dma_cnt; /* # of DMA data transfers */ 254 unsigned long disc_allowed_cnt[8]; /* # of disconnects allowed per target */ 255 unsigned long disc_done_cnt[8]; /* # of disconnects done per target*/ 256#endif 257#endif 258 }; 259 260static inline struct scsi_pointer *WD33C93_scsi_pointer(struct scsi_cmnd *cmd) 261{ 262 return scsi_cmd_priv(cmd); 263} 264 265/* defines for hostdata->chip */ 266 267#define C_WD33C93 0 268#define C_WD33C93A 1 269#define C_WD33C93B 2 270#define C_UNKNOWN_CHIP 100 271 272/* defines for hostdata->state */ 273 274#define S_UNCONNECTED 0 275#define S_SELECTING 1 276#define S_RUNNING_LEVEL2 2 277#define S_CONNECTED 3 278#define S_PRE_TMP_DISC 4 279#define S_PRE_CMP_DISC 5 280 281/* defines for hostdata->dma */ 282 283#define D_DMA_OFF 0 284#define D_DMA_RUNNING 1 285 286/* defines for hostdata->level2 */ 287/* NOTE: only the first 3 are implemented so far */ 288 289#define L2_NONE 1 /* no combination commands - we get lots of ints */ 290#define L2_SELECT 2 /* start with SEL_ATN_XFER, but never resume it */ 291#define L2_BASIC 3 /* resume after STATUS ints & RDP messages */ 292#define L2_DATA 4 /* resume after DATA_IN/OUT ints */ 293#define L2_MOST 5 /* resume after anything except a RESELECT int */ 294#define L2_RESELECT 6 /* resume after everything, including RESELECT ints */ 295#define L2_ALL 7 /* always resume */ 296 297/* defines for hostdata->disconnect */ 298 299#define DIS_NEVER 0 300#define DIS_ADAPTIVE 1 301#define DIS_ALWAYS 2 302 303/* defines for hostdata->args */ 304 305#define DB_TEST1 1<<0 306#define DB_TEST2 1<<1 307#define DB_QUEUE_COMMAND 1<<2 308#define DB_EXECUTE 1<<3 309#define DB_INTR 1<<4 310#define DB_TRANSFER 1<<5 311#define DB_MASK 0x3f 312 313/* defines for hostdata->sync_stat[] */ 314 315#define SS_UNSET 0 316#define SS_FIRST 1 317#define SS_WAITING 2 318#define SS_SET 3 319 320/* defines for hostdata->proc */ 321 322#define PR_VERSION 1<<0 323#define PR_INFO 1<<1 324#define PR_STATISTICS 1<<2 325#define PR_CONNECTED 1<<3 326#define PR_INPUTQ 1<<4 327#define PR_DISCQ 1<<5 328#define PR_TEST 1<<6 329#define PR_STOP 1<<7 330 331 332void wd33c93_init (struct Scsi_Host *instance, const wd33c93_regs regs, 333 dma_setup_t setup, dma_stop_t stop, int clock_freq); 334int wd33c93_abort (struct scsi_cmnd *cmd); 335int wd33c93_queuecommand (struct Scsi_Host *h, struct scsi_cmnd *cmd); 336void wd33c93_intr (struct Scsi_Host *instance); 337int wd33c93_show_info(struct seq_file *, struct Scsi_Host *); 338int wd33c93_write_info(struct Scsi_Host *, char *, int); 339int wd33c93_host_reset (struct scsi_cmnd *); 340 341#endif /* WD33C93_H */ 342