Shamusworld >> Repos - virtualjaguar/blob - src/wnaspi32.h

   1 /******************************************************************************
   2 **
   3 **  Module Name:    wnaspi32.h
   4 **
   5 **  Description:    Header file for ASPI for Win32.  This header includes
   6 **                  macro and type declarations, and can be included without
   7 **                  modification when using Borland C++ or Microsoft Visual
   8 **                  C++ with 32-bit compilation.  If you are using a different
   9 **                  compiler then you MUST ensure that structures are packed
  10 **                  onto byte alignments, and that C++ name mangling is turned
  11 **                  off.
  12 **
  13 **  Notes:          This file created using 4 spaces per tab.
  14 **
  15 ******************************************************************************/
  16
  17 #ifndef __WNASPI32_H__
  18 #define __WNASPI32_H__
  19
  20 // Make sure structures are packed and undecorated.
  21
  22 #ifdef __BORLANDC__
  23 #pragma option -a1
  24 #endif //__BORLANDC__
  25
  26 #ifdef _MSC_VER
  27 #pragma pack(1)
  28 #endif //__MSC_VER
  29
  30 #ifdef __GCCWIN32__
  31 #pragma pack(1)
  32 #endif
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif //__cplusplus
  37
  38 //*****************************************************************************
  39 //      %%% SCSI MISCELLANEOUS EQUATES %%%
  40 //*****************************************************************************
  41
  42 #define SENSE_LEN                   14          // Default sense buffer length
  43 #define SRB_DIR_SCSI                0x00        // Direction determined by SCSI
  44 #define SRB_POSTING                 0x01        // Enable ASPI posting
  45 #define SRB_ENABLE_RESIDUAL_COUNT   0x04        // Enable residual byte count reporting
  46 #define SRB_DIR_IN                  0x08        // Transfer from SCSI target to host
  47 #define SRB_DIR_OUT                 0x10        // Transfer from host to SCSI target
  48 #define SRB_EVENT_NOTIFY            0x40        // Enable ASPI event notification
  49
  50 #define RESIDUAL_COUNT_SUPPORTED    0x02        // Extended buffer flag
  51 #define MAX_SRB_TIMEOUT             108000lu    // 30 hour maximum timeout in s
  52 #define DEFAULT_SRB_TIMEOUT         108000lu    // Max timeout by default
  53
  54
  55 //*****************************************************************************
  56 //      %%% ASPI Command Definitions %%%
  57 //*****************************************************************************
  58
  59 #define SC_HA_INQUIRY               0x00        // Host adapter inquiry
  60 #define SC_GET_DEV_TYPE             0x01        // Get device type
  61 #define SC_EXEC_SCSI_CMD            0x02        // Execute SCSI command
  62 #define SC_ABORT_SRB                0x03        // Abort an SRB
  63 #define SC_RESET_DEV                0x04        // SCSI bus device reset
  64 #define SC_SET_HA_PARMS             0x05        // Set HA parameters
  65 #define SC_GET_DISK_INFO            0x06        // Get Disk information
  66 #define SC_RESCAN_SCSI_BUS          0x07        // ReBuild SCSI device map
  67 #define SC_GETSET_TIMEOUTS          0x08        // Get/Set target timeouts
  68
  69 //*****************************************************************************
  70 //      %%% SRB Status %%%
  71 //*****************************************************************************
  72
  73 #define SS_PENDING                  0x00        // SRB being processed
  74 #define SS_COMP                     0x01        // SRB completed without error
  75 #define SS_ABORTED                  0x02        // SRB aborted
  76 #define SS_ABORT_FAIL               0x03        // Unable to abort SRB
  77 #define SS_ERR                      0x04        // SRB completed with error
  78
  79 #define SS_INVALID_CMD              0x80        // Invalid ASPI command
  80 #define SS_INVALID_HA               0x81        // Invalid host adapter number
  81 #define SS_NO_DEVICE                0x82        // SCSI device not installed
  82
  83 #define SS_INVALID_SRB              0xE0        // Invalid parameter set in SRB
  84 #define SS_OLD_MANAGER              0xE1        // ASPI manager doesn't support Windows
  85 #define SS_BUFFER_ALIGN             0xE1        // Buffer not aligned (replaces OLD_MANAGER in Win32)
  86 #define SS_ILLEGAL_MODE             0xE2        // Unsupported Windows mode
  87 #define SS_NO_ASPI                  0xE3        // No ASPI managers resident
  88 #define SS_FAILED_INIT              0xE4        // ASPI for windows failed init
  89 #define SS_ASPI_IS_BUSY             0xE5        // No resources available to execute cmd
  90 #define SS_BUFFER_TOO_BIG           0xE6        // Buffer size too big to handle!
  91 #define SS_MISMATCHED_COMPONENTS    0xE7        // The DLLs/EXEs of ASPI don't version check
  92 #define SS_NO_ADAPTERS              0xE8        // No host adapters to manage
  93 #define SS_INSUFFICIENT_RESOURCES   0xE9        // Couldn't allocate resources needed to init
  94 #define SS_ASPI_IS_SHUTDOWN         0xEA        // Call came to ASPI after PROCESS_DETACH
  95 #define SS_BAD_INSTALL              0xEB        // The DLL or other components are installed wrong
  96
  97 //*****************************************************************************
  98 //      %%% Host Adapter Status %%%
  99 //*****************************************************************************
 100
 101 #define HASTAT_OK                   0x00        // Host adapter did not detect an                                                                                                                       // error
 102 #define HASTAT_SEL_TO               0x11        // Selection Timeout
 103 #define HASTAT_DO_DU                0x12        // Data overrun data underrun
 104 #define HASTAT_BUS_FREE             0x13        // Unexpected bus free
 105 #define HASTAT_PHASE_ERR            0x14        // Target bus phase sequence                                                                                                                            // failure
 106 #define HASTAT_TIMEOUT              0x09        // Timed out while SRB was                                                                                                                                      waiting to beprocessed.
 107 #define HASTAT_COMMAND_TIMEOUT      0x0B        // Adapter timed out processing SRB.
 108 #define HASTAT_MESSAGE_REJECT       0x0D        // While processing SRB, the                                                                                                                            // adapter received a MESSAGE
 109 #define HASTAT_BUS_RESET            0x0E        // A bus reset was detected.
 110 #define HASTAT_PARITY_ERROR         0x0F        // A parity error was detected.
 111 #define HASTAT_REQUEST_SENSE_FAILED 0x10        // The adapter failed in issuing
 112
 113 //*****************************************************************************
 114 //          %%% SRB - HOST ADAPTER INQUIRY - SC_HA_INQUIRY (0) %%%
 115 //*****************************************************************************
 116
 117 typedef struct                                  // Offset
 118 {                                               // HX/DEC
 119     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_HA_INQUIRY
 120     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 121     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 122     BYTE        SRB_Flags;                      // 03/003 ASPI request flags
 123     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved, MUST = 0
 124     BYTE        HA_Count;                       // 08/008 Number of host adapters present
 125     BYTE        HA_SCSI_ID;                     // 09/009 SCSI ID of host adapter
 126     BYTE        HA_ManagerId[16];               // 0A/010 String describing the manager
 127     BYTE        HA_Identifier[16];              // 1A/026 String describing the host adapter
 128     BYTE        HA_Unique[16];                  // 2A/042 Host Adapter Unique parameters
 129     WORD        HA_Rsvd1;                       // 3A/058 Reserved, MUST = 0
 130 }
 131 SRB_HAInquiry, *PSRB_HAInquiry, FAR *LPSRB_HAInquiry;
 132
 133 //*****************************************************************************
 134 //          %%% SRB - GET DEVICE TYPE - SC_GET_DEV_TYPE (1) %%%
 135 //*****************************************************************************
 136
 137 typedef struct                                  // Offset
 138 {                                               // HX/DEC
 139     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_GET_DEV_TYPE
 140     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 141     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 142     BYTE        SRB_Flags;                      // 03/003 Reserved, MUST = 0
 143     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved, MUST = 0
 144     BYTE        SRB_Target;                     // 08/008 Target's SCSI ID
 145     BYTE        SRB_Lun;                        // 09/009 Target's LUN number
 146     BYTE        SRB_DeviceType;                 // 0A/010 Target's peripheral device type
 147     BYTE        SRB_Rsvd1;                      // 0B/011 Reserved, MUST = 0
 148 }
 149 SRB_GDEVBlock, *PSRB_GDEVBlock, FAR *LPSRB_GDEVBlock;
 150
 151 //*****************************************************************************
 152 //          %%% SRB - EXECUTE SCSI COMMAND - SC_EXEC_SCSI_CMD (2) %%%
 153 //*****************************************************************************
 154
 155 typedef struct                                  // Offset
 156 {                                               // HX/DEC
 157     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_EXEC_SCSI_CMD
 158     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 159     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 160     BYTE        SRB_Flags;                      // 03/003 ASPI request flags
 161     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved
 162     BYTE        SRB_Target;                     // 08/008 Target's SCSI ID
 163     BYTE        SRB_Lun;                        // 09/009 Target's LUN number
 164     WORD        SRB_Rsvd1;                      // 0A/010 Reserved for Alignment
 165     DWORD       SRB_BufLen;                     // 0C/012 Data Allocation Length
 166     BYTE        FAR *SRB_BufPointer;            // 10/016 Data Buffer Pointer
 167     BYTE        SRB_SenseLen;                   // 14/020 Sense Allocation Length
 168     BYTE        SRB_CDBLen;                     // 15/021 CDB Length
 169     BYTE        SRB_HaStat;                     // 16/022 Host Adapter Status
 170     BYTE        SRB_TargStat;                   // 17/023 Target Status
 171     VOID        FAR *SRB_PostProc;              // 18/024 Post routine
 172     BYTE        SRB_Rsvd2[20];                  // 1C/028 Reserved, MUST = 0
 173     BYTE        CDBByte[16];                    // 30/048 SCSI CDB
 174     BYTE        SenseArea[SENSE_LEN+2];         // 50/064 Request Sense buffer
 175 }
 176 SRB_ExecSCSICmd, *PSRB_ExecSCSICmd, FAR *LPSRB_ExecSCSICmd;
 177
 178 //*****************************************************************************
 179 //          %%% SRB - ABORT AN SRB - SC_ABORT_SRB (3) %%%
 180 //*****************************************************************************
 181
 182 typedef struct                                  // Offset
 183 {                                               // HX/DEC
 184     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_ABORT_SRB
 185     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 186     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 187     BYTE        SRB_Flags;                      // 03/003 Reserved
 188     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved
 189     VOID        FAR *SRB_ToAbort;               // 08/008 Pointer to SRB to abort
 190 }
 191 SRB_Abort, *PSRB_Abort, FAR *LPSRB_Abort;
 192
 193 //*****************************************************************************
 194 //          %%% SRB - BUS DEVICE RESET - SC_RESET_DEV (4) %%%
 195 //*****************************************************************************
 196
 197 typedef struct                                  // Offset
 198 {                                               // HX/DEC
 199     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_RESET_DEV
 200     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 201     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 202     BYTE        SRB_Flags;                      // 03/003 ASPI request flags
 203     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved
 204     BYTE        SRB_Target;                     // 08/008 Target's SCSI ID
 205     BYTE        SRB_Lun;                        // 09/009 Target's LUN number
 206     BYTE        SRB_Rsvd1[12];                  // 0A/010 Reserved for Alignment
 207     BYTE        SRB_HaStat;                     // 16/022 Host Adapter Status
 208     BYTE        SRB_TargStat;                   // 17/023 Target Status
 209     VOID        FAR *SRB_PostProc;              // 18/024 Post routine
 210     BYTE        SRB_Rsvd2[36];                  // 1C/028 Reserved, MUST = 0
 211 }
 212 SRB_BusDeviceReset, *PSRB_BusDeviceReset, FAR *LPSRB_BusDeviceReset;
 213
 214 //*****************************************************************************
 215 //          %%% SRB - GET DISK INFORMATION - SC_GET_DISK_INFO %%%
 216 //*****************************************************************************
 217
 218 typedef struct                                  // Offset
 219 {                                               // HX/DEC
 220     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_GET_DISK_INFO
 221     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 222     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 223     BYTE        SRB_Flags;                      // 03/003 Reserved, MUST = 0
 224     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved, MUST = 0
 225     BYTE        SRB_Target;                     // 08/008 Target's SCSI ID
 226     BYTE        SRB_Lun;                        // 09/009 Target's LUN number
 227     BYTE        SRB_DriveFlags;                 // 0A/010 Driver flags
 228     BYTE        SRB_Int13HDriveInfo;            // 0B/011 Host Adapter Status
 229     BYTE        SRB_Heads;                      // 0C/012 Preferred number of heads translation
 230     BYTE        SRB_Sectors;                    // 0D/013 Preferred number of sectors translation
 231     BYTE        SRB_Rsvd1[10];                  // 0E/014 Reserved, MUST = 0
 232 }
 233 SRB_GetDiskInfo, *PSRB_GetDiskInfo, FAR *LPSRB_GetDiskInfo;
 234
 235 //*****************************************************************************
 236 //          %%%  SRB - RESCAN SCSI BUS(ES) ON SCSIPORT %%%
 237 //*****************************************************************************
 238
 239 typedef struct                                  // Offset
 240 {                                               // HX/DEC
 241     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_RESCAN_SCSI_BUS
 242     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 243     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 244     BYTE        SRB_Flags;                      // 03/003 Reserved, MUST = 0
 245     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved, MUST = 0
 246 }
 247 SRB_RescanPort, *PSRB_RescanPort, FAR *LPSRB_RescanPort;
 248
 249 //*****************************************************************************
 250 //          %%% SRB - GET/SET TARGET TIMEOUTS %%%
 251 //*****************************************************************************
 252
 253 typedef struct                                  // Offset
 254 {                                               // HX/DEC
 255     BYTE        SRB_Cmd;                        // 00/000 ASPI command code = SC_GETSET_TIMEOUTS
 256     BYTE        SRB_Status;                     // 01/001 ASPI command status byte
 257     BYTE        SRB_HaId;                       // 02/002 ASPI host adapter number
 258     BYTE        SRB_Flags;                      // 03/003 ASPI request flags
 259     DWORD       SRB_Hdr_Rsvd;                   // 04/004 Reserved, MUST = 0
 260     BYTE        SRB_Target;                     // 08/008 Target's SCSI ID
 261     BYTE        SRB_Lun;                        // 09/009 Target's LUN number
 262     DWORD       SRB_Timeout;                    // 0A/010 Timeout in half seconds
 263 }
 264 SRB_GetSetTimeouts, *PSRB_GetSetTimeouts, FAR *LPSRB_GetSetTimeouts;
 265
 266 //*****************************************************************************
 267 //          %%% ASPIBUFF - Structure For Controllng I/O Buffers %%%
 268 //*****************************************************************************
 269
 270 typedef struct tag_ASPI32BUFF                   // Offset
 271 {                                               // HX/DEC
 272     PBYTE                   AB_BufPointer;      // 00/000 Pointer to the ASPI allocated buffer
 273     DWORD                   AB_BufLen;          // 04/004 Length in bytes of the buffer
 274     DWORD                   AB_ZeroFill;        // 08/008 Flag set to 1 if buffer should be zeroed
 275     DWORD                   AB_Reserved;        // 0C/012 Reserved
 276 }
 277 ASPI32BUFF, *PASPI32BUFF, FAR *LPASPI32BUFF;
 278
 279 //*****************************************************************************
 280 //          %%% PROTOTYPES - User Callable ASPI for Win32 Functions %%%
 281 //*****************************************************************************
 282
 283 typedef void *LPSRB;
 284
 285 #if defined(__BORLANDC__)
 286
 287 DWORD _import GetASPI32SupportInfo( void );
 288 DWORD _import SendASPI32Command( LPSRB );
 289 BOOL _import GetASPI32Buffer( PASPI32BUFF );
 290 BOOL _import FreeASPI32Buffer( PASPI32BUFF );
 291 BOOL _import TranslateASPI32Address( PDWORD, PDWORD );
 292
 293 #elif defined(_MSC_VER)
 294
 295 __declspec(dllimport) DWORD GetASPI32SupportInfo( void );
 296 __declspec(dllimport) DWORD SendASPI32Command( LPSRB );
 297 __declspec(dllimport) BOOL GetASPI32Buffer( PASPI32BUFF );
 298 __declspec(dllimport) BOOL FreeASPI32Buffer( PASPI32BUFF );
 299 __declspec(dllimport) BOOL TranslateASPI32Address( PDWORD, PDWORD );
 300
 301 #else
 302
 303 extern DWORD GetASPI32SupportInfo( void );
 304 extern DWORD GetASPI32Command( LPSRB );
 305 extern BOOL GetASPI32Buffer( PASPI32BUFF );
 306 extern BOOL FreeASPI32Buffer( PASPI32BUFF );
 307 extern BOOL TranslateASPI32Address( PDWORD, PDWORD );
 308
 309 #endif
 310
 311 // Restore compiler default packing and close off the C declarations.
 312
 313 #ifdef __BORLANDC__
 314 #pragma option -a.
 315 #endif //__BORLANDC__
 316
 317 #ifdef _MSC_VER
 318 #pragma pack()
 319 #endif //_MSC_VER
 320
 321 #ifdef __GCCWIN32__
 322 #pragma pack()
 323 #endif
 324
 325 #ifdef __cplusplus
 326 }
 327 #endif //__cplusplus
 328
 329 #endif //__WNASPI32_H__