UsbPeim.c File Reference

#include "UsbPeim.h"
#include "HubPeim.h"
#include "PeiUsbLib.h"

Go to the source code of this file.

Functions
EFI_STATUS	PeiUsbEnumeration (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_HOST_CONTROLLER_PPI *UsbHcPpi, IN PEI_USB2_HOST_CONTROLLER_PPI *Usb2HcPpi)
EFI_STATUS	PeiConfigureUsbDevice (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_DEVICE *PeiUsbDevice, IN UINT8 Port, IN OUT UINT8 *DeviceAddress)
EFI_STATUS	PeiUsbGetAllConfiguration (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_DEVICE *PeiUsbDevice)
EFI_STATUS	GetExpectedDescriptor (IN UINT8 *Buffer, IN UINTN Length, IN UINT8 DescType, IN UINT8 DescLength, OUT UINTN *ParsedBytes)
EFI_STATUS EFIAPI	PeimInitializeUsb (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)
EFI_STATUS	PeiHubEnumeration (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_DEVICE *PeiUsbDevice, IN UINT8 *CurrentAddress)
VOID	ResetRootPort (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_HOST_CONTROLLER_PPI *UsbHcPpi, IN PEI_USB2_HOST_CONTROLLER_PPI *Usb2HcPpi, IN UINT8 PortNum, IN UINT8 RetryIndex)

Variables
PEI_USB_IO_PPI	mUsbIoPpi
EFI_PEI_PPI_DESCRIPTOR	mUsbIoPpiList

Detailed Description

The module to produce Usb Bus PPI.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UsbPeim.c.

Function Documentation

GetExpectedDescriptor()

EFI_STATUS GetExpectedDescriptor	(	IN UINT8 *	Buffer,
		IN UINTN	Length,
		IN UINT8	DescType,
		IN UINT8	DescLength,
		OUT UINTN *	ParsedBytes
	)

Get the start position of next wanted descriptor.

Parameters

Buffer	Buffer containing data to parse.
Length	Buffer length.
DescType	Descriptor type.
DescLength	Descriptor length.
ParsedBytes	Bytes has been parsed.

Return values

EFI_SUCCESS	Get wanted descriptor successfully.
EFI_DEVICE_ERROR	Error occurred.

Definition at line 953 of file UsbPeim.c.

PeiConfigureUsbDevice()

EFI_STATUS PeiConfigureUsbDevice	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_DEVICE *	PeiUsbDevice,
		IN UINT8	Port,
		IN OUT UINT8 *	DeviceAddress
	)

Configure new detected usb device.

Parameters

PeiServices	Describes the list of possible PEI Services.
PeiUsbDevice	The pointer of PEI_USB_DEVICE instance.
Port	The port to be configured.
DeviceAddress	The device address to be configured.

Return values

EFI_SUCCESS	The new detected usb device is configured successfully.
EFI_OUT_OF_RESOURCES	Can't allocate memory resource.
Others	Other failure occurs.

Definition at line 664 of file UsbPeim.c.

PeiHubEnumeration()

EFI_STATUS PeiHubEnumeration	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_DEVICE *	PeiUsbDevice,
		IN UINT8 *	CurrentAddress
	)

The Hub Enumeration just scans the hub ports one time. It also doesn't support hot-plug.

Parameters

PeiServices	Describes the list of possible PEI Services.
PeiUsbDevice	The pointer of PEI_USB_DEVICE instance.
CurrentAddress	The DeviceAddress of usb device.

Return values

EFI_SUCCESS	The usb hub is enumerated successfully.
EFI_OUT_OF_RESOURCES	Can't allocate memory resource.
Others	Other failure occurs.

Definition at line 207 of file UsbPeim.c.

PeimInitializeUsb()

EFI_STATUS EFIAPI PeimInitializeUsb	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

The entrypoint of the module, it will enumerate all HCs.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	Usb initialization is done successfully.
EFI_OUT_OF_RESOURCES	Can't allocate memory resource.
EFI_UNSUPPORTED	Can't find required PPI.

Definition at line 123 of file UsbPeim.c.

PeiUsbEnumeration()

EFI_STATUS PeiUsbEnumeration	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_HOST_CONTROLLER_PPI *	UsbHcPpi,
		IN PEI_USB2_HOST_CONTROLLER_PPI *	Usb2HcPpi
	)

The enumeration routine to detect device change.

Parameters

PeiServices	Describes the list of possible PEI Services.
UsbHcPpi	The pointer of PEI_USB_HOST_CONTROLLER_PPI instance.
Usb2HcPpi	The pointer of PEI_USB2_HOST_CONTROLLER_PPI instance.

Return values

EFI_SUCCESS	The usb is enumerated successfully.
EFI_OUT_OF_RESOURCES	Can't allocate memory resource.
Others	Other failure occurs.

Definition at line 415 of file UsbPeim.c.

PeiUsbGetAllConfiguration()

EFI_STATUS PeiUsbGetAllConfiguration	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_DEVICE *	PeiUsbDevice
	)

Get all configurations from a detected usb device.

Parameters

PeiServices	Describes the list of possible PEI Services.
PeiUsbDevice	The pointer of PEI_USB_DEVICE instance.

Return values

EFI_SUCCESS	The new detected usb device is configured successfully.
EFI_OUT_OF_RESOURCES	Can't allocate memory resource.
Others	Other failure occurs.

Definition at line 781 of file UsbPeim.c.

ResetRootPort()

VOID ResetRootPort	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_HOST_CONTROLLER_PPI *	UsbHcPpi,
		IN PEI_USB2_HOST_CONTROLLER_PPI *	Usb2HcPpi,
		IN UINT8	PortNum,
		IN UINT8	RetryIndex
	)

Send reset signal over the given root hub port.

Parameters

PeiServices	Describes the list of possible PEI Services.
UsbHcPpi	The pointer of PEI_USB_HOST_CONTROLLER_PPI instance.
Usb2HcPpi	The pointer of PEI_USB2_HOST_CONTROLLER_PPI instance.
PortNum	The port to be reset.
RetryIndex	The retry times.

Definition at line 1033 of file UsbPeim.c.

Variable Documentation

mUsbIoPpi

PEI_USB_IO_PPI mUsbIoPpi

Initial value:

= {
  PeiUsbControlTransfer,
  PeiUsbBulkTransfer,
  PeiUsbGetInterfaceDescriptor,
  PeiUsbGetEndpointDescriptor,
  PeiUsbPortReset
}

Definition at line 17 of file UsbPeim.c.

mUsbIoPpiList

EFI_PEI_PPI_DESCRIPTOR mUsbIoPpiList

Initial value:

= {
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
  &gPeiUsbIoPpiGuid,
  NULL
}

Definition at line 25 of file UsbPeim.c.