3 Provides some data structure definitions used by the XHCI host controller driver.
5 Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #include <Protocol/Usb2HostController.h>
22 #include <Protocol/PciIo.h>
24 #include <Guid/EventGroup.h>
26 #include <Library/BaseLib.h>
27 #include <Library/BaseMemoryLib.h>
28 #include <Library/UefiDriverEntryPoint.h>
29 #include <Library/UefiBootServicesTableLib.h>
30 #include <Library/MemoryAllocationLib.h>
31 #include <Library/UefiLib.h>
32 #include <Library/DebugLib.h>
33 #include <Library/ReportStatusCodeLib.h>
35 #include <IndustryStandard/Pci.h>
37 typedef struct _USB_XHCI_INSTANCE USB_XHCI_INSTANCE
;
38 typedef struct _USB_DEV_CONTEXT USB_DEV_CONTEXT
;
41 #include "XhciSched.h"
42 #include "ComponentName.h"
46 // The unit is microsecond, setting it as 1us.
48 #define XHC_1_MICROSECOND (1)
50 // Convert millisecond to microsecond.
52 #define XHC_1_MILLISECOND (1000)
54 // XHC generic timeout experience values.
55 // The unit is microsecond, setting it as 10ms.
57 #define XHC_GENERIC_TIMEOUT (10 * 1000)
59 // XHC reset timeout experience values.
60 // The unit is microsecond, setting it as 1s.
62 #define XHC_RESET_TIMEOUT (1000 * 1000)
64 // XHC delay experience value for polling operation.
65 // The unit is microsecond, set it as 1ms.
67 #define XHC_POLL_DELAY (1000)
69 // XHC async transfer timer interval, set by experience.
70 // The unit is 100us, takes 50ms as interval.
72 #define XHC_ASYNC_TIMER_INTERVAL EFI_TIMER_PERIOD_MILLISECONDS(50)
75 // XHC raises TPL to TPL_NOTIFY to serialize all its operations
76 // to protect shared data structures.
78 #define XHC_TPL TPL_NOTIFY
80 #define CMD_RING_TRB_NUMBER 0x100
81 #define TR_RING_TRB_NUMBER 0x100
82 #define ERST_NUMBER 0x01
83 #define EVENT_RING_TRB_NUMBER 0x200
89 #define INT_INTER_ASYNC 4
92 // Iterate through the doule linked list. This is delete-safe.
93 // Don't touch NextEntry
95 #define EFI_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
96 for (Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink;\
97 Entry != (ListHead); Entry = NextEntry, NextEntry = Entry->ForwardLink)
99 #define EFI_LIST_CONTAINER(Entry, Type, Field) BASE_CR(Entry, Type, Field)
101 #define XHC_LOW_32BIT(Addr64) ((UINT32)(((UINTN)(Addr64)) & 0xFFFFFFFF))
102 #define XHC_HIGH_32BIT(Addr64) ((UINT32)(RShiftU64((UINT64)(UINTN)(Addr64), 32) & 0xFFFFFFFF))
103 #define XHC_BIT_IS_SET(Data, Bit) ((BOOLEAN)(((Data) & (Bit)) == (Bit)))
105 #define XHC_REG_BIT_IS_SET(Xhc, Offset, Bit) \
106 (XHC_BIT_IS_SET(XhcReadOpReg ((Xhc), (Offset)), (Bit)))
108 #define XHCI_IS_DATAIN(EndpointAddr) XHC_BIT_IS_SET((EndpointAddr), 0x80)
110 #define XHCI_INSTANCE_SIG SIGNATURE_32 ('x', 'h', 'c', 'i')
111 #define XHC_FROM_THIS(a) CR(a, USB_XHCI_INSTANCE, Usb2Hc, XHCI_INSTANCE_SIG)
113 #define USB_DESC_TYPE_HUB 0x29
114 #define USB_DESC_TYPE_HUB_SUPER_SPEED 0x2a
117 // The RequestType in EFI_USB_DEVICE_REQUEST is composed of
118 // three fields: One bit direction, 2 bit type, and 5 bit
121 #define USB_REQUEST_TYPE(Dir, Type, Target) \
122 ((UINT8)((((Dir) == EfiUsbDataIn ? 0x01 : 0) << 7) | (Type) | (Target)))
125 // Xhci Data and Ctrl Structures
140 UINT8 HubContrCurrent
;
142 } EFI_USB_HUB_DESCRIPTOR
;
145 struct _USB_DEV_CONTEXT
{
147 // Whether this entry in UsbDevContext array is used or not.
151 // The slot id assigned to the new device through XHCI's Enable_Slot cmd.
155 // The route string presented an attached usb device.
157 USB_DEV_ROUTE RouteString
;
159 // The route string of parent device if it exists. Otherwise it's zero.
161 USB_DEV_ROUTE ParentRouteString
;
163 // The actual device address assigned by XHCI through Address_Device command.
167 // The requested device address from UsbBus driver through Set_Address standard usb request.
168 // As XHCI spec replaces this request with Address_Device command, we have to record the
169 // requested device address and establish a mapping relationship with the actual device address.
170 // Then UsbBus driver just need to be aware of the requested device address to access usb device
171 // through EFI_USB2_HC_PROTOCOL. Xhci driver would be responsible for translating it to actual
172 // device address and access the actual device.
176 // The pointer to the input device context.
180 // The pointer to the output device context.
184 // The transfer queue for every endpoint.
186 VOID
*EndpointTransferRing
[31];
188 // The device descriptor which is stored to support XHCI's Evaluate_Context cmd.
190 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
192 // As a usb device may include multiple configuration descriptors, we dynamically allocate an array
194 // Note that every configuration descriptor stored here includes those lower level descriptors,
195 // such as Interface descriptor, Endpoint descriptor, and so on.
196 // These information is used to support XHCI's Config_Endpoint cmd.
198 EFI_USB_CONFIG_DESCRIPTOR
**ConfDesc
;
201 struct _USB_XHCI_INSTANCE
{
203 EFI_PCI_IO_PROTOCOL
*PciIo
;
204 UINT64 OriginalPciAttributes
;
205 USBHC_MEM_POOL
*MemPool
;
207 EFI_USB2_HC_PROTOCOL Usb2Hc
;
209 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
212 // ExitBootServicesEvent is used to set OS semaphore and
213 // stop the XHC DMA operation after exit boot service.
215 EFI_EVENT ExitBootServiceEvent
;
217 LIST_ENTRY AsyncIntTransfers
;
219 UINT8 CapLength
; ///< Capability Register Length
220 XHC_HCSPARAMS1 HcSParams1
; ///< Structural Parameters 1
221 XHC_HCSPARAMS2 HcSParams2
; ///< Structural Parameters 2
222 XHC_HCCPARAMS HcCParams
; ///< Capability Parameters
223 UINT32 DBOff
; ///< Doorbell Offset
224 UINT32 RTSOff
; ///< Runtime Register Space Offset
229 UINT32 MaxScratchpadBufs
;
230 UINT64
*ScratchEntry
;
231 UINTN
*ScratchEntryMap
;
232 UINT32 ExtCapRegBase
;
233 UINT32 UsbLegSupOffset
;
234 UINT32 DebugCapSupOffset
;
241 TRANSFER_RING CmdRing
;
245 EVENT_RING EventRing
;
249 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
252 // Store device contexts managed by XHCI instance
253 // The array supports up to 255 devices, entry 0 is reserved and should not be used.
255 USB_DEV_CONTEXT UsbDevContext
[256];
259 extern EFI_DRIVER_BINDING_PROTOCOL gXhciDriverBinding
;
260 extern EFI_COMPONENT_NAME_PROTOCOL gXhciComponentName
;
261 extern EFI_COMPONENT_NAME2_PROTOCOL gXhciComponentName2
;
264 Test to see if this driver supports ControllerHandle. Any
265 ControllerHandle that has Usb2HcProtocol installed will
268 @param This Protocol instance pointer.
269 @param Controller Handle of device to test.
270 @param RemainingDevicePath Not used.
272 @return EFI_SUCCESS This driver supports this device.
273 @return EFI_UNSUPPORTED This driver does not support this device.
278 XhcDriverBindingSupported (
279 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
280 IN EFI_HANDLE Controller
,
281 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
285 Starting the Usb XHCI Driver.
287 @param This Protocol instance pointer.
288 @param Controller Handle of device to test.
289 @param RemainingDevicePath Not used.
291 @return EFI_SUCCESS supports this device.
292 @return EFI_UNSUPPORTED do not support this device.
293 @return EFI_DEVICE_ERROR cannot be started due to device Error.
294 @return EFI_OUT_OF_RESOURCES cannot allocate resources.
299 XhcDriverBindingStart (
300 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
301 IN EFI_HANDLE Controller
,
302 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
306 Stop this driver on ControllerHandle. Support stoping any child handles
307 created by this driver.
309 @param This Protocol instance pointer.
310 @param Controller Handle of device to stop driver on.
311 @param NumberOfChildren Number of Children in the ChildHandleBuffer.
312 @param ChildHandleBuffer List of handles for the children we need to stop.
314 @return EFI_SUCCESS Success.
315 @return EFI_DEVICE_ERROR Fail.
320 XhcDriverBindingStop (
321 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
322 IN EFI_HANDLE Controller
,
323 IN UINTN NumberOfChildren
,
324 IN EFI_HANDLE
*ChildHandleBuffer
328 Retrieves the capability of root hub ports.
330 @param This The EFI_USB2_HC_PROTOCOL instance.
331 @param MaxSpeed Max speed supported by the controller.
332 @param PortNumber Number of the root hub ports.
333 @param Is64BitCapable Whether the controller supports 64-bit memory
336 @retval EFI_SUCCESS Host controller capability were retrieved successfully.
337 @retval EFI_INVALID_PARAMETER Either of the three capability pointer is NULL.
343 IN EFI_USB2_HC_PROTOCOL
*This
,
345 OUT UINT8
*PortNumber
,
346 OUT UINT8
*Is64BitCapable
350 Provides software reset for the USB host controller.
352 @param This This EFI_USB2_HC_PROTOCOL instance.
353 @param Attributes A bit mask of the reset operation to perform.
355 @retval EFI_SUCCESS The reset operation succeeded.
356 @retval EFI_INVALID_PARAMETER Attributes is not valid.
357 @retval EFI_UNSUPPOURTED The type of reset specified by Attributes is
358 not currently supported by the host controller.
359 @retval EFI_DEVICE_ERROR Host controller isn't halted to reset.
365 IN EFI_USB2_HC_PROTOCOL
*This
,
370 Retrieve the current state of the USB host controller.
372 @param This This EFI_USB2_HC_PROTOCOL instance.
373 @param State Variable to return the current host controller
376 @retval EFI_SUCCESS Host controller state was returned in State.
377 @retval EFI_INVALID_PARAMETER State is NULL.
378 @retval EFI_DEVICE_ERROR An error was encountered while attempting to
379 retrieve the host controller's current state.
385 IN EFI_USB2_HC_PROTOCOL
*This
,
386 OUT EFI_USB_HC_STATE
*State
390 Sets the USB host controller to a specific state.
392 @param This This EFI_USB2_HC_PROTOCOL instance.
393 @param State The state of the host controller that will be set.
395 @retval EFI_SUCCESS The USB host controller was successfully placed
396 in the state specified by State.
397 @retval EFI_INVALID_PARAMETER State is invalid.
398 @retval EFI_DEVICE_ERROR Failed to set the state due to device error.
404 IN EFI_USB2_HC_PROTOCOL
*This
,
405 IN EFI_USB_HC_STATE State
409 Retrieves the current status of a USB root hub port.
411 @param This This EFI_USB2_HC_PROTOCOL instance.
412 @param PortNumber The root hub port to retrieve the state from.
413 This value is zero-based.
414 @param PortStatus Variable to receive the port state.
416 @retval EFI_SUCCESS The status of the USB root hub port specified.
417 by PortNumber was returned in PortStatus.
418 @retval EFI_INVALID_PARAMETER PortNumber is invalid.
419 @retval EFI_DEVICE_ERROR Can't read register.
424 XhcGetRootHubPortStatus (
425 IN EFI_USB2_HC_PROTOCOL
*This
,
427 OUT EFI_USB_PORT_STATUS
*PortStatus
431 Sets a feature for the specified root hub port.
433 @param This This EFI_USB2_HC_PROTOCOL instance.
434 @param PortNumber Root hub port to set.
435 @param PortFeature Feature to set.
437 @retval EFI_SUCCESS The feature specified by PortFeature was set.
438 @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid.
439 @retval EFI_DEVICE_ERROR Can't read register.
444 XhcSetRootHubPortFeature (
445 IN EFI_USB2_HC_PROTOCOL
*This
,
447 IN EFI_USB_PORT_FEATURE PortFeature
451 Clears a feature for the specified root hub port.
453 @param This A pointer to the EFI_USB2_HC_PROTOCOL instance.
454 @param PortNumber Specifies the root hub port whose feature is
455 requested to be cleared.
456 @param PortFeature Indicates the feature selector associated with the
457 feature clear request.
459 @retval EFI_SUCCESS The feature specified by PortFeature was cleared
460 for the USB root hub port specified by PortNumber.
461 @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid.
462 @retval EFI_DEVICE_ERROR Can't read register.
467 XhcClearRootHubPortFeature (
468 IN EFI_USB2_HC_PROTOCOL
*This
,
470 IN EFI_USB_PORT_FEATURE PortFeature
474 Submits control transfer to a target USB device.
476 @param This This EFI_USB2_HC_PROTOCOL instance.
477 @param DeviceAddress The target device address.
478 @param DeviceSpeed Target device speed.
479 @param MaximumPacketLength Maximum packet size the default control transfer
480 endpoint is capable of sending or receiving.
481 @param Request USB device request to send.
482 @param TransferDirection Specifies the data direction for the data stage
483 @param Data Data buffer to be transmitted or received from USB
485 @param DataLength The size (in bytes) of the data buffer.
486 @param Timeout Indicates the maximum timeout, in millisecond.
487 @param Translator Transaction translator to be used by this device.
488 @param TransferResult Return the result of this control transfer.
490 @retval EFI_SUCCESS Transfer was completed successfully.
491 @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resources.
492 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
493 @retval EFI_TIMEOUT Transfer failed due to timeout.
494 @retval EFI_DEVICE_ERROR Transfer failed due to host controller or device error.
500 IN EFI_USB2_HC_PROTOCOL
*This
,
501 IN UINT8 DeviceAddress
,
502 IN UINT8 DeviceSpeed
,
503 IN UINTN MaximumPacketLength
,
504 IN EFI_USB_DEVICE_REQUEST
*Request
,
505 IN EFI_USB_DATA_DIRECTION TransferDirection
,
507 IN OUT UINTN
*DataLength
,
509 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
510 OUT UINT32
*TransferResult
514 Submits bulk transfer to a bulk endpoint of a USB device.
516 @param This This EFI_USB2_HC_PROTOCOL instance.
517 @param DeviceAddress Target device address.
518 @param EndPointAddress Endpoint number and its direction in bit 7.
519 @param DeviceSpeed Device speed, Low speed device doesn't support bulk
521 @param MaximumPacketLength Maximum packet size the endpoint is capable of
522 sending or receiving.
523 @param DataBuffersNumber Number of data buffers prepared for the transfer.
524 @param Data Array of pointers to the buffers of data to transmit
525 from or receive into.
526 @param DataLength The lenght of the data buffer.
527 @param DataToggle On input, the initial data toggle for the transfer;
528 On output, it is updated to to next data toggle to
529 use of the subsequent bulk transfer.
530 @param Timeout Indicates the maximum time, in millisecond, which
531 the transfer is allowed to complete.
532 @param Translator A pointr to the transaction translator data.
533 @param TransferResult A pointer to the detailed result information of the
536 @retval EFI_SUCCESS The transfer was completed successfully.
537 @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource.
538 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
539 @retval EFI_TIMEOUT The transfer failed due to timeout.
540 @retval EFI_DEVICE_ERROR The transfer failed due to host controller error.
546 IN EFI_USB2_HC_PROTOCOL
*This
,
547 IN UINT8 DeviceAddress
,
548 IN UINT8 EndPointAddress
,
549 IN UINT8 DeviceSpeed
,
550 IN UINTN MaximumPacketLength
,
551 IN UINT8 DataBuffersNumber
,
552 IN OUT VOID
*Data
[EFI_USB_MAX_BULK_BUFFER_NUM
],
553 IN OUT UINTN
*DataLength
,
554 IN OUT UINT8
*DataToggle
,
556 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
557 OUT UINT32
*TransferResult
561 Submits an asynchronous interrupt transfer to an
562 interrupt endpoint of a USB device.
564 @param This This EFI_USB2_HC_PROTOCOL instance.
565 @param DeviceAddress Target device address.
566 @param EndPointAddress Endpoint number and its direction encoded in bit 7
567 @param DeviceSpeed Indicates device speed.
568 @param MaximumPacketLength Maximum packet size the target endpoint is capable
569 @param IsNewTransfer If TRUE, to submit an new asynchronous interrupt
570 transfer If FALSE, to remove the specified
571 asynchronous interrupt.
572 @param DataToggle On input, the initial data toggle to use; on output,
573 it is updated to indicate the next data toggle.
574 @param PollingInterval The he interval, in milliseconds, that the transfer
576 @param DataLength The length of data to receive at the rate specified
578 @param Translator Transaction translator to use.
579 @param CallBackFunction Function to call at the rate specified by
581 @param Context Context to CallBackFunction.
583 @retval EFI_SUCCESS The request has been successfully submitted or canceled.
584 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
585 @retval EFI_OUT_OF_RESOURCES The request failed due to a lack of resources.
586 @retval EFI_DEVICE_ERROR The transfer failed due to host controller error.
591 XhcAsyncInterruptTransfer (
592 IN EFI_USB2_HC_PROTOCOL
*This
,
593 IN UINT8 DeviceAddress
,
594 IN UINT8 EndPointAddress
,
595 IN UINT8 DeviceSpeed
,
596 IN UINTN MaximumPacketLength
,
597 IN BOOLEAN IsNewTransfer
,
598 IN OUT UINT8
*DataToggle
,
599 IN UINTN PollingInterval
,
601 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
602 IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction
,
603 IN VOID
*Context OPTIONAL
607 Submits synchronous interrupt transfer to an interrupt endpoint
610 @param This This EFI_USB2_HC_PROTOCOL instance.
611 @param DeviceAddress Target device address.
612 @param EndPointAddress Endpoint number and its direction encoded in bit 7
613 @param DeviceSpeed Indicates device speed.
614 @param MaximumPacketLength Maximum packet size the target endpoint is capable
615 of sending or receiving.
616 @param Data Buffer of data that will be transmitted to USB
617 device or received from USB device.
618 @param DataLength On input, the size, in bytes, of the data buffer; On
619 output, the number of bytes transferred.
620 @param DataToggle On input, the initial data toggle to use; on output,
621 it is updated to indicate the next data toggle.
622 @param Timeout Maximum time, in second, to complete.
623 @param Translator Transaction translator to use.
624 @param TransferResult Variable to receive the transfer result.
626 @return EFI_SUCCESS The transfer was completed successfully.
627 @return EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource.
628 @return EFI_INVALID_PARAMETER Some parameters are invalid.
629 @return EFI_TIMEOUT The transfer failed due to timeout.
630 @return EFI_DEVICE_ERROR The failed due to host controller or device error
635 XhcSyncInterruptTransfer (
636 IN EFI_USB2_HC_PROTOCOL
*This
,
637 IN UINT8 DeviceAddress
,
638 IN UINT8 EndPointAddress
,
639 IN UINT8 DeviceSpeed
,
640 IN UINTN MaximumPacketLength
,
642 IN OUT UINTN
*DataLength
,
643 IN OUT UINT8
*DataToggle
,
645 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
646 OUT UINT32
*TransferResult
650 Submits isochronous transfer to a target USB device.
652 @param This This EFI_USB2_HC_PROTOCOL instance.
653 @param DeviceAddress Target device address.
654 @param EndPointAddress End point address with its direction.
655 @param DeviceSpeed Device speed, Low speed device doesn't support this
657 @param MaximumPacketLength Maximum packet size that the endpoint is capable of
658 sending or receiving.
659 @param DataBuffersNumber Number of data buffers prepared for the transfer.
660 @param Data Array of pointers to the buffers of data that will
661 be transmitted to USB device or received from USB
663 @param DataLength The size, in bytes, of the data buffer.
664 @param Translator Transaction translator to use.
665 @param TransferResult Variable to receive the transfer result.
667 @return EFI_UNSUPPORTED Isochronous transfer is unsupported.
672 XhcIsochronousTransfer (
673 IN EFI_USB2_HC_PROTOCOL
*This
,
674 IN UINT8 DeviceAddress
,
675 IN UINT8 EndPointAddress
,
676 IN UINT8 DeviceSpeed
,
677 IN UINTN MaximumPacketLength
,
678 IN UINT8 DataBuffersNumber
,
679 IN OUT VOID
*Data
[EFI_USB_MAX_ISO_BUFFER_NUM
],
681 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
682 OUT UINT32
*TransferResult
686 Submits Async isochronous transfer to a target USB device.
688 @param This This EFI_USB2_HC_PROTOCOL instance.
689 @param DeviceAddress Target device address.
690 @param EndPointAddress End point address with its direction.
691 @param DeviceSpeed Device speed, Low speed device doesn't support this
693 @param MaximumPacketLength Maximum packet size that the endpoint is capable of
694 sending or receiving.
695 @param DataBuffersNumber Number of data buffers prepared for the transfer.
696 @param Data Array of pointers to the buffers of data that will
697 be transmitted to USB device or received from USB
699 @param DataLength The size, in bytes, of the data buffer.
700 @param Translator Transaction translator to use.
701 @param IsochronousCallBack Function to be called when the transfer complete.
702 @param Context Context passed to the call back function as
705 @return EFI_UNSUPPORTED Isochronous transfer isn't supported.
710 XhcAsyncIsochronousTransfer (
711 IN EFI_USB2_HC_PROTOCOL
*This
,
712 IN UINT8 DeviceAddress
,
713 IN UINT8 EndPointAddress
,
714 IN UINT8 DeviceSpeed
,
715 IN UINTN MaximumPacketLength
,
716 IN UINT8 DataBuffersNumber
,
717 IN OUT VOID
*Data
[EFI_USB_MAX_ISO_BUFFER_NUM
],
719 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
720 IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack
,