mirror of
https://github.com/reactos/reactos.git
synced 2024-08-28 14:18:41 +00:00
974 lines
24 KiB
C
974 lines
24 KiB
C
/*
|
|
* scsi.h
|
|
*
|
|
* Interface between SCSI miniport drivers and the SCSI port driver.
|
|
*
|
|
* This file is part of the w32api package.
|
|
*
|
|
* Contributors:
|
|
* Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
|
|
*
|
|
* THIS SOFTWARE IS NOT COPYRIGHTED
|
|
*
|
|
* This source code is offered for use in the public domain. You may
|
|
* use, modify or distribute it freely.
|
|
*
|
|
* This code is distributed in the hope that it will be useful but
|
|
* WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
|
|
* DISCLAIMED. This includes but is not limited to warranties of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
*
|
|
*/
|
|
|
|
#ifndef _NTSRB_
|
|
#define _NTSRB_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#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_MAXIMUM_TARGETS 8
|
|
|
|
/* PORT_CONFIGURATION_INFORMATION.Dma64BitAddresses constants */
|
|
#define SCSI_DMA64_MINIPORT_SUPPORTED 0x01
|
|
#define SCSI_DMA64_SYSTEM_SUPPORTED 0x80
|
|
#if (NTDDI_VERSION > NTDDI_WS03SP1)
|
|
#define SCSI_DMA64_MINIPORT_FULL64BIT_SUPPORTED 0x02
|
|
#endif
|
|
|
|
#define SP_UNINITIALIZED_VALUE ((ULONG) ~0)
|
|
#define SP_UNTAGGED ((UCHAR) ~0)
|
|
|
|
/* Asynchronous events */
|
|
#define SRBEV_BUS_RESET 0x0001
|
|
#define SRBEV_SCSI_ASYNC_NOTIFICATION 0x0002
|
|
|
|
#define MAXIMUM_CDB_SIZE 12
|
|
|
|
#if DBG
|
|
#define DebugPrint(x) ScsiDebugPrint x
|
|
#else
|
|
#define DebugPrint(x)
|
|
#endif
|
|
|
|
#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))))
|
|
|
|
/* SCSI_REQUEST_BLOCK.Function constants */
|
|
#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
|
|
#define SRB_FUNCTION_RESET_LOGICAL_UNIT 0x20
|
|
#define SRB_FUNCTION_SET_LINK_TIMEOUT 0x21
|
|
#define SRB_FUNCTION_LINK_TIMEOUT_OCCURRED 0x22
|
|
#define SRB_FUNCTION_LINK_TIMEOUT_COMPLETE 0x23
|
|
#define SRB_FUNCTION_POWER 0x24
|
|
#define SRB_FUNCTION_PNP 0x25
|
|
#define SRB_FUNCTION_DUMP_POINTERS 0x26
|
|
|
|
/* SCSI_REQUEST_BLOCK.SrbStatus constants */
|
|
#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
|
|
#define SRB_STATUS_LINK_DOWN 0x25
|
|
#define SRB_STATUS_INTERNAL_ERROR 0x30
|
|
|
|
#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))
|
|
|
|
/* SCSI_REQUEST_BLOCK.SrbFlags constants */
|
|
#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
|
|
#define SCSI_PORT_SIGNATURE 0x54524f50
|
|
#endif
|
|
|
|
#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 0x0001
|
|
#define SRB_POWER_FLAGS_ADAPTER_REQUEST 0x0001
|
|
#define SRB_PNP_FLAGS_ADAPTER_REQUEST 0x0001
|
|
|
|
#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
|
|
|
|
#define SP_VER_TRACE_SUPPORT 0x0010
|
|
|
|
#define SP_RETURN_NOT_FOUND 0
|
|
#define SP_RETURN_FOUND 1
|
|
#define SP_RETURN_ERROR 2
|
|
#define SP_RETURN_BAD_CONFIG 3
|
|
|
|
typedef PHYSICAL_ADDRESS SCSI_PHYSICAL_ADDRESS, *PSCSI_PHYSICAL_ADDRESS;
|
|
|
|
typedef struct _ACCESS_RANGE {
|
|
SCSI_PHYSICAL_ADDRESS RangeStart;
|
|
ULONG RangeLength;
|
|
BOOLEAN RangeInMemory;
|
|
} ACCESS_RANGE, *PACCESS_RANGE;
|
|
|
|
typedef struct _PORT_CONFIGURATION_INFORMATION {
|
|
ULONG Length;
|
|
ULONG SystemIoBusNumber;
|
|
INTERFACE_TYPE AdapterInterfaceType;
|
|
ULONG BusInterruptLevel;
|
|
ULONG BusInterruptVector;
|
|
KINTERRUPT_MODE InterruptMode;
|
|
ULONG MaximumTransferLength;
|
|
ULONG NumberOfPhysicalBreaks;
|
|
ULONG DmaChannel;
|
|
ULONG DmaPort;
|
|
DMA_WIDTH DmaWidth;
|
|
DMA_SPEED DmaSpeed;
|
|
ULONG AlignmentMask;
|
|
ULONG NumberOfAccessRanges;
|
|
ACCESS_RANGE (*AccessRanges)[];
|
|
PVOID Reserved;
|
|
UCHAR NumberOfBuses;
|
|
UCHAR InitiatorBusId[8];
|
|
BOOLEAN ScatterGather;
|
|
BOOLEAN Master;
|
|
BOOLEAN CachesData;
|
|
BOOLEAN AdapterScansDown;
|
|
BOOLEAN AtdiskPrimaryClaimed;
|
|
BOOLEAN AtdiskSecondaryClaimed;
|
|
BOOLEAN Dma32BitAddresses;
|
|
BOOLEAN DemandMode;
|
|
BOOLEAN MapBuffers;
|
|
BOOLEAN NeedPhysicalAddresses;
|
|
BOOLEAN TaggedQueuing;
|
|
BOOLEAN AutoRequestSense;
|
|
BOOLEAN MultipleRequestPerLu;
|
|
BOOLEAN ReceiveEvent;
|
|
BOOLEAN RealModeInitialized;
|
|
BOOLEAN BufferAccessScsiPortControlled;
|
|
UCHAR MaximumNumberOfTargets;
|
|
UCHAR ReservedUchars[2];
|
|
ULONG SlotNumber;
|
|
ULONG BusInterruptLevel2;
|
|
ULONG BusInterruptVector2;
|
|
KINTERRUPT_MODE InterruptMode2;
|
|
ULONG DmaChannel2;
|
|
ULONG DmaPort2;
|
|
DMA_WIDTH DmaWidth2;
|
|
DMA_SPEED DmaSpeed2;
|
|
ULONG DeviceExtensionSize;
|
|
ULONG SpecificLuExtensionSize;
|
|
ULONG SrbExtensionSize;
|
|
UCHAR Dma64BitAddresses;
|
|
BOOLEAN ResetTargetSupported;
|
|
UCHAR MaximumNumberOfLogicalUnits;
|
|
BOOLEAN WmiDataProvider;
|
|
} PORT_CONFIGURATION_INFORMATION, *PPORT_CONFIGURATION_INFORMATION;
|
|
|
|
#define CONFIG_INFO_VERSION_2 sizeof(PORT_CONFIGURATION_INFORMATION)
|
|
|
|
#ifdef __GNUC__
|
|
__extension__ /* enums limited to range of integer */
|
|
#endif
|
|
typedef enum _SCSI_ADAPTER_CONTROL_TYPE {
|
|
ScsiQuerySupportedControlTypes = 0,
|
|
ScsiStopAdapter,
|
|
ScsiRestartAdapter,
|
|
ScsiSetBootConfig,
|
|
ScsiSetRunningConfig,
|
|
ScsiAdapterControlMax,
|
|
MakeAdapterControlTypeSizeOfUlong = 0xffffffff
|
|
} SCSI_ADAPTER_CONTROL_TYPE, *PSCSI_ADAPTER_CONTROL_TYPE;
|
|
|
|
typedef enum _SCSI_ADAPTER_CONTROL_STATUS {
|
|
ScsiAdapterControlSuccess = 0,
|
|
ScsiAdapterControlUnsuccessful
|
|
} SCSI_ADAPTER_CONTROL_STATUS, *PSCSI_ADAPTER_CONTROL_STATUS;
|
|
|
|
typedef struct _SCSI_SUPPORTED_CONTROL_TYPE_LIST {
|
|
ULONG MaxControlType;
|
|
BOOLEAN SupportedTypeList[0];
|
|
} SCSI_SUPPORTED_CONTROL_TYPE_LIST, *PSCSI_SUPPORTED_CONTROL_TYPE_LIST;
|
|
|
|
typedef struct _SCSI_REQUEST_BLOCK {
|
|
USHORT Length;
|
|
UCHAR Function;
|
|
UCHAR SrbStatus;
|
|
UCHAR ScsiStatus;
|
|
UCHAR PathId;
|
|
UCHAR TargetId;
|
|
UCHAR Lun;
|
|
UCHAR QueueTag;
|
|
UCHAR QueueAction;
|
|
UCHAR CdbLength;
|
|
UCHAR SenseInfoBufferLength;
|
|
ULONG SrbFlags;
|
|
ULONG DataTransferLength;
|
|
ULONG TimeOutValue;
|
|
_Field_size_bytes_(DataTransferLength) PVOID DataBuffer;
|
|
PVOID SenseInfoBuffer;
|
|
struct _SCSI_REQUEST_BLOCK *NextSrb;
|
|
PVOID OriginalRequest;
|
|
PVOID SrbExtension;
|
|
_ANONYMOUS_UNION union {
|
|
ULONG InternalStatus;
|
|
ULONG QueueSortKey;
|
|
ULONG LinkTimeoutValue;
|
|
} DUMMYUNIONNAME;
|
|
#if defined(_WIN64)
|
|
ULONG Reserved;
|
|
#endif
|
|
UCHAR Cdb[16];
|
|
} SCSI_REQUEST_BLOCK, *PSCSI_REQUEST_BLOCK;
|
|
|
|
#define SCSI_REQUEST_BLOCK_SIZE sizeof(SCSI_REQUEST_BLOCK)
|
|
|
|
typedef struct _SCSI_WMI_REQUEST_BLOCK {
|
|
USHORT Length;
|
|
UCHAR Function;
|
|
UCHAR SrbStatus;
|
|
UCHAR WMISubFunction;
|
|
UCHAR PathId;
|
|
UCHAR TargetId;
|
|
UCHAR Lun;
|
|
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;
|
|
#if (NTDDI_VERSION >= NTDDI_WS03SP1) && defined(_WIN64)
|
|
ULONG Reserved6;
|
|
#endif
|
|
UCHAR Reserved5[16];
|
|
} SCSI_WMI_REQUEST_BLOCK, *PSCSI_WMI_REQUEST_BLOCK;
|
|
|
|
typedef enum _STOR_DEVICE_POWER_STATE {
|
|
StorPowerDeviceUnspecified = 0,
|
|
StorPowerDeviceD0,
|
|
StorPowerDeviceD1,
|
|
StorPowerDeviceD2,
|
|
StorPowerDeviceD3,
|
|
StorPowerDeviceMaximum
|
|
} STOR_DEVICE_POWER_STATE, *PSTOR_DEVICE_POWER_STATE;
|
|
|
|
typedef enum _STOR_POWER_ACTION {
|
|
StorPowerActionNone = 0,
|
|
StorPowerActionReserved,
|
|
StorPowerActionSleep,
|
|
StorPowerActionHibernate,
|
|
StorPowerActionShutdown,
|
|
StorPowerActionShutdownReset,
|
|
StorPowerActionShutdownOff,
|
|
StorPowerActionWarmEject
|
|
} STOR_POWER_ACTION, *PSTOR_POWER_ACTION;
|
|
|
|
typedef struct _SCSI_POWER_REQUEST_BLOCK {
|
|
USHORT Length;
|
|
UCHAR Function;
|
|
UCHAR SrbStatus;
|
|
UCHAR SrbPowerFlags;
|
|
UCHAR PathId;
|
|
UCHAR TargetId;
|
|
UCHAR Lun;
|
|
STOR_DEVICE_POWER_STATE DevicePowerState;
|
|
ULONG SrbFlags;
|
|
ULONG DataTransferLength;
|
|
ULONG TimeOutValue;
|
|
PVOID DataBuffer;
|
|
PVOID SenseInfoBuffer;
|
|
struct _SCSI_REQUEST_BLOCK *NextSrb;
|
|
PVOID OriginalRequest;
|
|
PVOID SrbExtension;
|
|
STOR_POWER_ACTION PowerAction;
|
|
#if defined(_WIN64)
|
|
ULONG Reserved;
|
|
#endif
|
|
UCHAR Reserved5[16];
|
|
} SCSI_POWER_REQUEST_BLOCK, *PSCSI_POWER_REQUEST_BLOCK;
|
|
|
|
typedef enum _STOR_PNP_ACTION {
|
|
StorStartDevice = 0x0,
|
|
StorRemoveDevice = 0x2,
|
|
StorStopDevice = 0x4,
|
|
StorQueryCapabilities = 0x9,
|
|
StorQueryResourceRequirements = 0xB,
|
|
StorFilterResourceRequirements = 0xD,
|
|
StorSurpriseRemoval = 0x17
|
|
} STOR_PNP_ACTION, *PSTOR_PNP_ACTION;
|
|
|
|
typedef struct _STOR_DEVICE_CAPABILITIES {
|
|
USHORT Version;
|
|
ULONG DeviceD1:1;
|
|
ULONG DeviceD2:1;
|
|
ULONG LockSupported:1;
|
|
ULONG EjectSupported:1;
|
|
ULONG Removable:1;
|
|
ULONG DockDevice:1;
|
|
ULONG UniqueID:1;
|
|
ULONG SilentInstall:1;
|
|
ULONG SurpriseRemovalOK:1;
|
|
ULONG NoDisplayInUI:1;
|
|
} STOR_DEVICE_CAPABILITIES, *PSTOR_DEVICE_CAPABILITIES;
|
|
|
|
typedef struct _SCSI_PNP_REQUEST_BLOCK {
|
|
USHORT Length;
|
|
UCHAR Function;
|
|
UCHAR SrbStatus;
|
|
UCHAR PnPSubFunction;
|
|
UCHAR PathId;
|
|
UCHAR TargetId;
|
|
UCHAR Lun;
|
|
STOR_PNP_ACTION PnPAction;
|
|
ULONG SrbFlags;
|
|
ULONG DataTransferLength;
|
|
ULONG TimeOutValue;
|
|
PVOID DataBuffer;
|
|
PVOID SenseInfoBuffer;
|
|
struct _SCSI_REQUEST_BLOCK *NextSrb;
|
|
PVOID OriginalRequest;
|
|
PVOID SrbExtension;
|
|
ULONG SrbPnPFlags;
|
|
#if defined(_WIN64)
|
|
ULONG Reserved;
|
|
#endif
|
|
UCHAR Reserved4[16];
|
|
} SCSI_PNP_REQUEST_BLOCK, *PSCSI_PNP_REQUEST_BLOCK;
|
|
|
|
typedef
|
|
_Must_inspect_result_
|
|
BOOLEAN
|
|
(NTAPI *PHW_INITIALIZE)(
|
|
_In_ PVOID DeviceExtension);
|
|
|
|
typedef
|
|
_Must_inspect_result_
|
|
BOOLEAN
|
|
(NTAPI *PHW_STARTIO)(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ PSCSI_REQUEST_BLOCK Srb);
|
|
|
|
typedef
|
|
_Must_inspect_result_
|
|
BOOLEAN
|
|
(NTAPI *PHW_INTERRUPT)(
|
|
_In_ PVOID DeviceExtension);
|
|
|
|
typedef VOID
|
|
(NTAPI *PHW_TIMER)(
|
|
_In_ PVOID DeviceExtension);
|
|
|
|
typedef VOID
|
|
(NTAPI *PHW_DMA_STARTED)(
|
|
_In_ PVOID DeviceExtension);
|
|
|
|
typedef
|
|
_Must_inspect_result_
|
|
ULONG
|
|
(NTAPI *PHW_FIND_ADAPTER)(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ PVOID HwContext,
|
|
_In_ PVOID BusInformation,
|
|
_In_ PCHAR ArgumentString,
|
|
_Inout_ PPORT_CONFIGURATION_INFORMATION ConfigInfo,
|
|
_Out_ PBOOLEAN Again);
|
|
|
|
typedef
|
|
_Must_inspect_result_
|
|
BOOLEAN
|
|
(NTAPI *PHW_RESET_BUS)(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ ULONG PathId);
|
|
|
|
typedef
|
|
_Must_inspect_result_
|
|
BOOLEAN
|
|
(NTAPI *PHW_ADAPTER_STATE)(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ PVOID Context,
|
|
_In_ BOOLEAN SaveState);
|
|
|
|
typedef
|
|
_Must_inspect_result_
|
|
SCSI_ADAPTER_CONTROL_STATUS
|
|
(NTAPI *PHW_ADAPTER_CONTROL)(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ SCSI_ADAPTER_CONTROL_TYPE ControlType,
|
|
_In_ PVOID Parameters);
|
|
|
|
typedef enum _SCSI_NOTIFICATION_TYPE {
|
|
RequestComplete,
|
|
NextRequest,
|
|
NextLuRequest,
|
|
ResetDetected,
|
|
CallDisableInterrupts,
|
|
CallEnableInterrupts,
|
|
RequestTimerCall,
|
|
BusChangeDetected,
|
|
WMIEvent,
|
|
WMIReregister,
|
|
LinkUp,
|
|
LinkDown,
|
|
QueryTickCount,
|
|
BufferOverrunDetected,
|
|
TraceNotification
|
|
} SCSI_NOTIFICATION_TYPE, *PSCSI_NOTIFICATION_TYPE;
|
|
|
|
typedef struct _HW_INITIALIZATION_DATA {
|
|
ULONG HwInitializationDataSize;
|
|
INTERFACE_TYPE AdapterInterfaceType;
|
|
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;
|
|
ULONG DeviceExtensionSize;
|
|
ULONG SpecificLuExtensionSize;
|
|
ULONG SrbExtensionSize;
|
|
ULONG NumberOfAccessRanges;
|
|
PVOID Reserved;
|
|
BOOLEAN MapBuffers;
|
|
BOOLEAN NeedPhysicalAddresses;
|
|
BOOLEAN TaggedQueuing;
|
|
BOOLEAN AutoRequestSense;
|
|
BOOLEAN MultipleRequestPerLu;
|
|
BOOLEAN ReceiveEvent;
|
|
USHORT VendorIdLength;
|
|
PVOID VendorId;
|
|
_ANONYMOUS_UNION union {
|
|
USHORT ReservedUshort;
|
|
USHORT PortVersionFlags;
|
|
} DUMMYUNIONNAME;
|
|
USHORT DeviceIdLength;
|
|
PVOID DeviceId;
|
|
PHW_ADAPTER_CONTROL HwAdapterControl;
|
|
} HW_INITIALIZATION_DATA, *PHW_INITIALIZATION_DATA;
|
|
|
|
#if defined(_NTDDK_)
|
|
#define SCSIPORTAPI
|
|
#else
|
|
#define SCSIPORTAPI DECLSPEC_IMPORT
|
|
#endif
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortCompleteRequest(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ UCHAR PathId,
|
|
_In_ UCHAR TargetId,
|
|
_In_ UCHAR Lun,
|
|
_In_ UCHAR SrbStatus);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
ULONG
|
|
NTAPI
|
|
ScsiPortConvertPhysicalAddressToUlong(
|
|
_In_ SCSI_PHYSICAL_ADDRESS Address);
|
|
|
|
#define ScsiPortConvertPhysicalAddressToUlong(Address) ((Address).LowPart)
|
|
#define ScsiPortConvertPhysicalAddressToULongPtr(Address) ((ULONG_PTR)((Address).QuadPart))
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
SCSI_PHYSICAL_ADDRESS
|
|
NTAPI
|
|
ScsiPortConvertUlongToPhysicalAddress(
|
|
_In_ ULONG_PTR UlongAddress);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortFlushDma(
|
|
_In_ PVOID DeviceExtension);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortFreeDeviceBase(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ PVOID MappedAddress);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
ULONG
|
|
NTAPI
|
|
ScsiPortGetBusData(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ ULONG BusDataType,
|
|
_In_ ULONG SystemIoBusNumber,
|
|
_In_ ULONG SlotNumber,
|
|
_In_reads_bytes_(Length) PVOID Buffer,
|
|
_In_ ULONG Length);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
PVOID
|
|
NTAPI
|
|
ScsiPortGetDeviceBase(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ INTERFACE_TYPE BusType,
|
|
_In_ ULONG SystemIoBusNumber,
|
|
_In_ SCSI_PHYSICAL_ADDRESS IoAddress,
|
|
_In_ ULONG NumberOfBytes,
|
|
_In_ BOOLEAN InIoSpace);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
PVOID
|
|
NTAPI
|
|
ScsiPortGetLogicalUnit(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ UCHAR PathId,
|
|
_In_ UCHAR TargetId,
|
|
_In_ UCHAR Lun);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
SCSI_PHYSICAL_ADDRESS
|
|
NTAPI
|
|
ScsiPortGetPhysicalAddress(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ PSCSI_REQUEST_BLOCK Srb,
|
|
_In_ PVOID VirtualAddress,
|
|
_Out_ ULONG *Length);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
PSCSI_REQUEST_BLOCK
|
|
NTAPI
|
|
ScsiPortGetSrb(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ UCHAR PathId,
|
|
_In_ UCHAR TargetId,
|
|
_In_ UCHAR Lun,
|
|
_In_ LONG QueueTag);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
PVOID
|
|
NTAPI
|
|
ScsiPortGetUncachedExtension(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ PPORT_CONFIGURATION_INFORMATION ConfigInfo,
|
|
_In_ ULONG NumberOfBytes);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
PVOID
|
|
NTAPI
|
|
ScsiPortGetVirtualAddress(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ SCSI_PHYSICAL_ADDRESS PhysicalAddress);
|
|
|
|
_Must_inspect_result_
|
|
_IRQL_requires_max_(PASSIVE_LEVEL)
|
|
SCSIPORTAPI
|
|
ULONG
|
|
NTAPI
|
|
ScsiPortInitialize(
|
|
_In_ PVOID Argument1,
|
|
_In_ PVOID Argument2,
|
|
_In_ struct _HW_INITIALIZATION_DATA *HwInitializationData,
|
|
_In_ PVOID HwContext);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortIoMapTransfer(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ PSCSI_REQUEST_BLOCK Srb,
|
|
_In_ PVOID LogicalAddress,
|
|
_In_ ULONG Length);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortLogError(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_opt_ PSCSI_REQUEST_BLOCK Srb,
|
|
_In_ UCHAR PathId,
|
|
_In_ UCHAR TargetId,
|
|
_In_ UCHAR Lun,
|
|
_In_ ULONG ErrorCode,
|
|
_In_ ULONG UniqueId);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
__cdecl
|
|
ScsiPortNotification(
|
|
_In_ SCSI_NOTIFICATION_TYPE NotificationType,
|
|
_In_ PVOID HwDeviceExtension,
|
|
...);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortQuerySystemTime(
|
|
_Out_ PLARGE_INTEGER CurrentTime);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
ULONG
|
|
NTAPI
|
|
ScsiPortSetBusDataByOffset(
|
|
_In_ PVOID DeviceExtension,
|
|
_In_ ULONG BusDataType,
|
|
_In_ ULONG SystemIoBusNumber,
|
|
_In_ ULONG SlotNumber,
|
|
_In_reads_bytes_(Length) PVOID Buffer,
|
|
_In_ ULONG Offset,
|
|
_In_ ULONG Length);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortStallExecution(
|
|
_In_ ULONG Delay);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
BOOLEAN
|
|
NTAPI
|
|
ScsiPortValidateRange(
|
|
_In_ PVOID HwDeviceExtension,
|
|
_In_ INTERFACE_TYPE BusType,
|
|
_In_ ULONG SystemIoBusNumber,
|
|
_In_ SCSI_PHYSICAL_ADDRESS IoAddress,
|
|
_In_ ULONG NumberOfBytes,
|
|
_In_ BOOLEAN InIoSpace);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
__cdecl
|
|
ScsiDebugPrint(
|
|
ULONG DebugPrintLevel,
|
|
PCCHAR DebugMessage,
|
|
...);
|
|
|
|
#if defined(_M_AMD64)
|
|
|
|
#define ScsiPortReadPortUchar READ_PORT_UCHAR
|
|
#define ScsiPortReadPortUshort READ_PORT_USHORT
|
|
#define ScsiPortReadPortUlong READ_PORT_ULONG
|
|
|
|
#define ScsiPortReadPortBufferUchar READ_PORT_BUFFER_UCHAR
|
|
#define ScsiPortReadPortBufferUshort READ_PORT_BUFFER_USHORT
|
|
#define ScsiPortReadPortBufferUlong READ_PORT_BUFFER_ULONG
|
|
|
|
#define ScsiPortReadRegisterUchar READ_REGISTER_UCHAR
|
|
#define ScsiPortReadRegisterUshort READ_REGISTER_USHORT
|
|
#define ScsiPortReadRegisterUlong READ_REGISTER_ULONG
|
|
|
|
#define ScsiPortReadRegisterBufferUchar READ_REGISTER_BUFFER_UCHAR
|
|
#define ScsiPortReadRegisterBufferUshort READ_REGISTER_BUFFER_USHORT
|
|
#define ScsiPortReadRegisterBufferUlong READ_REGISTER_BUFFER_ULONG
|
|
|
|
#define ScsiPortWritePortUchar WRITE_PORT_UCHAR
|
|
#define ScsiPortWritePortUshort WRITE_PORT_USHORT
|
|
#define ScsiPortWritePortUlong WRITE_PORT_ULONG
|
|
|
|
#define ScsiPortWritePortBufferUchar WRITE_PORT_BUFFER_UCHAR
|
|
#define ScsiPortWritePortBufferUshort WRITE_PORT_BUFFER_USHORT
|
|
#define ScsiPortWritePortBufferUlong WRITE_PORT_BUFFER_ULONG
|
|
|
|
#define ScsiPortWriteRegisterUchar WRITE_REGISTER_UCHAR
|
|
#define ScsiPortWriteRegisterUshort WRITE_REGISTER_USHORT
|
|
#define ScsiPortWriteRegisterUlong WRITE_REGISTER_ULONG
|
|
|
|
#define ScsiPortWriteRegisterBufferUchar WRITE_REGISTER_BUFFER_UCHAR
|
|
#define ScsiPortWriteRegisterBufferUshort WRITE_REGISTER_BUFFER_USHORT
|
|
#define ScsiPortWriteRegisterBufferUlong WRITE_REGISTER_BUFFER_ULONG
|
|
|
|
#define ScsiPortMoveMemory memmove
|
|
|
|
#else
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
UCHAR
|
|
NTAPI
|
|
ScsiPortReadPortUchar(
|
|
_In_ PUCHAR Port);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
ULONG
|
|
NTAPI
|
|
ScsiPortReadPortUlong(
|
|
_In_ PULONG Port);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
USHORT
|
|
NTAPI
|
|
ScsiPortReadPortUshort(
|
|
_In_ PUSHORT Port);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortReadPortBufferUchar(
|
|
_In_ PUCHAR Port,
|
|
_In_ PUCHAR Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortReadPortBufferUlong(
|
|
_In_ PULONG Port,
|
|
_In_ PULONG Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortReadPortBufferUshort(
|
|
_In_ PUSHORT Port,
|
|
_In_ PUSHORT Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
UCHAR
|
|
NTAPI
|
|
ScsiPortReadRegisterUchar(
|
|
_In_ PUCHAR Register);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
ULONG
|
|
NTAPI
|
|
ScsiPortReadRegisterUlong(
|
|
_In_ PULONG Register);
|
|
|
|
_Must_inspect_result_
|
|
SCSIPORTAPI
|
|
USHORT
|
|
NTAPI
|
|
ScsiPortReadRegisterUshort(
|
|
_In_ PUSHORT Register);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortReadRegisterBufferUchar(
|
|
_In_ PUCHAR Register,
|
|
_In_ PUCHAR Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortReadRegisterBufferUlong(
|
|
_In_ PULONG Register,
|
|
_In_ PULONG Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortReadRegisterBufferUshort(
|
|
_In_ PUSHORT Register,
|
|
_In_ PUSHORT Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWritePortUchar(
|
|
_In_ PUCHAR Port,
|
|
_In_ UCHAR Value);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWritePortUlong(
|
|
_In_ PULONG Port,
|
|
_In_ ULONG Value);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWritePortUshort(
|
|
_In_ PUSHORT Port,
|
|
_In_ USHORT Value);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWritePortBufferUchar(
|
|
_In_ PUCHAR Port,
|
|
_In_ PUCHAR Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWritePortBufferUlong(
|
|
_In_ PULONG Port,
|
|
_In_ PULONG Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWritePortBufferUshort(
|
|
_In_ PUSHORT Port,
|
|
_In_ PUSHORT Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWriteRegisterUchar(
|
|
_In_ PUCHAR Register,
|
|
_In_ UCHAR Value);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWriteRegisterUlong(
|
|
_In_ PULONG Register,
|
|
_In_ ULONG Value);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWriteRegisterUshort(
|
|
_In_ PUSHORT Register,
|
|
_In_ USHORT Value);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWriteRegisterBufferUchar(
|
|
_In_ PUCHAR Register,
|
|
_In_ PUCHAR Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWriteRegisterBufferUlong(
|
|
_In_ PULONG Register,
|
|
_In_ PULONG Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortWriteRegisterBufferUshort(
|
|
_In_ PUSHORT Register,
|
|
_In_ PUSHORT Buffer,
|
|
_In_ ULONG Count);
|
|
|
|
SCSIPORTAPI
|
|
VOID
|
|
NTAPI
|
|
ScsiPortMoveMemory(
|
|
_In_ PVOID WriteBuffer,
|
|
_In_ PVOID ReadBuffer,
|
|
_In_ ULONG Length);
|
|
|
|
#endif /* defined(_M_AMD64) */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _NTSRB_ */
|