427 lines
8.6 KiB
C
427 lines
8.6 KiB
C
|
||
/*++
|
||
|
||
Copyright (C) Microsoft Corporation, 1996 - 1998
|
||
|
||
Module Name:
|
||
|
||
mcd.h
|
||
|
||
Abstract:
|
||
|
||
These are the structures and defines that are used in the
|
||
changer class drivers. The changer class driver is separated
|
||
into two modules. Mcd.c contains code common to all medium
|
||
changer drivers including the driver's major entry points.
|
||
|
||
Author:
|
||
|
||
chuckp (Chuck Park)
|
||
|
||
Environment:
|
||
|
||
Kernel mode
|
||
|
||
Revision History :
|
||
|
||
--*/
|
||
|
||
|
||
#include "scsi.h"
|
||
#include "ntddchgr.h"
|
||
#include <classpnp.h>
|
||
|
||
#include <wmidata.h>
|
||
#include <wmistr.h>
|
||
|
||
#ifdef DebugPrint
|
||
#undef DebugPrint
|
||
#endif
|
||
|
||
#if DBG
|
||
#define DebugPrint(x) ChangerClassDebugPrint x
|
||
#else
|
||
#define DebugPrint(x)
|
||
#endif
|
||
|
||
#define MAXIMUM_CHANGER_INQUIRY_DATA 252
|
||
|
||
typedef
|
||
NTSTATUS
|
||
(*CHANGER_COMMAND_ROUTINE)(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
typedef
|
||
ULONG
|
||
(*CHANGER_EXTENSION_SIZE)(
|
||
IN VOID
|
||
);
|
||
|
||
typedef
|
||
NTSTATUS
|
||
(*CHANGER_INITIALIZE)(
|
||
IN PDEVICE_OBJECT DeviceObject
|
||
);
|
||
|
||
typedef
|
||
NTSTATUS
|
||
(*CHANGER_PERFORM_DIAGNOSTICS)(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
OUT PWMI_CHANGER_PROBLEM_DEVICE_ERROR changerDeviceError
|
||
);
|
||
|
||
typedef
|
||
VOID
|
||
(*CHANGER_ERROR_ROUTINE)(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PSCSI_REQUEST_BLOCK Srb,
|
||
IN NTSTATUS *Status,
|
||
IN BOOLEAN *Retry
|
||
);
|
||
|
||
typedef struct _MCD_INIT_DATA {
|
||
|
||
//
|
||
// Size of this structure.
|
||
//
|
||
|
||
ULONG InitDataSize;
|
||
|
||
//
|
||
// To return the size of the minidriver extension
|
||
//
|
||
|
||
CHANGER_EXTENSION_SIZE ChangerAdditionalExtensionSize;
|
||
|
||
//
|
||
// To perform minidriver specific initialization
|
||
//
|
||
|
||
CHANGER_INITIALIZE ChangerInitialize;
|
||
|
||
//
|
||
// To perform minidriver specific error processing
|
||
//
|
||
|
||
CHANGER_ERROR_ROUTINE ChangerError;
|
||
|
||
//
|
||
// To perform diagnostic tests on the device
|
||
//
|
||
|
||
CHANGER_PERFORM_DIAGNOSTICS ChangerPerformDiagnostics;
|
||
|
||
//
|
||
// Minidriver dispatch routines
|
||
//
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerGetParameters;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerGetStatus;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerGetProductData;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerSetAccess;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerGetElementStatus;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerInitializeElementStatus;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerSetPosition;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerExchangeMedium;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerMoveMedium;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerReinitializeUnit;
|
||
|
||
CHANGER_COMMAND_ROUTINE ChangerQueryVolumeTags;
|
||
|
||
} MCD_INIT_DATA, *PMCD_INIT_DATA;
|
||
|
||
typedef struct _MODE_ELEMENT_ADDRESS_PAGE {
|
||
|
||
UCHAR PageCode : 6;
|
||
UCHAR Reserved1 : 1;
|
||
UCHAR PS : 1;
|
||
UCHAR PageLength;
|
||
UCHAR MediumTransportElementAddress[2];
|
||
UCHAR NumberTransportElements[2];
|
||
UCHAR FirstStorageElementAddress[2];
|
||
UCHAR NumberStorageElements[2];
|
||
UCHAR FirstIEPortElementAddress[2];
|
||
UCHAR NumberIEPortElements[2];
|
||
UCHAR FirstDataXFerElementAddress[2];
|
||
UCHAR NumberDataXFerElements[2];
|
||
UCHAR Reserved2[2];
|
||
|
||
} MODE_ELEMENT_ADDRESS_PAGE, *PMODE_ELEMENT_ADDRESS_PAGE;
|
||
|
||
typedef struct _MODE_TRANSPORT_GEOMETRY_PAGE {
|
||
|
||
UCHAR PageCode : 6;
|
||
UCHAR Reserved1 : 1;
|
||
UCHAR PS : 1;
|
||
UCHAR PageLength;
|
||
UCHAR Flip : 1;
|
||
UCHAR Reserved2: 7;
|
||
UCHAR TransportElementNumber;
|
||
|
||
} MODE_TRANSPORT_GEOMETRY_PAGE, *PMODE_TRANSPORT_GEOMETRY_PAGE;
|
||
|
||
//
|
||
// Capabilities page decribes the various functions that the device
|
||
// supports. Used in GetParameters.
|
||
//
|
||
|
||
typedef struct _MODE_DEVICE_CAPABILITIES_PAGE {
|
||
|
||
UCHAR PageCode : 6;
|
||
UCHAR Reserved1 : 1;
|
||
UCHAR PS : 1;
|
||
UCHAR PageLength;
|
||
UCHAR MediumTransport : 1;
|
||
UCHAR StorageLocation : 1;
|
||
UCHAR IEPort : 1;
|
||
UCHAR DataXFer : 1;
|
||
UCHAR Reserved2 : 4;
|
||
UCHAR Reserved3;
|
||
UCHAR MTtoMT : 1;
|
||
UCHAR MTtoST : 1;
|
||
UCHAR MTtoIE : 1;
|
||
UCHAR MTtoDT : 1;
|
||
UCHAR Reserved4 : 4;
|
||
UCHAR STtoMT : 1;
|
||
UCHAR STtoST : 1;
|
||
UCHAR STtoIE : 1;
|
||
UCHAR STtoDT : 1;
|
||
UCHAR Reserved5 : 4;
|
||
UCHAR IEtoMT : 1;
|
||
UCHAR IEtoST : 1;
|
||
UCHAR IEtoIE : 1;
|
||
UCHAR IEtoDT : 1;
|
||
UCHAR Reserved6 : 4;
|
||
UCHAR DTtoMT : 1;
|
||
UCHAR DTtoST : 1;
|
||
UCHAR DTtoIE : 1;
|
||
UCHAR DTtoDT : 1;
|
||
UCHAR Reserved7 : 4;
|
||
UCHAR Reserved8[4];
|
||
UCHAR XMTtoMT : 1;
|
||
UCHAR XMTtoST : 1;
|
||
UCHAR XMTtoIE : 1;
|
||
UCHAR XMTtoDT : 1;
|
||
UCHAR Reserved9 : 4;
|
||
UCHAR XSTtoMT : 1;
|
||
UCHAR XSTtoST : 1;
|
||
UCHAR XSTtoIE : 1;
|
||
UCHAR XSTtoDT : 1;
|
||
UCHAR Reserved10 : 4;
|
||
UCHAR XIEtoMT : 1;
|
||
UCHAR XIEtoST : 1;
|
||
UCHAR XIEtoIE : 1;
|
||
UCHAR XIEtoDT : 1;
|
||
UCHAR Reserved11 : 4;
|
||
UCHAR XDTtoMT : 1;
|
||
UCHAR XDTtoST : 1;
|
||
UCHAR XDTtoIE : 1;
|
||
UCHAR XDTtoDT : 1;
|
||
UCHAR Reserved12 : 4;
|
||
|
||
} MODE_DEVICE_CAPABILITIES_PAGE, *PMODE_DEVICE_CAPABILITIES_PAGE;
|
||
|
||
#define MODE_PAGE_DISPLAY 0x22
|
||
|
||
//
|
||
// Structures describing return data from READ_ELEMENT_STATUS
|
||
//
|
||
|
||
typedef struct _ELEMENT_STATUS_HEADER {
|
||
UCHAR FirstElementAddress[2];
|
||
UCHAR NumberOfElements[2];
|
||
UCHAR Reserved1;
|
||
UCHAR ReportByteCount[3];
|
||
} ELEMENT_STATUS_HEADER, *PELEMENT_STATUS_HEADER;
|
||
|
||
typedef struct _ELEMENT_STATUS_PAGE {
|
||
UCHAR ElementType;
|
||
UCHAR Reserved1 : 6;
|
||
UCHAR AVolTag : 1;
|
||
UCHAR PVolTag : 1;
|
||
UCHAR ElementDescriptorLength[2];
|
||
UCHAR Reserved2;
|
||
UCHAR DescriptorByteCount[3];
|
||
} ELEMENT_STATUS_PAGE, *PELEMENT_STATUS_PAGE;
|
||
|
||
|
||
typedef struct _ELEMENT_DESCRIPTOR {
|
||
UCHAR ElementAddress[2];
|
||
UCHAR Full : 1;
|
||
UCHAR Reserved1 : 1;
|
||
UCHAR Exception : 1;
|
||
UCHAR Accessible : 1;
|
||
UCHAR Reserved2 : 4;
|
||
UCHAR Reserved3;
|
||
UCHAR AdditionalSenseCode;
|
||
UCHAR AddSenseCodeQualifier;
|
||
UCHAR Lun : 3;
|
||
UCHAR Reserved4 : 1;
|
||
UCHAR LunValid : 1;
|
||
UCHAR IdValid : 1;
|
||
UCHAR Reserved5 : 1;
|
||
UCHAR NotThisBus : 1;
|
||
UCHAR BusAddress;
|
||
UCHAR Reserved6;
|
||
UCHAR Reserved7 : 6;
|
||
UCHAR Invert : 1;
|
||
UCHAR SValid : 1;
|
||
UCHAR SourceStorageElementAddress[2];
|
||
} ELEMENT_DESCRIPTOR, *PELEMENT_DESCRIPTOR;
|
||
|
||
|
||
//
|
||
// The following routines are the exported entry points for
|
||
// all changer class drivers.
|
||
//
|
||
|
||
NTSTATUS
|
||
DriverEntry(
|
||
IN PDRIVER_OBJECT DriverObject,
|
||
IN PUNICODE_STRING RegistryPath
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerClassInitialize(
|
||
IN PDRIVER_OBJECT DriverObject,
|
||
IN PUNICODE_STRING RegistryPath,
|
||
IN PMCD_INIT_DATA ChangerInitData
|
||
);
|
||
|
||
PVOID
|
||
ChangerClassAllocatePool(
|
||
IN POOL_TYPE PoolType,
|
||
IN ULONG NumberOfBytes
|
||
);
|
||
|
||
VOID
|
||
ChangerClassFreePool(
|
||
IN PVOID PoolToFree
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerClassSendSrbSynchronous(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PSCSI_REQUEST_BLOCK Srb,
|
||
IN PVOID Buffer,
|
||
IN ULONG BufferSize,
|
||
IN BOOLEAN WriteToDevice
|
||
);
|
||
|
||
VOID
|
||
ChangerClassDebugPrint(
|
||
ULONG DebugPrintLevel,
|
||
PCCHAR DebugMessage,
|
||
...
|
||
);
|
||
|
||
|
||
//
|
||
// The following routines are provided by the changer
|
||
// device-specific module. Each routine name is
|
||
// prefixed with 'Changer.'
|
||
|
||
|
||
ULONG
|
||
ChangerAdditionalExtensionSize(
|
||
VOID
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerInitialize(
|
||
IN PDEVICE_OBJECT DeviceObject
|
||
);
|
||
|
||
VOID
|
||
ChangerError(
|
||
PDEVICE_OBJECT DeviceObject,
|
||
PSCSI_REQUEST_BLOCK Srb,
|
||
NTSTATUS *Status,
|
||
BOOLEAN *Retry
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerGetParameters(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerGetStatus(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerGetProductData(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerSetAccess(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerGetElementStatus(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
|
||
NTSTATUS
|
||
ChangerInitializeElementStatus(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerSetPosition(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerExchangeMedium(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerMoveMedium(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerReinitializeUnit(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerQueryVolumeTags(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
IN PIRP Irp
|
||
);
|
||
|
||
NTSTATUS
|
||
ChangerPerformDiagnostics(
|
||
IN PDEVICE_OBJECT DeviceObject,
|
||
OUT PWMI_CHANGER_PROBLEM_DEVICE_ERROR changerDeviceError
|
||
);
|
||
|