1/* 2 * linux/drivers/acorn/scsi/fas216.h 3 * 4 * Copyright (C) 1997-2000 Russell King 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License version 2 as 8 * published by the Free Software Foundation. 9 * 10 * FAS216 generic driver 11 */ 12#ifndef FAS216_H 13#define FAS216_H 14 15#ifndef NO_IRQ 16#define NO_IRQ 255 17#endif 18 19#include "queue.h" 20#include "msgqueue.h" 21 22/* FAS register definitions */ 23 24/* transfer count low */ 25#define REG_CTCL(x) ((x)->scsi.io_port) 26#define REG_STCL(x) ((x)->scsi.io_port) 27 28/* transfer count medium */ 29#define REG_CTCM(x) ((x)->scsi.io_port + (1 << (x)->scsi.io_shift)) 30#define REG_STCM(x) ((x)->scsi.io_port + (1 << (x)->scsi.io_shift)) 31 32/* fifo data */ 33#define REG_FF(x) ((x)->scsi.io_port + (2 << (x)->scsi.io_shift)) 34 35/* command */ 36#define REG_CMD(x) ((x)->scsi.io_port + (3 << (x)->scsi.io_shift)) 37#define CMD_NOP 0x00 38#define CMD_FLUSHFIFO 0x01 39#define CMD_RESETCHIP 0x02 40#define CMD_RESETSCSI 0x03 41 42#define CMD_TRANSFERINFO 0x10 43#define CMD_INITCMDCOMPLETE 0x11 44#define CMD_MSGACCEPTED 0x12 45#define CMD_PADBYTES 0x18 46#define CMD_SETATN 0x1a 47#define CMD_RSETATN 0x1b 48 49#define CMD_SELECTWOATN 0x41 50#define CMD_SELECTATN 0x42 51#define CMD_SELECTATNSTOP 0x43 52#define CMD_ENABLESEL 0x44 53#define CMD_DISABLESEL 0x45 54#define CMD_SELECTATN3 0x46 55#define CMD_RESEL3 0x47 56 57#define CMD_WITHDMA 0x80 58 59/* status register (read) */ 60#define REG_STAT(x) ((x)->scsi.io_port + (4 << (x)->scsi.io_shift)) 61#define STAT_IO (1 << 0) /* IO phase */ 62#define STAT_CD (1 << 1) /* CD phase */ 63#define STAT_MSG (1 << 2) /* MSG phase */ 64#define STAT_TRANSFERDONE (1 << 3) /* Transfer completed */ 65#define STAT_TRANSFERCNTZ (1 << 4) /* Transfer counter is zero */ 66#define STAT_PARITYERROR (1 << 5) /* Parity error */ 67#define STAT_REALBAD (1 << 6) /* Something bad */ 68#define STAT_INT (1 << 7) /* Interrupt */ 69 70#define STAT_BUSMASK (STAT_MSG|STAT_CD|STAT_IO) 71#define STAT_DATAOUT (0) /* Data out */ 72#define STAT_DATAIN (STAT_IO) /* Data in */ 73#define STAT_COMMAND (STAT_CD) /* Command out */ 74#define STAT_STATUS (STAT_CD|STAT_IO) /* Status In */ 75#define STAT_MESGOUT (STAT_MSG|STAT_CD) /* Message out */ 76#define STAT_MESGIN (STAT_MSG|STAT_CD|STAT_IO) /* Message In */ 77 78/* bus ID for select / reselect */ 79#define REG_SDID(x) ((x)->scsi.io_port + (4 << (x)->scsi.io_shift)) 80#define BUSID(target) ((target) & 7) 81 82/* Interrupt status register (read) */ 83#define REG_INST(x) ((x)->scsi.io_port + (5 << (x)->scsi.io_shift)) 84#define INST_SELWOATN (1 << 0) /* Select w/o ATN */ 85#define INST_SELATN (1 << 1) /* Select w/ATN */ 86#define INST_RESELECTED (1 << 2) /* Reselected */ 87#define INST_FUNCDONE (1 << 3) /* Function done */ 88#define INST_BUSSERVICE (1 << 4) /* Bus service */ 89#define INST_DISCONNECT (1 << 5) /* Disconnect */ 90#define INST_ILLEGALCMD (1 << 6) /* Illegal command */ 91#define INST_BUSRESET (1 << 7) /* SCSI Bus reset */ 92 93/* Timeout register (write) */ 94#define REG_STIM(x) ((x)->scsi.io_port + (5 << (x)->scsi.io_shift)) 95 96/* Sequence step register (read) */ 97#define REG_IS(x) ((x)->scsi.io_port + (6 << (x)->scsi.io_shift)) 98#define IS_BITS 0x07 99#define IS_SELARB 0x00 /* Select & Arb ok */ 100#define IS_MSGBYTESENT 0x01 /* One byte message sent*/ 101#define IS_NOTCOMMAND 0x02 /* Not in command state */ 102#define IS_EARLYPHASE 0x03 /* Early phase change */ 103#define IS_COMPLETE 0x04 /* Command ok */ 104#define IS_SOF 0x08 /* Sync off flag */ 105 106/* Transfer period step (write) */ 107#define REG_STP(x) ((x)->scsi.io_port + (6 << (x)->scsi.io_shift)) 108 109/* Synchronous Offset (write) */ 110#define REG_SOF(x) ((x)->scsi.io_port + (7 << (x)->scsi.io_shift)) 111 112/* Fifo state register (read) */ 113#define REG_CFIS(x) ((x)->scsi.io_port + (7 << (x)->scsi.io_shift)) 114#define CFIS_CF 0x1f /* Num bytes in FIFO */ 115#define CFIS_IS 0xe0 /* Step */ 116 117/* config register 1 */ 118#define REG_CNTL1(x) ((x)->scsi.io_port + (8 << (x)->scsi.io_shift)) 119#define CNTL1_CID (7 << 0) /* Chip ID */ 120#define CNTL1_STE (1 << 3) /* Self test enable */ 121#define CNTL1_PERE (1 << 4) /* Parity enable reporting en. */ 122#define CNTL1_PTE (1 << 5) /* Parity test enable */ 123#define CNTL1_DISR (1 << 6) /* Disable Irq on SCSI reset */ 124#define CNTL1_ETM (1 << 7) /* Extended Timing Mode */ 125 126/* Clock conversion factor (read) */ 127#define REG_CLKF(x) ((x)->scsi.io_port + (9 << (x)->scsi.io_shift)) 128#define CLKF_F37MHZ 0x00 /* 35.01 - 40 MHz */ 129#define CLKF_F10MHZ 0x02 /* 10 MHz */ 130#define CLKF_F12MHZ 0x03 /* 10.01 - 15 MHz */ 131#define CLKF_F17MHZ 0x04 /* 15.01 - 20 MHz */ 132#define CLKF_F22MHZ 0x05 /* 20.01 - 25 MHz */ 133#define CLKF_F27MHZ 0x06 /* 25.01 - 30 MHz */ 134#define CLKF_F32MHZ 0x07 /* 30.01 - 35 MHz */ 135 136/* Chip test register (write) */ 137#define REG0_FTM(x) ((x)->scsi.io_port + (10 << (x)->scsi.io_shift)) 138#define TEST_FTM 0x01 /* Force target mode */ 139#define TEST_FIM 0x02 /* Force initiator mode */ 140#define TEST_FHI 0x04 /* Force high impedance mode */ 141 142/* Configuration register 2 (read/write) */ 143#define REG_CNTL2(x) ((x)->scsi.io_port + (11 << (x)->scsi.io_shift)) 144#define CNTL2_PGDP (1 << 0) /* Pass Th/Generate Data Parity */ 145#define CNTL2_PGRP (1 << 1) /* Pass Th/Generate Reg Parity */ 146#define CNTL2_ACDPE (1 << 2) /* Abort on Cmd/Data Parity Err */ 147#define CNTL2_S2FE (1 << 3) /* SCSI2 Features Enable */ 148#define CNTL2_TSDR (1 << 4) /* Tristate DREQ */ 149#define CNTL2_SBO (1 << 5) /* Select Byte Order */ 150#define CNTL2_ENF (1 << 6) /* Enable features */ 151#define CNTL2_DAE (1 << 7) /* Data Alignment Enable */ 152 153/* Configuration register 3 (read/write) */ 154#define REG_CNTL3(x) ((x)->scsi.io_port + (12 << (x)->scsi.io_shift)) 155#define CNTL3_BS8 (1 << 0) /* Burst size 8 */ 156#define CNTL3_MDM (1 << 1) /* Modify DMA mode */ 157#define CNTL3_LBTM (1 << 2) /* Last Byte Transfer mode */ 158#define CNTL3_FASTCLK (1 << 3) /* Fast SCSI clocking */ 159#define CNTL3_FASTSCSI (1 << 4) /* Fast SCSI */ 160#define CNTL3_G2CB (1 << 5) /* Group2 SCSI support */ 161#define CNTL3_QTAG (1 << 6) /* Enable 3 byte msgs */ 162#define CNTL3_ADIDCHK (1 << 7) /* Additional ID check */ 163 164/* High transfer count (read/write) */ 165#define REG_CTCH(x) ((x)->scsi.io_port + (14 << (x)->scsi.io_shift)) 166#define REG_STCH(x) ((x)->scsi.io_port + (14 << (x)->scsi.io_shift)) 167 168/* ID reigster (read only) */ 169#define REG1_ID(x) ((x)->scsi.io_port + (14 << (x)->scsi.io_shift)) 170 171/* Data alignment */ 172#define REG0_DAL(x) ((x)->scsi.io_port + (15 << (x)->scsi.io_shift)) 173 174typedef enum { 175 PHASE_IDLE, /* we're not planning on doing anything */ 176 PHASE_SELECTION, /* selecting a device */ 177 PHASE_SELSTEPS, /* selection with command steps */ 178 PHASE_COMMAND, /* command sent */ 179 PHASE_MESSAGESENT, /* selected, and we're sending cmd */ 180 PHASE_RECONNECTED, /* reconnected */ 181 PHASE_DATAOUT, /* data out to device */ 182 PHASE_DATAIN, /* data in from device */ 183 PHASE_MSGIN, /* message in from device */ 184 PHASE_MSGIN_DISCONNECT, /* disconnecting from bus */ 185 PHASE_MSGOUT, /* after message out phase */ 186 PHASE_MSGOUT_EXPECT, /* expecting message out */ 187 PHASE_STATUS, /* status from device */ 188 PHASE_DONE /* Command complete */ 189} phase_t; 190 191typedef enum { 192 DMA_OUT, /* DMA from memory to chip */ 193 DMA_IN /* DMA from chip to memory */ 194} fasdmadir_t; 195 196typedef enum { 197 fasdma_none, /* No dma */ 198 fasdma_pio, /* PIO mode */ 199 fasdma_pseudo, /* Pseudo DMA */ 200 fasdma_real_block, /* Real DMA, on block by block basis */ 201 fasdma_real_all /* Real DMA, on request by request */ 202} fasdmatype_t; 203 204typedef enum { 205 neg_wait, /* Negociate with device */ 206 neg_inprogress, /* Negociation sent */ 207 neg_complete, /* Negociation complete */ 208 neg_targcomplete, /* Target completed negociation */ 209 neg_invalid /* Negociation not supported */ 210} neg_t; 211 212#define MAGIC 0x441296bdUL 213#define NR_MSGS 8 214 215typedef struct { 216 unsigned long magic_start; 217 struct Scsi_Host *host; /* host */ 218 Scsi_Cmnd *SCpnt; /* currently processing command */ 219 Scsi_Cmnd *origSCpnt; /* original connecting command */ 220 Scsi_Cmnd *reqSCpnt; /* request sense command */ 221 222 /* driver information */ 223 struct { 224 unsigned int io_port; /* base address of FAS216 */ 225 unsigned int io_shift; /* shift to adjust reg offsets by */ 226 unsigned int irq; /* interrupt */ 227 unsigned char cfg[4]; /* configuration registers */ 228 const char *type; /* chip type */ 229 phase_t phase; /* current phase */ 230 231 struct { 232 unsigned char target; /* reconnected target */ 233 unsigned char lun; /* reconnected lun */ 234 unsigned char tag; /* reconnected tag */ 235 } reconnected; 236 237 Scsi_Pointer SCp; /* current commands data pointer */ 238 239 MsgQueue_t msgs; /* message queue for connected device */ 240 241 unsigned int async_stp; /* Async transfer STP value */ 242 unsigned char msgin_fifo; /* bytes in fifo at time of message in */ 243 unsigned char message[256]; /* last message received from device */ 244 unsigned int msglen; /* length of last message received */ 245 246 unsigned char disconnectable:1; /* this command can be disconnected */ 247 unsigned char aborting:1; /* aborting command */ 248 } scsi; 249 250 /* statistics information */ 251 struct { 252 unsigned int queues; 253 unsigned int removes; 254 unsigned int fins; 255 unsigned int reads; 256 unsigned int writes; 257 unsigned int miscs; 258 unsigned int disconnects; 259 unsigned int aborts; 260 unsigned int bus_resets; 261 unsigned int host_resets; 262 } stats; 263 264 /* configuration information */ 265 struct { 266 unsigned char clockrate; /* clock rate of FAS device (MHz) */ 267 unsigned char select_timeout; /* timeout (R5) */ 268 unsigned char sync_max_depth; /* Synchronous xfer max fifo depth */ 269 unsigned char wide_max_size; /* Maximum wide transfer size */ 270 unsigned char cntl3; /* Control Reg 3 */ 271 unsigned int asyncperiod; /* Async transfer period (ns) */ 272 unsigned int disconnect_ok:1; /* Disconnects allowed? */ 273 } ifcfg; 274 275 /* queue handling */ 276 struct { 277 Queue_t issue; /* issue queue */ 278 Queue_t disconnected; /* disconnected command queue */ 279 } queues; 280 281 /* per-device info */ 282 struct fas216_device { 283 unsigned char disconnect_ok:1; /* device can disconnect */ 284 unsigned char period; /* sync xfer period in (*4ns) */ 285 unsigned char stp; /* synchronous transfer period */ 286 unsigned char sof; /* synchronous offset register */ 287 unsigned char wide_xfer; /* currently negociated wide transfer */ 288 neg_t sync_state; /* synchronous transfer mode */ 289 neg_t wide_state; /* wide transfer mode */ 290 } device[8]; 291 unsigned char busyluns[8]; /* array of bits indicating LUNs busy */ 292 293 /* dma */ 294 struct { 295 fasdmatype_t transfer_type; /* current type of DMA transfer */ 296 fasdmatype_t (*setup) (struct Scsi_Host *host, Scsi_Pointer *SCp, fasdmadir_t direction, fasdmatype_t min_dma); 297 void (*pseudo)(struct Scsi_Host *host, Scsi_Pointer *SCp, fasdmadir_t direction, int transfer); 298 void (*stop) (struct Scsi_Host *host, Scsi_Pointer *SCp); 299 } dma; 300 301 /* miscellaneous */ 302 int internal_done; /* flag to indicate request done */ 303 304 unsigned long magic_end; 305} FAS216_Info; 306 307/* Function: int fas216_init (struct Scsi_Host *instance) 308 * Purpose : initialise FAS/NCR/AMD SCSI ic. 309 * Params : instance - a driver-specific filled-out structure 310 * Returns : 0 on success 311 */ 312extern int fas216_init (struct Scsi_Host *instance); 313 314/* Function: int fas216_abort (Scsi_Cmnd *SCpnt) 315 * Purpose : abort a command if something horrible happens. 316 * Params : SCpnt - Command that is believed to be causing a problem. 317 * Returns : one of SCSI_ABORT_ macros. 318 */ 319extern int fas216_abort (Scsi_Cmnd *); 320 321/* Function: int fas216_reset (Scsi_Cmnd *SCpnt, unsigned int reset_flags) 322 * Purpose : resets the adapter if something horrible happens. 323 * Params : SCpnt - Command that is believed to be causing a problem. 324 * reset_flags - flags indicating reset type that is believed to be required. 325 * Returns : one of SCSI_RESET_ macros, or'd with the SCSI_RESET_*_RESET macros. 326 */ 327extern int fas216_reset (Scsi_Cmnd *, unsigned int); 328 329/* Function: int fas216_queue_command (Scsi_Cmnd *SCpnt, void (*done)(Scsi_Cmnd *)) 330 * Purpose : queue a command for adapter to process. 331 * Params : SCpnt - Command to queue 332 * done - done function to call once command is complete 333 * Returns : 0 - success, else error 334 */ 335extern int fas216_queue_command (Scsi_Cmnd *, void (*done)(Scsi_Cmnd *)); 336 337/* Function: int fas216_command (Scsi_Cmnd *SCpnt) 338 * Purpose : queue a command for adapter to process. 339 * Params : SCpnt - Command to queue 340 * Returns : scsi result code 341 */ 342extern int fas216_command (Scsi_Cmnd *); 343 344/* Function: void fas216_intr (struct Scsi_Host *instance) 345 * Purpose : handle interrupts from the interface to progress a command 346 * Params : instance - interface to service 347 */ 348extern void fas216_intr (struct Scsi_Host *instance); 349 350/* Function: int fas216_release (struct Scsi_Host *instance) 351 * Purpose : release all resources and put everything to bed for FAS/NCR/AMD SCSI ic. 352 * Params : instance - a driver-specific filled-out structure 353 * Returns : 0 on success 354 */ 355extern int fas216_release (struct Scsi_Host *instance); 356 357extern int fas216_info(FAS216_Info *info, char *buffer); 358extern int fas216_print_host(FAS216_Info *info, char *buffer); 359extern int fas216_print_stats(FAS216_Info *info, char *buffer); 360extern int fas216_print_device(FAS216_Info *info, Scsi_Device *scd, char *buffer); 361 362/* Function: int fas216_eh_abort(Scsi_Cmnd *SCpnt) 363 * Purpose : abort this command 364 * Params : SCpnt - command to abort 365 * Returns : FAILED if unable to abort 366 */ 367extern int fas216_eh_abort(Scsi_Cmnd *SCpnt); 368 369/* Function: int fas216_eh_device_reset(Scsi_Cmnd *SCpnt) 370 * Purpose : Reset the device associated with this command 371 * Params : SCpnt - command specifing device to reset 372 * Returns : FAILED if unable to reset 373 */ 374extern int fas216_eh_device_reset(Scsi_Cmnd *SCpnt); 375 376/* Function: int fas216_eh_bus_reset(Scsi_Cmnd *SCpnt) 377 * Purpose : Reset the complete bus associated with this command 378 * Params : SCpnt - command specifing bus to reset 379 * Returns : FAILED if unable to reset 380 */ 381extern int fas216_eh_bus_reset(Scsi_Cmnd *SCpnt); 382 383/* Function: int fas216_eh_host_reset(Scsi_Cmnd *SCpnt) 384 * Purpose : Reset the host associated with this command 385 * Params : SCpnt - command specifing host to reset 386 * Returns : FAILED if unable to reset 387 */ 388extern int fas216_eh_host_reset(Scsi_Cmnd *SCpnt); 389 390#endif /* FAS216_H */ 391