Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...
authorpkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 4 Jun 2009 05:49:29 +0000 (05:49 +0000)
committerpkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 4 Jun 2009 05:49:29 +0000 (05:49 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8462 6f19259b-4bc3-4df7-8a09-765794883524

55 files changed:
MdePkg/Include/Protocol/AbsolutePointer.h
MdePkg/Include/Protocol/Arp.h
MdePkg/Include/Protocol/AuthenticationInfo.h
MdePkg/Include/Protocol/Bis.h
MdePkg/Include/Protocol/ComponentName.h
MdePkg/Include/Protocol/ComponentName2.h
MdePkg/Include/Protocol/DebugSupport.h
MdePkg/Include/Protocol/Decompress.h
MdePkg/Include/Protocol/DeviceIo.h
MdePkg/Include/Protocol/DevicePath.h
MdePkg/Include/Protocol/Dhcp4.h
MdePkg/Include/Protocol/DriverConfiguration.h
MdePkg/Include/Protocol/DriverConfiguration2.h
MdePkg/Include/Protocol/DriverDiagnostics2.h
MdePkg/Include/Protocol/DriverFamilyOverride.h
MdePkg/Include/Protocol/DriverSupportedEfiVersion.h
MdePkg/Include/Protocol/Ebc.h
MdePkg/Include/Protocol/EdidActive.h
MdePkg/Include/Protocol/EdidDiscovered.h
MdePkg/Include/Protocol/EdidOverride.h
MdePkg/Include/Protocol/FirmwareVolume2.h
MdePkg/Include/Protocol/FirmwareVolumeBlock.h
MdePkg/Include/Protocol/FormBrowser2.h
MdePkg/Include/Protocol/GraphicsOutput.h
MdePkg/Include/Protocol/Hash.h
MdePkg/Include/Protocol/HiiConfigAccess.h
MdePkg/Include/Protocol/HiiConfigRouting.h
MdePkg/Include/Protocol/HiiDatabase.h
MdePkg/Include/Protocol/HiiFont.h
MdePkg/Include/Protocol/HiiPackageList.h
MdePkg/Include/Protocol/IScsiInitiatorName.h
MdePkg/Include/Protocol/Ip4.h
MdePkg/Include/Protocol/Metronome.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/Pcd.h
MdePkg/Include/Protocol/PciIo.h
MdePkg/Include/Protocol/PciRootBridgeIo.h
MdePkg/Include/Protocol/PlatformDriverOverride.h
MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
MdePkg/Include/Protocol/RealTimeClock.h
MdePkg/Include/Protocol/Runtime.h
MdePkg/Include/Protocol/ScsiIo.h
MdePkg/Include/Protocol/ScsiPassThru.h
MdePkg/Include/Protocol/ScsiPassThruExt.h
MdePkg/Include/Protocol/SerialIo.h
MdePkg/Include/Protocol/SimpleFileSystem.h
MdePkg/Include/Protocol/SimpleNetwork.h
MdePkg/Include/Protocol/SimplePointer.h
MdePkg/Include/Protocol/SimpleTextInEx.h
MdePkg/Include/Protocol/SimpleTextOut.h
MdePkg/Include/Protocol/SmbusHc.h
MdePkg/Include/Protocol/StatusCode.h
MdePkg/Include/Protocol/Tcp4.h
MdePkg/Include/Protocol/UgaIo.h
MdePkg/Include/Protocol/WatchdogTimer.h

index 29947ed..5e18bf8 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  The file provides services that allow information about a\r
+  The file provides services that allow information about an\r
   absolute pointer device to be retrieved.\r
   \r
   Copyright (c) 2006 - 2008, Intel Corporation\r
@@ -108,7 +108,7 @@ EFI_STATUS
 **/\r
 typedef struct {\r
   ///\r
-  /// The unsigned position of the activation on the x axis If the AboluteMinX \r
+  /// The unsigned position of the activation on the x axis. If the AboluteMinX \r
   /// and the AboluteMaxX fields of the EFI_ABSOLUTE_POINTER_MODE structure are \r
   /// both 0, then this pointer device does not support an x-axis, and this field\r
   /// must be ignored.\r
@@ -116,7 +116,7 @@ typedef struct {
   UINT64 CurrentX;\r
   \r
   ///\r
-  /// The unsigned position of the activation on the x axis If the AboluteMinY \r
+  /// The unsigned position of the activation on the x axis. If the AboluteMinY \r
   /// and the AboluteMaxY fields of the EFI_ABSOLUTE_POINTER_MODE structure are \r
   /// both 0, then this pointer device does not support an y-axis, and this field\r
   /// must be ignored.  \r
@@ -180,10 +180,9 @@ EFI_STATUS
 /// The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services\r
 /// for a pointer device that can be used as an input device from an\r
 /// application written to this specification. The services include\r
-/// the ability to reset the pointer device, retrieve the state of\r
+/// the ability to: reset the pointer device, retrieve the state of\r
 /// the pointer device, and retrieve the capabilities of the pointer\r
-/// device. In addition certain data items describing the device are\r
-/// provided.\r
+/// device. The service also provides certain data items describing the device.\r
 ///\r
 struct _EFI_ABSOLUTE_POINTER_PROTOCOL {\r
   EFI_ABSOLUTE_POINTER_RESET      Reset;\r
index bd7f7d2..1f21386 100644 (file)
@@ -131,9 +131,9 @@ typedef struct {
   @retval EFI_SUCCESS            The new station address was successfully\r
                                  registered.\r
   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
-                                 This is NULL. SwAddressLength is zero when\r
-                                 ConfigData is not NULL. StationAddress is NULL\r
-                                 when ConfigData is not NULL.\r
+                                 * This is NULL. \r
+                                 * SwAddressLength is zero when ConfigData is not NULL. \r
+                                 * StationAddress is NULL when ConfigData is not NULL.\r
   @retval EFI_ACCESS_DENIED      The SwAddressType, SwAddressLength, or\r
                                  StationAddress is different from the one that is\r
                                  already registered.\r
@@ -181,11 +181,11 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS            The entry has been added or updated.\r
   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
-                                 This is NULL. DenyFlag is FALSE and\r
-                                 TargetHwAddress is NULL. DenyFlag is FALSE and\r
-                                 TargetSwAddress is NULL. TargetHwAddress is NULL\r
-                                 and TargetSwAddress is NULL. Both TargetSwAddress\r
-                                 and TargetHwAddress are not NULL when DenyFlag is\r
+                                 * This is NULL. \r
+                                 * DenyFlag is FALSE and TargetHwAddress is NULL. \r
+                                 * DenyFlag is FALSE and TargetSwAddress is NULL. \r
+                                 * TargetHwAddress is NULL and TargetSwAddress is NULL. \r
+                                 * Neither TargetSwAddress nor TargetHwAddress are NULL when DenyFlag is\r
                                  TRUE.\r
   @retval EFI_OUT_OF_RESOURCES   The new ARP cache entry could not be allocated.\r
   @retval EFI_ACCESS_DENIED      The ARP cache entry already exists and Overwrite\r
@@ -326,7 +326,7 @@ EFI_STATUS
   );  \r
 \r
 /**\r
-  This function aborts the previous ARP request (identified by This,  TargetSwAddress\r
+  This function aborts the previous ARP request (identified by This, TargetSwAddress\r
   and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request().\r
   \r
   If the request is in the internal ARP request queue, the request is aborted \r
index 8f62bc9..b520327 100644 (file)
@@ -145,14 +145,14 @@ typedef struct {
 } CHAP_LOCAL_AUTH_NODE;\r
 \r
 /**\r
-  Retrieves the Authentication information associated with a particular controller handle.\r
+  Retrieves the authentication information associated with a particular controller handle.\r
 \r
   @param  This                  Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
   @param  ControllerHandle      Handle to the Controller\r
   @param  Buffer                Pointer to the authentication information.\r
 \r
-  @retval EFI_SUCCESS           Successfully retrieved Authentication information for the given ControllerHandle\r
-  @retval EFI_INVALID_PARAMETER No matching Authentication information found for the given ControllerHandle\r
+  @retval EFI_SUCCESS           Successfully retrieved authentication information for the given ControllerHandle\r
+  @retval EFI_INVALID_PARAMETER No matching authentication information found for the given ControllerHandle\r
   @retval EFI_DEVICE_ERROR      The authentication information could not be retrieved due to a\r
                                 hardware error.\r
 \r
@@ -166,14 +166,14 @@ EFI_STATUS
   );  \r
 \r
 /**\r
-  Set the Authentication information for a given controller handle.\r
+  Set the authentication information for a given controller handle.\r
 \r
   @param  This                 Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
   @param  ControllerHandle     Handle to the Controller\r
   @param  Buffer               Pointer to the authentication information.\r
                                 \r
-  @retval EFI_SUCCESS          Successfully set Authentication information for the given ControllerHandle\r
-  @retval EFI_UNSUPPORTED      If the platform policies do not allow setting of the Authentication\r
+  @retval EFI_SUCCESS          Successfully set authentication information for the given ControllerHandle\r
+  @retval EFI_UNSUPPORTED      If the platform policies do not allow setting of the authentication\r
                                information.\r
   @retval EFI_DEVICE_ERROR     The authentication information could not be configured due to a\r
                                hardware error.\r
index 3a8ab09..bff4812 100644 (file)
@@ -115,7 +115,7 @@ typedef struct {
 #define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data)\r
 \r
 ///\r
-/// Support old name for backward compatible\r
+/// Support old name for backward compatibility\r
 ///\r
 #define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \\r
         BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID\r
@@ -146,11 +146,11 @@ typedef struct {
                                    TargetAddress.Data was any other value that was not\r
                                    supported by the implementation.                   \r
   @retval EFI_OUT_OF_RESOURCES     The function failed due to lack of memory or other resources.                              \r
-  @retval EFI_DEVICE_ERROR         The function encountered an unexpected internal failure while\r
-                                   initializing a cryptographic software module, or\r
-                                   No cryptographic software module with compatible version was\r
-                                   found, or A resource limitation was encountered while using a\r
-                                   cryptographic software module.\r
+  @retval EFI_DEVICE_ERROR         One of the following device errors:\r
+                                   * The function encountered an unexpected internal failure while initializing a cryptographic software module\r
+                                   * No cryptographic software module with compatible version was found\r
+                                   found\r
+                                   * A resource limitation was encountered while using a cryptographic software module.\r
   @retval EFI_INVALID_PARAMETER    The This parameter supplied by the caller is NULL or does not\r
                                    reference a valid EFI_BIS_PROTOCOL object, or\r
                                    The AppHandle parameter supplied by the caller is NULL or\r
index 1f0f5f1..f7f2871 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
   EFI Component Name Protocol as defined in the EFI 1.1 specification.\r
-  This protocol is used to retrieve user readable names of EFI Drivers \r
+  This protocol is used to retrieve user-readable names of EFI Drivers \r
   and controllers managed by EFI Drivers.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
@@ -29,7 +29,7 @@ typedef struct _EFI_COMPONENT_NAME_PROTOCOL  EFI_COMPONENT_NAME_PROTOCOL;
 \r
 \r
 /**\r
-  Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
+  Retrieves a Unicode string that is the user-readable name of the EFI Driver.\r
 \r
   @param  This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
   @param  Language   A pointer to a three character ISO 639-2 language identifier.\r
index 2dfdf2f..45b2a8a 100644 (file)
@@ -27,7 +27,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL  EFI_COMPONENT_NAME2_PROTOCOL;
 \r
 \r
 /**\r
-  Retrieves a Unicode string that is the user readable name of\r
+  Retrieves a Unicode string that is the user-readable name of\r
   the EFI Driver.\r
 \r
   @param  This       A pointer to the\r
@@ -87,7 +87,7 @@ EFI_STATUS
                            retrieve the name of.  This is an\r
                            optional parameter that may be NULL.\r
                            It will be NULL for device drivers.\r
-                           It will also be NULL for bus\r
+                           It will also be NULL for bus\r
                            drivers that wish to retrieve the\r
                            name of the bus controller.  It will\r
                            not be NULL for a bus driver that\r
index 8f9ea48..843c829 100644 (file)
@@ -285,7 +285,7 @@ typedef struct {
 typedef struct {\r
   //\r
   // The first reserved field is necessary to preserve alignment for the correct\r
-  // bits in UNAT and to insure F2 is 16 byte aligned..\r
+  // bits in UNAT and to insure F2 is 16 byte aligned.\r
   //\r
   UINT64  Reserved;\r
   UINT64  R1;\r
index ed1e422..ae3bf94 100644 (file)
@@ -32,7 +32,7 @@ typedef struct _EFI_DECOMPRESS_PROTOCOL  EFI_DECOMPRESS_PROTOCOL;
   buffer is returned in DestinationSize, the size of the scratch buffer is \r
   returned in ScratchSize, and EFI_SUCCESS is returned.\r
 \r
-  The GetInfo() function does not have scratch buffer available to perform \r
+  The GetInfo() function does not have scratch buffer available to perform \r
   a thorough checking of the validity of the source data. It just retrieves\r
   the 'Original Size' field from the beginning bytes of the source data and\r
   output it as DestinationSize.  And ScratchSize is specific to the decompression\r
index 24939d8..ea3949c 100644 (file)
@@ -134,7 +134,7 @@ typedef enum {
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
   @param  Operation             Indicates if the bus master is going to read or write to system memory.\r
   @param  HostAddress           The system memory address to map to the device.\r
-  @param  NumberOfBytes         On input the number of bytes to map.\r
+  @param  NumberOfBytes         On input, the number of bytes to map.\r
   @param  DeviceAddress         The resulting map address for the bus master device to use to access the\r
                                 hosts HostAddress.\r
   @param  Mapping               A resulting value to pass to Unmap().\r
index a699eaf..8a6f339 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   The device path protocol as defined in UEFI 2.0.\r
 \r
-  The device path represents a programatic path to a device. It's the view\r
-  from a software point of view. It also must persist from boot to boot, so \r
+  The device path represents a programmatic path to a device,\r
+  from a software point of view. The path must persist from boot to boot, so \r
   it can not contain things like PCI bus numbers that change from boot to boot.\r
 \r
   Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
index dd536e3..69ec779 100644 (file)
@@ -720,7 +720,7 @@ EFI_STATUS
   If *OptionCount isn't zero, and there is enough space for all the DHCP options\r
   in the Packet, each element of PacketOptionList is set to point to somewhere in\r
   the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported,\r
-  the caller should reassemble the parsed DHCP options to get the finial result.\r
+  the caller should reassemble the parsed DHCP options to get the final result.\r
   If *OptionCount is zero or there isn't enough space for all of them, the number\r
   of DHCP options in the Packet is returned in OptionCount.\r
 \r
index f02c532..00da549 100644 (file)
@@ -35,7 +35,7 @@ typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL  EFI_DRIVER_CONFIGURATION_PROT
   @param  ControllerHandle The handle of the controller to set options on.\r
   @param  ChildHandle      The handle of the child controller to set options on.  This\r
                            is an optional parameter that may be NULL.  It will be NULL\r
-                           for device drivers, and for bus drivers that wish to set\r
+                           for device drivers, and for bus drivers that wish to set\r
                            options for the bus controller.  It will not be NULL for a\r
                            bus driver that wishes to set options for one of its child\r
                            controllers.\r
@@ -88,7 +88,7 @@ EFI_STATUS
   @param  ChildHandle      The handle of the child controller to test if it's current\r
                            configuration options are valid.  This is an optional\r
                            parameter that may be NULL.  It will be NULL for device\r
-                           drivers.  It will also be NULL for bus drivers that wish\r
+                           drivers.  It will also be NULL for bus drivers that wish\r
                            to test the configuration options for the bus controller.\r
                            It will not be NULL for a bus driver that wishes to test\r
                            configuration options for one of its child controllers.\r
@@ -121,9 +121,9 @@ EFI_STATUS
 \r
   @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
   @param  ControllerHandle The handle of the controller to force default configuration options on.\r
-  @param  ChildHandle      The handle of the child controller to force default configuration options on  This is an optional parameter that may be NULL.  It will be NULL for device drivers.  It will also be NULL for bus drivers that wish to force default configuration options for the bus controller.  It will not be NULL for a bus driver that wishes to force default configuration options for one of its child controllers.\r
+  @param  ChildHandle      The handle of the child controller to force default configuration options on  This is an optional parameter that may be NULL.  It will be NULL for device drivers.  It will also be NULL for bus drivers that wish to force default configuration options for the bus controller.  It will not be NULL for a bus driver that wishes to force default configuration options for one of its child controllers.\r
   @param  DefaultType      The type of default configuration options to force on the controller specified by ControllerHandle and ChildHandle.  See Table 9-1 for legal values.  A DefaultType of 0x00000000 must be supported by this protocol.\r
-  @param  ActionRequired   A pointer to the action that the calling agent is required to perform when this function returns.  See "Related Definitions" in Section 9.1for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
+  @param  ActionRequired   A pointer to the action that the calling agent is required to perform when this function returns.  See "Related Definitions" in Section 9.1 for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
 \r
   @retval EFI_SUCCESS           The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
index fc12fc8..2d28286 100644 (file)
@@ -62,7 +62,7 @@ typedef enum {
   @param  ControllerHandle The handle of the controller to set options on.\r
   @param  ChildHandle      The handle of the child controller to set options on.  This\r
                            is an optional parameter that may be NULL.  It will be NULL\r
-                           for device drivers, and for bus drivers that wish to set\r
+                           for device drivers, and for bus drivers that wish to set\r
                            options for the bus controller.  It will not be NULL for a\r
                            bus driver that wishes to set options for one of its child\r
                            controllers.\r
@@ -78,7 +78,7 @@ typedef enum {
 \r
   @retval EFI_SUCCESS           The driver specified by This successfully set the\r
                                 configuration options for the controller specified\r
-                                by ControllerHandle..\r
+                                by ControllerHandle.\r
   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
   @retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
@@ -87,7 +87,7 @@ typedef enum {
                                 ControllerHandle and ChildHandle.\r
   @retval EFI_UNSUPPORTED       The driver specified by This does not support the\r
                                 language specified by Language.\r
-  @retval EFI_DEVICE_ERROR      A device error occurred while attempt to set the\r
+  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to set the\r
                                 configuration options for the controller specified\r
                                 by ControllerHandle and ChildHandle.\r
   @retval EFI_OUT_RESOURCES     There are not enough resources available to set the\r
@@ -114,7 +114,7 @@ EFI_STATUS
   @param  ChildHandle      The handle of the child controller to test if it's current\r
                            configuration options are valid.  This is an optional\r
                            parameter that may be NULL.  It will be NULL for device\r
-                           drivers.  It will also be NULL for bus drivers that wish\r
+                           drivers.  It will also be NULL for bus drivers that wish\r
                            to test the configuration options for the bus controller.\r
                            It will not be NULL for a bus driver that wishes to test\r
                            configuration options for one of its child controllers.\r
@@ -147,9 +147,9 @@ EFI_STATUS
 \r
   @param  This             A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
   @param  ControllerHandle The handle of the controller to force default configuration options on.\r
-  @param  ChildHandle      The handle of the child controller to force default configuration options on  This is an optional parameter that may be NULL.  It will be NULL for device drivers.  It will also be NULL for bus drivers that wish to force default configuration options for the bus controller.  It will not be NULL for a bus driver that wishes to force default configuration options for one of its child controllers.\r
+  @param  ChildHandle      The handle of the child controller to force default configuration options on  This is an optional parameter that may be NULL.  It will be NULL for device drivers.  It will also be NULL for bus drivers that wish to force default configuration options for the bus controller.  It will not be NULL for a bus driver that wishes to force default configuration options for one of its child controllers.\r
   @param  DefaultType      The type of default configuration options to force on the controller specified by ControllerHandle and ChildHandle.  See Table 9-1 for legal values.  A DefaultType of 0x00000000 must be supported by this protocol.\r
-  @param  ActionRequired   A pointer to the action that the calling agent is required to perform when this function returns.  See "Related Definitions" in Section 9.1for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
+  @param  ActionRequired   A pointer to the action that the calling agent is required to perform when this function returns.  See "Related Definitions" in Section 9.1 for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
 \r
   @retval EFI_SUCCESS           The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
index 0531223..adba0f7 100644 (file)
@@ -31,11 +31,11 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
   @param  ControllerHandle The handle of the controller to run diagnostics on.\r
   @param  ChildHandle      The handle of the child controller to run diagnostics on\r
                            This is an optional parameter that may be NULL.  It will\r
-                           be NULL for device drivers.  It will also be NULL for a\r
+                           be NULL for device drivers.  It will also be NULL for \r
                            bus drivers that wish to run diagnostics on the bus\r
                            controller.  It will not be NULL for a bus driver that\r
                            wishes to run diagnostics on one of its child controllers.\r
-  @param  DiagnosticType   Indicates type of diagnostics to perform on the controller\r
+  @param  DiagnosticType   Indicates the type of diagnostics to perform on the controller\r
                            specified by ControllerHandle and ChildHandle.   See\r
                            "Related Definitions" for the list of supported types.\r
   @param  Language         A pointer to a Null-terminated ASCII string\r
index 92fc1d9..b0b35f0 100644 (file)
@@ -32,7 +32,7 @@ typedef struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL  EFI_DRIVER_FAMILY_OVERRIDE_
   Retrieves the version of the driver that is used by the EFI Boot Service ConnectController()\r
   to sort the set of Driver Binding Protocols in order from highest priority to lowest priority.\r
   For drivers that support the Driver Family Override Protocol, those drivers are sorted so that\r
-  the drivers with higher values returned by GetVersion() are high priority that drivers that\r
+  the drivers with higher values returned by GetVersion() are higher priority than drivers that\r
   return lower values from GetVersion().\r
 \r
   @param  This                  A pointer to the EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL instance.                            \r
index d465a3a..dc72ecb 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   The protocol provides information about the version of the EFI\r
   specification that a driver is following. This protocol is\r
-  required for EFI drivers that are on PCI and other plug in\r
+  required for EFI drivers that are on PCI and other plug-in\r
   cards.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation\r
 /// The EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL provides a\r
 /// mechanism for an EFI driver to publish the version of the EFI   \r
 /// specification it conforms to. This protocol must be placed on   \r
-/// the drivers image handle when the driver's entry point is   \r
+/// the driver's image handle when the driver's entry point is   \r
 /// called.\r
 ///\r
 typedef struct _EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL {\r
   ///\r
   /// The size, in bytes, of the entire structure. Future versions of this \r
-  /// specification may grow the size of the structure.\r
+  /// specification may increase the size of the structure.\r
   /// \r
   UINT32 Length;\r
   ///\r
index a516f54..13ece4a 100644 (file)
@@ -34,15 +34,15 @@ typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL;
   Creates a thunk for an EBC entry point, returning the address of the thunk.\r
   \r
   A PE32+ EBC image, like any other PE32+ image, contains an optional header that specifies the\r
-  entry point for image execution. However for EBC images this is the entry point of EBC\r
-  instructions, so is not directly executable by the native processor. Therefore when an EBC image is\r
-  loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed\r
+  entry point for image execution. However, for EBC images, this is the entry point of EBC\r
+  instructions, so is not directly executable by the native processor. Therefore, when an EBC image is\r
+  loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed,\r
   which will invoke the interpreter to begin execution at the original EBC entry point.\r
 \r
   @param  This          A pointer to the EFI_EBC_PROTOCOL instance.\r
   @param  ImageHandle   Handle of image for which the thunk is being created.\r
   @param  EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.\r
-  @param  Thunk         Returned pointer to a thunk created.\r
+  @param  Thunk         Returned pointer to a created thunk.\r
 \r
   @retval EFI_SUCCESS            The function completed successfully.\r
   @retval EFI_INVALID_PARAMETER  Image entry point is not 2-byte aligned.\r
@@ -119,7 +119,7 @@ EFI_STATUS
   returned version is identical to that returned by the EBC BREAK 1 instruction.\r
 \r
   @param  This       A pointer to the EFI_EBC_PROTOCOL instance.  \r
-  @param  Version Pointer to where to store the returned version of the interpreter.\r
+  @param  Version       Pointer to the location to store the returned version of the interpreter.\r
 \r
   @retval EFI_SUCCESS            The function completed successfully.\r
   @retval EFI_INVALID_PARAMETER  Version pointer is NULL.\r
index 81299a3..4e199db 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   EDID Active Protocol from the UEFI 2.0 specification.\r
 \r
-  Placed on the video output device child handle that are actively displaying output.\r
+  Placed on the video output device child handle that is actively displaying output.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index dedefa0..6ebe207 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   EDID Discovered Protocol from the UEFI 2.0 specification.\r
 \r
-  This protocol is placed on the video output device child handle and it represents\r
-  the EDID information being used for output device represented by the child handle.\r
+  This protocol is placed on the video output device child handle. It represents\r
+  the EDID information being used for the output device represented by the child handle.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index f2076b2..772956e 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   EDID Override Protocol from the UEFI 2.0 specification.\r
 \r
-  Allow platform to provide EDID information to producer of the Graphics Output\r
+  Allow platform to provide EDID information to the producer of the Graphics Output\r
   protocol.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
index 07767f3..7e5775d 100644 (file)
@@ -295,7 +295,7 @@ EFI_STATUS
                                       attempting to access the firmware volume.\r
 \r
   @retval EFI_ACCESS_DENIED           The firmware volume is configured to\r
-                                      isallow reads.\r
+                                      disallow reads.\r
 \r
 **/\r
 typedef\r
index d44f615..d25a2a0 100644 (file)
@@ -206,9 +206,9 @@ EFI_STATUS
   function, or else the result will be unpredictable. This\r
   unpredictability arises because, for a sticky-write firmware\r
   volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY\r
-  state but it cannot flip it back again. In general, before\r
+  state but cannot flip it back again. In general, before\r
   calling the Write() function, the caller should call the\r
-  EraseBlocks() function first to erase the specified block to\r
+  EraseBlocks() function first to erase the block it intends to\r
   write. A block erase cycle will transition bits from the\r
   (NOT)EFI_FVB_ERASE_POLARITY state back to the\r
   EFI_FVB_ERASE_POLARITY state. Implementations should be\r
@@ -276,7 +276,7 @@ EFI_STATUS
 /**\r
   Erases and initializes a firmware volume block.\r
 \r
-  The EraseBlocks() function erases one or more blocks as denoted\r
+  The EraseBlocks() function erases one or more blocks, as denoted\r
   by the variable argument list. The entire parameter list of\r
   blocks must be verified before erasing any blocks. If a block is\r
   requested that does not exist within the associated firmware\r
index 9cb3f96..43589c1 100644 (file)
@@ -29,12 +29,10 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL   EFI_FORM_BROWSER2_PROTOCOL;
 /**\r
    \r
   @param LeftColumn   Value that designates the text column\r
-                      where the browser window will begin from\r
-                      the left-hand side of the screen\r
+                      at which the browser window will begin (left-most column). \r
                       \r
   @param RightColumn  Value that designates the text\r
-                      column where the browser window will end\r
-                      on the right-hand side of the screen.\r
+                      column at which the browser window will end (right-most column).\r
 \r
   @param TopRow       Value that designates the text row from the\r
                       top of the screen where the browser window\r
index 8d63f97..5f2e6e1 100644 (file)
@@ -33,7 +33,7 @@ typedef struct {
 \r
 typedef enum {\r
   ///\r
-  /// A pixel is 32-bits and byte zero represents red, byte one represents green, \r
+  /// A pixel is 32-bits. Byte zero represents red, byte one represents green, \r
   /// byte two represents blue, and byte three is reserved. This is the definition \r
   /// for the physical frame buffer. The byte values for the red, green, and blue \r
   /// components represent the color intensity. This color intensity value range \r
@@ -41,7 +41,7 @@ typedef enum {
   ///\r
   PixelRedGreenBlueReserved8BitPerColor,\r
   ///\r
-  /// A pixel is 32-bits and byte zero represents blue, byte one represents green, \r
+  /// A pixel is 32-bits. Byte zero represents blue, byte one represents green, \r
   /// byte two represents red, and byte three is reserved. This is the definition \r
   /// for the physical frame buffer. The byte values for the red, green, and blue \r
   /// components represent the color intensity. This color intensity value range \r
index fe8c901..e5cc8de 100644 (file)
@@ -2,7 +2,7 @@
   EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.\r
   EFI_HASH_PROTOCOL as defined in UEFI 2.0.\r
   The EFI Hash Service Binding Protocol is used to locate hashing services support \r
-  provided by a driver and create and destroy instances of the EFI Hash Protocol \r
+  provided by a driver and to create and destroy instances of the EFI Hash Protocol \r
   so that a multiple drivers can use the underlying hashing services.\r
   The EFI Service Binding Protocol defines the generic Service Binding Protocol functions.\r
 \r
@@ -79,7 +79,7 @@ typedef union {
 } EFI_HASH_OUTPUT;\r
 \r
 /**\r
-  Returns the size of the hash which results from a specific algorithm.\r
+  Returns the size of the hash that results from a specific algorithm.\r
 \r
   @param  This                  Points to this instance of EFI_HASH_PROTOCOL.\r
   @param  HashAlgorithm         Points to the EFI_GUID which identifies the algorithm to use.\r
@@ -100,7 +100,7 @@ EFI_STATUS
   );      \r
 \r
 /**\r
-  Returns the size of the hash which results from a specific algorithm.\r
+  Returns the size of the hash that results from a specific algorithm.\r
 \r
   @param  This          Points to this instance of EFI_HASH_PROTOCOL.\r
   @param  HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
index c131821..46a4362 100644 (file)
@@ -95,7 +95,7 @@ typedef UINTN EFI_BROWSER_ACTION;
                                   process the names.\r
 \r
   @retval EFI_INVALID_PARAMETER   Illegal syntax. Progress set\r
-                                  to most recent & before the\r
+                                  to most recent "&" before the\r
                                   error or the beginning of the\r
                                   string.\r
 \r
@@ -173,7 +173,7 @@ EFI_STATUS
   @param  QuestionId             A unique value which is sent to the original\r
                                  exporting driver so that it can identify the type\r
                                  of data to expect. The format of the data tends to \r
-                                 vary based on the opcode that enerated the callback.\r
+                                 vary based on the opcode that generated the callback.\r
   @param  Type                   The type of value for the question.\r
   @param  Value                  A pointer to the data being sent to the original\r
                                  exporting driver.\r
index 8e833bd..1530bb8 100644 (file)
@@ -87,8 +87,9 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
                                   for the Request parameter\r
                                   would result in this type of\r
                                   error. The Progress parameter\r
-                                  is set to NULL. EFI_NOT_FOUND\r
-                                  Routing data doesn't match any\r
+                                  is set to NULL. \r
+  \r
+  @retval EFI_NOT_FOUND           Routing data doesn't match any\r
                                   known driver. Progress set to\r
                                   the "G" in "GUID" of the\r
                                   routing header that doesn't\r
@@ -256,8 +257,8 @@ EFI_STATUS
   @retval EFI_NOT_FOUND           Target for the specified routing data\r
                                   was not found. Progress points to the\r
                                   'G' in "GUID" of the errant routing\r
-                                  data. EFI_DEVICE_ERROR Block not large\r
-                                  enough. Progress undefined.\r
+                                  data. \r
+  @retval EFI_DEVICE_ERROR                             Block not large enough. Progress undefined.\r
 \r
   @retval EFI_INVALID_PARAMETER   Encountered non <BlockName>\r
                                   formatted string. Block is\r
@@ -324,7 +325,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS            The request succeeded. Progress points to the null\r
                                  terminator at the end of the ConfigResp string.\r
-  @retval EFI_OUT_OF_RESOURCES   Not enough memory to allocate Config.     Progress\r
+  @retval EFI_OUT_OF_RESOURCES   Not enough memory to allocate Config. Progress\r
                                  points to the first character of ConfigResp.\r
   @retval EFI_INVALID_PARAMETER  Passing in a NULL for the ConfigResp or\r
                                  Block parameter would result in this type of\r
index b94323f..4fb2613 100644 (file)
@@ -147,8 +147,7 @@ EFI_STATUS
   EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in\r
   EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within\r
   the existing package list in the HII database specified by\r
-  Handle. If a package??s type matches one of the types collected\r
-  in step 1, then perform the following steps:\r
+  Handle. If a package's type matches one of the collected types, then perform the following steps:\r
   - Call any functions registered with the notification type\r
   REMOVE_PACK.\r
   - Remove the package from the package list and the HII\r
@@ -355,7 +354,7 @@ EFI_STATUS
   @retval EFI_SUCCESS   Unregister the notification Successsfully\r
   \r
   @retval EFI_NOT_FOUND The incoming notification handle does not exist \r
-                        in current hii database.\r
+                        in the current hii database.\r
   \r
 **/\r
 typedef\r
index 2590411..579eb64 100644 (file)
@@ -90,10 +90,10 @@ typedef struct {
 /**\r
   Describes font output-related information.\r
 \r
-  This structure is used for describing the way in which a string\r
+  This structure is used for describing the way a string\r
   should be rendered in a particular font. FontInfo specifies the\r
-  basic font information and ForegroundColor and BackgroundColor\r
-  specify the color in which they should be displayed. The flags\r
+  basic font information, and ForegroundColor and BackgroundColor\r
+  specify the color in which the characters should be displayed. The flags\r
   in FontInfoMask describe where the system default should be\r
   supplied instead of the specified information. The flags also\r
   describe what options can be used to make a match between the\r
@@ -194,7 +194,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
                           string on the row where it is\r
                           displayed. Non-printing characters\r
                           will have the offset ~0. The caller is\r
-                          responsible to allocate a buffer large\r
+                          responsible for allocating a buffer large\r
                           enough so that there is one entry for\r
                           each character in the string, not\r
                           including the null-terminator. It is\r
@@ -231,7 +231,7 @@ EFI_STATUS
 \r
   This function renders a string as a bitmap or to the screen\r
   and can clip or wrap the string. The bitmap is either supplied\r
-  by the caller or else is allocated by the function. The\r
+  by the caller or allocated by the function. The\r
   strings are drawn with the font, size and style specified and\r
   can be drawn transparently or opaquely. The function can also\r
   return information about each row and each character's\r
index 112e266..4afe46f 100644 (file)
@@ -2,7 +2,7 @@
   EFI_HII_PACKAGE_LIST_PROTOCOL as defined in UEFI 2.1.\r
   Boot service LoadImage() installs EFI_HII_PACKAGE_LIST_PROTOCOL on the handle\r
   if the image contains a custom PE/COFF resource with the type 'HII'.\r
-  The protocol's interface pointer points to the HII package list which is\r
+  The protocol's interface pointer points to the HII package list, which is\r
   contained in the resource's data.\r
   \r
   Copyright (c) 2009, Intel Corporation\r
index afa72b5..1b947d8 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
   EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.\r
-  It rovides the ability to get and set the iSCSI Initiator Name.                                                  \r
+  It provides the ability to get and set the iSCSI Initiator Name.                                                  \r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index ab59848..d0ff760 100644 (file)
@@ -311,7 +311,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The driver instance was successfully opened.\r
   @retval EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) is not finished yet.\r
-  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+  @retval EFI_INVALID_PARAMETER At least one of the parameters was invalid. \r
   @retval EFI_UNSUPPORTED       One or more of the following conditions is TRUE:\r
                                 A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
                                 not be located when clients choose to use the default IPv4\r
@@ -509,7 +509,7 @@ EFI_STATUS
   Abort an asynchronous transmit or receive request.\r
   \r
   The Cancel() function is used to abort a pending transmit or receive request.\r
-  If the token is in the transmit or receive request queues, after calling this\r
+  If the token is in the transmit or receive request queues, then after calling this\r
   function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
   be signaled. If the token is not in one of the queues, which usually means the\r
   asynchronous operation has completed, this function will not signal the token\r
index 2383c73..bef64a5 100644 (file)
@@ -33,7 +33,7 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;
   TickNumber from a known time source in the platform.  If TickNumber of \r
   ticks are detected, then EFI_SUCCESS is returned.  The actual time passed \r
   between entry of this function and the first tick is between 0 and \r
-  TickPeriod 100 nS units.  If you want to guarantee that at least TickPeriod \r
+  TickPeriod 100 nS units.  To guarantee that at least TickPeriod \r
   time has elapsed, wait for two ticks.  This function waits for a hardware \r
   event to determine when a tick occurs.  It is possible for interrupt \r
   processing, or exception processing to interrupt the execution of the \r
index c13851e..149c627 100644 (file)
@@ -182,9 +182,9 @@ typedef struct {
 //\r
 \r
 /**\r
-  a callback function that is provided by the caller to intercept               \r
+  A callback function that is provided by the caller to intercept               \r
   the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the\r
-  EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept       \r
+  EFI_MTFTP4_PROTOCOL.ReadFile() function, or alternatively to intercept       \r
   EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to    \r
   EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().                   \r
 \r
@@ -230,7 +230,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  a callback function that the caller provides to feed data to the\r
+  A callback function that the caller provides to feed data to the\r
   EFI_MTFTP4_PROTOCOL.WriteFile() function.\r
 \r
   @param  This   Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
index 3cf1049..9765206 100644 (file)
@@ -74,9 +74,9 @@ UINT8
 \r
 \r
 /**\r
-  Retrieves an 16-bit value for a given PCD token.\r
+  Retrieves a 16-bit value for a given PCD token.\r
 \r
-  Retrieves the current 16-bits value for a PCD token number.  \r
+  Retrieves the current 16-bit value for a PCD token number.  \r
   If the TokenNumber is invalid, the results are unpredictable.\r
   \r
   @param[in]  TokenNumber The PCD token number. \r
@@ -93,9 +93,9 @@ UINT16
 \r
 \r
 /**\r
-  Retrieves an 32-bit value for a given PCD token.\r
+  Retrieves a 32-bit value for a given PCD token.\r
 \r
-  Retrieves the current 32-bits value for a PCD token number.  \r
+  Retrieves the current 32-bit value for a PCD token number.  \r
   If the TokenNumber is invalid, the results are unpredictable.\r
   \r
   @param[in]  TokenNumber The PCD token number. \r
@@ -112,9 +112,9 @@ UINT32
 \r
 \r
 /**\r
-  Retrieves an 64-bit value for a given PCD token.\r
+  Retrieves a 64-bit value for a given PCD token.\r
 \r
-  Retrieves the current 64-bits value for a PCD token number.  \r
+  Retrieves the current 64-bit value for a PCD token number.  \r
   If the TokenNumber is invalid, the results are unpredictable.\r
   \r
   @param[in]  TokenNumber The PCD token number. \r
@@ -215,7 +215,7 @@ UINT8
 \r
 \r
 /**\r
-  Retrieves an 16-bit value for a given PCD token.\r
+  Retrieves a 16-bit value for a given PCD token.\r
 \r
   Retrieves the 16-bit value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -238,7 +238,7 @@ UINT16
 \r
 \r
 /**\r
-  Retrieves an 32-bit value for a given PCD token.\r
+  Retrieves a 32-bit value for a given PCD token.\r
 \r
   Retrieves the 32-bit value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -294,7 +294,7 @@ UINT64
   @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
-  @return The pointer to the buffer to be retrived.\r
+  @return The pointer to the buffer to be retrieved.\r
   \r
 **/\r
 typedef\r
@@ -307,7 +307,7 @@ VOID *
 \r
 \r
 /**\r
-  Retrieves an Boolean value for a given PCD token.\r
+  Retrieves a Boolean value for a given PCD token.\r
 \r
   Retrieves the Boolean value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -377,7 +377,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Sets an 16-bit value for a given PCD token.\r
+  Sets a 16-bit value for a given PCD token.\r
 \r
   When the PCD service sets a value, it will check to ensure that the \r
   size of the value being set is compatible with the Token's existing definition.  \r
@@ -403,7 +403,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Sets an 32-bit value for a given PCD token.\r
+  Sets a 32-bit value for a given PCD token.\r
 \r
   When the PCD service sets a value, it will check to ensure that the \r
   size of the value being set is compatible with the Token's existing definition.  \r
@@ -429,7 +429,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Sets an 64-bit value for a given PCD token.\r
+  Sets a 64-bit value for a given PCD token.\r
 \r
   When the PCD service sets a value, it will check to ensure that the \r
   size of the value being set is compatible with the Token's existing definition.  \r
@@ -486,7 +486,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Sets an Boolean value for a given PCD token.\r
+  Sets a Boolean value for a given PCD token.\r
 \r
   When the PCD service sets a value, it will check to ensure that the \r
   size of the value being set is compatible with the Token's existing definition.  \r
@@ -568,7 +568,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Sets an 32-bit value for a given PCD token.\r
+  Sets a 32-bit value for a given PCD token.\r
 \r
   When the PCD service sets a value, it will check to ensure that the \r
   size of the value being set is compatible with the Token's existing definition.  \r
@@ -596,7 +596,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Sets an 64-bit value for a given PCD token.\r
+  Sets a 64-bit value for a given PCD token.\r
 \r
   When the PCD service sets a value, it will check to ensure that the \r
   size of the value being set is compatible with the Token's existing definition.  \r
@@ -657,7 +657,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Sets an Boolean value for a given PCD token.\r
+  Sets a Boolean value for a given PCD token.\r
 \r
   When the PCD service sets a value, it will check to ensure that the \r
   size of the value being set is compatible with the Token's existing definition.  \r
@@ -690,8 +690,8 @@ EFI_STATUS
   This notification function serves two purposes. \r
   Firstly, it notifies the module which did the registration that the value \r
   of this PCD token has been set. Secondly, it provides a mechanism for the \r
-  module which did the registration to intercept the set operation and override \r
-  the value been set if necessary. After the invocation of the callback function, \r
+  module that did the registration to intercept the set operation and override \r
+  the value that has been set, if necessary. After the invocation of the callback function, \r
   TokenData will be used by PCD service DXE driver to modify the internal data in \r
   PCD database.\r
 \r
@@ -775,7 +775,7 @@ EFI_STATUS
 \r
 \r
   @param[in]      Guid    The 128-bit unique value that designates the namespace from which to retrieve the next token. \r
-                          This is an optional parameter that may be NULL.  If this parameter is NULL, then a request is \r
+                          This is an optional parameter that may be NULL. If this parameter is NULL, then a request is \r
                           being made to retrieve tokens from the default token space.\r
   @param[in,out]  TokenNumber \r
                           A pointer to the PCD token number to use to find the subsequent token number.  \r
@@ -798,14 +798,14 @@ EFI_STATUS
 /**\r
   Retrieves the next valid PCD token namespace for a given namespace.\r
 \r
-  @param[in, out]  Guid An indirect pointer to EFI_GUID.  On input it designates \r
+  @param[in, out]  Guid An indirect pointer to EFI_GUID. On input it designates \r
                         a known token namespace from which the search will start. On output, \r
                         it designates the next valid token namespace on the platform. If the input \r
                         token namespace does not exist on the platform, an error is returned and \r
                         the value of *Guid is undefined. If *Guid is NULL, then the GUID of the \r
                         first token space of the current platform is assigned to *Guid the function \r
-                        return EFI_SUCCESS. If  *Guid is NULL  and there is no namespace exist in \r
-                        the platform other than the default (NULL) tokennamespace, *Guid is unchanged \r
+                        return EFI_SUCCESS. If *Guid is NULL  and there is no namespace exist in \r
+                        the platform other than the default (NULL) token namespace, *Guid is unchanged \r
                         and the function return EFI_SUCCESS. If this input token namespace is the last \r
                         namespace on the platform, *Guid will be assigned to NULL and the function return \r
                         EFI_SUCCESS. \r
index f04218d..54ab0b5 100644 (file)
@@ -59,7 +59,7 @@ typedef enum {
 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO               0x0010  ///< I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (10 bit decode)\r
 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO       0x0020  ///< I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode)\r
 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO     0x0040  ///< I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080  ///< Map a memory range so write are combined\r
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080  ///< Map a memory range so writes are combined\r
 #define EFI_PCI_IO_ATTRIBUTE_IO                   0x0100  ///< Enable the I/O decode bit in the PCI Config Header\r
 #define EFI_PCI_IO_ATTRIBUTE_MEMORY               0x0200  ///< Enable the Memory decode bit in the PCI Config Header\r
 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER           0x0400  ///< Enable the DMA bit in the PCI Config Header\r
@@ -127,7 +127,7 @@ typedef enum {
 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;\r
 \r
 /**                                                                 \r
-  Reads from the memory space of a PCI controller. Returns when either the polling exit criteria is\r
+  Reads from the memory space of a PCI controller. Returns either when the polling exit criteria is\r
   satisfied or after a defined duration.                                                           \r
           \r
   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@@ -283,7 +283,7 @@ EFI_STATUS
   );\r
 \r
 /**                                                                 \r
-  Provides the PCI controller-Cspecific addresses needed to access system memory.\r
+  Provides the PCI controller-specific addresses needed to access system memory.\r
             \r
   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
   @param  Operation             Indicates if the bus master is going to read or write to system memory.\r
@@ -515,7 +515,7 @@ EFI_STATUS
 \r
 ///\r
 /// The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration, \r
-/// and DMA interfaces that are used to abstract accesses to PCI controllers. \r
+/// and DMA interfaces used to abstract accesses to PCI controllers. \r
 /// There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus. \r
 /// A device driver that wishes to manage a PCI controller in a system will have to \r
 /// retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller. \r
index 970aee0..56999e0 100644 (file)
@@ -3,7 +3,7 @@
 \r
   PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O, \r
   and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform \r
-  defferent types of bus mastering DMA\r
+  defferent types of bus mastering DMA.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
@@ -205,7 +205,7 @@ EFI_STATUS
   );\r
 \r
 /**                                                                 \r
-  Provides the PCI controller-Cspecific addresses required to access system memory from a\r
+  Provides the PCI controller-specific addresses required to access system memory from a\r
   DMA bus master.                                                                        \r
             \r
   @param  This                  A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
index cbcdefc..d11f431 100644 (file)
@@ -65,7 +65,7 @@ EFI_STATUS
                                 exists.                                                          \r
   @param  DriverImagePath       On input, a pointer to the previous driver device path returned by\r
                                 GetDriverPath(). On output, a pointer to the next driver\r
-                                device path. Passing in a pointer to NULL, will return the first\r
+                                device path. Passing in a pointer to NULL will return the first\r
                                 driver device path for ControllerHandle.\r
                                 \r
   @retval EFI_SUCCESS           The driver override for ControllerHandle was returned in\r
index fff7688..4973553 100644 (file)
@@ -33,7 +33,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
   the platform about the ControllerHandle that is being started.\r
   Information returned from Query may lead to the drivers Start()\r
   function failing.\r
-  If the UEFI driver is a bus driver and producing a ChildHandle\r
+  If the UEFI driver is a bus driver and producing a ChildHandle,\r
   the driver must call Query after the child handle has been created\r
   and an EFI_DEVICE_PATH_PROTOCOL has been placed on that handle,\r
   but before any time consuming operation is performed. If information\r
@@ -57,7 +57,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
   @param ChildHandle          The handle of the child controller to\r
                               return information on. This is an optional\r
                               parameter that may be NULL. It will be\r
-                              NULL for device drivers, and for bus\r
+                              NULL for device drivers and for bus\r
                               drivers that attempt to get options for\r
                               the bus controller. It will not be NULL\r
                               for a bus driver that attempts to get\r
@@ -76,7 +76,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
                               should not attempt to free ParameterTypeGuid.\r
 \r
   @param ParameterBlock       The platform returns a pointer to the\r
-                              ParameterBlock structure which\r
+                              ParameterBlock structure, which\r
                               contains details about the\r
                               configuration parameters specific to\r
                               the ParameterTypeGuid. This structure\r
@@ -85,7 +85,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
                               protocols. UEFI driver decodes this\r
                               structure and its contents based on\r
                               ProtocolGuid. ParameterBlock is\r
-                              allocated by the platform and the\r
+                              allocated by the platform. The\r
                               platform is responsible for freeing\r
                               the ParameterBlock after Result is\r
                               called.\r
@@ -132,9 +132,9 @@ EFI_STATUS
 typedef enum {\r
   ///\r
   ///  The controller specified by ControllerHandle is still\r
-  ///  in a usable state, it's configuration has been updated\r
+  ///  in a usable state, and its configuration has been updated\r
   ///  via parsing the ParameterBlock. If required by the\r
-  ///  parameter block and the module supports an NVRAM store\r
+  ///  parameter block, and the module supports an NVRAM store,\r
   ///  the configuration information from PB was successfully\r
   ///  saved to the NVRAM. No actions are required before\r
   ///  this controller can be used again with the updated\r
@@ -144,7 +144,7 @@ typedef enum {
   \r
   ///\r
   ///  The driver has detected that the controller specified\r
-  ///  by ControllerHandle  is not in a usable state, and it\r
+  ///  by ControllerHandle is not in a usable state and \r
   ///  needs to be stopped. The calling agent can use the\r
   ///  DisconnectControservice to perform this operation, and\r
   ///  it should be performed as soon as possible.  \r
@@ -156,8 +156,8 @@ typedef enum {
   ///  be stopped and restarted before it can be used again.\r
   ///  The calling agent can use the DisconnectController()\r
   ///  and ConnectController() services to perform this\r
-  ///  operation. The restart operation can be delayed  until\r
-  ///  all of the configuratiooptions have been set.  \r
+  ///  operation. The restart operation can be delayed until\r
+  ///  all of the configuratiooptions have been set.  \r
   ///\r
   EfiPlatformConfigurationActionRestartController = 2,\r
   \r
@@ -199,7 +199,7 @@ typedef enum {
   ParameterBlock, and ParameterBlockSize. The UEFI driver may\r
   update values in ParameterBlock based on rules defined by\r
   ParameterTypeGuid. The platform is responsible for freeing\r
-  ParameterBlock and the UEFI driver must not try to free it\r
+  ParameterBlock and the UEFI driver must not try to free it.\r
 \r
   @param This               A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
 \r
@@ -225,7 +225,7 @@ typedef enum {
 \r
   @param ParameterBlockSize The ParameterBlock size returned from Query.\r
 \r
-  @param Configuration      ActionThe driver tells the platform what\r
+  @param ConfigurationAction      The driver tells the platform what\r
                             action is required for ParameterBlock to\r
                             take effect.\r
   \r
@@ -285,15 +285,15 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
   EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is platform\r
   firmware and the consumer is the UEFI driver. Note: if future\r
   versions of the DMTF SM CLP Specification require changes to the\r
-  parameter block definition, newer ParameterTypeGuid will be\r
+  parameter block definition, newer ParameterTypeGuid will be\r
   used.\r
 **/\r
 typedef struct {\r
   CHAR8   *CLPCommand;        ///<  A pointer to the DMTF SM CLP command line null-terminated string that the \r
-                              ///<  driver is required to parse and process when this EFI_SUCCESS The platform \r
+                              ///<  driver is required to parse and process. EFI_SUCCESS The platform \r
                               ///<  return parameter information for ControllerHandle. EFI_NOT_FOUND Instance \r
                               ///<  was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
-                              ///<  EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. \r
+                              ///<  EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. Function is called. \r
                               ///<  See the DMTF SM CLP Specification 1.0 Final Standard for details on the \r
                               ///<  format and syntax of the CLP command line string. CLPCommand buffer\r
                               ///<  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
index 3de3d28..6f4df05 100644 (file)
@@ -9,7 +9,7 @@
   EFI_REAL_TIME_CLOCK_ARCH_PROTOCOL_GUID protocol is registered with a NULL \r
   pointer.\r
 \r
-  No CRC of the EFI system table is required, as it is done in the DXE core.\r
+  No CRC of the EFI system table is required, since that is done in the DXE core.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index 2dfd320..c78ccd1 100644 (file)
@@ -113,8 +113,8 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
 struct _EFI_RUNTIME_ARCH_PROTOCOL {\r
   EFI_LIST_ENTRY          ImageHead;    ///< A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
   EFI_LIST_ENTRY          EventHead;    ///< A list of type EFI_RUNTIME_EVENT_ENTRY.\r
-  UINTN                   MemoryDescriptorSize;   ///< Size of a memory descriptor that is return by GetMemoryMap().\r
-  UINT32                  MemoryDesciptorVersion; ///< Version of a memory descriptor that is return by GetMemoryMap().\r
+  UINTN                   MemoryDescriptorSize;   ///< Size of a memory descriptor that is returned by GetMemoryMap().\r
+  UINT32                  MemoryDesciptorVersion; ///< Version of a memory descriptor that is returned by GetMemoryMap().\r
   UINTN                   MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
   EFI_MEMORY_DESCRIPTOR   *MemoryMapPhysical;     ///< Pointer to a runtime buffer that contains a copy of \r
                                                   ///< the memory map returned via GetMemoryMap().\r
index e0204cc..66cda35 100644 (file)
@@ -140,7 +140,7 @@ typedef struct {
   @param  DeviceType A pointer to the device type information\r
                      retrieved from the SCSI Controller.\r
 \r
-  @retval EFI_SUCCESS           Retrieves the device type information successfully.\r
+  @retval EFI_SUCCESS           Retrieved the device type information successfully.\r
   @retval EFI_INVALID_PARAMETER The DeviceType is NULL.\r
 \r
 **/\r
@@ -197,7 +197,7 @@ EFI_STATUS
   @param  This Protocol instance pointer.\r
 \r
   @retval EFI_SUCCESS      Reset the SCSI controller successfully.\r
-  @retval EFI_DEVICE_ERROR Errors are encountered when resetting the\r
+  @retval EFI_DEVICE_ERROR Errors were encountered when resetting the\r
                            SCSI Controller.\r
   @retval EFI_UNSUPPORTED  The SCSI bus does not support a device\r
                            reset operation.\r
@@ -218,7 +218,7 @@ EFI_STATUS
   @param  This    Protocol instance pointer.\r
   @param  Packet  The SCSI request packet to send to the SCSI\r
                   Controller specified by the device handle.\r
-  @param  Event   If the SCSI bus where the SCSI device is attached\r
+  @param  Event   If the SCSI bus to which the SCSI device is attached\r
                   does not support non-blocking I/O, then Event is\r
                   ignored, and blocking I/O is performed.\r
                   If Event is NULL, then blocking I/O is performed.\r
@@ -229,7 +229,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS               The SCSI Request Packet was sent by the host\r
                                     successfully, and TransferLength bytes were\r
-                                    transferred to/from DataBuffer.See\r
+                                    transferred to/from DataBuffer. See\r
                                     HostAdapterStatus, TargetStatus,\r
                                     SenseDataLength, and SenseData in that order\r
                                     for additional status information.\r
index 1790c1a..24b70aa 100644 (file)
@@ -171,8 +171,8 @@ typedef struct {
 \r
   @retval EFI_SUCCESS               The SCSI Request Packet was sent by the host, and\r
                                     TransferLength bytes were transferred to/from\r
-                                    DataBuffer.See HostAdapterStatus, TargetStatus,\r
-                                    SenseDataLength,and SenseData in that order\r
+                                    DataBuffer. See HostAdapterStatus, TargetStatus,\r
+                                    SenseDataLength, and SenseData in that order\r
                                     for additional status information.\r
   @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, but the\r
                                     entire DataBuffer could not be transferred.\r
@@ -223,7 +223,7 @@ EFI_STATUS
                  Target ID of the first SCSI device present on\r
                  a SCSI channel.\r
   @param  Lun    On input, a pointer to the LUN of a SCSI device\r
-                 present on the SCSI channel.On output, a pointer\r
+                 present on the SCSI channel. On output, a pointer\r
                  to the LUN of the next SCSI device present on a\r
                  SCSI channel.\r
 \r
@@ -360,7 +360,7 @@ EFI_STATUS
 \r
 ///\r
 /// The EFI_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel and\r
-/// the ability to send SCI Request Packets to any SCSI device attached to that SCSI channel. The\r
+/// the ability to send SCSI Request Packets to any SCSI device attached to that SCSI channel. The\r
 /// information includes the Target ID of the host controller on the SCSI channel, the attributes of\r
 /// the SCSI channel, the printable name for the SCSI controller, and the printable name of the\r
 /// SCSI channel.\r
index 7ec0dd9..176db59 100644 (file)
@@ -153,9 +153,9 @@ typedef struct {
   nonblocking I/O functionality is optional.                                                             \r
 \r
   @param  This    A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
-  @param  Target  The Target is an array of size TARGET_MAX_BYTES and it represents\r
-                  the id of the SCSI device to send the SCSI Request Packet. Each\r
-                  transport driver may chose to utilize a subset of this size to suit the needs\r
+  @param  Target  The Target is an array of size TARGET_MAX_BYTES. It represents\r
+                  the id of the SCSI device that will send the SCSI Request Packet. Each\r
+                  transport driver may choose to utilize a subset of this size to suit the needs\r
                   of transport target representation. For example, a Fibre Channel driver\r
                   may use only 8 bytes (WWN) to represent an FC target.\r
   @param  Lun     The LUN of the SCSI device to send the SCSI Request Packet.\r
@@ -201,7 +201,7 @@ EFI_STATUS
 /**\r
   Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These       \r
   can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal\r
-  Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the       \r
+  Target Ids and LUNs for the SCSI channel. Either way, the caller of this function must probe the       \r
   Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI    \r
   channel.                                                                                               \r
 \r
@@ -317,7 +317,7 @@ EFI_STATUS
   Resets a SCSI logical unit that is connected to a SCSI channel.\r
 \r
   @param  This   A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
-  @param  Target The Target is an array of size TARGET_MAX_BYTE and it represents the\r
+  @param  Target The Target is an array of size TARGET_MAX_BYTE. It represents the\r
                  target port ID of the SCSI device containing the SCSI logical unit to\r
                  reset. Transport drivers may chose to utilize a subset of this array to suit\r
                  the representation of their targets.\r
@@ -357,7 +357,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The Target ID of the next SCSI device on the SCSI\r
                                 channel was returned in Target.\r
   @retval EFI_INVALID_PARAMETER Target or Lun is NULL.\r
-  @retval EFI_TIMEOUT           Target array is not all 0xF, and Target were not\r
+  @retval EFI_TIMEOUT           Target array is not all 0xF, and Target was not\r
                                 returned on a previous call to GetNextTarget().\r
   @retval EFI_NOT_FOUND         There are no more SCSI devices on this SCSI channel.\r
 \r
index 32415ca..4fbfe02 100644 (file)
@@ -104,15 +104,20 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \r
-  data buts, and stop bits on a serial device.\r
+  Sets the following attributes for a serial device:\r
+  * baud rate\r
+  * receive FIFO depth\r
+  * transmit/receive time out\r
+  * parity \r
+  * data bits\r
+  * stop bits\r
 \r
   @param  This             Protocol instance pointer.\r
-  @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the the\r
+  @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the\r
                            device's default interface speed.\r
   @param  ReveiveFifoDepth The requested depth of the FIFO on the receive side of the\r
                            serial interface. A ReceiveFifoDepth value of 0 will use\r
-                           the device's dfault FIFO depth.\r
+                           the device's default FIFO depth.\r
   @param  Timeout          The requested time out for a single character in microseconds.\r
                            This timeout applies to both the transmit and receive side of the\r
                            interface. A Timeout value of 0 will use the device's default time\r
@@ -203,7 +208,7 @@ EFI_STATUS
   @param  This              Protocol instance pointer.\r
   @param  BufferSize        On input, the size of the Buffer. On output, the amount of\r
                             data returned in Buffer.\r
-  @param  Buffer            The buffer to return the data into.\r
+  @param  Buffer            The buffer to which to return the data.\r
 \r
   @retval EFI_SUCCESS       The data was read.\r
   @retval EFI_DEVICE_ERROR  The device reported an error.\r
@@ -224,7 +229,7 @@ EFI_STATUS
   that produces the SERIAL_IO_PROTOCOL member functions.\r
 \r
   @param ControlMask\r
-  A mask fo the Control bits that the device supports. The device\r
+  A mask for the Control bits that the device supports. The device\r
   must always support the Input Buffer Empty control bit.\r
   \r
   @param TimeOut\r
@@ -272,13 +277,13 @@ typedef struct {
 \r
 ///\r
 /// The Serial I/O protocol is used to communicate with UART-style serial devices. \r
-/// These can be standard UART serial ports in PC-AT systems, serial ports attached \r
-/// to a USB interface, or potentially any character-based I/O device.\r
+/// These can be standard UART serial ports in PC-AT systems, or serial ports attached \r
+/// to a USB interface or any character-based I/O device.\r
 ///\r
 struct _EFI_SERIAL_IO_PROTOCOL {\r
   ///\r
   /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions \r
-  /// must be backwards compatible. If a future version is not back wards compatible, \r
+  /// must be backwards compatible. If a future version is not backwards compatible, \r
   /// it is not the same GUID.\r
   ///\r
   UINT32                      Revision;\r
index ddfbebb..0733235 100644 (file)
@@ -1,11 +1,11 @@
 /** @file\r
   SimpleFileSystem protocol as defined in the UEFI 2.0 specification.\r
 \r
-  The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r
+  The SimpleFileSystem protocol is the programmatic access to the FAT (12,16,32) \r
   file system specified in UEFI 2.0. It can also be used to abstract a file  \r
   system other than FAT.\r
 \r
-  UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem\r
+  UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
@@ -181,11 +181,11 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Write data from to the file.\r
+  Write data from or to the file.\r
 \r
   @param  This       Protocol instance pointer.\r
-  @param  BufferSize On input size of buffer, on output amount of data in buffer.\r
-  @param  Buffer     The buffer in which data to write.\r
+  @param  BufferSize On input: size of buffer. On output: amount of data in buffer.\r
+  @param  Buffer     The buffer in which to write data.\r
 \r
   @retval EFI_SUCCESS          Data was written.\r
   @retval EFI_UNSUPPORT        Writes to Open directory are not supported\r
@@ -209,7 +209,7 @@ EFI_STATUS
   Set a files current position\r
 \r
   @param  This            Protocol instance pointer.\r
-  @param  Position        Byte possition from the start of the file\r
+  @param  Position        Byte position, from the start of the file\r
                           \r
   @retval EFI_SUCCESS     Data was written.\r
   @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
@@ -223,10 +223,10 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Get a files current position\r
+  Get a file's current position\r
 \r
   @param  This            Protocol instance pointer.\r
-  @param  Position        Byte possition from the start of the file\r
+  @param  Position        Byte position, from the start of the file\r
                           \r
   @retval EFI_SUCCESS     Data was written.\r
   @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
@@ -244,7 +244,7 @@ EFI_STATUS
 \r
   @param  This            Protocol instance pointer.\r
   @param  InformationType Type of info to return in Buffer\r
-  @param  BufferSize      On input size of buffer, on output amount of data in buffer.\r
+  @param  BufferSize      On input: size of buffer. On output: amount of data in buffer.\r
   @param  Buffer          The buffer to return data.\r
 \r
   @retval EFI_SUCCESS          Data was returned.\r
index 1d9cc67..242e84d 100644 (file)
@@ -284,7 +284,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The network interface was initialized.\r
   @retval EFI_NOT_STARTED       The network interface has not been started\r
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory for the transmit and\r
-                                receive buffers.   .\r
+                                receive buffers.\r
   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.\r
   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.\r
index 9b5fb31..44d640c 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Simple Pointer protocol from the UEFI 2.0 specification.\r
 \r
-  Abstraction of a very simple pointer device like a mice or tracekballs.\r
+  Abstraction of a very simple pointer device like a mouse or trackball.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index 430ec60..df5e6fd 100644 (file)
@@ -58,8 +58,8 @@ EFI_STATUS
 \r
 \r
 ///\r
-/// EFI_KEY_TOGGLE_STATE. The toggle state are defined.\r
-/// They are EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE\r
+/// EFI_KEY_TOGGLE_STATE. The toggle states are defined.\r
+/// They are: EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE\r
 /// EFI_NUM_LOCK_ACTIVE, EFI_CAPS_LOCK_ACTIVE\r
 ///\r
 typedef UINT8 EFI_KEY_TOGGLE_STATE;\r
@@ -149,29 +149,28 @@ typedef struct {
   there is no pending keystroke the function returns\r
   EFI_NOT_READY. If there is a pending keystroke, then\r
   KeyData.Key.ScanCode is the EFI scan code defined in Error!\r
-  Reference source not found.. The KeyData.Key.UnicodeChar is the\r
-  actual printable character or is zero if the key does not\r
+  Reference source not found. The KeyData.Key.UnicodeChar is the\r
+  actual printable character, or is zero if the key does not\r
   represent a printable character (control key, function key,\r
   etc.). The KeyData.KeyState is shift state for the character\r
   reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode .\r
-  When interpreting the data from this function, it should be\r
-  noted that if a class of printable characters that are\r
+  When interpreting the data from this function, printable characters that are\r
   normally adjusted by shift modifiers (e.g. Shift Key + "f"\r
-  key) would be presented solely as a KeyData.Key.UnicodeChar\r
-  without the associated shift state. So in the previous example\r
-  of a Shift Key + "f" key being pressed, the only pertinent\r
+  key) are presented solely as a KeyData.Key.UnicodeChar\r
+  without the associated shift state. For example,\r
+  if Shift Key + "f" key are pressed, the only pertinent\r
   data returned would be KeyData.Key.UnicodeChar with the value\r
-  of "F". This of course would not typically be the case for\r
-  non-printable characters such as the pressing of the Right\r
-  Shift Key + F10 key since the corresponding returned data\r
+  of "F". This would not typically be the case for\r
+  non-printable characters such as pressing the Right\r
+  Shift Key + F10 key, since the corresponding returned data\r
   would be reflected both in the KeyData.KeyState.KeyShiftState\r
   and KeyData.Key.ScanCode values. UEFI drivers which implement\r
   the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return\r
   KeyData.Key and KeyData.KeyState values. These drivers must\r
   always return the most current state of\r
   KeyData.KeyState.KeyShiftState and\r
-  KeyData.KeyState.KeyToggleState. It should also be noted that\r
-  certain input devices may not be able to produce shift or toggle\r
+  KeyData.KeyState.KeyToggleState. \r
+  Certain input devices may not be able to produce shift or toggle\r
   state information, and in those cases the high order bit in the\r
   respective Toggle and Shift state fields should not be active.\r
 \r
@@ -238,7 +237,7 @@ EFI_STATUS
 \r
 /**\r
   The RegisterKeystrokeNotify() function registers a function\r
-  which will be called when a specified keystroke will occur.\r
+  to be called when a specified keystroke will occur.\r
   \r
   @param This                     A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
   \r
@@ -271,8 +270,8 @@ EFI_STATUS
 );\r
 \r
 /**\r
-  The UnregisterKeystrokeNotify() function removes the\r
-  notification which was previously registered.\r
+  The UnregisterKeystrokeNotify() function removes a\r
+  notification that was previously registered.\r
   \r
   @param This               A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
   \r
index a55b407..3a74416 100644 (file)
@@ -3,7 +3,7 @@
 \r
   Abstraction of a very simple text based output device like VGA text mode or\r
   a serial terminal. The Simple Text Out protocol instance can represent\r
-  a single hardware device or a virtual device that is an agregation\r
+  a single hardware device or a virtual device that is an aggregation\r
   of multiple physical devices.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
@@ -137,11 +137,11 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 \r
 //\r
 // We currently define attributes from 0 - 7F for color manipulations\r
-// To internally handle the local display characteristics for a particular character, we are defining\r
-// Bit 7 to signify the local glyph representation for a character.  If turned on, glyphs will be\r
+// To internally handle the local display characteristics for a particular character, \r
+// Bit 7 signifies the local glyph representation for a character.  If turned on, glyphs will be\r
 // pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19)\r
 // If bit 7 is off, the narrow glyph database will be used.  This does NOT affect information that is sent to\r
-// non-local displays (e.g. serial or LAN consoles).\r
+// non-local displays, such as serial or LAN consoles.\r
 //\r
 #define EFI_WIDE_ATTRIBUTE  0x80\r
 \r
@@ -263,7 +263,7 @@ EFI_STATUS
                     and must be zero. The valid Attributes are defined in this file.\r
 \r
   @retval EFI_SUCCESS     The attribute was set.\r
-  @retval EFI_DEVICE_     ERROR The device had an error and could not complete the request.\r
+  @retval EFI_DEVICE_ERROR  The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED The attribute requested is not defined.\r
 \r
 **/\r
index 5431c49..f03b6b6 100644 (file)
@@ -51,8 +51,8 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
                   EFI_SMBUS_DEVICE_COMMAND is defined in\r
                   EFI_PEI_SMBUS_PPI.Execute() in the Platform\r
                   Initialization SMBus PPI Specification.\r
                 Operation Signifies which particular SMBus\r
-                  hardware protocol instance that it will use to\r
@param Operation Signifies the particular SMBus\r
+                  hardware protocol instance it will use to\r
                   execute the SMBus transactions. This SMBus\r
                   hardware protocol is defined by the SMBus\r
                   Specification and is not related to PI\r
@@ -64,8 +64,9 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
   @param PecCheck Defines if Packet Error Code (PEC) checking\r
                   is required for this operation. SMBus Host\r
                   Controller Code Definitions Version 1.0\r
-                  August 21, 2006 13 Length Signifies the\r
-                  number of bytes that this operation will do.\r
+                  August 21, 2006 13 \r
+                  \r
+ @param Length    Signifies the number of bytes that this operation will do.\r
                   The maximum number of bytes can be revision\r
                   specific and operation specific. This field\r
                   will contain the actual number of bytes that\r
@@ -248,10 +249,10 @@ EFI_STATUS
   @param  This            A pointer to the EFI_SMBUS_HC_PROTOCOL instance.\r
   \r
   @param  SlaveAddress    Address that the host controller detects\r
-                          as sending a message and calls all the registered function.\r
+                          as sending a message, and that calls all the registered function.\r
 \r
   @param  Data            Data that the host controller detects as sending\r
-                          message and calls all the registered function.\r
+                          message, and that calls all the registered function.\r
 \r
 \r
   @param  NotifyFunction  The function to call when the bus\r
index 25c1f0d..a0e8145 100644 (file)
@@ -5,7 +5,7 @@
   EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL \r
   pointer.\r
 \r
-  No CRC of the EFI system table is required, as it is done in the DXE core.\r
+  No CRC of the EFI system table is required, since that is done in the DXE core.\r
 \r
   This code abstracts Status Code reporting.\r
 \r
index d750fe9..544236b 100644 (file)
@@ -279,7 +279,7 @@ EFI_STATUS
                                 - This is NULL.\r
                                 - ConnectionToken is NULL.\r
                                 - ConnectionToken->CompletionToken.Event is NULL.\r
-  @retval EFI_OUT_OF_RESOURCES  The driver can't allocate enough resource to initiate the activeopen.\r
+  @retval EFI_OUT_OF_RESOURCES  The driver can't allocate enough resources to initiate the activeopen.\r
   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
 \r
 **/\r
@@ -308,8 +308,8 @@ EFI_STATUS
                                 - This is NULL.\r
                                 - ListenToken is NULL.\r
                                 - ListentToken->CompletionToken.Event is NULL.\r
-  @retval EFI_OUT_OF_RESOURCES  Could not allocate enough resource to finish the operation.\r
-  @retval EFI_DEVICE_ERROR      Any unexpected and not belonged to above category error.\r
+  @retval EFI_OUT_OF_RESOURCES  Could not allocate enough resources to finish the operation.\r
+  @retval EFI_DEVICE_ERROR      Any unexpected error not covered by another error.\r
 \r
 **/\r
 typedef\r
@@ -389,7 +389,7 @@ EFI_STATUS
                                Tcp4StateListen state.\r
                                - User has called Close() to disconnect this connection.\r
   @retval EFI_CONNECTION_FIN   The communication peer has closed the connection and there is\r
-                               no any buffered data in the receive buffer of this instance.\r
+                               no buffered data in the receive buffer of this instance.\r
   @retval EFI_NOT_READY        The receive request could not be queued because the receive queue is full.\r
 \r
 **/\r
@@ -419,8 +419,8 @@ EFI_STATUS
                                 - This is NULL.\r
                                 - CloseToken is NULL.\r
                                 - CloseToken->CompletionToken.Event is NULL.\r
-  @retval EFI_OUT_OF_RESOURCES  Could not allocate enough resource to finish the operation.\r
-  @retval EFI_DEVICE_ERROR      Any unexpected and not belonged to above category error.\r
+  @retval EFI_OUT_OF_RESOURCES  Could not allocate enough resources to finish the operation.\r
+  @retval EFI_DEVICE_ERROR      Any unexpected error not covered by another error.\r
 \r
 **/\r
 typedef\r
index 0c4d54d..e58fb56 100644 (file)
@@ -88,7 +88,7 @@ typedef struct {
 \r
 \r
 /**\r
-  Dynamically allocate storage for a child UGA_DEVICE .\r
+  Dynamically allocate storage for a child UGA_DEVICE.\r
 \r
   @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. \r
   @param[in]     ParentDevice    ParentDevice specifies a pointer to the parent device of Device.\r
@@ -116,7 +116,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() .\r
+  Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice().\r
 \r
   @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
                                  defined in Section 10.7.\r
index 2727862..efe8987 100644 (file)
@@ -108,8 +108,7 @@ EFI_STATUS
                            will wait before the watchdog timer is fired. If TimerPeriod of\r
                            zero is returned, then the watchdog timer is disabled.\r
 \r
-  @retval EFI_SUCCESS           The amount of time that the system will wait before\r
-                                firing the watchdog timer was returned in TimerPeriod.\r
+  @retval EFI_SUCCESS           The function successfully returned TimerPeriod with the amount of time that the system will wait                                                                                                                       before firing the watchdog timer.\r
   @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
 \r
 **/\r