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
{
47 ULONG InterruptVector
;
50 KAFFINITY InterruptAffinity
;
53 KINTERRUPT_MODE InterruptMode
;
60 BOOLEAN IsChirpHandled
;
63 } USBPORT_RESOURCES
, *PUSBPORT_RESOURCES
;
65 C_ASSERT(sizeof(USBPORT_RESOURCES
) == 52);
67 typedef ULONG MPSTATUS
; // Miniport status
68 typedef ULONG RHSTATUS
; // Roothub status
70 #define MP_STATUS_SUCCESS 0
71 #define MP_STATUS_FAILURE 1
72 #define MP_STATUS_NO_RESOURCES 2
73 #define MP_STATUS_NO_BANDWIDTH 3
74 #define MP_STATUS_ERROR 4
75 #define MP_STATUS_RESERVED1 5
76 #define MP_STATUS_NOT_SUPPORTED 6
77 #define MP_STATUS_HW_ERROR 7
78 #define MP_STATUS_UNSUCCESSFUL 8
80 #define RH_STATUS_SUCCESS 0
81 #define RH_STATUS_NO_CHANGES 1
82 #define RH_STATUS_UNSUCCESSFUL 2
84 /* Additional USB Class Codes from USB.org */
85 #define USBC_DEVICE_CLASS_TYPE_C_BRIDGE 0x12
87 /* Miniport functions */
89 (NTAPI
*PHCI_OPEN_ENDPOINT
)(
95 (NTAPI
*PHCI_REOPEN_ENDPOINT
)(
101 (NTAPI
*PHCI_QUERY_ENDPOINT_REQUIREMENTS
)(
107 (NTAPI
*PHCI_CLOSE_ENDPOINT
)(
113 (NTAPI
*PHCI_START_CONTROLLER
)(
118 (NTAPI
*PHCI_STOP_CONTROLLER
)(
123 (NTAPI
*PHCI_SUSPEND_CONTROLLER
)(PVOID
);
126 (NTAPI
*PHCI_RESUME_CONTROLLER
)(PVOID
);
129 (NTAPI
*PHCI_INTERRUPT_SERVICE
)(PVOID
);
132 (NTAPI
*PHCI_INTERRUPT_DPC
)(
137 (NTAPI
*PHCI_SUBMIT_TRANSFER
)(
145 (NTAPI
*PHCI_SUBMIT_ISO_TRANSFER
)(
153 (NTAPI
*PHCI_ABORT_TRANSFER
)(
160 (NTAPI
*PHCI_GET_ENDPOINT_STATE
)(
165 (NTAPI
*PHCI_SET_ENDPOINT_STATE
)(
171 (NTAPI
*PHCI_POLL_ENDPOINT
)(
176 (NTAPI
*PHCI_CHECK_CONTROLLER
)(PVOID
);
179 (NTAPI
*PHCI_GET_32BIT_FRAME_NUMBER
)(PVOID
);
182 (NTAPI
*PHCI_INTERRUPT_NEXT_SOF
)(PVOID
);
185 (NTAPI
*PHCI_ENABLE_INTERRUPTS
)(PVOID
);
188 (NTAPI
*PHCI_DISABLE_INTERRUPTS
)(PVOID
);
191 (NTAPI
*PHCI_POLL_CONTROLLER
)(PVOID
);
194 (NTAPI
*PHCI_SET_ENDPOINT_DATA_TOGGLE
)(
200 (NTAPI
*PHCI_GET_ENDPOINT_STATUS
)(
205 (NTAPI
*PHCI_SET_ENDPOINT_STATUS
)(
211 (NTAPI
*PHCI_RESET_CONTROLLER
)(PVOID
);
213 /* Roothub functions */
215 (NTAPI
*PHCI_RH_GET_ROOT_HUB_DATA
)(
220 (NTAPI
*PHCI_RH_GET_STATUS
)(
225 (NTAPI
*PHCI_RH_GET_PORT_STATUS
)(
228 PUSB_PORT_STATUS_AND_CHANGE
);
231 (NTAPI
*PHCI_RH_GET_HUB_STATUS
)(
233 PUSB_HUB_STATUS_AND_CHANGE
);
236 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_RESET
)(
241 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_POWER
)(
246 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_ENABLE
)(
251 (NTAPI
*PHCI_RH_SET_FEATURE_PORT_SUSPEND
)(
256 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_ENABLE
)(
261 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_POWER
)(
266 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND
)(
271 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_ENABLE_CHANGE
)(
276 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_CONNECT_CHANGE
)(
281 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_RESET_CHANGE
)(
286 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND_CHANGE
)(
291 (NTAPI
*PHCI_RH_CLEAR_FEATURE_PORT_OVERCURRENT_CHANGE
)(
296 (NTAPI
*PHCI_RH_DISABLE_IRQ
)(PVOID
);
299 (NTAPI
*PHCI_RH_ENABLE_IRQ
)(PVOID
);
301 /* Miniport ioctl functions */
303 (NTAPI
*PHCI_START_SEND_ONE_PACKET
)(
314 (NTAPI
*PHCI_END_SEND_ONE_PACKET
)(
325 (NTAPI
*PHCI_PASS_THRU
)(
333 (NTAPI
*PUSBPORT_DBG_PRINT
)(
340 (NTAPI
*PUSBPORT_TEST_DEBUG_BREAK
)(PVOID
);
343 (NTAPI
*PUSBPORT_ASSERT_FAILURE
)(
351 (NTAPI
*PUSBPORT_GET_MINIPORT_REGISTRY_KEY_VALUE
)(
360 (NTAPI
*PUSBPORT_INVALIDATE_ROOT_HUB
)(PVOID
);
363 (NTAPI
*PUSBPORT_INVALIDATE_ENDPOINT
)(
368 (NTAPI
*PUSBPORT_COMPLETE_TRANSFER
)(
376 (NTAPI
*PUSBPORT_COMPLETE_ISO_TRANSFER
)(
383 (NTAPI
*PUSBPORT_LOG_ENTRY
)(
392 (NTAPI
*PUSBPORT_GET_MAPPED_VIRTUAL_ADDRESS
)(
398 (NTAPI ASYNC_TIMER_CALLBACK
)(
399 IN PVOID MiniportExtension
,
400 IN PVOID CallBackContext
);
403 (NTAPI
*PUSBPORT_REQUEST_ASYNC_CALLBACK
)(
408 ASYNC_TIMER_CALLBACK
*);
411 (NTAPI
*PUSBPORT_READ_WRITE_CONFIG_SPACE
)(
419 (NTAPI
*PUSBPORT_WAIT
)(
423 #define USBPORT_INVALIDATE_CONTROLLER_RESET 1
424 #define USBPORT_INVALIDATE_CONTROLLER_SURPRISE_REMOVE 2
425 #define USBPORT_INVALIDATE_CONTROLLER_SOFT_INTERRUPT 3
428 (NTAPI
*PUSBPORT_INVALIDATE_CONTROLLER
)(
433 (NTAPI
*PUSBPORT_BUG_CHECK
)(PVOID
);
436 (NTAPI
*PUSBPORT_NOTIFY_DOUBLE_BUFFER
)(
442 /* Miniport functions */
444 (NTAPI
*PHCI_REBALANCE_ENDPOINT
)(
450 (NTAPI
*PHCI_FLUSH_INTERRUPTS
)(PVOID
);
453 (NTAPI
*PHCI_RH_CHIRP_ROOT_PORT
)(
458 (NTAPI
*PHCI_TAKE_PORT_CONTROL
)(PVOID
);
460 #define USB_MINIPORT_VERSION_OHCI 0x01
461 #define USB_MINIPORT_VERSION_UHCI 0x02
462 #define USB_MINIPORT_VERSION_EHCI 0x03
463 #define USB_MINIPORT_VERSION_XHCI 0x04
465 #define USB_MINIPORT_FLAGS_INTERRUPT 0x0001
466 #define USB_MINIPORT_FLAGS_PORT_IO 0x0002
467 #define USB_MINIPORT_FLAGS_MEMORY_IO 0x0004
468 #define USB_MINIPORT_FLAGS_USB2 0x0010
469 #define USB_MINIPORT_FLAGS_DISABLE_SS 0x0020
470 #define USB_MINIPORT_FLAGS_NOT_LOCK_INT 0x0040
471 #define USB_MINIPORT_FLAGS_POLLING 0x0080
472 #define USB_MINIPORT_FLAGS_NO_DMA 0x0100
473 #define USB_MINIPORT_FLAGS_WAKE_SUPPORT 0x0200
475 #define TOTAL_USB11_BUS_BANDWIDTH 12000
476 #define TOTAL_USB20_BUS_BANDWIDTH 400000
478 typedef struct _USBPORT_REGISTRATION_PACKET
{
479 ULONG MiniPortVersion
;
481 ULONG MiniPortBusBandwidth
;
483 SIZE_T MiniPortExtensionSize
;
484 SIZE_T MiniPortEndpointSize
;
485 SIZE_T MiniPortTransferSize
;
488 SIZE_T MiniPortResourcesSize
;
491 PHCI_OPEN_ENDPOINT OpenEndpoint
;
492 PHCI_REOPEN_ENDPOINT ReopenEndpoint
;
493 PHCI_QUERY_ENDPOINT_REQUIREMENTS QueryEndpointRequirements
;
494 PHCI_CLOSE_ENDPOINT CloseEndpoint
;
495 PHCI_START_CONTROLLER StartController
;
496 PHCI_STOP_CONTROLLER StopController
;
497 PHCI_SUSPEND_CONTROLLER SuspendController
;
498 PHCI_RESUME_CONTROLLER ResumeController
;
499 PHCI_INTERRUPT_SERVICE InterruptService
;
500 PHCI_INTERRUPT_DPC InterruptDpc
;
501 PHCI_SUBMIT_TRANSFER SubmitTransfer
;
502 PHCI_SUBMIT_ISO_TRANSFER SubmitIsoTransfer
;
503 PHCI_ABORT_TRANSFER AbortTransfer
;
504 PHCI_GET_ENDPOINT_STATE GetEndpointState
;
505 PHCI_SET_ENDPOINT_STATE SetEndpointState
;
506 PHCI_POLL_ENDPOINT PollEndpoint
;
507 PHCI_CHECK_CONTROLLER CheckController
;
508 PHCI_GET_32BIT_FRAME_NUMBER Get32BitFrameNumber
;
509 PHCI_INTERRUPT_NEXT_SOF InterruptNextSOF
;
510 PHCI_ENABLE_INTERRUPTS EnableInterrupts
;
511 PHCI_DISABLE_INTERRUPTS DisableInterrupts
;
512 PHCI_POLL_CONTROLLER PollController
;
513 PHCI_SET_ENDPOINT_DATA_TOGGLE SetEndpointDataToggle
;
514 PHCI_GET_ENDPOINT_STATUS GetEndpointStatus
;
515 PHCI_SET_ENDPOINT_STATUS SetEndpointStatus
;
516 PHCI_RESET_CONTROLLER ResetController
;
519 PHCI_RH_GET_ROOT_HUB_DATA RH_GetRootHubData
;
520 PHCI_RH_GET_STATUS RH_GetStatus
;
521 PHCI_RH_GET_PORT_STATUS RH_GetPortStatus
;
522 PHCI_RH_GET_HUB_STATUS RH_GetHubStatus
;
523 PHCI_RH_SET_FEATURE_PORT_RESET RH_SetFeaturePortReset
;
524 PHCI_RH_SET_FEATURE_PORT_POWER RH_SetFeaturePortPower
;
525 PHCI_RH_SET_FEATURE_PORT_ENABLE RH_SetFeaturePortEnable
;
526 PHCI_RH_SET_FEATURE_PORT_SUSPEND RH_SetFeaturePortSuspend
;
527 PHCI_RH_CLEAR_FEATURE_PORT_ENABLE RH_ClearFeaturePortEnable
;
528 PHCI_RH_CLEAR_FEATURE_PORT_POWER RH_ClearFeaturePortPower
;
529 PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND RH_ClearFeaturePortSuspend
;
530 PHCI_RH_CLEAR_FEATURE_PORT_ENABLE_CHANGE RH_ClearFeaturePortEnableChange
;
531 PHCI_RH_CLEAR_FEATURE_PORT_CONNECT_CHANGE RH_ClearFeaturePortConnectChange
;
532 PHCI_RH_CLEAR_FEATURE_PORT_RESET_CHANGE RH_ClearFeaturePortResetChange
;
533 PHCI_RH_CLEAR_FEATURE_PORT_SUSPEND_CHANGE RH_ClearFeaturePortSuspendChange
;
534 PHCI_RH_CLEAR_FEATURE_PORT_OVERCURRENT_CHANGE RH_ClearFeaturePortOvercurrentChange
;
535 PHCI_RH_DISABLE_IRQ RH_DisableIrq
;
536 PHCI_RH_ENABLE_IRQ RH_EnableIrq
;
539 PHCI_START_SEND_ONE_PACKET StartSendOnePacket
;
540 PHCI_END_SEND_ONE_PACKET EndSendOnePacket
;
541 PHCI_PASS_THRU PassThru
;
544 PUSBPORT_DBG_PRINT UsbPortDbgPrint
;
545 PUSBPORT_TEST_DEBUG_BREAK UsbPortTestDebugBreak
;
546 PUSBPORT_ASSERT_FAILURE UsbPortAssertFailure
;
547 PUSBPORT_GET_MINIPORT_REGISTRY_KEY_VALUE UsbPortGetMiniportRegistryKeyValue
;
548 PUSBPORT_INVALIDATE_ROOT_HUB UsbPortInvalidateRootHub
;
549 PUSBPORT_INVALIDATE_ENDPOINT UsbPortInvalidateEndpoint
;
550 PUSBPORT_COMPLETE_TRANSFER UsbPortCompleteTransfer
;
551 PUSBPORT_COMPLETE_ISO_TRANSFER UsbPortCompleteIsoTransfer
;
552 PUSBPORT_LOG_ENTRY UsbPortLogEntry
;
553 PUSBPORT_GET_MAPPED_VIRTUAL_ADDRESS UsbPortGetMappedVirtualAddress
;
554 PUSBPORT_REQUEST_ASYNC_CALLBACK UsbPortRequestAsyncCallback
;
555 PUSBPORT_READ_WRITE_CONFIG_SPACE UsbPortReadWriteConfigSpace
;
556 PUSBPORT_WAIT UsbPortWait
;
557 PUSBPORT_INVALIDATE_CONTROLLER UsbPortInvalidateController
;
558 PUSBPORT_BUG_CHECK UsbPortBugCheck
;
559 PUSBPORT_NOTIFY_DOUBLE_BUFFER UsbPortNotifyDoubleBuffer
;
562 PHCI_REBALANCE_ENDPOINT RebalanceEndpoint
;
563 PHCI_FLUSH_INTERRUPTS FlushInterrupts
;
564 PHCI_RH_CHIRP_ROOT_PORT RH_ChirpRootPort
;
565 PHCI_TAKE_PORT_CONTROL TakePortControl
;
568 } USBPORT_REGISTRATION_PACKET
, *PUSBPORT_REGISTRATION_PACKET
;
570 #define USB10_MINIPORT_INTERFACE_VERSION 100
571 #define USB20_MINIPORT_INTERFACE_VERSION 200
573 typedef struct _USBPORT_MINIPORT_INTERFACE
{
574 PDRIVER_OBJECT DriverObject
;
575 LIST_ENTRY DriverLink
;
576 PDRIVER_UNLOAD DriverUnload
;
578 USBPORT_REGISTRATION_PACKET Packet
;
579 } USBPORT_MINIPORT_INTERFACE
, *PUSBPORT_MINIPORT_INTERFACE
;
581 C_ASSERT(sizeof(USBPORT_MINIPORT_INTERFACE
) == 336);
583 typedef struct _USBPORT_ENDPOINT_PROPERTIES
{
584 USHORT DeviceAddress
;
585 USHORT EndpointAddress
;
586 USHORT TotalMaxPacketSize
; // TransactionPerMicroframe * MaxPacketSize
589 USB_DEVICE_SPEED DeviceSpeed
;
591 ULONG ScheduleOffset
;
598 ULONG MaxTransferSize
;
601 UCHAR InterruptScheduleMask
;
602 UCHAR SplitCompletionMask
;
603 UCHAR TransactionPerMicroframe
; // 1 + additional transactions. Total: from 1 to 3)
607 } USBPORT_ENDPOINT_PROPERTIES
, *PUSBPORT_ENDPOINT_PROPERTIES
;
609 C_ASSERT(sizeof(USBPORT_ENDPOINT_PROPERTIES
) == 64);
611 typedef struct _USBPORT_SCATTER_GATHER_ELEMENT
{
612 PHYSICAL_ADDRESS SgPhysicalAddress
;
614 ULONG SgTransferLength
;
617 } USBPORT_SCATTER_GATHER_ELEMENT
, *PUSBPORT_SCATTER_GATHER_ELEMENT
;
619 C_ASSERT(sizeof(USBPORT_SCATTER_GATHER_ELEMENT
) == 24);
621 typedef struct _USBPORT_SCATTER_GATHER_LIST
{
624 PVOID MappedSystemVa
;
625 ULONG SgElementCount
;
626 USBPORT_SCATTER_GATHER_ELEMENT SgElement
[1];
627 } USBPORT_SCATTER_GATHER_LIST
, *PUSBPORT_SCATTER_GATHER_LIST
;
629 C_ASSERT(sizeof(USBPORT_SCATTER_GATHER_LIST
) == 40);
631 typedef struct _USBPORT_TRANSFER_PARAMETERS
{
633 ULONG TransferBufferLength
;
634 ULONG TransferCounter
;
637 USB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
;
638 } USBPORT_TRANSFER_PARAMETERS
, *PUSBPORT_TRANSFER_PARAMETERS
;
640 C_ASSERT(sizeof(USBPORT_TRANSFER_PARAMETERS
) == 28);
642 /* For USB1.1 or USB3 Hub Descriptors */
643 typedef union _USBPORT_HUB_11_CHARACTERISTICS
{
645 USHORT PowerControlMode
:1;
646 USHORT NoPowerSwitching
:1; // Reserved. Used only on 1.0 compliant hubs that implement no power switching.
647 USHORT PartOfCompoundDevice
:1;
648 USHORT OverCurrentProtectionMode
:1;
649 USHORT NoOverCurrentProtection
:1;
650 USHORT Reserved1
:11;
653 } USBPORT_HUB_11_CHARACTERISTICS
;
655 C_ASSERT(sizeof(USBPORT_HUB_11_CHARACTERISTICS
) == sizeof(USHORT
));
657 /* For USB2.0 Hub Descriptors */
658 typedef union _USBPORT_HUB_20_CHARACTERISTICS
{
660 USHORT PowerControlMode
:1;
661 USHORT NoPowerSwitching
:1; // Reserved. Used only on 1.0 compliant hubs that implement no power switching.
662 USHORT PartOfCompoundDevice
:1;
663 USHORT OverCurrentProtectionMode
:1;
664 USHORT NoOverCurrentProtection
:1;
665 USHORT TtThinkTime
:2;
666 USHORT PortIndicatorsSupported
:1;
670 } USBPORT_HUB_20_CHARACTERISTICS
;
672 C_ASSERT(sizeof(USBPORT_HUB_20_CHARACTERISTICS
) == sizeof(USHORT
));
674 typedef USBPORT_HUB_11_CHARACTERISTICS USBPORT_HUB_30_CHARACTERISTICS
;
676 typedef union _USBPORT_HUB_CHARACTERISTICS
{
678 USBPORT_HUB_11_CHARACTERISTICS Usb11HubCharacteristics
;
679 USBPORT_HUB_20_CHARACTERISTICS Usb20HubCharacteristics
;
680 USBPORT_HUB_30_CHARACTERISTICS Usb30HubCharacteristics
;
681 } USBPORT_HUB_CHARACTERISTICS
;
683 C_ASSERT(sizeof(USBPORT_HUB_CHARACTERISTICS
) == sizeof(USHORT
));
685 typedef struct _USBPORT_ROOT_HUB_DATA
{
687 USBPORT_HUB_CHARACTERISTICS HubCharacteristics
;
689 ULONG PowerOnToPowerGood
;
690 ULONG HubControlCurrent
;
691 } USBPORT_ROOT_HUB_DATA
, *PUSBPORT_ROOT_HUB_DATA
;
693 C_ASSERT(sizeof(USBPORT_ROOT_HUB_DATA
) == 16);
697 USBPORT_GetHciMn(VOID
);
701 USBPORT_RegisterUSBPortDriver(
702 IN PDRIVER_OBJECT DriverObject
,
704 IN PUSBPORT_REGISTRATION_PACKET RegistrationPacket
);
706 #endif /* USBMPORT_H__ */