4 #define USBPORT_HCI_MN 0x10000001
7 #define USBPORT_TRANSFER_TYPE_ISOCHRONOUS 0
8 #define USBPORT_TRANSFER_TYPE_CONTROL 1
9 #define USBPORT_TRANSFER_TYPE_BULK 2
10 #define USBPORT_TRANSFER_TYPE_INTERRUPT 3
13 #define USBPORT_ENDPOINT_UNKNOWN 0
14 #define USBPORT_ENDPOINT_PAUSED 2
15 #define USBPORT_ENDPOINT_ACTIVE 3
16 #define USBPORT_ENDPOINT_REMOVE 4
17 #define USBPORT_ENDPOINT_CLOSED 5
20 #define USBPORT_ENDPOINT_RUN 0
21 #define USBPORT_ENDPOINT_HALT 1
22 #define USBPORT_ENDPOINT_CONTROL 4
24 /* Interrupt Endpoint Poll Interval */
25 #define ENDPOINT_INTERRUPT_1ms 1
26 #define ENDPOINT_INTERRUPT_2ms 2
27 #define ENDPOINT_INTERRUPT_4ms 4
28 #define ENDPOINT_INTERRUPT_8ms 8
29 #define ENDPOINT_INTERRUPT_16ms 16
30 #define ENDPOINT_INTERRUPT_32ms 32
32 #define INTERRUPT_ENDPOINTs (ENDPOINT_INTERRUPT_32ms + \
33 ENDPOINT_INTERRUPT_16ms + \
34 ENDPOINT_INTERRUPT_8ms + \
35 ENDPOINT_INTERRUPT_4ms + \
36 ENDPOINT_INTERRUPT_2ms + \
37 ENDPOINT_INTERRUPT_1ms)
39 /* Types of resources. For USBPORT_RESOURCES::ResourcesTypes */
40 #define USBPORT_RESOURCES_PORT 1
41 #define USBPORT_RESOURCES_INTERRUPT 2
42 #define USBPORT_RESOURCES_MEMORY 4
44 typedef struct _USBPORT_RESOURCES
{
46 USB_CONTROLLER_FLAVOR HcFlavor
;
47 ULONG InterruptVector
;
50 KAFFINITY InterruptAffinity
;
53 KINTERRUPT_MODE InterruptMode
;
60 BOOLEAN IsChirpHandled
;
63 } USBPORT_RESOURCES
, *PUSBPORT_RESOURCES
;
65 C_ASSERT(sizeof(USBPORT_RESOURCES
) == 32 + 5 * sizeof(PVOID
));
67 typedef struct _USBPORT_ENDPOINT_PROPERTIES
{
69 USHORT EndpointAddress
;
70 USHORT TotalMaxPacketSize
; // TransactionPerMicroframe * MaxPacketSize
73 USB_DEVICE_SPEED DeviceSpeed
;
82 ULONG MaxTransferSize
;
85 UCHAR InterruptScheduleMask
;
86 UCHAR SplitCompletionMask
;
87 UCHAR TransactionPerMicroframe
; // 1 + additional transactions. Total: from 1 to 3)
91 } USBPORT_ENDPOINT_PROPERTIES
, *PUSBPORT_ENDPOINT_PROPERTIES
;
93 C_ASSERT(sizeof(USBPORT_ENDPOINT_PROPERTIES
) == 56 + 2 * sizeof(PVOID
));
95 typedef struct _USBPORT_TRANSFER_PARAMETERS
{
97 ULONG TransferBufferLength
;
98 ULONG TransferCounter
;
99 BOOL IsTransferSplited
;
101 USB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
;
102 } USBPORT_TRANSFER_PARAMETERS
, *PUSBPORT_TRANSFER_PARAMETERS
;
104 C_ASSERT(sizeof(USBPORT_TRANSFER_PARAMETERS
) == 28);
106 typedef struct _USBPORT_SCATTER_GATHER_ELEMENT
{
107 PHYSICAL_ADDRESS SgPhysicalAddress
;
109 ULONG SgTransferLength
;
112 } USBPORT_SCATTER_GATHER_ELEMENT
, *PUSBPORT_SCATTER_GATHER_ELEMENT
;
114 C_ASSERT(sizeof(USBPORT_SCATTER_GATHER_ELEMENT
) == 24);
116 typedef struct _USBPORT_SCATTER_GATHER_LIST
{
119 PVOID MappedSystemVa
;
120 ULONG SgElementCount
;
121 USBPORT_SCATTER_GATHER_ELEMENT SgElement
[2];
122 } USBPORT_SCATTER_GATHER_LIST
, *PUSBPORT_SCATTER_GATHER_LIST
;
124 C_ASSERT(sizeof(USBPORT_SCATTER_GATHER_LIST
) == 48 + 4 * sizeof(PVOID
));
126 typedef struct _USBPORT_ENDPOINT_REQUIREMENTS
{
127 ULONG HeaderBufferSize
;
128 ULONG MaxTransferSize
;
129 } USBPORT_ENDPOINT_REQUIREMENTS
, *PUSBPORT_ENDPOINT_REQUIREMENTS
;
131 typedef ULONG MPSTATUS
; // Miniport status
132 typedef ULONG RHSTATUS
; // Roothub status
134 #define MP_STATUS_SUCCESS 0
135 #define MP_STATUS_FAILURE 1
136 #define MP_STATUS_NO_RESOURCES 2
137 #define MP_STATUS_NO_BANDWIDTH 3
138 #define MP_STATUS_ERROR 4
139 #define MP_STATUS_RESERVED1 5
140 #define MP_STATUS_NOT_SUPPORTED 6
141 #define MP_STATUS_HW_ERROR 7
142 #define MP_STATUS_UNSUCCESSFUL 8
144 #define RH_STATUS_SUCCESS 0
145 #define RH_STATUS_NO_CHANGES 1
146 #define RH_STATUS_UNSUCCESSFUL 2
148 /* Additional USB Class Codes from USB.org */
149 #define USBC_DEVICE_CLASS_TYPE_C_BRIDGE 0x12
151 /* Miniport functions */
153 (NTAPI
*PHCI_OPEN_ENDPOINT
)(
155 PUSBPORT_ENDPOINT_PROPERTIES
,
159 (NTAPI
*PHCI_REOPEN_ENDPOINT
)(
161 PUSBPORT_ENDPOINT_PROPERTIES
,
165 (NTAPI
*PHCI_QUERY_ENDPOINT_REQUIREMENTS
)(
167 PUSBPORT_ENDPOINT_PROPERTIES
,
168 PUSBPORT_ENDPOINT_REQUIREMENTS
);
171 (NTAPI
*PHCI_CLOSE_ENDPOINT
)(
177 (NTAPI
*PHCI_START_CONTROLLER
)(
182 (NTAPI
*PHCI_STOP_CONTROLLER
)(
187 (NTAPI
*PHCI_SUSPEND_CONTROLLER
)(PVOID
);
190 (NTAPI
*PHCI_RESUME_CONTROLLER
)(PVOID
);
193 (NTAPI
*PHCI_INTERRUPT_SERVICE
)(PVOID
);
196 (NTAPI
*PHCI_INTERRUPT_DPC
)(
201 (NTAPI
*PHCI_SUBMIT_TRANSFER
)(
204 PUSBPORT_TRANSFER_PARAMETERS
,
206 PUSBPORT_SCATTER_GATHER_LIST
);
209 (NTAPI
*PHCI_SUBMIT_ISO_TRANSFER
)(
212 PUSBPORT_TRANSFER_PARAMETERS
,
217 (NTAPI
*PHCI_ABORT_TRANSFER
)(
224 (NTAPI
*PHCI_GET_ENDPOINT_STATE
)(
229 (NTAPI
*PHCI_SET_ENDPOINT_STATE
)(
235 (NTAPI
*PHCI_POLL_ENDPOINT
)(
240 (NTAPI
*PHCI_CHECK_CONTROLLER
)(PVOID
);
243 (NTAPI
*PHCI_GET_32BIT_FRAME_NUMBER
)(PVOID
);
246 (NTAPI
*PHCI_INTERRUPT_NEXT_SOF
)(PVOID
);
249 (NTAPI
*PHCI_ENABLE_INTERRUPTS
)(PVOID
);
252 (NTAPI
*PHCI_DISABLE_INTERRUPTS
)(PVOID
);
255 (NTAPI
*PHCI_POLL_CONTROLLER
)(PVOID
);
258 (NTAPI
*PHCI_SET_ENDPOINT_DATA_TOGGLE
)(
264 (NTAPI
*PHCI_GET_ENDPOINT_STATUS
)(
269 (NTAPI
*PHCI_SET_ENDPOINT_STATUS
)(
275 (NTAPI
*PHCI_RESET_CONTROLLER
)(PVOID
);
277 /* Roothub functions */
279 (NTAPI
*PHCI_RH_GET_ROOT_HUB_DATA
)(
284 (NTAPI
*PHCI_RH_GET_STATUS
)(
289 (NTAPI
*PHCI_RH_GET_PORT_STATUS
)(
292 PUSB_PORT_STATUS_AND_CHANGE
);
295 (NTAPI
*PHCI_RH_GET_HUB_STATUS
)(
297 PUSB_HUB_STATUS_AND_CHANGE
);
300 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_RESET
)(
305 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_POWER
)(
310 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_ENABLE
)(
315 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_SUSPEND
)(
320 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_ENABLE
)(
325 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_POWER
)(
330 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND
)(
335 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_ENABLE_CHANGE
)(
340 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_CONNECT_CHANGE
)(
345 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_RESET_CHANGE
)(
350 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND_CHANGE
)(
355 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_OVERCURRENT_CHANGE
)(
360 (NTAPI
*PHCI_RH_DISABLE_IRQ
)(PVOID
);
363 (NTAPI
*PHCI_RH_ENABLE_IRQ
)(PVOID
);
365 /* Miniport ioctl functions */
367 (NTAPI
*PHCI_START_SEND_ONE_PACKET
)(
378 (NTAPI
*PHCI_END_SEND_ONE_PACKET
)(
389 (NTAPI
*PHCI_PASS_THRU
)(
397 (NTAPI
*PUSBPORT_DBG_PRINT
)(
404 (NTAPI
*PUSBPORT_TEST_DEBUG_BREAK
)(PVOID
);
407 (NTAPI
*PUSBPORT_ASSERT_FAILURE
)(
415 (NTAPI
*PUSBPORT_GET_MINIPORT_REGISTRY_KEY_VALUE
)(
424 (NTAPI
*PUSBPORT_INVALIDATE_ROOT_HUB
)(PVOID
);
427 (NTAPI
*PUSBPORT_INVALIDATE_ENDPOINT
)(
432 (NTAPI
*PUSBPORT_COMPLETE_TRANSFER
)(
440 (NTAPI
*PUSBPORT_COMPLETE_ISO_TRANSFER
)(
447 (NTAPI
*PUSBPORT_LOG_ENTRY
)(
456 (NTAPI
*PUSBPORT_GET_MAPPED_VIRTUAL_ADDRESS
)(
462 (NTAPI ASYNC_TIMER_CALLBACK
)(
463 IN PVOID MiniportExtension
,
464 IN PVOID CallBackContext
);
467 (NTAPI
*PUSBPORT_REQUEST_ASYNC_CALLBACK
)(
472 ASYNC_TIMER_CALLBACK
*);
475 (NTAPI
*PUSBPORT_READ_WRITE_CONFIG_SPACE
)(
483 (NTAPI
*PUSBPORT_WAIT
)(
487 #define USBPORT_INVALIDATE_CONTROLLER_RESET 1
488 #define USBPORT_INVALIDATE_CONTROLLER_SURPRISE_REMOVE 2
489 #define USBPORT_INVALIDATE_CONTROLLER_SOFT_INTERRUPT 3
492 (NTAPI
*PUSBPORT_INVALIDATE_CONTROLLER
)(
497 (NTAPI
*PUSBPORT_BUG_CHECK
)(PVOID
);
500 (NTAPI
*PUSBPORT_NOTIFY_DOUBLE_BUFFER
)(
506 /* Miniport functions */
508 (NTAPI
*PHCI_REBALANCE_ENDPOINT
)(
510 PUSBPORT_ENDPOINT_PROPERTIES
,
514 (NTAPI
*PHCI_FLUSH_INTERRUPTS
)(PVOID
);
517 (NTAPI
*PHCI_RH_CHIRP_ROOT_PORT
)(
522 (NTAPI
*PHCI_TAKE_PORT_CONTROL
)(PVOID
);
524 #define USB_MINIPORT_VERSION_OHCI 0x01
525 #define USB_MINIPORT_VERSION_UHCI 0x02
526 #define USB_MINIPORT_VERSION_EHCI 0x03
527 #define USB_MINIPORT_VERSION_XHCI 0x04
529 #define USB_MINIPORT_FLAGS_INTERRUPT 0x0001
530 #define USB_MINIPORT_FLAGS_PORT_IO 0x0002
531 #define USB_MINIPORT_FLAGS_MEMORY_IO 0x0004
532 #define USB_MINIPORT_FLAGS_USB2 0x0010
533 #define USB_MINIPORT_FLAGS_DISABLE_SS 0x0020
534 #define USB_MINIPORT_FLAGS_NOT_LOCK_INT 0x0040
535 #define USB_MINIPORT_FLAGS_POLLING 0x0080
536 #define USB_MINIPORT_FLAGS_NO_DMA 0x0100
537 #define USB_MINIPORT_FLAGS_WAKE_SUPPORT 0x0200
539 #define TOTAL_USB11_BUS_BANDWIDTH 12000
540 #define TOTAL_USB20_BUS_BANDWIDTH 400000
542 typedef struct _USBPORT_REGISTRATION_PACKET
{
543 ULONG MiniPortVersion
;
545 ULONG MiniPortBusBandwidth
;
547 SIZE_T MiniPortExtensionSize
;
548 SIZE_T MiniPortEndpointSize
;
549 SIZE_T MiniPortTransferSize
;
552 SIZE_T MiniPortResourcesSize
;
555 PHCI_OPEN_ENDPOINT OpenEndpoint
;
556 PHCI_REOPEN_ENDPOINT ReopenEndpoint
;
557 PHCI_QUERY_ENDPOINT_REQUIREMENTS QueryEndpointRequirements
;
558 PHCI_CLOSE_ENDPOINT CloseEndpoint
;
559 PHCI_START_CONTROLLER StartController
;
560 PHCI_STOP_CONTROLLER StopController
;
561 PHCI_SUSPEND_CONTROLLER SuspendController
;
562 PHCI_RESUME_CONTROLLER ResumeController
;
563 PHCI_INTERRUPT_SERVICE InterruptService
;
564 PHCI_INTERRUPT_DPC InterruptDpc
;
565 PHCI_SUBMIT_TRANSFER SubmitTransfer
;
566 PHCI_SUBMIT_ISO_TRANSFER SubmitIsoTransfer
;
567 PHCI_ABORT_TRANSFER AbortTransfer
;
568 PHCI_GET_ENDPOINT_STATE GetEndpointState
;
569 PHCI_SET_ENDPOINT_STATE SetEndpointState
;
570 PHCI_POLL_ENDPOINT PollEndpoint
;
571 PHCI_CHECK_CONTROLLER CheckController
;
572 PHCI_GET_32BIT_FRAME_NUMBER Get32BitFrameNumber
;
573 PHCI_INTERRUPT_NEXT_SOF InterruptNextSOF
;
574 PHCI_ENABLE_INTERRUPTS EnableInterrupts
;
575 PHCI_DISABLE_INTERRUPTS DisableInterrupts
;
576 PHCI_POLL_CONTROLLER PollController
;
577 PHCI_SET_ENDPOINT_DATA_TOGGLE SetEndpointDataToggle
;
578 PHCI_GET_ENDPOINT_STATUS GetEndpointStatus
;
579 PHCI_SET_ENDPOINT_STATUS SetEndpointStatus
;
580 PHCI_RESET_CONTROLLER ResetController
;
583 PHCI_RH_GET_ROOT_HUB_DATA RH_GetRootHubData
;
584 PHCI_RH_GET_STATUS RH_GetStatus
;
585 PHCI_RH_GET_PORT_STATUS RH_GetPortStatus
;
586 PHCI_RH_GET_HUB_STATUS RH_GetHubStatus
;
587 PHCI_RH_SET_FEATURE_PORT_RESET RH_SetFeaturePortReset
;
588 PHCI_RH_SET_FEATURE_PORT_POWER RH_SetFeaturePortPower
;
589 PHCI_RH_SET_FEATURE_PORT_ENABLE RH_SetFeaturePortEnable
;
590 PHCI_RH_SET_FEATURE_PORT_SUSPEND RH_SetFeaturePortSuspend
;
591 PHCI_RH_CLEAR_FEATURE_PORT_ENABLE RH_ClearFeaturePortEnable
;
592 PHCI_RH_CLEAR_FEATURE_PORT_POWER RH_ClearFeaturePortPower
;
593 PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND RH_ClearFeaturePortSuspend
;
594 PHCI_RH_CLEAR_FEATURE_PORT_ENABLE_CHANGE RH_ClearFeaturePortEnableChange
;
595 PHCI_RH_CLEAR_FEATURE_PORT_CONNECT_CHANGE RH_ClearFeaturePortConnectChange
;
596 PHCI_RH_CLEAR_FEATURE_PORT_RESET_CHANGE RH_ClearFeaturePortResetChange
;
597 PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND_CHANGE RH_ClearFeaturePortSuspendChange
;
598 PHCI_RH_CLEAR_FEATURE_PORT_OVERCURRENT_CHANGE RH_ClearFeaturePortOvercurrentChange
;
599 PHCI_RH_DISABLE_IRQ RH_DisableIrq
;
600 PHCI_RH_ENABLE_IRQ RH_EnableIrq
;
603 PHCI_START_SEND_ONE_PACKET StartSendOnePacket
;
604 PHCI_END_SEND_ONE_PACKET EndSendOnePacket
;
605 PHCI_PASS_THRU PassThru
;
608 PUSBPORT_DBG_PRINT UsbPortDbgPrint
;
609 PUSBPORT_TEST_DEBUG_BREAK UsbPortTestDebugBreak
;
610 PUSBPORT_ASSERT_FAILURE UsbPortAssertFailure
;
611 PUSBPORT_GET_MINIPORT_REGISTRY_KEY_VALUE UsbPortGetMiniportRegistryKeyValue
;
612 PUSBPORT_INVALIDATE_ROOT_HUB UsbPortInvalidateRootHub
;
613 PUSBPORT_INVALIDATE_ENDPOINT UsbPortInvalidateEndpoint
;
614 PUSBPORT_COMPLETE_TRANSFER UsbPortCompleteTransfer
;
615 PUSBPORT_COMPLETE_ISO_TRANSFER UsbPortCompleteIsoTransfer
;
616 PUSBPORT_LOG_ENTRY UsbPortLogEntry
;
617 PUSBPORT_GET_MAPPED_VIRTUAL_ADDRESS UsbPortGetMappedVirtualAddress
;
618 PUSBPORT_REQUEST_ASYNC_CALLBACK UsbPortRequestAsyncCallback
;
619 PUSBPORT_READ_WRITE_CONFIG_SPACE UsbPortReadWriteConfigSpace
;
620 PUSBPORT_WAIT UsbPortWait
;
621 PUSBPORT_INVALIDATE_CONTROLLER UsbPortInvalidateController
;
622 PUSBPORT_BUG_CHECK UsbPortBugCheck
;
623 PUSBPORT_NOTIFY_DOUBLE_BUFFER UsbPortNotifyDoubleBuffer
;
626 PHCI_REBALANCE_ENDPOINT RebalanceEndpoint
;
627 PHCI_FLUSH_INTERRUPTS FlushInterrupts
;
628 PHCI_RH_CHIRP_ROOT_PORT RH_ChirpRootPort
;
629 PHCI_TAKE_PORT_CONTROL TakePortControl
;
632 } USBPORT_REGISTRATION_PACKET
, *PUSBPORT_REGISTRATION_PACKET
;
634 #define USB10_MINIPORT_INTERFACE_VERSION 100
635 #define USB20_MINIPORT_INTERFACE_VERSION 200
637 typedef struct _USBPORT_MINIPORT_INTERFACE
{
638 PDRIVER_OBJECT DriverObject
;
639 LIST_ENTRY DriverLink
;
640 PDRIVER_UNLOAD DriverUnload
;
642 USBPORT_REGISTRATION_PACKET Packet
;
643 } USBPORT_MINIPORT_INTERFACE
, *PUSBPORT_MINIPORT_INTERFACE
;
645 C_ASSERT(sizeof(USBPORT_MINIPORT_INTERFACE
) == 32 + 76 * sizeof(PVOID
));
647 #define USBPORT_TRANSFER_DIRECTION_OUT 1 // From host to device
648 #define USBPORT_MAX_DEVICE_ADDRESS 127
650 /* For USB1.1 or USB3 Hub Descriptors */
651 typedef union _USBPORT_HUB_11_CHARACTERISTICS
{
653 USHORT PowerControlMode
:1;
654 USHORT NoPowerSwitching
:1; // Reserved. Used only on 1.0 compliant hubs that implement no power switching.
655 USHORT PartOfCompoundDevice
:1;
656 USHORT OverCurrentProtectionMode
:1;
657 USHORT NoOverCurrentProtection
:1;
658 USHORT Reserved1
:11;
661 } USBPORT_HUB_11_CHARACTERISTICS
;
663 C_ASSERT(sizeof(USBPORT_HUB_11_CHARACTERISTICS
) == sizeof(USHORT
));
665 /* For USB2.0 Hub Descriptors */
666 typedef union _USBPORT_HUB_20_CHARACTERISTICS
{
668 USHORT PowerControlMode
:1;
669 USHORT NoPowerSwitching
:1; // Reserved. Used only on 1.0 compliant hubs that implement no power switching.
670 USHORT PartOfCompoundDevice
:1;
671 USHORT OverCurrentProtectionMode
:1;
672 USHORT NoOverCurrentProtection
:1;
673 USHORT TtThinkTime
:2;
674 USHORT PortIndicatorsSupported
:1;
678 } USBPORT_HUB_20_CHARACTERISTICS
;
680 C_ASSERT(sizeof(USBPORT_HUB_20_CHARACTERISTICS
) == sizeof(USHORT
));
682 typedef USBPORT_HUB_11_CHARACTERISTICS USBPORT_HUB_30_CHARACTERISTICS
;
684 typedef union _USBPORT_HUB_CHARACTERISTICS
{
686 USBPORT_HUB_11_CHARACTERISTICS Usb11HubCharacteristics
;
687 USBPORT_HUB_20_CHARACTERISTICS Usb20HubCharacteristics
;
688 USBPORT_HUB_30_CHARACTERISTICS Usb30HubCharacteristics
;
689 } USBPORT_HUB_CHARACTERISTICS
;
691 C_ASSERT(sizeof(USBPORT_HUB_CHARACTERISTICS
) == sizeof(USHORT
));
693 typedef struct _USBPORT_ROOT_HUB_DATA
{
695 USBPORT_HUB_CHARACTERISTICS HubCharacteristics
;
697 ULONG PowerOnToPowerGood
;
698 ULONG HubControlCurrent
;
699 } USBPORT_ROOT_HUB_DATA
, *PUSBPORT_ROOT_HUB_DATA
;
701 C_ASSERT(sizeof(USBPORT_ROOT_HUB_DATA
) == 16);
705 USBPORT_GetHciMn(VOID
);
709 USBPORT_RegisterUSBPortDriver(
710 IN PDRIVER_OBJECT DriverObject
,
712 IN PUSBPORT_REGISTRATION_PACKET RegistrationPacket
);
714 #endif /* USBMPORT_H__ */