]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/UefiUsbLib.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdePkg / Include / Library / UefiUsbLib.h
index 455cb7b06e478f6c0d2bd42dafb935e4a5a12783..a8ab47aeff9bca17ad1719946d5cc930a3a713e6 100644 (file)
@@ -2,18 +2,11 @@
   Provides most USB APIs to support the Hid requests defined in USB Hid 1.1 spec\r
   and the standard requests defined in USB 1.1 spec.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-\r
 #ifndef __USB_DXE_LIB_H__\r
 #define __USB_DXE_LIB_H__\r
 \r
@@ -41,12 +34,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 EFI_STATUS\r
 EFIAPI\r
 UsbGetHidDescriptor (\r
-  IN  EFI_USB_IO_PROTOCOL        *UsbIo,\r
-  IN  UINT8                      Interface,\r
-  OUT EFI_USB_HID_DESCRIPTOR     *HidDescriptor\r
+  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
+  IN  UINT8                   Interface,\r
+  OUT EFI_USB_HID_DESCRIPTOR  *HidDescriptor\r
   );\r
 \r
-\r
 /**\r
   Get the report descriptor of the specified USB HID interface.\r
 \r
@@ -71,10 +63,10 @@ UsbGetHidDescriptor (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetReportDescriptor (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT8                   Interface,\r
-  IN  UINT16                  DescriptorLength,\r
-  OUT UINT8                   *DescriptorBuffer\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT8                Interface,\r
+  IN  UINT16               DescriptorLength,\r
+  OUT UINT8                *DescriptorBuffer\r
   );\r
 \r
 /**\r
@@ -97,9 +89,9 @@ UsbGetReportDescriptor (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetProtocolRequest (\r
-  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN UINT8                   Interface,\r
-  OUT UINT8                   *Protocol\r
+  IN EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN UINT8                Interface,\r
+  OUT UINT8               *Protocol\r
   );\r
 \r
 /**\r
@@ -121,9 +113,9 @@ UsbGetProtocolRequest (
 EFI_STATUS\r
 EFIAPI\r
 UsbSetProtocolRequest (\r
-  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN UINT8                   Interface,\r
-  IN UINT8                   Protocol\r
+  IN EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN UINT8                Interface,\r
+  IN UINT8                Protocol\r
   );\r
 \r
 /**\r
@@ -146,10 +138,10 @@ UsbSetProtocolRequest (
 EFI_STATUS\r
 EFIAPI\r
 UsbSetIdleRequest (\r
-  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN UINT8                   Interface,\r
-  IN UINT8                   ReportId,\r
-  IN UINT8                   Duration\r
+  IN EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN UINT8                Interface,\r
+  IN UINT8                ReportId,\r
+  IN UINT8                Duration\r
   );\r
 \r
 /**\r
@@ -173,10 +165,10 @@ UsbSetIdleRequest (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetIdleRequest (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT8                   Interface,\r
-  IN  UINT8                   ReportId,\r
-  OUT UINT8                   *Duration\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT8                Interface,\r
+  IN  UINT8                ReportId,\r
+  OUT UINT8                *Duration\r
   );\r
 \r
 /**\r
@@ -203,12 +195,12 @@ UsbGetIdleRequest (
 EFI_STATUS\r
 EFIAPI\r
 UsbSetReportRequest (\r
-  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN UINT8                   Interface,\r
-  IN UINT8                   ReportId,\r
-  IN UINT8                   ReportType,\r
-  IN UINT16                  ReportLen,\r
-  IN UINT8                   *Report\r
+  IN EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN UINT8                Interface,\r
+  IN UINT8                ReportId,\r
+  IN UINT8                ReportType,\r
+  IN UINT16               ReportLen,\r
+  IN UINT8                *Report\r
   );\r
 \r
 /**\r
@@ -238,12 +230,12 @@ UsbSetReportRequest (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetReportRequest (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT8                   Interface,\r
-  IN  UINT8                   ReportId,\r
-  IN  UINT8                   ReportType,\r
-  IN  UINT16                  ReportLen,\r
-  OUT UINT8                   *Report\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT8                Interface,\r
+  IN  UINT8                ReportId,\r
+  IN  UINT8                ReportType,\r
+  IN  UINT16               ReportLen,\r
+  OUT UINT8                *Report\r
   );\r
 \r
 /**\r
@@ -275,12 +267,12 @@ UsbGetReportRequest (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetDescriptor (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT16                  Value,\r
-  IN  UINT16                  Index,\r
-  IN  UINT16                  DescriptorLength,\r
-  OUT VOID                    *Descriptor,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT16               Value,\r
+  IN  UINT16               Index,\r
+  IN  UINT16               DescriptorLength,\r
+  OUT VOID                 *Descriptor,\r
+  OUT UINT32               *Status\r
   );\r
 \r
 /**\r
@@ -309,12 +301,12 @@ UsbGetDescriptor (
 EFI_STATUS\r
 EFIAPI\r
 UsbSetDescriptor (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT16                  Value,\r
-  IN  UINT16                  Index,\r
-  IN  UINT16                  DescriptorLength,\r
-  IN  VOID                    *Descriptor,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT16               Value,\r
+  IN  UINT16               Index,\r
+  IN  UINT16               DescriptorLength,\r
+  IN  VOID                 *Descriptor,\r
+  OUT UINT32               *Status\r
   );\r
 \r
 /**\r
@@ -341,10 +333,10 @@ UsbSetDescriptor (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetInterface (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT16                  Interface,\r
-  OUT UINT16                  *AlternateSetting,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT16               Interface,\r
+  OUT UINT16               *AlternateSetting,\r
+  OUT UINT32               *Status\r
   );\r
 \r
 /**\r
@@ -370,10 +362,10 @@ UsbGetInterface (
 EFI_STATUS\r
 EFIAPI\r
 UsbSetInterface (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT16                  Interface,\r
-  IN  UINT16                  AlternateSetting,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT16               Interface,\r
+  IN  UINT16               AlternateSetting,\r
+  OUT UINT32               *Status\r
   );\r
 \r
 /**\r
@@ -399,9 +391,9 @@ UsbSetInterface (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetConfiguration (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  OUT UINT16                  *ConfigurationValue,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  OUT UINT16               *ConfigurationValue,\r
+  OUT UINT32               *Status\r
   );\r
 \r
 /**\r
@@ -426,9 +418,9 @@ UsbGetConfiguration (
 EFI_STATUS\r
 EFIAPI\r
 UsbSetConfiguration (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT16                  ConfigurationValue,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT16               ConfigurationValue,\r
+  OUT UINT32               *Status\r
   );\r
 \r
 /**\r
@@ -457,11 +449,11 @@ UsbSetConfiguration (
 EFI_STATUS\r
 EFIAPI\r
 UsbSetFeature (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  USB_TYPES_DEFINITION    Recipient,\r
-  IN  UINT16                  Value,\r
-  IN  UINT16                  Target,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL   *UsbIo,\r
+  IN  USB_TYPES_DEFINITION  Recipient,\r
+  IN  UINT16                Value,\r
+  IN  UINT16                Target,\r
+  OUT UINT32                *Status\r
   );\r
 \r
 /**\r
@@ -490,11 +482,11 @@ UsbSetFeature (
 EFI_STATUS\r
 EFIAPI\r
 UsbClearFeature (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  USB_TYPES_DEFINITION    Recipient,\r
-  IN  UINT16                  Value,\r
-  IN  UINT16                  Target,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL   *UsbIo,\r
+  IN  USB_TYPES_DEFINITION  Recipient,\r
+  IN  UINT16                Value,\r
+  IN  UINT16                Target,\r
+  OUT UINT32                *Status\r
   );\r
 \r
 /**\r
@@ -524,11 +516,11 @@ UsbClearFeature (
 EFI_STATUS\r
 EFIAPI\r
 UsbGetStatus (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  USB_TYPES_DEFINITION    Recipient,\r
-  IN  UINT16                  Target,\r
-  OUT UINT16                  *DeviceStatus,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL   *UsbIo,\r
+  IN  USB_TYPES_DEFINITION  Recipient,\r
+  IN  UINT16                Target,\r
+  OUT UINT16                *DeviceStatus,\r
+  OUT UINT32                *Status\r
   );\r
 \r
 /**\r
@@ -555,9 +547,9 @@ UsbGetStatus (
 EFI_STATUS\r
 EFIAPI\r
 UsbClearEndpointHalt (\r
-  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
-  IN  UINT8                   Endpoint,\r
-  OUT UINT32                  *Status\r
+  IN  EFI_USB_IO_PROTOCOL  *UsbIo,\r
+  IN  UINT8                Endpoint,\r
+  OUT UINT32               *Status\r
   );\r
 \r
 #endif\r