6 * This file is part of the w32api package.
9 * Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
11 * THIS SOFTWARE IS NOT COPYRIGHTED
13 * This source code is offered for use in the public domain. You may
14 * use, modify or distribute it freely.
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.
27 #pragma GCC system_header
31 #error usbdi.h cannot be included with usb.h
40 typedef LONG USBD_STATUS
;
41 typedef PVOID USBD_PIPE_HANDLE
;
42 typedef PVOID USBD_CONFIGURATION_HANDLE
;
43 typedef PVOID USBD_INTERFACE_HANDLE
;
45 #define USBD_STATUS_SUCCESS ((USBD_STATUS)0x00000000L)
46 #define USBD_STATUS_PENDING ((USBD_STATUS)0x40000000L)
47 #define USBD_STATUS_CRC ((USBD_STATUS)0xC0000001L)
48 #define USBD_STATUS_BTSTUFF ((USBD_STATUS)0xC0000002L)
49 #define USBD_STATUS_DATA_TOGGLE_MISMATCH ((USBD_STATUS)0xC0000003L)
50 #define USBD_STATUS_STALL_PID ((USBD_STATUS)0xC0000004L)
51 #define USBD_STATUS_DEV_NOT_RESPONDING ((USBD_STATUS)0xC0000005L)
52 #define USBD_STATUS_PID_CHECK_FAILURE ((USBD_STATUS)0xC0000006L)
53 #define USBD_STATUS_UNEXPECTED_PID ((USBD_STATUS)0xC0000007L)
54 #define USBD_STATUS_DATA_OVERRUN ((USBD_STATUS)0xC0000008L)
55 #define USBD_STATUS_DATA_UNDERRUN ((USBD_STATUS)0xC0000009L)
56 #define USBD_STATUS_RESERVED1 ((USBD_STATUS)0xC000000AL)
57 #define USBD_STATUS_RESERVED2 ((USBD_STATUS)0xC000000BL)
58 #define USBD_STATUS_BUFFER_OVERRUN ((USBD_STATUS)0xC000000CL)
59 #define USBD_STATUS_BUFFER_UNDERRUN ((USBD_STATUS)0xC000000DL)
60 #define USBD_STATUS_NOT_ACCESSED ((USBD_STATUS)0xC000000FL)
61 #define USBD_STATUS_FIFO ((USBD_STATUS)0xC0000010L)
62 #define USBD_STATUS_XACT_ERROR ((USBD_STATUS)0xC0000011L)
63 #define USBD_STATUS_BABBLE_DETECTED ((USBD_STATUS)0xC0000012L)
64 #define USBD_STATUS_DATA_BUFFER_ERROR ((USBD_STATUS)0xC0000013L)
65 #define USBD_STATUS_ENDPOINT_HALTED ((USBD_STATUS)0xC0000030L)
66 #define USBD_STATUS_INVALID_URB_FUNCTION ((USBD_STATUS)0x80000200L)
67 #define USBD_STATUS_INVALID_PARAMETER ((USBD_STATUS)0x80000300L)
68 #define USBD_STATUS_ERROR_BUSY ((USBD_STATUS)0x80000400L)
69 #define USBD_STATUS_INVALID_PIPE_HANDLE ((USBD_STATUS)0x80000600L)
70 #define USBD_STATUS_NO_BANDWIDTH ((USBD_STATUS)0x80000700L)
71 #define USBD_STATUS_INTERNAL_HC_ERROR ((USBD_STATUS)0x80000800L)
72 #define USBD_STATUS_ERROR_SHORT_TRANSFER ((USBD_STATUS)0x80000900L)
73 #define USBD_STATUS_BAD_START_FRAME ((USBD_STATUS)0xC0000A00L)
74 #define USBD_STATUS_ISOCH_REQUEST_FAILED ((USBD_STATUS)0xC0000B00L)
75 #define USBD_STATUS_FRAME_CONTROL_OWNED ((USBD_STATUS)0xC0000C00L)
76 #define USBD_STATUS_FRAME_CONTROL_NOT_OWNED \
77 ((USBD_STATUS)0xC0000D00L)
78 #define USBD_STATUS_NOT_SUPPORTED ((USBD_STATUS)0xC0000E00L)
79 #define USBD_STATUS_INAVLID_CONFIGURATION_DESCRIPTOR \
80 ((USBD_STATUS)0xC0000F00L)
81 #define USBD_STATUS_INSUFFICIENT_RESOURCES \
82 ((USBD_STATUS)0xC0001000L)
83 #define USBD_STATUS_SET_CONFIG_FAILED ((USBD_STATUS)0xC0002000L)
84 #define USBD_STATUS_BUFFER_TOO_SMALL ((USBD_STATUS)0xC0003000L)
85 #define USBD_STATUS_INTERFACE_NOT_FOUND ((USBD_STATUS)0xC0004000L)
86 #define USBD_STATUS_INAVLID_PIPE_FLAGS ((USBD_STATUS)0xC0005000L)
87 #define USBD_STATUS_TIMEOUT ((USBD_STATUS)0xC0006000L)
88 #define USBD_STATUS_DEVICE_GONE ((USBD_STATUS)0xC0007000L)
89 #define USBD_STATUS_STATUS_NOT_MAPPED ((USBD_STATUS)0xC0008000L)
90 #define USBD_STATUS_CANCELED ((USBD_STATUS)0xC0010000L)
91 #define USBD_STATUS_ISO_NOT_ACCESSED_BY_HW \
92 ((USBD_STATUS)0xC0020000L)
93 #define USBD_STATUS_ISO_TD_ERROR ((USBD_STATUS)0xC0030000L)
94 #define USBD_STATUS_ISO_NA_LATE_USBPORT ((USBD_STATUS)0xC0040000L)
95 #define USBD_STATUS_ISO_NOT_ACCESSED_LATE ((USBD_STATUS)0xC0050000L)
97 #define USBD_SUCCESS(Status) ((USBD_STATUS)(Status) >= 0)
98 #define USBD_PENDING(Status) ((ULONG)(Status) >> 30 == 1)
99 #define USBD_ERROR(Status) ((USBD_STATUS)(Status) < 0)
101 /* URB TransferFlags constants */
102 #define USBD_TRANSFER_DIRECTION(x) ((x) & USBD_TRANSFER_DIRECTION_IN)
103 #define USBD_TRANSFER_DIRECTION_OUT 0
104 #define USBD_TRANSFER_DIRECTION_BIT 0
105 #define USBD_TRANSFER_DIRECTION_IN (1 << USBD_TRANSFER_DIRECTION_BIT)
106 #define USBD_SHORT_TRANSFER_OK_BIT 1
107 #define USBD_SHORT_TRANSFER_OK (1 << USBD_SHORT_TRANSFER_OK_BIT)
108 #define USBD_START_ISO_TRANSFER_ASAP_BIT 2
109 #define USBD_START_ISO_TRANSFER_ASAP (1 << USBD_START_ISO_TRANSFER_ASAP_BIT)
110 #define USBD_DEFAULT_PIPE_TRANSFER_BIT 3
111 #define USBD_DEFAULT_PIPE_TRANSFER (1 << USBD_DEFAULT_PIPE_TRANSFER_BIT)
113 #define USBD_TRANSFER_DIRECTION_FLAG(flags) ((flags) & USBD_TRANSFER_DIRECTION)
115 #define VALID_TRANSFER_FLAGS_MASK \
116 (USBD_SHORT_TRANSFER_OK | \
117 USBD_TRANSFER_DIRECTION | \
118 USBD_START_ISO_TRANSFER_ASAP | \
119 USBD_DEFAULT_PIPE_TRANSFER)
121 #define USB_DEFAULT_DEVICE_ADDRESS 0
122 #define USB_DEFAULT_ENDPOINT_ADDRESS 0
123 #define USB_DEFAULT_MAX_PACKET 64
124 #define USBD_ISO_START_FRAME_RANGE 1024
125 #define USBD_DEFAULT_MAXIMUM_TRANSFER_SIZE 0xFFFFFFFF
127 typedef enum _USB_CONTROLLER_FLAVOR
{
142 } USB_CONTROLLER_FLAVOR
;
148 PVOID UsbdDeviceHandle
;
152 typedef struct _USBD_VERSION_INFORMATION
{
154 ULONG Supported_USB_Version
;
155 } USBD_VERSION_INFORMATION
, *PUSBD_VERSION_INFORMATION
;
157 struct _URB_HCD_AREA
{
161 struct _URB_BULK_OR_INTERRUPT_TRANSFER
{
162 struct _URB_HEADER Hdr
;
163 USBD_PIPE_HANDLE PipeHandle
;
165 ULONG TransferBufferLength
;
166 PVOID TransferBuffer
;
167 PMDL TransferBufferMDL
;
168 struct _URB
*UrbLink
;
169 struct _URB_HCD_AREA hca
;
172 struct _URB_CONTROL_DESCRIPTOR_REQUEST
{
173 struct _URB_HEADER Hdr
;
176 ULONG TransferBufferLength
;
177 PVOID TransferBuffer
;
178 PMDL TransferBufferMDL
;
179 struct _URB
*UrbLink
;
180 struct _URB_HCD_AREA hca
;
183 UCHAR DescriptorType
;
188 struct _URB_CONTROL_FEATURE_REQUEST
{
189 struct _URB_HEADER Hdr
;
195 struct _URB
*UrbLink
;
196 struct _URB_HCD_AREA hca
;
198 USHORT FeatureSelector
;
203 struct _URB_CONTROL_GET_CONFIGURATION_REQUEST
{
204 struct _URB_HEADER Hdr
;
207 ULONG TransferBufferLength
;
208 PVOID TransferBuffer
;
209 PMDL TransferBufferMDL
;
210 struct _URB
*UrbLink
;
211 struct _URB_HCD_AREA hca
;
215 struct _URB_CONTROL_GET_INTERFACE_REQUEST
{
216 struct _URB_HEADER Hdr
;
219 ULONG TransferBufferLength
;
220 PVOID TransferBuffer
;
221 PMDL TransferBufferMDL
;
222 struct _URB
*UrbLink
;
223 struct _URB_HCD_AREA hca
;
229 struct _URB_CONTROL_GET_STATUS_REQUEST
{
230 struct _URB_HEADER Hdr
;
233 ULONG TransferBufferLength
;
234 PVOID TransferBuffer
;
235 PMDL TransferBufferMDL
;
236 struct _URB
*UrbLink
;
237 struct _URB_HCD_AREA hca
;
243 struct _URB_CONTROL_TRANSFER
{
244 struct _URB_HEADER Hdr
;
245 USBD_PIPE_HANDLE PipeHandle
;
247 ULONG TransferBufferLength
;
248 PVOID TransferBuffer
;
249 PMDL TransferBufferMDL
;
250 struct _URB
*UrbLink
;
251 struct _URB_HCD_AREA hca
;
252 UCHAR SetupPacket
[8];
255 struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST
{
256 struct _URB_HEADER Hdr
;
259 ULONG TransferBufferLength
;
260 PVOID TransferBuffer
;
261 PMDL TransferBufferMDL
;
262 struct _URB
*UrbLink
;
263 struct _URB_HCD_AREA hca
;
264 UCHAR RequestTypeReservedBits
;
271 struct _URB_FRAME_LENGTH_CONTROL
{
272 struct _URB_HEADER Hdr
;
275 struct _URB_GET_CURRENT_FRAME_NUMBER
{
276 struct _URB_HEADER Hdr
;
280 struct _URB_GET_FRAME_LENGTH
{
281 struct _URB_HEADER Hdr
;
286 typedef struct _USBD_ISO_PACKET_DESCRIPTOR
{
290 } USBD_ISO_PACKET_DESCRIPTOR
, *PUSBD_ISO_PACKET_DESCRIPTOR
;
292 struct _URB_ISOCH_TRANSFER
{
293 struct _URB_HEADER Hdr
;
294 USBD_PIPE_HANDLE PipeHandle
;
296 ULONG TransferBufferLength
;
297 PVOID TransferBuffer
;
298 PMDL TransferBufferMDL
;
299 struct _URB
*UrbLink
;
300 struct _URB_HCD_AREA hca
;
302 ULONG NumberOfPackets
;
304 USBD_ISO_PACKET_DESCRIPTOR IsoPacket
[1];
307 typedef enum _USBD_PIPE_TYPE
{
309 UsbdPipeTypeIsochronous
,
311 UsbdPipeTypeInterrupt
314 typedef struct _USBD_PIPE_INFORMATION
{
315 USHORT MaximumPacketSize
;
316 UCHAR EndpointAddress
;
318 USBD_PIPE_TYPE PipeType
;
319 USBD_PIPE_HANDLE PipeHandle
;
320 ULONG MaximumTransferSize
;
322 } USBD_PIPE_INFORMATION
, *PUSBD_PIPE_INFORMATION
;
324 #define USBD_PIPE_DIRECTION_IN(pipeInformation) \
325 ((pipeInformation)->EndpointAddress & USB_ENDPOINT_DIRECTION_MASK)
327 typedef struct _USBD_INTERFACE_INFORMATION
{
329 UCHAR InterfaceNumber
;
330 UCHAR AlternateSetting
;
335 USBD_INTERFACE_HANDLE InterfaceHandle
;
337 USBD_PIPE_INFORMATION Pipes
[1];
338 } USBD_INTERFACE_INFORMATION
, *PUSBD_INTERFACE_INFORMATION
;
340 struct _URB_SELECT_INTERFACE
{
341 struct _URB_HEADER Hdr
;
342 USBD_CONFIGURATION_HANDLE ConfigurationHandle
;
343 USBD_INTERFACE_INFORMATION Interface
;
346 struct _URB_SELECT_CONFIGURATION
{
347 struct _URB_HEADER Hdr
;
348 PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
;
349 USBD_CONFIGURATION_HANDLE ConfigurationHandle
;
350 USBD_INTERFACE_INFORMATION Interface
;
353 struct _URB_PIPE_REQUEST
{
354 struct _URB_HEADER Hdr
;
355 USBD_PIPE_HANDLE PipeHandle
;
359 struct _URB_SET_FRAME_LENGTH
{
360 struct _URB_HEADER Hdr
;
361 LONG FrameLengthDelta
;
364 typedef struct _URB
{
365 _ANONYMOUS_UNION
union {
366 struct _URB_HEADER UrbHeader
;
367 struct _URB_SELECT_INTERFACE UrbSelectInterface
;
368 struct _URB_SELECT_CONFIGURATION UrbSelectConfiguration
;
369 struct _URB_PIPE_REQUEST UrbPipeRequest
;
370 struct _URB_FRAME_LENGTH_CONTROL UrbFrameLengthControl
;
371 struct _URB_GET_FRAME_LENGTH UrbGetFrameLength
;
372 struct _URB_SET_FRAME_LENGTH UrbSetFrameLength
;
373 struct _URB_GET_CURRENT_FRAME_NUMBER UrbGetCurrentFrameNumber
;
374 struct _URB_CONTROL_TRANSFER UrbControlTransfer
;
375 struct _URB_BULK_OR_INTERRUPT_TRANSFER UrbBulkOrInterruptTransfer
;
376 struct _URB_ISOCH_TRANSFER UrbIsochronousTransfer
;
377 struct _URB_CONTROL_DESCRIPTOR_REQUEST UrbControlDescriptorRequest
;
378 struct _URB_CONTROL_GET_STATUS_REQUEST UrbControlGetStatusRequest
;
379 struct _URB_CONTROL_FEATURE_REQUEST UrbControlFeatureRequest
;
380 struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST UrbControlVendorClassRequest
;
381 struct _URB_CONTROL_GET_INTERFACE_REQUEST UrbControlGetInterfaceRequest
;
382 struct _URB_CONTROL_GET_CONFIGURATION_REQUEST UrbControlGetConfigurationRequest
;
386 #define URB_FROM_IRP(Irp) ((IoGetCurrentIrpStackLocation(Irp))->Parameters.Others.Argument1)
388 #define URB_FUNCTION_SELECT_CONFIGURATION 0x0000
389 #define URB_FUNCTION_SELECT_INTERFACE 0x0001
390 #define URB_FUNCTION_ABORT_PIPE 0x0002
391 #define URB_FUNCTION_TAKE_FRAME_LENGTH_CONTROL 0x0003
392 #define URB_FUNCTION_RELEASE_FRAME_LENGTH_CONTROL 0x0004
393 #define URB_FUNCTION_GET_FRAME_LENGTH 0x0005
394 #define URB_FUNCTION_SET_FRAME_LENGTH 0x0006
395 #define URB_FUNCTION_GET_CURRENT_FRAME_NUMBER 0x0007
396 #define URB_FUNCTION_CONTROL_TRANSFER 0x0008
397 #define URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER 0x0009
398 #define URB_FUNCTION_ISOCH_TRANSFER 0x000A
399 #define URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE 0x000B
400 #define URB_FUNCTION_SET_DESCRIPTOR_TO_DEVICE 0x000C
401 #define URB_FUNCTION_SET_FEATURE_TO_DEVICE 0x000D
402 #define URB_FUNCTION_SET_FEATURE_TO_INTERFACE 0x000E
403 #define URB_FUNCTION_SET_FEATURE_TO_ENDPOINT 0x000F
404 #define URB_FUNCTION_CLEAR_FEATURE_TO_DEVICE 0x0010
405 #define URB_FUNCTION_CLEAR_FEATURE_TO_INTERFACE 0x0011
406 #define URB_FUNCTION_CLEAR_FEATURE_TO_ENDPOINT 0x0012
407 #define URB_FUNCTION_GET_STATUS_FROM_DEVICE 0x0013
408 #define URB_FUNCTION_GET_STATUS_FROM_INTERFACE 0x0014
409 #define URB_FUNCTION_GET_STATUS_FROM_ENDPOINT 0x0015
410 #define URB_FUNCTION_RESERVED_0X0016 0x0016
411 #define URB_FUNCTION_VENDOR_DEVICE 0x0017
412 #define URB_FUNCTION_VENDOR_INTERFACE 0x0018
413 #define URB_FUNCTION_VENDOR_ENDPOINT 0x0019
414 #define URB_FUNCTION_CLASS_DEVICE 0x001A
415 #define URB_FUNCTION_CLASS_INTERFACE 0x001B
416 #define URB_FUNCTION_CLASS_ENDPOINT 0x001C
417 #define URB_FUNCTION_RESERVE_0X001D 0x001D
418 #define URB_FUNCTION_SYNC_RESET_PIPE_AND_CLEAR_STALL 0x001E
419 #define URB_FUNCTION_CLASS_OTHER 0x001F
420 #define URB_FUNCTION_VENDOR_OTHER 0x0020
421 #define URB_FUNCTION_GET_STATUS_FROM_OTHER 0x0021
422 #define URB_FUNCTION_CLEAR_FEATURE_TO_OTHER 0x0022
423 #define URB_FUNCTION_SET_FEATURE_TO_OTHER 0x0023
424 #define URB_FUNCTION_GET_DESCRIPTOR_FROM_ENDPOINT 0x0024
425 #define URB_FUNCTION_SET_DESCRIPTOR_TO_ENDPOINT 0x0025
426 #define URB_FUNCTION_GET_CONFIGURATION 0x0026
427 #define URB_FUNCTION_GET_INTERFACE 0x0027
428 #define URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE 0x0028
429 #define URB_FUNCTION_SET_DESCRIPTOR_TO_INTERFACE 0x0029
430 #define URB_FUNCTION_GET_MS_FEATURE_DESCRIPTOR 0x002A
431 #define URB_FUNCTION_RESERVE_0X002B 0x002B
432 #define URB_FUNCTION_RESERVE_0X002C 0x002C
433 #define URB_FUNCTION_RESERVE_0X002D 0x002D
434 #define URB_FUNCTION_RESERVE_0X002E 0x002E
435 #define URB_FUNCTION_RESERVE_0X002F 0x002F
436 #define URB_FUNCTION_SYNC_RESET_PIPE 0x0030
437 #define URB_FUNCTION_SYNC_CLEAR_STALL 0x0031
439 #define USBD_PF_CHANGE_MAX_PACKET 0x00000001
440 #define USBD_PF_SHORT_PACKET_OPT 0x00000002
441 #define USBD_PF_ENABLE_RT_THREAD_ACCESS 0x00000004
442 #define USBD_PF_MAP_ADD_TRANSFERS 0x00000008
444 #define USBD_PF_VALID_MASK (USBD_PF_CHANGE_MAX_PACKET | \
445 USBD_PF_SHORT_PACKET_OPT | \
446 USBD_PF_ENABLE_RT_THREAD_ACCESS | \
447 USBD_PF_MAP_ADD_TRANSFERS)
449 #define OS_STRING_DESCRIPTOR_INDEX 0xEE
451 #define MS_GENRE_DESCRIPTOR_INDEX 0x0001
452 #define MS_POWER_DESCRIPTOR_INDEX 0x0002
454 #define MS_OS_STRING_SIGNATURE L"MSFT100"
456 typedef struct _OS_STRING
{
458 UCHAR bDescriptorType
;
459 WCHAR MicrosoftString
[7];
462 } OS_STRING
, *POS_STRING
;
468 #endif /* defined __USBDI_H */