reactos/w32api/include/ddk/minitape.h

   1 /*
   2  * minitape.h
   3  *
   4  * Minitape driver interface
   5  *
   6  * This file is part of the w32api package.
   7  *
   8  * Contributors:
   9  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10  *
  11  * THIS SOFTWARE IS NOT COPYRIGHTED
  12  *
  13  * This source code is offered for use in the public domain. You may
  14  * use, modify or distribute it freely.
  15  *
  16  * This code is distributed in the hope that it will be useful but
  17  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18  * DISCLAIMED. This includes but is not limited to warranties of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  */
  22 #ifndef __MINITAPE_H
  23 #define __MINITAPE_H
  24
  25 #if __GNUC__ >=3
  26 #pragma GCC system_header
  27 #endif
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 #pragma pack(push,4)
  34
  35 #define MEDIA_ERASEABLE                   0x00000001
  36 #define MEDIA_WRITE_ONCE                  0x00000002
  37 #define MEDIA_READ_ONLY                   0x00000004
  38 #define MEDIA_READ_WRITE                  0x00000008
  39 #define MEDIA_WRITE_PROTECTED             0x00000100
  40 #define MEDIA_CURRENTLY_MOUNTED           0x80000000
  41
  42 typedef enum _TAPE_STATUS {
  43         TAPE_STATUS_SEND_SRB_AND_CALLBACK,
  44         TAPE_STATUS_CALLBACK,
  45         TAPE_STATUS_CHECK_TEST_UNIT_READY,
  46         TAPE_STATUS_SUCCESS,
  47         TAPE_STATUS_INSUFFICIENT_RESOURCES,
  48         TAPE_STATUS_NOT_IMPLEMENTED,
  49         TAPE_STATUS_INVALID_DEVICE_REQUEST,
  50         TAPE_STATUS_INVALID_PARAMETER,
  51         TAPE_STATUS_MEDIA_CHANGED,
  52         TAPE_STATUS_BUS_RESET,
  53         TAPE_STATUS_SETMARK_DETECTED,
  54         TAPE_STATUS_FILEMARK_DETECTED,
  55         TAPE_STATUS_BEGINNING_OF_MEDIA,
  56         TAPE_STATUS_END_OF_MEDIA,
  57         TAPE_STATUS_BUFFER_OVERFLOW,
  58         TAPE_STATUS_NO_DATA_DETECTED,
  59         TAPE_STATUS_EOM_OVERFLOW,
  60         TAPE_STATUS_NO_MEDIA,
  61         TAPE_STATUS_IO_DEVICE_ERROR,
  62         TAPE_STATUS_UNRECOGNIZED_MEDIA,
  63         TAPE_STATUS_DEVICE_NOT_READY,
  64         TAPE_STATUS_MEDIA_WRITE_PROTECTED,
  65         TAPE_STATUS_DEVICE_DATA_ERROR,
  66         TAPE_STATUS_NO_SUCH_DEVICE,
  67         TAPE_STATUS_INVALID_BLOCK_LENGTH,
  68         TAPE_STATUS_IO_TIMEOUT,
  69         TAPE_STATUS_DEVICE_NOT_CONNECTED,
  70         TAPE_STATUS_DATA_OVERRUN,
  71         TAPE_STATUS_DEVICE_BUSY,
  72         TAPE_STATUS_REQUIRES_CLEANING,
  73         TAPE_STATUS_CLEANER_CARTRIDGE_INSTALLED
  74 } TAPE_STATUS, *PTAPE_STATUS;
  75
  76 #define INQUIRYDATABUFFERSIZE 36
  77 #ifndef _INQUIRYDATA_DEFINED /* also in scsi.h */
  78 #define _INQUIRYDATA_DEFINED
  79 typedef struct _INQUIRYDATA {
  80         UCHAR  DeviceType : 5;
  81         UCHAR  DeviceTypeQualifier : 3;
  82         UCHAR  DeviceTypeModifier : 7;
  83         UCHAR  RemovableMedia : 1;
  84         union {
  85                 UCHAR  Versions;
  86                 struct {
  87                         UCHAR  ANSIVersion : 3;
  88                         UCHAR  ECMAVersion : 3;
  89                         UCHAR  ISOVersion : 2;
  90                 };
  91         };
  92         UCHAR  ResponseDataFormat : 4;
  93         UCHAR  HiSupport : 1;
  94         UCHAR  NormACA : 1;
  95         UCHAR  TerminateTask : 1;
  96         UCHAR  AERC : 1;
  97         UCHAR  AdditionalLength;
  98         UCHAR  Reserved;
  99         UCHAR  Addr16 : 1;
 100         UCHAR  Addr32 : 1;
 101         UCHAR  AckReqQ: 1;
 102         UCHAR  MediumChanger : 1;
 103         UCHAR  MultiPort : 1;
 104         UCHAR  ReservedBit2 : 1;
 105         UCHAR  EnclosureServices : 1;
 106         UCHAR  ReservedBit3 : 1;
 107         UCHAR  SoftReset : 1;
 108         UCHAR  CommandQueue : 1;
 109         UCHAR  TransferDisable : 1;
 110         UCHAR  LinkedCommands : 1;
 111         UCHAR  Synchronous : 1;
 112         UCHAR  Wide16Bit : 1;
 113         UCHAR  Wide32Bit : 1;
 114         UCHAR  RelativeAddressing : 1;
 115         UCHAR  VendorId[8];
 116         UCHAR  ProductId[16];
 117         UCHAR  ProductRevisionLevel[4];
 118         UCHAR  VendorSpecific[20];
 119         UCHAR  Reserved3[40];
 120 } INQUIRYDATA, *PINQUIRYDATA;
 121 #endif
 122
 123 typedef struct _MODE_CAPABILITIES_PAGE {
 124         UCHAR PageCode : 6;
 125         UCHAR Reserved1 : 2;
 126         UCHAR PageLength;
 127         UCHAR Reserved2[2];
 128         UCHAR RO : 1;
 129         UCHAR Reserved3 : 4;
 130         UCHAR SPREV : 1;
 131         UCHAR Reserved4 : 2;
 132         UCHAR Reserved5 : 3;
 133         UCHAR EFMT : 1;
 134         UCHAR Reserved6 : 1;
 135         UCHAR QFA : 1;
 136         UCHAR Reserved7 : 2;
 137         UCHAR LOCK : 1;
 138         UCHAR LOCKED : 1;
 139         UCHAR PREVENT : 1;
 140         UCHAR UNLOAD : 1;
 141         UCHAR Reserved8 : 2;
 142         UCHAR ECC : 1;
 143         UCHAR CMPRS : 1;
 144         UCHAR Reserved9 : 1;
 145         UCHAR BLK512 : 1;
 146         UCHAR BLK1024 : 1;
 147         UCHAR Reserved10 : 4;
 148         UCHAR SLOWB : 1;
 149         UCHAR MaximumSpeedSupported[2];
 150         UCHAR MaximumStoredDefectedListEntries[2];
 151         UCHAR ContinuousTransferLimit[2];
 152         UCHAR CurrentSpeedSelected[2];
 153         UCHAR BufferSize[2];
 154         UCHAR Reserved11[2];
 155 } MODE_CAPABILITIES_PAGE, *PMODE_CAPABILITIES_PAGE;
 156
 157 typedef BOOLEAN DDKAPI
 158 (*TAPE_VERIFY_INQUIRY_ROUTINE)(
 159         IN PINQUIRYDATA  InquiryData,
 160         IN PMODE_CAPABILITIES_PAGE ModeCapabilitiesPage);
 161
 162 typedef VOID DDKAPI
 163 (*TAPE_EXTENSION_INIT_ROUTINE)(
 164   IN PVOID  MinitapeExtension,
 165   IN PINQUIRYDATA  InquiryData,
 166   IN PMODE_CAPABILITIES_PAGE  ModeCapabilitiesPage);
 167
 168 typedef VOID DDKAPI
 169 (*TAPE_ERROR_ROUTINE)(
 170     IN PVOID  MinitapeExtension,
 171     IN PSCSI_REQUEST_BLOCK  Srb,
 172     IN OUT PTAPE_STATUS  TapeStatus);
 173
 174 typedef TAPE_STATUS DDKAPI
 175 (*TAPE_PROCESS_COMMAND_ROUTINE)(
 176   IN OUT PVOID  MinitapeExtension,
 177   IN OUT PVOID  CommandExtension,
 178   IN OUT PVOID  CommandParameters,
 179   IN OUT PSCSI_REQUEST_BLOCK  Srb,
 180   IN ULONG  CallNumber,
 181   IN TAPE_STATUS  StatusOfLastCommand,
 182   IN OUT PULONG  RetryFlags);
 183
 184 #define TAPE_RETRY_MASK                   0x0000FFFF
 185 #define IGNORE_ERRORS                     0x00010000
 186 #define RETURN_ERRORS                     0x00020000
 187
 188 typedef struct _TAPE_INIT_DATA {
 189   TAPE_VERIFY_INQUIRY_ROUTINE  VerifyInquiry;
 190   BOOLEAN  QueryModeCapabilitiesPage;
 191   ULONG  MinitapeExtensionSize;
 192   TAPE_EXTENSION_INIT_ROUTINE  ExtensionInit;
 193   ULONG  DefaultTimeOutValue;
 194   TAPE_ERROR_ROUTINE  TapeError;
 195   ULONG  CommandExtensionSize;
 196   TAPE_PROCESS_COMMAND_ROUTINE  CreatePartition;
 197   TAPE_PROCESS_COMMAND_ROUTINE  Erase;
 198   TAPE_PROCESS_COMMAND_ROUTINE  GetDriveParameters;
 199   TAPE_PROCESS_COMMAND_ROUTINE  GetMediaParameters;
 200   TAPE_PROCESS_COMMAND_ROUTINE  GetPosition;
 201   TAPE_PROCESS_COMMAND_ROUTINE  GetStatus;
 202   TAPE_PROCESS_COMMAND_ROUTINE  Prepare;
 203   TAPE_PROCESS_COMMAND_ROUTINE  SetDriveParameters;
 204   TAPE_PROCESS_COMMAND_ROUTINE  SetMediaParameters;
 205   TAPE_PROCESS_COMMAND_ROUTINE  SetPosition;
 206   TAPE_PROCESS_COMMAND_ROUTINE  WriteMarks;
 207   TAPE_PROCESS_COMMAND_ROUTINE  PreProcessReadWrite; /* optional */
 208 } TAPE_INIT_DATA, *PTAPE_INIT_DATA;
 209
 210 typedef struct _TAPE_PHYS_POSITION {
 211         ULONG  SeekBlockAddress;
 212         ULONG  SpaceBlockCount;
 213 } TAPE_PHYS_POSITION, PTAPE_PHYS_POSITION;
 214
 215 #pragma pack(pop)
 216
 217 #ifdef __cplusplus
 218 }
 219 #endif
 220
 221 #endif /* __MINITAPE_H */