fas216.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:14k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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