reactos/include/ddk/ntddchgr.h

   1 /*
   2  * ntddchgr.h
   3  *
   4  * Media changer IOCTL 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
  23 #ifndef __NTDDCHGR_H
  24 #define __NTDDCHGR_H
  25
  26 #if __GNUC__ >=3
  27 #pragma GCC system_header
  28 #endif
  29
  30 #include "ntddstor.h"
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #define DD_CHANGER_DEVICE_NAME            "\\Device\\Changer"
  37 #define DD_CHANGER_DEVICE_NAME_U          L"\\Device\\Changer"
  38
  39 #define IOCTL_CHANGER_BASE                FILE_DEVICE_CHANGER
  40
  41 #define IOCTL_CHANGER_EXCHANGE_MEDIUM  \
  42   CTL_CODE(IOCTL_CHANGER_BASE, 0x0008, METHOD_BUFFERED, FILE_READ_ACCESS)
  43
  44 #define IOCTL_CHANGER_GET_ELEMENT_STATUS \
  45   CTL_CODE(IOCTL_CHANGER_BASE, 0x0005, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS)
  46
  47 #define IOCTL_CHANGER_GET_PARAMETERS \
  48   CTL_CODE(IOCTL_CHANGER_BASE, 0x0000, METHOD_BUFFERED, FILE_READ_ACCESS)
  49
  50 #define IOCTL_CHANGER_GET_PRODUCT_DATA \
  51   CTL_CODE(IOCTL_CHANGER_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS)
  52
  53 #define IOCTL_CHANGER_GET_STATUS \
  54   CTL_CODE(IOCTL_CHANGER_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS)
  55
  56 #define IOCTL_CHANGER_INITIALIZE_ELEMENT_STATUS \
  57   CTL_CODE(IOCTL_CHANGER_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS)
  58
  59 #define IOCTL_CHANGER_MOVE_MEDIUM \
  60   CTL_CODE(IOCTL_CHANGER_BASE, 0x0009, METHOD_BUFFERED, FILE_READ_ACCESS)
  61
  62 #define IOCTL_CHANGER_QUERY_VOLUME_TAGS \
  63   CTL_CODE(IOCTL_CHANGER_BASE, 0x000B, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS)
  64
  65 #define IOCTL_CHANGER_REINITIALIZE_TRANSPORT \
  66   CTL_CODE(IOCTL_CHANGER_BASE, 0x000A, METHOD_BUFFERED, FILE_READ_ACCESS)
  67
  68 #define IOCTL_CHANGER_SET_ACCESS \
  69   CTL_CODE(IOCTL_CHANGER_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS)
  70
  71 #define IOCTL_CHANGER_SET_POSITION \
  72   CTL_CODE(IOCTL_CHANGER_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS)
  73
  74
  75 #define MAX_VOLUME_ID_SIZE                36
  76 #define MAX_VOLUME_TEMPLATE_SIZE          40
  77
  78 typedef  enum _ELEMENT_TYPE {
  79   AllElements,
  80   ChangerTransport,
  81   ChangerSlot,
  82   ChangerIEPort,
  83   ChangerDrive,
  84   ChangerDoor,
  85   ChangerKeypad,
  86   ChangerMaxElement
  87 } ELEMENT_TYPE, *PELEMENT_TYPE;
  88
  89 typedef struct _CHANGER_ELEMENT {
  90   ELEMENT_TYPE  ElementType;
  91   ULONG  ElementAddress;
  92 } CHANGER_ELEMENT, *PCHANGER_ELEMENT;
  93
  94 typedef struct _CHANGER_ELEMENT_LIST {
  95   CHANGER_ELEMENT  Element;
  96   ULONG  NumberOfElements;
  97 } CHANGER_ELEMENT_LIST, *PCHANGER_ELEMENT_LIST;
  98
  99 typedef struct _CHANGER_INITIALIZE_ELEMENT_STATUS {
 100   CHANGER_ELEMENT_LIST  ElementList;
 101   BOOLEAN  BarCodeScan;
 102 } CHANGER_INITIALIZE_ELEMENT_STATUS, *PCHANGER_INITIALIZE_ELEMENT_STATUS;
 103
 104 typedef struct _CHANGER_READ_ELEMENT_STATUS {
 105   CHANGER_ELEMENT_LIST  ElementList;
 106   BOOLEAN  VolumeTagInfo;
 107 } CHANGER_READ_ELEMENT_STATUS, *PCHANGER_READ_ELEMENT_STATUS;
 108
 109
 110 typedef struct _CHANGER_SET_POSITION {
 111         CHANGER_ELEMENT  Transport;
 112         CHANGER_ELEMENT  Destination;
 113         BOOLEAN  Flip;
 114 } CHANGER_SET_POSITION, *PCHANGER_SET_POSITION;
 115
 116 typedef struct _CHANGER_EXCHANGE_MEDIUM {
 117         CHANGER_ELEMENT  Transport;
 118         CHANGER_ELEMENT  Source;
 119         CHANGER_ELEMENT  Destination1;
 120         CHANGER_ELEMENT  Destination2;
 121         BOOLEAN  Flip1;
 122         BOOLEAN  Flip2;
 123 } CHANGER_EXCHANGE_MEDIUM, *PCHANGER_EXCHANGE_MEDIUM;
 124
 125 typedef struct _CHANGER_MOVE_MEDIUM {
 126   CHANGER_ELEMENT  Transport;
 127   CHANGER_ELEMENT  Source;
 128   CHANGER_ELEMENT  Destination;
 129   BOOLEAN  Flip;
 130 } CHANGER_MOVE_MEDIUM, *PCHANGER_MOVE_MEDIUM;
 131
 132 #define VENDOR_ID_LENGTH                  8
 133 #define PRODUCT_ID_LENGTH                 16
 134 #define REVISION_LENGTH                   4
 135 #define SERIAL_NUMBER_LENGTH              32
 136
 137 typedef  struct _CHANGER_PRODUCT_DATA {
 138         UCHAR  VendorId[VENDOR_ID_LENGTH];
 139         UCHAR  ProductId[PRODUCT_ID_LENGTH];
 140         UCHAR  Revision[REVISION_LENGTH];
 141         UCHAR  SerialNumber[SERIAL_NUMBER_LENGTH];
 142         UCHAR  DeviceType;
 143 } CHANGER_PRODUCT_DATA, *PCHANGER_PRODUCT_DATA;
 144
 145 /* CHANGER_SET_ACCESS.Control constants */
 146 #define LOCK_ELEMENT                      0
 147 #define UNLOCK_ELEMENT                    1
 148 #define EXTEND_IEPORT                     2
 149 #define RETRACT_IEPORT                    3
 150
 151 typedef struct _CHANGER_SET_ACCESS {
 152   CHANGER_ELEMENT  Element;
 153   ULONG  Control;
 154 } CHANGER_SET_ACCESS, *PCHANGER_SET_ACCESS;
 155
 156
 157 typedef enum _CHANGER_DEVICE_PROBLEM_TYPE {
 158   DeviceProblemNone,
 159   DeviceProblemHardware,
 160   DeviceProblemCHMError,
 161   DeviceProblemDoorOpen,
 162   DeviceProblemCalibrationError,
 163   DeviceProblemTargetFailure,
 164   DeviceProblemCHMMoveError,
 165   DeviceProblemCHMZeroError,
 166   DeviceProblemCartridgeInsertError,
 167   DeviceProblemPositionError,
 168   DeviceProblemSensorError,
 169   DeviceProblemCartridgeEjectError,
 170   DeviceProblemGripperError,
 171   DeviceProblemDriveError
 172 } CHANGER_DEVICE_PROBLEM_TYPE, *PCHANGER_DEVICE_PROBLEM_TYPE;
 173
 174 /* CHANGER_ELEMENT_STATUS(_EX).Flags constants */
 175 #define ELEMENT_STATUS_FULL               0x00000001
 176 #define ELEMENT_STATUS_IMPEXP             0x00000002
 177 #define ELEMENT_STATUS_EXCEPT             0x00000004
 178 #define ELEMENT_STATUS_ACCESS             0x00000008
 179 #define ELEMENT_STATUS_EXENAB             0x00000010
 180 #define ELEMENT_STATUS_INENAB             0x00000020
 181 #define ELEMENT_STATUS_PRODUCT_DATA       0x00000040
 182 #define ELEMENT_STATUS_LUN_VALID          0x00001000
 183 #define ELEMENT_STATUS_ID_VALID           0x00002000
 184 #define ELEMENT_STATUS_NOT_BUS            0x00008000
 185 #define ELEMENT_STATUS_INVERT             0x00400000
 186 #define ELEMENT_STATUS_SVALID             0x00800000
 187 #define ELEMENT_STATUS_PVOLTAG            0x10000000
 188 #define ELEMENT_STATUS_AVOLTAG            0x20000000
 189
 190 /* CHANGER_ELEMENT_STATUS(_EX).ExceptionCode constants */
 191 #define ERROR_LABEL_UNREADABLE            0x00000001
 192 #define ERROR_LABEL_QUESTIONABLE          0x00000002
 193 #define ERROR_SLOT_NOT_PRESENT            0x00000004
 194 #define ERROR_DRIVE_NOT_INSTALLED         0x00000008
 195 #define ERROR_TRAY_MALFUNCTION            0x00000010
 196 #define ERROR_INIT_STATUS_NEEDED          0x00000011
 197 #define ERROR_UNHANDLED_ERROR             0xFFFFFFFF
 198
 199 typedef struct _CHANGER_ELEMENT_STATUS {
 200   CHANGER_ELEMENT  Element;
 201   CHANGER_ELEMENT  SrcElementAddress;
 202   ULONG  Flags;
 203   ULONG  ExceptionCode;
 204   UCHAR  TargetId;
 205   UCHAR  Lun;
 206   USHORT  Reserved;
 207   UCHAR  PrimaryVolumeID[MAX_VOLUME_ID_SIZE];
 208   UCHAR  AlternateVolumeID[MAX_VOLUME_ID_SIZE];
 209 } CHANGER_ELEMENT_STATUS, *PCHANGER_ELEMENT_STATUS;
 210
 211 typedef  struct _CHANGER_ELEMENT_STATUS_EX {
 212   CHANGER_ELEMENT  Element;
 213   CHANGER_ELEMENT  SrcElementAddress;
 214   ULONG  Flags;
 215   ULONG  ExceptionCode;
 216   UCHAR  TargetId;
 217   UCHAR  Lun;
 218   USHORT  Reserved;
 219   UCHAR  PrimaryVolumeID[MAX_VOLUME_ID_SIZE];
 220   UCHAR  AlternateVolumeID[MAX_VOLUME_ID_SIZE];
 221   UCHAR  VendorIdentification[VENDOR_ID_LENGTH];
 222   UCHAR  ProductIdentification[PRODUCT_ID_LENGTH];
 223   UCHAR  SerialNumber[SERIAL_NUMBER_LENGTH];
 224 } CHANGER_ELEMENT_STATUS_EX, *PCHANGER_ELEMENT_STATUS_EX;
 225
 226 /* CHANGER_SEND_VOLUME_TAG_INFORMATION.ActionCode constants */
 227 #define SEARCH_ALL                        0x0
 228 #define SEARCH_PRIMARY                    0x1
 229 #define SEARCH_ALTERNATE                  0x2
 230 #define SEARCH_ALL_NO_SEQ                 0x4
 231 #define SEARCH_PRI_NO_SEQ                 0x5
 232 #define SEARCH_ALT_NO_SEQ                 0x6
 233 #define ASSERT_PRIMARY                    0x8
 234 #define ASSERT_ALTERNATE                  0x9
 235 #define REPLACE_PRIMARY                   0xA
 236 #define REPLACE_ALTERNATE                 0xB
 237 #define UNDEFINE_PRIMARY                  0xC
 238 #define UNDEFINE_ALTERNATE                0xD
 239
 240 typedef struct _CHANGER_SEND_VOLUME_TAG_INFORMATION {
 241   CHANGER_ELEMENT StartingElement;
 242   ULONG  ActionCode;
 243   UCHAR  VolumeIDTemplate[MAX_VOLUME_TEMPLATE_SIZE];
 244 } CHANGER_SEND_VOLUME_TAG_INFORMATION, *PCHANGER_SEND_VOLUME_TAG_INFORMATION;
 245
 246 /* GET_CHANGER_PARAMETERS.Features0 constants */
 247 #define CHANGER_BAR_CODE_SCANNER_INSTALLED  0x00000001
 248 #define CHANGER_INIT_ELEM_STAT_WITH_RANGE   0x00000002
 249 #define CHANGER_CLOSE_IEPORT                0x00000004
 250 #define CHANGER_OPEN_IEPORT                 0x00000008
 251 #define CHANGER_STATUS_NON_VOLATILE         0x00000010
 252 #define CHANGER_EXCHANGE_MEDIA              0x00000020
 253 #define CHANGER_CLEANER_SLOT                0x00000040
 254 #define CHANGER_LOCK_UNLOCK                 0x00000080
 255 #define CHANGER_CARTRIDGE_MAGAZINE          0x00000100
 256 #define CHANGER_MEDIUM_FLIP                 0x00000200
 257 #define CHANGER_POSITION_TO_ELEMENT         0x00000400
 258 #define CHANGER_REPORT_IEPORT_STATE         0x00000800
 259 #define CHANGER_STORAGE_DRIVE               0x00001000
 260 #define CHANGER_STORAGE_IEPORT              0x00002000
 261 #define CHANGER_STORAGE_SLOT                0x00004000
 262 #define CHANGER_STORAGE_TRANSPORT           0x00008000
 263 #define CHANGER_DRIVE_CLEANING_REQUIRED     0x00010000
 264 #define CHANGER_PREDISMOUNT_EJECT_REQUIRED  0x00020000
 265 #define CHANGER_CLEANER_ACCESS_NOT_VALID    0x00040000
 266 #define CHANGER_PREMOUNT_EJECT_REQUIRED     0x00080000
 267 #define CHANGER_VOLUME_IDENTIFICATION       0x00100000
 268 #define CHANGER_VOLUME_SEARCH               0x00200000
 269 #define CHANGER_VOLUME_ASSERT               0x00400000
 270 #define CHANGER_VOLUME_REPLACE              0x00800000
 271 #define CHANGER_VOLUME_UNDEFINE             0x01000000
 272 #define CHANGER_SERIAL_NUMBER_VALID         0x04000000
 273 #define CHANGER_DEVICE_REINITIALIZE_CAPABLE 0x08000000
 274 #define CHANGER_KEYPAD_ENABLE_DISABLE       0x10000000
 275 #define CHANGER_DRIVE_EMPTY_ON_DOOR_ACCESS  0x20000000
 276 #define CHANGER_RESERVED_BIT                0x80000000
 277
 278 /* GET_CHANGER_PARAMETERS.Features1 constants */
 279 #define CHANGER_PREDISMOUNT_ALIGN_TO_SLOT   0x80000001
 280 #define CHANGER_PREDISMOUNT_ALIGN_TO_DRIVE  0x80000002
 281 #define CHANGER_CLEANER_AUTODISMOUNT        0x80000004
 282 #define CHANGER_TRUE_EXCHANGE_CAPABLE       0x80000008
 283 #define CHANGER_SLOTS_USE_TRAYS             0x80000010
 284 #define CHANGER_RTN_MEDIA_TO_ORIGINAL_ADDR  0x80000020
 285 #define CHANGER_CLEANER_OPS_NOT_SUPPORTED   0x80000040
 286 #define CHANGER_IEPORT_USER_CONTROL_OPEN    0x80000080
 287 #define CHANGER_IEPORT_USER_CONTROL_CLOSE   0x80000100
 288 #define CHANGER_MOVE_EXTENDS_IEPORT         0x80000200
 289 #define CHANGER_MOVE_RETRACTS_IEPORT        0x80000400
 290
 291 /* GET_CHANGER_PARAMETERS.MoveFrom,ExchangeFrom,PositionCapabilities constants */
 292 #define CHANGER_TO_TRANSPORT              0x01
 293 #define CHANGER_TO_SLOT                   0x02
 294 #define CHANGER_TO_IEPORT                 0x04
 295 #define CHANGER_TO_DRIVE                  0x08
 296
 297 /* GET_CHANGER_PARAMETERS.LockUnlockCapabilities constants */
 298 #define LOCK_UNLOCK_IEPORT                0x01
 299 #define LOCK_UNLOCK_DOOR                  0x02
 300 #define LOCK_UNLOCK_KEYPAD                0x04
 301
 302 typedef struct _GET_CHANGER_PARAMETERS {
 303   ULONG  Size;
 304   USHORT  NumberTransportElements;
 305   USHORT  NumberStorageElements;
 306   USHORT  NumberCleanerSlots;
 307   USHORT  NumberIEElements;
 308   USHORT  NumberDataTransferElements;
 309   USHORT  NumberOfDoors;
 310   USHORT  FirstSlotNumber;
 311   USHORT  FirstDriveNumber;
 312   USHORT  FirstTransportNumber;
 313   USHORT  FirstIEPortNumber;
 314   USHORT  FirstCleanerSlotAddress;
 315   USHORT  MagazineSize;
 316   ULONG  DriveCleanTimeout;
 317   ULONG  Features0;
 318   ULONG  Features1;
 319   UCHAR  MoveFromTransport;
 320   UCHAR  MoveFromSlot;
 321   UCHAR  MoveFromIePort;
 322   UCHAR  MoveFromDrive;
 323   UCHAR  ExchangeFromTransport;
 324   UCHAR  ExchangeFromSlot;
 325   UCHAR  ExchangeFromIePort;
 326   UCHAR  ExchangeFromDrive;
 327   UCHAR  LockUnlockCapabilities;
 328   UCHAR  PositionCapabilities;
 329   UCHAR  Reserved1[2];
 330   ULONG  Reserved2[2];
 331 } GET_CHANGER_PARAMETERS, * PGET_CHANGER_PARAMETERS;
 332
 333 typedef struct READ_ELEMENT_ADDRESS_INFO {
 334   ULONG  NumberOfElements;
 335   CHANGER_ELEMENT_STATUS  ElementStatus[1];
 336 } READ_ELEMENT_ADDRESS_INFO, *PREAD_ELEMENT_ADDRESS_INFO;
 337
 338 typedef struct _TAPE_WMI_OPERATIONS {
 339   ULONG  Method;
 340   ULONG  DataBufferSize;
 341   PVOID  DataBuffer;
 342 } TAPE_WMI_OPERATIONS, *PTAPE_WMI_OPERATIONS;
 343
 344 typedef struct _WMI_CHANGER_PROBLEM_DEVICE_ERROR {
 345   ULONG  ChangerProblemType;
 346 } WMI_CHANGER_PROBLEM_DEVICE_ERROR, *PWMI_CHANGER_PROBLEM_DEVICE_ERROR;
 347
 348 #ifdef __cplusplus
 349 }
 350 #endif
 351
 352 #endif /* __NTDDCHGR_H */