mirror of https://github.com/acidanthera/audk.git
579 lines
15 KiB
C
579 lines
15 KiB
C
/** @file
|
|
|
|
The library provides the USB Standard Device Requests defined
|
|
in Usb specification 9.4 section.
|
|
|
|
Copyright (c) 2004 - 2007, Intel Corporation All rights
|
|
reserved. This program and the accompanying materials are
|
|
licensed and made available under the terms and conditions of
|
|
the BSD License which accompanies this distribution. The full
|
|
text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#include <UefiUsbLibInternal.h>
|
|
|
|
|
|
/**
|
|
Usb Get Descriptor.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param Value Device Request Value.
|
|
@param Index Device Request Index.
|
|
@param DescriptorLength Descriptor Length.
|
|
@param Descriptor Descriptor buffer to contain result.
|
|
@param Status Transfer Status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbGetDescriptor (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINT16 Value,
|
|
IN UINT16 Index,
|
|
IN UINT16 DescriptorLength,
|
|
OUT VOID *Descriptor,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
DevReq.RequestType = USB_DEV_GET_DESCRIPTOR_REQ_TYPE;
|
|
DevReq.Request = USB_REQ_GET_DESCRIPTOR;
|
|
DevReq.Value = Value;
|
|
DevReq.Index = Index;
|
|
DevReq.Length = DescriptorLength;
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbDataIn,
|
|
TIMEOUT_VALUE,
|
|
Descriptor,
|
|
DescriptorLength,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Set Descriptor.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param Value Device Request Value.
|
|
@param Index Device Request Index.
|
|
@param DescriptorLength Descriptor Length.
|
|
@param Descriptor Descriptor buffer to set.
|
|
@param Status Transfer Status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbSetDescriptor (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINT16 Value,
|
|
IN UINT16 Index,
|
|
IN UINT16 DescriptorLength,
|
|
IN VOID *Descriptor,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
DevReq.RequestType = USB_DEV_SET_DESCRIPTOR_REQ_TYPE;
|
|
DevReq.Request = USB_REQ_SET_DESCRIPTOR;
|
|
DevReq.Value = Value;
|
|
DevReq.Index = Index;
|
|
DevReq.Length = DescriptorLength;
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbDataOut,
|
|
TIMEOUT_VALUE,
|
|
Descriptor,
|
|
DescriptorLength,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Get Device Interface.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param Index Interface index value.
|
|
@param AltSetting Alternate setting.
|
|
@param Status Trasnsfer status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbGetInterface (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINT16 Index,
|
|
OUT UINT8 *AltSetting,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
DevReq.RequestType = USB_DEV_GET_INTERFACE_REQ_TYPE;
|
|
DevReq.Request = USB_REQ_GET_INTERFACE;
|
|
DevReq.Index = Index;
|
|
DevReq.Length = 1;
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbDataIn,
|
|
TIMEOUT_VALUE,
|
|
AltSetting,
|
|
1,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Set Device Interface.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param InterfaceNo Interface Number.
|
|
@param AltSetting Alternate setting.
|
|
@param Status Trasnsfer status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbSetInterface (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINT16 InterfaceNo,
|
|
IN UINT16 AltSetting,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
DevReq.RequestType = USB_DEV_SET_INTERFACE_REQ_TYPE;
|
|
DevReq.Request = USB_REQ_SET_INTERFACE;
|
|
DevReq.Value = AltSetting;
|
|
DevReq.Index = InterfaceNo;
|
|
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbNoData,
|
|
TIMEOUT_VALUE,
|
|
NULL,
|
|
0,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Get Device Configuration.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param ConfigValue Config Value.
|
|
@param Status Transfer Status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbGetConfiguration (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
OUT UINT8 *ConfigValue,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
DevReq.RequestType = USB_DEV_GET_CONFIGURATION_REQ_TYPE;
|
|
DevReq.Request = USB_REQ_GET_CONFIG;
|
|
DevReq.Length = 1;
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbDataIn,
|
|
TIMEOUT_VALUE,
|
|
ConfigValue,
|
|
1,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Set Device Configuration.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param Value Configuration Value to set.
|
|
@param Status Transfer status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbSetConfiguration (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINT16 Value,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
DevReq.RequestType = USB_DEV_SET_CONFIGURATION_REQ_TYPE;
|
|
DevReq.Request = USB_REQ_SET_CONFIG;
|
|
DevReq.Value = Value;
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbNoData,
|
|
TIMEOUT_VALUE,
|
|
NULL,
|
|
0,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Set Device Feature.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param Recipient Interface/Device/Endpoint.
|
|
@param Value Request value.
|
|
@param Target Request Index.
|
|
@param Status Transfer status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbSetFeature (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINTN Recipient,
|
|
IN UINT16 Value,
|
|
IN UINT16 Target,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
switch (Recipient) {
|
|
|
|
case USB_TARGET_DEVICE:
|
|
DevReq.RequestType = USB_DEV_SET_FEATURE_REQ_TYPE_D;
|
|
break;
|
|
|
|
case USB_TARGET_INTERFACE:
|
|
DevReq.RequestType = USB_DEV_SET_FEATURE_REQ_TYPE_I;
|
|
break;
|
|
|
|
case USB_TARGET_ENDPOINT:
|
|
DevReq.RequestType = USB_DEV_SET_FEATURE_REQ_TYPE_E;
|
|
break;
|
|
}
|
|
//
|
|
// Fill device request, see USB1.1 spec
|
|
//
|
|
DevReq.Request = USB_REQ_SET_FEATURE;
|
|
DevReq.Value = Value;
|
|
DevReq.Index = Target;
|
|
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbNoData,
|
|
TIMEOUT_VALUE,
|
|
NULL,
|
|
0,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Clear Device Feature.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param Recipient Interface/Device/Endpoint.
|
|
@param Value Request value.
|
|
@param Target Request Index.
|
|
@param Status Transfer status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbClearFeature (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINTN Recipient,
|
|
IN UINT16 Value,
|
|
IN UINT16 Target,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
switch (Recipient) {
|
|
|
|
case USB_TARGET_DEVICE:
|
|
DevReq.RequestType = USB_DEV_CLEAR_FEATURE_REQ_TYPE_D;
|
|
break;
|
|
|
|
case USB_TARGET_INTERFACE:
|
|
DevReq.RequestType = USB_DEV_CLEAR_FEATURE_REQ_TYPE_I;
|
|
break;
|
|
|
|
case USB_TARGET_ENDPOINT:
|
|
DevReq.RequestType = USB_DEV_CLEAR_FEATURE_REQ_TYPE_E;
|
|
break;
|
|
}
|
|
//
|
|
// Fill device request, see USB1.1 spec
|
|
//
|
|
DevReq.Request = USB_REQ_CLEAR_FEATURE;
|
|
DevReq.Value = Value;
|
|
DevReq.Index = Target;
|
|
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbNoData,
|
|
TIMEOUT_VALUE,
|
|
NULL,
|
|
0,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Usb Get Device Status.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param Recipient Interface/Device/Endpoint.
|
|
@param Target Request index.
|
|
@param DevStatus Device status.
|
|
@param Status Transfer status.
|
|
|
|
@retval EFI_INVALID_PARAMETER Parameter is error.
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_TIMEOUT Device has no response.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbGetStatus (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINTN Recipient,
|
|
IN UINT16 Target,
|
|
OUT UINT16 *DevStatus,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
switch (Recipient) {
|
|
|
|
case USB_TARGET_DEVICE:
|
|
DevReq.RequestType = USB_DEV_GET_STATUS_REQ_TYPE_D;
|
|
break;
|
|
|
|
case USB_TARGET_INTERFACE:
|
|
DevReq.RequestType = USB_DEV_GET_STATUS_REQ_TYPE_I;
|
|
break;
|
|
|
|
case USB_TARGET_ENDPOINT:
|
|
DevReq.RequestType = USB_DEV_GET_STATUS_REQ_TYPE_E;
|
|
break;
|
|
}
|
|
//
|
|
// Fill device request, see USB1.1 spec
|
|
//
|
|
DevReq.Request = USB_REQ_GET_STATUS;
|
|
DevReq.Value = 0;
|
|
DevReq.Index = Target;
|
|
DevReq.Length = 2;
|
|
|
|
return UsbIo->UsbControlTransfer (
|
|
UsbIo,
|
|
&DevReq,
|
|
EfiUsbDataIn,
|
|
TIMEOUT_VALUE,
|
|
DevStatus,
|
|
2,
|
|
Status
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
Clear endpoint stall.
|
|
|
|
@param UsbIo EFI_USB_IO_PROTOCOL.
|
|
@param EndpointNo Endpoint Number.
|
|
@param Status Transfer Status.
|
|
|
|
@retval EFI_NOT_FOUND Can't find the Endpoint.
|
|
@retval EFI_DEVICE_ERROR Hardware error.
|
|
@retval EFI_SUCCESS Success.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UsbClearEndpointHalt (
|
|
IN EFI_USB_IO_PROTOCOL *UsbIo,
|
|
IN UINT8 EndpointNo,
|
|
OUT UINT32 *Status
|
|
)
|
|
{
|
|
EFI_STATUS Result;
|
|
EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;
|
|
EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;
|
|
UINT8 Index;
|
|
|
|
if (UsbIo == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
ZeroMem (&EndpointDescriptor, sizeof (EFI_USB_ENDPOINT_DESCRIPTOR));
|
|
//
|
|
// First seach the endpoint descriptor for that endpoint addr
|
|
//
|
|
Result = UsbIo->UsbGetInterfaceDescriptor (
|
|
UsbIo,
|
|
&InterfaceDescriptor
|
|
);
|
|
if (EFI_ERROR (Result)) {
|
|
return Result;
|
|
}
|
|
|
|
for (Index = 0; Index < InterfaceDescriptor.NumEndpoints; Index++) {
|
|
Result = UsbIo->UsbGetEndpointDescriptor (
|
|
UsbIo,
|
|
Index,
|
|
&EndpointDescriptor
|
|
);
|
|
if (EFI_ERROR (Result)) {
|
|
continue;
|
|
}
|
|
|
|
if (EndpointDescriptor.EndpointAddress == EndpointNo) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (Index == InterfaceDescriptor.NumEndpoints) {
|
|
//
|
|
// No such endpoint
|
|
//
|
|
return EFI_NOT_FOUND;
|
|
}
|
|
|
|
Result = UsbClearFeature (
|
|
UsbIo,
|
|
USB_TARGET_ENDPOINT,
|
|
USB_FEATURE_ENDPOINT_HALT,
|
|
EndpointDescriptor.EndpointAddress,
|
|
Status
|
|
);
|
|
|
|
return Result;
|
|
}
|