MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBotPei / PeiUsbLib.c

/** @file\r
Common Libarary  for PEI USB.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UsbPeim.h"\r
#include "PeiUsbLib.h"\r
\r
\r
/**\r
  Clear a given usb feature.\r
\r
  @param  PeiServices       General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi          Indicates the PEI_USB_IO_PPI instance.\r
  @param  Recipient         The recipient of ClearFeature Request, should be one of Device/Interface/Endpoint.\r
  @param  Value             Request Value.\r
  @param  Target            Request Index.\r
\r
  @retval EFI_SUCCESS       Usb feature is cleared successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot clear the usb feature due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbClearDeviceFeature (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN EFI_USB_RECIPIENT        Recipient,\r
  IN UINT16                   Value,\r
  IN UINT16                   Target\r
  )\r
{\r
  EFI_USB_DEVICE_REQUEST  DevReq;\r
\r
  ASSERT (UsbIoPpi != NULL);\r
\r
  switch (Recipient) {\r
  case EfiUsbDevice:\r
    DevReq.RequestType = USB_DEV_CLEAR_FEATURE_REQ_TYPE_D;\r
    break;\r
\r
  case EfiUsbInterface:\r
    DevReq.RequestType = USB_DEV_CLEAR_FEATURE_REQ_TYPE_I;\r
    break;\r
\r
  case EfiUsbEndpoint:\r
    DevReq.RequestType = USB_DEV_CLEAR_FEATURE_REQ_TYPE_E;\r
    break;\r
  }\r
\r
  DevReq.Request      = USB_DEV_CLEAR_FEATURE;\r
  DevReq.Value        = Value;\r
  DevReq.Index        = Target;\r
  DevReq.Length       = 0;\r
\r
  return UsbIoPpi->UsbControlTransfer (\r
                     PeiServices,\r
                     UsbIoPpi,\r
                     &DevReq,\r
                     EfiUsbNoData,\r
                     PcdGet32 (PcdUsbTransferTimeoutValue),\r
                     NULL,\r
                     0\r
                     );\r
}\r
\r
\r
/**\r
  Clear Endpoint Halt.\r
\r
  @param  PeiServices       General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi          Indicates the PEI_USB_IO_PPI instance.\r
  @param  EndpointAddress   The endpoint address.\r
\r
  @retval EFI_SUCCESS       Endpoint halt is cleared successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot clear the endpoint halt status due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbClearEndpointHalt (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN UINT8                    EndpointAddress\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_USB_INTERFACE_DESCRIPTOR  *InterfaceDesc;\r
  EFI_USB_ENDPOINT_DESCRIPTOR   *EndpointDescriptor;\r
  UINT8                         EndpointIndex;\r
\r
\r
  //\r
  // Check its interface\r
  //\r
  Status = UsbIoPpi->UsbGetInterfaceDescriptor (\r
                      PeiServices,\r
                      UsbIoPpi,\r
                      &InterfaceDesc\r
                      );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  for (EndpointIndex = 0; EndpointIndex < InterfaceDesc->NumEndpoints; EndpointIndex++) {\r
    Status = UsbIoPpi->UsbGetEndpointDescriptor (PeiServices, UsbIoPpi, EndpointIndex, &EndpointDescriptor);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (EndpointDescriptor->EndpointAddress == EndpointAddress) {\r
      break;\r
    }\r
  }\r
\r
  if (EndpointIndex == InterfaceDesc->NumEndpoints) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = PeiUsbClearDeviceFeature (\r
            PeiServices,\r
            UsbIoPpi,\r
            EfiUsbEndpoint,\r
            EfiUsbEndpointHalt,\r
            EndpointAddress\r
            );\r
\r
  return Status;\r
}\r
\r
\r