wd719x.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _WD719X_H_
  3. #define _WD719X_H_
  4. #define WD719X_SG 255 /* Scatter/gather size */
  5. struct wd719x_sglist {
  6. __le32 ptr;
  7. __le32 length;
  8. } __packed;
  9. enum wd719x_card_type {
  10. WD719X_TYPE_UNKNOWN = 0,
  11. WD719X_TYPE_7193,
  12. WD719X_TYPE_7197,
  13. WD719X_TYPE_7296,
  14. };
  15. union wd719x_regs {
  16. __le32 all; /* All Status at once */
  17. struct {
  18. u8 OPC; /* Opcode register */
  19. u8 SCSI; /* SCSI Errors */
  20. u8 SUE; /* Spider unique Errors */
  21. u8 INT; /* Interrupt Status */
  22. } bytes;
  23. };
  24. /* Spider Command Block (SCB) */
  25. struct wd719x_scb {
  26. __le32 Int_SCB; /* 00-03 Internal SCB link pointer (must be cleared) */
  27. u8 SCB_opcode; /* 04 SCB Command opcode */
  28. u8 CDB_tag; /* 05 SCSI Tag byte for CDB queues (0 if untagged) */
  29. u8 lun; /* 06 SCSI LUN */
  30. u8 devid; /* 07 SCSI Device ID */
  31. u8 CDB[16]; /* 08-23 SCSI CDB (16 bytes as defined by ANSI spec. */
  32. __le32 data_p; /* 24-27 Data transfer address (or SG list address) */
  33. __le32 data_length; /* 28-31 Data transfer Length (or SG list length) */
  34. __le32 CDB_link; /* 32-35 SCSI CDB Link Ptr */
  35. __le32 sense_buf; /* 36-39 Auto request sense buffer address */
  36. u8 sense_buf_length;/* 40 Auto request sense transfer length */
  37. u8 reserved; /* 41 reserved */
  38. u8 SCB_options; /* 42 SCB-options */
  39. u8 SCB_tag_msg; /* 43 Tagged messages options */
  40. /* Not filled in by host */
  41. __le32 req_ptr; /* 44-47 Ptr to Host Request returned on interrupt */
  42. u8 host_opcode; /* 48 Host Command Opcode (same as AMR_00) */
  43. u8 scsi_stat; /* 49 SCSI Status returned */
  44. u8 ret_error; /* 50 SPIDER Unique Error Code returned (SUE) */
  45. u8 int_stat; /* 51 Message u8 / Interrupt Status byte returned */
  46. __le32 transferred; /* 52-55 Bytes Transferred */
  47. u8 last_trans[3]; /* 56-58 Bytes Transferred in last session */
  48. u8 length; /* 59 SCSI Messages Length (1-8) */
  49. u8 sync_offset; /* 60 Synchronous offset */
  50. u8 sync_rate; /* 61 Synchronous rate */
  51. u8 flags[2]; /* 62-63 SCB specific flags (local to each thread) */
  52. /* everything below is for driver use (not used by card) */
  53. dma_addr_t phys; /* bus address of the SCB */
  54. struct scsi_cmnd *cmd; /* a copy of the pointer we were passed */
  55. struct list_head list;
  56. struct wd719x_sglist sg_list[WD719X_SG] __aligned(8); /* SG list */
  57. } __packed;
  58. struct wd719x {
  59. struct Scsi_Host *sh; /* pointer to host structure */
  60. struct pci_dev *pdev;
  61. void __iomem *base;
  62. enum wd719x_card_type type; /* type of card */
  63. void *fw_virt; /* firmware buffer CPU address */
  64. dma_addr_t fw_phys; /* firmware buffer bus address */
  65. size_t fw_size; /* firmware buffer size */
  66. struct wd719x_host_param *params; /* host parameters (EEPROM) */
  67. dma_addr_t params_phys; /* host parameters bus address */
  68. void *hash_virt; /* hash table CPU address */
  69. dma_addr_t hash_phys; /* hash table bus address */
  70. struct list_head active_scbs;
  71. };
  72. /* timeout delays in microsecs */
  73. #define WD719X_WAIT_FOR_CMD_READY 500
  74. #define WD719X_WAIT_FOR_RISC 2000
  75. #define WD719X_WAIT_FOR_SCSI_RESET 3000000
  76. /* All commands except 0x00 generate an interrupt */
  77. #define WD719X_CMD_READY 0x00 /* Command register ready (or noop) */
  78. #define WD719X_CMD_INIT_RISC 0x01 /* Initialize RISC */
  79. /* 0x02 is reserved */
  80. #define WD719X_CMD_BUSRESET 0x03 /* Assert SCSI bus reset */
  81. #define WD719X_CMD_READ_FIRMVER 0x04 /* Read the Firmware Revision */
  82. #define WD719X_CMD_ECHO_BYTES 0x05 /* Echo command bytes (DW) */
  83. /* 0x06 is reserved */
  84. /* 0x07 is reserved */
  85. #define WD719X_CMD_GET_PARAM 0x08 /* Get programmable parameters */
  86. #define WD719X_CMD_SET_PARAM 0x09 /* Set programmable parameters */
  87. #define WD719X_CMD_SLEEP 0x0a /* Put SPIDER to sleep */
  88. #define WD719X_CMD_READ_INIT 0x0b /* Read initialization parameters */
  89. #define WD719X_CMD_RESTORE_INIT 0x0c /* Restore initialization parameters */
  90. /* 0x0d is reserved */
  91. /* 0x0e is reserved */
  92. /* 0x0f is reserved */
  93. #define WD719X_CMD_ABORT_TAG 0x10 /* Send Abort tag message to target */
  94. #define WD719X_CMD_ABORT 0x11 /* Send Abort message to target */
  95. #define WD719X_CMD_RESET 0x12 /* Send Reset message to target */
  96. #define WD719X_CMD_INIT_SCAM 0x13 /* Initiate SCAM */
  97. #define WD719X_CMD_GET_SYNC 0x14 /* Get synchronous rates */
  98. #define WD719X_CMD_SET_SYNC 0x15 /* Set synchronous rates */
  99. #define WD719X_CMD_GET_WIDTH 0x16 /* Get SCSI bus width */
  100. #define WD719X_CMD_SET_WIDTH 0x17 /* Set SCSI bus width */
  101. #define WD719X_CMD_GET_TAGS 0x18 /* Get tag flags */
  102. #define WD719X_CMD_SET_TAGS 0x19 /* Set tag flags */
  103. #define WD719X_CMD_GET_PARAM2 0x1a /* Get programmable params (format 2) */
  104. #define WD719X_CMD_SET_PARAM2 0x1b /* Set programmable params (format 2) */
  105. /* Commands with request pointers (mailbox) */
  106. #define WD719X_CMD_PROCESS_SCB 0x80 /* Process SCSI Control Block (SCB) */
  107. /* No interrupt generated on acceptance of SCB pointer */
  108. /* interrupt status defines */
  109. #define WD719X_INT_NONE 0x00 /* No interrupt pending */
  110. #define WD719X_INT_NOERRORS 0x01 /* Command completed with no errors */
  111. #define WD719X_INT_LINKNOERRORS 0x02 /* link cmd completed with no errors */
  112. #define WD719X_INT_LINKNOSTATUS 0x03 /* link cmd completed with no flag set */
  113. #define WD719X_INT_ERRORSLOGGED 0x04 /* cmd completed with errors logged */
  114. #define WD719X_INT_SPIDERFAILED 0x05 /* cmd failed without valid SCSI status */
  115. #define WD719X_INT_BADINT 0x80 /* unsolicited interrupt */
  116. #define WD719X_INT_PIOREADY 0xf0 /* data ready for PIO output */
  117. /* Spider Unique Error Codes (SUE) */
  118. #define WD719X_SUE_NOERRORS 0x00 /* No errors detected by SPIDER */
  119. #define WD719X_SUE_REJECTED 0x01 /* Command Rejected (bad opcode/param) */
  120. #define WD719X_SUE_SCBQFULL 0x02 /* SCB queue full */
  121. /* 0x03 is reserved */
  122. #define WD719X_SUE_TERM 0x04 /* Host terminated SCB via primative cmd */
  123. #define WD719X_SUE_CHAN1PAR 0x05 /* PCI Channel 1 parity error occurred */
  124. #define WD719X_SUE_CHAN1ABORT 0x06 /* PCI Channel 1 system abort occurred */
  125. #define WD719X_SUE_CHAN23PAR 0x07 /* PCI Channel 2/3 parity error occurred */
  126. #define WD719X_SUE_CHAN23ABORT 0x08 /* PCI Channel 2/3 system abort occurred */
  127. #define WD719X_SUE_TIMEOUT 0x10 /* Selection/reselection timeout */
  128. #define WD719X_SUE_RESET 0x11 /* SCSI bus reset occurred */
  129. #define WD719X_SUE_BUSERROR 0x12 /* SCSI bus error */
  130. #define WD719X_SUE_WRONGWAY 0x13 /* Wrong data transfer dir set by target */
  131. #define WD719X_SUE_BADPHASE 0x14 /* SCSI phase illegal or unexpected */
  132. #define WD719X_SUE_TOOLONG 0x15 /* target requested too much data */
  133. #define WD719X_SUE_BUSFREE 0x16 /* Unexpected SCSI bus free */
  134. #define WD719X_SUE_ARSDONE 0x17 /* Auto request sense executed */
  135. #define WD719X_SUE_IGNORED 0x18 /* SCSI message was ignored by target */
  136. #define WD719X_SUE_WRONGTAGS 0x19 /* Tagged SCB & tags off (or vice versa) */
  137. #define WD719X_SUE_BADTAGS 0x1a /* Wrong tag message type for target */
  138. #define WD719X_SUE_NOSCAMID 0x1b /* No SCAM soft ID available */
  139. /* code sizes */
  140. #define WD719X_HASH_TABLE_SIZE 4096
  141. /* Advanced Mode Registers */
  142. /* Regs 0x00..0x1f are for Advanced Mode of the card (RISC is running). */
  143. #define WD719X_AMR_COMMAND 0x00
  144. #define WD719X_AMR_CMD_PARAM 0x01
  145. #define WD719X_AMR_CMD_PARAM_2 0x02
  146. #define WD719X_AMR_CMD_PARAM_3 0x03
  147. #define WD719X_AMR_SCB_IN 0x04
  148. #define WD719X_AMR_BIOS_SHARE_INT 0x0f
  149. #define WD719X_AMR_SCB_OUT 0x18
  150. #define WD719X_AMR_OP_CODE 0x1c
  151. #define WD719X_AMR_SCSI_STATUS 0x1d
  152. #define WD719X_AMR_SCB_ERROR 0x1e
  153. #define WD719X_AMR_INT_STATUS 0x1f
  154. #define WD719X_DISABLE_INT 0x80
  155. /* SCB flags */
  156. #define WD719X_SCB_FLAGS_CHECK_DIRECTION 0x01
  157. #define WD719X_SCB_FLAGS_PCI_TO_SCSI 0x02
  158. #define WD719X_SCB_FLAGS_AUTO_REQUEST_SENSE 0x10
  159. #define WD719X_SCB_FLAGS_DO_SCATTER_GATHER 0x20
  160. #define WD719X_SCB_FLAGS_NO_DISCONNECT 0x40
  161. /* PCI Registers used for reset, initial code download */
  162. /* Regs 0x20..0x3f are for Normal (DOS) mode (RISC is asleep). */
  163. #define WD719X_PCI_GPIO_CONTROL 0x3C
  164. #define WD719X_PCI_GPIO_DATA 0x3D
  165. #define WD719X_PCI_PORT_RESET 0x3E
  166. #define WD719X_PCI_MODE_SELECT 0x3F
  167. #define WD719X_PCI_EXTERNAL_ADDR 0x60
  168. #define WD719X_PCI_INTERNAL_ADDR 0x64
  169. #define WD719X_PCI_DMA_TRANSFER_SIZE 0x66
  170. #define WD719X_PCI_CHANNEL2_3CMD 0x68
  171. #define WD719X_PCI_CHANNEL2_3STATUS 0x69
  172. #define WD719X_GPIO_ID_BITS 0x0a
  173. #define WD719X_PRAM_BASE_ADDR 0x00
  174. /* codes written to or read from the card */
  175. #define WD719X_PCI_RESET 0x01
  176. #define WD719X_ENABLE_ADVANCE_MODE 0x01
  177. #define WD719X_START_CHANNEL2_3DMA 0x17
  178. #define WD719X_START_CHANNEL2_3DONE 0x01
  179. #define WD719X_START_CHANNEL2_3ABORT 0x20
  180. /* 33C296 GPIO bits for EEPROM pins */
  181. #define WD719X_EE_DI (1 << 1)
  182. #define WD719X_EE_CS (1 << 2)
  183. #define WD719X_EE_CLK (1 << 3)
  184. #define WD719X_EE_DO (1 << 4)
  185. /* EEPROM contents */
  186. struct wd719x_eeprom_header {
  187. u8 sig1;
  188. u8 sig2;
  189. u8 version;
  190. u8 checksum;
  191. u8 cfg_offset;
  192. u8 cfg_size;
  193. u8 setup_offset;
  194. u8 setup_size;
  195. } __packed;
  196. #define WD719X_EE_SIG1 0
  197. #define WD719X_EE_SIG2 1
  198. #define WD719X_EE_VERSION 2
  199. #define WD719X_EE_CHECKSUM 3
  200. #define WD719X_EE_CFG_OFFSET 4
  201. #define WD719X_EE_CFG_SIZE 5
  202. #define WD719X_EE_SETUP_OFFSET 6
  203. #define WD719X_EE_SETUP_SIZE 7
  204. #define WD719X_EE_SCSI_ID_MASK 0xf
  205. /* SPIDER Host Parameters Block (=EEPROM configuration block) */
  206. struct wd719x_host_param {
  207. u8 ch_1_th; /* FIFO threshold */
  208. u8 scsi_conf; /* SCSI configuration */
  209. u8 own_scsi_id; /* controller SCSI ID */
  210. u8 sel_timeout; /* selection timeout*/
  211. u8 sleep_timer; /* seep timer */
  212. __le16 cdb_size;/* CDB size groups */
  213. __le16 tag_en; /* Tag msg enables (ID 0-15) */
  214. u8 scsi_pad; /* SCSI pad control */
  215. __le32 wide; /* WIDE msg options (ID 0-15) */
  216. __le32 sync; /* SYNC msg options (ID 0-15) */
  217. u8 soft_mask; /* soft error mask */
  218. u8 unsol_mask; /* unsolicited error mask */
  219. } __packed;
  220. #endif /* _WD719X_H_ */