Uhci.h File Reference

#include <Uefi.h>
#include <Protocol/Usb2HostController.h>
#include <Protocol/PciIo.h>
#include <Guid/EventGroup.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PcdLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <IndustryStandard/Pci.h>
#include "UsbHcMem.h"
#include "UhciQueue.h"
#include "UhciReg.h"
#include "UhciSched.h"
#include "UhciDebug.h"
#include "ComponentName.h"

Go to the source code of this file.

Data Structures
struct	USB_CLASSC
struct	_USB_HC_DEV

Macros
#define	UHC_1_MICROSECOND   1
#define	UHC_1_MILLISECOND   (1000 * UHC_1_MICROSECOND)
#define	UHC_1_SECOND   (1000 * UHC_1_MILLISECOND)
#define	UHC_GENERIC_TIMEOUT   UHC_1_SECOND
#define	UHC_FORCE_GLOBAL_RESUME_STALL   (20 * UHC_1_MILLISECOND)
#define	UHC_ROOT_PORT_RESET_STALL   (50 * UHC_1_MILLISECOND)
#define	UHC_ROOT_PORT_RECOVERY_STALL   (10 * UHC_1_MILLISECOND)
#define	UHC_SYNC_POLL_INTERVAL   (1 * UHC_1_MILLISECOND)
#define	UHC_ASYNC_POLL_INTERVAL   EFI_TIMER_PERIOD_MILLISECONDS(1)
#define	UHCI_TPL   TPL_NOTIFY
#define	USB_HC_DEV_SIGNATURE   SIGNATURE_32 ('u', 'h', 'c', 'i')
#define	UHC_FROM_USB2_HC_PROTO(This)   CR(This, USB_HC_DEV, Usb2Hc, USB_HC_DEV_SIGNATURE)

Typedefs
typedef struct _USB_HC_DEV	USB_HC_DEV

Functions
EFI_STATUS EFIAPI	UhciDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
EFI_STATUS EFIAPI	UhciDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath)
EFI_STATUS EFIAPI	UhciDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gUhciDriverBinding
EFI_COMPONENT_NAME_PROTOCOL	gUhciComponentName
EFI_COMPONENT_NAME2_PROTOCOL	gUhciComponentName2

Detailed Description

The definition for UHCI driver model and HC protocol routines.

Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Uhci.h.

Macro Definition Documentation

UHC_1_MICROSECOND

#define UHC_1_MICROSECOND   1

Definition at line 45 of file Uhci.h.

UHC_1_MILLISECOND

#define UHC_1_MILLISECOND   (1000 * UHC_1_MICROSECOND)

Definition at line 46 of file Uhci.h.

UHC_1_SECOND

#define UHC_1_SECOND   (1000 * UHC_1_MILLISECOND)

Definition at line 47 of file Uhci.h.

UHC_ASYNC_POLL_INTERVAL

#define UHC_ASYNC_POLL_INTERVAL   EFI_TIMER_PERIOD_MILLISECONDS(1)

Definition at line 73 of file Uhci.h.

UHC_FORCE_GLOBAL_RESUME_STALL

#define UHC_FORCE_GLOBAL_RESUME_STALL   (20 * UHC_1_MILLISECOND)

Definition at line 58 of file Uhci.h.

UHC_FROM_USB2_HC_PROTO

#define UHC_FROM_USB2_HC_PROTO

(

This

)

CR(This, USB_HC_DEV, Usb2Hc, USB_HC_DEV_SIGNATURE)

Definition at line 91 of file Uhci.h.

UHC_GENERIC_TIMEOUT

#define UHC_GENERIC_TIMEOUT   UHC_1_SECOND

Definition at line 52 of file Uhci.h.

UHC_ROOT_PORT_RECOVERY_STALL

#define UHC_ROOT_PORT_RECOVERY_STALL   (10 * UHC_1_MILLISECOND)

Definition at line 66 of file Uhci.h.

UHC_ROOT_PORT_RESET_STALL

#define UHC_ROOT_PORT_RESET_STALL   (50 * UHC_1_MILLISECOND)

Definition at line 65 of file Uhci.h.

UHC_SYNC_POLL_INTERVAL

#define UHC_SYNC_POLL_INTERVAL   (1 * UHC_1_MILLISECOND)

Definition at line 72 of file Uhci.h.

UHCI_TPL

#define UHCI_TPL   TPL_NOTIFY

Definition at line 79 of file Uhci.h.

USB_HC_DEV_SIGNATURE

#define USB_HC_DEV_SIGNATURE   SIGNATURE_32 ('u', 'h', 'c', 'i')

Definition at line 81 of file Uhci.h.

Typedef Documentation

USB_HC_DEV

typedef struct _USB_HC_DEV USB_HC_DEV

Definition at line 32 of file Uhci.h.

Function Documentation

UhciDriverBindingStart()

EFI_STATUS EFIAPI UhciDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Starting the Usb UHCI Driver.

Parameters

This	Protocol instance pointer.
Controller	Handle of device to test.
RemainingDevicePath	Not used.

Return values

EFI_SUCCESS	This driver supports this device.
EFI_UNSUPPORTED	This driver does not support this device.
EFI_DEVICE_ERROR	This driver cannot be started due to device Error. EFI_OUT_OF_RESOURCES- Failed due to resource shortage.

Definition at line 1608 of file Uhci.c.

UhciDriverBindingStop()

EFI_STATUS EFIAPI UhciDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stop this driver on ControllerHandle. Support stopping any child handles created by this driver.

Parameters

This	Protocol instance pointer.
Controller	Handle of device to stop driver on.
NumberOfChildren	Number of Children in the ChildHandleBuffer.
ChildHandleBuffer	List of handles for the children we need to stop.

Returns

EFI_SUCCESS

others

Definition at line 1829 of file Uhci.c.

UhciDriverBindingSupported()

EFI_STATUS EFIAPI UhciDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Test to see if this driver supports ControllerHandle.

Parameters

This	Protocol instance pointer.
Controller	Handle of device to test.
RemainingDevicePath	Not used.

Returns

EFI_SUCCESS This driver supports this device.

EFI_UNSUPPORTED This driver does not support this device.

Definition at line 1345 of file Uhci.c.

Variable Documentation

gUhciComponentName

EFI_COMPONENT_NAME_PROTOCOL gUhciComponentName

extern

Definition at line 15 of file ComponentName.c.

gUhciComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gUhciComponentName2

extern

Definition at line 24 of file ComponentName.c.

gUhciDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gUhciDriverBinding

extern

Definition at line 12 of file Uhci.c.