2 * PROJECT: ReactOS USB Port Driver
3 * LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+)
4 * PURPOSE: USBPort declarations
5 * COPYRIGHT: Copyright 2017 Vadim Galyant <vgal@rambler.ru>
15 #include <ntstrsafe.h>
21 #include <drivers/usbport/usbmport.h>
23 #define PCI_INTERFACE_USB_ID_UHCI 0x00
24 #define PCI_INTERFACE_USB_ID_OHCI 0x10
25 #define PCI_INTERFACE_USB_ID_EHCI 0x20
26 #define PCI_INTERFACE_USB_ID_XHCI 0x30
28 #ifdef USBD_TRANSFER_DIRECTION // due hubbusif.h included usbdi.h (Which overwrites...)
29 #undef USBD_TRANSFER_DIRECTION
30 #define USBD_TRANSFER_DIRECTION 0x00000001
33 #define USBPORT_RECIPIENT_HUB BMREQUEST_TO_DEVICE
34 #define USBPORT_RECIPIENT_PORT BMREQUEST_TO_OTHER
36 #define INVALIDATE_ENDPOINT_ONLY 0
37 #define INVALIDATE_ENDPOINT_WORKER_THREAD 1
38 #define INVALIDATE_ENDPOINT_WORKER_DPC 2
39 #define INVALIDATE_ENDPOINT_INT_NEXT_SOF 3
41 #define USBPORT_DMA_DIRECTION_FROM_DEVICE 1
42 #define USBPORT_DMA_DIRECTION_TO_DEVICE 2
44 #define USB_PORT_TAG 'pbsu'
45 #define URB_FUNCTION_MAX 0x31
47 /* Hub Class Feature Selectors (Recipient - Port) */
48 #define FEATURE_PORT_CONNECTION 0
49 #define FEATURE_PORT_ENABLE 1
50 #define FEATURE_PORT_SUSPEND 2
51 #define FEATURE_PORT_OVER_CURRENT 3
52 #define FEATURE_PORT_RESET 4
53 #define FEATURE_PORT_POWER 8
54 #define FEATURE_PORT_LOW_SPEED 9
55 #define FEATURE_C_PORT_CONNECTION 16
56 #define FEATURE_C_PORT_ENABLE 17
57 #define FEATURE_C_PORT_SUSPEND 18
58 #define FEATURE_C_PORT_OVER_CURRENT 19
59 #define FEATURE_C_PORT_RESET 20
61 /* Hub Class Feature Selectors (Recipient - Hub) */
62 #define FEATURE_C_HUB_LOCAL_POWER 0
63 #define FEATURE_C_HUB_OVER_CURRENT 1
66 #define USBPORT_FLAG_INT_CONNECTED 0x00000001
67 #define USBPORT_FLAG_HC_STARTED 0x00000002
68 #define USBPORT_FLAG_HC_POLLING 0x00000004
69 #define USBPORT_FLAG_WORKER_THREAD_ON 0x00000008
70 #define USBPORT_FLAG_HC_SUSPEND 0x00000100
71 #define USBPORT_FLAG_INTERRUPT_ENABLED 0x00000400
72 #define USBPORT_FLAG_SELECTIVE_SUSPEND 0x00000800
73 #define USBPORT_FLAG_DOS_SYMBOLIC_NAME 0x00010000
74 #define USBPORT_FLAG_LEGACY_SUPPORT 0x00080000
75 #define USBPORT_FLAG_HC_WAKE_SUPPORT 0x00200000
76 #define USBPORT_FLAG_DIAGNOSTIC_MODE 0x00800000 //IOCTL_USB_DIAGNOSTIC_MODE_ON
77 #define USBPORT_FLAG_COMPANION_HC 0x01000000
78 #define USBPORT_FLAG_REGISTERED_FDO 0x02000000
79 #define USBPORT_FLAG_NO_HACTION 0x04000000
80 #define USBPORT_FLAG_BIOS_DISABLE_SS 0x08000000 //Selective Suspend
81 #define USBPORT_FLAG_PWR_AND_CHIRP_LOCK 0x10000000
82 #define USBPORT_FLAG_POWER_AND_CHIRP_OK 0x40000000
83 #define USBPORT_FLAG_RH_INIT_CALLBACK 0x80000000
86 #define USBPORT_PNP_STATE_NOT_INIT 0x00000001
87 #define USBPORT_PNP_STATE_STARTED 0x00000002
88 #define USBPORT_PNP_STATE_FAILED 0x00000004
89 #define USBPORT_PNP_STATE_STOPPED 0x00000008
92 #define USBPORT_TMFLAG_TIMER_QUEUED 0x00000001
93 #define USBPORT_TMFLAG_HC_SUSPENDED 0x00000002
94 #define USBPORT_TMFLAG_HC_RESUME 0x00000004
95 #define USBPORT_TMFLAG_RH_SUSPENDED 0x00000008
96 #define USBPORT_TMFLAG_TIMER_STARTED 0x00000010
97 #define USBPORT_TMFLAG_WAKE 0x00000020
98 #define USBPORT_TMFLAG_IDLE_QUEUEITEM_ON 0x00000040
101 #define USBPORT_MPFLAG_INTERRUPTS_ENABLED 0x00000001
102 #define USBPORT_MPFLAG_SUSPENDED 0x00000002
104 /* Device handle Flags (USBPORT_DEVICE_HANDLE) */
105 #define DEVICE_HANDLE_FLAG_ROOTHUB 0x00000002
106 #define DEVICE_HANDLE_FLAG_REMOVED 0x00000008
107 #define DEVICE_HANDLE_FLAG_INITIALIZED 0x00000010
109 /* Endpoint Flags (USBPORT_ENDPOINT) */
110 #define ENDPOINT_FLAG_DMA_TYPE 0x00000001
111 #define ENDPOINT_FLAG_ROOTHUB_EP0 0x00000002
112 #define ENDPOINT_FLAG_NUKE 0x00000008
113 #define ENDPOINT_FLAG_QUEUENE_EMPTY 0x00000010
114 #define ENDPOINT_FLAG_ABORTING 0x00000020
115 #define ENDPOINT_FLAG_IDLE 0x00000100
116 #define ENDPOINT_FLAG_OPENED 0x00000200
117 #define ENDPOINT_FLAG_CLOSED 0x00000400
119 /* UsbdFlags Flags (URB) */
120 #define USBD_FLAG_ALLOCATED_MDL 0x00000002
121 #define USBD_FLAG_NOT_ISO_TRANSFER 0x00000010
122 #define USBD_FLAG_ALLOCATED_TRANSFER 0x00000020
124 /* Pipe handle Flags (USBPORT_PIPE_HANDLE) */
125 #define PIPE_HANDLE_FLAG_CLOSED 0x00000001
126 #define PIPE_HANDLE_FLAG_NULL_PACKET_SIZE 0x00000002
128 /* Transfer Flags (USBPORT_TRANSFER) */
129 #define TRANSFER_FLAG_CANCELED 0x00000001
130 #define TRANSFER_FLAG_DMA_MAPPED 0x00000002
131 #define TRANSFER_FLAG_HIGH_SPEED 0x00000004
132 #define TRANSFER_FLAG_SUBMITED 0x00000008
133 #define TRANSFER_FLAG_ABORTED 0x00000010
134 #define TRANSFER_FLAG_ISO 0x00000020
135 #define TRANSFER_FLAG_DEVICE_GONE 0x00000080
136 #define TRANSFER_FLAG_SPLITED 0x00000100
137 #define TRANSFER_FLAG_COMPLETED 0x00000200
138 #define TRANSFER_FLAG_PARENT 0x00000400
140 extern KSPIN_LOCK USBPORT_SpinLock
;
141 extern LIST_ENTRY USBPORT_MiniPortDrivers
;
143 typedef USBD_STATUS
* PUSBD_STATUS
;
145 typedef struct _USBPORT_COMMON_BUFFER_HEADER
{
148 PHYSICAL_ADDRESS LogicalAddress
;
150 ULONG_PTR VirtualAddress
;
151 ULONG_PTR PhysicalAddress
;
152 } USBPORT_COMMON_BUFFER_HEADER
, *PUSBPORT_COMMON_BUFFER_HEADER
;
154 typedef struct _USBPORT_ENDPOINT
*PUSBPORT_ENDPOINT
;
156 typedef struct _USB2_HC_EXTENSION
*PUSB2_HC_EXTENSION
;
157 typedef struct _USB2_TT
*PUSB2_TT
;
159 typedef struct _USBPORT_PIPE_HANDLE
{
162 USB_ENDPOINT_DESCRIPTOR EndpointDescriptor
;
164 PUSBPORT_ENDPOINT Endpoint
;
166 } USBPORT_PIPE_HANDLE
, *PUSBPORT_PIPE_HANDLE
;
168 typedef struct _USBPORT_CONFIGURATION_HANDLE
{
169 PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
;
170 LIST_ENTRY InterfaceHandleList
;
171 //USB_CONFIGURATION_DESCRIPTOR CfgDescriptor; // Body.
172 } USBPORT_CONFIGURATION_HANDLE
, *PUSBPORT_CONFIGURATION_HANDLE
;
174 typedef struct _USBPORT_INTERFACE_HANDLE
{
175 LIST_ENTRY InterfaceLink
;
176 UCHAR AlternateSetting
;
178 USB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
180 USBPORT_PIPE_HANDLE PipeHandle
[1];
181 } USBPORT_INTERFACE_HANDLE
, *PUSBPORT_INTERFACE_HANDLE
;
183 typedef struct _USBPORT_DEVICE_HANDLE
{
185 USHORT DeviceAddress
;
187 USBPORT_PIPE_HANDLE PipeHandle
;
190 LIST_ENTRY PipeHandleList
;
191 PUSBPORT_CONFIGURATION_HANDLE ConfigHandle
;
192 struct _USBPORT_DEVICE_HANDLE
*HubDeviceHandle
;
193 USB_DEVICE_DESCRIPTOR DeviceDescriptor
;
194 LIST_ENTRY DeviceHandleLink
;
195 LONG DeviceHandleLock
;
198 } USBPORT_DEVICE_HANDLE
, *PUSBPORT_DEVICE_HANDLE
;
200 typedef struct _USBPORT_ENDPOINT
{
202 PDEVICE_OBJECT FdoDevice
;
203 PUSBPORT_COMMON_BUFFER_HEADER HeaderBuffer
;
204 PUSBPORT_DEVICE_HANDLE DeviceHandle
;
205 USBPORT_ENDPOINT_PROPERTIES EndpointProperties
;
206 ULONG EndpointWorker
;
209 KSPIN_LOCK EndpointSpinLock
;
210 KIRQL EndpointOldIrql
;
211 KIRQL EndpointStateOldIrql
;
214 LONG FlushPendingLock
;
218 LIST_ENTRY StateChangeLink
;
219 KSPIN_LOCK StateChangeSpinLock
;
221 LIST_ENTRY PendingTransferList
;
222 LIST_ENTRY TransferList
;
223 LIST_ENTRY CancelList
;
224 LIST_ENTRY AbortList
;
226 LIST_ENTRY EndpointLink
;
227 LIST_ENTRY WorkerLink
;
228 LIST_ENTRY CloseLink
;
229 LIST_ENTRY DispatchLink
;
230 LIST_ENTRY FlushLink
;
231 LIST_ENTRY FlushControllerLink
;
232 LIST_ENTRY FlushAbortLink
;
233 } USBPORT_ENDPOINT
, *PUSBPORT_ENDPOINT
;
235 typedef struct _USBPORT_ISO_BLOCK
*PUSBPORT_ISO_BLOCK
;
237 typedef struct _USBPORT_TRANSFER
{
242 PVOID MiniportTransfer
;
243 SIZE_T PortTransferLength
; // Only port part
244 SIZE_T FullTransferLength
; // Port + miniport
245 PUSBPORT_ENDPOINT Endpoint
;
246 USBPORT_TRANSFER_PARAMETERS TransferParameters
;
247 PMDL TransferBufferMDL
;
249 LIST_ENTRY TransferLink
;
250 USBD_STATUS USBDStatus
;
251 ULONG CompletedTransferLen
;
252 ULONG NumberOfMapRegisters
;
253 PVOID MapRegisterBase
;
256 struct _USBPORT_TRANSFER
* ParentTransfer
;
257 KSPIN_LOCK TransferSpinLock
;
258 LIST_ENTRY SplitTransfersList
; // for parent transfers
259 LIST_ENTRY SplitLink
; // for splitted transfers
261 PUSBPORT_ISO_BLOCK IsoBlockPtr
; // pointer on IsoBlock
262 // SgList should be LAST field
263 USBPORT_SCATTER_GATHER_LIST SgList
; // variable length
264 //USBPORT_ISO_BLOCK IsoBlock; // variable length
265 } USBPORT_TRANSFER
, *PUSBPORT_TRANSFER
;
267 typedef struct _USBPORT_IRP_TABLE
{
268 struct _USBPORT_IRP_TABLE
* LinkNextTable
;
270 } USBPORT_IRP_TABLE
, *PUSBPORT_IRP_TABLE
;
272 typedef struct _USBPORT_COMMON_DEVICE_EXTENSION
{
273 PDEVICE_OBJECT SelfDevice
;
274 PDEVICE_OBJECT LowerPdoDevice
; // PhysicalDeviceObject
275 PDEVICE_OBJECT LowerDevice
; // TopOfStackDeviceObject
277 UNICODE_STRING SymbolicLinkName
;
278 BOOL IsInterfaceEnabled
;
279 DEVICE_POWER_STATE DevicePowerState
;
281 } USBPORT_COMMON_DEVICE_EXTENSION
, *PUSBPORT_COMMON_DEVICE_EXTENSION
;
283 typedef struct _USBPORT_DEVICE_EXTENSION
{
284 USBPORT_COMMON_DEVICE_EXTENSION CommonExtension
;
286 PDEVICE_OBJECT RootHubPdo
; // RootHubDeviceObject
287 KSPIN_LOCK RootHubCallbackSpinLock
;
288 LONG RHInitCallBackLock
;
289 LONG ChirpRootPortLock
;
290 KSEMAPHORE ControllerSemaphore
;
292 UNICODE_STRING DosDeviceSymbolicName
;
294 LIST_ENTRY ControllerLink
;
295 ULONG CommonBufferLimit
;
299 PUSBPORT_MINIPORT_INTERFACE MiniPortInterface
;
300 USBPORT_RESOURCES UsbPortResources
;
301 PUSBPORT_COMMON_BUFFER_HEADER MiniPortCommonBuffer
;
302 KSPIN_LOCK MiniportSpinLock
;
304 BUS_INTERFACE_STANDARD BusInterface
;
312 PDMA_ADAPTER DmaAdapter
;
315 PKINTERRUPT InterruptObject
;
318 LONG IsrDpcHandlerCounter
;
319 KSPIN_LOCK MiniportInterruptsSpinLock
;
320 KTIMER TimerSoftInterrupt
;
321 KDPC SoftInterruptDpc
;
323 ULONG PeriodicEndpoints
;
324 LIST_ENTRY EndpointList
;
325 KSPIN_LOCK EndpointListSpinLock
;
326 LIST_ENTRY EpStateChangeList
;
327 KSPIN_LOCK EpStateChangeSpinLock
;
328 LIST_ENTRY EndpointClosedList
;
329 KSPIN_LOCK EndpointClosedSpinLock
;
330 LIST_ENTRY WorkerList
;
332 LIST_ENTRY MapTransferList
;
333 KSPIN_LOCK MapTransferSpinLock
;
334 LIST_ENTRY DoneTransferList
;
335 KSPIN_LOCK DoneTransferSpinLock
;
336 KDPC TransferFlushDpc
;
337 KSPIN_LOCK FlushTransferSpinLock
;
338 KSPIN_LOCK FlushPendingTransferSpinLock
;
340 ULONG TimerValue
; // Timer period (500) msec. default
344 KSPIN_LOCK TimerFlagsSpinLock
;
346 PRKTHREAD WorkerThread
;
347 HANDLE WorkerThreadHandle
;
348 KEVENT WorkerThreadEvent
;
349 KSPIN_LOCK WorkerThreadEventSpinLock
;
351 ULONG UsbAddressBitMap
[4];
352 LIST_ENTRY DeviceHandleList
;
353 KSPIN_LOCK DeviceHandleSpinLock
;
354 KSEMAPHORE DeviceSemaphore
;
355 /* Device Capabilities */
356 DEVICE_CAPABILITIES Capabilities
;
358 ULONG PciDeviceNumber
;
359 ULONG PciFunctionNumber
;
360 ULONG TotalBusBandwidth
;
362 LARGE_INTEGER IdleTime
;
364 KSPIN_LOCK IdleIoCsqSpinLock
;
365 LIST_ENTRY IdleIrpList
;
366 LONG IdleLockCounter
;
368 IO_CSQ BadRequestIoCsq
;
369 KSPIN_LOCK BadRequestIoCsqSpinLock
;
370 LIST_ENTRY BadRequestList
;
371 LONG BadRequestLockCounter
;
373 PUSBPORT_IRP_TABLE PendingIrpTable
;
374 PUSBPORT_IRP_TABLE ActiveIrpTable
;
376 LONG SetPowerLockCounter
;
377 KSPIN_LOCK PowerWakeSpinLock
;
378 KSPIN_LOCK SetPowerD0SpinLock
;
379 KDPC WorkerRequestDpc
;
381 /* Usb 2.0 HC Extension */
382 PUSB2_HC_EXTENSION Usb2Extension
;
385 /* Miniport extension should be aligned on 0x100 */
392 } USBPORT_DEVICE_EXTENSION
, *PUSBPORT_DEVICE_EXTENSION
;
395 C_ASSERT(sizeof(USBPORT_DEVICE_EXTENSION
) == 0x400);
397 C_ASSERT(sizeof(USBPORT_DEVICE_EXTENSION
) == 0x600);
400 typedef struct _USBPORT_RH_DESCRIPTORS
{
401 USB_DEVICE_DESCRIPTOR DeviceDescriptor
;
402 USB_CONFIGURATION_DESCRIPTOR ConfigDescriptor
;
403 USB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
404 USB_ENDPOINT_DESCRIPTOR EndPointDescriptor
;
405 USB_HUB_DESCRIPTOR Descriptor
; // Size may be: 7 + 2[1..32] (7 + 2..64)
406 } USBPORT_RH_DESCRIPTORS
, *PUSBPORT_RH_DESCRIPTORS
;
408 typedef struct _USBPORT_RHDEVICE_EXTENSION
{
409 USBPORT_COMMON_DEVICE_EXTENSION CommonExtension
;
411 PDEVICE_OBJECT FdoDevice
;
413 USBPORT_DEVICE_HANDLE DeviceHandle
;
414 PUSBPORT_RH_DESCRIPTORS RootHubDescriptors
;
415 PUSBPORT_ENDPOINT Endpoint
;
416 ULONG ConfigurationValue
;
417 PRH_INIT_CALLBACK RootHubInitCallback
;
418 PVOID RootHubInitContext
;
419 DEVICE_CAPABILITIES Capabilities
;
421 } USBPORT_RHDEVICE_EXTENSION
, *PUSBPORT_RHDEVICE_EXTENSION
;
423 typedef struct _USBPORT_ASYNC_CALLBACK_DATA
{
425 PDEVICE_OBJECT FdoDevice
;
428 ASYNC_TIMER_CALLBACK
*CallbackFunction
;
429 ULONG CallbackContext
;
430 } USBPORT_ASYNC_CALLBACK_DATA
, *PUSBPORT_ASYNC_CALLBACK_DATA
;
432 C_ASSERT(sizeof(USBPORT_ASYNC_CALLBACK_DATA
) == 16 + 18 * sizeof(PVOID
));
434 typedef struct _TIMER_WORK_QUEUE_ITEM
{
435 WORK_QUEUE_ITEM WqItem
;
436 PDEVICE_OBJECT FdoDevice
;
438 } TIMER_WORK_QUEUE_ITEM
, *PTIMER_WORK_QUEUE_ITEM
;
440 /* Transaction Translator */
441 /* See Chapter 5 - USB Data Flow Model and Chapter 11 - Hub Specification */
443 #define USB2_FRAMES 32
444 #define USB2_MICROFRAMES 8
445 #define USB2_MAX_MICROFRAMES (USB2_FRAMES * USB2_MICROFRAMES)
447 #define USB2_MAX_MICROFRAME_ALLOCATION 7000 // bytes
448 #define USB2_CONTROLLER_DELAY 100
449 #define USB2_FS_MAX_PERIODIC_ALLOCATION 1157 // ((12000 / 8 bits) * 0.9) / (7/6) - 90% max, and bits stuffing
450 #define USB2_FS_SOF_TIME 6
451 #define USB2_HUB_DELAY 30
452 #define USB2_MAX_FS_LS_TRANSACTIONS_IN_UFRAME 16
453 #define USB2_FS_RAW_BYTES_IN_MICROFRAME 188 // (12000 / 8 bits / USB2_MICROFRAMES) = 187,5. But we use "best case budget"
456 #define USB2_LS_INTERRUPT_OVERHEAD 117 // FS-bytes
457 #define USB2_FS_INTERRUPT_OVERHEAD 13
458 #define USB2_HS_INTERRUPT_OUT_OVERHEAD 45
459 #define USB2_HS_INTERRUPT_IN_OVERHEAD 25
460 #define USB2_FS_ISOCHRONOUS_OVERHEAD 9
461 #define USB2_HS_ISOCHRONOUS_OUT_OVERHEAD 38
462 #define USB2_HS_ISOCHRONOUS_IN_OVERHEAD 18
464 typedef union _USB2_TT_ENDPOINT_PARAMS
{
466 ULONG TransferType
: 4;
468 USB_DEVICE_SPEED DeviceSpeed
: 2;
469 ULONG EndpointMoved
: 1;
473 } USB2_TT_ENDPOINT_PARAMS
;
475 C_ASSERT(sizeof(USB2_TT_ENDPOINT_PARAMS
) == sizeof(ULONG
));
477 typedef union _USB2_TT_ENDPOINT_NUMS
{
480 ULONG NumCompletes
: 4;
484 } USB2_TT_ENDPOINT_NUMS
;
486 C_ASSERT(sizeof(USB2_TT_ENDPOINT_NUMS
) == sizeof(ULONG
));
488 typedef struct _USB2_TT_ENDPOINT
{
490 PUSBPORT_ENDPOINT Endpoint
;
491 struct _USB2_TT_ENDPOINT
* NextTtEndpoint
;
492 USB2_TT_ENDPOINT_PARAMS TtEndpointParams
;
493 USB2_TT_ENDPOINT_NUMS Nums
;
494 USHORT MaxPacketSize
;
495 USHORT PreviosPeriod
;
502 UCHAR StartMicroframe
;
503 } USB2_TT_ENDPOINT
, *PUSB2_TT_ENDPOINT
;
505 typedef struct _USB2_FRAME_BUDGET
{
506 PUSB2_TT_ENDPOINT IsoEndpoint
;
507 PUSB2_TT_ENDPOINT IntEndpoint
;
508 PUSB2_TT_ENDPOINT AltEndpoint
;
511 } USB2_FRAME_BUDGET
, *PUSB2_FRAME_BUDGET
;
513 typedef struct _USB2_TT
{
514 PUSB2_HC_EXTENSION HcExtension
;
517 USB2_TT_ENDPOINT IntEndpoint
[USB2_FRAMES
];
518 USB2_TT_ENDPOINT IsoEndpoint
[USB2_FRAMES
];
519 USB2_FRAME_BUDGET FrameBudget
[USB2_FRAMES
];
520 ULONG NumStartSplits
[USB2_FRAMES
][USB2_MICROFRAMES
];
521 ULONG TimeCS
[USB2_FRAMES
][USB2_MICROFRAMES
];
522 } USB2_TT
, *PUSB2_TT
;
524 typedef struct _USB2_TT_EXTENSION
{
525 PDEVICE_OBJECT RootHubPdo
;
528 ULONG Bandwidth
[USB2_FRAMES
];
531 USHORT DeviceAddress
;
536 } USB2_TT_EXTENSION
, *PUSB2_TT_EXTENSION
;
538 typedef struct _USB2_HC_EXTENSION
{
539 ULONG MaxHsBusAllocation
;
541 ULONG TimeUsed
[USB2_FRAMES
][USB2_MICROFRAMES
];
543 } USB2_HC_EXTENSION
, *PUSB2_HC_EXTENSION
;
548 USBPORT_USBDStatusToNtStatus(
550 IN USBD_STATUS USBDStatus
);
555 IN PVOID MiniPortExtension
,
556 IN ULONG Milliseconds
);
560 USBPORT_TransferFlushDpc(
562 IN PVOID DeferredContext
,
563 IN PVOID SystemArgument1
,
564 IN PVOID SystemArgument2
);
568 USBPORT_CreateWorkerThread(
569 IN PDEVICE_OBJECT FdoDevice
);
574 IN PDEVICE_OBJECT FdoDevice
,
577 PUSBPORT_COMMON_BUFFER_HEADER
579 USBPORT_AllocateCommonBuffer(
580 IN PDEVICE_OBJECT FdoDevice
,
581 IN SIZE_T BufferLength
);
585 USBPORT_FreeCommonBuffer(
586 IN PDEVICE_OBJECT FdoDevice
,
587 IN PUSBPORT_COMMON_BUFFER_HEADER HeaderBuffer
);
591 USBPORT_AllocateTransfer(
592 IN PDEVICE_OBJECT FdoDevice
,
594 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
600 USBPORT_FlushMapTransfers(
601 IN PDEVICE_OBJECT FdoDevice
);
607 IN PVOID DeferredContext
,
608 IN PVOID SystemArgument1
,
609 IN PVOID SystemArgument2
);
613 USBPORT_InterruptService(
614 IN PKINTERRUPT Interrupt
,
615 IN PVOID ServiceContext
);
619 USBPORT_SignalWorkerThread(
620 IN PDEVICE_OBJECT FdoDevice
);
624 USBPORT_CompleteTransfer(
626 IN USBD_STATUS TransferStatus
);
631 IN PDEVICE_OBJECT FdoDevice
);
635 USBPORT_WorkerRequestDpc(
637 IN PVOID DeferredContext
,
638 IN PVOID SystemArgument1
,
639 IN PVOID SystemArgument2
);
643 USBPORT_QueueDoneTransfer(
644 IN PUSBPORT_TRANSFER Transfer
,
645 IN USBD_STATUS USBDStatus
);
649 USBPORT_MiniportInterrupts(
650 IN PDEVICE_OBJECT FdoDevice
,
651 IN BOOLEAN IsEnable
);
655 USBPORT_SetRegistryKeyValue(
656 IN PDEVICE_OBJECT DeviceObject
,
657 IN BOOL UseDriverKey
,
659 IN PCWSTR ValueNameString
,
665 USBPORT_GetRegistryKeyValueFullInfo(
666 IN PDEVICE_OBJECT FdoDevice
,
667 IN PDEVICE_OBJECT PdoDevice
,
668 IN BOOL UseDriverKey
,
669 IN PCWSTR SourceString
,
672 IN ULONG NumberOfBytes
);
677 IN PDEVICE_OBJECT FdoDevice
);
682 IN PDEVICE_OBJECT FdoDevice
);
686 USBPORT_RemoveUSBxFdo(
687 IN PDEVICE_OBJECT FdoDevice
);
691 USBPORT_FindUSB2Controller(
692 IN PDEVICE_OBJECT FdoDevice
);
696 USBPORT_FindCompanionControllers(
697 IN PDEVICE_OBJECT USB2FdoDevice
,
698 IN BOOLEAN IsObRefer
,
699 IN BOOLEAN IsFDOsReturned
);
703 USBPORT_InvalidateControllerHandler(
704 IN PDEVICE_OBJECT FdoDevice
,
709 USBPORT_DoneTransfer(
710 IN PUSBPORT_TRANSFER Transfer
);
716 IN PVOID MiniPortExtension
,
723 USBPORT_TestDebugBreak(
724 IN PVOID MiniPortExtension
);
728 USBPORT_AssertFailure(
729 PVOID MiniPortExtension
,
730 PVOID FailedAssertion
,
738 IN PVOID MiniPortExtension
);
743 IN PVOID MiniPortExtension
,
752 USBPORT_DumpingDeviceDescriptor(
753 IN PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
);
757 USBPORT_DumpingConfiguration(
758 IN PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptor
);
762 USBPORT_DumpingCapabilities(
763 IN PDEVICE_CAPABILITIES Capabilities
);
767 USBPORT_DumpingSetupPacket(
768 IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
);
783 USBPORT_HandleSelectConfiguration(
784 IN PDEVICE_OBJECT FdoDevice
,
790 USBPORT_AddDeviceHandle(
791 IN PDEVICE_OBJECT FdoDevice
,
792 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
);
796 USBPORT_RemoveDeviceHandle(
797 IN PDEVICE_OBJECT FdoDevice
,
798 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
);
802 USBPORT_ValidateDeviceHandle(
803 IN PDEVICE_OBJECT FdoDevice
,
804 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
);
808 USBPORT_CreateDevice(
809 IN OUT PUSB_DEVICE_HANDLE
*pUsbdDeviceHandle
,
810 IN PDEVICE_OBJECT FdoDevice
,
811 IN PUSBPORT_DEVICE_HANDLE HubDeviceHandle
,
812 IN USHORT PortStatus
,
817 USBPORT_InitializeDevice(
818 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
819 IN PDEVICE_OBJECT FdoDevice
);
823 USBPORT_GetUsbDescriptor(
824 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
825 IN PDEVICE_OBJECT FdoDevice
,
827 IN PUCHAR ConfigDesc
,
828 IN PULONG ConfigDescSize
);
832 USBPORT_HandleSelectInterface(
833 IN PDEVICE_OBJECT FdoDevice
,
839 USBPORT_RemoveDevice(
840 IN PDEVICE_OBJECT FdoDevice
,
841 IN OUT PUSBPORT_DEVICE_HANDLE DeviceHandle
,
846 USBPORT_SendSetupPacket(
847 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
848 IN PDEVICE_OBJECT FdoDevice
,
849 IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
,
852 IN OUT PULONG TransferedLen
,
853 IN OUT PUSBD_STATUS pUSBDStatus
);
857 USBPORT_RestoreDevice(
858 IN PDEVICE_OBJECT FdoDevice
,
859 IN OUT PUSBPORT_DEVICE_HANDLE OldDeviceHandle
,
860 IN OUT PUSBPORT_DEVICE_HANDLE NewDeviceHandle
);
864 USBPORT_Initialize20Hub(
865 IN PDEVICE_OBJECT FdoDevice
,
866 IN PUSBPORT_DEVICE_HANDLE HubDeviceHandle
,
873 IN PDEVICE_OBJECT FdoDevice
,
874 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
875 IN PUSBPORT_PIPE_HANDLE PipeHandle
,
876 IN PUSBD_STATUS UsbdStatus
);
880 MiniportOpenEndpoint(
881 IN PDEVICE_OBJECT FdoDevice
,
882 IN PUSBPORT_ENDPOINT Endpoint
);
887 IN PDEVICE_OBJECT FdoDevice
,
888 IN PUSBPORT_ENDPOINT Endpoint
);
893 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
894 IN PDEVICE_OBJECT FdoDevice
,
895 IN PUSBPORT_PIPE_HANDLE PipeHandle
);
899 MiniportCloseEndpoint(
900 IN PDEVICE_OBJECT FdoDevice
,
901 IN PUSBPORT_ENDPOINT Endpoint
);
905 USBPORT_AddPipeHandle(
906 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
907 IN PUSBPORT_PIPE_HANDLE PipeHandle
);
911 USBPORT_RemovePipeHandle(
912 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
913 IN PUSBPORT_PIPE_HANDLE PipeHandle
);
917 USBPORT_ValidatePipeHandle(
918 IN PUSBPORT_DEVICE_HANDLE DeviceHandle
,
919 IN PUSBPORT_PIPE_HANDLE PipeHandle
);
923 USBPORT_FlushClosedEndpointList(
924 IN PDEVICE_OBJECT FdoDevice
);
928 USBPORT_SetEndpointState(
929 IN PUSBPORT_ENDPOINT Endpoint
,
934 USBPORT_GetEndpointState(
935 IN PUSBPORT_ENDPOINT Endpoint
);
939 USBPORT_InvalidateEndpointHandler(
940 IN PDEVICE_OBJECT FdoDevice
,
941 IN PUSBPORT_ENDPOINT Endpoint
,
946 USBPORT_EndpointWorker(
947 IN PUSBPORT_ENDPOINT Endpoint
,
952 USBPORT_NukeAllEndpoints(
953 IN PDEVICE_OBJECT FdoDevice
);
957 USBPORT_EndpointHasQueuedTransfers(
958 IN PDEVICE_OBJECT FdoDevice
,
959 IN PUSBPORT_ENDPOINT Endpoint
,
960 IN PULONG TransferCount
);
965 USBPORT_PdoQueryInterface(
966 IN PDEVICE_OBJECT FdoDevice
,
967 IN PDEVICE_OBJECT PdoDevice
,
973 USBPORT_PdoDeviceControl(
974 PDEVICE_OBJECT PdoDevice
,
979 USBPORT_FdoDeviceControl(
980 PDEVICE_OBJECT FdoDevice
,
985 USBPORT_FdoInternalDeviceControl(
986 IN PDEVICE_OBJECT FdoDevice
,
991 USBPORT_PdoInternalDeviceControl(
992 IN PDEVICE_OBJECT FdoDevice
,
997 USBPORT_GetSymbolicName(
998 IN PDEVICE_OBJECT RootHubPdo
,
999 IN PUNICODE_STRING DestinationString
);
1004 USBPORT_InitializeIsoTransfer(
1005 IN PDEVICE_OBJECT FdoDevice
,
1006 IN
struct _URB_ISOCH_TRANSFER
* Urb
,
1007 IN PUSBPORT_TRANSFER Transfer
);
1011 USBPORT_CompleteIsoTransfer(
1012 IN PVOID MiniPortExtension
,
1013 IN PVOID MiniPortEndpoint
,
1014 IN PVOID TransferParameters
,
1015 IN ULONG TransferLength
);
1021 IN PDEVICE_OBJECT FdoDevice
,
1027 IN PDEVICE_OBJECT FdoDevice
,
1034 IN PDEVICE_OBJECT PdoDevice
,
1040 IN PDEVICE_OBJECT FdoDevice
,
1045 USBPORT_IdleNotification(
1046 IN PDEVICE_OBJECT PdoDevice
,
1051 USBPORT_AdjustDeviceCapabilities(
1052 IN PDEVICE_OBJECT FdoDevice
,
1053 IN PDEVICE_OBJECT PdoDevice
);
1057 USBPORT_DoIdleNotificationCallback(
1062 USBPORT_CompletePdoWaitWake(
1063 IN PDEVICE_OBJECT FdoDevice
);
1067 USBPORT_DoSetPowerD0(
1068 IN PDEVICE_OBJECT FdoDevice
);
1074 IN PVOID DeferredContext
,
1075 IN PVOID SystemArgument1
,
1076 IN PVOID SystemArgument2
);
1080 USBPORT_HcQueueWakeDpc(
1081 IN PDEVICE_OBJECT FdoDevice
);
1086 USBPORT_InsertIdleIrp(
1092 USBPORT_RemoveIdleIrp(
1098 USBPORT_PeekNextIdleIrp(
1101 IN PVOID PeekContext
);
1105 USBPORT_AcquireIdleLock(
1111 USBPORT_ReleaseIdleLock(
1117 USBPORT_CompleteCanceledIdleIrp(
1123 USBPORT_InsertBadRequest(
1129 USBPORT_RemoveBadRequest(
1135 USBPORT_PeekNextBadRequest(
1138 IN PVOID PeekContext
);
1142 USBPORT_AcquireBadRequestLock(
1148 USBPORT_ReleaseBadRequestLock(
1154 USBPORT_CompleteCanceledBadRequest(
1160 USBPORT_InsertIrpInTable(
1161 IN PUSBPORT_IRP_TABLE IrpTable
,
1166 USBPORT_RemovePendingTransferIrp(
1167 IN PDEVICE_OBJECT FdoDevice
,
1172 USBPORT_RemoveActiveTransferIrp(
1173 IN PDEVICE_OBJECT FdoDevice
,
1178 USBPORT_FindUrbInIrpTable(
1179 IN PUSBPORT_IRP_TABLE IrpTable
,
1185 USBPORT_CancelActiveTransferIrp(
1186 IN PDEVICE_OBJECT DeviceObject
,
1191 USBPORT_FlushAbortList(
1192 IN PUSBPORT_ENDPOINT Endpoint
);
1196 USBPORT_FlushCancelList(
1197 IN PUSBPORT_ENDPOINT Endpoint
);
1201 USBPORT_QueueTransferUrb(
1206 USBPORT_FlushAllEndpoints(
1207 IN PDEVICE_OBJECT FdoDevice
);
1211 USBPORT_FlushPendingTransfers(
1212 IN PUSBPORT_ENDPOINT Endpoint
);
1216 USBPORT_QueueActiveUrbToEndpoint(
1217 IN PUSBPORT_ENDPOINT Endpoint
,
1222 USBPORT_FlushController(
1223 IN PDEVICE_OBJECT FdoDevice
);
1227 USBPORT_BadRequestFlush(
1228 IN PDEVICE_OBJECT FdoDevice
);
1232 USBPORT_AbortEndpoint(
1233 IN PDEVICE_OBJECT FdoDevice
,
1234 IN PUSBPORT_ENDPOINT Endpoint
,
1240 USBPORT_RootHubEndpointWorker(
1241 PUSBPORT_ENDPOINT Endpoint
);
1245 USBPORT_RootHubCreateDevice(
1246 IN PDEVICE_OBJECT FdoDevice
,
1247 IN PDEVICE_OBJECT PdoDevice
);
1251 USBPORT_InvalidateRootHub(
1252 PVOID MiniPortExtension
);
1256 USBPORT_RootHubPowerAndChirpAllCcPorts(
1257 IN PDEVICE_OBJECT FdoDevice
);
1262 USBPORT_SplitTransfer(
1263 IN PDEVICE_OBJECT FdoDevice
,
1264 IN PUSBPORT_ENDPOINT Endpoint
,
1265 IN PUSBPORT_TRANSFER Transfer
,
1266 IN PLIST_ENTRY List
);
1270 USBPORT_DoneSplitTransfer(
1271 IN PUSBPORT_TRANSFER SplitTransfer
);
1275 USBPORT_CancelSplitTransfer(
1276 IN PUSBPORT_TRANSFER SplitTransfer
);
1281 USBPORT_HandleSubmitURB(
1282 IN PDEVICE_OBJECT PdoDevice
,
1289 USBPORT_AllocateBandwidthUSB2(
1290 IN PDEVICE_OBJECT FdoDevice
,
1291 IN PUSBPORT_ENDPOINT Endpoint
);
1295 USBPORT_FreeBandwidthUSB2(
1296 IN PDEVICE_OBJECT FdoDevice
,
1297 IN PUSBPORT_ENDPOINT Endpoint
);
1301 USBPORT_UpdateAllocatedBwTt(
1302 IN PUSB2_TT_EXTENSION TtExtension
);
1307 IN PUSB2_HC_EXTENSION HcExtension
,
1312 USB2_InitController(
1313 IN PUSB2_HC_EXTENSION HcExtension
);
1315 #endif /* USBPORT_H__ */