开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 嵌入式/单片机编程 > VxWorks > 查看源码
scsi1Lib.h
资源名称：ixp425BSP.rar　[点击查看]
上传用户：luoyougen
上传日期：2008-05-12
资源大小：23136k
文件大小：26k
源码类别：

VxWorks

开发平台：

C/C++

scsi1Lib.h：源码内容
  1. /* scsi1Lib.h - SCSI library header file */
  3. /* Copyright 1984-1994 Wind River Systems, Inc. */
  5. /*
  6. modification history
  7. --------------------
  8. 02k,10oct94,jds  fixed for SCSI1 and SCSI2 compatability
  9. 02j,11jan93,ccc  added #ifndef _ASMLANGUAGE.
  10. 02i,30sep92,ccc  added two new errno's.
  11. 02h,24sep92,ccc  removed timeout parameter to scsiAutoConfig().
  12. 02g,22sep92,rrr  added support for c++
  13. 02f,27aug92,ccc  added timeout to SCSI_TRANSACTION structure.
  14. 02e,26jul92,rrr  Removed decl of scsiSyncTarget, it was made LOCAL.
  15. 02d,20jul92,eve  Remove conditional compilation.
  16. 02c,14jul92,eve  added a pScsiXaction info in SCSI_PHYS_DEV structure to
  17.  maintain the data direction information to support
  18.  cache coherency in drivers.
  19. 02b,06jul92,eve  added declaration for extended sync functionalities.
  20. 02a,04jul92,jcf  cleaned up.
  21. 01l,26may92,rrr  the tree shuffle
  22. 01k,07apr92,yao  changed BYTE_ORDER to _BYTE_ORDER, BIG_ENDIAN to _BIG_ENDIAN.
  23. 01j,04oct91,rrr  passed through the ansification filter
  24.   -fixed #else and #endif
  25.   -changed READ, WRITE and UPDATE to O_RDONLY O_WRONLY O_RDWR
  26.   -changed VOID to void
  27.   -changed copyright notice
  28. 01i,07mar91,jcc  added SCSI_BLK_DEV_LIST and SCSI_BLK_DEV_NODE definitions;
  29.  added SCSI_SWAB macro. added a few error codes.
  30. 01h,05oct90,shl  added ANSI function prototypes.
  31.                  added copyright notice.
  32. 01g,02oct90,jcc  changed SEM_ID's to SEMAPHORE's in SCSI_PHYS_DEV and SCSI_CTRL
  33.  structures; modified structures to return variable length
  34.  REQUEST SENSE data; miscellaneous.
  35. 01f,20aug90,jcc  added conditional defines and typedefs for 4.0.2 compatibility.
  36. 01e,10aug90,dnw  changed scsiBusReset and scsiSelTimeOutCvt to VOIDFUNCPTR.
  37. 01d,07aug90,shl  moved function declarations to end of file.
  38. 01c,12jul90,jcc  misc. enhancements and changes.
  39. 01b,08jun90,jcc  added scsiMsgInAck to SCSI_CTRL, which routine is invoked
  40.  to accept incoming messages.
  41. 01a,17apr89,jcc  written.
  42. */
  44. #ifndef __INCscsi1Libh
  45. #define __INCscsi1Libh
  47. #ifndef _ASMLANGUAGE
  49. #ifdef __cplusplus
  50. extern "C" {
  51. #endif
  53. #include "vwModNum.h"
  54. #include "blkIo.h"
  55. #include "lstLib.h"
  56. #include "private/semLibP.h"
  58. #ifndef WAIT_FOREVER    /* the following is for 4.0.2 backward compatibility */
  60. #define WAIT_FOREVER    (-1)
  61. typedef void            (*VOIDFUNCPTR) ();  /* ptr to function returning void */
  62. typedef unsigned char   UINT8;
  63. typedef unsigned short  UINT16;
  65. #endif /* WAIT_FOREVER */
  67. /* SCSI direct-access device and general purpose command opcodes are enumerated.
  68.  * NOTE: Some commands are optional and may not be supported by all devices.
  69.  */
  71. #define SCSI_OPCODE_TEST_UNIT_READY     ((UINT8) 0x00)  /* test unit ready */
  72. #define SCSI_OPCODE_REZERO_UNIT         ((UINT8) 0x01)  /* rezero unit */
  73. #define SCSI_OPCODE_REWIND ((UINT8) 0x01)  /* rewind */
  74. #define SCSI_OPCODE_REQUEST_SENSE       ((UINT8) 0x03)  /* request sense */
  75. #define SCSI_OPCODE_FORMAT_UNIT         ((UINT8) 0x04)  /* format unit */
  76. #define SCSI_OPCODE_READ_BLOCK_LIMITS ((UINT8) 0x05)  /* read block limits */
  77. #define SCSI_OPCODE_REASSIGN_BLOCKS     ((UINT8) 0x07)  /* reassign blocks */
  78. #define SCSI_OPCODE_READ                ((UINT8) 0x08)  /* read */
  79. #define SCSI_OPCODE_RECEIVE ((UINT8) 0x08)  /* receive */
  80. #define SCSI_OPCODE_WRITE               ((UINT8) 0x0a)  /* write */
  81. #define SCSI_OPCODE_PRINT               ((UINT8) 0x0a)  /* print */
  82. #define SCSI_OPCODE_SEND ((UINT8) 0x0a)  /* send */
  83. #define SCSI_OPCODE_SEEK                ((UINT8) 0x0b)  /* seek */
  84. #define SCSI_OPCODE_TRACK_SELECT ((UINT8) 0x0b)  /* track select */
  85. #define SCSI_OPCODE_SLEW_AND_PRINT ((UINT8) 0x0b)  /* slew and print */
  86. #define SCSI_OPCODE_READ_REVERSE ((UINT8) 0x0f)  /* read reverse */
  87. #define SCSI_OPCODE_WRITE_FILEMARKS ((UINT8) 0x10)  /* write filemarks */
  88. #define SCSI_OPCODE_FLUSH_BUFFER ((UINT8) 0x10)  /* flush buffer */
  89. #define SCSI_OPCODE_SPACE ((UINT8) 0x11)  /* space */
  90. #define SCSI_OPCODE_INQUIRY             ((UINT8) 0x12)  /* inquiry */
  91. #define SCSI_OPCODE_VERIFY_SEQ ((UINT8) 0x13)  /* seq. access verify */
  92. #define SCSI_OPCODE_RECOVER_BUF_DATA ((UINT8) 0x14)  /* rec. buffered data */
  93. #define SCSI_OPCODE_MODE_SELECT         ((UINT8) 0x15)  /* mode select */
  94. #define SCSI_OPCODE_RESERVE             ((UINT8) 0x16)  /* reserve */
  95. #define SCSI_OPCODE_RELEASE             ((UINT8) 0x17)  /* release */
  96. #define SCSI_OPCODE_COPY ((UINT8) 0x18)  /* copy */
  97. #define SCSI_OPCODE_ERASE ((UINT8) 0x19)  /* erase */
  98. #define SCSI_OPCODE_MODE_SENSE          ((UINT8) 0x1a)  /* mode sense */
  99. #define SCSI_OPCODE_START_STOP_UNIT     ((UINT8) 0x1b)  /* start/stop unit */
  100. #define SCSI_OPCODE_LOAD_UNLOAD ((UINT8) 0x1b)  /* load/unload */
  101. #define SCSI_OPCODE_STOP_PRINT ((UINT8) 0x1b)  /* stop print */
  102. #define SCSI_OPCODE_RECV_DIAG_RESULTS ((UINT8) 0x1c)  /* recv diag results */
  103. #define SCSI_OPCODE_SEND_DIAGNOSTIC     ((UINT8) 0x1d)  /* send diagnostic */
  104. #define SCSI_OPCODE_CTRL_MEDIUM_REMOVAL ((UINT8) 0x1e)  /* ctrl med. removal */
  105. #define SCSI_OPCODE_READ_CAPACITY       ((UINT8) 0x25)  /* read capacity */
  106. #define SCSI_OPCODE_READ_EXT ((UINT8) 0x28)  /* read extended */
  107. #define SCSI_OPCODE_WRITE_EXT       ((UINT8) 0x2a)  /* write extended */
  108. #define SCSI_OPCODE_SEEK_EXT        ((UINT8) 0x2b)  /* seek extended */
  109. #define SCSI_OPCODE_WRITE_AND_VERIFY    ((UINT8) 0x2e)  /* write and verify */
  110. #define SCSI_OPCODE_VERIFY              ((UINT8) 0x2f)  /* verify */
  111. #define SCSI_OPCODE_SEARCH_DATA_HIGH ((UINT8) 0x30)  /* search data high */
  112. #define SCSI_OPCODE_SEARCH_DATA_EQUAL ((UINT8) 0x31)  /* search data equal */
  113. #define SCSI_OPCODE_SEARCH_DATA_LOW ((UINT8) 0x32)  /* search data low */
  114. #define SCSI_OPCODE_SET_LIMITS ((UINT8) 0x33)  /* set limits */
  115. #define SCSI_OPCODE_READ_DEFECT_DATA    ((UINT8) 0x37)  /* read defect data */
  116. #define SCSI_OPCODE_COMPARE     ((UINT8) 0x39)  /* compare */
  117. #define SCSI_OPCODE_COPY_AND_VERIFY ((UINT8) 0x3a)  /* copy and verify */
  118. #define SCSI_OPCODE_WRITE_BUFFER        ((UINT8) 0x3b)  /* write buffer */
  119. #define SCSI_OPCODE_READ_BUFFER         ((UINT8) 0x3c)  /* read buffer */
  121. /* SCSI general purpose sense keys are enumerated.
  122.  * NOTE: Some sense keys are optional and may not be supported by all devices.
  123. */
  125. #define SCSI_SENSE_KEY_NO_SENSE         0x00  /* no sense sense key */
  126. #define SCSI_SENSE_KEY_RECOVERED_ERROR  0x01  /* recovered error sense key */
  127. #define SCSI_SENSE_KEY_NOT_READY        0x02  /* not ready sense key */
  128. #define SCSI_SENSE_KEY_MEDIUM_ERROR     0x03  /* medium error sense key */
  129. #define SCSI_SENSE_KEY_HARDWARE_ERROR   0x04  /* hardware error sense key */
  130. #define SCSI_SENSE_KEY_ILLEGAL_REQUEST  0x05  /* illegal request sense key */
  131. #define SCSI_SENSE_KEY_UNIT_ATTENTION   0x06  /* unit attention sense key */
  132. #define SCSI_SENSE_KEY_DATA_PROTECT     0x07  /* data protect sense key */
  133. #define SCSI_SENSE_KEY_BLANK_CHECK      0x08  /* blank check sense key */
  134. #define SCSI_SENSE_KEY_VENDOR_UNIQUE    0x09  /* vendor unique sense key */
  135. #define SCSI_SENSE_KEY_COPY_ABORTED     0x0a  /* copy aborted sense key */
  136. #define SCSI_SENSE_KEY_ABORTED_COMMAND  0x0b  /* aborted command sense key */
  137. #define SCSI_SENSE_KEY_EQUAL            0x0c  /* key equal sense key */
  138. #define SCSI_SENSE_KEY_VOLUME_OVERFLOW  0x0d  /* volume overflow sense key */
  139. #define SCSI_SENSE_KEY_MISCOMPARE       0x0e  /* miscompare sense key */
  140. #define SCSI_SENSE_KEY_RESERVED         0x0f  /* reserved sense key */
  142. /* SCSI status byte codes are enumerated.
  143.  * NOTE: Some status codes are optional and may not be supported by all devices.
  144. */
  146. #define SCSI_STATUS_MASK            ((UINT8) 0x1e) /* mask vend uniq status */
  147. #define SCSI_STATUS_GOOD            ((UINT8) 0x00) /* good status */
  148. #define SCSI_STATUS_CHECK_CONDITION ((UINT8) 0x02) /* check condition status */
  149. #define SCSI_STATUS_CONDITION_MET   ((UINT8) 0x04) /* condition met/good stat */
  150. #define SCSI_STATUS_BUSY            ((UINT8) 0x08) /* busy status */
  151. #define SCSI_STATUS_INTMED_GOOD     ((UINT8) 0x10) /* intermediate/good stat */
  152. #define SCSI_STATUS_INTMED_COND_MET ((UINT8) 0x14) /* interm./cond. met stat */
  153. #define SCSI_STATUS_RESERV_CONFLICT ((UINT8) 0x18) /* reservation conflict */
  154. #define SCSI_STATUS_QUEUE_FULL      ((UINT8) 0x28) /* queue full status */
  156. /* SCSI message codes are enumerated.
  157.  * NOTE: Some message codes are optional and may not be supported by all
  158.  *       devices.
  159. */
  161. #define SCSI_MSG_COMMAND_COMPLETE   ((UINT8) 0x00) /* command complete msg. */
  162. #define SCSI_MSG_EXTENDED_MESSAGE   ((UINT8) 0x01) /* extended message msg. */
  163. #define SCSI_MSG_SAVE_DATA_POINTER  ((UINT8) 0x02) /* save data pointer msg. */
  164. #define SCSI_MSG_RESTORE_POINTERS   ((UINT8) 0x03) /* restore pointers msg. */
  165. #define SCSI_MSG_DISCONNECT         ((UINT8) 0x04) /* disconnect msg. */
  166. #define SCSI_MSG_INITOR_DETECT_ERR  ((UINT8) 0x05) /* initor. detect err msg. */
  167. #define SCSI_MSG_ABORT              ((UINT8) 0x06) /* abort msg. */
  168. #define SCSI_MSG_MESSAGE_REJECT     ((UINT8) 0x07) /* message reject msg. */
  169. #define SCSI_MSG_NO_OP              ((UINT8) 0x08) /* no operation msg. */
  170. #define SCSI_MSG_MSG_PARITY_ERR     ((UINT8) 0x09) /* message parity err msg. */
  171. #define SCSI_MSG_LINK_CMD_COMPLETE  ((UINT8) 0x0a) /* linked cmd. comp. msg. */
  172. #define SCSI_MSG_LINK_CMD_FLAG_COMP ((UINT8) 0x0b) /* link cmd w/flag comp. */
  173. #define SCSI_MSG_BUS_DEVICE_RESET   ((UINT8) 0x0c) /* bus device reset msg. */
  174. #define SCSI_MSG_IDENT_DISCONNECT   ((UINT8) 0x40) /* identify disconnect bit */
  175. #define SCSI_MSG_IDENTIFY      ((UINT8) 0x80) /* identify msg bit mask */
  177. /* SCSI extended message codes */
  179. #define SCSI_EXT_MSG_MODIFY_DATA_PTR ((UINT8) 0x00)  /* modify data pointer */
  180. #define SCSI_EXT_MSG_SYNC_XFER_REQ   ((UINT8) 0x01)  /* sync. data xfer. req. */
  181. #define SCSI_EXT_MSG_WIDE_XFER_REQ   ((UINT8) 0x03)  /* wide data xfer req. */
  183. /* SCSI extended message lengths */
  185. #define SCSI_MODIFY_DATA_PTR_MSG_LENGTH  5  /* modify data pointer */
  186. #define SCSI_SYNC_XFER_REQ_MSG_LENGTH    3  /* sync. data xfer. req. */
  187. #define SCSI_WIDE_XFER_REQ_MSG_LENGTH    2  /* wide data xfer req. */
  189. /* the largest SCSI ID and LUN a target drive can have */
  191. #define SCSI_MIN_BUS_ID 0 /* min. bus ID under SCSI */
  192. #define SCSI_MAX_BUS_ID 7 /* max. bus ID under SCSI */
  193. #define SCSI_MIN_LUN 0 /* min. logical unit number */
  194. #define SCSI_MAX_LUN 7 /* max. logical unit number */
  196. /* scsiLib errno's */
  198. #define S_scsiLib_DEV_NOT_READY (M_scsiLib | 1)
  199. #define S_scsiLib_WRITE_PROTECTED (M_scsiLib | 2)
  200. #define S_scsiLib_MEDIUM_ERROR (M_scsiLib | 3)
  201. #define S_scsiLib_HARDWARE_ERROR (M_scsiLib | 4)
  202. #define S_scsiLib_ILLEGAL_REQUEST (M_scsiLib | 5)
  203. #define S_scsiLib_BLANK_CHECK (M_scsiLib | 6)
  204. #define S_scsiLib_ABORTED_COMMAND (M_scsiLib | 7)
  205. #define S_scsiLib_VOLUME_OVERFLOW (M_scsiLib | 8)
  206. #define S_scsiLib_UNIT_ATTENTION (M_scsiLib | 9)
  207. #define S_scsiLib_SELECT_TIMEOUT (M_scsiLib | 10)
  208. #define S_scsiLib_LUN_NOT_PRESENT (M_scsiLib | 11)
  209. #define S_scsiLib_ILLEGAL_BUS_ID (M_scsiLib | 12)
  210. #define S_scsiLib_NO_CONTROLLER (M_scsiLib | 13)
  211. #define S_scsiLib_REQ_SENSE_ERROR (M_scsiLib | 14)
  212. #define S_scsiLib_DEV_UNSUPPORTED (M_scsiLib | 15)
  213. #define S_scsiLib_ILLEGAL_PARAMETER (M_scsiLib | 16)
  214. #define S_scsiLib_EARLY_PHASE_CHANGE (M_scsiLib | 17)
  215. #define S_scsiLib_PHASE_CHANGE_TIMEOUT (M_scsiLib | 18)
  216. #define S_scsiLib_ILLEGAL_OPERATION (M_scsiLib | 19)
  217. #define S_scsiLib_DEVICE_EXIST          (M_scsiLib | 20)
  218. #define S_scsiLib_SYNC_UNSUPPORTED      (M_scsiLib | 21)
  219. #define S_scsiLib_SYNC_VAL_UNSUPPORTED  (M_scsiLib | 22)
  220. #define S_scsiLib_DATA_TRANSFER_TIMEOUT (M_scsiLib | 23)
  221. #define S_scsiLib_UNKNOWN_PHASE (M_scsiLib | 24)
  224. /* default select timeout (usec) */
  225. #define SCSI_DEF_SELECT_TIMEOUT ((UINT) 250000)
  227. /* default auto-config timeout (usec) */
  228. #define SCSI_DEF_CONFIG_TIMEOUT ((UINT) 1000)
  230. #define SCSI_TIMEOUT_5SEC ((UINT) 5000000)
  231. #define SCSI_TIMEOUT_1SEC ((UINT) 1000000)
  232. #define SCSI_TIMEOUT_FULL ((UINT) 0x7fffffff)
  234. /* default bus ID for a vxWorks SCSI port */
  236. #define SCSI_DEF_CTRL_BUS_ID 7
  238. /* values in status register for SCSI bus phases */
  240. #define SCSI_DATA_OUT_PHASE 0x0
  241. #define SCSI_DATA_IN_PHASE 0x1
  242. #define SCSI_COMMAND_PHASE 0x2
  243. #define SCSI_STATUS_PHASE 0x3
  244. #define SCSI_MSG_OUT_PHASE 0x6
  245. #define SCSI_MSG_IN_PHASE 0x7
  246. #define SCSI_BUS_FREE_PHASE 0x8
  248. /* device status enumeration */
  250. typedef enum scsiPhysDevStatus
  251.     {
  252.     IDLE,
  253.     SELECT_REQUESTED,
  254.     SELECT_IN_PROGRESS,
  255.     SELECT_SUCCESSFUL,
  256.     SELECT_TIMEOUT,
  257.     SELECT_LOST_ARBIT,
  258.     DISCONNECTED,
  259.     RECONNECTED
  260.     } SCSI_DEV_STATUS;
  262. /* device type enumeration */
  264. #define SCSI_DEV_DIR_ACCESS ((UINT8) 0x00) /* direct-access dev (disk) */
  265. #define SCSI_DEV_SEQ_ACCESS ((UINT8) 0x01) /* sequent'l-access dev (tape) */
  266. #define SCSI_DEV_PRINTER ((UINT8) 0x02) /* printer dev */
  267. #define SCSI_DEV_PROCESSOR ((UINT8) 0x03) /* processor dev */
  268. #define SCSI_DEV_WORM ((UINT8) 0x04) /* write-once read-mult dev */
  269. #define SCSI_DEV_RO_DIR_ACCESS ((UINT8) 0x05) /* read-only direct-access dev */
  270. #define SCSI_LUN_NOT_PRESENT ((UINT8) 0x7f) /* logical unit not present */
  272. #define MAX_SCSI_PHYS_DEVS 64
  273. #define MAX_MSG_IN_BYTES 8
  274. #define MAX_MSG_OUT_BYTES 8
  276. #define VENDOR_ID_LENGTH 8
  277. #define PRODUCT_ID_LENGTH 16
  278. #define REV_LEVEL_LENGTH 4
  280. typedef struct scsiBlkDevList
  281.     {
  282.     SEMAPHORE listMutexSem;
  283.     LIST blkDevNodes;
  284.     } SCSI_BLK_DEV_LIST;
  286. /* structure to pass to ioctl call to execute an SCSI command*/
  288. typedef struct  /* SCSI_TRANSACTION - information about a SCSI transaction */
  289.     {
  290.     UINT8 *cmdAddress;          /* address of SCSI command bytes */
  291.     int cmdLength;              /* length of command in bytes */
  292.     UINT8 *dataAddress;         /* address of data buffer */
  293.     int dataDirection;          /* direction of data transfer */
  294.     int dataLength;             /* length of data buffer in bytes (0=no data) */    int addLengthByte;          /* if != -1 , byte # of additional length */
  295.     UINT8 statusByte;           /* status byte returned from target */
  296.     int cmdTimeout; /* number of usec for this command timeout */
  297.     } SCSI_TRANSACTION;
  299. /* NOTE: Not all of the fields in the following structure
  300.  *       are currently supported or used.
  301.  */
  303. typedef struct  /* SCSI_PHYS_DEV - SCSI physical device info */
  304.     {
  305.     SEMAPHORE devMutexSem; /* semaphore for exclusive access */
  306.     SEMAPHORE devSyncSem; /* semaphore for waiting on I/O interrupt */
  307.     int scsiDevBusId; /* device's address on SCSI bus */
  308.     int scsiDevLUN; /* device's logical unit number */
  309.     UINT selTimeOut; /* device select time-out (units var.) */
  310.     UINT8 scsiDevType; /* SCSI device type */
  311.     TBOOL disconnect;           /* whether device supports disconnect */
  312.     TBOOL expectDisconnect;     /* TRUE if a disconnect is expected */
  313.     TBOOL xmitsParity;      /* TRUE if dev. xmits parity */
  314.     TBOOL useIdentify; /* whether to use identify message at select */
  315.     TBOOL syncXfer; /* TRUE for synchronous data transfer */
  316.     int syncXferOffset; /* synchronous xfer maximum offset */
  317.     int syncXferPeriod; /* synchronous xfer mimimum period */
  318.     UINT8 *savedTransAddress;   /* saved data pointer address */
  319.     int savedTransLength;       /* saved data pointer length */
  320.     BOOL resetFlag; /* set TRUE when dev reset sensed */
  321.     FUNCPTR postResetRtn; /* routine to call when dev has been reset */
  323.     char devVendorID [VENDOR_ID_LENGTH + 1];  /* vendor ID in ASCII */
  324.     char devProductID [PRODUCT_ID_LENGTH + 1]; /* product ID in ASCII */
  325.     char devRevLevel [REV_LEVEL_LENGTH + 1]; /* revision level in ASCII */
  327.     BOOL removable; /* whether medium is removable */
  328.     UINT8 lastSenseKey; /* last sense key returned by dev */
  329.     UINT8 lastAddSenseCode; /* last additional sense code returned by dev */
  330.     int controlByte; /* vendor unique control byte for commands */
  331.     int numBlocks; /* number of blocks on the physical device */
  332.     int blockSize; /* size of an SCSI disk sector */
  333.     struct scsiCtrl *pScsiCtrl; /* ptr to dev's SCSI controller info */
  334.     SCSI_DEV_STATUS devStatus; /* status of most recent device operation */
  335.      /* list of outgoing messages */
  336.     UINT8 msgOutArray [MAX_MSG_OUT_BYTES + 1];/* msg[0] reserved for identify */
  337.     int msgLength; /* number of bytes in outgoing message */
  338.     BOOL extendedSense; /* whether device returns extended sense */
  339.     UINT8 *pReqSenseData; /* ptr to last REQ SENSE data returned by dev */
  340.     int reqSenseDataLength; /* size of REQ SENSE data array */
  341.      /* ptr to first block dev created on device */
  342.     struct scsiBlkDevList blkDevList;
  343.     struct scsiBlkDev *pScsiBlkDev;
  344.     int useMsgout;              /* whether to send a message out at select */
  345.     int syncReserved1;          /* Reserved for hardware sync register value */
  346.     int syncReserved2;          /* Reserved for hardware sync register value */
  347.     SCSI_TRANSACTION  *pScsiXaction; /* current scsi action requested */
  348.     } SCSI_PHYS_DEV;
  351. /* Step scsi period ( look at the scsi ANSI ) */
  353. #define SCSI_SYNC_STEP_PERIOD     4     /* scsi step period in sync msg */
  355. /* Used to negotiate a scsi sync agreement for the synchronous transfert
  356.  * to return parameters computed both by the driver and target
  357.  */
  358. typedef struct
  359.      {
  360.      int syncPeriodCtrl;     /* Closest period available with the controller */
  361.      int syncOffsetCtrl;     /* Closest offset available with the controller */
  362.      int syncPeriodTarget;   /* Period value returned by the target */
  363.      int syncOffsetTarget;   /* Offset value returned by the target */
  364.      } SCSI_SYNC_AGREEMENT;
  366. typedef SCSI_PHYS_DEV *SCSI_PHYS_DEV_ID;
  368. typedef struct scsiBlkDev /* SCSI_BLK_DEV -
  369.    SCSI logical block device info */
  370.     {
  371.     BLK_DEV blkDev; /* generic logical block device info */
  372.     SCSI_PHYS_DEV *pScsiPhysDev;/* ptr to SCSI physical device info */
  373.     int numBlocks; /* number of blocks on the logical device */
  374.     int blockOffset; /* address of first block on logical device */
  375.     } SCSI_BLK_DEV;
  377. typedef SCSI_BLK_DEV *SCSI_BLK_DEV_ID;
  379. typedef struct scsiBlkDevNode
  380.     {
  381.     NODE blkDevNode;
  382.     SCSI_BLK_DEV scsiBlkDev;
  383.     } SCSI_BLK_DEV_NODE;
  385. typedef struct scsiCtrl /* SCSI_CTRL - generic SCSI controller info */
  386.     {
  387.     SEMAPHORE ctrlMutexSem; /* semaphore for exclusive access */
  388.     SEMAPHORE ctrlSyncSem; /* semaphore for waiting on I/O interrupt */
  389.     VOIDFUNCPTR scsiBusReset; /* function for resetting the SCSI bus */
  390.     FUNCPTR scsiTransact; /* function for managing a SCSI transaction */
  391.     FUNCPTR scsiDevSelect; /* function for selecting a SCSI device */
  392.     FUNCPTR scsiBytesIn; /* function for SCSI input */
  393.     FUNCPTR scsiBytesOut; /* function for SCSI output */
  394.     FUNCPTR scsiDmaBytesIn; /* function for SCSI DMA input */
  395.     FUNCPTR scsiDmaBytesOut; /* function for SCSI DMA output */
  396.     FUNCPTR scsiBusPhaseGet; /* function returning the current bus phase */
  397.     FUNCPTR scsiMsgInAck; /* function for accepting an incoming message */
  398.     VOIDFUNCPTR scsiSelTimeOutCvt; /* func. for converting a select time-out */
  399.     UINT maxBytesPerXfer; /* upper bound of ctrl. tansfer counter */
  400.     UINT clkPeriod; /* period of the controller clock (nsec) */
  401.     int scsiCtrlBusId; /* SCSI bus ID of this SCSI controller */
  402.     int scsiPriority; /* priority of task when doing SCSI I/O */
  403.     int scsiBusPhase;           /* current phase of SCSI */
  404.     TBOOL disconnect; /* globally enable / disable disconnect */
  405. /* info on devs. attached to this controller */
  406.     SCSI_PHYS_DEV *physDevArr [MAX_SCSI_PHYS_DEVS];
  407.     FUNCPTR scsiSyncMsgConvert; /* function for converting extended sync
  408.                                  * message in hardware register value */
  409.     VOIDFUNCPTR scsiSetAtn;     /* function to set atn */
  410.     } SCSI_CTRL;
  412. /* definitions relating to SCSI commands */
  414. #define MAX_SCSI_CMD_LENGTH 12  /* maximum length in bytes of a SCSI command */
  416. typedef UINT8 SCSI_COMMAND [MAX_SCSI_CMD_LENGTH];
  418. #define SCSI_GROUP_0_CMD_LENGTH  6
  419. #define SCSI_GROUP_1_CMD_LENGTH 10
  420. #define SCSI_GROUP_5_CMD_LENGTH 12
  422. /* some useful defines and structures for CCS commands */
  424. #define SCSI_FORMAT_DATA_BIT ((UINT8) 0x10)
  425. #define SCSI_COMPLETE_LIST_BIT ((UINT8) 0x08)
  427. #define DEFAULT_INQUIRY_DATA_LENGTH 36
  428. #define REQ_SENSE_ADD_LENGTH_BYTE 7
  429. #define INQUIRY_ADD_LENGTH_BYTE 4
  430. #define MODE_SENSE_ADD_LENGTH_BYTE 0
  431. #define INQUIRY_REMOVABLE_MED_BIT ((UINT8) 0x80)
  433. typedef struct  /* RD_CAP_DATA - results from O_RDONLY CAPACITY */
  434.     {
  435.     int lastLogBlkAdrs; /* address of last logical block on device */
  436.     int blkLength; /* block length of last logical block */
  437.     } RD_CAP_DATA;
  439. #define NON_EXT_SENSE_DATA_LENGTH 4
  441. #define SCSI_SENSE_DATA_CLASS 0x70
  442. #define SCSI_SENSE_DATA_CODE 0x0f
  444. #define SCSI_SENSE_KEY_MASK 0x0f
  446. #define SCSI_EXT_SENSE_CLASS 0x70
  447. #define SCSI_EXT_SENSE_CODE 0x00
  449. /* Min/Max sync value in 4ns step */
  451. #define MAX_SCSI_SYNC_PERIOD  0xfa            /* ~1Mbytes/s value */
  452. #define MIN_SCSI_SYNC_PERIOD  0x19            /* ~10Mbytes/s value */
  453. #define DEFAULT_SCSI_OFFSET   0x4             /* scsi default offset */
  455. /* Type of msgout to send */
  456. #define SCSI_NO_MSGOUT          0x00000000    /* No msgout capability */
  457. #define SCSI_SYNC_MSGOUT        0x00000001    /* Build and send sync message */
  458. #define SCSI_WIDE_MSGOUT        0x00000002    /* Build and send wide message */
  459. #define SCSI_DEV_RST_MSGOUT     0x00000004    /* Build and send wide message */
  460. #define SCSI_OTHER_MSGOUT       0x00000008    /* Send user message */
  462. /* external variable declarations */
  464. IMPORT BOOL            scsiDebug;  /* enable task level debug messages */
  465. IMPORT BOOL            scsiIntsDebug; /* enable int level debug messages */
  466. IMPORT SCSI_CTRL *     pSysScsiCtrl;
  467. IMPORT SCSI_FUNC_TBL * pScsiIfTbl;      /* scsiLib interface function table */
  468. IMPORT UINT32          scsiSelectTimeout;
  469. IMPORT int             blkDevListMutexOptions;
  470. IMPORT int             scsiCtrlMutexOptions;
  471. IMPORT int             scsiCtrlSemOptions;
  472. IMPORT int             scsiPhysDevMutexOptions;
  473. IMPORT int             scsiPhysDevSemOptions;
  477. /* macros */
  479. #define SCSI_MSG
  480. logMsg
  482. #define SCSI_DEBUG_MSG
  483.     if (scsiDebug)
  484. SCSI_MSG
  486. #define SCSI_INT_DEBUG_MSG
  487.     if (scsiIntsDebug)
  488. logMsg
  490. /* macros to get msgout pointer Identify and msg array */
  492. #define SCSI_GET_PTR_IDENTIFY(pScsiPhysDev)    (&pScsiPhysDev->msgOutArray[0])
  493. #define SCSI_GET_PTR_MSGOUT(pScsiPhysDev)      (&pScsiPhysDev->msgOutArray[1])
  495. /*******************************************************************************
  496. *
  497. * SCSI_SWAB - swap bytes on little-endian machines
  498. *
  499. * All fields which are defined as integers (short or long) by the SCSI spec
  500. * and which are passed during the data phase should be pre- or post-processed
  501. * by this macro. The macro does nothing on big-endian machines, but swaps
  502. * bytes for little-endian machines. All SCSI quantities are big-endian.
  503. *
  504. * NOMANUAL
  505. */
  507. #if (_BYTE_ORDER == _BIG_ENDIAN)
  508. #define SCSI_SWAB(pBuffer, bufLength)
  509. #else
  510. #define SCSI_SWAB(pBuffer, bufLength)
  511.     do
  512. {
  513. char temp;
  514. char *pHead = (char *) pBuffer;
  515. char *pTail = (char *) pBuffer + bufLength - 1;
  517. while (pHead < pTail)
  518.     {
  519.     temp = *pTail;
  520.     *pTail-- = *pHead;
  521.     *pHead++ = temp;
  522.     }
  523. } while (FALSE)
  524. #endif
  527. /* function declarations */
  529. extern void   scsi1IfInit ();
  531. #if defined(__STDC__) || defined(__cplusplus)
  533. extern BLK_DEV *       scsiBlkDevCreate (SCSI_PHYS_DEV *, int, int);
  534. extern SCSI_PHYS_DEV * scsiPhysDevCreate (SCSI_CTRL *, int, int, int, int, 
  535.  BOOL, int, int);
  536. extern SCSI_PHYS_DEV * scsiPhysDevIdGet (SCSI_CTRL *, int, int);
  537. extern STATUS         scsiAutoConfig (SCSI_CTRL *);
  538. extern STATUS         scsiBusReset (SCSI_CTRL *);
  539. extern STATUS         scsiCmdBuild (SCSI_COMMAND, int *, UINT8, int, BOOL, 
  540.                                      int, int , UINT8);
  541. extern STATUS         scsiCtrlInit (SCSI_CTRL *);
  542. extern STATUS         scsiFormatUnit (SCSI_PHYS_DEV *, BOOL, int, int, int, 
  543.                                        char *, int);
  544. extern STATUS         scsiInquiry (SCSI_PHYS_DEV *, char *, int);
  545. extern STATUS         scsiIoctl (SCSI_PHYS_DEV *, int, int);
  546. extern STATUS         scsiModeSelect (SCSI_PHYS_DEV *, int, int, char *, int);
  547. extern STATUS         scsiModeSense (SCSI_PHYS_DEV *, int, int, char *, int);
  548. extern STATUS         scsiPhysDevDelete (SCSI_PHYS_DEV *);
  549. extern STATUS         scsiRdSecs (SCSI_BLK_DEV *, int, int, char *);
  550. extern STATUS         scsiReadCapacity (SCSI_PHYS_DEV *, int *, int *);
  551. extern STATUS         scsiReqSense (SCSI_PHYS_DEV *, char *, int);
  552. extern STATUS         scsiShow (SCSI_CTRL *);
  553. extern STATUS         scsiTestUnitRdy (SCSI_PHYS_DEV *);
  554. extern STATUS         scsiTransact (SCSI_PHYS_DEV *, SCSI_TRANSACTION *);
  555. extern STATUS         scsiWrtSecs (SCSI_BLK_DEV *, int, int, char *);
  556. extern char *        scsiPhaseNameGet (int);
  557. extern void         scsiBlkDevInit (SCSI_BLK_DEV *, int, int);
  558. extern void         scsiBlkDevShow (SCSI_PHYS_DEV *);
  559. extern STATUS          scsiBuildByteMsgOut (UINT8 *,UINT8);
  560. extern STATUS          scsiBuildExtMsgOut (UINT8 *,UINT8);
  562. #else /* __STDC__ */
  564. extern BLK_DEV *       scsiBlkDevCreate ();
  565. extern SCSI_PHYS_DEV * scsiPhysDevCreate ();
  566. extern SCSI_PHYS_DEV * scsiPhysDevIdGet ();
  567. extern STATUS         scsiAutoConfig ();
  568. extern STATUS         scsiBusReset ();
  569. extern STATUS         scsiCmdBuild ();
  570. extern STATUS         scsiCtrlInit ();
  571. extern STATUS         scsiFormatUnit ();
  572. extern STATUS         scsiInquiry ();
  573. extern STATUS         scsiIoctl ();
  574. extern STATUS         scsiModeSelect ();
  575. extern STATUS         scsiModeSense ();
  576. extern STATUS         scsiPhysDevDelete ();
  577. extern STATUS         scsiRdSecs ();
  578. extern STATUS         scsiReadCapacity ();
  579. extern STATUS         scsiReqSense ();
  580. extern STATUS         scsiShow ();
  581. extern STATUS         scsiTestUnitRdy ();
  582. extern STATUS         scsiTransact ();
  583. extern STATUS         scsiWrtSecs ();
  584. extern char *        scsiPhaseNameGet ();
  585. extern void         scsiBlkDevInit ();
  586. extern void         scsiBlkDevShow ();
  587. extern STATUS          scsiBuildByteMsgOut ();
  588. extern STATUS          scsiBuildExtMsgOut ();
  590. #endif /* __STDC__ */
  592. #ifdef __cplusplus
  593. }
  594. #endif
  596. #endif /* _ASMLANGUAGE */
  597. #endif /* __INCscsi1Libh */