archive
/
windows-xp
mirror of https://github.com/tongzx/nt5src
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8 Commits
1 Branch
0 Tags
3.8 GiB
 
 
 
 
 
 
Tree: 744f0b4006
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '744f0b4006'
${ noResults }
windows-xp/Source/XPSP1/NT/public/ddk/inc/storport.h

4266 lines
110 KiB
Raw Blame History

/*++
Copyright (c) Microsoft Corporation. All rights reserved.
Module Name:
storport.h
Abstract:
These are the structures and defines that are included by STORPORT miniport
drivers.
Authors:
Revision History:
--*/
#ifdef _NTSCSI_
#error "STORPORT.H must be included instead of SCSI.H"
#endif
#ifdef _NTSRB_
#error "STORPORT.H must be included instead of SRB.H"
#endif
#ifndef _NTSTORPORT_
#define _NTSTORPORT_
#if _MSC_VER >= 1200
#pragma warning(push)
#endif
#pragma warning(disable:4200) // array[0] is not a warning for this file
//
// For backwards compatability, use SCSIPORT definitions.
//
#define STOR_USE_SCSI_ALIASES (1)
#if DBG
#define DebugPrint(x) StorPortDebugPrint x
#else
#define DebugPrint(x)
#endif
//
// Define SCSI maximum configuration parameters.
//
#define SCSI_MAXIMUM_LOGICAL_UNITS 8
#define SCSI_MAXIMUM_TARGETS_PER_BUS 128
#define SCSI_MAXIMUM_LUNS_PER_TARGET 255
#define SCSI_MAXIMUM_BUSES 8
#define SCSI_MINIMUM_PHYSICAL_BREAKS 16
#define SCSI_MAXIMUM_PHYSICAL_BREAKS 255
#define SCSI_COMBINE_BUS_TARGET( Bus, Target ) ( \
((((UCHAR) (Target)) & ~(0x20 - 1)) << 8) | \
(((UCHAR) (Bus)) << 5) | \
(((UCHAR) (Target)) & (0x20 - 1)))
#define SCSI_DECODE_BUS_TARGET( Value, Bus, Target ) ( \
Bus = (UCHAR) ((Value) >> 5), \
Target = (UCHAR) ((((Value) >> 8) & ~(0x20 - 1)) | ((Value) & (0x20 - 1))))
//
// This constant is for backward compatibility.
// This use to be the maximum number of targets supported.
//
#define SCSI_MAXIMUM_TARGETS 8
typedef PHYSICAL_ADDRESS STOR_PHYSICAL_ADDRESS, *PSTOR_PHYSICAL_ADDRESS;
typedef struct _ACCESS_RANGE {
STOR_PHYSICAL_ADDRESS RangeStart;
ULONG RangeLength;
BOOLEAN RangeInMemory;
} ACCESS_RANGE, *PACCESS_RANGE;
typedef enum _STOR_SYNCHRONIZATION_MODEL {
StorSynchronizeHalfDuplex,
StorSynchronizeFullDuplex
} STOR_SYNCHRONIZATION_MODEL;
#define STOR_MAP_NO_BUFFERS (0)
#define STOR_MAP_ALL_BUFFERS (1)
#define STOR_MAP_NON_READ_WRITE_BUFFERS (2)
//
// Configuration information structure. Contains the information necessary
// to initialize the adapter. NOTE: This structure must be a multiple of
// quadwords.
//
typedef struct _PORT_CONFIGURATION_INFORMATION {
//
// Length of port configuation information strucuture.
//
ULONG Length;
//
// IO bus number (0 for machines that have only 1 IO bus
//
ULONG SystemIoBusNumber;
//
// EISA, MCA or ISA
//
INTERFACE_TYPE AdapterInterfaceType;
//
// Interrupt request level for device
//
ULONG BusInterruptLevel;
//
// Bus interrupt vector used with hardware buses which use as vector as
// well as level, such as internal buses.
//
ULONG BusInterruptVector;
//
// Interrupt mode (level-sensitive or edge-triggered)
//
KINTERRUPT_MODE InterruptMode;
//
// Maximum number of bytes that can be transferred in a single SRB
//
ULONG MaximumTransferLength;
//
// Number of contiguous blocks of physical memory
//
ULONG NumberOfPhysicalBreaks;
//
// DMA channel for devices using system DMA
//
ULONG DmaChannel;
ULONG DmaPort;
DMA_WIDTH DmaWidth;
DMA_SPEED DmaSpeed;
//
// Alignment masked required by the adapter for data transfers.
//
ULONG AlignmentMask;
//
// Number of access range elements which have been allocated.
//
ULONG NumberOfAccessRanges;
//
// Pointer to array of access range elements.
//
ACCESS_RANGE (*AccessRanges)[];
//
// Reserved field.
//
PVOID Reserved;
//
// Number of SCSI buses attached to the adapter.
//
UCHAR NumberOfBuses;
//
// SCSI bus ID for adapter
//
CCHAR InitiatorBusId[8];
//
// Indicates that the adapter does scatter/gather
//
BOOLEAN ScatterGather;
//
// Indicates that the adapter is a bus master
//
BOOLEAN Master;
//
// Host caches data or state.
//
BOOLEAN CachesData;
//
// Host adapter scans down for bios devices.
//
BOOLEAN AdapterScansDown;
//
// Primary at disk address (0x1F0) claimed.
//
BOOLEAN AtdiskPrimaryClaimed;
//
// Secondary at disk address (0x170) claimed.
//
BOOLEAN AtdiskSecondaryClaimed;
//
// The master uses 32-bit DMA addresses.
//
BOOLEAN Dma32BitAddresses;
//
// Use Demand Mode DMA rather than Single Request.
//
BOOLEAN DemandMode;
//
// Data buffers must be mapped into virtual address space.
//
UCHAR MapBuffers;
//
// The driver will need to tranlate virtual to physical addresses.
//
BOOLEAN NeedPhysicalAddresses;
//
// Supports tagged queuing
//
BOOLEAN TaggedQueuing;
//
// Supports auto request sense.
//
BOOLEAN AutoRequestSense;
//
// Supports multiple requests per logical unit.
//
BOOLEAN MultipleRequestPerLu;
//
// Support receive event function.
//
BOOLEAN ReceiveEvent;
//
// Indicates the real-mode driver has initialized the card.
//
BOOLEAN RealModeInitialized;
//
// Indicate that the miniport will not touch the data buffers directly.
//
BOOLEAN BufferAccessScsiPortControlled;
//
// Indicator for wide scsi.
//
UCHAR MaximumNumberOfTargets;
//
// Ensure quadword alignment.
//
UCHAR ReservedUchars[2];
//
// Adapter slot number
//
ULONG SlotNumber;
//
// Interrupt information for a second IRQ.
//
ULONG BusInterruptLevel2;
ULONG BusInterruptVector2;
KINTERRUPT_MODE InterruptMode2;
//
// DMA information for a second channel.
//
ULONG DmaChannel2;
ULONG DmaPort2;
DMA_WIDTH DmaWidth2;
DMA_SPEED DmaSpeed2;
//
// Fields added to allow for the miniport
// to update these sizes based on requirements
// for large transfers ( > 64K);
//
ULONG DeviceExtensionSize;
ULONG SpecificLuExtensionSize;
ULONG SrbExtensionSize;
//
// Used to determine whether the system and/or the miniport support
// 64-bit physical addresses. See SCSI_DMA64_* flags below.
//
UCHAR Dma64BitAddresses; /* New */
//
// Indicates that the miniport can accept a SRB_FUNCTION_RESET_DEVICE
// to clear all requests to a particular LUN.
//
BOOLEAN ResetTargetSupported; /* New */
//
// Indicates that the miniport can support more than 8 logical units per
// target (maximum LUN number is one less than this field).
//
UCHAR MaximumNumberOfLogicalUnits; /* New */
//
// Supports WMI?
//
BOOLEAN WmiDataProvider;
//
// STORPORT synchronization model, either half or full duplex
// depending on whether the driver supports async-with-interrupt
// model or not.
//
STOR_SYNCHRONIZATION_MODEL SynchronizationModel; // STORPORT New
} PORT_CONFIGURATION_INFORMATION, *PPORT_CONFIGURATION_INFORMATION;
//
// Version control for ConfigInfo structure.
//
#define CONFIG_INFO_VERSION_2 sizeof(PORT_CONFIGURATION_INFORMATION)
//
// Flags for controlling 64-bit DMA use (PORT_CONFIGURATION_INFORMATION field
// Dma64BitAddresses)
//
//
// Set by scsiport on entering HwFindAdapter if the system can support 64-bit
// physical addresses. The miniport can use this information before calling
// ScsiPortGetUncachedExtension to modify the DeviceExtensionSize,
// SpecificLuExtensionSize & SrbExtensionSize fields to account for the extra
// size of the scatter gather list.
//
#define SCSI_DMA64_SYSTEM_SUPPORTED 0x80
//
// Set by the miniport before calling ScsiPortGetUncachedExtension to indicate
// that scsiport should provide it with 64-bit physical addresses. If the
// system does not support 64-bit PA's then this bit will be ignored.
//
#define SCSI_DMA64_MINIPORT_SUPPORTED 0x01
//
// Command type (and parameter) definition(s) for AdapterControl requests.
//
typedef enum _SCSI_ADAPTER_CONTROL_TYPE {
ScsiQuerySupportedControlTypes = 0,
ScsiStopAdapter,
ScsiRestartAdapter,
ScsiSetBootConfig,
ScsiSetRunningConfig,
ScsiAdapterControlMax,
MakeAdapterControlTypeSizeOfUlong = 0xffffffff
} SCSI_ADAPTER_CONTROL_TYPE, *PSCSI_ADAPTER_CONTROL_TYPE;
//
// Adapter control status values
//
typedef enum _SCSI_ADAPTER_CONTROL_STATUS {
ScsiAdapterControlSuccess = 0,
ScsiAdapterControlUnsuccessful
} SCSI_ADAPTER_CONTROL_STATUS, *PSCSI_ADAPTER_CONTROL_STATUS;
//
// Parameters for Adapter Control Functions:
//
//
// ScsiQuerySupportedControlTypes:
//
typedef struct _SCSI_SUPPORTED_CONTROL_TYPE_LIST {
//
// Specifies the number of entries in the adapter control type list.
//
IN ULONG MaxControlType;
//
// The miniport will set TRUE for each control type it supports.
// The number of entries in this array is defined by MaxAdapterControlType
// - the miniport must not attempt to set any AC types beyond the maximum
// value specified.
//
OUT BOOLEAN SupportedTypeList[0];
} SCSI_SUPPORTED_CONTROL_TYPE_LIST, *PSCSI_SUPPORTED_CONTROL_TYPE_LIST;
//
// Uninitialized flag value.
//
#define SP_UNINITIALIZED_VALUE ((ULONG) ~0)
#define SP_UNTAGGED ((UCHAR) ~0)
//
// Set asynchronous events.
//
#define SRBEV_BUS_RESET 0x0001
#define SRBEV_SCSI_ASYNC_NOTIFICATION 0x0002
#define MAXIMUM_CDB_SIZE 12
//
// SCSI I/O Request Block
//
typedef struct _SCSI_REQUEST_BLOCK {
USHORT Length; // offset 0
UCHAR Function; // offset 2
UCHAR SrbStatus; // offset 3
UCHAR ScsiStatus; // offset 4
UCHAR PathId; // offset 5
UCHAR TargetId; // offset 6
UCHAR Lun; // offset 7
UCHAR QueueTag; // offset 8
UCHAR QueueAction; // offset 9
UCHAR CdbLength; // offset a
UCHAR SenseInfoBufferLength; // offset b
ULONG SrbFlags; // offset c
ULONG DataTransferLength; // offset 10
ULONG TimeOutValue; // offset 14
PVOID DataBuffer; // offset 18
PVOID SenseInfoBuffer; // offset 1c
struct _SCSI_REQUEST_BLOCK *NextSrb; // offset 20
PVOID OriginalRequest; // offset 24
PVOID SrbExtension; // offset 28
union {
ULONG InternalStatus; // offset 2c
ULONG QueueSortKey; // offset 2c
};
#if defined(_WIN64)
//
// Force PVOID alignment of Cdb
//
ULONG Reserved;
#endif
UCHAR Cdb[16]; // offset 30
} SCSI_REQUEST_BLOCK, *PSCSI_REQUEST_BLOCK;
#define SCSI_REQUEST_BLOCK_SIZE sizeof(SCSI_REQUEST_BLOCK)
//
// SCSI I/O Request Block for WMI Requests
//
typedef struct _SCSI_WMI_REQUEST_BLOCK {
USHORT Length;
UCHAR Function; // SRB_FUNCTION_WMI
UCHAR SrbStatus;
UCHAR WMISubFunction;
UCHAR PathId; // If SRB_WMI_FLAGS_ADAPTER_REQUEST is set in
UCHAR TargetId; // WMIFlags then PathId, TargetId and Lun are
UCHAR Lun; // reserved fields.
UCHAR Reserved1;
UCHAR WMIFlags;
UCHAR Reserved2[2];
ULONG SrbFlags;
ULONG DataTransferLength;
ULONG TimeOutValue;
PVOID DataBuffer;
PVOID DataPath;
PVOID Reserved3;
PVOID OriginalRequest;
PVOID SrbExtension;
ULONG Reserved4;
UCHAR Reserved5[16];
} SCSI_WMI_REQUEST_BLOCK, *PSCSI_WMI_REQUEST_BLOCK;
//
// SRB Functions
//
#define SRB_FUNCTION_EXECUTE_SCSI 0x00
#define SRB_FUNCTION_CLAIM_DEVICE 0x01
#define SRB_FUNCTION_IO_CONTROL 0x02
#define SRB_FUNCTION_RECEIVE_EVENT 0x03
#define SRB_FUNCTION_RELEASE_QUEUE 0x04
#define SRB_FUNCTION_ATTACH_DEVICE 0x05
#define SRB_FUNCTION_RELEASE_DEVICE 0x06
#define SRB_FUNCTION_SHUTDOWN 0x07
#define SRB_FUNCTION_FLUSH 0x08
#define SRB_FUNCTION_ABORT_COMMAND 0x10
#define SRB_FUNCTION_RELEASE_RECOVERY 0x11
#define SRB_FUNCTION_RESET_BUS 0x12
#define SRB_FUNCTION_RESET_DEVICE 0x13
#define SRB_FUNCTION_TERMINATE_IO 0x14
#define SRB_FUNCTION_FLUSH_QUEUE 0x15
#define SRB_FUNCTION_REMOVE_DEVICE 0x16
#define SRB_FUNCTION_WMI 0x17
#define SRB_FUNCTION_LOCK_QUEUE 0x18
#define SRB_FUNCTION_UNLOCK_QUEUE 0x19
//
// SRB Status
//
#define SRB_STATUS_PENDING 0x00
#define SRB_STATUS_SUCCESS 0x01
#define SRB_STATUS_ABORTED 0x02
#define SRB_STATUS_ABORT_FAILED 0x03
#define SRB_STATUS_ERROR 0x04
#define SRB_STATUS_BUSY 0x05
#define SRB_STATUS_INVALID_REQUEST 0x06
#define SRB_STATUS_INVALID_PATH_ID 0x07
#define SRB_STATUS_NO_DEVICE 0x08
#define SRB_STATUS_TIMEOUT 0x09
#define SRB_STATUS_SELECTION_TIMEOUT 0x0A
#define SRB_STATUS_COMMAND_TIMEOUT 0x0B
#define SRB_STATUS_MESSAGE_REJECTED 0x0D
#define SRB_STATUS_BUS_RESET 0x0E
#define SRB_STATUS_PARITY_ERROR 0x0F
#define SRB_STATUS_REQUEST_SENSE_FAILED 0x10
#define SRB_STATUS_NO_HBA 0x11
#define SRB_STATUS_DATA_OVERRUN 0x12
#define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13
#define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14
#define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15
#define SRB_STATUS_REQUEST_FLUSHED 0x16
#define SRB_STATUS_INVALID_LUN 0x20
#define SRB_STATUS_INVALID_TARGET_ID 0x21
#define SRB_STATUS_BAD_FUNCTION 0x22
#define SRB_STATUS_ERROR_RECOVERY 0x23
#define SRB_STATUS_NOT_POWERED 0x24
//
// This value is used by the port driver to indicate that a non-scsi-related
// error occured. Miniports must never return this status.
//
#define SRB_STATUS_INTERNAL_ERROR 0x30
//
// Srb status values 0x38 through 0x3f are reserved for internal port driver
// use.
//
//
// SRB Status Masks
//
#define SRB_STATUS_QUEUE_FROZEN 0x40
#define SRB_STATUS_AUTOSENSE_VALID 0x80
#define SRB_STATUS(Status) (Status & ~(SRB_STATUS_AUTOSENSE_VALID | SRB_STATUS_QUEUE_FROZEN))
//
// SRB Flag Bits
//
#define SRB_FLAGS_QUEUE_ACTION_ENABLE 0x00000002
#define SRB_FLAGS_DISABLE_DISCONNECT 0x00000004
#define SRB_FLAGS_DISABLE_SYNCH_TRANSFER 0x00000008
#define SRB_FLAGS_BYPASS_FROZEN_QUEUE 0x00000010
#define SRB_FLAGS_DISABLE_AUTOSENSE 0x00000020
#define SRB_FLAGS_DATA_IN 0x00000040
#define SRB_FLAGS_DATA_OUT 0x00000080
#define SRB_FLAGS_NO_DATA_TRANSFER 0x00000000
#define SRB_FLAGS_UNSPECIFIED_DIRECTION (SRB_FLAGS_DATA_IN | SRB_FLAGS_DATA_OUT)
#define SRB_FLAGS_NO_QUEUE_FREEZE 0x00000100
#define SRB_FLAGS_ADAPTER_CACHE_ENABLE 0x00000200
#define SRB_FLAGS_FREE_SENSE_BUFFER 0x00000400
#define SRB_FLAGS_IS_ACTIVE 0x00010000
#define SRB_FLAGS_ALLOCATED_FROM_ZONE 0x00020000
#define SRB_FLAGS_SGLIST_FROM_POOL 0x00040000
#define SRB_FLAGS_BYPASS_LOCKED_QUEUE 0x00080000
#define SRB_FLAGS_NO_KEEP_AWAKE 0x00100000
#define SRB_FLAGS_PORT_DRIVER_ALLOCSENSE 0x00200000
#define SRB_FLAGS_PORT_DRIVER_SENSEHASPORT 0x00400000
#define SRB_FLAGS_DONT_START_NEXT_PACKET 0x00800000
#define SRB_FLAGS_PORT_DRIVER_RESERVED 0x0F000000
#define SRB_FLAGS_CLASS_DRIVER_RESERVED 0xF0000000
#if DBG==1
//
// A signature used to validate the scsi port number
// at the end of a sense buffer.
//
#define SCSI_PORT_SIGNATURE 0x54524f50
#endif
//
// Queue Action
//
#define SRB_SIMPLE_TAG_REQUEST 0x20
#define SRB_HEAD_OF_QUEUE_TAG_REQUEST 0x21
#define SRB_ORDERED_QUEUE_TAG_REQUEST 0x22
#define SRB_WMI_FLAGS_ADAPTER_REQUEST 0x01
//
// SCSI Adapter Dependent Routines
//
typedef
BOOLEAN
(*PHW_INITIALIZE) (
IN PVOID DeviceExtension
);
typedef
BOOLEAN
(*PHW_BUILDIO) (
IN PVOID DeviceExtension,
IN PSCSI_REQUEST_BLOCK Srb
);
typedef
BOOLEAN
(*PHW_STARTIO) (
IN PVOID DeviceExtension,
IN PSCSI_REQUEST_BLOCK Srb
);
typedef
BOOLEAN
(*PHW_INTERRUPT) (
IN PVOID DeviceExtension
);
typedef
VOID
(*PHW_TIMER) (
IN PVOID DeviceExtension
);
typedef
VOID
(*PHW_DMA_STARTED) (
IN PVOID DeviceExtension
);
typedef
ULONG
(*PHW_FIND_ADAPTER) (
IN PVOID DeviceExtension,
IN PVOID HwContext,
IN PVOID BusInformation,
IN PCHAR ArgumentString,
IN OUT PPORT_CONFIGURATION_INFORMATION ConfigInfo,
OUT PBOOLEAN Again
);
typedef
BOOLEAN
(*PHW_RESET_BUS) (
IN PVOID DeviceExtension,
IN ULONG PathId
);
typedef
BOOLEAN
(*PHW_ADAPTER_STATE) (
IN PVOID DeviceExtension,
IN PVOID Context,
IN BOOLEAN SaveState
);
typedef
SCSI_ADAPTER_CONTROL_STATUS
(*PHW_ADAPTER_CONTROL) (
IN PVOID DeviceExtension,
IN SCSI_ADAPTER_CONTROL_TYPE ControlType,
IN PVOID Parameters
);
//
// Port driver error codes
//
#define SP_BUS_PARITY_ERROR 0x0001
#define SP_UNEXPECTED_DISCONNECT 0x0002
#define SP_INVALID_RESELECTION 0x0003
#define SP_BUS_TIME_OUT 0x0004
#define SP_PROTOCOL_ERROR 0x0005
#define SP_INTERNAL_ADAPTER_ERROR 0x0006
#define SP_REQUEST_TIMEOUT 0x0007
#define SP_IRQ_NOT_RESPONDING 0x0008
#define SP_BAD_FW_WARNING 0x0009
#define SP_BAD_FW_ERROR 0x000a
#define SP_LOST_WMI_MINIPORT_REQUEST 0x000b
//
// Return values for SCSI_HW_FIND_ADAPTER.
//
#define SP_RETURN_NOT_FOUND 0
#define SP_RETURN_FOUND 1
#define SP_RETURN_ERROR 2
#define SP_RETURN_BAD_CONFIG 3
//
// Notification Event Types
//
typedef enum _SCSI_NOTIFICATION_TYPE {
RequestComplete,
NextRequest,
NextLuRequest,
ResetDetected,
_obsolete1, // STORPORT: CallDisableInterrupts has been removed
_obsolete2, // STORPORT: CallEnableInterrupts has been removed
RequestTimerCall,
BusChangeDetected,
WMIEvent,
WMIReregister
} SCSI_NOTIFICATION_TYPE, *PSCSI_NOTIFICATION_TYPE;
//
// Structure passed between miniport initialization
// and SCSI port initialization
//
typedef struct _HW_INITIALIZATION_DATA {
ULONG HwInitializationDataSize;
//
// Adapter interface type:
//
// Internal
// Isa
// Eisa
// MicroChannel
// TurboChannel
// PCIBus
// VMEBus
// NuBus
// PCMCIABus
// CBus
// MPIBus
// MPSABus
//
INTERFACE_TYPE AdapterInterfaceType;
//
// Miniport driver routines
//
PHW_INITIALIZE HwInitialize;
PHW_STARTIO HwStartIo;
PHW_INTERRUPT HwInterrupt;
PHW_FIND_ADAPTER HwFindAdapter;
PHW_RESET_BUS HwResetBus;
PHW_DMA_STARTED HwDmaStarted;
PHW_ADAPTER_STATE HwAdapterState;
//
// Miniport driver resources
//
ULONG DeviceExtensionSize;
ULONG SpecificLuExtensionSize;
ULONG SrbExtensionSize;
ULONG NumberOfAccessRanges;
PVOID Reserved;
//
// Data buffers must be mapped into virtual address space.
//
UCHAR MapBuffers;
//
// The driver will need to tranlate virtual to physical addresses.
//
BOOLEAN NeedPhysicalAddresses;
//
// Supports tagged queuing
//
BOOLEAN TaggedQueuing;
//
// Supports auto request sense.
//
BOOLEAN AutoRequestSense;
//
// Supports multiple requests per logical unit.
//
BOOLEAN MultipleRequestPerLu;
//
// Support receive event function.
//
BOOLEAN ReceiveEvent;
//
// Vendor identification length
//
USHORT VendorIdLength;
//
// Vendor identification
//
PVOID VendorId;
//
// Pad for alignment and future use.
//
USHORT ReservedUshort;
//
// Device identification length
//
USHORT DeviceIdLength;
//
// Device identification
//
PVOID DeviceId;
//
// Stop adapter routine.
//
PHW_ADAPTER_CONTROL HwAdapterControl;
//
// Initialize to the Build IO routine if one is supported, otherwise
// should be NULL.
//
PHW_BUILDIO HwBuildIo; // STORPORT New
} HW_INITIALIZATION_DATA, *PHW_INITIALIZATION_DATA;
//
// Scatter/gather lists
//
typedef struct _STOR_SCATTER_GATHER_ELEMENT {
STOR_PHYSICAL_ADDRESS PhysicalAddress;
ULONG Length;
ULONG_PTR Reserved;
} STOR_SCATTER_GATHER_ELEMENT, *PSTOR_SCATTER_GATHER_ELEMENT;
typedef struct _STOR_SCATTER_GATHER_LIST {
ULONG NumberOfElements;
ULONG_PTR Reserved;
STOR_SCATTER_GATHER_ELEMENT List[];
} STOR_SCATTER_GATHER_LIST, *PSTOR_SCATTER_GATHER_LIST;
typedef
BOOLEAN
(*PSTOR_SYNCHRONIZED_ACCESS)(
IN PVOID HwDeviceExtension,
IN PVOID Context
);
#ifndef _NTDDK_
#define STORPORT_API DECLSPEC_IMPORT
#else
#define STORPORT_API
#endif
//
// Port driver routines called by miniport driver
//
STORPORT_API
ULONG
StorPortInitialize(
IN PVOID Argument1,
IN PVOID Argument2,
IN struct _HW_INITIALIZATION_DATA *HwInitializationData,
IN PVOID HwContext
);
STORPORT_API
VOID
StorPortFreeDeviceBase(
IN PVOID HwDeviceExtension,
IN PVOID MappedAddress
);
STORPORT_API
ULONG
StorPortGetBusData(
IN PVOID DeviceExtension,
IN ULONG BusDataType,
IN ULONG SystemIoBusNumber,
IN ULONG SlotNumber,
IN PVOID Buffer,
IN ULONG Length
);
STORPORT_API
ULONG
StorPortSetBusDataByOffset(
IN PVOID DeviceExtension,
IN ULONG BusDataType,
IN ULONG SystemIoBusNumber,
IN ULONG SlotNumber,
IN PVOID Buffer,
IN ULONG Offset,
IN ULONG Length
);
STORPORT_API
PVOID
StorPortGetDeviceBase(
IN PVOID HwDeviceExtension,
IN INTERFACE_TYPE BusType,
IN ULONG SystemIoBusNumber,
IN STOR_PHYSICAL_ADDRESS IoAddress,
IN ULONG NumberOfBytes,
IN BOOLEAN InIoSpace
);
STORPORT_API
PVOID
StorPortGetLogicalUnit(
IN PVOID HwDeviceExtension,
IN UCHAR PathId,
IN UCHAR TargetId,
IN UCHAR Lun
);
STORPORT_API
PSTOR_SCATTER_GATHER_LIST
StorPortGetScatterGatherList(
IN PVOID HwDeviceExtension,
IN PSCSI_REQUEST_BLOCK Srb
);
STORPORT_API
STOR_PHYSICAL_ADDRESS
StorPortGetPhysicalAddress(
IN PVOID HwDeviceExtension,
IN PSCSI_REQUEST_BLOCK Srb,
IN PVOID VirtualAddress,
OUT ULONG *Length
);
STORPORT_API
PVOID
StorPortGetVirtualAddress(
IN PVOID HwDeviceExtension,
IN STOR_PHYSICAL_ADDRESS PhysicalAddress
);
STORPORT_API
PVOID
StorPortGetUncachedExtension(
IN PVOID HwDeviceExtension,
IN PPORT_CONFIGURATION_INFORMATION ConfigInfo,
IN ULONG NumberOfBytes
);
STORPORT_API
BOOLEAN
StorPortPauseDevice(
IN PVOID HwDeviceExtension,
IN UCHAR PathId,
IN UCHAR TargetId,
IN UCHAR Lun,
IN ULONG Timeout
);
STORPORT_API
BOOLEAN
StorPortResumeDevice(
IN PVOID HwDeviceExtension,
IN UCHAR PathId,
IN UCHAR TargetId,
IN UCHAR Lun
);
STORPORT_API
BOOLEAN
StorPortPause(
IN PVOID HwDeviceExtension,
IN ULONG Timeout
);
STORPORT_API
BOOLEAN
StorPortResume(
IN PVOID HwDeviceExtension
);
STORPORT_API
BOOLEAN
StorPortDeviceBusy(
IN PVOID HwDeviceExtension,
IN UCHAR PathId,
IN UCHAR TargetId,
IN UCHAR Lun,
IN ULONG RequestsToComplete
);
STORPORT_API
BOOLEAN
StorPortDeviceReady(
IN PVOID HwDeviceExtension,
IN UCHAR PathId,
IN UCHAR TargetId,
IN UCHAR Lun
);
STORPORT_API
BOOLEAN
StorPortBusy(
IN PVOID HwDeviceExtension,
IN ULONG RequestsToComplete
);
STORPORT_API
BOOLEAN
RaidPortReady(
IN PVOID HwDeviceExtension
);
STORPORT_API
VOID
StorPortNotification(
IN SCSI_NOTIFICATION_TYPE NotificationType,
IN PVOID HwDeviceExtension,
...
);
STORPORT_API
VOID
StorPortLogError(
IN PVOID HwDeviceExtension,
IN PSCSI_REQUEST_BLOCK Srb OPTIONAL,
IN UCHAR PathId,
IN UCHAR TargetId,
IN UCHAR Lun,
IN ULONG ErrorCode,
IN ULONG UniqueId
);
STORPORT_API
VOID
StorPortCompleteRequest(
IN PVOID HwDeviceExtension,
IN UCHAR PathId,
IN UCHAR TargetId,
IN UCHAR Lun,
IN UCHAR SrbStatus
);
STORPORT_API
VOID
StorPortMoveMemory(
IN PVOID WriteBuffer,
IN PVOID ReadBuffer,
IN ULONG Length
);
STORPORT_API
UCHAR
StorPortReadPortUchar(
IN PUCHAR Port
);
STORPORT_API
USHORT
StorPortReadPortUshort(
IN PUSHORT Port
);
STORPORT_API
ULONG
StorPortReadPortUlong(
IN PULONG Port
);
STORPORT_API
VOID
StorPortReadPortBufferUchar(
IN PUCHAR Port,
IN PUCHAR Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortReadPortBufferUshort(
IN PUSHORT Port,
IN PUSHORT Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortReadPortBufferUlong(
IN PULONG Port,
IN PULONG Buffer,
IN ULONG Count
);
STORPORT_API
UCHAR
StorPortReadRegisterUchar(
IN PUCHAR Register
);
STORPORT_API
USHORT
StorPortReadRegisterUshort(
IN PUSHORT Register
);
STORPORT_API
ULONG
StorPortReadRegisterUlong(
IN PULONG Register
);
STORPORT_API
VOID
StorPortReadRegisterBufferUchar(
IN PUCHAR Register,
IN PUCHAR Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortReadRegisterBufferUshort(
IN PUSHORT Register,
IN PUSHORT Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortReadRegisterBufferUlong(
IN PULONG Register,
IN PULONG Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortStallExecution(
IN ULONG Delay
);
STORPORT_API
BOOLEAN
StorPortSynchronizeAccess(
IN PVOID HwDeviceExtension,
IN PSTOR_SYNCHRONIZED_ACCESS SynchronizedAccessRoutine,
IN PVOID Context
);
STORPORT_API
VOID
StorPortWritePortUchar(
IN PUCHAR Port,
IN UCHAR Value
);
STORPORT_API
VOID
StorPortWritePortUshort(
IN PUSHORT Port,
IN USHORT Value
);
STORPORT_API
VOID
StorPortWritePortUlong(
IN PULONG Port,
IN ULONG Value
);
STORPORT_API
VOID
StorPortWritePortBufferUchar(
IN PUCHAR Port,
IN PUCHAR Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortWritePortBufferUshort(
IN PUSHORT Port,
IN PUSHORT Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortWritePortBufferUlong(
IN PULONG Port,
IN PULONG Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortWriteRegisterUchar(
IN PUCHAR Register,
IN UCHAR Value
);
STORPORT_API
VOID
StorPortWriteRegisterUshort(
IN PUSHORT Register,
IN USHORT Value
);
STORPORT_API
VOID
StorPortWriteRegisterUlong(
IN PULONG Register,
IN ULONG Value
);
STORPORT_API
VOID
StorPortWriteRegisterBufferUchar(
IN PUCHAR Register,
IN PUCHAR Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortWriteRegisterBufferUshort(
IN PUSHORT Register,
IN PUSHORT Buffer,
IN ULONG Count
);
STORPORT_API
VOID
StorPortWriteRegisterBufferUlong(
IN PULONG Register,
IN PULONG Buffer,
IN ULONG Count
);
STORPORT_API
STOR_PHYSICAL_ADDRESS
StorPortConvertUlongToPhysicalAddress(
ULONG_PTR UlongAddress
);
STORPORT_API
ULONG
StorPortConvertPhysicalAddressToUlong(
STOR_PHYSICAL_ADDRESS Address
);
STORPORT_API
VOID
StorPortQuerySystemTime(
OUT PLARGE_INTEGER CurrentTime
);
#define StorPortConvertPhysicalAddressToUlong(Address) ((Address).LowPart)
#define StorPortConvertPhysicalAddressToULong64(Address) ((Address).QuadPart)
STORPORT_API
BOOLEAN
StorPortValidateRange(
IN PVOID HwDeviceExtension,
IN INTERFACE_TYPE BusType,
IN ULONG SystemIoBusNumber,
IN STOR_PHYSICAL_ADDRESS IoAddress,
IN ULONG NumberOfBytes,
IN BOOLEAN InIoSpace
);
STORPORT_API
VOID
StorPortDebugPrint(
ULONG DebugPrintLevel,
PCCHAR DebugMessage,
...
);
//
// Command Descriptor Block. Passed by SCSI controller chip over the SCSI bus
//
typedef union _CDB {
//
// Generic 6-Byte CDB
//
struct _CDB6GENERIC {
UCHAR OperationCode;
UCHAR Immediate : 1;
UCHAR CommandUniqueBits : 4;
UCHAR LogicalUnitNumber : 3;
UCHAR CommandUniqueBytes[3];
UCHAR Link : 1;
UCHAR Flag : 1;
UCHAR Reserved : 4;
UCHAR VendorUnique : 2;
} CDB6GENERIC, *PCDB6GENERIC;
//
// Standard 6-byte CDB
//
struct _CDB6READWRITE {
UCHAR OperationCode; // 0x08, 0x0A - SCSIOP_READ, SCSIOP_WRITE
UCHAR LogicalBlockMsb1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR LogicalBlockMsb0;
UCHAR LogicalBlockLsb;
UCHAR TransferBlocks;
UCHAR Control;
} CDB6READWRITE, *PCDB6READWRITE;
//
// SCSI-1 Inquiry CDB
//
struct _CDB6INQUIRY {
UCHAR OperationCode; // 0x12 - SCSIOP_INQUIRY
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR PageCode;
UCHAR IReserved;
UCHAR AllocationLength;
UCHAR Control;
} CDB6INQUIRY, *PCDB6INQUIRY;
//
// SCSI-3 Inquiry CDB
//
struct _CDB6INQUIRY3 {
UCHAR OperationCode; // 0x12 - SCSIOP_INQUIRY
UCHAR EnableVitalProductData : 1;
UCHAR CommandSupportData : 1;
UCHAR Reserved1 : 6;
UCHAR PageCode;
UCHAR Reserved2;
UCHAR AllocationLength;
UCHAR Control;
} CDB6INQUIRY3, *PCDB6INQUIRY3;
struct _CDB6VERIFY {
UCHAR OperationCode; // 0x13 - SCSIOP_VERIFY
UCHAR Fixed : 1;
UCHAR ByteCompare : 1;
UCHAR Immediate : 1;
UCHAR Reserved : 2;
UCHAR LogicalUnitNumber : 3;
UCHAR VerificationLength[3];
UCHAR Control;
} CDB6VERIFY, *PCDB6VERIFY;
//
// SCSI Format CDB
//
struct _CDB6FORMAT {
UCHAR OperationCode; // 0x04 - SCSIOP_FORMAT_UNIT
UCHAR FormatControl : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR FReserved1;
UCHAR InterleaveMsb;
UCHAR InterleaveLsb;
UCHAR FReserved2;
} CDB6FORMAT, *PCDB6FORMAT;
//
// Standard 10-byte CDB
struct _CDB10 {
UCHAR OperationCode;
UCHAR RelativeAddress : 1;
UCHAR Reserved1 : 2;
UCHAR ForceUnitAccess : 1;
UCHAR DisablePageOut : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR LogicalBlockByte0;
UCHAR LogicalBlockByte1;
UCHAR LogicalBlockByte2;
UCHAR LogicalBlockByte3;
UCHAR Reserved2;
UCHAR TransferBlocksMsb;
UCHAR TransferBlocksLsb;
UCHAR Control;
} CDB10, *PCDB10;
//
// Standard 12-byte CDB
//
struct _CDB12 {
UCHAR OperationCode;
UCHAR RelativeAddress : 1;
UCHAR Reserved1 : 2;
UCHAR ForceUnitAccess : 1;
UCHAR DisablePageOut : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR LogicalBlock[4];
UCHAR TransferLength[4];
UCHAR Reserved2;
UCHAR Control;
} CDB12, *PCDB12;
//
// CD Rom Audio CDBs
//
struct _PAUSE_RESUME {
UCHAR OperationCode; // 0x4B - SCSIOP_PAUSE_RESUME
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2[6];
UCHAR Action;
UCHAR Control;
} PAUSE_RESUME, *PPAUSE_RESUME;
//
// Read Table of Contents
//
struct _READ_TOC {
UCHAR OperationCode; // 0x43 - SCSIOP_READ_TOC
UCHAR Reserved0 : 1;
UCHAR Msf : 1;
UCHAR Reserved1 : 3;
UCHAR LogicalUnitNumber : 3;
UCHAR Format2 : 4;
UCHAR Reserved2 : 4;
UCHAR Reserved3[3];
UCHAR StartingTrack;
UCHAR AllocationLength[2];
UCHAR Control : 6;
UCHAR Format : 2;
} READ_TOC, *PREAD_TOC;
struct _READ_DISK_INFORMATION {
UCHAR OperationCode; // 0x51 - SCSIOP_READ_DISC_INFORMATION
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR Reserved2[5];
UCHAR AllocationLength[2];
UCHAR Control;
} READ_DISK_INFORMATION, *PREAD_DISK_INFORMATION;
struct _READ_TRACK_INFORMATION {
UCHAR OperationCode; // 0x52 - SCSIOP_READ_TRACK_INFORMATION
UCHAR Track : 1;
UCHAR Reserved1 : 3;
UCHAR Reserved2 : 1;
UCHAR Lun : 3;
UCHAR BlockAddress[4]; // or Track Number
UCHAR Reserved3;
UCHAR AllocationLength[2];
UCHAR Control;
} READ_TRACK_INFORMATION, *PREAD_TRACK_INFORMATION;
struct _RESERVE_TRACK_RZONE {
UCHAR OperationCode; // 0x53 - SCSIOP_RESERVE_TRACK_RZONE
UCHAR Reserved1[4];
UCHAR ReservationSize[4];
UCHAR Control;
} RESERVE_TRACK_RZONE, *PRESERVE_TRACK_RZONE;
struct _SEND_OPC_INFORMATION {
UCHAR OperationCode; // 0x54 - SCSIOP_SEND_OPC_INFORMATION
UCHAR DoOpc : 1; // perform OPC
UCHAR Reserved : 7;
UCHAR Reserved1[5];
UCHAR ParameterListLength[2];
UCHAR Reserved2;
} SEND_OPC_INFORMATION, *PSEND_OPC_INFORMATION;
struct _CLOSE_TRACK {
UCHAR OperationCode; // 0x5B - SCSIOP_CLOSE_TRACK_SESSION
UCHAR Immediate : 1;
UCHAR Reserved1 : 7;
UCHAR Track : 1;
UCHAR Session : 1;
UCHAR Reserved2 : 6;
UCHAR Reserved3;
UCHAR TrackNumber[2];
UCHAR Reserved4[3];
UCHAR Control;
} CLOSE_TRACK, *PCLOSE_TRACK;
struct _SEND_CUE_SHEET {
UCHAR OperationCode; // 0x5D - SCSIOP_SEND_CUE_SHEET
UCHAR Reserved[5];
UCHAR CueSheetSize[3];
UCHAR Control;
} SEND_CUE_SHEET, *PSEND_CUE_SHEET;
struct _READ_HEADER {
UCHAR OperationCode; // 0x44 - SCSIOP_READ_HEADER
UCHAR Reserved1 : 1;
UCHAR Msf : 1;
UCHAR Reserved2 : 3;
UCHAR Lun : 3;
UCHAR LogicalBlockAddress[4];
UCHAR Reserved3;
UCHAR AllocationLength[2];
UCHAR Control;
} READ_HEADER, *PREAD_HEADER;
struct _PLAY_AUDIO {
UCHAR OperationCode; // 0x45 - SCSIOP_PLAY_AUDIO
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR StartingBlockAddress[4];
UCHAR Reserved2;
UCHAR PlayLength[2];
UCHAR Control;
} PLAY_AUDIO, *PPLAY_AUDIO;
struct _PLAY_AUDIO_MSF {
UCHAR OperationCode; // 0x47 - SCSIOP_PLAY_AUDIO_MSF
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2;
UCHAR StartingM;
UCHAR StartingS;
UCHAR StartingF;
UCHAR EndingM;
UCHAR EndingS;
UCHAR EndingF;
UCHAR Control;
} PLAY_AUDIO_MSF, *PPLAY_AUDIO_MSF;
struct _PLAY_CD {
UCHAR OperationCode; // 0xBC - SCSIOP_PLAY_CD
UCHAR Reserved1 : 1;
UCHAR CMSF : 1; // LBA = 0, MSF = 1
UCHAR ExpectedSectorType : 3;
UCHAR Lun : 3;
union {
struct _LBA {
UCHAR StartingBlockAddress[4];
UCHAR PlayLength[4];
} LBA;
struct _MSF {
UCHAR Reserved1;
UCHAR StartingM;
UCHAR StartingS;
UCHAR StartingF;
UCHAR EndingM;
UCHAR EndingS;
UCHAR EndingF;
UCHAR Reserved2;
} MSF;
};
UCHAR Audio : 1;
UCHAR Composite : 1;
UCHAR Port1 : 1;
UCHAR Port2 : 1;
UCHAR Reserved2 : 3;
UCHAR Speed : 1;
UCHAR Control;
} PLAY_CD, *PPLAY_CD;
struct _SCAN_CD {
UCHAR OperationCode; // 0xBA - SCSIOP_SCAN_CD
UCHAR RelativeAddress : 1;
UCHAR Reserved1 : 3;
UCHAR Direct : 1;
UCHAR Lun : 3;
UCHAR StartingAddress[4];
UCHAR Reserved2[3];
UCHAR Reserved3 : 6;
UCHAR Type : 2;
UCHAR Reserved4;
UCHAR Control;
} SCAN_CD, *PSCAN_CD;
struct _STOP_PLAY_SCAN {
UCHAR OperationCode; // 0x4E - SCSIOP_STOP_PLAY_SCAN
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR Reserved2[7];
UCHAR Control;
} STOP_PLAY_SCAN, *PSTOP_PLAY_SCAN;
//
// Read SubChannel Data
//
struct _SUBCHANNEL {
UCHAR OperationCode; // 0x42 - SCSIOP_READ_SUB_CHANNEL
UCHAR Reserved0 : 1;
UCHAR Msf : 1;
UCHAR Reserved1 : 3;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2 : 6;
UCHAR SubQ : 1;
UCHAR Reserved3 : 1;
UCHAR Format;
UCHAR Reserved4[2];
UCHAR TrackNumber;
UCHAR AllocationLength[2];
UCHAR Control;
} SUBCHANNEL, *PSUBCHANNEL;
//
// Read CD. Used by Atapi for raw sector reads.
//
struct _READ_CD {
UCHAR OperationCode; // 0xBE - SCSIOP_READ_CD
UCHAR RelativeAddress : 1;
UCHAR Reserved0 : 1;
UCHAR ExpectedSectorType : 3;
UCHAR Lun : 3;
UCHAR StartingLBA[4];
UCHAR TransferBlocks[3];
UCHAR Reserved2 : 1;
UCHAR ErrorFlags : 2;
UCHAR IncludeEDC : 1;
UCHAR IncludeUserData : 1;
UCHAR HeaderCode : 2;
UCHAR IncludeSyncData : 1;
UCHAR SubChannelSelection : 3;
UCHAR Reserved3 : 5;
UCHAR Control;
} READ_CD, *PREAD_CD;
struct _READ_CD_MSF {
UCHAR OperationCode; // 0xB9 - SCSIOP_READ_CD_MSF
UCHAR RelativeAddress : 1;
UCHAR Reserved1 : 1;
UCHAR ExpectedSectorType : 3;
UCHAR Lun : 3;
UCHAR Reserved2;
UCHAR StartingM;
UCHAR StartingS;
UCHAR StartingF;
UCHAR EndingM;
UCHAR EndingS;
UCHAR EndingF;
UCHAR Reserved3;
UCHAR Reserved4 : 1;
UCHAR ErrorFlags : 2;
UCHAR IncludeEDC : 1;
UCHAR IncludeUserData : 1;
UCHAR HeaderCode : 2;
UCHAR IncludeSyncData : 1;
UCHAR SubChannelSelection : 3;
UCHAR Reserved5 : 5;
UCHAR Control;
} READ_CD_MSF, *PREAD_CD_MSF;
//
// Plextor Read CD-DA
//
struct _PLXTR_READ_CDDA {
UCHAR OperationCode; // Unknown -- vendor-unique?
UCHAR Reserved0 : 5;
UCHAR LogicalUnitNumber :3;
UCHAR LogicalBlockByte0;
UCHAR LogicalBlockByte1;
UCHAR LogicalBlockByte2;
UCHAR LogicalBlockByte3;
UCHAR TransferBlockByte0;
UCHAR TransferBlockByte1;
UCHAR TransferBlockByte2;
UCHAR TransferBlockByte3;
UCHAR SubCode;
UCHAR Control;
} PLXTR_READ_CDDA, *PPLXTR_READ_CDDA;
//
// NEC Read CD-DA
//
struct _NEC_READ_CDDA {
UCHAR OperationCode; // Unknown -- vendor-unique?
UCHAR Reserved0;
UCHAR LogicalBlockByte0;
UCHAR LogicalBlockByte1;
UCHAR LogicalBlockByte2;
UCHAR LogicalBlockByte3;
UCHAR Reserved1;
UCHAR TransferBlockByte0;
UCHAR TransferBlockByte1;
UCHAR Control;
} NEC_READ_CDDA, *PNEC_READ_CDDA;
//
// Mode sense
//
struct _MODE_SENSE {
UCHAR OperationCode; // 0x1A - SCSIOP_MODE_SENSE
UCHAR Reserved1 : 3;
UCHAR Dbd : 1;
UCHAR Reserved2 : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR PageCode : 6;
UCHAR Pc : 2;
UCHAR Reserved3;
UCHAR AllocationLength;
UCHAR Control;
} MODE_SENSE, *PMODE_SENSE;
struct _MODE_SENSE10 {
UCHAR OperationCode; // 0x5A - SCSIOP_MODE_SENSE10
UCHAR Reserved1 : 3;
UCHAR Dbd : 1;
UCHAR Reserved2 : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR PageCode : 6;
UCHAR Pc : 2;
UCHAR Reserved3[4];
UCHAR AllocationLength[2];
UCHAR Control;
} MODE_SENSE10, *PMODE_SENSE10;
//
// Mode select
//
struct _MODE_SELECT {
UCHAR OperationCode; // 0x15 - SCSIOP_MODE_SELECT
UCHAR SPBit : 1;
UCHAR Reserved1 : 3;
UCHAR PFBit : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2[2];
UCHAR ParameterListLength;
UCHAR Control;
} MODE_SELECT, *PMODE_SELECT;
struct _MODE_SELECT10 {
UCHAR OperationCode; // 0x55 - SCSIOP_MODE_SELECT10
UCHAR SPBit : 1;
UCHAR Reserved1 : 3;
UCHAR PFBit : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2[5];
UCHAR ParameterListLength[2];
UCHAR Control;
} MODE_SELECT10, *PMODE_SELECT10;
struct _LOCATE {
UCHAR OperationCode; // 0x2B - SCSIOP_LOCATE
UCHAR Immediate : 1;
UCHAR CPBit : 1;
UCHAR BTBit : 1;
UCHAR Reserved1 : 2;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved3;
UCHAR LogicalBlockAddress[4];
UCHAR Reserved4;
UCHAR Partition;
UCHAR Control;
} LOCATE, *PLOCATE;
struct _LOGSENSE {
UCHAR OperationCode; // 0x4D - SCSIOP_LOG_SENSE
UCHAR SPBit : 1;
UCHAR PPCBit : 1;
UCHAR Reserved1 : 3;
UCHAR LogicalUnitNumber : 3;
UCHAR PageCode : 6;
UCHAR PCBit : 2;
UCHAR Reserved2;
UCHAR Reserved3;
UCHAR ParameterPointer[2];
UCHAR AllocationLength[2];
UCHAR Control;
} LOGSENSE, *PLOGSENSE;
struct _LOGSELECT {
UCHAR OperationCode; // 0x4C - SCSIOP_LOG_SELECT
UCHAR SPBit : 1;
UCHAR PCRBit : 1;
UCHAR Reserved1 : 3;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved : 6;
UCHAR PCBit : 2;
UCHAR Reserved2[4];
UCHAR ParameterListLength[2];
UCHAR Control;
} LOGSELECT, *PLOGSELECT;
struct _PRINT {
UCHAR OperationCode; // 0x0A - SCSIOP_PRINT
UCHAR Reserved : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR TransferLength[3];
UCHAR Control;
} PRINT, *PPRINT;
struct _SEEK {
UCHAR OperationCode; // 0x2B - SCSIOP_SEEK
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR LogicalBlockAddress[4];
UCHAR Reserved2[3];
UCHAR Control;
} SEEK, *PSEEK;
struct _ERASE {
UCHAR OperationCode; // 0x19 - SCSIOP_ERASE
UCHAR Long : 1;
UCHAR Immediate : 1;
UCHAR Reserved1 : 3;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2[3];
UCHAR Control;
} ERASE, *PERASE;
struct _START_STOP {
UCHAR OperationCode; // 0x1B - SCSIOP_START_STOP_UNIT
UCHAR Immediate: 1;
UCHAR Reserved1 : 4;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2[2];
UCHAR Start : 1;
UCHAR LoadEject : 1;
UCHAR Reserved3 : 6;
UCHAR Control;
} START_STOP, *PSTART_STOP;
struct _MEDIA_REMOVAL {
UCHAR OperationCode; // 0x1E - SCSIOP_MEDIUM_REMOVAL
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR Reserved2[2];
UCHAR Prevent : 1;
UCHAR Persistant : 1;
UCHAR Reserved3 : 6;
UCHAR Control;
} MEDIA_REMOVAL, *PMEDIA_REMOVAL;
//
// Tape CDBs
//
struct _SEEK_BLOCK {
UCHAR OperationCode; // 0x0C - SCSIOP_SEEK_BLOCK
UCHAR Immediate : 1;
UCHAR Reserved1 : 7;
UCHAR BlockAddress[3];
UCHAR Link : 1;
UCHAR Flag : 1;
UCHAR Reserved2 : 4;
UCHAR VendorUnique : 2;
} SEEK_BLOCK, *PSEEK_BLOCK;
struct _REQUEST_BLOCK_ADDRESS {
UCHAR OperationCode; // 0x02 - SCSIOP_REQUEST_BLOCK_ADDR
UCHAR Reserved1[3];
UCHAR AllocationLength;
UCHAR Link : 1;
UCHAR Flag : 1;
UCHAR Reserved2 : 4;
UCHAR VendorUnique : 2;
} REQUEST_BLOCK_ADDRESS, *PREQUEST_BLOCK_ADDRESS;
struct _PARTITION {
UCHAR OperationCode; // 0x0D - SCSIOP_PARTITION
UCHAR Immediate : 1;
UCHAR Sel: 1;
UCHAR PartitionSelect : 6;
UCHAR Reserved1[3];
UCHAR Control;
} PARTITION, *PPARTITION;
struct _WRITE_TAPE_MARKS {
UCHAR OperationCode; // Unknown -- vendor-unique?
UCHAR Immediate : 1;
UCHAR WriteSetMarks: 1;
UCHAR Reserved : 3;
UCHAR LogicalUnitNumber : 3;
UCHAR TransferLength[3];
UCHAR Control;
} WRITE_TAPE_MARKS, *PWRITE_TAPE_MARKS;
struct _SPACE_TAPE_MARKS {
UCHAR OperationCode; // Unknown -- vendor-unique?
UCHAR Code : 3;
UCHAR Reserved : 2;
UCHAR LogicalUnitNumber : 3;
UCHAR NumMarksMSB ;
UCHAR NumMarks;
UCHAR NumMarksLSB;
union {
UCHAR value;
struct {
UCHAR Link : 1;
UCHAR Flag : 1;
UCHAR Reserved : 4;
UCHAR VendorUnique : 2;
} Fields;
} Byte6;
} SPACE_TAPE_MARKS, *PSPACE_TAPE_MARKS;
//
// Read tape position
//
struct _READ_POSITION {
UCHAR Operation; // 0x43 - SCSIOP_READ_POSITION
UCHAR BlockType:1;
UCHAR Reserved1:4;
UCHAR Lun:3;
UCHAR Reserved2[7];
UCHAR Control;
} READ_POSITION, *PREAD_POSITION;
//
// ReadWrite for Tape
//
struct _CDB6READWRITETAPE {
UCHAR OperationCode; // Unknown -- vendor-unique?
UCHAR VendorSpecific : 5;
UCHAR Reserved : 3;
UCHAR TransferLenMSB;
UCHAR TransferLen;
UCHAR TransferLenLSB;
UCHAR Link : 1;
UCHAR Flag : 1;
UCHAR Reserved1 : 4;
UCHAR VendorUnique : 2;
} CDB6READWRITETAPE, *PCDB6READWRITETAPE;
//
// Medium changer CDB's
//
struct _INIT_ELEMENT_STATUS {
UCHAR OperationCode; // 0x07 - SCSIOP_INIT_ELEMENT_STATUS
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNubmer : 3;
UCHAR Reserved2[3];
UCHAR Reserved3 : 7;
UCHAR NoBarCode : 1;
} INIT_ELEMENT_STATUS, *PINIT_ELEMENT_STATUS;
struct _INITIALIZE_ELEMENT_RANGE {
UCHAR OperationCode; // 0xE7 - SCSIOP_INIT_ELEMENT_RANGE
UCHAR Range : 1;
UCHAR Reserved1 : 4;
UCHAR LogicalUnitNubmer : 3;
UCHAR FirstElementAddress[2];
UCHAR Reserved2[2];
UCHAR NumberOfElements[2];
UCHAR Reserved3;
UCHAR Reserved4 : 7;
UCHAR NoBarCode : 1;
} INITIALIZE_ELEMENT_RANGE, *PINITIALIZE_ELEMENT_RANGE;
struct _POSITION_TO_ELEMENT {
UCHAR OperationCode; // 0x2B - SCSIOP_POSITION_TO_ELEMENT
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR TransportElementAddress[2];
UCHAR DestinationElementAddress[2];
UCHAR Reserved2[2];
UCHAR Flip : 1;
UCHAR Reserved3 : 7;
UCHAR Control;
} POSITION_TO_ELEMENT, *PPOSITION_TO_ELEMENT;
struct _MOVE_MEDIUM {
UCHAR OperationCode; // 0xA5 - SCSIOP_MOVE_MEDIUM
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR TransportElementAddress[2];
UCHAR SourceElementAddress[2];
UCHAR DestinationElementAddress[2];
UCHAR Reserved2[2];
UCHAR Flip : 1;
UCHAR Reserved3 : 7;
UCHAR Control;
} MOVE_MEDIUM, *PMOVE_MEDIUM;
struct _EXCHANGE_MEDIUM {
UCHAR OperationCode; // 0xA6 - SCSIOP_EXCHANGE_MEDIUM
UCHAR Reserved1 : 5;
UCHAR LogicalUnitNumber : 3;
UCHAR TransportElementAddress[2];
UCHAR SourceElementAddress[2];
UCHAR Destination1ElementAddress[2];
UCHAR Destination2ElementAddress[2];
UCHAR Flip1 : 1;
UCHAR Flip2 : 1;
UCHAR Reserved3 : 6;
UCHAR Control;
} EXCHANGE_MEDIUM, *PEXCHANGE_MEDIUM;
struct _READ_ELEMENT_STATUS {
UCHAR OperationCode; // 0xB8 - SCSIOP_READ_ELEMENT_STATUS
UCHAR ElementType : 4;
UCHAR VolTag : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR StartingElementAddress[2];
UCHAR NumberOfElements[2];
UCHAR Reserved1;
UCHAR AllocationLength[3];
UCHAR Reserved2;
UCHAR Control;
} READ_ELEMENT_STATUS, *PREAD_ELEMENT_STATUS;
struct _SEND_VOLUME_TAG {
UCHAR OperationCode; // 0xB6 - SCSIOP_SEND_VOLUME_TAG
UCHAR ElementType : 4;
UCHAR Reserved1 : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR StartingElementAddress[2];
UCHAR Reserved2;
UCHAR ActionCode : 5;
UCHAR Reserved3 : 3;
UCHAR Reserved4[2];
UCHAR ParameterListLength[2];
UCHAR Reserved5;
UCHAR Control;
} SEND_VOLUME_TAG, *PSEND_VOLUME_TAG;
struct _REQUEST_VOLUME_ELEMENT_ADDRESS {
UCHAR OperationCode; // Unknown -- vendor-unique?
UCHAR ElementType : 4;
UCHAR VolTag : 1;
UCHAR LogicalUnitNumber : 3;
UCHAR StartingElementAddress[2];
UCHAR NumberElements[2];
UCHAR Reserved1;
UCHAR AllocationLength[3];
UCHAR Reserved2;
UCHAR Control;
} REQUEST_VOLUME_ELEMENT_ADDRESS, *PREQUEST_VOLUME_ELEMENT_ADDRESS;
//
// Atapi 2.5 Changer 12-byte CDBs
//
struct _LOAD_UNLOAD {
UCHAR OperationCode; // 0xA6 - SCSIOP_LOAD_UNLOAD_SLOT
UCHAR Immediate : 1;
UCHAR Reserved1 : 4;
UCHAR Lun : 3;
UCHAR Reserved2[2];
UCHAR Start : 1;
UCHAR LoadEject : 1;
UCHAR Reserved3: 6;
UCHAR Reserved4[3];
UCHAR Slot;
UCHAR Reserved5[3];
} LOAD_UNLOAD, *PLOAD_UNLOAD;
struct _MECH_STATUS {
UCHAR OperationCode; // 0xBD - SCSIOP_MECHANISM_STATUS
UCHAR Reserved : 5;
UCHAR Lun : 3;
UCHAR Reserved1[6];
UCHAR AllocationLength[2];
UCHAR Reserved2[1];
UCHAR Control;
} MECH_STATUS, *PMECH_STATUS;
//
// C/DVD 0.9 CDBs
//
struct _SYNCHRONIZE_CACHE10 {
UCHAR OperationCode; // 0x35 - SCSIOP_SYNCHRONIZE_CACHE
UCHAR RelAddr : 1;
UCHAR Immediate : 1;
UCHAR Reserved : 3;
UCHAR Lun : 3;
UCHAR LogicalBlockAddress[4]; // Unused - set to zero
UCHAR Reserved2;
UCHAR BlockCount[2]; // Unused - set to zero
UCHAR Control;
} SYNCHRONIZE_CACHE10, *PSYNCHRONIZE_CACHE10;
struct _GET_EVENT_STATUS_NOTIFICATION {
UCHAR OperationCode; // 0x4A - SCSIOP_GET_EVENT_STATUS_NOTIFICATION
UCHAR Immediate : 1;
UCHAR Reserved : 4;
UCHAR Lun : 3;
UCHAR Reserved2[2];
UCHAR NotificationClassRequest;
UCHAR Reserved3[2];
UCHAR EventListLength[2];
UCHAR Control;
} GET_EVENT_STATUS_NOTIFICATION, *PGET_EVENT_STATUS_NOTIFICATION;
struct _READ_DVD_STRUCTURE {
UCHAR OperationCode; // 0xAD - SCSIOP_READ_DVD_STRUCTURE
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR RMDBlockNumber[4];
UCHAR LayerNumber;
UCHAR Format;
UCHAR AllocationLength[2];
UCHAR Reserved3 : 6;
UCHAR AGID : 2;
UCHAR Control;
} READ_DVD_STRUCTURE, *PREAD_DVD_STRUCTURE;
struct _SEND_DVD_STRUCTURE {
UCHAR OperationCode; // 0xBF - SCSIOP_SEND_DVD_STRUCTURE
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR Reserved2[5];
UCHAR Format;
UCHAR ParameterListLength[2];
UCHAR Reserved3;
UCHAR Control;
} SEND_DVD_STRUCTURE, *PSEND_DVD_STRUCTURE;
struct _SEND_KEY {
UCHAR OperationCode; // 0xA3 - SCSIOP_SEND_KEY
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR Reserved2[6];
UCHAR ParameterListLength[2];
UCHAR KeyFormat : 6;
UCHAR AGID : 2;
UCHAR Control;
} SEND_KEY, *PSEND_KEY;
struct _REPORT_KEY {
UCHAR OperationCode; // 0xA4 - SCSIOP_REPORT_KEY
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR LogicalBlockAddress[4]; // for title key
UCHAR Reserved2[2];
UCHAR AllocationLength[2];
UCHAR KeyFormat : 6;
UCHAR AGID : 2;
UCHAR Control;
} REPORT_KEY, *PREPORT_KEY;
struct _SET_READ_AHEAD {
UCHAR OperationCode; // 0xA7 - SCSIOP_SET_READ_AHEAD
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR TriggerLBA[4];
UCHAR ReadAheadLBA[4];
UCHAR Reserved2;
UCHAR Control;
} SET_READ_AHEAD, *PSET_READ_AHEAD;
struct _READ_FORMATTED_CAPACITIES {
UCHAR OperationCode; // 0x23 - SCSIOP_READ_FORMATTED_CAPACITY
UCHAR Reserved1 : 5;
UCHAR Lun : 3;
UCHAR Reserved2[5];
UCHAR AllocationLength[2];
UCHAR Control;
} READ_FORMATTED_CAPACITIES, *PREAD_FORMATTED_CAPACITIES;
//
// SCSI-3
//
struct _REPORT_LUNS {
UCHAR OperationCode; // 0xA0 - SCSIOP_REPORT_LUNS
UCHAR Reserved1[5];
UCHAR AllocationLength[4];
UCHAR Reserved2[1];
UCHAR Control;
} REPORT_LUNS, *PREPORT_LUNS;
struct _PERSISTENT_RESERVE_IN {
UCHAR OperationCode; // 0x5E - SCSIOP_PERSISTENT_RESERVE_IN
UCHAR ServiceAction : 5;
UCHAR Reserved1 : 3;
UCHAR Reserved2[5];
UCHAR AllocationLength[2];
UCHAR Control;
} PERSISTENT_RESERVE_IN, *PPERSISTENT_RESERVE_IN;
struct _PERSISTENT_RESERVE_OUT {
UCHAR OperationCode; // 0x5F - SCSIOP_PERSISTENT_RESERVE_OUT
UCHAR ServiceAction : 5;
UCHAR Reserved1 : 3;
UCHAR Type : 4;
UCHAR Scope : 4;
UCHAR Reserved2[4];
UCHAR ParameterListLength[2]; // 0x18
UCHAR Control;
} PERSISTENT_RESERVE_OUT, *PPERSISTENT_RESERVE_OUT;
//
// MMC / SFF-8090 commands
//
struct _GET_CONFIGURATION {
UCHAR OperationCode; // 0x46 - SCSIOP_GET_CONFIGURATION
UCHAR RequestType : 1; // SCSI_GET_CONFIGURATION_REQUEST_TYPE_*
UCHAR Reserved1 : 7; // includes obsolete LUN field
UCHAR StartingFeature[2];
UCHAR Reserved2[3];
UCHAR AllocationLength[2];
UCHAR Control;
} GET_CONFIGURATION, *PGET_CONFIGURATION;
struct _SET_CD_SPEED {
UCHAR OperationCode; // 0xB8 - SCSIOP_SET_CD_SPEED
UCHAR Reserved1;
UCHAR ReadSpeed[2]; // 1x == (75 * 2352)
UCHAR WriteSpeed[2]; // 1x == (75 * 2352)
UCHAR Reserved2[5];
UCHAR Control;
} SET_CD_SPEED, *PSET_CD_SPEED;
ULONG AsUlong[4];
UCHAR AsByte[16];
} CDB, *PCDB;
////////////////////////////////////////////////////////////////////////////////
//
// GET_EVENT_STATUS_NOTIFICATION
//
#define NOTIFICATION_OPERATIONAL_CHANGE_CLASS_MASK 0x02
#define NOTIFICATION_POWER_MANAGEMENT_CLASS_MASK 0x04
#define NOTIFICATION_EXTERNAL_REQUEST_CLASS_MASK 0x08
#define NOTIFICATION_MEDIA_STATUS_CLASS_MASK 0x10
#define NOTIFICATION_MULTI_HOST_CLASS_MASK 0x20
#define NOTIFICATION_DEVICE_BUSY_CLASS_MASK 0x40
#define NOTIFICATION_NO_CLASS_EVENTS 0x0
#define NOTIFICATION_OPERATIONAL_CHANGE_CLASS_EVENTS 0x1
#define NOTIFICATION_POWER_MANAGEMENT_CLASS_EVENTS 0x2
#define NOTIFICATION_EXTERNAL_REQUEST_CLASS_EVENTS 0x3
#define NOTIFICATION_MEDIA_STATUS_CLASS_EVENTS 0x4
#define NOTIFICATION_MULTI_HOST_CLASS_EVENTS 0x5
#define NOTIFICATION_DEVICE_BUSY_CLASS_EVENTS 0x6
typedef struct _NOTIFICATION_EVENT_STATUS_HEADER {
UCHAR EventDataLength[2];
UCHAR NotificationClass : 3;
UCHAR Reserved : 4;
UCHAR NEA : 1;
UCHAR SupportedEventClasses;
UCHAR ClassEventData[0];
} NOTIFICATION_EVENT_STATUS_HEADER, *PNOTIFICATION_EVENT_STATUS_HEADER;
#define NOTIFICATION_OPERATIONAL_EVENT_NO_CHANGE 0x0
#define NOTIFICATION_OPERATIONAL_EVENT_CHANGE_REQUESTED 0x1
#define NOTIFICATION_OPERATIONAL_EVENT_CHANGE_OCCURRED 0x2
#define NOTIFICATION_OPERATIONAL_STATUS_AVAILABLE 0x0
#define NOTIFICATION_OPERATIONAL_STATUS_TEMPORARY_BUSY 0x1
#define NOTIFICATION_OPERATIONAL_STATUS_EXTENDED_BUSY 0x2
#define NOTIFICATION_OPERATIONAL_OPCODE_NONE
#define NOTIFICATION_OPERATIONAL_OPCODE_FEATURE_CHANGE 0x1
#define NOTIFICATION_OPERATIONAL_OPCODE_FEATURE_ADDED 0x2
#define NOTIFICATION_OPERATIONAL_OPCODE_UNIT_RESET 0x3
#define NOTIFICATION_OPERATIONAL_OPCODE_FIRMWARE_CHANGED 0x4
#define NOTIFICATION_OPERATIONAL_OPCODE_INQUIRY_CHANGED 0x5
//
// Class event data may be one (or none) of the following:
//
typedef struct _NOTIFICATION_OPERATIONAL_STATUS { // event class == 0x1
UCHAR OperationalEvent : 4;
UCHAR Reserved1 : 4;
UCHAR OperationalStatus : 4;
UCHAR Reserved2 : 3;
UCHAR PersistentPrevented : 1;
UCHAR Operation[2];
} NOTIFICATION_OPERATIONAL_STATUS, *PNOTIFICATION_OPERATIONAL_STATUS;
#define NOTIFICATION_POWER_EVENT_NO_CHANGE 0x0
#define NOTIFICATION_POWER_EVENT_CHANGE_SUCCEEDED 0x1
#define NOTIFICATION_POWER_EVENT_CHANGE_FAILED 0x2
#define NOTIFICATION_POWER_STATUS_ACTIVE 0x1
#define NOTIFICATION_POWER_STATUS_IDLE 0x2
#define NOTIFICATION_POWER_STATUS_STANDBY 0x3
#define NOTIFICATION_POWER_STATUS_SLEEP 0x4
typedef struct _NOTIFICATION_POWER_STATUS { // event class == 0x2
UCHAR PowerEvent : 4;
UCHAR Reserved : 4;
UCHAR PowerStatus;
UCHAR Reserved2[2];
} NOTIFICATION_POWER_STATUS, *PNOTIFICATION_POWER_STATUS;
#define NOTIFICATION_EXTERNAL_EVENT_NO_CHANGE 0x0
#define NOTIFICATION_EXTERNAL_EVENT_BUTTON_DOWN 0x1
#define NOTIFICATION_EXTERNAL_EVENT_BUTTON_UP 0x2
#define NOTIFICATION_EXTERNAL_EVENT_EXTERNAL 0x3 // respond with GET_CONFIGURATION?
#define NOTIFICATION_EXTERNAL_STATUS_READY 0x0
#define NOTIFICATION_EXTERNAL_STATUS_PREVENT 0x1
#define NOTIFICATION_EXTERNAL_REQUEST_NONE 0x0000
#define NOTIFICATION_EXTERNAL_REQUEST_QUEUE_OVERRUN 0x0001
#define NOTIFICATION_EXTERNAL_REQUEST_PLAY 0x0101
#define NOTIFICATION_EXTERNAL_REQUEST_REWIND_BACK 0x0102
#define NOTIFICATION_EXTERNAL_REQUEST_FAST_FORWARD 0x0103
#define NOTIFICATION_EXTERNAL_REQUEST_PAUSE 0x0104
#define NOTIFICATION_EXTERNAL_REQUEST_STOP 0x0106
#define NOTIFICATION_EXTERNAL_REQUEST_ASCII_LOW 0x0200
#define NOTIFICATION_EXTERNAL_REQUEST_ASCII_HIGH 0x02ff
typedef struct _NOTIFICATION_EXTERNAL_STATUS { // event class == 0x3
UCHAR ExternalEvent : 4;
UCHAR Reserved1 : 4;
UCHAR ExternalStatus : 4;
UCHAR Reserved2 : 3;
UCHAR PersistentPrevented : 1;
UCHAR Request[2];
} NOTIFICATION_EXTERNAL_STATUS, *PNOTIFICATION_EXTERNAL_STATUS;
#define NOTIFICATION_MEDIA_EVENT_NO_CHANGE 0x0
#define NOTIFICATION_MEDIA_EVENT_EJECT_REQUEST 0x1
#define NOTIFICATION_MEDIA_EVENT_NEW_MEDIA 0x2
#define NOTIFICATION_MEDIA_EVENT_MEDIA_REMOVAL 0x3
#define NOTIFICATION_MEDIA_EVENT_MEDIA_CHANGE 0x4
typedef struct _NOTIFICATION_MEDIA_STATUS { // event class == 0x4
UCHAR MediaEvent : 4;
UCHAR Reserved : 4;
union {
UCHAR PowerStatus; // OBSOLETE -- was improperly named in NT5 headers
UCHAR MediaStatus; // Use this for currently reserved fields
struct {
UCHAR DoorTrayOpen : 1;
UCHAR MediaPresent : 1;
UCHAR ReservedX : 6; // do not reference this directly!
};
};
UCHAR StartSlot;
UCHAR EndSlot;
} NOTIFICATION_MEDIA_STATUS, *PNOTIFICATION_MEDIA_STATUS;
#define NOTIFICATION_MULTI_HOST_EVENT_NO_CHANGE 0x0
#define NOTIFICATION_MULTI_HOST_EVENT_CONTROL_REQUEST 0x1
#define NOTIFICATION_MULTI_HOST_EVENT_CONTROL_GRANT 0x2
#define NOTIFICATION_MULTI_HOST_EVENT_CONTROL_RELEASE 0x3
#define NOTIFICATION_MULTI_HOST_STATUS_READY 0x0
#define NOTIFICATION_MULTI_HOST_STATUS_PREVENT 0x1
#define NOTIFICATION_MULTI_HOST_PRIORITY_NO_REQUESTS 0x0
#define NOTIFICATION_MULTI_HOST_PRIORITY_LOW 0x1
#define NOTIFICATION_MULTI_HOST_PRIORITY_MEDIUM 0x2
#define NOTIFICATION_MULTI_HOST_PRIORITY_HIGH 0x3
typedef struct _NOTIFICATION_MULTI_HOST_STATUS { // event class == 0x5
UCHAR MultiHostEvent : 4;
UCHAR Reserved1 : 4;
UCHAR MultiHostStatus : 4;
UCHAR Reserved2 : 3;
UCHAR PersistentPrevented : 1;
UCHAR Priority[2];
} NOTIFICATION_MULTI_HOST_STATUS, *PNOTIFICATION_MULTI_HOST_STATUS;
#define NOTIFICATION_BUSY_EVENT_NO_CHANGE 0x0
#define NOTIFICATION_BUSY_EVENT_BUSY 0x1
#define NOTIFICATION_BUSY_STATUS_NO_EVENT 0x0
#define NOTIFICATION_BUSY_STATUS_POWER 0x1
#define NOTIFICATION_BUSY_STATUS_IMMEDIATE 0x2
#define NOTIFICATION_BUSY_STATUS_DEFERRED 0x3
typedef struct _NOTIFICATION_BUSY_STATUS { // event class == 0x6
UCHAR DeviceBusyEvent : 4;
UCHAR Reserved : 4;
UCHAR DeviceBusyStatus;
UCHAR Time[2];
} NOTIFICATION_BUSY_STATUS, *PNOTIFICATION_BUSY_STATUS;
////////////////////////////////////////////////////////////////////////////////
//
// Read DVD Structure Definitions and Constants
//
#define DVD_FORMAT_LEAD_IN 0x00
#define DVD_FORMAT_COPYRIGHT 0x01
#define DVD_FORMAT_DISK_KEY 0x02
#define DVD_FORMAT_BCA 0x03
#define DVD_FORMAT_MANUFACTURING 0x04
typedef struct _READ_DVD_STRUCTURES_HEADER {
UCHAR Length[2];
UCHAR Reserved[2];
UCHAR Data[0];
} READ_DVD_STRUCTURES_HEADER, *PREAD_DVD_STRUCTURES_HEADER;
//
// DiskKey, BCA & Manufacturer information will provide byte arrays as their
// data.
//
//
// CDVD 0.9 Send & Report Key Definitions and Structures
//
#define DVD_REPORT_AGID 0x00
#define DVD_CHALLENGE_KEY 0x01
#define DVD_KEY_1 0x02
#define DVD_KEY_2 0x03
#define DVD_TITLE_KEY 0x04
#define DVD_REPORT_ASF 0x05
#define DVD_INVALIDATE_AGID 0x3F
typedef struct _CDVD_KEY_HEADER {
UCHAR DataLength[2];
UCHAR Reserved[2];
UCHAR Data[0];
} CDVD_KEY_HEADER, *PCDVD_KEY_HEADER;
typedef struct _CDVD_REPORT_AGID_DATA {
UCHAR Reserved1[3];
UCHAR Reserved2 : 6;
UCHAR AGID : 2;
} CDVD_REPORT_AGID_DATA, *PCDVD_REPORT_AGID_DATA;
typedef struct _CDVD_CHALLENGE_KEY_DATA {
UCHAR ChallengeKeyValue[10];
UCHAR Reserved[2];
} CDVD_CHALLENGE_KEY_DATA, *PCDVD_CHALLENGE_KEY_DATA;
typedef struct _CDVD_KEY_DATA {
UCHAR Key[5];
UCHAR Reserved[3];
} CDVD_KEY_DATA, *PCDVD_KEY_DATA;
typedef struct _CDVD_REPORT_ASF_DATA {
UCHAR Reserved1[3];
UCHAR Success : 1;
UCHAR Reserved2 : 7;
} CDVD_REPORT_ASF_DATA, *PCDVD_REPORT_ASF_DATA;
typedef struct _CDVD_TITLE_KEY_HEADER {
UCHAR DataLength[2];
UCHAR Reserved1[1];
UCHAR Reserved2 : 3;
UCHAR CGMS : 2;
UCHAR CP_SEC : 1;
UCHAR CPM : 1;
UCHAR Zero : 1;
CDVD_KEY_DATA TitleKey;
} CDVD_TITLE_KEY_HEADER, *PCDVD_TITLE_KEY_HEADER;
//
// Read Formatted Capacity Data - returned in Big Endian Format
//
typedef struct _FORMATTED_CAPACITY_DESCRIPTOR {
UCHAR NumberOfBlocks[4];
UCHAR Maximum : 1;
UCHAR Valid : 1;
UCHAR BlockLength[3];
} FORMATTED_CAPACITY_DESCRIPTOR, *PFORMATTED_CAPACITY_DESCRIPTOR;
typedef struct _FORMATTED_CAPACITY_LIST {
UCHAR Reserved[3];
UCHAR CapacityListLength;
FORMATTED_CAPACITY_DESCRIPTOR Descriptors[0];
} FORMATTED_CAPACITY_LIST, *PFORMATTED_CAPACITY_LIST;
//
// PLAY_CD definitions and constants
//
#define CD_EXPECTED_SECTOR_ANY 0x0
#define CD_EXPECTED_SECTOR_CDDA 0x1
#define CD_EXPECTED_SECTOR_MODE1 0x2
#define CD_EXPECTED_SECTOR_MODE2 0x3
#define CD_EXPECTED_SECTOR_MODE2_FORM1 0x4
#define CD_EXPECTED_SECTOR_MODE2_FORM2 0x5
//
// Read Disk Information Definitions and Capabilities
//
#define DISK_STATUS_EMPTY 0x00
#define DISK_STATUS_INCOMPLETE 0x01
#define DISK_STATUS_COMPLETE 0x02
#define LAST_SESSION_EMPTY 0x00
#define LAST_SESSION_INCOMPLETE 0x01
#define LAST_SESSION_COMPLETE 0x03
#define DISK_TYPE_CDDA 0x01
#define DISK_TYPE_CDI 0x10
#define DISK_TYPE_XA 0x20
#define DISK_TYPE_UNDEFINED 0xFF
typedef struct _OPC_TABLE_ENTRY {
UCHAR Speed[2];
UCHAR OPCValue[6];
} OPC_TABLE_ENTRY, *POPC_TABLE_ENTRY;
typedef struct _DISK_INFORMATION {
UCHAR Length[2];
UCHAR DiskStatus : 2;
UCHAR LastSessionStatus : 2;
UCHAR Erasable : 1;
UCHAR Reserved1 : 3;
UCHAR FirstTrackNumber;
UCHAR NumberOfSessions;
UCHAR LastSessionFirstTrack;
UCHAR LastSessionLastTrack;
UCHAR Reserved2 : 5;
UCHAR GEN : 1;
UCHAR DBC_V : 1;
UCHAR DID_V : 1;
UCHAR DiskType;
UCHAR Reserved3[3];
UCHAR DiskIdentification[4];
UCHAR LastSessionLeadIn[4]; // MSF
UCHAR LastPossibleStartTime[4]; // MSF
UCHAR DiskBarCode[8];
UCHAR Reserved4;
UCHAR NumberOPCEntries;
OPC_TABLE_ENTRY OPCTable[0];
} DISK_INFORMATION, *PDISK_INFORMATION;
//
// Read Header definitions and structures
//
typedef struct _DATA_BLOCK_HEADER {
UCHAR DataMode;
UCHAR Reserved[4];
union {
UCHAR LogicalBlockAddress[4];
struct {
UCHAR Reserved;
UCHAR M;
UCHAR S;
UCHAR F;
} MSF;
};
} DATA_BLOCK_HEADER, *PDATA_BLOCK_HEADER;
#define DATA_BLOCK_MODE0 0x0
#define DATA_BLOCK_MODE1 0x1
#define DATA_BLOCK_MODE2 0x2
//
// Read TOC Format Codes
//
#define READ_TOC_FORMAT_TOC 0x00
#define READ_TOC_FORMAT_SESSION 0x01
#define READ_TOC_FORMAT_FULL_TOC 0x02
#define READ_TOC_FORMAT_PMA 0x03
#define READ_TOC_FORMAT_ATIP 0x04
typedef struct _TRACK_INFORMATION {
UCHAR Length[2];
UCHAR TrackNumber;
UCHAR SessionNumber;
UCHAR Reserved1;
UCHAR TrackMode : 4;
UCHAR Copy : 1;
UCHAR Damage : 1;
UCHAR Reserved2 : 2;
UCHAR DataMode : 4;
UCHAR FP : 1;
UCHAR Packet : 1;
UCHAR Blank : 1;
UCHAR RT : 1;
UCHAR NWA_V : 1;
UCHAR Reserved3 : 7;
UCHAR TrackStartAddress[4];
UCHAR NextWritableAddress[4];
UCHAR FreeBlocks[4];
UCHAR FixedPacketSize[4];
} TRACK_INFORMATION, *PTRACK_INFORMATION;
//
// Command Descriptor Block constants.
//
#define CDB6GENERIC_LENGTH 6
#define CDB10GENERIC_LENGTH 10
#define CDB12GENERIC_LENGTH 12
#define SETBITON 1
#define SETBITOFF 0
//
// Mode Sense/Select page constants.
//
#define MODE_PAGE_ERROR_RECOVERY 0x01
#define MODE_PAGE_DISCONNECT 0x02
#define MODE_PAGE_FORMAT_DEVICE 0x03
#define MODE_PAGE_RIGID_GEOMETRY 0x04
#define MODE_PAGE_FLEXIBILE 0x05 // disk
#define MODE_PAGE_WRITE_PARAMETERS 0x05 // cdrom
#define MODE_PAGE_VERIFY_ERROR 0x07
#define MODE_PAGE_CACHING 0x08
#define MODE_PAGE_PERIPHERAL 0x09
#define MODE_PAGE_CONTROL 0x0A
#define MODE_PAGE_MEDIUM_TYPES 0x0B
#define MODE_PAGE_NOTCH_PARTITION 0x0C
#define MODE_PAGE_CD_AUDIO_CONTROL 0x0E
#define MODE_PAGE_DATA_COMPRESS 0x0F
#define MODE_PAGE_DEVICE_CONFIG 0x10
#define MODE_PAGE_MEDIUM_PARTITION 0x11
#define MODE_PAGE_CDVD_FEATURE_SET 0x18
#define MODE_PAGE_POWER_CONDITION 0x1A
#define MODE_PAGE_FAULT_REPORTING 0x1C
#define MODE_PAGE_CDVD_INACTIVITY 0x1D // cdrom
#define MODE_PAGE_ELEMENT_ADDRESS 0x1D
#define MODE_PAGE_TRANSPORT_GEOMETRY 0x1E
#define MODE_PAGE_DEVICE_CAPABILITIES 0x1F
#define MODE_PAGE_CAPABILITIES 0x2A // cdrom
#define MODE_SENSE_RETURN_ALL 0x3f
#define MODE_SENSE_CURRENT_VALUES 0x00
#define MODE_SENSE_CHANGEABLE_VALUES 0x40
#define MODE_SENSE_DEFAULT_VAULES 0x80
#define MODE_SENSE_SAVED_VALUES 0xc0
//
// SCSI CDB operation codes
//
// 6-byte commands:
#define SCSIOP_TEST_UNIT_READY 0x00
#define SCSIOP_REZERO_UNIT 0x01
#define SCSIOP_REWIND 0x01
#define SCSIOP_REQUEST_BLOCK_ADDR 0x02
#define SCSIOP_REQUEST_SENSE 0x03
#define SCSIOP_FORMAT_UNIT 0x04
#define SCSIOP_READ_BLOCK_LIMITS 0x05
#define SCSIOP_REASSIGN_BLOCKS 0x07
#define SCSIOP_INIT_ELEMENT_STATUS 0x07
#define SCSIOP_READ6 0x08
#define SCSIOP_RECEIVE 0x08
#define SCSIOP_WRITE6 0x0A
#define SCSIOP_PRINT 0x0A
#define SCSIOP_SEND 0x0A
#define SCSIOP_SEEK6 0x0B
#define SCSIOP_TRACK_SELECT 0x0B
#define SCSIOP_SLEW_PRINT 0x0B
#define SCSIOP_SEEK_BLOCK 0x0C
#define SCSIOP_PARTITION 0x0D
#define SCSIOP_READ_REVERSE 0x0F
#define SCSIOP_WRITE_FILEMARKS 0x10
#define SCSIOP_FLUSH_BUFFER 0x10
#define SCSIOP_SPACE 0x11
#define SCSIOP_INQUIRY 0x12
#define SCSIOP_VERIFY6 0x13
#define SCSIOP_RECOVER_BUF_DATA 0x14
#define SCSIOP_MODE_SELECT 0x15
#define SCSIOP_RESERVE_UNIT 0x16
#define SCSIOP_RELEASE_UNIT 0x17
#define SCSIOP_COPY 0x18
#define SCSIOP_ERASE 0x19
#define SCSIOP_MODE_SENSE 0x1A
#define SCSIOP_START_STOP_UNIT 0x1B
#define SCSIOP_STOP_PRINT 0x1B
#define SCSIOP_LOAD_UNLOAD 0x1B
#define SCSIOP_RECEIVE_DIAGNOSTIC 0x1C
#define SCSIOP_SEND_DIAGNOSTIC 0x1D
#define SCSIOP_MEDIUM_REMOVAL 0x1E
// 10-byte commands
#define SCSIOP_READ_FORMATTED_CAPACITY 0x23
#define SCSIOP_READ_CAPACITY 0x25
#define SCSIOP_READ 0x28
#define SCSIOP_WRITE 0x2A
#define SCSIOP_SEEK 0x2B
#define SCSIOP_LOCATE 0x2B
#define SCSIOP_POSITION_TO_ELEMENT 0x2B
#define SCSIOP_WRITE_VERIFY 0x2E
#define SCSIOP_VERIFY 0x2F
#define SCSIOP_SEARCH_DATA_HIGH 0x30
#define SCSIOP_SEARCH_DATA_EQUAL 0x31
#define SCSIOP_SEARCH_DATA_LOW 0x32
#define SCSIOP_SET_LIMITS 0x33
#define SCSIOP_READ_POSITION 0x34
#define SCSIOP_SYNCHRONIZE_CACHE 0x35
#define SCSIOP_COMPARE 0x39
#define SCSIOP_COPY_COMPARE 0x3A
#define SCSIOP_WRITE_DATA_BUFF 0x3B
#define SCSIOP_READ_DATA_BUFF 0x3C
#define SCSIOP_CHANGE_DEFINITION 0x40
#define SCSIOP_READ_SUB_CHANNEL 0x42
#define SCSIOP_READ_TOC 0x43
#define SCSIOP_READ_HEADER 0x44
#define SCSIOP_PLAY_AUDIO 0x45
#define SCSIOP_GET_CONFIGURATION 0x46
#define SCSIOP_PLAY_AUDIO_MSF 0x47
#define SCSIOP_PLAY_TRACK_INDEX 0x48
#define SCSIOP_PLAY_TRACK_RELATIVE 0x49
#define SCSIOP_GET_EVENT_STATUS 0x4A
#define SCSIOP_PAUSE_RESUME 0x4B
#define SCSIOP_LOG_SELECT 0x4C
#define SCSIOP_LOG_SENSE 0x4D
#define SCSIOP_STOP_PLAY_SCAN 0x4E
#define SCSIOP_READ_DISK_INFORMATION 0x51
#define SCSIOP_READ_TRACK_INFORMATION 0x52
#define SCSIOP_RESERVE_TRACK_RZONE 0x53
#define SCSIOP_SEND_OPC_INFORMATION 0x54 // optimum power calibration
#define SCSIOP_MODE_SELECT10 0x55
#define SCSIOP_MODE_SENSE10 0x5A
#define SCSIOP_CLOSE_TRACK_SESSION 0x5B
#define SCSIOP_READ_BUFFER_CAPACITY 0x5C
#define SCSIOP_SEND_CUE_SHEET 0x5D
#define SCSIOP_PERSISTENT_RESERVE_IN 0x5E
#define SCSIOP_PERSISTENT_RESERVE_OUT 0x5F
// 12-byte commands
#define SCSIOP_REPORT_LUNS 0xA0
#define SCSIOP_BLANK 0xA1
#define SCSIOP_SEND_KEY 0xA3
#define SCSIOP_REPORT_KEY 0xA4
#define SCSIOP_MOVE_MEDIUM 0xA5
#define SCSIOP_LOAD_UNLOAD_SLOT 0xA6
#define SCSIOP_EXCHANGE_MEDIUM 0xA6
#define SCSIOP_SET_READ_AHEAD 0xA7
#define SCSIOP_READ_DVD_STRUCTURE 0xAD
#define SCSIOP_REQUEST_VOL_ELEMENT 0xB5
#define SCSIOP_SEND_VOLUME_TAG 0xB6
#define SCSIOP_READ_ELEMENT_STATUS 0xB8
#define SCSIOP_READ_CD_MSF 0xB9
#define SCSIOP_SCAN_CD 0xBA
#define SCSIOP_SET_CD_SPEED 0xBB
#define SCSIOP_PLAY_CD 0xBC
#define SCSIOP_MECHANISM_STATUS 0xBD
#define SCSIOP_READ_CD 0xBE
#define SCSIOP_SEND_DVD_STRUCTURE 0xBF
#define SCSIOP_INIT_ELEMENT_RANGE 0xE7
//
// If the IMMED bit is 1, status is returned as soon
// as the operation is initiated. If the IMMED bit
// is 0, status is not returned until the operation
// is completed.
//
#define CDB_RETURN_ON_COMPLETION 0
#define CDB_RETURN_IMMEDIATE 1
// end_ntminitape
//
// CDB Force media access used in extended read and write commands.
//
#define CDB_FORCE_MEDIA_ACCESS 0x08
//
// Denon CD ROM operation codes
//
#define SCSIOP_DENON_EJECT_DISC 0xE6
#define SCSIOP_DENON_STOP_AUDIO 0xE7
#define SCSIOP_DENON_PLAY_AUDIO 0xE8
#define SCSIOP_DENON_READ_TOC 0xE9
#define SCSIOP_DENON_READ_SUBCODE 0xEB
//
// SCSI Bus Messages
//
#define SCSIMESS_ABORT 0x06
#define SCSIMESS_ABORT_WITH_TAG 0x0D
#define SCSIMESS_BUS_DEVICE_RESET 0X0C
#define SCSIMESS_CLEAR_QUEUE 0X0E
#define SCSIMESS_COMMAND_COMPLETE 0X00
#define SCSIMESS_DISCONNECT 0X04
#define SCSIMESS_EXTENDED_MESSAGE 0X01
#define SCSIMESS_IDENTIFY 0X80
#define SCSIMESS_IDENTIFY_WITH_DISCON 0XC0
#define SCSIMESS_IGNORE_WIDE_RESIDUE 0X23
#define SCSIMESS_INITIATE_RECOVERY 0X0F
#define SCSIMESS_INIT_DETECTED_ERROR 0X05
#define SCSIMESS_LINK_CMD_COMP 0X0A
#define SCSIMESS_LINK_CMD_COMP_W_FLAG 0X0B
#define SCSIMESS_MESS_PARITY_ERROR 0X09
#define SCSIMESS_MESSAGE_REJECT 0X07
#define SCSIMESS_NO_OPERATION 0X08
#define SCSIMESS_HEAD_OF_QUEUE_TAG 0X21
#define SCSIMESS_ORDERED_QUEUE_TAG 0X22
#define SCSIMESS_SIMPLE_QUEUE_TAG 0X20
#define SCSIMESS_RELEASE_RECOVERY 0X10
#define SCSIMESS_RESTORE_POINTERS 0X03
#define SCSIMESS_SAVE_DATA_POINTER 0X02
#define SCSIMESS_TERMINATE_IO_PROCESS 0X11
//
// SCSI Extended Message operation codes
//
#define SCSIMESS_MODIFY_DATA_POINTER 0X00
#define SCSIMESS_SYNCHRONOUS_DATA_REQ 0X01
#define SCSIMESS_WIDE_DATA_REQUEST 0X03
//
// SCSI Extended Message Lengths
//
#define SCSIMESS_MODIFY_DATA_LENGTH 5
#define SCSIMESS_SYNCH_DATA_LENGTH 3
#define SCSIMESS_WIDE_DATA_LENGTH 2
//
// SCSI extended message structure
//
#pragma pack (1)
typedef struct _SCSI_EXTENDED_MESSAGE {
UCHAR InitialMessageCode;
UCHAR MessageLength;
UCHAR MessageType;
union _EXTENDED_ARGUMENTS {
struct {
UCHAR Modifier[4];
} Modify;
struct {
UCHAR TransferPeriod;
UCHAR ReqAckOffset;
} Synchronous;
struct{
UCHAR Width;
} Wide;
}ExtendedArguments;
}SCSI_EXTENDED_MESSAGE, *PSCSI_EXTENDED_MESSAGE;
#pragma pack ()
//
// SCSI bus status codes.
//
#define SCSISTAT_GOOD 0x00
#define SCSISTAT_CHECK_CONDITION 0x02
#define SCSISTAT_CONDITION_MET 0x04
#define SCSISTAT_BUSY 0x08
#define SCSISTAT_INTERMEDIATE 0x10
#define SCSISTAT_INTERMEDIATE_COND_MET 0x14
#define SCSISTAT_RESERVATION_CONFLICT 0x18
#define SCSISTAT_COMMAND_TERMINATED 0x22
#define SCSISTAT_QUEUE_FULL 0x28
//
// Enable Vital Product Data Flag (EVPD)
// used with INQUIRY command.
//
#define CDB_INQUIRY_EVPD 0x01
//
// Defines for format CDB
//
#define LUN0_FORMAT_SAVING_DEFECT_LIST 0
#define USE_DEFAULTMSB 0
#define USE_DEFAULTLSB 0
#define START_UNIT_CODE 0x01
#define STOP_UNIT_CODE 0x00
//
// Inquiry buffer structure. This is the data returned from the target
// after it receives an inquiry.
//
// This structure may be extended by the number of bytes specified
// in the field AdditionalLength. The defined size constant only
// includes fields through ProductRevisionLevel.
//
// The NT SCSI drivers are only interested in the first 36 bytes of data.
//
#define INQUIRYDATABUFFERSIZE 36
typedef struct _INQUIRYDATA {
UCHAR DeviceType : 5;
UCHAR DeviceTypeQualifier : 3;
UCHAR DeviceTypeModifier : 7;
UCHAR RemovableMedia : 1;
union {
UCHAR Versions;
struct {
UCHAR ANSIVersion : 3;
UCHAR ECMAVersion : 3;
UCHAR ISOVersion : 2;
};
};
UCHAR ResponseDataFormat : 4;
UCHAR HiSupport : 1;
UCHAR NormACA : 1;
UCHAR TerminateTask : 1;
UCHAR AERC : 1;
UCHAR AdditionalLength;
UCHAR Reserved;
UCHAR Addr16 : 1; // defined only for SIP devices.
UCHAR Addr32 : 1; // defined only for SIP devices.
UCHAR AckReqQ: 1; // defined only for SIP devices.
UCHAR MediumChanger : 1;
UCHAR MultiPort : 1;
UCHAR ReservedBit2 : 1;
UCHAR EnclosureServices : 1;
UCHAR ReservedBit3 : 1;
UCHAR SoftReset : 1;
UCHAR CommandQueue : 1;
UCHAR TransferDisable : 1; // defined only for SIP devices.
UCHAR LinkedCommands : 1;
UCHAR Synchronous : 1; // defined only for SIP devices.
UCHAR Wide16Bit : 1; // defined only for SIP devices.
UCHAR Wide32Bit : 1; // defined only for SIP devices.
UCHAR RelativeAddressing : 1;
UCHAR VendorId[8];
UCHAR ProductId[16];
UCHAR ProductRevisionLevel[4];
UCHAR VendorSpecific[20];
UCHAR Reserved3[40];
} INQUIRYDATA, *PINQUIRYDATA;
//
// Inquiry defines. Used to interpret data returned from target as result
// of inquiry command.
//
// DeviceType field
//
#define DIRECT_ACCESS_DEVICE 0x00 // disks
#define SEQUENTIAL_ACCESS_DEVICE 0x01 // tapes
#define PRINTER_DEVICE 0x02 // printers
#define PROCESSOR_DEVICE 0x03 // scanners, printers, etc
#define WRITE_ONCE_READ_MULTIPLE_DEVICE 0x04 // worms
#define READ_ONLY_DIRECT_ACCESS_DEVICE 0x05 // cdroms
#define SCANNER_DEVICE 0x06 // scanners
#define OPTICAL_DEVICE 0x07 // optical disks
#define MEDIUM_CHANGER 0x08 // jukebox
#define COMMUNICATION_DEVICE 0x09 // network
#define LOGICAL_UNIT_NOT_PRESENT_DEVICE 0x7F
#define DEVICE_QUALIFIER_ACTIVE 0x00
#define DEVICE_QUALIFIER_NOT_ACTIVE 0x01
#define DEVICE_QUALIFIER_NOT_SUPPORTED 0x03
//
// DeviceTypeQualifier field
//
#define DEVICE_CONNECTED 0x00
//
// Vital Product Data Pages
//
//
// Unit Serial Number Page (page code 0x80)
//
// Provides a product serial number for the target or the logical unit.
//
typedef struct _VPD_SERIAL_NUMBER_PAGE {
UCHAR DeviceType : 5;
UCHAR DeviceTypeQualifier : 3;
UCHAR PageCode;
UCHAR Reserved;
UCHAR PageLength;
UCHAR SerialNumber[0];
} VPD_SERIAL_NUMBER_PAGE, *PVPD_SERIAL_NUMBER_PAGE;
//
// Device Identification Page (page code 0x83)
// Provides the means to retrieve zero or more identification descriptors
// applying to the logical unit.
//
typedef enum _VPD_CODE_SET {
VpdCodeSetReserved = 0,
VpdCodeSetBinary = 1,
VpdCodeSetAscii = 2
} VPD_CODE_SET, *PVPD_CODE_SET;
typedef enum _VPD_IDENTIFIER_TYPE {
VpdIdentifierTypeVendorSpecific = 0,
VpdIdentifierTypeVendorId = 1,
VpdIdentifierTypeEUI64 = 2,
VpdIdentifierTypeFCPHName = 3
} VPD_IDENTIFIER_TYPE, *PVPD_IDENTIFIER_TYPE;
typedef struct _VPD_IDENTIFICATION_DESCRIPTOR {
UCHAR CodeSet : 4; // VPD_CODE_SET
UCHAR Reserved : 4;
UCHAR IdentifierType : 4; // VPD_IDENTIFIER_TYPE
UCHAR Reserved2 : 4;
UCHAR Reserved3;
UCHAR IdentifierLength;
UCHAR Identifier[0];
} VPD_IDENTIFICATION_DESCRIPTOR, *PVPD_IDENTIFICATION_DESCRIPTOR;
typedef struct _VPD_IDENTIFICATION_PAGE {
UCHAR DeviceType : 5;
UCHAR DeviceTypeQualifier : 3;
UCHAR PageCode;
UCHAR Reserved;
UCHAR PageLength;
//
// The following field is actually a variable length array of identification
// descriptors. Unfortunately there's no C notation for an array of
// variable length structures so we're forced to just pretend.
//
// VPD_IDENTIFICATION_DESCRIPTOR Descriptors[0];
UCHAR Descriptors[0];
} VPD_IDENTIFICATION_PAGE, *PVPD_IDENTIFICATION_PAGE;
//
// Supported Vital Product Data Pages Page (page code 0x00)
// Contains a list of the vital product data page cods supported by the target
// or logical unit.
//
typedef struct _VPD_SUPPORTED_PAGES_PAGE {
UCHAR DeviceType : 5;
UCHAR DeviceTypeQualifier : 3;
UCHAR PageCode;
UCHAR Reserved;
UCHAR PageLength;
UCHAR SupportedPageList[0];
} VPD_SUPPORTED_PAGES_PAGE, *PVPD_SUPPORTED_PAGES_PAGE;
#define VPD_MAX_BUFFER_SIZE 0xff
#define VPD_SUPPORTED_PAGES 0x00
#define VPD_SERIAL_NUMBER 0x80
#define VPD_DEVICE_IDENTIFIERS 0x83
//
// Persistent Reservation Definitions.
//
//
// PERSISTENT_RESERVE_* definitions
//
#define RESERVATION_ACTION_READ_KEYS 0x00
#define RESERVATION_ACTION_READ_RESERVATIONS 0x01
#define RESERVATION_ACTION_REGISTER 0x00
#define RESERVATION_ACTION_RESERVE 0x01
#define RESERVATION_ACTION_RELEASE 0x02
#define RESERVATION_ACTION_CLEAR 0x03
#define RESERVATION_ACTION_PREEMPT 0x04
#define RESERVATION_ACTION_PREEMPT_ABORT 0x05
#define RESERVATION_ACTION_REGISTER_IGNORE_EXISTING 0x06
#define RESERVATION_SCOPE_LU 0x00
#define RESERVATION_SCOPE_ELEMENT 0x02
#define RESERVATION_TYPE_WRITE_EXCLUSIVE 0x01
#define RESERVATION_TYPE_EXCLUSIVE 0x03
#define RESERVATION_TYPE_WRITE_EXCLUSIVE_REGISTRANTS 0x05
#define RESERVATION_TYPE_EXCLUSIVE_REGISTRANTS 0x06
//
// Structures for reserve in command.
//
typedef struct {
UCHAR Generation[4];
UCHAR AdditionalLength[4];
UCHAR ReservationKeyList[0][8];
} PRI_REGISTRATION_LIST, *PPRI_REGISTRATION_LIST;
typedef struct {
UCHAR ReservationKey[8];
UCHAR ScopeSpecificAddress[4];
UCHAR Reserved;
UCHAR Type : 4;
UCHAR Scope : 4;
UCHAR Obsolete[2];
} PRI_RESERVATION_DESCRIPTOR, *PPRI_RESERVATION_DESCRIPTOR;
typedef struct {
UCHAR Generation[4];
UCHAR AdditionalLength[4];
PRI_RESERVATION_DESCRIPTOR Reservations[0];
} PRI_RESERVATION_LIST, *PPRI_RESERVATION_LIST;
//
// Structures for reserve out command.
//
typedef struct {
UCHAR ReservationKey[8];
UCHAR ServiceActionReservationKey[8];
UCHAR ScopeSpecificAddress[4];
UCHAR ActivatePersistThroughPowerLoss : 1;
UCHAR Reserved1 : 7;
UCHAR Reserved2;
UCHAR Obsolete[2];
} PRO_PARAMETER_LIST, *PPRO_PARAMETER_LIST;
//
// Sense Data Format
//
typedef struct _SENSE_DATA {
UCHAR ErrorCode:7;
UCHAR Valid:1;
UCHAR SegmentNumber;
UCHAR SenseKey:4;
UCHAR Reserved:1;
UCHAR IncorrectLength:1;
UCHAR EndOfMedia:1;
UCHAR FileMark:1;
UCHAR Information[4];
UCHAR AdditionalSenseLength;
UCHAR CommandSpecificInformation[4];
UCHAR AdditionalSenseCode;
UCHAR AdditionalSenseCodeQualifier;
UCHAR FieldReplaceableUnitCode;
UCHAR SenseKeySpecific[3];
} SENSE_DATA, *PSENSE_DATA;
//
// Default request sense buffer size
//
#define SENSE_BUFFER_SIZE 18
//
// Maximum request sense buffer size
//
#define MAX_SENSE_BUFFER_SIZE 255
//
// Maximum number of additional sense bytes.
//
#define MAX_ADDITIONAL_SENSE_BYTES (MAX_SENSE_BUFFER_SIZE - SENSE_BUFFER_SIZE)
//
// Sense codes
//
#define SCSI_SENSE_NO_SENSE 0x00
#define SCSI_SENSE_RECOVERED_ERROR 0x01
#define SCSI_SENSE_NOT_READY 0x02
#define SCSI_SENSE_MEDIUM_ERROR 0x03
#define SCSI_SENSE_HARDWARE_ERROR 0x04
#define SCSI_SENSE_ILLEGAL_REQUEST 0x05
#define SCSI_SENSE_UNIT_ATTENTION 0x06
#define SCSI_SENSE_DATA_PROTECT 0x07
#define SCSI_SENSE_BLANK_CHECK 0x08
#define SCSI_SENSE_UNIQUE 0x09
#define SCSI_SENSE_COPY_ABORTED 0x0A
#define SCSI_SENSE_ABORTED_COMMAND 0x0B
#define SCSI_SENSE_EQUAL 0x0C
#define SCSI_SENSE_VOL_OVERFLOW 0x0D
#define SCSI_SENSE_MISCOMPARE 0x0E
#define SCSI_SENSE_RESERVED 0x0F
//
// Additional tape bit
//
#define SCSI_ILLEGAL_LENGTH 0x20
#define SCSI_EOM 0x40
#define SCSI_FILE_MARK 0x80
//
// Additional Sense codes
//
#define SCSI_ADSENSE_NO_SENSE 0x00
#define SCSI_ADSENSE_LUN_NOT_READY 0x04
#define SCSI_ADSENSE_TRACK_ERROR 0x14
#define SCSI_ADSENSE_SEEK_ERROR 0x15
#define SCSI_ADSENSE_REC_DATA_NOECC 0x17
#define SCSI_ADSENSE_REC_DATA_ECC 0x18
#define SCSI_ADSENSE_ILLEGAL_COMMAND 0x20
#define SCSI_ADSENSE_ILLEGAL_BLOCK 0x21
#define SCSI_ADSENSE_INVALID_CDB 0x24
#define SCSI_ADSENSE_INVALID_LUN 0x25
#define SCSI_ADSENSE_WRITE_PROTECT 0x27
#define SCSI_ADWRITE_PROTECT 0x27 // Legacy define
#define SCSI_ADSENSE_MEDIUM_CHANGED 0x28
#define SCSI_ADSENSE_BUS_RESET 0x29
#define SCSI_ADSENSE_INVALID_MEDIA 0x30
#define SCSI_ADSENSE_NO_MEDIA_IN_DEVICE 0x3a
#define SCSI_ADSENSE_POSITION_ERROR 0x3b
#define SCSI_ADSENSE_OPERATOR_REQUEST 0x5a // see below
// the second is for legacy apps.
#define SCSI_ADSENSE_FAILURE_PREDICTION_THRESHOLD_EXCEEDED 0x5d
#define SCSI_FAILURE_PREDICTION_THRESHOLD_EXCEEDED SCSI_ADSENSE_FAILURE_PREDICTION_THRESHOLD_EXCEEDED
#define SCSI_ADSENSE_COPY_PROTECTION_FAILURE 0x6f
#define SCSI_ADSENSE_VENDOR_UNIQUE 0x80
#define SCSI_ADSENSE_MUSIC_AREA 0xA0
#define SCSI_ADSENSE_DATA_AREA 0xA1
#define SCSI_ADSENSE_VOLUME_OVERFLOW 0xA7
//
// SCSI_ADSENSE_LUN_NOT_READY (0x04) qualifiers
//
#define SCSI_SENSEQ_CAUSE_NOT_REPORTABLE 0x00
#define SCSI_SENSEQ_BECOMING_READY 0x01
#define SCSI_SENSEQ_INIT_COMMAND_REQUIRED 0x02
#define SCSI_SENSEQ_MANUAL_INTERVENTION_REQUIRED 0x03
#define SCSI_SENSEQ_FORMAT_IN_PROGRESS 0x04
#define SCSI_SENSEQ_REBUILD_IN_PROGRESS 0x05
#define SCSI_SENSEQ_RECALCULATION_IN_PROGRESS 0x06
#define SCSI_SENSEQ_OPERATION_IN_PROGRESS 0x07
#define SCSI_SENSEQ_LONG_WRITE_IN_PROGRESS 0x08
//
// SCSI_ADSENSE_NO_SENSE (0x00) qualifiers
//
#define SCSI_SENSEQ_FILEMARK_DETECTED 0x01
#define SCSI_SENSEQ_END_OF_MEDIA_DETECTED 0x02
#define SCSI_SENSEQ_SETMARK_DETECTED 0x03
#define SCSI_SENSEQ_BEGINNING_OF_MEDIA_DETECTED 0x04
//
// SCSI_ADSENSE_ILLEGAL_BLOCK (0x21) qualifiers
//
#define SCSI_SENSEQ_ILLEGAL_ELEMENT_ADDR 0x01
//
// SCSI_ADSENSE_POSITION_ERROR (0x3b) qualifiers
//
#define SCSI_SENSEQ_DESTINATION_FULL 0x0d
#define SCSI_SENSEQ_SOURCE_EMPTY 0x0e
//
// SCSI_ADSENSE_INVALID_MEDIA (0x30) qualifiers
//
#define SCSI_SENSEQ_INCOMPATIBLE_MEDIA_INSTALLED 0x00
#define SCSI_SENSEQ_UNKNOWN_FORMAT 0x01
#define SCSI_SENSEQ_INCOMPATIBLE_FORMAT 0x02
#define SCSI_SENSEQ_CLEANING_CARTRIDGE_INSTALLED 0x03
//
// SCSI_ADSENSE_OPERATOR_REQUEST (0x5a) qualifiers
//
#define SCSI_SENSEQ_STATE_CHANGE_INPUT 0x00 // generic request
#define SCSI_SENSEQ_MEDIUM_REMOVAL 0x01
#define SCSI_SENSEQ_WRITE_PROTECT_ENABLE 0x02
#define SCSI_SENSEQ_WRITE_PROTECT_DISABLE 0x03
//
// SCSI_ADSENSE_COPY_PROTECTION_FAILURE (0x6f) qualifiers
//
#define SCSI_SENSEQ_AUTHENTICATION_FAILURE 0x00
#define SCSI_SENSEQ_KEY_NOT_PRESENT 0x01
#define SCSI_SENSEQ_KEY_NOT_ESTABLISHED 0x02
#define SCSI_SENSEQ_READ_OF_SCRAMBLED_SECTOR_WITHOUT_AUTHENTICATION 0x03
#define SCSI_SENSEQ_MEDIA_CODE_MISMATCHED_TO_LOGICAL_UNIT 0x04
#define SCSI_SENSEQ_LOGICAL_UNIT_RESET_COUNT_ERROR 0x05
// end_ntminitape
//
// SCSI IO Device Control Codes
//
#define FILE_DEVICE_SCSI 0x0000001b
#define IOCTL_SCSI_EXECUTE_IN ((FILE_DEVICE_SCSI << 16) + 0x0011)
#define IOCTL_SCSI_EXECUTE_OUT ((FILE_DEVICE_SCSI << 16) + 0x0012)
#define IOCTL_SCSI_EXECUTE_NONE ((FILE_DEVICE_SCSI << 16) + 0x0013)
//
// SMART support in atapi
//
#define IOCTL_SCSI_MINIPORT_SMART_VERSION ((FILE_DEVICE_SCSI << 16) + 0x0500)
#define IOCTL_SCSI_MINIPORT_IDENTIFY ((FILE_DEVICE_SCSI << 16) + 0x0501)
#define IOCTL_SCSI_MINIPORT_READ_SMART_ATTRIBS ((FILE_DEVICE_SCSI << 16) + 0x0502)
#define IOCTL_SCSI_MINIPORT_READ_SMART_THRESHOLDS ((FILE_DEVICE_SCSI << 16) + 0x0503)
#define IOCTL_SCSI_MINIPORT_ENABLE_SMART ((FILE_DEVICE_SCSI << 16) + 0x0504)
#define IOCTL_SCSI_MINIPORT_DISABLE_SMART ((FILE_DEVICE_SCSI << 16) + 0x0505)
#define IOCTL_SCSI_MINIPORT_RETURN_STATUS ((FILE_DEVICE_SCSI << 16) + 0x0506)
#define IOCTL_SCSI_MINIPORT_ENABLE_DISABLE_AUTOSAVE ((FILE_DEVICE_SCSI << 16) + 0x0507)
#define IOCTL_SCSI_MINIPORT_SAVE_ATTRIBUTE_VALUES ((FILE_DEVICE_SCSI << 16) + 0x0508)
#define IOCTL_SCSI_MINIPORT_EXECUTE_OFFLINE_DIAGS ((FILE_DEVICE_SCSI << 16) + 0x0509)
#define IOCTL_SCSI_MINIPORT_ENABLE_DISABLE_AUTO_OFFLINE ((FILE_DEVICE_SCSI << 16) + 0x050a)
#define IOCTL_SCSI_MINIPORT_READ_SMART_LOG ((FILE_DEVICE_SCSI << 16) + 0x050b)
#define IOCTL_SCSI_MINIPORT_WRITE_SMART_LOG ((FILE_DEVICE_SCSI << 16) + 0x050c)
//
// CLUSTER support
// deliberately skipped some values to allow for expansion above.
//
#define IOCTL_SCSI_MINIPORT_NOT_QUORUM_CAPABLE ((FILE_DEVICE_SCSI << 16) + 0x0520)
#define IOCTL_SCSI_MINIPORT_NOT_CLUSTER_CAPABLE ((FILE_DEVICE_SCSI << 16) + 0x0521)
//
// Read Capacity Data - returned in Big Endian format
//
typedef struct _READ_CAPACITY_DATA {
ULONG LogicalBlockAddress;
ULONG BytesPerBlock;
} READ_CAPACITY_DATA, *PREAD_CAPACITY_DATA;
//
// Read Block Limits Data - returned in Big Endian format
// This structure returns the maximum and minimum block
// size for a TAPE device.
//
typedef struct _READ_BLOCK_LIMITS {
UCHAR Reserved;
UCHAR BlockMaximumSize[3];
UCHAR BlockMinimumSize[2];
} READ_BLOCK_LIMITS_DATA, *PREAD_BLOCK_LIMITS_DATA;
//
// Mode data structures.
//
//
// Define Mode parameter header.
//
typedef struct _MODE_PARAMETER_HEADER {
UCHAR ModeDataLength;
UCHAR MediumType;
UCHAR DeviceSpecificParameter;
UCHAR BlockDescriptorLength;
}MODE_PARAMETER_HEADER, *PMODE_PARAMETER_HEADER;
typedef struct _MODE_PARAMETER_HEADER10 {
UCHAR ModeDataLength[2];
UCHAR MediumType;
UCHAR DeviceSpecificParameter;
UCHAR Reserved[2];
UCHAR BlockDescriptorLength[2];
}MODE_PARAMETER_HEADER10, *PMODE_PARAMETER_HEADER10;
#define MODE_FD_SINGLE_SIDE 0x01
#define MODE_FD_DOUBLE_SIDE 0x02
#define MODE_FD_MAXIMUM_TYPE 0x1E
#define MODE_DSP_FUA_SUPPORTED 0x10
#define MODE_DSP_WRITE_PROTECT 0x80
//
// Define the mode parameter block.
//
typedef struct _MODE_PARAMETER_BLOCK {
UCHAR DensityCode;
UCHAR NumberOfBlocks[3];
UCHAR Reserved;
UCHAR BlockLength[3];
}MODE_PARAMETER_BLOCK, *PMODE_PARAMETER_BLOCK;
//
// Define Disconnect-Reconnect page.
//
typedef struct _MODE_DISCONNECT_PAGE {
UCHAR PageCode : 6;
UCHAR Reserved : 1;
UCHAR PageSavable : 1;
UCHAR PageLength;
UCHAR BufferFullRatio;
UCHAR BufferEmptyRatio;
UCHAR BusInactivityLimit[2];
UCHAR BusDisconnectTime[2];
UCHAR BusConnectTime[2];
UCHAR MaximumBurstSize[2];
UCHAR DataTransferDisconnect : 2;
UCHAR Reserved2[3];
}MODE_DISCONNECT_PAGE, *PMODE_DISCONNECT_PAGE;
//
// Define mode caching page.
//
typedef struct _MODE_CACHING_PAGE {
UCHAR PageCode : 6;
UCHAR Reserved : 1;
UCHAR PageSavable : 1;
UCHAR PageLength;
UCHAR ReadDisableCache : 1;
UCHAR MultiplicationFactor : 1;
UCHAR WriteCacheEnable : 1;
UCHAR Reserved2 : 5;
UCHAR WriteRetensionPriority : 4;
UCHAR ReadRetensionPriority : 4;
UCHAR DisablePrefetchTransfer[2];
UCHAR MinimumPrefetch[2];
UCHAR MaximumPrefetch[2];
UCHAR MaximumPrefetchCeiling[2];
}MODE_CACHING_PAGE, *PMODE_CACHING_PAGE;
//
// Define write parameters cdrom page
//
typedef struct _MODE_CDROM_WRITE_PARAMETERS_PAGE {
UCHAR PageLength; // 0x32 ??
UCHAR WriteType : 4;
UCHAR TestWrite : 1;
UCHAR LinkSizeValid : 1;
UCHAR BufferUnderrunFreeEnabled : 1;
UCHAR Reserved2 : 1;
UCHAR TrackMode : 4;
UCHAR Copy : 1;
UCHAR FixedPacket : 1;
UCHAR MultiSession : 2;
UCHAR DataBlockType : 4;
UCHAR Reserved3 : 4;
UCHAR LinkSize;
UCHAR Reserved4;
UCHAR HostApplicationCode : 6;
UCHAR Reserved5 : 2;
UCHAR SessionFormat;
UCHAR Reserved6;
UCHAR PacketSize[4];
UCHAR AudioPauseLength[2];
UCHAR Reserved7 : 7;
UCHAR MediaCatalogNumberValid : 1;
UCHAR MediaCatalogNumber[13];
UCHAR MediaCatalogNumberZero;
UCHAR MediaCatalogNumberAFrame;
UCHAR Reserved8 : 7;
UCHAR ISRCValid : 1;
UCHAR ISRCCountry[2];
UCHAR ISRCOwner[3];
UCHAR ISRCRecordingYear[2];
UCHAR ISRCSerialNumber[5];
UCHAR ISRCZero;
UCHAR ISRCAFrame;
UCHAR ISRCReserved;
UCHAR SubHeaderData[4];
} MODE_CDROM_WRITE_PARAMETERS_PAGE, *PMODE_CDROM_WRITE_PARAMETERS_PAGE;
//
// Define mode flexible disk page.
//
typedef struct _MODE_FLEXIBLE_DISK_PAGE {
UCHAR PageCode : 6;
UCHAR Reserved : 1;
UCHAR PageSavable : 1;
UCHAR PageLength;
UCHAR TransferRate[2];
UCHAR NumberOfHeads;
UCHAR SectorsPerTrack;
UCHAR BytesPerSector[2];
UCHAR NumberOfCylinders[2];
UCHAR StartWritePrecom[2];
UCHAR StartReducedCurrent[2];
UCHAR StepRate[2];
UCHAR StepPluseWidth;
UCHAR HeadSettleDelay[2];
UCHAR MotorOnDelay;
UCHAR MotorOffDelay;
UCHAR Reserved2 : 5;
UCHAR MotorOnAsserted : 1;
UCHAR StartSectorNumber : 1;
UCHAR TrueReadySignal : 1;
UCHAR StepPlusePerCyclynder : 4;
UCHAR Reserved3 : 4;
UCHAR WriteCompenstation;
UCHAR HeadLoadDelay;
UCHAR HeadUnloadDelay;
UCHAR Pin2Usage : 4;
UCHAR Pin34Usage : 4;
UCHAR Pin1Usage : 4;
UCHAR Pin4Usage : 4;
UCHAR MediumRotationRate[2];
UCHAR Reserved4[2];
}MODE_FLEXIBLE_DISK_PAGE, *PMODE_FLEXIBLE_DISK_PAGE;
//
// Define mode format page.
//
typedef struct _MODE_FORMAT_PAGE {
UCHAR PageCode : 6;
UCHAR Reserved : 1;
UCHAR PageSavable : 1;
UCHAR PageLength;
UCHAR TracksPerZone[2];
UCHAR AlternateSectorsPerZone[2];
UCHAR AlternateTracksPerZone[2];
UCHAR AlternateTracksPerLogicalUnit[2];
UCHAR SectorsPerTrack[2];
UCHAR BytesPerPhysicalSector[2];
UCHAR Interleave[2];
UCHAR TrackSkewFactor[2];
UCHAR CylinderSkewFactor[2];
UCHAR Reserved2 : 4;
UCHAR SurfaceFirst : 1;
UCHAR RemovableMedia : 1;
UCHAR HardSectorFormating : 1;
UCHAR SoftSectorFormating : 1;
UCHAR Reserved3[3];
}MODE_FORMAT_PAGE, *PMODE_FORMAT_PAGE;
//
// Define rigid disk driver geometry page.
//
typedef struct _MODE_RIGID_GEOMETRY_PAGE {
UCHAR PageCode : 6;
UCHAR Reserved : 1;
UCHAR PageSavable : 1;
UCHAR PageLength;
UCHAR NumberOfCylinders[3];
UCHAR NumberOfHeads;
UCHAR StartWritePrecom[3];
UCHAR StartReducedCurrent[3];
UCHAR DriveStepRate[2];
UCHAR LandZoneCyclinder[3];
UCHAR RotationalPositionLock : 2;
UCHAR Reserved2 : 6;
UCHAR RotationOffset;
UCHAR Reserved3;
UCHAR RoataionRate[2];
UCHAR Reserved4[2];
}MODE_RIGID_GEOMETRY_PAGE, *PMODE_RIGID_GEOMETRY_PAGE;
//
// Define read write recovery page
//
typedef struct _MODE_READ_WRITE_RECOVERY_PAGE {
UCHAR PageCode : 6;
UCHAR Reserved1 : 1;
UCHAR PSBit : 1;
UCHAR PageLength;
UCHAR DCRBit : 1;
UCHAR DTEBit : 1;
UCHAR PERBit : 1;
UCHAR EERBit : 1;
UCHAR RCBit : 1;
UCHAR TBBit : 1;
UCHAR ARRE : 1;
UCHAR AWRE : 1;
UCHAR ReadRetryCount;
UCHAR Reserved4[4];
UCHAR WriteRetryCount;
UCHAR Reserved5[3];
} MODE_READ_WRITE_RECOVERY_PAGE, *PMODE_READ_WRITE_RECOVERY_PAGE;
//
// Define read recovery page - cdrom
//
typedef struct _MODE_READ_RECOVERY_PAGE {
UCHAR PageCode : 6;
UCHAR Reserved1 : 1;
UCHAR PSBit : 1;
UCHAR PageLength;
UCHAR DCRBit : 1;
UCHAR DTEBit : 1;
UCHAR PERBit : 1;
UCHAR Reserved2 : 1;
UCHAR RCBit : 1;
UCHAR TBBit : 1;
UCHAR Reserved3 : 2;
UCHAR ReadRetryCount;
UCHAR Reserved4[4];
} MODE_READ_RECOVERY_PAGE, *PMODE_READ_RECOVERY_PAGE;
//
// Define Informational Exception Control Page. Used for failure prediction
//
typedef struct _MODE_INFO_EXCEPTIONS
{
UCHAR PageCode : 6;
UCHAR Reserved1 : 1;
UCHAR PSBit : 1;
UCHAR PageLength;
union
{
UCHAR Flags;
struct
{
UCHAR LogErr : 1;
UCHAR Reserved2 : 1;
UCHAR Test : 1;
UCHAR Dexcpt : 1;
UCHAR Reserved3 : 3;
UCHAR Perf : 1;
};
};
UCHAR ReportMethod : 4;
UCHAR Reserved4 : 4;
UCHAR IntervalTimer[4];
UCHAR ReportCount[4];
} MODE_INFO_EXCEPTIONS, *PMODE_INFO_EXCEPTIONS;
//
// Begin C/DVD 0.9 definitions
//
//
// Power Condition Mode Page Format
//
typedef struct _POWER_CONDITION_PAGE {
UCHAR PageCode : 6; // 0x1A
UCHAR Reserved : 1;
UCHAR PSBit : 1;
UCHAR PageLength; // 0x0A
UCHAR Reserved2;
UCHAR Standby : 1;
UCHAR Idle : 1;
UCHAR Reserved3 : 6;
UCHAR IdleTimer[4];
UCHAR StandbyTimer[4];
} POWER_CONDITION_PAGE, *PPOWER_CONDITION_PAGE;
//
// CD-Audio Control Mode Page Format
//
typedef struct _CDDA_OUTPUT_PORT {
UCHAR ChannelSelection : 4;
UCHAR Reserved : 4;
UCHAR Volume;
} CDDA_OUTPUT_PORT, *PCDDA_OUTPUT_PORT;
typedef struct _CDAUDIO_CONTROL_PAGE {
UCHAR PageCode : 6; // 0x0E
UCHAR Reserved : 1;
UCHAR PSBit : 1;
UCHAR PageLength; // 0x0E
UCHAR Reserved2 : 1;
UCHAR StopOnTrackCrossing : 1; // Default 0
UCHAR Immediate : 1; // Always 1
UCHAR Reserved3 : 5;
UCHAR Reserved4[3];
UCHAR Obsolete[2];
CDDA_OUTPUT_PORT CDDAOutputPorts[4];
} CDAUDIO_CONTROL_PAGE, *PCDAUDIO_CONTROL_PAGE;
#define CDDA_CHANNEL_MUTED 0x0
#define CDDA_CHANNEL_ZERO 0x1
#define CDDA_CHANNEL_ONE 0x2
#define CDDA_CHANNEL_TWO 0x4
#define CDDA_CHANNEL_THREE 0x8
//
// C/DVD Feature Set Support & Version Page
//
typedef struct _CDVD_FEATURE_SET_PAGE {
UCHAR PageCode : 6; // 0x18
UCHAR Reserved : 1;
UCHAR PSBit : 1;
UCHAR PageLength; // 0x16
UCHAR CDAudio[2];
UCHAR EmbeddedChanger[2];
UCHAR PacketSMART[2];
UCHAR PersistantPrevent[2];
UCHAR EventStatusNotification[2];
UCHAR DigitalOutput[2];
UCHAR CDSequentialRecordable[2];
UCHAR DVDSequentialRecordable[2];
UCHAR RandomRecordable[2];
UCHAR KeyExchange[2];
UCHAR Reserved2[2];
} CDVD_FEATURE_SET_PAGE, *PCDVD_FEATURE_SET_PAGE;
//
// CDVD Inactivity Time-out Page Format
//
typedef struct _CDVD_INACTIVITY_TIMEOUT_PAGE {
UCHAR PageCode : 6; // 0x1D
UCHAR Reserved : 1;
UCHAR PSBit : 1;
UCHAR PageLength; // 0x08
UCHAR Reserved2[2];
UCHAR SWPP : 1;
UCHAR DISP : 1;
UCHAR Reserved3 : 6;
UCHAR Reserved4;
UCHAR GroupOneMinimumTimeout[2];
UCHAR GroupTwoMinimumTimeout[2];
} CDVD_INACTIVITY_TIMEOUT_PAGE, *PCDVD_INACTIVITY_TIMEOUT_PAGE;
//
// CDVD Capabilities & Mechanism Status Page
//
#define CDVD_LMT_CADDY 0
#define CDVD_LMT_TRAY 1
#define CDVD_LMT_POPUP 2
#define CDVD_LMT_RESERVED1 3
#define CDVD_LMT_CHANGER_INDIVIDUAL 4
#define CDVD_LMT_CHANGER_CARTRIDGE 5
#define CDVD_LMT_RESERVED2 6
#define CDVD_LMT_RESERVED3 7
typedef struct _CDVD_CAPABILITIES_PAGE {
UCHAR PageCode : 6; // 0x2A
UCHAR Reserved : 1;
UCHAR PSBit : 1; // offset 0
UCHAR PageLength; // 0x18 // offset 1
UCHAR CDRRead : 1;
UCHAR CDERead : 1;
UCHAR Method2 : 1;
UCHAR DVDROMRead : 1;
UCHAR DVDRRead : 1;
UCHAR DVDRAMRead : 1;
UCHAR Reserved2 : 2; // offset 2
UCHAR CDRWrite : 1;
UCHAR CDEWrite : 1;
UCHAR TestWrite : 1;
UCHAR Reserved3 : 1;
UCHAR DVDRWrite : 1;
UCHAR DVDRAMWrite : 1;
UCHAR Reserved4 : 2; // offset 3
UCHAR AudioPlay : 1;
UCHAR Composite : 1;
UCHAR DigitalPortOne : 1;
UCHAR DigitalPortTwo : 1;
UCHAR Mode2Form1 : 1;
UCHAR Mode2Form2 : 1;
UCHAR MultiSession : 1;
UCHAR Reserved5 : 1; // offset 4
UCHAR CDDA : 1;
UCHAR CDDAAccurate : 1;
UCHAR RWSupported : 1;
UCHAR RWDeinterleaved : 1;
UCHAR C2Pointers : 1;
UCHAR ISRC : 1;
UCHAR UPC : 1;
UCHAR ReadBarCodeCapable : 1; // offset 5
UCHAR Lock : 1;
UCHAR LockState : 1;
UCHAR PreventJumper : 1;
UCHAR Eject : 1;
UCHAR Reserved6 : 1;
UCHAR LoadingMechanismType : 3; // offset 6
UCHAR SeparateVolume : 1;
UCHAR SeperateChannelMute : 1;
UCHAR SupportsDiskPresent : 1;
UCHAR SWSlotSelection : 1;
UCHAR SideChangeCapable : 1;
UCHAR RWInLeadInReadable : 1;
UCHAR Reserved7 : 2; // offset 7
UCHAR ObsoleteReserved[2]; // offset 8
UCHAR NumberVolumeLevels[2]; // offset 10
UCHAR BufferSize[2]; // offset 12
UCHAR ObsoleteReserved2[2]; // offset 14
UCHAR ObsoleteReserved3; // offset 16
UCHAR Reserved8 : 1;
UCHAR BCK : 1;
UCHAR RCK : 1;
UCHAR LSBF : 1;
UCHAR Length : 2;
UCHAR Reserved9 : 2; // offset 17
UCHAR ObsoleteReserved4[2]; // offset 18
UCHAR ObsoleteReserved11[2]; // offset 20
//
// NOTE: This mode page is two bytes too small in the release
// version of the Windows2000 DDK. it also incorrectly
// put the CopyManagementRevision at offset 20 instead
// of offset 22, so fix that with a nameless union (for
// backwards-compatibility with those who "fixed" it on
// their own by looking at Reserved10[]).
//
union {
UCHAR CopyManagementRevision[2]; // offset 22
UCHAR Reserved10[2];
};
//UCHAR Reserved12[2]; // offset 24
} CDVD_CAPABILITIES_PAGE, *PCDVD_CAPABILITIES_PAGE;
typedef struct _LUN_LIST {
UCHAR LunListLength[4]; // sizeof LunSize * 8
UCHAR Reserved[4];
UCHAR Lun[0][8]; // 4 level of addressing. 2 bytes each.
} LUN_LIST, *PLUN_LIST;
#define LOADING_MECHANISM_CADDY 0x00
#define LOADING_MECHANISM_TRAY 0x01
#define LOADING_MECHANISM_POPUP 0x02
#define LOADING_MECHANISM_INDIVIDUAL_CHANGER 0x04
#define LOADING_MECHANISM_CARTRIDGE_CHANGER 0x05
//
// end C/DVD 0.9 mode page definitions
//
// Mode parameter list block descriptor -
// set the block length for reading/writing
//
//
#define MODE_BLOCK_DESC_LENGTH 8
#define MODE_HEADER_LENGTH 4
#define MODE_HEADER_LENGTH10 8
typedef struct _MODE_PARM_READ_WRITE {
MODE_PARAMETER_HEADER ParameterListHeader; // List Header Format
MODE_PARAMETER_BLOCK ParameterListBlock; // List Block Descriptor
} MODE_PARM_READ_WRITE_DATA, *PMODE_PARM_READ_WRITE_DATA;
//
// CDROM audio control (0x0E)
//
#define CDB_AUDIO_PAUSE 0
#define CDB_AUDIO_RESUME 1
#define CDB_DEVICE_START 0x11
#define CDB_DEVICE_STOP 0x10
#define CDB_EJECT_MEDIA 0x10
#define CDB_LOAD_MEDIA 0x01
#define CDB_SUBCHANNEL_HEADER 0x00
#define CDB_SUBCHANNEL_BLOCK 0x01
#define CDROM_AUDIO_CONTROL_PAGE 0x0E
#define MODE_SELECT_IMMEDIATE 0x04
#define MODE_SELECT_PFBIT 0x10
#define CDB_USE_MSF 0x01
typedef struct _PORT_OUTPUT {
UCHAR ChannelSelection;
UCHAR Volume;
} PORT_OUTPUT, *PPORT_OUTPUT;
typedef struct _AUDIO_OUTPUT {
UCHAR CodePage;
UCHAR ParameterLength;
UCHAR Immediate;
UCHAR Reserved[2];
UCHAR LbaFormat;
UCHAR LogicalBlocksPerSecond[2];
PORT_OUTPUT PortOutput[4];
} AUDIO_OUTPUT, *PAUDIO_OUTPUT;
//
// Multisession CDROM
//
#define GET_LAST_SESSION 0x01
#define GET_SESSION_DATA 0x02;
//
// Atapi 2.5 changer
//
typedef struct _MECHANICAL_STATUS_INFORMATION_HEADER {
UCHAR CurrentSlot : 5;
UCHAR ChangerState : 2;
UCHAR Fault : 1;
UCHAR Reserved : 5;
UCHAR MechanismState : 3;
UCHAR CurrentLogicalBlockAddress[3];
UCHAR NumberAvailableSlots;
UCHAR SlotTableLength[2];
} MECHANICAL_STATUS_INFORMATION_HEADER, *PMECHANICAL_STATUS_INFORMATION_HEADER;
typedef struct _SLOT_TABLE_INFORMATION {
UCHAR DiscChanged : 1;
UCHAR Reserved : 6;
UCHAR DiscPresent : 1;
UCHAR Reserved2[3];
} SLOT_TABLE_INFORMATION, *PSLOT_TABLE_INFORMATION;
typedef struct _MECHANICAL_STATUS {
MECHANICAL_STATUS_INFORMATION_HEADER MechanicalStatusHeader;
SLOT_TABLE_INFORMATION SlotTableInfo[1];
} MECHANICAL_STATUS, *PMECHANICAL_STATUS;
//
// This structure is used to convert little endian
// ULONGs to SCSI CDB big endians values.
//
typedef union _EIGHT_BYTE {
struct {
UCHAR Byte0;
UCHAR Byte1;
UCHAR Byte2;
UCHAR Byte3;
UCHAR Byte4;
UCHAR Byte5;
UCHAR Byte6;
UCHAR Byte7;
};
ULONGLONG AsULongLong;
} EIGHT_BYTE, *PEIGHT_BYTE;
typedef union _FOUR_BYTE {
struct {
UCHAR Byte0;
UCHAR Byte1;
UCHAR Byte2;
UCHAR Byte3;
};
ULONG AsULong;
} FOUR_BYTE, *PFOUR_BYTE;
typedef union _TWO_BYTE {
struct {
UCHAR Byte0;
UCHAR Byte1;
};
USHORT AsUShort;
} TWO_BYTE, *PTWO_BYTE;
//
// Byte reversing macro for converting
// between big- and little-endian formats
//
#define REVERSE_BYTES_QUAD(Destination, Source) { \
PEIGHT_BYTE d = (PEIGHT_BYTE)(Destination); \
PEIGHT_BYTE s = (PEIGHT_BYTE)(Source); \
d->Byte7 = s->Byte0; \
d->Byte6 = s->Byte1; \
d->Byte5 = s->Byte2; \
d->Byte4 = s->Byte3; \
d->Byte3 = s->Byte4; \
d->Byte2 = s->Byte5; \
d->Byte1 = s->Byte6; \
d->Byte0 = s->Byte7; \
}
#define REVERSE_BYTES(Destination, Source) { \
PFOUR_BYTE d = (PFOUR_BYTE)(Destination); \
PFOUR_BYTE s = (PFOUR_BYTE)(Source); \
d->Byte3 = s->Byte0; \
d->Byte2 = s->Byte1; \
d->Byte1 = s->Byte2; \
d->Byte0 = s->Byte3; \
}
#define REVERSE_BYTES_SHORT(Destination, Source) { \
PTWO_BYTE d = (PTWO_BYTE)(Destination); \
PTWO_BYTE s = (PTWO_BYTE)(Source); \
d->Byte1 = s->Byte0; \
d->Byte0 = s->Byte1; \
}
//
// Byte reversing macro for converting
// USHORTS from big to little endian in place
//
#define REVERSE_SHORT(Short) { \
UCHAR tmp; \
PTWO_BYTE w = (PTWO_BYTE)(Short); \
tmp = w->Byte0; \
w->Byte0 = w->Byte1; \
w->Byte1 = tmp; \
}
//
// Byte reversing macro for convering
// ULONGS between big & little endian in place
//
#define REVERSE_LONG(Long) { \
UCHAR tmp; \
PFOUR_BYTE l = (PFOUR_BYTE)(Long); \
tmp = l->Byte3; \
l->Byte3 = l->Byte0; \
l->Byte0 = tmp; \
tmp = l->Byte2; \
l->Byte2 = l->Byte1; \
l->Byte1 = tmp; \
}
//
// This macro has the effect of Bit = log2(Data)
//
#define WHICH_BIT(Data, Bit) { \
UCHAR tmp; \
for (tmp = 0; tmp < 32; tmp++) { \
if (((Data) >> tmp) == 1) { \
break; \
} \
} \
ASSERT(tmp != 32); \
(Bit) = tmp; \
}
//
// Include SCSIPORT definitions for backwards compatability.
//
#if defined (STOR_USE_SCSI_ALIASES)
#define ScsiPortInitialize StorPortInitialize
#define ScsiPortFreeDeviceBase StorPortFreeDeviceBase
#define ScsiPortGetBusData StorPortGetBusData
#define ScsiPortSetBusDataByOffset StorPortSetBusDataByOffset
#define ScsiPortGetDeviceBase StorPortGetDeviceBase
#define ScsiPortGetLogicalUnit StorPortGetLogicalUnit
#define ScsiPortGetSrb StorPortGetSrb
#define ScsiPortGetPhysicalAddress StorPortGetPhysicalAddress
#define ScsiPortGetVirtualAddress StorPortGetVirtualAddress
#define ScsiPortGetUncachedExtension StorPortGetUncachedExtension
#define ScsiPortFlushDma StorPortFlushDma
#define ScsiPortIoMapTransfer StorPortIoMapTransfer
#define ScsiPortNotification StorPortNotification
#define ScsiPortLogError StorPortLogError
#define ScsiPortCompleteRequest StorPortCompleteRequest
#define ScsiPortMoveMemory StorPortMoveMemory
#define ScsiPortReadPortUchar StorPortReadPortUchar
#define ScsiPortReadPortUshort StorPortReadPortUshort
#define ScsiPortReadPortUlong StorPortReadPortUlong
#define ScsiPortReadPortBufferUchar StorPortReadPortBufferUchar
#define ScsiPortReadPortBufferUshort StorPortReadPortBufferUshort
#define ScsiPortReadPortBufferUlong StorPortReadPortBufferUlong
#define ScsiPortReadRegisterUchar StorPortReadRegisterUchar
#define ScsiPortReadRegisterUshort StorPortReadRegisterUshort
#define ScsiPortReadRegisterUlong StorPortReadRegisterUlong
#define ScsiPortReadRegisterBufferUchar StorPortReadRegisterBufferUchar
#define ScsiPortReadRegisterBufferUshort StorPortReadRegisterBufferUshort
#define ScsiPortReadRegisterBufferUlong StorPortReadRegisterBufferUlong
#define ScsiPortStallExecution StorPortStallExecution
#define ScsiPortWritePortUchar StorPortWritePortUchar
#define ScsiPortWritePortUshort StorPortWritePortUshort
#define ScsiPortWritePortUlong StorPortWritePortUlong
#define ScsiPortWritePortBufferUchar StorPortWritePortBufferUchar
#define ScsiPortWritePortBufferUshort StorPortWritePortBufferUshort
#define ScsiPortWritePortBufferUlong StorPortWritePortBufferUlong
#define ScsiPortWriteRegisterUchar StorPortWriteRegisterUchar
#define ScsiPortWriteRegisterUshort StorPortWriteRegisterUshort
#define ScsiPortWriteRegisterUlong StorPortWriteRegisterUlong
#define ScsiPortWriteRegisterBufferUchar StorPortWriteRegisterBufferUchar
#define ScsiPortWriteRegisterBufferUshort StorPortWriteRegisterBufferUshort
#define ScsiPortWriteRegisterBufferUlong StorPortWriteRegisterBufferUlong
#define ScsiPortConvertUlongToPhysicalAddress StorPortConvertUlongToPhysicalAddress
#define ScsiPortConvertPhysicalAddressToUlong StorPortConvertPhysicalAddressToUlong
#define ScsiPortQuerySystemTime StorPortQuerySystemTime
#define ScsiPortValidateRange StorPortValidateRange
#define ScsiDebugPrint StorPortDebugPrint
typedef PHYSICAL_ADDRESS SCSI_PHYSICAL_ADDRESS, *PSCSI_PHYSICAL_ADDRESS;
#endif // STOR_USE_SCSI_ALIASES
#if _MSC_VER >= 1200
#pragma warning(pop) // un-sets any local warning changes
#else
#pragma warning(default:4200) // array[0] is not a warning for this file
#endif
#endif // !defined _NTSTORPORT_