UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / EmbeddedPkg / Include / Protocol / UsbDevice.h

/** @file\r
\r
  Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __USB_DEVICE_PROTOCOL_H__\r
#define __USB_DEVICE_PROTOCOL_H__\r
\r
#include <IndustryStandard/Usb.h>\r
\r
extern EFI_GUID  gUsbDeviceProtocolGuid;\r
\r
/*\r
 * Note: This Protocol is just  the bare minimum for Android Fastboot. It\r
 * only makes sense for devices that only do Bulk Transfers and only have one\r
 * endpoint.\r
 */\r
\r
/*\r
  Callback to be called when data is received.\r
  Buffer is callee-allocated and it's the caller's responsibility to free it with\r
  FreePool.\r
\r
  @param[in] Size        Size in bytes of data.\r
  @param[in] Buffer      Pointer to data.\r
*/\r
typedef\r
VOID\r
(*USB_DEVICE_RX_CALLBACK) (\r
  IN UINTN  Size,\r
  IN VOID   *Buffer\r
  );\r
\r
/*\r
  Callback to be called when the host asks for data by sending an IN token\r
  (excluding during the data stage of a control transfer).\r
  When this function is called, data previously buffered by calling Send() has\r
  been sent.\r
\r
  @param[in]Endpoint    Endpoint index, as specified in endpoint descriptors, of\r
                        the endpoint the IN token was sent to.\r
*/\r
typedef\r
VOID\r
(*USB_DEVICE_TX_CALLBACK) (\r
  IN UINT8  EndpointIndex\r
  );\r
\r
/*\r
  Put data in the Tx buffer to be sent on the next IN token.\r
  Don't call this function again until the TxCallback has been called.\r
\r
  @param[in]Endpoint    Endpoint index, as specified in endpoint descriptors, of\r
                        the endpoint to send the data from.\r
  @param[in]Size        Size in bytes of data.\r
  @param[in]Buffer      Pointer to data.\r
\r
  @retval EFI_SUCCESS           The data was queued successfully.\r
  @retval EFI_INVALID_PARAMETER There was an error sending the data.\r
*/\r
typedef\r
EFI_STATUS\r
(*USB_DEVICE_SEND) (\r
  IN       UINT8  EndpointIndex,\r
  IN       UINTN  Size,\r
  IN CONST VOID   *Buffer\r
  );\r
\r
/*\r
  Restart the USB peripheral controller and respond to enumeration.\r
\r
  @param[in] DeviceDescriptor   pointer to device descriptor\r
  @param[in] Descriptors        Array of pointers to buffers, where\r
                                Descriptors[n] contains the response to a\r
                                GET_DESCRIPTOR request for configuration n. From\r
                                USB Spec section 9.4.3:\r
                                "The first interface descriptor follows the\r
                                configuration descriptor. The endpoint\r
                                descriptors for the first interface follow the\r
                                first interface descriptor. If there are\r
                                additional interfaces, their interface\r
                                descriptor and endpoint descriptors follow the\r
                                first interface’s endpoint descriptors".\r
\r
                                The size of each buffer is the TotalLength\r
                                member of the Configuration Descriptor.\r
\r
                                The size of the array is\r
                                DeviceDescriptor->NumConfigurations.\r
  @param[in]RxCallback          See USB_DEVICE_RX_CALLBACK\r
  @param[in]TxCallback          See USB_DEVICE_TX_CALLBACK\r
*/\r
typedef\r
EFI_STATUS\r
(*USB_DEVICE_START) (\r
  IN USB_DEVICE_DESCRIPTOR   *DeviceDescriptor,\r
  IN VOID                    **Descriptors,\r
  IN USB_DEVICE_RX_CALLBACK  RxCallback,\r
  IN USB_DEVICE_TX_CALLBACK  TxCallback\r
  );\r
\r
struct _USB_DEVICE_PROTOCOL {\r
  USB_DEVICE_START    Start;\r
  USB_DEVICE_SEND     Send;\r
};\r
\r
typedef struct _USB_DEVICE_PROTOCOL USB_DEVICE_PROTOCOL;\r
\r
#endif //ifndef __USB_DEVICE_PROTOCOL_H__\r