3 This file contains the definition for XHCI host controller schedule routines.
5 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef _EFI_XHCI_SCHED_H_
11 #define _EFI_XHCI_SCHED_H_
13 #define XHC_URB_SIG SIGNATURE_32 ('U', 'S', 'B', 'R')
14 #define XHC_INIT_DEVICE_SLOT_RETRIES 1
17 // Transfer types, used in URB to identify the transfer type
19 #define XHC_CTRL_TRANSFER 0x01
20 #define XHC_BULK_TRANSFER 0x02
21 #define XHC_INT_TRANSFER_SYNC 0x04
22 #define XHC_INT_TRANSFER_ASYNC 0x08
23 #define XHC_INT_ONLY_TRANSFER_ASYNC 0x10
28 #define TRB_TYPE_NORMAL 1
29 #define TRB_TYPE_SETUP_STAGE 2
30 #define TRB_TYPE_DATA_STAGE 3
31 #define TRB_TYPE_STATUS_STAGE 4
32 #define TRB_TYPE_ISOCH 5
33 #define TRB_TYPE_LINK 6
34 #define TRB_TYPE_EVENT_DATA 7
35 #define TRB_TYPE_NO_OP 8
36 #define TRB_TYPE_EN_SLOT 9
37 #define TRB_TYPE_DIS_SLOT 10
38 #define TRB_TYPE_ADDRESS_DEV 11
39 #define TRB_TYPE_CON_ENDPOINT 12
40 #define TRB_TYPE_EVALU_CONTXT 13
41 #define TRB_TYPE_RESET_ENDPOINT 14
42 #define TRB_TYPE_STOP_ENDPOINT 15
43 #define TRB_TYPE_SET_TR_DEQUE 16
44 #define TRB_TYPE_RESET_DEV 17
45 #define TRB_TYPE_GET_PORT_BANW 21
46 #define TRB_TYPE_FORCE_HEADER 22
47 #define TRB_TYPE_NO_OP_COMMAND 23
48 #define TRB_TYPE_TRANS_EVENT 32
49 #define TRB_TYPE_COMMAND_COMPLT_EVENT 33
50 #define TRB_TYPE_PORT_STATUS_CHANGE_EVENT 34
51 #define TRB_TYPE_HOST_CONTROLLER_EVENT 37
52 #define TRB_TYPE_DEVICE_NOTIFI_EVENT 38
53 #define TRB_TYPE_MFINDEX_WRAP_EVENT 39
56 // Endpoint Type (EP Type).
58 #define ED_NOT_VALID 0
59 #define ED_ISOCH_OUT 1
61 #define ED_INTERRUPT_OUT 3
62 #define ED_CONTROL_BIDIR 4
65 #define ED_INTERRUPT_IN 7
68 // 6.4.5 TRB Completion Codes
70 #define TRB_COMPLETION_INVALID 0
71 #define TRB_COMPLETION_SUCCESS 1
72 #define TRB_COMPLETION_DATA_BUFFER_ERROR 2
73 #define TRB_COMPLETION_BABBLE_ERROR 3
74 #define TRB_COMPLETION_USB_TRANSACTION_ERROR 4
75 #define TRB_COMPLETION_TRB_ERROR 5
76 #define TRB_COMPLETION_STALL_ERROR 6
77 #define TRB_COMPLETION_SHORT_PACKET 13
78 #define TRB_COMPLETION_STOPPED 26
79 #define TRB_COMPLETION_STOPPED_LENGTH_INVALID 27
82 // The topology string used to present usb device location
84 typedef struct _USB_DEV_TOPOLOGY
{
86 // The tier concatenation of down stream port.
88 UINT32 RouteString
:20;
90 // The root port number of the chain.
94 // The Tier the device reside.
100 // USB Device's RouteChart
102 typedef union _USB_DEV_ROUTE
{
104 USB_DEV_TOPOLOGY Route
;
108 // Endpoint address and its capabilities
110 typedef struct _USB_ENDPOINT
{
112 // Store logical device address assigned by UsbBus
113 // It's because some XHCI host controllers may assign the same physcial device
114 // address for those devices inserted at different root port.
119 EFI_USB_DATA_DIRECTION Direction
;
128 typedef struct _TRB_TEMPLATE
{
141 typedef struct _TRANSFER_RING
{
144 TRB_TEMPLATE
*RingEnqueue
;
145 TRB_TEMPLATE
*RingDequeue
;
149 typedef struct _EVENT_RING
{
153 TRB_TEMPLATE
*EventRingEnqueue
;
154 TRB_TEMPLATE
*EventRingDequeue
;
159 // URB (Usb Request Block) contains information for all kinds of
162 typedef struct _URB
{
166 // Usb Device URB related information
169 EFI_USB_DEVICE_REQUEST
*Request
;
174 EFI_ASYNC_USB_TRANSFER_CALLBACK Callback
;
181 // completed data length
185 // Command/Tranfer Ring info
188 TRB_TEMPLATE
*TrbStart
;
189 TRB_TEMPLATE
*TrbEnd
;
195 TRB_TEMPLATE
*EvtTrb
;
199 // 6.5 Event Ring Segment Table
200 // The Event Ring Segment Table is used to define multi-segment Event Rings and to enable runtime
201 // expansion and shrinking of the Event Ring. The location of the Event Ring Segment Table is defined by the
202 // Event Ring Segment Table Base Address Register (5.5.2.3.2). The size of the Event Ring Segment Table
203 // is defined by the Event Ring Segment Table Base Size Register (5.5.2.3.1).
205 typedef struct _EVENT_RING_SEG_TABLE_ENTRY
{
208 UINT32 RingTrbSize
:16;
211 } EVENT_RING_SEG_TABLE_ENTRY
;
214 // 6.4.1.1 Normal TRB
215 // A Normal TRB is used in several ways; exclusively on Bulk and Interrupt Transfer Rings for normal and
216 // Scatter/Gather operations, to define additional data buffers for Scatter/Gather operations on Isoch Transfer
217 // Rings, and to define the Data stage information for Control Transfer Rings.
219 typedef struct _TRANSFER_TRB_NORMAL
{
239 } TRANSFER_TRB_NORMAL
;
242 // 6.4.1.2.1 Setup Stage TRB
243 // A Setup Stage TRB is created by system software to initiate a USB Setup packet on a control endpoint.
245 typedef struct _TRANSFER_TRB_CONTROL_SETUP
{
246 UINT32 bmRequestType
:8;
265 } TRANSFER_TRB_CONTROL_SETUP
;
268 // 6.4.1.2.2 Data Stage TRB
269 // A Data Stage TRB is used generate the Data stage transaction of a USB Control transfer.
271 typedef struct _TRANSFER_TRB_CONTROL_DATA
{
291 } TRANSFER_TRB_CONTROL_DATA
;
294 // 6.4.1.2.2 Data Stage TRB
295 // A Data Stage TRB is used generate the Data stage transaction of a USB Control transfer.
297 typedef struct _TRANSFER_TRB_CONTROL_STATUS
{
313 } TRANSFER_TRB_CONTROL_STATUS
;
316 // 6.4.2.1 Transfer Event TRB
317 // A Transfer Event provides the completion status associated with a Transfer TRB. Refer to section 4.11.3.1
318 // for more information on the use and operation of Transfer Events.
320 typedef struct _EVT_TRB_TRANSFER
{
326 UINT32 Completecode
:8;
339 // 6.4.2.2 Command Completion Event TRB
340 // A Command Completion Event TRB shall be generated by the xHC when a command completes on the
341 // Command Ring. Refer to section 4.11.4 for more information on the use of Command Completion Events.
343 typedef struct _EVT_TRB_COMMAND_COMPLETION
{
349 UINT32 Completecode
:8;
356 } EVT_TRB_COMMAND_COMPLETION
;
359 TRB_TEMPLATE TrbTemplate
;
360 TRANSFER_TRB_NORMAL TrbNormal
;
361 TRANSFER_TRB_CONTROL_SETUP TrbCtrSetup
;
362 TRANSFER_TRB_CONTROL_DATA TrbCtrData
;
363 TRANSFER_TRB_CONTROL_STATUS TrbCtrStatus
;
367 // 6.4.3.1 No Op Command TRB
368 // The No Op Command TRB provides a simple means for verifying the operation of the Command Ring
369 // mechanisms offered by the xHCI.
371 typedef struct _CMD_TRB_NO_OP
{
383 // 6.4.3.2 Enable Slot Command TRB
384 // The Enable Slot Command TRB causes the xHC to select an available Device Slot and return the ID of the
385 // selected slot to the host in a Command Completion Event.
387 typedef struct _CMD_TRB_ENABLE_SLOT
{
396 } CMD_TRB_ENABLE_SLOT
;
399 // 6.4.3.3 Disable Slot Command TRB
400 // The Disable Slot Command TRB releases any bandwidth assigned to the disabled slot and frees any
401 // internal xHC resources assigned to the slot.
403 typedef struct _CMD_TRB_DISABLE_SLOT
{
413 } CMD_TRB_DISABLE_SLOT
;
416 // 6.4.3.4 Address Device Command TRB
417 // The Address Device Command TRB transitions the selected Device Context from the Default to the
418 // Addressed state and causes the xHC to select an address for the USB device in the Default State and
419 // issue a SET_ADDRESS request to the USB device.
421 typedef struct _CMD_TRB_ADDRESS_DEVICE
{
434 } CMD_TRB_ADDRESS_DEVICE
;
437 // 6.4.3.5 Configure Endpoint Command TRB
438 // The Configure Endpoint Command TRB evaluates the bandwidth and resource requirements of the
439 // endpoints selected by the command.
441 typedef struct _CMD_TRB_CONFIG_ENDPOINT
{
454 } CMD_TRB_CONFIG_ENDPOINT
;
457 // 6.4.3.6 Evaluate Context Command TRB
458 // The Evaluate Context Command TRB is used by system software to inform the xHC that the selected
459 // Context data structures in the Device Context have been modified by system software and that the xHC
460 // shall evaluate any changes
462 typedef struct _CMD_TRB_EVALUATE_CONTEXT
{
474 } CMD_TRB_EVALUATE_CONTEXT
;
477 // 6.4.3.7 Reset Endpoint Command TRB
478 // The Reset Endpoint Command TRB is used by system software to reset a specified Transfer Ring
480 typedef struct _CMD_TRB_RESET_ENDPOINT
{
492 } CMD_TRB_RESET_ENDPOINT
;
495 // 6.4.3.8 Stop Endpoint Command TRB
496 // The Stop Endpoint Command TRB command allows software to stop the xHC execution of the TDs on a
497 // Transfer Ring and temporarily take ownership of TDs that had previously been passed to the xHC.
499 typedef struct _CMD_TRB_STOP_ENDPOINT
{
511 } CMD_TRB_STOP_ENDPOINT
;
514 // 6.4.3.9 Set TR Dequeue Pointer Command TRB
515 // The Set TR Dequeue Pointer Command TRB is used by system software to modify the TR Dequeue
516 // Pointer and DCS fields of an Endpoint or Stream Context.
518 typedef struct _CMD_SET_TR_DEQ_POINTER
{
532 } CMD_SET_TR_DEQ_POINTER
;
536 // A Link TRB provides support for non-contiguous TRB Rings.
538 typedef struct _LINK_TRB
{
544 UINT32 InterTarget
:10;
557 // 6.2.2 Slot Context
559 typedef struct _SLOT_CONTEXT
{
560 UINT32 RouteString
:20;
565 UINT32 ContextEntries
:5;
567 UINT32 MaxExitLatency
:16;
568 UINT32 RootHubPortNum
:8;
571 UINT32 TTHubSlotId
:8;
575 UINT32 InterTarget
:10;
577 UINT32 DeviceAddress
:8;
587 typedef struct _SLOT_CONTEXT_64
{
588 UINT32 RouteString
:20;
593 UINT32 ContextEntries
:5;
595 UINT32 MaxExitLatency
:16;
596 UINT32 RootHubPortNum
:8;
599 UINT32 TTHubSlotId
:8;
603 UINT32 InterTarget
:10;
605 UINT32 DeviceAddress
:8;
628 // 6.2.3 Endpoint Context
630 typedef struct _ENDPOINT_CONTEXT
{
634 UINT32 MaxPStreams
:5;
644 UINT32 MaxBurstSize
:8;
645 UINT32 MaxPacketSize
:16;
651 UINT32 AverageTRBLength
:16;
652 UINT32 MaxESITPayload
:16;
659 typedef struct _ENDPOINT_CONTEXT_64
{
663 UINT32 MaxPStreams
:5;
673 UINT32 MaxBurstSize
:8;
674 UINT32 MaxPacketSize
:16;
680 UINT32 AverageTRBLength
:16;
681 UINT32 MaxESITPayload
:16;
697 } ENDPOINT_CONTEXT_64
;
701 // 6.2.5.1 Input Control Context
703 typedef struct _INPUT_CONTRL_CONTEXT
{
712 } INPUT_CONTRL_CONTEXT
;
714 typedef struct _INPUT_CONTRL_CONTEXT_64
{
731 } INPUT_CONTRL_CONTEXT_64
;
734 // 6.2.1 Device Context
736 typedef struct _DEVICE_CONTEXT
{
738 ENDPOINT_CONTEXT EP
[31];
741 typedef struct _DEVICE_CONTEXT_64
{
742 SLOT_CONTEXT_64 Slot
;
743 ENDPOINT_CONTEXT_64 EP
[31];
747 // 6.2.5 Input Context
749 typedef struct _INPUT_CONTEXT
{
750 INPUT_CONTRL_CONTEXT InputControlContext
;
752 ENDPOINT_CONTEXT EP
[31];
755 typedef struct _INPUT_CONTEXT_64
{
756 INPUT_CONTRL_CONTEXT_64 InputControlContext
;
757 SLOT_CONTEXT_64 Slot
;
758 ENDPOINT_CONTEXT_64 EP
[31];
763 Initialize the XHCI host controller for schedule.
765 @param Xhc The XHCI Instance to be initialized.
770 IN USB_XHCI_INSTANCE
*Xhc
774 Free the resouce allocated at initializing schedule.
776 @param Xhc The XHCI Instance.
781 IN USB_XHCI_INSTANCE
*Xhc
785 Ring the door bell to notify XHCI there is a transaction to be executed through URB.
787 @param Xhc The XHCI Instance.
788 @param Urb The URB to be rung.
790 @retval EFI_SUCCESS Successfully ring the door bell.
794 RingIntTransferDoorBell (
795 IN USB_XHCI_INSTANCE
*Xhc
,
800 Execute the transfer by polling the URB. This is a synchronous operation.
802 @param Xhc The XHCI Instance.
803 @param CmdTransfer The executed URB is for cmd transfer or not.
804 @param Urb The URB to execute.
805 @param Timeout The time to wait before abort, in millisecond.
807 @return EFI_DEVICE_ERROR The transfer failed due to transfer error.
808 @return EFI_TIMEOUT The transfer failed due to time out.
809 @return EFI_SUCCESS The transfer finished OK.
814 IN USB_XHCI_INSTANCE
*Xhc
,
815 IN BOOLEAN CmdTransfer
,
821 Delete a single asynchronous interrupt transfer for
822 the device and endpoint.
824 @param Xhc The XHCI Instance.
825 @param BusAddr The logical device address assigned by UsbBus driver.
826 @param EpNum The endpoint of the target.
828 @retval EFI_SUCCESS An asynchronous transfer is removed.
829 @retval EFI_NOT_FOUND No transfer for the device is found.
833 XhciDelAsyncIntTransfer (
834 IN USB_XHCI_INSTANCE
*Xhc
,
840 Remove all the asynchronous interrupt transfers.
842 @param Xhc The XHCI Instance.
846 XhciDelAllAsyncIntTransfers (
847 IN USB_XHCI_INSTANCE
*Xhc
851 Insert a single asynchronous interrupt transfer for
852 the device and endpoint.
854 @param Xhc The XHCI Instance
855 @param BusAddr The logical device address assigned by UsbBus driver
856 @param EpAddr Endpoint addrress
857 @param DevSpeed The device speed
858 @param MaxPacket The max packet length of the endpoint
859 @param DataLen The length of data buffer
860 @param Callback The function to call when data is transferred
861 @param Context The context to the callback
863 @return Created URB or NULL
867 XhciInsertAsyncIntTransfer (
868 IN USB_XHCI_INSTANCE
*Xhc
,
874 IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback
,
881 @param Xhc The XHCI Instance.
885 XhcSetBiosOwnership (
886 IN USB_XHCI_INSTANCE
*Xhc
892 @param Xhc The XHCI Instance.
896 XhcClearBiosOwnership (
897 IN USB_XHCI_INSTANCE
*Xhc
901 Find out the slot id according to the device's route string.
903 @param Xhc The XHCI Instance.
904 @param RouteString The route string described the device location.
906 @return The slot id used by the device.
911 XhcRouteStringToSlotId (
912 IN USB_XHCI_INSTANCE
*Xhc
,
913 IN USB_DEV_ROUTE RouteString
917 Calculate the device context index by endpoint address and direction.
919 @param EpAddr The target endpoint number.
920 @param Direction The direction of the target endpoint.
922 @return The device context index of endpoint.
932 Ring the door bell to notify XHCI there is a transaction to be executed.
934 @param Xhc The XHCI Instance.
935 @param SlotId The slot id of the target device.
936 @param Dci The device context index of the target slot or endpoint.
938 @retval EFI_SUCCESS Successfully ring the door bell.
944 IN USB_XHCI_INSTANCE
*Xhc
,
950 Interrupt transfer periodic check handler.
952 @param Event Interrupt event.
953 @param Context Pointer to USB_XHCI_INSTANCE.
958 XhcMonitorAsyncRequests (
964 Monitor the port status change. Enable/Disable device slot if there is a device attached/detached.
966 @param Xhc The XHCI Instance.
967 @param ParentRouteChart The route string pointed to the parent device if it exists.
968 @param Port The port to be polled.
969 @param PortState The port state.
971 @retval EFI_SUCCESS Successfully enable/disable device slot according to port state.
972 @retval Others Should not appear.
977 XhcPollPortStatusChange (
978 IN USB_XHCI_INSTANCE
*Xhc
,
979 IN USB_DEV_ROUTE ParentRouteChart
,
981 IN EFI_USB_PORT_STATUS
*PortState
985 Evaluate the slot context for hub device through XHCI's Configure_Endpoint cmd.
987 @param Xhc The XHCI Instance.
988 @param SlotId The slot id to be configured.
989 @param PortNum The total number of downstream port supported by the hub.
990 @param TTT The TT think time of the hub device.
991 @param MTT The multi-TT of the hub device.
993 @retval EFI_SUCCESS Successfully configure the hub device's slot context.
997 XhcConfigHubContext (
998 IN USB_XHCI_INSTANCE
*Xhc
,
1007 Evaluate the slot context for hub device through XHCI's Configure_Endpoint cmd.
1009 @param Xhc The XHCI Instance.
1010 @param SlotId The slot id to be configured.
1011 @param PortNum The total number of downstream port supported by the hub.
1012 @param TTT The TT think time of the hub device.
1013 @param MTT The multi-TT of the hub device.
1015 @retval EFI_SUCCESS Successfully configure the hub device's slot context.
1019 XhcConfigHubContext64 (
1020 IN USB_XHCI_INSTANCE
*Xhc
,
1029 Configure all the device endpoints through XHCI's Configure_Endpoint cmd.
1031 @param Xhc The XHCI Instance.
1032 @param SlotId The slot id to be configured.
1033 @param DeviceSpeed The device's speed.
1034 @param ConfigDesc The pointer to the usb device configuration descriptor.
1036 @retval EFI_SUCCESS Successfully configure all the device endpoints.
1042 IN USB_XHCI_INSTANCE
*Xhc
,
1044 IN UINT8 DeviceSpeed
,
1045 IN USB_CONFIG_DESCRIPTOR
*ConfigDesc
1050 Configure all the device endpoints through XHCI's Configure_Endpoint cmd.
1052 @param Xhc The XHCI Instance.
1053 @param SlotId The slot id to be configured.
1054 @param DeviceSpeed The device's speed.
1055 @param ConfigDesc The pointer to the usb device configuration descriptor.
1057 @retval EFI_SUCCESS Successfully configure all the device endpoints.
1063 IN USB_XHCI_INSTANCE
*Xhc
,
1065 IN UINT8 DeviceSpeed
,
1066 IN USB_CONFIG_DESCRIPTOR
*ConfigDesc
1070 Set interface through XHCI's Configure_Endpoint cmd.
1072 @param Xhc The XHCI Instance.
1073 @param SlotId The slot id to be configured.
1074 @param DeviceSpeed The device's speed.
1075 @param ConfigDesc The pointer to the usb device configuration descriptor.
1076 @param Request USB device request to send.
1078 @retval EFI_SUCCESS Successfully set interface.
1084 IN USB_XHCI_INSTANCE
*Xhc
,
1086 IN UINT8 DeviceSpeed
,
1087 IN USB_CONFIG_DESCRIPTOR
*ConfigDesc
,
1088 IN EFI_USB_DEVICE_REQUEST
*Request
1092 Set interface through XHCI's Configure_Endpoint cmd.
1094 @param Xhc The XHCI Instance.
1095 @param SlotId The slot id to be configured.
1096 @param DeviceSpeed The device's speed.
1097 @param ConfigDesc The pointer to the usb device configuration descriptor.
1098 @param Request USB device request to send.
1100 @retval EFI_SUCCESS Successfully set interface.
1106 IN USB_XHCI_INSTANCE
*Xhc
,
1108 IN UINT8 DeviceSpeed
,
1109 IN USB_CONFIG_DESCRIPTOR
*ConfigDesc
,
1110 IN EFI_USB_DEVICE_REQUEST
*Request
1114 Find out the actual device address according to the requested device address from UsbBus.
1116 @param Xhc The XHCI Instance.
1117 @param BusDevAddr The requested device address by UsbBus upper driver.
1119 @return The actual device address assigned to the device.
1124 XhcBusDevAddrToSlotId (
1125 IN USB_XHCI_INSTANCE
*Xhc
,
1130 Assign and initialize the device slot for a new device.
1132 @param Xhc The XHCI Instance.
1133 @param ParentRouteChart The route string pointed to the parent device.
1134 @param ParentPort The port at which the device is located.
1135 @param RouteChart The route string pointed to the device.
1136 @param DeviceSpeed The device speed.
1138 @retval EFI_SUCCESS Successfully assign a slot to the device and assign an address to it.
1143 XhcInitializeDeviceSlot (
1144 IN USB_XHCI_INSTANCE
*Xhc
,
1145 IN USB_DEV_ROUTE ParentRouteChart
,
1146 IN UINT16 ParentPort
,
1147 IN USB_DEV_ROUTE RouteChart
,
1148 IN UINT8 DeviceSpeed
1152 Assign and initialize the device slot for a new device.
1154 @param Xhc The XHCI Instance.
1155 @param ParentRouteChart The route string pointed to the parent device.
1156 @param ParentPort The port at which the device is located.
1157 @param RouteChart The route string pointed to the device.
1158 @param DeviceSpeed The device speed.
1160 @retval EFI_SUCCESS Successfully assign a slot to the device and assign an address to it.
1165 XhcInitializeDeviceSlot64 (
1166 IN USB_XHCI_INSTANCE
*Xhc
,
1167 IN USB_DEV_ROUTE ParentRouteChart
,
1168 IN UINT16 ParentPort
,
1169 IN USB_DEV_ROUTE RouteChart
,
1170 IN UINT8 DeviceSpeed
1174 Evaluate the endpoint 0 context through XHCI's Evaluate_Context cmd.
1176 @param Xhc The XHCI Instance.
1177 @param SlotId The slot id to be evaluated.
1178 @param MaxPacketSize The max packet size supported by the device control transfer.
1180 @retval EFI_SUCCESS Successfully evaluate the device endpoint 0.
1185 XhcEvaluateContext (
1186 IN USB_XHCI_INSTANCE
*Xhc
,
1188 IN UINT32 MaxPacketSize
1193 Evaluate the endpoint 0 context through XHCI's Evaluate_Context cmd.
1195 @param Xhc The XHCI Instance.
1196 @param SlotId The slot id to be evaluated.
1197 @param MaxPacketSize The max packet size supported by the device control transfer.
1199 @retval EFI_SUCCESS Successfully evaluate the device endpoint 0.
1204 XhcEvaluateContext64 (
1205 IN USB_XHCI_INSTANCE
*Xhc
,
1207 IN UINT32 MaxPacketSize
1212 Disable the specified device slot.
1214 @param Xhc The XHCI Instance.
1215 @param SlotId The slot id to be disabled.
1217 @retval EFI_SUCCESS Successfully disable the device slot.
1223 IN USB_XHCI_INSTANCE
*Xhc
,
1229 Disable the specified device slot.
1231 @param Xhc The XHCI Instance.
1232 @param SlotId The slot id to be disabled.
1234 @retval EFI_SUCCESS Successfully disable the device slot.
1239 XhcDisableSlotCmd64 (
1240 IN USB_XHCI_INSTANCE
*Xhc
,
1246 Synchronize the specified transfer ring to update the enqueue and dequeue pointer.
1248 @param Xhc The XHCI Instance.
1249 @param TrsRing The transfer ring to sync.
1251 @retval EFI_SUCCESS The transfer ring is synchronized successfully.
1257 IN USB_XHCI_INSTANCE
*Xhc
,
1258 TRANSFER_RING
*TrsRing
1262 Synchronize the specified event ring to update the enqueue and dequeue pointer.
1264 @param Xhc The XHCI Instance.
1265 @param EvtRing The event ring to sync.
1267 @retval EFI_SUCCESS The event ring is synchronized successfully.
1273 IN USB_XHCI_INSTANCE
*Xhc
,
1278 Check if there is a new generated event.
1280 @param Xhc The XHCI Instance.
1281 @param EvtRing The event ring to check.
1282 @param NewEvtTrb The new event TRB found.
1284 @retval EFI_SUCCESS Found a new event TRB at the event ring.
1285 @retval EFI_NOT_READY The event ring has no new event.
1291 IN USB_XHCI_INSTANCE
*Xhc
,
1292 IN EVENT_RING
*EvtRing
,
1293 OUT TRB_TEMPLATE
**NewEvtTrb
1297 Create XHCI transfer ring.
1299 @param Xhc The XHCI Instance.
1300 @param TrbNum The number of TRB in the ring.
1301 @param TransferRing The created transfer ring.
1305 CreateTransferRing (
1306 IN USB_XHCI_INSTANCE
*Xhc
,
1308 OUT TRANSFER_RING
*TransferRing
1312 Create XHCI event ring.
1314 @param Xhc The XHCI Instance.
1315 @param EventRing The created event ring.
1320 IN USB_XHCI_INSTANCE
*Xhc
,
1321 OUT EVENT_RING
*EventRing
1325 System software shall use a Reset Endpoint Command (section 4.11.4.7) to remove the Halted
1326 condition in the xHC. After the successful completion of the Reset Endpoint Command, the Endpoint
1327 Context is transitioned from the Halted to the Stopped state and the Transfer Ring of the endpoint is
1328 reenabled. The next write to the Doorbell of the Endpoint will transition the Endpoint Context from the
1329 Stopped to the Running state.
1331 @param Xhc The XHCI Instance.
1332 @param Urb The urb which makes the endpoint halted.
1334 @retval EFI_SUCCESS The recovery is successful.
1335 @retval Others Failed to recovery halted endpoint.
1340 XhcRecoverHaltedEndpoint (
1341 IN USB_XHCI_INSTANCE
*Xhc
,
1346 System software shall use a Stop Endpoint Command (section 4.6.9) and the Set TR Dequeue Pointer
1347 Command (section 4.6.10) to remove the timed-out TDs from the xHC transfer ring. The next write to
1348 the Doorbell of the Endpoint will transition the Endpoint Context from the Stopped to the Running
1351 @param Xhc The XHCI Instance.
1352 @param Urb The urb which doesn't get completed in a specified timeout range.
1354 @retval EFI_SUCCESS The dequeuing of the TDs is successful.
1355 @retval Others Failed to stop the endpoint and dequeue the TDs.
1360 XhcDequeueTrbFromEndpoint (
1361 IN USB_XHCI_INSTANCE
*Xhc
,
1366 Stop endpoint through XHCI's Stop_Endpoint cmd.
1368 @param Xhc The XHCI Instance.
1369 @param SlotId The slot id to be configured.
1370 @param Dci The device context index of endpoint.
1371 @param PendingUrb The pending URB to check completion status when stopping the end point.
1373 @retval EFI_SUCCESS Stop endpoint successfully.
1374 @retval Others Failed to stop endpoint.
1380 IN USB_XHCI_INSTANCE
*Xhc
,
1383 IN URB
*PendingUrb OPTIONAL
1387 Reset endpoint through XHCI's Reset_Endpoint cmd.
1389 @param Xhc The XHCI Instance.
1390 @param SlotId The slot id to be configured.
1391 @param Dci The device context index of endpoint.
1393 @retval EFI_SUCCESS Reset endpoint successfully.
1394 @retval Others Failed to reset endpoint.
1400 IN USB_XHCI_INSTANCE
*Xhc
,
1406 Set transfer ring dequeue pointer through XHCI's Set_Tr_Dequeue_Pointer cmd.
1408 @param Xhc The XHCI Instance.
1409 @param SlotId The slot id to be configured.
1410 @param Dci The device context index of endpoint.
1411 @param Urb The dequeue pointer of the transfer ring specified
1412 by the urb to be updated.
1414 @retval EFI_SUCCESS Set transfer ring dequeue pointer succeeds.
1415 @retval Others Failed to set transfer ring dequeue pointer.
1420 XhcSetTrDequeuePointer (
1421 IN USB_XHCI_INSTANCE
*Xhc
,
1428 Create a new URB for a new transaction.
1430 @param Xhc The XHCI Instance
1431 @param DevAddr The device address
1432 @param EpAddr Endpoint addrress
1433 @param DevSpeed The device speed
1434 @param MaxPacket The max packet length of the endpoint
1435 @param Type The transaction type
1436 @param Request The standard USB request for control transfer
1437 @param Data The user data to transfer
1438 @param DataLen The length of data buffer
1439 @param Callback The function to call when data is transferred
1440 @param Context The context to the callback
1442 @return Created URB or NULL
1447 IN USB_XHCI_INSTANCE
*Xhc
,
1453 IN EFI_USB_DEVICE_REQUEST
*Request
,
1456 IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback
,
1461 Free an allocated URB.
1463 @param Xhc The XHCI device.
1464 @param Urb The URB to free.
1469 IN USB_XHCI_INSTANCE
*Xhc
,
1474 Create a transfer TRB.
1476 @param Xhc The XHCI Instance
1477 @param Urb The urb used to construct the transfer TRB.
1479 @return Created TRB or NULL
1483 XhcCreateTransferTrb (
1484 IN USB_XHCI_INSTANCE
*Xhc
,