Code Scrub for Protocol Definition

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5566 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/UsbIo.h b/MdePkg/Include/Protocol/UsbIo.h
index 66131be38e38141ee1d1d3c91025aa8b903858a5..8f24f1a98c989f0e7e7749997be7cbe73f6ada41 100644 (file)
--- a/MdePkg/Include/Protocol/UsbIo.h
+++ b/MdePkg/Include/Protocol/UsbIo.h
@@ -1,6 +1,10 @@
 /** @file\r
-  EFI Usb I/O Protocol\r
-\r
+  EFI Usb I/O Protocol as defined in UEFI specification.\r
+  This protocol is used by code, typically drivers, running in the EFI \r
+  boot services environment to access USB devices like USB keyboards, \r
+  mice and mass storage devices. In particular, functions for managing devices \r
+  on USB buses are defined here.\r
+  \r
   Copyright (c) 2006 - 2008, Intel Corporation\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
@@ -173,9 +177,9 @@ EFI_STATUS
                                 executed.\r
   @param  DataLength            Specifies the length, in bytes, of the data to be received from the\r
                                 USB device.\r
-  @param  Context               Data passed to the InterruptCallback function.\r
   @param  InterruptCallback     The Callback function. This function is called if the asynchronous\r
                                 interrupt transfer is completed.\r
+  @param  Context               Data passed to the InterruptCallback function.\r
 \r
   @retval EFI_SUCCESS           The asynchronous USB transfer request transfer has been successfully executed.\r
   @retval EFI_DEVICE_ERROR      The asynchronous USB transfer request failed.\r
@@ -262,8 +266,8 @@ EFI_STATUS
   @param  Data                  A pointer to the buffer of data that will be transmitted to USB\r
                                 device or received from USB device.\r
   @param  DataLength            The size, in bytes, of the data buffer specified by Data.\r
-  @param  Context               Data passed to the IsochronousCallback() function.\r
   @param  IsochronousCallback   The IsochronousCallback() function.\r
+  @param  Context               Data passed to the IsochronousCallback() function.\r
 \r
   @retval EFI_SUCCESS           The asynchronous isochronous transfer has been successfully submitted\r
                                 to the system.\r
@@ -419,9 +423,54 @@ EFI_STATUS
   OUT UINT16                        *TableSize\r
   );\r
 \r
-//\r
-//  Protocol Interface Structure\r
-//\r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_USB_IO_PROTOCOL provides four basic transfers types described \r
+  in the USB 1.1 Specification. These include control transfer, interrupt \r
+  transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL \r
+  also provides some basic USB device/controller management and configuration \r
+  interfaces. A USB device driver uses the services of this protocol to manage USB devices.  \r
+\r
+  @param UsbControlTransfer \r
+  Accesses the USB Device through USB Control Transfer Pipe. \r
+\r
+  @param UsbBulkTransfer\r
+  Accesses the USB Device through USB Bulk Transfer Pipe. \r
+\r
+  @param UsbAsyncInterruptTransfer\r
+  Non-block USB interrupt transfer. \r
+\r
+  @param UsbSyncInterruptTransfer\r
+  Accesses the USB Device through USB Synchronous\r
+  Interrupt Transfer Pipe. \r
+\r
+  @param UsbIsochronousTransfer\r
+  Accesses the USB Device through USB Isochronous Transfer Pipe. \r
+\r
+  @param UsbAsyncIsochronousTransfer\r
+  Nonblock USB isochronous transfer. \r
+\r
+  @param UsbGetDeviceDescriptor\r
+  Retrieves the device descriptor of a USB device. \r
+\r
+  @param UsbGetConfigDescriptor\r
+  Retrieves the activated configuration descriptor of a USB device. \r
+\r
+  @param UsbGetInterfaceDescriptor\r
+  Retrieves the interface descriptor of a USB Controller. \r
+\r
+  @param UsbGetEndpointDescriptor\r
+  Retrieves the endpoint descriptor of a USB Controller. \r
+\r
+  @param UsbGetStringDescriptor\r
+  Retrieves the string descriptor inside a USB Device. \r
+\r
+  @param UsbGetSupportedLanguages\r
+  Retrieves the array of languages that the USB device supports. \r
+\r
+  @param UsbPortReset\r
+  Resets and reconfigures the USB controller. \r
+**/\r
 struct _EFI_USB_IO_PROTOCOL {\r
   //\r
   // IO transfer\r

diff --git a/MdePkg/Include/Protocol/Variable.h b/MdePkg/Include/Protocol/Variable.h
index 12f3aa4b625aec80cfa18a35708e1afc0c65fc76..ea60c20e6a3ab2438889291ccb55cf7765c2c220 100644 (file)
--- a/MdePkg/Include/Protocol/Variable.h
+++ b/MdePkg/Include/Protocol/Variable.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Variable Architectural Protocol as defined in the DXE CIS\r
+  Variable Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
 \r
   This code is used to produce the UEFI 2.0 runtime variable services\r
 \r
@@ -18,9 +18,6 @@
   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
 \r
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #ifndef __ARCH_PROTOCOL_VARIABLE_ARCH_H__\r

diff --git a/MdePkg/Include/Protocol/VariableWrite.h b/MdePkg/Include/Protocol/VariableWrite.h
index c9d1fa5b4a84f46fc3a59dfcce430d464aa0e262..cb8050eb0d942aaf8ace76a9c30b0540b52dec5f 100644 (file)
--- a/MdePkg/Include/Protocol/VariableWrite.h
+++ b/MdePkg/Include/Protocol/VariableWrite.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Variable Write Architectural Protocol as defined in the DXE CIS\r
+  Variable Write Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
 \r
   This code is used to produce the UEFI 2.0 runtime variable services\r
 \r
@@ -17,9 +17,6 @@
   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
 \r
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #ifndef __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__\r

diff --git a/MdePkg/Include/Protocol/WatchdogTimer.h b/MdePkg/Include/Protocol/WatchdogTimer.h
index f13d1fd5e5f1a9439de95cc69f0d3308835e6b36..d85dc5bb94dbc1297014da2aaa1cf41d53c87f79 100644 (file)
--- a/MdePkg/Include/Protocol/WatchdogTimer.h
+++ b/MdePkg/Include/Protocol/WatchdogTimer.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Watchdog Timer Architectural Protocol as defined in the DXE CIS\r
+  Watchdog Timer Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
 \r
   Used to provide system watchdog timer services\r
 \r
@@ -11,10 +11,6 @@
 \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
-\r
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r