update comments per review comments.

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

11 files changed, 35 insertions, 35 deletions

diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h
index ea3949cada..fc68603b34 100644
--- a/MdePkg/Include/Protocol/DeviceIo.h
+++ b/MdePkg/Include/Protocol/DeviceIo.h
@@ -4,7 +4,7 @@
   Device IO is used to abstract hardware access to devices. It includes

   memory mapped IO, IO, PCI Config space, and DMA.

 

-  Copyright (c) 2006 - 2008, Intel Corporation                                                         

+  Copyright (c) 2006 - 2009, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -135,6 +135,7 @@ typedef enum {
   @param  Operation             Indicates if the bus master is going to read or write to system memory.

   @param  HostAddress           The system memory address to map to the device.

   @param  NumberOfBytes         On input, the number of bytes to map.

+                                On output the number of bytes that were mapped.

   @param  DeviceAddress         The resulting map address for the bus master device to use to access the

                                 hosts HostAddress.

   @param  Mapping               A resulting value to pass to Unmap().

diff --git a/MdePkg/Include/Protocol/DriverBinding.h b/MdePkg/Include/Protocol/DriverBinding.h
index 2b7eb31ea7..8ec2d2d7df 100644
--- a/MdePkg/Include/Protocol/DriverBinding.h
+++ b/MdePkg/Include/Protocol/DriverBinding.h
@@ -4,7 +4,7 @@
   This protocol is produced by every driver that follows the UEFI Driver Model, 

   and it is the central component that allows drivers and controllers to be managed.

 

-  Copyright (c) 2006 - 2008, Intel Corporation                                                         

+  Copyright (c) 2006 - 2009, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -113,7 +113,7 @@ EFI_STATUS
                                 to use to stop the device.

   @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.Not used.

   @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL 

-                                if NumberOfChildren is 0.Not used.

+                                if NumberOfChildren is 0.

 

   @retval EFI_SUCCESS           The device was stopped.

   @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.

diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h
index 1530bb824c..dbdaca3827 100644
--- a/MdePkg/Include/Protocol/HiiConfigRouting.h
+++ b/MdePkg/Include/Protocol/HiiConfigRouting.h
@@ -5,7 +5,7 @@
   information from configuration applications, routing the

   results to the appropriate drivers.

   

-  Copyright (c) 2006 - 2008, Intel Corporation

+  Copyright (c) 2006 - 2009, Intel Corporation

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -108,7 +108,7 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
 **/

 typedef

 EFI_STATUS

-(EFIAPI * EFI_HII_ROUTING_EXTRACT_CONFIG)(

+(EFIAPI * EFI_HII_EXTRACT_CONFIG)(

   IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,

   IN CONST  EFI_STRING                      Request,

   OUT       EFI_STRING                      *Progress,

@@ -124,7 +124,7 @@ EFI_STATUS
   call has deceptively few inputs but the implementation is likely

   to be somewhat complex. The requirement is to scan all IFR in

   the HII database to determine the list of names and then request

-  the configuration using the corresponding drivers??

+  the configuration using the corresponding drivers.

   EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig() interfaces below.

   

   @param This     Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.

@@ -152,7 +152,7 @@ EFI_STATUS
 **/

 typedef

 EFI_STATUS

-(EFIAPI * EFI_HII_ROUTING_EXPORT_CONFIG)(

+(EFIAPI * EFI_HII_EXPORT_CONFIG)(

   IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,

   OUT       EFI_STRING                      *Results

 );

@@ -199,7 +199,7 @@ EFI_STATUS
 **/

 typedef

 EFI_STATUS

-(EFIAPI * EFI_HII_ROUTING_ROUTE_CONFIG)(

+(EFIAPI * EFI_HII_ROUTE_CONFIG)(

   IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,

   IN CONST  EFI_STRING                      Configuration,

   OUT       EFI_STRING                      *Progress

@@ -269,7 +269,7 @@ EFI_STATUS
 **/

 typedef

 EFI_STATUS

-(EFIAPI * EFI_HII_ROUTING_BLOCK_TO_CONFIG)(

+(EFIAPI * EFI_HII_BLOCK_TO_CONFIG)(

   IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,

   IN CONST  EFI_STRING                      ConfigRequest,

   IN CONST  UINT8                           *Block,

@@ -339,7 +339,7 @@ EFI_STATUS
 **/

 typedef

 EFI_STATUS

-(EFIAPI * EFI_HII_ROUTING_CONFIG_TO_BLOCK)(

+(EFIAPI * EFI_HII_CONFIG_TO_BLOCK)(

   IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,

   IN CONST  EFI_STRING                      ConfigResp,

   IN OUT    UINT8                           *Block,

@@ -397,11 +397,11 @@ EFI_STATUS
 /// instance of this protocol in the system.

 ///

 struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {

-  EFI_HII_ROUTING_EXTRACT_CONFIG  ExtractConfig;

-  EFI_HII_ROUTING_EXPORT_CONFIG   ExportConfig;

-  EFI_HII_ROUTING_ROUTE_CONFIG    RouteConfig;

-  EFI_HII_ROUTING_BLOCK_TO_CONFIG BlockToConfig;

-  EFI_HII_ROUTING_CONFIG_TO_BLOCK ConfigToBlock;

+  EFI_HII_EXTRACT_CONFIG  ExtractConfig;

+  EFI_HII_EXPORT_CONFIG   ExportConfig;

+  EFI_HII_ROUTE_CONFIG    RouteConfig;

+  EFI_HII_BLOCK_TO_CONFIG BlockToConfig;

+  EFI_HII_CONFIG_TO_BLOCK ConfigToBlock;

   EFI_HII_GET_ALT_CFG             GetAltConfig;

 };

 

diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h
index 579eb64c5d..2b836158d9 100644
--- a/MdePkg/Include/Protocol/HiiFont.h
+++ b/MdePkg/Include/Protocol/HiiFont.h
@@ -1,7 +1,7 @@
 /** @file

   The file provides services to retrieve font information.

   

-  Copyright (c) 2006 - 2008, Intel Corporation

+  Copyright (c) 2006 - 2009, Intel Corporation

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -251,8 +251,7 @@ EFI_STATUS
   EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the

   behavior of EFI_HII_OUT_FLAG_CLIP so that if a row's bottom

   most pixel cannot fit, then it will not be drawn at all. This

-  flag requires that EFI_HII_OUT_FLAG_CLIP be set. Draft for

-  Review HII Protocols Version 2.1 November 3, 2006 1285 If

+  flag requires that EFI_HII_OUT_FLAG_CLIP be set. If

   EFI_HII_OUT_FLAG_WRAP is set, then text will be wrapped at the

   right-most line-break opportunity prior to a character whose

   right-most extent would exceed Width. If no line-break

diff --git a/MdePkg/Include/Protocol/Ip4.h b/MdePkg/Include/Protocol/Ip4.h
index d0ff760ee2..5dc2dc69e7 100644
--- a/MdePkg/Include/Protocol/Ip4.h
+++ b/MdePkg/Include/Protocol/Ip4.h
@@ -11,7 +11,7 @@
     may include support for the Internet Group Management

     Protocol (IGMP).

   

-  Copyright (c) 2006 - 2008, Intel Corporation                                                         

+  Copyright (c) 2006 - 2009, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -311,7 +311,10 @@ EFI_STATUS
   @retval EFI_SUCCESS           The driver instance was successfully opened.

   @retval EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,

                                 RARP, etc.) is not finished yet.

-  @retval EFI_INVALID_PARAMETER At least one of the parameters was invalid. 

+  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:

+                                This is NULL.

+                                IpConfigData.StationAddress is not a unicast IPv4 address.

+                                IpConfigData.SubnetMask is not a valid IPv4 subnet 

   @retval EFI_UNSUPPORTED       One or more of the following conditions is TRUE:

                                 A configuration protocol (DHCP, BOOTP, RARP, etc.) could

                                 not be located when clients choose to use the default IPv4

diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h
index 9765206d0b..db3b2b1f0d 100644
--- a/MdePkg/Include/Protocol/Pcd.h
+++ b/MdePkg/Include/Protocol/Pcd.h
@@ -1,7 +1,7 @@
 /** @file

   Platform Configuration Database (PCD) Protocol

 

-  Copyright (c) 2006 - 2008, Intel Corporation                                                         

+  Copyright (c) 2006 - 2009, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -43,7 +43,6 @@ extern EFI_GUID gPcdProtocolGuid;
   @param[in]  SkuId The SKU value that will be used when the PCD service will retrieve and 

                     set values associated with a PCD token.

 

-  @retval VOID

 

 **/

 typedef 

diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
index 4973553eb9..6c974caf64 100644
--- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
+++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
@@ -5,7 +5,7 @@
   by a UEFI Driver in its Start() function. This protocol allows the driver to receive 

   configuration information as part of being started.

 

-  Copyright (c) 2006 - 2008, Intel Corporation 

+  Copyright (c) 2006 - 2009, Intel Corporation 

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -290,10 +290,7 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
 **/

 typedef struct {

   CHAR8   *CLPCommand;        ///<  A pointer to the DMTF SM CLP command line null-terminated string that the 

-                              ///<  driver is required to parse and process. EFI_SUCCESS The platform 

-                              ///<  return parameter information for ControllerHandle. EFI_NOT_FOUND Instance 

-                              ///<  was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid 

-                              ///<  EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. Function is called. 

+                              ///<  driver is required to parse and process when this function is called. 

                               ///<  See the DMTF SM CLP Specification 1.0 Final Standard for details on the 

                               ///<  format and syntax of the CLP command line string. CLPCommand buffer

                               ///<  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.

diff --git a/MdePkg/Include/Protocol/RealTimeClock.h b/MdePkg/Include/Protocol/RealTimeClock.h
index 6f4df05158..82a94e1750 100644
--- a/MdePkg/Include/Protocol/RealTimeClock.h
+++ b/MdePkg/Include/Protocol/RealTimeClock.h
@@ -11,7 +11,7 @@
 

   No CRC of the EFI system table is required, since that is done in the DXE core.

 

-  Copyright (c) 2006 - 2008, Intel Corporation                                                         

+  Copyright (c) 2006 - 2009, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h b/MdePkg/Include/Protocol/SimpleTextIn.h
index 6f4e73887f..b093592da2 100644
--- a/MdePkg/Include/Protocol/SimpleTextIn.h
+++ b/MdePkg/Include/Protocol/SimpleTextIn.h
@@ -1,5 +1,5 @@
 /** @file

-  Simple Text In protocol from the UEFI 2.0 specification.

+  Simple Text Input protocol from the UEFI 2.0 specification.

 

   Abstraction of a very simple input device like a keyboard or serial

   terminal.

diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h
index df5e6fd393..98d0c583dc 100644
--- a/MdePkg/Include/Protocol/SimpleTextInEx.h
+++ b/MdePkg/Include/Protocol/SimpleTextInEx.h
@@ -1,8 +1,9 @@
 /** @file

-  The file defines the protocol to obtain input from the

-  ConsoleIn device. The EFI specification requires that the

-  EFI_SIMPLE_TEXT_INPUT_PROTOCOL supports the same languages as

-  the corresponding

+  Simple Text Input Ex protocol from the UEFI 2.0 specification.

+  

+  This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL

+  which exposes much more state and modifier information from the input device,

+  also allows one to register a notification for a particular keystroke.

 

   Copyright (c) 2006 - 2009, Intel Corporation 

   All rights reserved. This program and the accompanying materials                          

diff --git a/MdePkg/Include/Protocol/SmbusHc.h b/MdePkg/Include/Protocol/SmbusHc.h
index f03b6b6d04..067ebb2b0a 100644
--- a/MdePkg/Include/Protocol/SmbusHc.h
+++ b/MdePkg/Include/Protocol/SmbusHc.h
@@ -2,7 +2,7 @@
   The file provides basic SMBus host controller management 

   and basic data transactions over the SMBus.

 

-  Copyright (c) 2006 - 2008, Intel Corporation                                                          

+  Copyright (c) 2006 - 2009, Intel Corporation                                                          

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -32,7 +32,7 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
   operation as defined in the System Management Bus (SMBus)

   Specification. The resulting transaction will be either that

   the SMBus slave devices accept this transaction or that this

-  function returns with error. Status Codes Returned

+  function returns with error. 

   

   @param This     A pointer to the EFI_SMBUS_HC_PROTOCOL instance.

                   SlaveAddress The SMBus slave address of the device