PeiUsbLib.c File Reference

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

Go to the source code of this file.

Functions
EFI_STATUS	PeiUsbGetDescriptor (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_IO_PPI *UsbIoPpi, IN UINT16 Value, IN UINT16 Index, IN UINT16 DescriptorLength, OUT VOID *Descriptor)
EFI_STATUS	PeiUsbSetDeviceAddress (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_IO_PPI *UsbIoPpi, IN UINT16 AddressValue)
EFI_STATUS	PeiUsbSetConfiguration (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_IO_PPI *UsbIoPpi)
BOOLEAN	IsPortConnect (IN UINT16 PortStatus)
UINTN	PeiUsbGetDeviceSpeed (IN UINT16 PortStatus)

Detailed Description

Common Library for PEI USB

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

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

Definition in file PeiUsbLib.c.

Function Documentation

IsPortConnect()

BOOLEAN IsPortConnect

(

IN UINT16

PortStatus

)

Judge if the port is connected with a usb device or not.

Parameters

PortStatus

The usb port status gotten.

Return values

TRUE	A usb device is connected with the port.
FALSE	No usb device is connected with the port.

Definition at line 146 of file PeiUsbLib.c.

PeiUsbGetDescriptor()

EFI_STATUS PeiUsbGetDescriptor	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_IO_PPI *	UsbIoPpi,
		IN UINT16	Value,
		IN UINT16	Index,
		IN UINT16	DescriptorLength,
		OUT VOID *	Descriptor
	)

Get a given usb descriptor.

Parameters

PeiServices	General-purpose services that are available to every PEIM.
UsbIoPpi	Indicates the PEI_USB_IO_PPI instance.
Value	Request Value.
Index	Request Index.
DescriptorLength	Request descriptor Length.
Descriptor	Request descriptor.

Return values

EFI_SUCCESS	Usb descriptor is obtained successfully.
EFI_DEVICE_ERROR	Cannot get the usb descriptor due to a hardware error.
Others	Other failure occurs.

Definition at line 30 of file PeiUsbLib.c.

PeiUsbGetDeviceSpeed()

UINTN PeiUsbGetDeviceSpeed

(

IN UINT16

PortStatus

)

Get device speed according to port status.

Parameters

PortStatus

The usb port status gotten.

Returns

Device speed value.

Definition at line 169 of file PeiUsbLib.c.

PeiUsbSetConfiguration()

EFI_STATUS PeiUsbSetConfiguration	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_IO_PPI *	UsbIoPpi
	)

Configure a usb device to Configuration 1.

Parameters

PeiServices	General-purpose services that are available to every PEIM.
UsbIoPpi	Indicates the PEI_USB_IO_PPI instance.

Return values

EFI_SUCCESS	Usb device is set to use Configuration 1 successfully.
EFI_DEVICE_ERROR	Cannot set the usb device due to a hardware error.
Others	Other failure occurs.

Definition at line 112 of file PeiUsbLib.c.

PeiUsbSetDeviceAddress()

EFI_STATUS PeiUsbSetDeviceAddress	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_IO_PPI *	UsbIoPpi,
		IN UINT16	AddressValue
	)

Set a usb device with a specified address.

Parameters

PeiServices	General-purpose services that are available to every PEIM.
UsbIoPpi	Indicates the PEI_USB_IO_PPI instance.
AddressValue	The address to assign.

Return values

EFI_SUCCESS	Usb device address is set successfully.
EFI_DEVICE_ERROR	Cannot set the usb address due to a hardware error.
Others	Other failure occurs.

Definition at line 73 of file PeiUsbLib.c.