srb.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940
  1. /*
  2. * scsi.h
  3. *
  4. * Interface between SCSI miniport drivers and the SCSI port driver.
  5. *
  6. * This file is part of the w32api package.
  7. *
  8. * Contributors:
  9. * Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10. *
  11. * THIS SOFTWARE IS NOT COPYRIGHTED
  12. *
  13. * This source code is offered for use in the public domain. You may
  14. * use, modify or distribute it freely.
  15. *
  16. * This code is distributed in the hope that it will be useful but
  17. * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18. * DISCLAIMED. This includes but is not limited to warranties of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20. *
  21. */
  22. #ifndef _NTSRB_
  23. #define _NTSRB_
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  27. #define SCSI_MAXIMUM_LOGICAL_UNITS 8
  28. #define SCSI_MAXIMUM_TARGETS_PER_BUS 128
  29. #define SCSI_MAXIMUM_LUNS_PER_TARGET 255
  30. #define SCSI_MAXIMUM_BUSES 8
  31. #define SCSI_MINIMUM_PHYSICAL_BREAKS 16
  32. #define SCSI_MAXIMUM_PHYSICAL_BREAKS 255
  33. #define SCSI_MAXIMUM_TARGETS 8
  34. /* PORT_CONFIGURATION_INFORMATION.Dma64BitAddresses constants */
  35. #define SCSI_DMA64_MINIPORT_SUPPORTED 0x01
  36. #define SCSI_DMA64_SYSTEM_SUPPORTED 0x80
  37. #if (NTDDI_VERSION > NTDDI_WS03SP1)
  38. #define SCSI_DMA64_MINIPORT_FULL64BIT_SUPPORTED 0x02
  39. #endif
  40. #define SP_UNINITIALIZED_VALUE ((ULONG) ~0)
  41. #define SP_UNTAGGED ((UCHAR) ~0)
  42. /* Asynchronous events */
  43. #define SRBEV_BUS_RESET 0x0001
  44. #define SRBEV_SCSI_ASYNC_NOTIFICATION 0x0002
  45. #define MAXIMUM_CDB_SIZE 12
  46. #if DBG
  47. #define DebugPrint(x) ScsiDebugPrint x
  48. #else
  49. #define DebugPrint(x)
  50. #endif
  51. #define SCSI_COMBINE_BUS_TARGET(Bus, Target)( \
  52. ((((UCHAR) (Target)) & ~(0x20 - 1)) << 8) | \
  53. (((UCHAR) (Bus)) << 5) | \
  54. (((UCHAR) (Target)) & (0x20 - 1)))
  55. #define SCSI_DECODE_BUS_TARGET(Value, Bus, Target)( \
  56. Bus = (UCHAR) ((Value) >> 5), \
  57. Target = (UCHAR) ((((Value) >> 8) & ~(0x20 - 1)) | ((Value) & (0x20 - 1))))
  58. /* SCSI_REQUEST_BLOCK.Function constants */
  59. #define SRB_FUNCTION_EXECUTE_SCSI 0x00
  60. #define SRB_FUNCTION_CLAIM_DEVICE 0x01
  61. #define SRB_FUNCTION_IO_CONTROL 0x02
  62. #define SRB_FUNCTION_RECEIVE_EVENT 0x03
  63. #define SRB_FUNCTION_RELEASE_QUEUE 0x04
  64. #define SRB_FUNCTION_ATTACH_DEVICE 0x05
  65. #define SRB_FUNCTION_RELEASE_DEVICE 0x06
  66. #define SRB_FUNCTION_SHUTDOWN 0x07
  67. #define SRB_FUNCTION_FLUSH 0x08
  68. #define SRB_FUNCTION_ABORT_COMMAND 0x10
  69. #define SRB_FUNCTION_RELEASE_RECOVERY 0x11
  70. #define SRB_FUNCTION_RESET_BUS 0x12
  71. #define SRB_FUNCTION_RESET_DEVICE 0x13
  72. #define SRB_FUNCTION_TERMINATE_IO 0x14
  73. #define SRB_FUNCTION_FLUSH_QUEUE 0x15
  74. #define SRB_FUNCTION_REMOVE_DEVICE 0x16
  75. #define SRB_FUNCTION_WMI 0x17
  76. #define SRB_FUNCTION_LOCK_QUEUE 0x18
  77. #define SRB_FUNCTION_UNLOCK_QUEUE 0x19
  78. #define SRB_FUNCTION_RESET_LOGICAL_UNIT 0x20
  79. #define SRB_FUNCTION_SET_LINK_TIMEOUT 0x21
  80. #define SRB_FUNCTION_LINK_TIMEOUT_OCCURRED 0x22
  81. #define SRB_FUNCTION_LINK_TIMEOUT_COMPLETE 0x23
  82. #define SRB_FUNCTION_POWER 0x24
  83. #define SRB_FUNCTION_PNP 0x25
  84. #define SRB_FUNCTION_DUMP_POINTERS 0x26
  85. /* SCSI_REQUEST_BLOCK.SrbStatus constants */
  86. #define SRB_STATUS_PENDING 0x00
  87. #define SRB_STATUS_SUCCESS 0x01
  88. #define SRB_STATUS_ABORTED 0x02
  89. #define SRB_STATUS_ABORT_FAILED 0x03
  90. #define SRB_STATUS_ERROR 0x04
  91. #define SRB_STATUS_BUSY 0x05
  92. #define SRB_STATUS_INVALID_REQUEST 0x06
  93. #define SRB_STATUS_INVALID_PATH_ID 0x07
  94. #define SRB_STATUS_NO_DEVICE 0x08
  95. #define SRB_STATUS_TIMEOUT 0x09
  96. #define SRB_STATUS_SELECTION_TIMEOUT 0x0A
  97. #define SRB_STATUS_COMMAND_TIMEOUT 0x0B
  98. #define SRB_STATUS_MESSAGE_REJECTED 0x0D
  99. #define SRB_STATUS_BUS_RESET 0x0E
  100. #define SRB_STATUS_PARITY_ERROR 0x0F
  101. #define SRB_STATUS_REQUEST_SENSE_FAILED 0x10
  102. #define SRB_STATUS_NO_HBA 0x11
  103. #define SRB_STATUS_DATA_OVERRUN 0x12
  104. #define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13
  105. #define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14
  106. #define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15
  107. #define SRB_STATUS_REQUEST_FLUSHED 0x16
  108. #define SRB_STATUS_INVALID_LUN 0x20
  109. #define SRB_STATUS_INVALID_TARGET_ID 0x21
  110. #define SRB_STATUS_BAD_FUNCTION 0x22
  111. #define SRB_STATUS_ERROR_RECOVERY 0x23
  112. #define SRB_STATUS_NOT_POWERED 0x24
  113. #define SRB_STATUS_LINK_DOWN 0x25
  114. #define SRB_STATUS_INTERNAL_ERROR 0x30
  115. #define SRB_STATUS_QUEUE_FROZEN 0x40
  116. #define SRB_STATUS_AUTOSENSE_VALID 0x80
  117. #define SRB_STATUS(Status) \
  118. (Status & ~(SRB_STATUS_AUTOSENSE_VALID | SRB_STATUS_QUEUE_FROZEN))
  119. /* SCSI_REQUEST_BLOCK.SrbFlags constants */
  120. #define SRB_FLAGS_QUEUE_ACTION_ENABLE 0x00000002
  121. #define SRB_FLAGS_DISABLE_DISCONNECT 0x00000004
  122. #define SRB_FLAGS_DISABLE_SYNCH_TRANSFER 0x00000008
  123. #define SRB_FLAGS_BYPASS_FROZEN_QUEUE 0x00000010
  124. #define SRB_FLAGS_DISABLE_AUTOSENSE 0x00000020
  125. #define SRB_FLAGS_DATA_IN 0x00000040
  126. #define SRB_FLAGS_DATA_OUT 0x00000080
  127. #define SRB_FLAGS_NO_DATA_TRANSFER 0x00000000
  128. #define SRB_FLAGS_UNSPECIFIED_DIRECTION (SRB_FLAGS_DATA_IN | SRB_FLAGS_DATA_OUT)
  129. #define SRB_FLAGS_NO_QUEUE_FREEZE 0x00000100
  130. #define SRB_FLAGS_ADAPTER_CACHE_ENABLE 0x00000200
  131. #define SRB_FLAGS_FREE_SENSE_BUFFER 0x00000400
  132. #define SRB_FLAGS_IS_ACTIVE 0x00010000
  133. #define SRB_FLAGS_ALLOCATED_FROM_ZONE 0x00020000
  134. #define SRB_FLAGS_SGLIST_FROM_POOL 0x00040000
  135. #define SRB_FLAGS_BYPASS_LOCKED_QUEUE 0x00080000
  136. #define SRB_FLAGS_NO_KEEP_AWAKE 0x00100000
  137. #define SRB_FLAGS_PORT_DRIVER_ALLOCSENSE 0x00200000
  138. #define SRB_FLAGS_PORT_DRIVER_SENSEHASPORT 0x00400000
  139. #define SRB_FLAGS_DONT_START_NEXT_PACKET 0x00800000
  140. #define SRB_FLAGS_PORT_DRIVER_RESERVED 0x0F000000
  141. #define SRB_FLAGS_CLASS_DRIVER_RESERVED 0xF0000000
  142. #if DBG
  143. #define SCSI_PORT_SIGNATURE 0x54524f50
  144. #endif
  145. #define SRB_SIMPLE_TAG_REQUEST 0x20
  146. #define SRB_HEAD_OF_QUEUE_TAG_REQUEST 0x21
  147. #define SRB_ORDERED_QUEUE_TAG_REQUEST 0x22
  148. #define SRB_WMI_FLAGS_ADAPTER_REQUEST 0x0001
  149. #define SRB_POWER_FLAGS_ADAPTER_REQUEST 0x0001
  150. #define SRB_PNP_FLAGS_ADAPTER_REQUEST 0x0001
  151. #define SP_BUS_PARITY_ERROR 0x0001
  152. #define SP_UNEXPECTED_DISCONNECT 0x0002
  153. #define SP_INVALID_RESELECTION 0x0003
  154. #define SP_BUS_TIME_OUT 0x0004
  155. #define SP_PROTOCOL_ERROR 0x0005
  156. #define SP_INTERNAL_ADAPTER_ERROR 0x0006
  157. #define SP_REQUEST_TIMEOUT 0x0007
  158. #define SP_IRQ_NOT_RESPONDING 0x0008
  159. #define SP_BAD_FW_WARNING 0x0009
  160. #define SP_BAD_FW_ERROR 0x000a
  161. #define SP_LOST_WMI_MINIPORT_REQUEST 0x000b
  162. #define SP_VER_TRACE_SUPPORT 0x0010
  163. #define SP_RETURN_NOT_FOUND 0
  164. #define SP_RETURN_FOUND 1
  165. #define SP_RETURN_ERROR 2
  166. #define SP_RETURN_BAD_CONFIG 3
  167. typedef PHYSICAL_ADDRESS SCSI_PHYSICAL_ADDRESS, *PSCSI_PHYSICAL_ADDRESS;
  168. typedef struct _ACCESS_RANGE {
  169. SCSI_PHYSICAL_ADDRESS RangeStart;
  170. ULONG RangeLength;
  171. BOOLEAN RangeInMemory;
  172. } ACCESS_RANGE, *PACCESS_RANGE;
  173. typedef struct _PORT_CONFIGURATION_INFORMATION {
  174. ULONG Length;
  175. ULONG SystemIoBusNumber;
  176. INTERFACE_TYPE AdapterInterfaceType;
  177. ULONG BusInterruptLevel;
  178. ULONG BusInterruptVector;
  179. KINTERRUPT_MODE InterruptMode;
  180. ULONG MaximumTransferLength;
  181. ULONG NumberOfPhysicalBreaks;
  182. ULONG DmaChannel;
  183. ULONG DmaPort;
  184. DMA_WIDTH DmaWidth;
  185. DMA_SPEED DmaSpeed;
  186. ULONG AlignmentMask;
  187. ULONG NumberOfAccessRanges;
  188. ACCESS_RANGE (*AccessRanges)[];
  189. PVOID Reserved;
  190. UCHAR NumberOfBuses;
  191. UCHAR InitiatorBusId[8];
  192. BOOLEAN ScatterGather;
  193. BOOLEAN Master;
  194. BOOLEAN CachesData;
  195. BOOLEAN AdapterScansDown;
  196. BOOLEAN AtdiskPrimaryClaimed;
  197. BOOLEAN AtdiskSecondaryClaimed;
  198. BOOLEAN Dma32BitAddresses;
  199. BOOLEAN DemandMode;
  200. BOOLEAN MapBuffers;
  201. BOOLEAN NeedPhysicalAddresses;
  202. BOOLEAN TaggedQueuing;
  203. BOOLEAN AutoRequestSense;
  204. BOOLEAN MultipleRequestPerLu;
  205. BOOLEAN ReceiveEvent;
  206. BOOLEAN RealModeInitialized;
  207. BOOLEAN BufferAccessScsiPortControlled;
  208. UCHAR MaximumNumberOfTargets;
  209. UCHAR ReservedUchars[2];
  210. ULONG SlotNumber;
  211. ULONG BusInterruptLevel2;
  212. ULONG BusInterruptVector2;
  213. KINTERRUPT_MODE InterruptMode2;
  214. ULONG DmaChannel2;
  215. ULONG DmaPort2;
  216. DMA_WIDTH DmaWidth2;
  217. DMA_SPEED DmaSpeed2;
  218. ULONG DeviceExtensionSize;
  219. ULONG SpecificLuExtensionSize;
  220. ULONG SrbExtensionSize;
  221. UCHAR Dma64BitAddresses;
  222. BOOLEAN ResetTargetSupported;
  223. UCHAR MaximumNumberOfLogicalUnits;
  224. BOOLEAN WmiDataProvider;
  225. } PORT_CONFIGURATION_INFORMATION, *PPORT_CONFIGURATION_INFORMATION;
  226. #define CONFIG_INFO_VERSION_2 sizeof(PORT_CONFIGURATION_INFORMATION)
  227. #ifdef __GNUC__
  228. __extension__ /* enums limited to range of integer */
  229. #endif
  230. typedef enum _SCSI_ADAPTER_CONTROL_TYPE {
  231. ScsiQuerySupportedControlTypes = 0,
  232. ScsiStopAdapter,
  233. ScsiRestartAdapter,
  234. ScsiSetBootConfig,
  235. ScsiSetRunningConfig,
  236. ScsiAdapterControlMax,
  237. MakeAdapterControlTypeSizeOfUlong = 0xffffffff
  238. } SCSI_ADAPTER_CONTROL_TYPE, *PSCSI_ADAPTER_CONTROL_TYPE;
  239. typedef enum _SCSI_ADAPTER_CONTROL_STATUS {
  240. ScsiAdapterControlSuccess = 0,
  241. ScsiAdapterControlUnsuccessful
  242. } SCSI_ADAPTER_CONTROL_STATUS, *PSCSI_ADAPTER_CONTROL_STATUS;
  243. typedef struct _SCSI_SUPPORTED_CONTROL_TYPE_LIST {
  244. ULONG MaxControlType;
  245. BOOLEAN SupportedTypeList[0];
  246. } SCSI_SUPPORTED_CONTROL_TYPE_LIST, *PSCSI_SUPPORTED_CONTROL_TYPE_LIST;
  247. typedef struct _SCSI_REQUEST_BLOCK {
  248. USHORT Length;
  249. UCHAR Function;
  250. UCHAR SrbStatus;
  251. UCHAR ScsiStatus;
  252. UCHAR PathId;
  253. UCHAR TargetId;
  254. UCHAR Lun;
  255. UCHAR QueueTag;
  256. UCHAR QueueAction;
  257. UCHAR CdbLength;
  258. UCHAR SenseInfoBufferLength;
  259. ULONG SrbFlags;
  260. ULONG DataTransferLength;
  261. ULONG TimeOutValue;
  262. PVOID DataBuffer;
  263. PVOID SenseInfoBuffer;
  264. struct _SCSI_REQUEST_BLOCK *NextSrb;
  265. PVOID OriginalRequest;
  266. PVOID SrbExtension;
  267. _ANONYMOUS_UNION union {
  268. ULONG InternalStatus;
  269. ULONG QueueSortKey;
  270. ULONG LinkTimeoutValue;
  271. } DUMMYUNIONNAME;
  272. #if defined(_WIN64)
  273. ULONG Reserved;
  274. #endif
  275. UCHAR Cdb[16];
  276. } SCSI_REQUEST_BLOCK, *PSCSI_REQUEST_BLOCK;
  277. #define SCSI_REQUEST_BLOCK_SIZE sizeof(SCSI_REQUEST_BLOCK)
  278. typedef struct _SCSI_WMI_REQUEST_BLOCK {
  279. USHORT Length;
  280. UCHAR Function;
  281. UCHAR SrbStatus;
  282. UCHAR WMISubFunction;
  283. UCHAR PathId;
  284. UCHAR TargetId;
  285. UCHAR Lun;
  286. UCHAR Reserved1;
  287. UCHAR WMIFlags;
  288. UCHAR Reserved2[2];
  289. ULONG SrbFlags;
  290. ULONG DataTransferLength;
  291. ULONG TimeOutValue;
  292. PVOID DataBuffer;
  293. PVOID DataPath;
  294. PVOID Reserved3;
  295. PVOID OriginalRequest;
  296. PVOID SrbExtension;
  297. ULONG Reserved4;
  298. #if (NTDDI_VERSION >= NTDDI_WS03SP1) && defined(_WIN64)
  299. ULONG Reserved6;
  300. #endif
  301. UCHAR Reserved5[16];
  302. } SCSI_WMI_REQUEST_BLOCK, *PSCSI_WMI_REQUEST_BLOCK;
  303. typedef enum _STOR_DEVICE_POWER_STATE {
  304. StorPowerDeviceUnspecified = 0,
  305. StorPowerDeviceD0,
  306. StorPowerDeviceD1,
  307. StorPowerDeviceD2,
  308. StorPowerDeviceD3,
  309. StorPowerDeviceMaximum
  310. } STOR_DEVICE_POWER_STATE, *PSTOR_DEVICE_POWER_STATE;
  311. typedef enum _STOR_POWER_ACTION {
  312. StorPowerActionNone = 0,
  313. StorPowerActionReserved,
  314. StorPowerActionSleep,
  315. StorPowerActionHibernate,
  316. StorPowerActionShutdown,
  317. StorPowerActionShutdownReset,
  318. StorPowerActionShutdownOff,
  319. StorPowerActionWarmEject
  320. } STOR_POWER_ACTION, *PSTOR_POWER_ACTION;
  321. typedef struct _SCSI_POWER_REQUEST_BLOCK {
  322. USHORT Length;
  323. UCHAR Function;
  324. UCHAR SrbStatus;
  325. UCHAR SrbPowerFlags;
  326. UCHAR PathId;
  327. UCHAR TargetId;
  328. UCHAR Lun;
  329. STOR_DEVICE_POWER_STATE DevicePowerState;
  330. ULONG SrbFlags;
  331. ULONG DataTransferLength;
  332. ULONG TimeOutValue;
  333. PVOID DataBuffer;
  334. PVOID SenseInfoBuffer;
  335. struct _SCSI_REQUEST_BLOCK *NextSrb;
  336. PVOID OriginalRequest;
  337. PVOID SrbExtension;
  338. STOR_POWER_ACTION PowerAction;
  339. #if defined(_WIN64)
  340. ULONG Reserved;
  341. #endif
  342. UCHAR Reserved5[16];
  343. } SCSI_POWER_REQUEST_BLOCK, *PSCSI_POWER_REQUEST_BLOCK;
  344. typedef enum _STOR_PNP_ACTION {
  345. StorStartDevice = 0x0,
  346. StorRemoveDevice = 0x2,
  347. StorStopDevice = 0x4,
  348. StorQueryCapabilities = 0x9,
  349. StorQueryResourceRequirements = 0xB,
  350. StorFilterResourceRequirements = 0xD,
  351. StorSurpriseRemoval = 0x17
  352. } STOR_PNP_ACTION, *PSTOR_PNP_ACTION;
  353. typedef struct _STOR_DEVICE_CAPABILITIES {
  354. USHORT Version;
  355. ULONG DeviceD1:1;
  356. ULONG DeviceD2:1;
  357. ULONG LockSupported:1;
  358. ULONG EjectSupported:1;
  359. ULONG Removable:1;
  360. ULONG DockDevice:1;
  361. ULONG UniqueID:1;
  362. ULONG SilentInstall:1;
  363. ULONG SurpriseRemovalOK:1;
  364. ULONG NoDisplayInUI:1;
  365. } STOR_DEVICE_CAPABILITIES, *PSTOR_DEVICE_CAPABILITIES;
  366. typedef struct _SCSI_PNP_REQUEST_BLOCK {
  367. USHORT Length;
  368. UCHAR Function;
  369. UCHAR SrbStatus;
  370. UCHAR PnPSubFunction;
  371. UCHAR PathId;
  372. UCHAR TargetId;
  373. UCHAR Lun;
  374. STOR_PNP_ACTION PnPAction;
  375. ULONG SrbFlags;
  376. ULONG DataTransferLength;
  377. ULONG TimeOutValue;
  378. PVOID DataBuffer;
  379. PVOID SenseInfoBuffer;
  380. struct _SCSI_REQUEST_BLOCK *NextSrb;
  381. PVOID OriginalRequest;
  382. PVOID SrbExtension;
  383. ULONG SrbPnPFlags;
  384. #if defined(_WIN64)
  385. ULONG Reserved;
  386. #endif
  387. UCHAR Reserved4[16];
  388. } SCSI_PNP_REQUEST_BLOCK, *PSCSI_PNP_REQUEST_BLOCK;
  389. typedef BOOLEAN
  390. (NTAPI *PHW_INITIALIZE)(
  391. IN PVOID DeviceExtension);
  392. typedef BOOLEAN
  393. (NTAPI *PHW_STARTIO)(
  394. IN PVOID DeviceExtension,
  395. IN PSCSI_REQUEST_BLOCK Srb);
  396. typedef BOOLEAN
  397. (NTAPI *PHW_INTERRUPT)(
  398. IN PVOID DeviceExtension);
  399. typedef VOID
  400. (NTAPI *PHW_TIMER)(
  401. IN PVOID DeviceExtension);
  402. typedef VOID
  403. (NTAPI *PHW_DMA_STARTED)(
  404. IN PVOID DeviceExtension);
  405. typedef ULONG
  406. (NTAPI *PHW_FIND_ADAPTER)(
  407. IN PVOID DeviceExtension,
  408. IN PVOID HwContext,
  409. IN PVOID BusInformation,
  410. IN PCHAR ArgumentString,
  411. IN OUT PPORT_CONFIGURATION_INFORMATION ConfigInfo,
  412. OUT PBOOLEAN Again);
  413. typedef BOOLEAN
  414. (NTAPI *PHW_RESET_BUS)(
  415. IN PVOID DeviceExtension,
  416. IN ULONG PathId);
  417. typedef BOOLEAN
  418. (NTAPI *PHW_ADAPTER_STATE)(
  419. IN PVOID DeviceExtension,
  420. IN PVOID Context,
  421. IN BOOLEAN SaveState);
  422. typedef SCSI_ADAPTER_CONTROL_STATUS
  423. (NTAPI *PHW_ADAPTER_CONTROL)(
  424. IN PVOID DeviceExtension,
  425. IN SCSI_ADAPTER_CONTROL_TYPE ControlType,
  426. IN PVOID Parameters);
  427. typedef enum _SCSI_NOTIFICATION_TYPE {
  428. RequestComplete,
  429. NextRequest,
  430. NextLuRequest,
  431. ResetDetected,
  432. CallDisableInterrupts,
  433. CallEnableInterrupts,
  434. RequestTimerCall,
  435. BusChangeDetected,
  436. WMIEvent,
  437. WMIReregister,
  438. LinkUp,
  439. LinkDown,
  440. QueryTickCount,
  441. BufferOverrunDetected,
  442. TraceNotification
  443. } SCSI_NOTIFICATION_TYPE, *PSCSI_NOTIFICATION_TYPE;
  444. typedef struct _HW_INITIALIZATION_DATA {
  445. ULONG HwInitializationDataSize;
  446. INTERFACE_TYPE AdapterInterfaceType;
  447. PHW_INITIALIZE HwInitialize;
  448. PHW_STARTIO HwStartIo;
  449. PHW_INTERRUPT HwInterrupt;
  450. PHW_FIND_ADAPTER HwFindAdapter;
  451. PHW_RESET_BUS HwResetBus;
  452. PHW_DMA_STARTED HwDmaStarted;
  453. PHW_ADAPTER_STATE HwAdapterState;
  454. ULONG DeviceExtensionSize;
  455. ULONG SpecificLuExtensionSize;
  456. ULONG SrbExtensionSize;
  457. ULONG NumberOfAccessRanges;
  458. PVOID Reserved;
  459. BOOLEAN MapBuffers;
  460. BOOLEAN NeedPhysicalAddresses;
  461. BOOLEAN TaggedQueuing;
  462. BOOLEAN AutoRequestSense;
  463. BOOLEAN MultipleRequestPerLu;
  464. BOOLEAN ReceiveEvent;
  465. USHORT VendorIdLength;
  466. PVOID VendorId;
  467. _ANONYMOUS_UNION union {
  468. USHORT ReservedUshort;
  469. USHORT PortVersionFlags;
  470. } DUMMYUNIONNAME;
  471. USHORT DeviceIdLength;
  472. PVOID DeviceId;
  473. PHW_ADAPTER_CONTROL HwAdapterControl;
  474. } HW_INITIALIZATION_DATA, *PHW_INITIALIZATION_DATA;
  475. #if defined(_NTDDK_)
  476. #define SCSIPORTAPI
  477. #else
  478. #define SCSIPORTAPI DECLSPEC_IMPORT
  479. #endif
  480. SCSIPORTAPI
  481. VOID
  482. NTAPI
  483. ScsiPortCompleteRequest(
  484. IN PVOID HwDeviceExtension,
  485. IN UCHAR PathId,
  486. IN UCHAR TargetId,
  487. IN UCHAR Lun,
  488. IN UCHAR SrbStatus);
  489. SCSIPORTAPI
  490. ULONG
  491. NTAPI
  492. ScsiPortConvertPhysicalAddressToUlong(
  493. IN SCSI_PHYSICAL_ADDRESS Address);
  494. #define ScsiPortConvertPhysicalAddressToUlong(Address) ((Address).LowPart)
  495. #define ScsiPortConvertPhysicalAddressToULongPtr(Address) ((ULONG_PTR)((Address).QuadPart))
  496. SCSIPORTAPI
  497. SCSI_PHYSICAL_ADDRESS
  498. NTAPI
  499. ScsiPortConvertUlongToPhysicalAddress(
  500. IN ULONG_PTR UlongAddress);
  501. SCSIPORTAPI
  502. VOID
  503. NTAPI
  504. ScsiPortFlushDma(
  505. IN PVOID DeviceExtension);
  506. SCSIPORTAPI
  507. VOID
  508. NTAPI
  509. ScsiPortFreeDeviceBase(
  510. IN PVOID HwDeviceExtension,
  511. IN PVOID MappedAddress);
  512. SCSIPORTAPI
  513. ULONG
  514. NTAPI
  515. ScsiPortGetBusData(
  516. IN PVOID DeviceExtension,
  517. IN ULONG BusDataType,
  518. IN ULONG SystemIoBusNumber,
  519. IN ULONG SlotNumber,
  520. IN PVOID Buffer,
  521. IN ULONG Length);
  522. SCSIPORTAPI
  523. PVOID
  524. NTAPI
  525. ScsiPortGetDeviceBase(
  526. IN PVOID HwDeviceExtension,
  527. IN INTERFACE_TYPE BusType,
  528. IN ULONG SystemIoBusNumber,
  529. IN SCSI_PHYSICAL_ADDRESS IoAddress,
  530. IN ULONG NumberOfBytes,
  531. IN BOOLEAN InIoSpace);
  532. SCSIPORTAPI
  533. PVOID
  534. NTAPI
  535. ScsiPortGetLogicalUnit(
  536. IN PVOID HwDeviceExtension,
  537. IN UCHAR PathId,
  538. IN UCHAR TargetId,
  539. IN UCHAR Lun);
  540. SCSIPORTAPI
  541. SCSI_PHYSICAL_ADDRESS
  542. NTAPI
  543. ScsiPortGetPhysicalAddress(
  544. IN PVOID HwDeviceExtension,
  545. IN PSCSI_REQUEST_BLOCK Srb OPTIONAL,
  546. IN PVOID VirtualAddress,
  547. OUT ULONG *Length);
  548. SCSIPORTAPI
  549. PSCSI_REQUEST_BLOCK
  550. NTAPI
  551. ScsiPortGetSrb(
  552. IN PVOID DeviceExtension,
  553. IN UCHAR PathId,
  554. IN UCHAR TargetId,
  555. IN UCHAR Lun,
  556. IN LONG QueueTag);
  557. SCSIPORTAPI
  558. PVOID
  559. NTAPI
  560. ScsiPortGetUncachedExtension(
  561. IN PVOID HwDeviceExtension,
  562. IN PPORT_CONFIGURATION_INFORMATION ConfigInfo,
  563. IN ULONG NumberOfBytes);
  564. SCSIPORTAPI
  565. PVOID
  566. NTAPI
  567. ScsiPortGetVirtualAddress(
  568. IN PVOID HwDeviceExtension,
  569. IN SCSI_PHYSICAL_ADDRESS PhysicalAddress);
  570. SCSIPORTAPI
  571. ULONG
  572. NTAPI
  573. ScsiPortInitialize(
  574. IN PVOID Argument1,
  575. IN PVOID Argument2,
  576. IN struct _HW_INITIALIZATION_DATA *HwInitializationData,
  577. IN PVOID HwContext OPTIONAL);
  578. SCSIPORTAPI
  579. VOID
  580. NTAPI
  581. ScsiPortIoMapTransfer(
  582. IN PVOID HwDeviceExtension,
  583. IN PSCSI_REQUEST_BLOCK Srb,
  584. IN PVOID LogicalAddress,
  585. IN ULONG Length);
  586. SCSIPORTAPI
  587. VOID
  588. NTAPI
  589. ScsiPortLogError(
  590. IN PVOID HwDeviceExtension,
  591. IN PSCSI_REQUEST_BLOCK Srb OPTIONAL,
  592. IN UCHAR PathId,
  593. IN UCHAR TargetId,
  594. IN UCHAR Lun,
  595. IN ULONG ErrorCode,
  596. IN ULONG UniqueId);
  597. SCSIPORTAPI
  598. VOID
  599. __cdecl
  600. ScsiPortNotification(
  601. IN SCSI_NOTIFICATION_TYPE NotificationType,
  602. IN PVOID HwDeviceExtension,
  603. IN ...);
  604. SCSIPORTAPI
  605. VOID
  606. NTAPI
  607. ScsiPortQuerySystemTime(
  608. OUT PLARGE_INTEGER CurrentTime);
  609. SCSIPORTAPI
  610. ULONG
  611. NTAPI
  612. ScsiPortSetBusDataByOffset(
  613. IN PVOID DeviceExtension,
  614. IN ULONG BusDataType,
  615. IN ULONG SystemIoBusNumber,
  616. IN ULONG SlotNumber,
  617. IN PVOID Buffer,
  618. IN ULONG Offset,
  619. IN ULONG Length);
  620. SCSIPORTAPI
  621. VOID
  622. NTAPI
  623. ScsiPortStallExecution(
  624. IN ULONG Delay);
  625. SCSIPORTAPI
  626. BOOLEAN
  627. NTAPI
  628. ScsiPortValidateRange(
  629. IN PVOID HwDeviceExtension,
  630. IN INTERFACE_TYPE BusType,
  631. IN ULONG SystemIoBusNumber,
  632. IN SCSI_PHYSICAL_ADDRESS IoAddress,
  633. IN ULONG NumberOfBytes,
  634. IN BOOLEAN InIoSpace);
  635. SCSIPORTAPI
  636. VOID
  637. __cdecl
  638. ScsiDebugPrint(
  639. IN ULONG DebugPrintLevel,
  640. IN PCCHAR DebugMessage,
  641. IN ...);
  642. #if defined(_M_AMD64)
  643. #define ScsiPortReadPortUchar READ_PORT_UCHAR
  644. #define ScsiPortReadPortUshort READ_PORT_USHORT
  645. #define ScsiPortReadPortUlong READ_PORT_ULONG
  646. #define ScsiPortReadPortBufferUchar READ_PORT_BUFFER_UCHAR
  647. #define ScsiPortReadPortBufferUshort READ_PORT_BUFFER_USHORT
  648. #define ScsiPortReadPortBufferUlong READ_PORT_BUFFER_ULONG
  649. #define ScsiPortReadRegisterUchar READ_REGISTER_UCHAR
  650. #define ScsiPortReadRegisterUshort READ_REGISTER_USHORT
  651. #define ScsiPortReadRegisterUlong READ_REGISTER_ULONG
  652. #define ScsiPortReadRegisterBufferUchar READ_REGISTER_BUFFER_UCHAR
  653. #define ScsiPortReadRegisterBufferUshort READ_REGISTER_BUFFER_USHORT
  654. #define ScsiPortReadRegisterBufferUlong READ_REGISTER_BUFFER_ULONG
  655. #define ScsiPortWritePortUchar WRITE_PORT_UCHAR
  656. #define ScsiPortWritePortUshort WRITE_PORT_USHORT
  657. #define ScsiPortWritePortUlong WRITE_PORT_ULONG
  658. #define ScsiPortWritePortBufferUchar WRITE_PORT_BUFFER_UCHAR
  659. #define ScsiPortWritePortBufferUshort WRITE_PORT_BUFFER_USHORT
  660. #define ScsiPortWritePortBufferUlong WRITE_PORT_BUFFER_ULONG
  661. #define ScsiPortWriteRegisterUchar WRITE_REGISTER_UCHAR
  662. #define ScsiPortWriteRegisterUshort WRITE_REGISTER_USHORT
  663. #define ScsiPortWriteRegisterUlong WRITE_REGISTER_ULONG
  664. #define ScsiPortWriteRegisterBufferUchar WRITE_REGISTER_BUFFER_UCHAR
  665. #define ScsiPortWriteRegisterBufferUshort WRITE_REGISTER_BUFFER_USHORT
  666. #define ScsiPortWriteRegisterBufferUlong WRITE_REGISTER_BUFFER_ULONG
  667. #define ScsiPortMoveMemory memmove
  668. #else
  669. SCSIPORTAPI
  670. UCHAR
  671. NTAPI
  672. ScsiPortReadPortUchar(
  673. IN PUCHAR Port);
  674. SCSIPORTAPI
  675. ULONG
  676. NTAPI
  677. ScsiPortReadPortUlong(
  678. IN PULONG Port);
  679. SCSIPORTAPI
  680. USHORT
  681. NTAPI
  682. ScsiPortReadPortUshort(
  683. IN PUSHORT Port);
  684. SCSIPORTAPI
  685. VOID
  686. NTAPI
  687. ScsiPortReadPortBufferUchar(
  688. IN PUCHAR Port,
  689. IN PUCHAR Buffer,
  690. IN ULONG Count);
  691. SCSIPORTAPI
  692. VOID
  693. NTAPI
  694. ScsiPortReadPortBufferUlong(
  695. IN PULONG Port,
  696. IN PULONG Buffer,
  697. IN ULONG Count);
  698. SCSIPORTAPI
  699. VOID
  700. NTAPI
  701. ScsiPortReadPortBufferUshort(
  702. IN PUSHORT Port,
  703. IN PUSHORT Buffer,
  704. IN ULONG Count);
  705. SCSIPORTAPI
  706. UCHAR
  707. NTAPI
  708. ScsiPortReadRegisterUchar(
  709. IN PUCHAR Register);
  710. SCSIPORTAPI
  711. ULONG
  712. NTAPI
  713. ScsiPortReadRegisterUlong(
  714. IN PULONG Register);
  715. SCSIPORTAPI
  716. USHORT
  717. NTAPI
  718. ScsiPortReadRegisterUshort(
  719. IN PUSHORT Register);
  720. SCSIPORTAPI
  721. VOID
  722. NTAPI
  723. ScsiPortReadRegisterBufferUchar(
  724. IN PUCHAR Register,
  725. IN PUCHAR Buffer,
  726. IN ULONG Count);
  727. SCSIPORTAPI
  728. VOID
  729. NTAPI
  730. ScsiPortReadRegisterBufferUlong(
  731. IN PULONG Register,
  732. IN PULONG Buffer,
  733. IN ULONG Count);
  734. SCSIPORTAPI
  735. VOID
  736. NTAPI
  737. ScsiPortReadRegisterBufferUshort(
  738. IN PUSHORT Register,
  739. IN PUSHORT Buffer,
  740. IN ULONG Count);
  741. SCSIPORTAPI
  742. VOID
  743. NTAPI
  744. ScsiPortWritePortUchar(
  745. IN PUCHAR Port,
  746. IN UCHAR Value);
  747. SCSIPORTAPI
  748. VOID
  749. NTAPI
  750. ScsiPortWritePortUlong(
  751. IN PULONG Port,
  752. IN ULONG Value);
  753. SCSIPORTAPI
  754. VOID
  755. NTAPI
  756. ScsiPortWritePortUshort(
  757. IN PUSHORT Port,
  758. IN USHORT Value);
  759. SCSIPORTAPI
  760. VOID
  761. NTAPI
  762. ScsiPortWritePortBufferUchar(
  763. IN PUCHAR Port,
  764. IN PUCHAR Buffer,
  765. IN ULONG Count);
  766. SCSIPORTAPI
  767. VOID
  768. NTAPI
  769. ScsiPortWritePortBufferUlong(
  770. IN PULONG Port,
  771. IN PULONG Buffer,
  772. IN ULONG Count);
  773. SCSIPORTAPI
  774. VOID
  775. NTAPI
  776. ScsiPortWritePortBufferUshort(
  777. IN PUSHORT Port,
  778. IN PUSHORT Buffer,
  779. IN ULONG Count);
  780. SCSIPORTAPI
  781. VOID
  782. NTAPI
  783. ScsiPortWriteRegisterUchar(
  784. IN PUCHAR Register,
  785. IN UCHAR Value);
  786. SCSIPORTAPI
  787. VOID
  788. NTAPI
  789. ScsiPortWriteRegisterUlong(
  790. IN PULONG Register,
  791. IN ULONG Value);
  792. SCSIPORTAPI
  793. VOID
  794. NTAPI
  795. ScsiPortWriteRegisterUshort(
  796. IN PUSHORT Register,
  797. IN USHORT Value);
  798. SCSIPORTAPI
  799. VOID
  800. NTAPI
  801. ScsiPortWriteRegisterBufferUchar(
  802. IN PUCHAR Register,
  803. IN PUCHAR Buffer,
  804. IN ULONG Count);
  805. SCSIPORTAPI
  806. VOID
  807. NTAPI
  808. ScsiPortWriteRegisterBufferUlong(
  809. IN PULONG Register,
  810. IN PULONG Buffer,
  811. IN ULONG Count);
  812. SCSIPORTAPI
  813. VOID
  814. NTAPI
  815. ScsiPortWriteRegisterBufferUshort(
  816. IN PUSHORT Register,
  817. IN PUSHORT Buffer,
  818. IN ULONG Count);
  819. SCSIPORTAPI
  820. VOID
  821. NTAPI
  822. ScsiPortMoveMemory(
  823. IN PVOID WriteBuffer,
  824. IN PVOID ReadBuffer,
  825. IN ULONG Length);
  826. #endif /* defined(_M_AMD64) */
  827. #ifdef __cplusplus
  828. }
  829. #endif
  830. #endif /* _NTSRB_ */