Code Scrub the common includes in MdePkg.

[mirror_edk2.git] / MdePkg / Library / UefiUsbLib / Hid.c

diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c
index aeab8f11aa15f723dfa5a9812c87a6a64a4afe2c..3a62d523f1964be51609bf47f0aa5a85d7302e8d 100644 (file)
--- a/MdePkg/Library/UefiUsbLib/Hid.c
+++ b/MdePkg/Library/UefiUsbLib/Hid.c
@@ -24,12 +24,12 @@
   @param  HidDescriptor     Caller allocated buffer to store Usb hid descriptor if\r
                             successfully returned.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of getting HID descriptor through USB I/O\r
+          protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbGetHidDescriptor (\r
   IN  EFI_USB_IO_PROTOCOL        *UsbIo,\r
   IN  UINT8                      InterfaceNum,\r
@@ -73,12 +73,12 @@ UsbGetHidDescriptor (
   @param  DescriptorBuffer  Caller allocated buffer to store Usb report descriptor\r
                             if successfully returned.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of getting Report Class descriptor through USB\r
+          I/O protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbGetReportDescriptor (\r
   IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN  UINT8                   InterfaceNum,\r
@@ -117,18 +117,18 @@ UsbGetReportDescriptor (
 }\r
 \r
 /**\r
-  Get Hid Protocol Request.\r
+  Get Hid Protocol Request\r
 \r
   @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
-  @param  Interface         Which interface the caller wants to get protocol.\r
+  @param  Interface         Which interface the caller wants to get protocol\r
   @param  Protocol          Protocol value returned.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of getting Protocol Request through USB I/O\r
+          protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbGetProtocolRequest (\r
   IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN UINT8                   Interface,\r
@@ -168,19 +168,21 @@ UsbGetProtocolRequest (
 }\r
 \r
 \r
+\r
 /**\r
   Set Hid Protocol Request.\r
 \r
   @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
-  @param  Interface         Which interface the caller wants to set protocol.\r
+  @param  Interface         Which interface the caller wants to\r
+                            set protocol.\r
   @param  Protocol          Protocol value the caller wants to set.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of setting Protocol Request through USB I/O\r
+          protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbSetProtocolRequest (\r
   IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN UINT8                   Interface,\r
@@ -227,12 +229,12 @@ UsbSetProtocolRequest (
   @param  ReportId          Which report the caller wants to set.\r
   @param  Duration          Idle rate the caller wants to set.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of setting IDLE Request through USB I/O\r
+          protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbSetIdleRequest (\r
   IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN UINT8                   Interface,\r
@@ -280,12 +282,12 @@ UsbSetIdleRequest (
   @param  ReportId          Which report the caller wants to get.\r
   @param  Duration          Idle rate the caller wants to get.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of getting IDLE Request through USB I/O\r
+          protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbGetIdleRequest (\r
   IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN  UINT8                   Interface,\r
@@ -326,6 +328,7 @@ UsbGetIdleRequest (
 }\r
 \r
 \r
+\r
 /**\r
   Hid Set Report request.\r
 \r
@@ -336,12 +339,12 @@ UsbGetIdleRequest (
   @param  ReportLen         Length of report descriptor.\r
   @param  Report            Report Descriptor buffer.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of setting Report Request through USB I/O\r
+          protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbSetReportRequest (\r
   IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN UINT8                   Interface,\r
@@ -394,12 +397,12 @@ UsbSetReportRequest (
   @param  ReportLen         Length of report descriptor.\r
   @param  Report            Caller allocated buffer to store Report Descriptor.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\r
+  @return Status of getting Report Request through USB I/O\r
+          protocol's UsbControlTransfer().\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbGetReportRequest (\r
   IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN UINT8                   Interface,\r