reactos/include/ddk/mcd.h

   1 /*
   2  * mcd.h
   3  *
   4  * Media changer 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
  23 #ifndef __MCD_H
  24 #define __MCD_H
  25
  26 #if __GNUC__ >=3
  27 #pragma GCC system_header
  28 #endif
  29
  30 #include "srb.h"
  31 #include "scsi.h"
  32 #include "ntddchgr.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 #if defined(_MCD_)
  39   #define CHANGERAPI DECLSPEC_EXPORT
  40 #else
  41   #define CHANGERAPI DECLSPEC_IMPORT
  42 #endif
  43
  44 #ifdef DebugPrint
  45 #undef DebugPrint
  46 #endif
  47
  48 #ifdef DBG
  49 #define DebugPrint(x) ChangerClassDebugPrint x
  50 #else
  51 #define DebugPrint(x)
  52 #endif
  53
  54 #define MAXIMUM_CHANGER_INQUIRY_DATA                    252
  55
  56 CHANGERAPI
  57 PVOID
  58 DDKAPI
  59 ChangerClassAllocatePool(
  60   IN POOL_TYPE  PoolType,
  61   IN ULONG  NumberOfBytes);
  62
  63 VOID
  64 ChangerClassDebugPrint(
  65   ULONG  DebugPrintLevel,
  66   PCCHAR  DebugMessage,
  67   ...);
  68
  69 CHANGERAPI
  70 PVOID
  71 DDKAPI
  72 ChangerClassFreePool(
  73   IN PVOID  PoolToFree);
  74
  75 CHANGERAPI
  76 NTSTATUS
  77 DDKAPI
  78 ChangerClassSendSrbSynchronous(
  79   IN PDEVICE_OBJECT  DeviceObject,
  80   IN PSCSI_REQUEST_BLOCK  Srb,
  81   IN PVOID  Buffer,
  82   IN ULONG  BufferSize,
  83   IN BOOLEAN  WriteToDevice);
  84
  85
  86 typedef NTSTATUS DDKAPI
  87 (*CHANGER_INITIALIZE)(
  88   IN PDEVICE_OBJECT  DeviceObject);
  89
  90 typedef ULONG DDKAPI
  91 (*CHANGER_EXTENSION_SIZE)(
  92   VOID);
  93
  94 typedef VOID DDKAPI
  95 (*CHANGER_ERROR_ROUTINE)(
  96   PDEVICE_OBJECT  DeviceObject,
  97   PSCSI_REQUEST_BLOCK  Srb,
  98   NTSTATUS  *Status,
  99   BOOLEAN  *Retry);
 100
 101 typedef NTSTATUS DDKAPI
 102 (*CHANGER_COMMAND_ROUTINE)(
 103   IN PDEVICE_OBJECT  DeviceObject,
 104   IN PIRP  Irp);
 105
 106 typedef NTSTATUS DDKAPI
 107 (*CHANGER_PERFORM_DIAGNOSTICS)(
 108   IN PDEVICE_OBJECT  DeviceObject,
 109   OUT PWMI_CHANGER_PROBLEM_DEVICE_ERROR  ChangerDeviceError);
 110
 111 typedef struct _MCD_INIT_DATA {
 112   ULONG  InitDataSize;
 113   CHANGER_EXTENSION_SIZE  ChangerAdditionalExtensionSize;
 114   CHANGER_INITIALIZE  ChangerInitialize;
 115   CHANGER_ERROR_ROUTINE  ChangerError;
 116   CHANGER_PERFORM_DIAGNOSTICS  ChangerPerformDiagnostics;
 117   CHANGER_COMMAND_ROUTINE  ChangerGetParameters;
 118   CHANGER_COMMAND_ROUTINE  ChangerGetStatus;
 119   CHANGER_COMMAND_ROUTINE  ChangerGetProductData;
 120   CHANGER_COMMAND_ROUTINE  ChangerSetAccess;
 121   CHANGER_COMMAND_ROUTINE  ChangerGetElementStatus;
 122   CHANGER_COMMAND_ROUTINE  ChangerInitializeElementStatus;
 123   CHANGER_COMMAND_ROUTINE  ChangerSetPosition;
 124   CHANGER_COMMAND_ROUTINE  ChangerExchangeMedium;
 125   CHANGER_COMMAND_ROUTINE  ChangerMoveMedium;
 126   CHANGER_COMMAND_ROUTINE  ChangerReinitializeUnit;
 127   CHANGER_COMMAND_ROUTINE  ChangerQueryVolumeTags;
 128 } MCD_INIT_DATA, *PMCD_INIT_DATA;
 129
 130 CHANGERAPI
 131 NTSTATUS
 132 DDKAPI
 133 ChangerClassInitialize(
 134   IN PDRIVER_OBJECT  DriverObject,
 135   IN PUNICODE_STRING  RegistryPath,
 136   IN PMCD_INIT_DATA  MCDInitData);
 137
 138 #ifdef __cplusplus
 139 }
 140 #endif
 141
 142 #endif /* __MCD_H */