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