diff options
| author | pkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-06-04 05:49:29 +0000 |
|---|---|---|
| committer | pkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-06-04 05:49:29 +0000 |
| commit | 630b41877e9a1afe59d4f8a1c22bc691fe933ff8 (patch) | |
| tree | fe787e60e04dc70dd307ca64fa0e89c02565752d /MdePkg/Include | |
| parent | e79a2975adf4a1a6ae8a26db0bf2143b462b9fd9 (diff) | |
| download | edk2-630b41877e9a1afe59d4f8a1c22bc691fe933ff8.tar.gz edk2-630b41877e9a1afe59d4f8a1c22bc691fe933ff8.tar.bz2 edk2-630b41877e9a1afe59d4f8a1c22bc691fe933ff8.zip | |
Reviewed the code comments in the Include/Protocol directory for typos, grammar issues, and language clarity.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8462 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include')
55 files changed, 219 insertions, 218 deletions
diff --git a/MdePkg/Include/Protocol/AbsolutePointer.h b/MdePkg/Include/Protocol/AbsolutePointer.h index 29947edb9a..5e18bf878a 100644 --- a/MdePkg/Include/Protocol/AbsolutePointer.h +++ b/MdePkg/Include/Protocol/AbsolutePointer.h @@ -1,5 +1,5 @@ /** @file
- The file provides services that allow information about a
+ The file provides services that allow information about an
absolute pointer device to be retrieved.
Copyright (c) 2006 - 2008, Intel Corporation
@@ -108,7 +108,7 @@ EFI_STATUS **/
typedef struct {
///
- /// The unsigned position of the activation on the x axis If the AboluteMinX
+ /// The unsigned position of the activation on the x axis. If the AboluteMinX
/// and the AboluteMaxX fields of the EFI_ABSOLUTE_POINTER_MODE structure are
/// both 0, then this pointer device does not support an x-axis, and this field
/// must be ignored.
@@ -116,7 +116,7 @@ typedef struct { UINT64 CurrentX;
///
- /// The unsigned position of the activation on the x axis If the AboluteMinY
+ /// The unsigned position of the activation on the x axis. If the AboluteMinY
/// and the AboluteMaxY fields of the EFI_ABSOLUTE_POINTER_MODE structure are
/// both 0, then this pointer device does not support an y-axis, and this field
/// must be ignored.
@@ -180,10 +180,9 @@ EFI_STATUS /// The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services
/// for a pointer device that can be used as an input device from an
/// application written to this specification. The services include
-/// the ability to reset the pointer device, retrieve the state of
+/// the ability to: reset the pointer device, retrieve the state of
/// the pointer device, and retrieve the capabilities of the pointer
-/// device. In addition certain data items describing the device are
-/// provided.
+/// device. The service also provides certain data items describing the device.
///
struct _EFI_ABSOLUTE_POINTER_PROTOCOL {
EFI_ABSOLUTE_POINTER_RESET Reset;
diff --git a/MdePkg/Include/Protocol/Arp.h b/MdePkg/Include/Protocol/Arp.h index bd7f7d2a5f..1f213862f7 100644 --- a/MdePkg/Include/Protocol/Arp.h +++ b/MdePkg/Include/Protocol/Arp.h @@ -131,9 +131,9 @@ typedef struct { @retval EFI_SUCCESS The new station address was successfully
registered.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- This is NULL. SwAddressLength is zero when
- ConfigData is not NULL. StationAddress is NULL
- when ConfigData is not NULL.
+ * This is NULL.
+ * SwAddressLength is zero when ConfigData is not NULL.
+ * StationAddress is NULL when ConfigData is not NULL.
@retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or
StationAddress is different from the one that is
already registered.
@@ -181,11 +181,11 @@ EFI_STATUS @retval EFI_SUCCESS The entry has been added or updated.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- This is NULL. DenyFlag is FALSE and
- TargetHwAddress is NULL. DenyFlag is FALSE and
- TargetSwAddress is NULL. TargetHwAddress is NULL
- and TargetSwAddress is NULL. Both TargetSwAddress
- and TargetHwAddress are not NULL when DenyFlag is
+ * This is NULL.
+ * DenyFlag is FALSE and TargetHwAddress is NULL.
+ * DenyFlag is FALSE and TargetSwAddress is NULL.
+ * TargetHwAddress is NULL and TargetSwAddress is NULL.
+ * Neither TargetSwAddress nor TargetHwAddress are NULL when DenyFlag is
TRUE.
@retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated.
@retval EFI_ACCESS_DENIED The ARP cache entry already exists and Overwrite
@@ -326,7 +326,7 @@ EFI_STATUS );
/**
- This function aborts the previous ARP request (identified by This, TargetSwAddress
+ This function aborts the previous ARP request (identified by This, TargetSwAddress
and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request().
If the request is in the internal ARP request queue, the request is aborted
diff --git a/MdePkg/Include/Protocol/AuthenticationInfo.h b/MdePkg/Include/Protocol/AuthenticationInfo.h index 8f62bc99cf..b520327834 100644 --- a/MdePkg/Include/Protocol/AuthenticationInfo.h +++ b/MdePkg/Include/Protocol/AuthenticationInfo.h @@ -145,14 +145,14 @@ typedef struct { } CHAP_LOCAL_AUTH_NODE;
/**
- Retrieves the Authentication information associated with a particular controller handle.
+ Retrieves the authentication information associated with a particular controller handle.
@param This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL
@param ControllerHandle Handle to the Controller
@param Buffer Pointer to the authentication information.
- @retval EFI_SUCCESS Successfully retrieved Authentication information for the given ControllerHandle
- @retval EFI_INVALID_PARAMETER No matching Authentication information found for the given ControllerHandle
+ @retval EFI_SUCCESS Successfully retrieved authentication information for the given ControllerHandle
+ @retval EFI_INVALID_PARAMETER No matching authentication information found for the given ControllerHandle
@retval EFI_DEVICE_ERROR The authentication information could not be retrieved due to a
hardware error.
@@ -166,14 +166,14 @@ EFI_STATUS );
/**
- Set the Authentication information for a given controller handle.
+ Set the authentication information for a given controller handle.
@param This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL
@param ControllerHandle Handle to the Controller
@param Buffer Pointer to the authentication information.
- @retval EFI_SUCCESS Successfully set Authentication information for the given ControllerHandle
- @retval EFI_UNSUPPORTED If the platform policies do not allow setting of the Authentication
+ @retval EFI_SUCCESS Successfully set authentication information for the given ControllerHandle
+ @retval EFI_UNSUPPORTED If the platform policies do not allow setting of the authentication
information.
@retval EFI_DEVICE_ERROR The authentication information could not be configured due to a
hardware error.
diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h index 3a8ab092bb..bff4812731 100644 --- a/MdePkg/Include/Protocol/Bis.h +++ b/MdePkg/Include/Protocol/Bis.h @@ -115,7 +115,7 @@ typedef struct { #define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data)
///
-/// Support old name for backward compatible
+/// Support old name for backward compatibility
///
#define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \
BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID
@@ -146,11 +146,11 @@ typedef struct { TargetAddress.Data was any other value that was not
supported by the implementation.
@retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources.
- @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while
- initializing a cryptographic software module, or
- No cryptographic software module with compatible version was
- found, or A resource limitation was encountered while using a
- cryptographic software module.
+ @retval EFI_DEVICE_ERROR One of the following device errors:
+ * The function encountered an unexpected internal failure while initializing a cryptographic software module
+ * No cryptographic software module with compatible version was found
+ found
+ * A resource limitation was encountered while using a cryptographic software module.
@retval EFI_INVALID_PARAMETER The This parameter supplied by the caller is NULL or does not
reference a valid EFI_BIS_PROTOCOL object, or
The AppHandle parameter supplied by the caller is NULL or
diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h index 1f0f5f1749..f7f2871375 100644 --- a/MdePkg/Include/Protocol/ComponentName.h +++ b/MdePkg/Include/Protocol/ComponentName.h @@ -1,6 +1,6 @@ /** @file
EFI Component Name Protocol as defined in the EFI 1.1 specification.
- This protocol is used to retrieve user readable names of EFI Drivers
+ This protocol is used to retrieve user-readable names of EFI Drivers
and controllers managed by EFI Drivers.
Copyright (c) 2006 - 2008, Intel Corporation
@@ -29,7 +29,7 @@ typedef struct _EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL; /**
- Retrieves a Unicode string that is the user readable name of the EFI Driver.
+ Retrieves a Unicode string that is the user-readable name of the EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language A pointer to a three character ISO 639-2 language identifier.
diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h index 2dfdf2f2b2..45b2a8a881 100644 --- a/MdePkg/Include/Protocol/ComponentName2.h +++ b/MdePkg/Include/Protocol/ComponentName2.h @@ -27,7 +27,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL; /**
- Retrieves a Unicode string that is the user readable name of
+ Retrieves a Unicode string that is the user-readable name of
the EFI Driver.
@param This A pointer to the
@@ -87,7 +87,7 @@ EFI_STATUS retrieve the name of. This is an
optional parameter that may be NULL.
It will be NULL for device drivers.
- It will also be NULL for a bus
+ It will also be NULL for bus
drivers that wish to retrieve the
name of the bus controller. It will
not be NULL for a bus driver that
diff --git a/MdePkg/Include/Protocol/DebugSupport.h b/MdePkg/Include/Protocol/DebugSupport.h index 8f9ea4831c..843c829354 100644 --- a/MdePkg/Include/Protocol/DebugSupport.h +++ b/MdePkg/Include/Protocol/DebugSupport.h @@ -285,7 +285,7 @@ typedef struct { typedef struct {
//
// The first reserved field is necessary to preserve alignment for the correct
- // bits in UNAT and to insure F2 is 16 byte aligned..
+ // bits in UNAT and to insure F2 is 16 byte aligned.
//
UINT64 Reserved;
UINT64 R1;
diff --git a/MdePkg/Include/Protocol/Decompress.h b/MdePkg/Include/Protocol/Decompress.h index ed1e4220e1..ae3bf946da 100644 --- a/MdePkg/Include/Protocol/Decompress.h +++ b/MdePkg/Include/Protocol/Decompress.h @@ -32,7 +32,7 @@ typedef struct _EFI_DECOMPRESS_PROTOCOL EFI_DECOMPRESS_PROTOCOL; buffer is returned in DestinationSize, the size of the scratch buffer is
returned in ScratchSize, and EFI_SUCCESS is returned.
- The GetInfo() function does not have scratch buffer available to perform
+ The GetInfo() function does not have a scratch buffer available to perform
a thorough checking of the validity of the source data. It just retrieves
the 'Original Size' field from the beginning bytes of the source data and
output it as DestinationSize. And ScratchSize is specific to the decompression
diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h index 24939d8aa8..ea3949cada 100644 --- a/MdePkg/Include/Protocol/DeviceIo.h +++ b/MdePkg/Include/Protocol/DeviceIo.h @@ -134,7 +134,7 @@ typedef enum { @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
@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.
+ @param NumberOfBytes On input, the number of bytes to map.
@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/DevicePath.h b/MdePkg/Include/Protocol/DevicePath.h index a699eaff80..8a6f339c16 100644 --- a/MdePkg/Include/Protocol/DevicePath.h +++ b/MdePkg/Include/Protocol/DevicePath.h @@ -1,8 +1,8 @@ /** @file
The device path protocol as defined in UEFI 2.0.
- The device path represents a programatic path to a device. It's the view
- from a software point of view. It also must persist from boot to boot, so
+ The device path represents a programmatic path to a device,
+ from a software point of view. The path must persist from boot to boot, so
it can not contain things like PCI bus numbers that change from boot to boot.
Copyright (c) 2006 - 2009, Intel Corporation
diff --git a/MdePkg/Include/Protocol/Dhcp4.h b/MdePkg/Include/Protocol/Dhcp4.h index dd536e3b59..69ec7792c3 100644 --- a/MdePkg/Include/Protocol/Dhcp4.h +++ b/MdePkg/Include/Protocol/Dhcp4.h @@ -720,7 +720,7 @@ EFI_STATUS If *OptionCount isn't zero, and there is enough space for all the DHCP options
in the Packet, each element of PacketOptionList is set to point to somewhere in
the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported,
- the caller should reassemble the parsed DHCP options to get the finial result.
+ the caller should reassemble the parsed DHCP options to get the final result.
If *OptionCount is zero or there isn't enough space for all of them, the number
of DHCP options in the Packet is returned in OptionCount.
diff --git a/MdePkg/Include/Protocol/DriverConfiguration.h b/MdePkg/Include/Protocol/DriverConfiguration.h index f02c5321d7..00da549911 100644 --- a/MdePkg/Include/Protocol/DriverConfiguration.h +++ b/MdePkg/Include/Protocol/DriverConfiguration.h @@ -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.
@param ChildHandle The handle of the child controller to set options on. This
is an optional parameter that may be NULL. It will be NULL
- for device drivers, and for a bus drivers that wish to set
+ for device drivers, and for bus drivers that wish to set
options for the bus controller. It will not be NULL for a
bus driver that wishes to set options for one of its child
controllers.
@@ -88,7 +88,7 @@ EFI_STATUS @param ChildHandle The handle of the child controller to test if it's current
configuration options are valid. This is an optional
parameter that may be NULL. It will be NULL for device
- drivers. It will also be NULL for a bus drivers that wish
+ drivers. It will also be NULL for bus drivers that wish
to test the configuration options for the bus controller.
It will not be NULL for a bus driver that wishes to test
configuration options for one of its child controllers.
@@ -121,9 +121,9 @@ EFI_STATUS @param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.
@param ControllerHandle The handle of the controller to force default configuration options on.
- @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 a 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.
+ @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.
@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.
- @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.
+ @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.
@retval EFI_SUCCESS The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
diff --git a/MdePkg/Include/Protocol/DriverConfiguration2.h b/MdePkg/Include/Protocol/DriverConfiguration2.h index fc12fc8697..2d2828622e 100644 --- a/MdePkg/Include/Protocol/DriverConfiguration2.h +++ b/MdePkg/Include/Protocol/DriverConfiguration2.h @@ -62,7 +62,7 @@ typedef enum { @param ControllerHandle The handle of the controller to set options on.
@param ChildHandle The handle of the child controller to set options on. This
is an optional parameter that may be NULL. It will be NULL
- for device drivers, and for a bus drivers that wish to set
+ for device drivers, and for bus drivers that wish to set
options for the bus controller. It will not be NULL for a
bus driver that wishes to set options for one of its child
controllers.
@@ -78,7 +78,7 @@ typedef enum { @retval EFI_SUCCESS The driver specified by This successfully set the
configuration options for the controller specified
- by ControllerHandle..
+ by ControllerHandle.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ActionRequired is NULL.
@@ -87,7 +87,7 @@ typedef enum { ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
language specified by Language.
- @retval EFI_DEVICE_ERROR A device error occurred while attempt to set the
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
@retval EFI_OUT_RESOURCES There are not enough resources available to set the
@@ -114,7 +114,7 @@ EFI_STATUS @param ChildHandle The handle of the child controller to test if it's current
configuration options are valid. This is an optional
parameter that may be NULL. It will be NULL for device
- drivers. It will also be NULL for a bus drivers that wish
+ drivers. It will also be NULL for bus drivers that wish
to test the configuration options for the bus controller.
It will not be NULL for a bus driver that wishes to test
configuration options for one of its child controllers.
@@ -147,9 +147,9 @@ EFI_STATUS @param This A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.
@param ControllerHandle The handle of the controller to force default configuration options on.
- @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 a 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.
+ @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.
@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.
- @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.
+ @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.
@retval EFI_SUCCESS The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
diff --git a/MdePkg/Include/Protocol/DriverDiagnostics2.h b/MdePkg/Include/Protocol/DriverDiagnostics2.h index 05312232c6..adba0f7554 100644 --- a/MdePkg/Include/Protocol/DriverDiagnostics2.h +++ b/MdePkg/Include/Protocol/DriverDiagnostics2.h @@ -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.
@param ChildHandle The handle of the child controller to run diagnostics on
This is an optional parameter that may be NULL. It will
- be NULL for device drivers. It will also be NULL for a
+ be NULL for device drivers. It will also be NULL for
bus drivers that wish to run diagnostics on the bus
controller. It will not be NULL for a bus driver that
wishes to run diagnostics on one of its child controllers.
- @param DiagnosticType Indicates type of diagnostics to perform on the controller
+ @param DiagnosticType Indicates the type of diagnostics to perform on the controller
specified by ControllerHandle and ChildHandle. See
"Related Definitions" for the list of supported types.
@param Language A pointer to a Null-terminated ASCII string
diff --git a/MdePkg/Include/Protocol/DriverFamilyOverride.h b/MdePkg/Include/Protocol/DriverFamilyOverride.h index 92fc1d9bdd..b0b35f0cbc 100644 --- a/MdePkg/Include/Protocol/DriverFamilyOverride.h +++ b/MdePkg/Include/Protocol/DriverFamilyOverride.h @@ -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()
to sort the set of Driver Binding Protocols in order from highest priority to lowest priority.
For drivers that support the Driver Family Override Protocol, those drivers are sorted so that
- the drivers with higher values returned by GetVersion() are high priority that drivers that
+ the drivers with higher values returned by GetVersion() are higher priority than drivers that
return lower values from GetVersion().
@param This A pointer to the EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL instance.
diff --git a/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h b/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h index d465a3a2f6..dc72ecb756 100644 --- a/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h +++ b/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h @@ -1,7 +1,7 @@ /** @file
The protocol provides information about the version of the EFI
specification that a driver is following. This protocol is
- required for EFI drivers that are on PCI and other plug in
+ required for EFI drivers that are on PCI and other plug-in
cards.
Copyright (c) 2006 - 2008, Intel Corporation
@@ -26,13 +26,13 @@ /// The EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL provides a
/// mechanism for an EFI driver to publish the version of the EFI
/// specification it conforms to. This protocol must be placed on
-/// the drivers image handle when the driver's entry point is
+/// the driver's image handle when the driver's entry point is
/// called.
///
typedef struct _EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL {
///
/// The size, in bytes, of the entire structure. Future versions of this
- /// specification may grow the size of the structure.
+ /// specification may increase the size of the structure.
///
UINT32 Length;
///
diff --git a/MdePkg/Include/Protocol/Ebc.h b/MdePkg/Include/Protocol/Ebc.h index a516f5439e..13ece4a227 100644 --- a/MdePkg/Include/Protocol/Ebc.h +++ b/MdePkg/Include/Protocol/Ebc.h @@ -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.
A PE32+ EBC image, like any other PE32+ image, contains an optional header that specifies the
- entry point for image execution. However for EBC images this is the entry point of EBC
- instructions, so is not directly executable by the native processor. Therefore when an EBC image is
- loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed
+ entry point for image execution. However, for EBC images, this is the entry point of EBC
+ instructions, so is not directly executable by the native processor. Therefore, when an EBC image is
+ loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed,
which will invoke the interpreter to begin execution at the original EBC entry point.
@param This A pointer to the EFI_EBC_PROTOCOL instance.
@param ImageHandle Handle of image for which the thunk is being created.
@param EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.
- @param Thunk Returned pointer to a thunk created.
+ @param Thunk Returned pointer to a created thunk.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Image entry point is not 2-byte aligned.
@@ -119,7 +119,7 @@ EFI_STATUS returned version is identical to that returned by the EBC BREAK 1 instruction.
@param This A pointer to the EFI_EBC_PROTOCOL instance.
- @param Version Pointer to where to store the returned version of the interpreter.
+ @param Version Pointer to the location to store the returned version of the interpreter.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Version pointer is NULL.
diff --git a/MdePkg/Include/Protocol/EdidActive.h b/MdePkg/Include/Protocol/EdidActive.h index 81299a3d27..4e199db3cd 100644 --- a/MdePkg/Include/Protocol/EdidActive.h +++ b/MdePkg/Include/Protocol/EdidActive.h @@ -1,7 +1,7 @@ /** @file
EDID Active Protocol from the UEFI 2.0 specification.
- Placed on the video output device child handle that are actively displaying output.
+ Placed on the video output device child handle that is actively displaying output.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Protocol/EdidDiscovered.h b/MdePkg/Include/Protocol/EdidDiscovered.h index dedefa0762..6ebe20778b 100644 --- a/MdePkg/Include/Protocol/EdidDiscovered.h +++ b/MdePkg/Include/Protocol/EdidDiscovered.h @@ -1,8 +1,8 @@ /** @file
EDID Discovered Protocol from the UEFI 2.0 specification.
- This protocol is placed on the video output device child handle and it represents
- the EDID information being used for output device represented by the child handle.
+ This protocol is placed on the video output device child handle. It represents
+ the EDID information being used for the output device represented by the child handle.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Protocol/EdidOverride.h b/MdePkg/Include/Protocol/EdidOverride.h index f2076b252e..772956e920 100644 --- a/MdePkg/Include/Protocol/EdidOverride.h +++ b/MdePkg/Include/Protocol/EdidOverride.h @@ -1,7 +1,7 @@ /** @file
EDID Override Protocol from the UEFI 2.0 specification.
- Allow platform to provide EDID information to producer of the Graphics Output
+ Allow platform to provide EDID information to the producer of the Graphics Output
protocol.
Copyright (c) 2006 - 2008, Intel Corporation
diff --git a/MdePkg/Include/Protocol/FirmwareVolume2.h b/MdePkg/Include/Protocol/FirmwareVolume2.h index 07767f3c70..7e5775d63b 100644 --- a/MdePkg/Include/Protocol/FirmwareVolume2.h +++ b/MdePkg/Include/Protocol/FirmwareVolume2.h @@ -295,7 +295,7 @@ EFI_STATUS attempting to access the firmware volume.
@retval EFI_ACCESS_DENIED The firmware volume is configured to
- isallow reads.
+ disallow reads.
**/
typedef
diff --git a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h index d44f615584..d25a2a0fa0 100644 --- a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h +++ b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h @@ -206,9 +206,9 @@ EFI_STATUS function, or else the result will be unpredictable. This
unpredictability arises because, for a sticky-write firmware
volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY
- state but it cannot flip it back again. In general, before
+ state but cannot flip it back again. In general, before
calling the Write() function, the caller should call the
- EraseBlocks() function first to erase the specified block to
+ EraseBlocks() function first to erase the block it intends to
write. A block erase cycle will transition bits from the
(NOT)EFI_FVB_ERASE_POLARITY state back to the
EFI_FVB_ERASE_POLARITY state. Implementations should be
@@ -276,7 +276,7 @@ EFI_STATUS /**
Erases and initializes a firmware volume block.
- The EraseBlocks() function erases one or more blocks as denoted
+ The EraseBlocks() function erases one or more blocks, as denoted
by the variable argument list. The entire parameter list of
blocks must be verified before erasing any blocks. If a block is
requested that does not exist within the associated firmware
diff --git a/MdePkg/Include/Protocol/FormBrowser2.h b/MdePkg/Include/Protocol/FormBrowser2.h index 9cb3f9657c..43589c1399 100644 --- a/MdePkg/Include/Protocol/FormBrowser2.h +++ b/MdePkg/Include/Protocol/FormBrowser2.h @@ -29,12 +29,10 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL; /**
@param LeftColumn Value that designates the text column
- where the browser window will begin from
- the left-hand side of the screen
+ at which the browser window will begin (left-most column).
@param RightColumn Value that designates the text
- column where the browser window will end
- on the right-hand side of the screen.
+ column at which the browser window will end (right-most column).
@param TopRow Value that designates the text row from the
top of the screen where the browser window
diff --git a/MdePkg/Include/Protocol/GraphicsOutput.h b/MdePkg/Include/Protocol/GraphicsOutput.h index 8d63f9787e..5f2e6e1746 100644 --- a/MdePkg/Include/Protocol/GraphicsOutput.h +++ b/MdePkg/Include/Protocol/GraphicsOutput.h @@ -33,7 +33,7 @@ typedef struct { typedef enum {
///
- /// A pixel is 32-bits and byte zero represents red, byte one represents green,
+ /// A pixel is 32-bits. Byte zero represents red, byte one represents green,
/// byte two represents blue, and byte three is reserved. This is the definition
/// for the physical frame buffer. The byte values for the red, green, and blue
/// components represent the color intensity. This color intensity value range
@@ -41,7 +41,7 @@ typedef enum { ///
PixelRedGreenBlueReserved8BitPerColor,
///
- /// A pixel is 32-bits and byte zero represents blue, byte one represents green,
+ /// A pixel is 32-bits. Byte zero represents blue, byte one represents green,
/// byte two represents red, and byte three is reserved. This is the definition
/// for the physical frame buffer. The byte values for the red, green, and blue
/// components represent the color intensity. This color intensity value range
diff --git a/MdePkg/Include/Protocol/Hash.h b/MdePkg/Include/Protocol/Hash.h index fe8c9011a0..e5cc8ded3a 100644 --- a/MdePkg/Include/Protocol/Hash.h +++ b/MdePkg/Include/Protocol/Hash.h @@ -2,7 +2,7 @@ EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.
EFI_HASH_PROTOCOL as defined in UEFI 2.0.
The EFI Hash Service Binding Protocol is used to locate hashing services support
- provided by a driver and create and destroy instances of the EFI Hash Protocol
+ provided by a driver and to create and destroy instances of the EFI Hash Protocol
so that a multiple drivers can use the underlying hashing services.
The EFI Service Binding Protocol defines the generic Service Binding Protocol functions.
@@ -79,7 +79,7 @@ typedef union { } EFI_HASH_OUTPUT;
/**
- Returns the size of the hash which results from a specific algorithm.
+ Returns the size of the hash that results from a specific algorithm.
@param This Points to this instance of EFI_HASH_PROTOCOL.
@param HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.
@@ -100,7 +100,7 @@ EFI_STATUS );
/**
- Returns the size of the hash which results from a specific algorithm.
+ Returns the size of the hash that results from a specific algorithm.
@param This Points to this instance of EFI_HASH_PROTOCOL.
@param HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.
diff --git a/MdePkg/Include/Protocol/HiiConfigAccess.h b/MdePkg/Include/Protocol/HiiConfigAccess.h index c131821d35..46a4362713 100644 --- a/MdePkg/Include/Protocol/HiiConfigAccess.h +++ b/MdePkg/Include/Protocol/HiiConfigAccess.h @@ -95,7 +95,7 @@ typedef UINTN EFI_BROWSER_ACTION; process the names.
@retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
- to most recent & before the
+ to most recent "&" before the
error or the beginning of the
string.
@@ -173,7 +173,7 @@ EFI_STATUS @param QuestionId A unique value which is sent to the original
exporting driver so that it can identify the type
of data to expect. The format of the data tends to
- vary based on the opcode that enerated the callback.
+ vary based on the opcode that generated the callback.
@param Type The type of value for the question.
@param Value A pointer to the data being sent to the original
exporting driver.
diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h index 8e833bdede..1530bb824c 100644 --- a/MdePkg/Include/Protocol/HiiConfigRouting.h +++ b/MdePkg/Include/Protocol/HiiConfigRouting.h @@ -87,8 +87,9 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL; for the Request parameter
would result in this type of
error. The Progress parameter
- is set to NULL. EFI_NOT_FOUND
- Routing data doesn't match any
+ is set to NULL.
+
+ @retval EFI_NOT_FOUND Routing data doesn't match any
known driver. Progress set to
the "G" in "GUID" of the
routing header that doesn't
@@ -256,8 +257,8 @@ EFI_STATUS @retval EFI_NOT_FOUND Target for the specified routing data
was not found. Progress points to the
'G' in "GUID" of the errant routing
- data. EFI_DEVICE_ERROR Block not large
- enough. Progress undefined.
+ data.
+ @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
@retval EFI_INVALID_PARAMETER Encountered non <BlockName>
formatted string. Block is
@@ -324,7 +325,7 @@ EFI_STATUS @retval EFI_SUCCESS The request succeeded. Progress points to the null
terminator at the end of the ConfigResp string.
- @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
+ @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
points to the first character of ConfigResp.
@retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or
Block parameter would result in this type of
diff --git a/MdePkg/Include/Protocol/HiiDatabase.h b/MdePkg/Include/Protocol/HiiDatabase.h index b94323fc76..4fb26134bc 100644 --- a/MdePkg/Include/Protocol/HiiDatabase.h +++ b/MdePkg/Include/Protocol/HiiDatabase.h @@ -147,8 +147,7 @@ EFI_STATUS EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in
EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within
the existing package list in the HII database specified by
- Handle. If a package??s type matches one of the types collected
- in step 1, then perform the following steps:
+ Handle. If a package's type matches one of the collected types, then perform the following steps:
- Call any functions registered with the notification type
REMOVE_PACK.
- Remove the package from the package list and the HII
@@ -355,7 +354,7 @@ EFI_STATUS @retval EFI_SUCCESS Unregister the notification Successsfully
@retval EFI_NOT_FOUND The incoming notification handle does not exist
- in current hii database.
+ in the current hii database.
**/
typedef
diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h index 259041113e..579eb64c5d 100644 --- a/MdePkg/Include/Protocol/HiiFont.h +++ b/MdePkg/Include/Protocol/HiiFont.h @@ -90,10 +90,10 @@ typedef struct { /**
Describes font output-related information.
- This structure is used for describing the way in which a string
+ This structure is used for describing the way a string
should be rendered in a particular font. FontInfo specifies the
- basic font information and ForegroundColor and BackgroundColor
- specify the color in which they should be displayed. The flags
+ basic font information, and ForegroundColor and BackgroundColor
+ specify the color in which the characters should be displayed. The flags
in FontInfoMask describe where the system default should be
supplied instead of the specified information. The flags also
describe what options can be used to make a match between the
@@ -194,7 +194,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO { string on the row where it is
displayed. Non-printing characters
will have the offset ~0. The caller is
- responsible to allocate a buffer large
+ responsible for allocating a buffer large
enough so that there is one entry for
each character in the string, not
including the null-terminator. It is
@@ -231,7 +231,7 @@ EFI_STATUS This function renders a string as a bitmap or to the screen
and can clip or wrap the string. The bitmap is either supplied
- by the caller or else is allocated by the function. The
+ by the caller or allocated by the function. The
strings are drawn with the font, size and style specified and
can be drawn transparently or opaquely. The function can also
return information about each row and each character's
diff --git a/MdePkg/Include/Protocol/HiiPackageList.h b/MdePkg/Include/Protocol/HiiPackageList.h index 112e266c98..4afe46f89d 100644 --- a/MdePkg/Include/Protocol/HiiPackageList.h +++ b/MdePkg/Include/Protocol/HiiPackageList.h @@ -2,7 +2,7 @@ EFI_HII_PACKAGE_LIST_PROTOCOL as defined in UEFI 2.1.
Boot service LoadImage() installs EFI_HII_PACKAGE_LIST_PROTOCOL on the handle
if the image contains a custom PE/COFF resource with the type 'HII'.
- The protocol's interface pointer points to the HII package list which is
+ The protocol's interface pointer points to the HII package list, which is
contained in the resource's data.
Copyright (c) 2009, Intel Corporation
diff --git a/MdePkg/Include/Protocol/IScsiInitiatorName.h b/MdePkg/Include/Protocol/IScsiInitiatorName.h index afa72b51de..1b947d8506 100644 --- a/MdePkg/Include/Protocol/IScsiInitiatorName.h +++ b/MdePkg/Include/Protocol/IScsiInitiatorName.h @@ -1,6 +1,6 @@ /** @file
EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.
- It rovides the ability to get and set the iSCSI Initiator Name.
+ It provides the ability to get and set the iSCSI Initiator Name.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Protocol/Ip4.h b/MdePkg/Include/Protocol/Ip4.h index ab598484af..d0ff760ee2 100644 --- a/MdePkg/Include/Protocol/Ip4.h +++ b/MdePkg/Include/Protocol/Ip4.h @@ -311,7 +311,7 @@ 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 One or more of the following conditions is TRUE:
+ @retval EFI_INVALID_PARAMETER At least one of the parameters was invalid.
@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
@@ -509,7 +509,7 @@ EFI_STATUS Abort an asynchronous transmit or receive request.
The Cancel() function is used to abort a pending transmit or receive request.
- If the token is in the transmit or receive request queues, after calling this
+ If the token is in the transmit or receive request queues, then after calling this
function, Token->Status will be set to EFI_ABORTED and then Token->Event will
be signaled. If the token is not in one of the queues, which usually means the
asynchronous operation has completed, this function will not signal the token
diff --git a/MdePkg/Include/Protocol/Metronome.h b/MdePkg/Include/Protocol/Metronome.h index 2383c73046..bef64a5963 100644 --- a/MdePkg/Include/Protocol/Metronome.h +++ b/MdePkg/Include/Protocol/Metronome.h @@ -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
ticks are detected, then EFI_SUCCESS is returned. The actual time passed
between entry of this function and the first tick is between 0 and
- TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod
+ TickPeriod 100 nS units. To guarantee that at least TickPeriod
time has elapsed, wait for two ticks. This function waits for a hardware
event to determine when a tick occurs. It is possible for interrupt
processing, or exception processing to interrupt the execution of the
diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h index c13851ef6c..149c6270e0 100644 --- a/MdePkg/Include/Protocol/Mtftp4.h +++ b/MdePkg/Include/Protocol/Mtftp4.h @@ -182,9 +182,9 @@ typedef struct { //
/**
- a callback function that is provided by the caller to intercept
+ A callback function that is provided by the caller to intercept
the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the
- EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept
+ EFI_MTFTP4_PROTOCOL.ReadFile() function, or alternatively to intercept
EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to
EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().
@@ -230,7 +230,7 @@ EFI_STATUS );
/**
- a callback function that the caller provides to feed data to the
+ A callback function that the caller provides to feed data to the
EFI_MTFTP4_PROTOCOL.WriteFile() function.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h index 3cf1049556..9765206d0b 100644 --- a/MdePkg/Include/Protocol/Pcd.h +++ b/MdePkg/Include/Protocol/Pcd.h @@ -74,9 +74,9 @@ UINT8 /**
- Retrieves an 16-bit value for a given PCD token.
+ Retrieves a 16-bit value for a given PCD token.
- Retrieves the current 16-bits value for a PCD token number.
+ Retrieves the current 16-bit value for a PCD token number.
If the TokenNumber is invalid, the results are unpredictable.
@param[in] TokenNumber The PCD token number.
@@ -93,9 +93,9 @@ UINT16 /**
- Retrieves an 32-bit value for a given PCD token.
+ Retrieves a 32-bit value for a given PCD token.
- Retrieves the current 32-bits value for a PCD token number.
+ Retrieves the current 32-bit value for a PCD token number.
If the TokenNumber is invalid, the results are unpredictable.
@param[in] TokenNumber The PCD token number.
@@ -112,9 +112,9 @@ UINT32 /**
- Retrieves an 64-bit value for a given PCD token.
+ Retrieves a 64-bit value for a given PCD token.
- Retrieves the current 64-bits value for a PCD token number.
+ Retrieves the current 64-bit value for a PCD token number.
If the TokenNumber is invalid, the results are unpredictable.
@param[in] TokenNumber The PCD token number.
@@ -215,7 +215,7 @@ UINT8 /**
- Retrieves an 16-bit value for a given PCD token.
+ Retrieves a 16-bit value for a given PCD token.
Retrieves the 16-bit value of a particular PCD token.
If the TokenNumber is invalid or the token space
@@ -238,7 +238,7 @@ UINT16 /**
- Retrieves an 32-bit value for a given PCD token.
+ Retrieves a 32-bit value for a given PCD token.
Retrieves the 32-bit value of a particular PCD token.
If the TokenNumber is invalid or the token space
@@ -294,7 +294,7 @@ UINT64 @param[in] Guid The token space for the token number.
@param[in] TokenNumber The PCD token number.
- @return The pointer to the buffer to be retrived.
+ @return The pointer to the buffer to be retrieved.
**/
typedef
@@ -307,7 +307,7 @@ VOID * /**
- Retrieves an Boolean value for a given PCD token.
+ Retrieves a Boolean value for a given PCD token.
Retrieves the Boolean value of a particular PCD token.
If the TokenNumber is invalid or the token space
@@ -377,7 +377,7 @@ EFI_STATUS /**
- Sets an 16-bit value for a given PCD token.
+ Sets a 16-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition.
@@ -403,7 +403,7 @@ EFI_STATUS /**
- Sets an 32-bit value for a given PCD token.
+ Sets a 32-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition.
@@ -429,7 +429,7 @@ EFI_STATUS /**
- Sets an 64-bit value for a given PCD token.
+ Sets a 64-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition.
@@ -486,7 +486,7 @@ EFI_STATUS /**
- Sets an Boolean value for a given PCD token.
+ Sets a Boolean value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition.
@@ -568,7 +568,7 @@ EFI_STATUS /**
- Sets an 32-bit value for a given PCD token.
+ Sets a 32-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition.
@@ -596,7 +596,7 @@ EFI_STATUS /**
- Sets an 64-bit value for a given PCD token.
+ Sets a 64-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition.
@@ -657,7 +657,7 @@ EFI_STATUS /**
- Sets an Boolean value for a given PCD token.
+ Sets a Boolean value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition.
@@ -690,8 +690,8 @@ EFI_STATUS This notification function serves two purposes.
Firstly, it notifies the module which did the registration that the value
of this PCD token has been set. Secondly, it provides a mechanism for the
- module which did the registration to intercept the set operation and override
- the value been set if necessary. After the invocation of the callback function,
+ module that did the registration to intercept the set operation and override
+ the value that has been set, if necessary. After the invocation of the callback function,
TokenData will be used by PCD service DXE driver to modify the internal data in
PCD database.
@@ -775,7 +775,7 @@ EFI_STATUS @param[in] Guid The 128-bit unique value that designates the namespace from which to retrieve the next token.
- This is an optional parameter that may be NULL. If this parameter is NULL, then a request is
+ This is an optional parameter that may be NULL. If this parameter is NULL, then a request is
being made to retrieve tokens from the default token space.
@param[in,out] TokenNumber
A pointer to the PCD token number to use to find the subsequent token number.
@@ -798,14 +798,14 @@ EFI_STATUS /**
Retrieves the next valid PCD token namespace for a given namespace.
- @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates
+ @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates
a known token namespace from which the search will start. On output,
it designates the next valid token namespace on the platform. If the input
token namespace does not exist on the platform, an error is returned and
the value of *Guid is undefined. If *Guid is NULL, then the GUID of the
first token space of the current platform is assigned to *Guid the function
- return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in
- the platform other than the default (NULL) tokennamespace, *Guid is unchanged
+ return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in
+ the platform other than the default (NULL) token namespace, *Guid is unchanged
and the function return EFI_SUCCESS. If this input token namespace is the last
namespace on the platform, *Guid will be assigned to NULL and the function return
EFI_SUCCESS.
diff --git a/MdePkg/Include/Protocol/PciIo.h b/MdePkg/Include/Protocol/PciIo.h index f04218de9c..54ab0b5807 100644 --- a/MdePkg/Include/Protocol/PciIo.h +++ b/MdePkg/Include/Protocol/PciIo.h @@ -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)
#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020 ///< I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode)
#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040 ///< I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode)
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 ///< Map a memory range so write are combined
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 ///< Map a memory range so writes are combined
#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100 ///< Enable the I/O decode bit in the PCI Config Header
#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200 ///< Enable the Memory decode bit in the PCI Config Header
#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400 ///< Enable the DMA bit in the PCI Config Header
@@ -127,7 +127,7 @@ typedef enum { } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
/**
- Reads from the memory space of a PCI controller. Returns when either the polling exit criteria is
+ Reads from the memory space of a PCI controller. Returns either when the polling exit criteria is
satisfied or after a defined duration.
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
@@ -283,7 +283,7 @@ EFI_STATUS );
/**
- Provides the PCI controller-Cspecific addresses needed to access system memory.
+ Provides the PCI controller-specific addresses needed to access system memory.
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
@param Operation Indicates if the bus master is going to read or write to system memory.
@@ -515,7 +515,7 @@ EFI_STATUS ///
/// The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration,
-/// and DMA interfaces that are used to abstract accesses to PCI controllers.
+/// and DMA interfaces used to abstract accesses to PCI controllers.
/// There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus.
/// A device driver that wishes to manage a PCI controller in a system will have to
/// retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller.
diff --git a/MdePkg/Include/Protocol/PciRootBridgeIo.h b/MdePkg/Include/Protocol/PciRootBridgeIo.h index 970aee0642..56999e0ef0 100644 --- a/MdePkg/Include/Protocol/PciRootBridgeIo.h +++ b/MdePkg/Include/Protocol/PciRootBridgeIo.h @@ -3,7 +3,7 @@ PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O,
and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform
- defferent types of bus mastering DMA
+ defferent types of bus mastering DMA.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -205,7 +205,7 @@ EFI_STATUS );
/**
- Provides the PCI controller-Cspecific addresses required to access system memory from a
+ Provides the PCI controller-specific addresses required to access system memory from a
DMA bus master.
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
diff --git a/MdePkg/Include/Protocol/PlatformDriverOverride.h b/MdePkg/Include/Protocol/PlatformDriverOverride.h index cbcdefc083..d11f431a1a 100644 --- a/MdePkg/Include/Protocol/PlatformDriverOverride.h +++ b/MdePkg/Include/Protocol/PlatformDriverOverride.h @@ -65,7 +65,7 @@ EFI_STATUS exists.
@param DriverImagePath On input, a pointer to the previous driver device path returned by
GetDriverPath(). On output, a pointer to the next driver
- device path. Passing in a pointer to NULL, will return the first
+ device path. Passing in a pointer to NULL will return the first
driver device path for ControllerHandle.
@retval EFI_SUCCESS The driver override for ControllerHandle was returned in
diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h index fff7688875..4973553eb9 100644 --- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h +++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h @@ -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.
Information returned from Query may lead to the drivers Start()
function failing.
- If the UEFI driver is a bus driver and producing a ChildHandle
+ If the UEFI driver is a bus driver and producing a ChildHandle,
the driver must call Query after the child handle has been created
and an EFI_DEVICE_PATH_PROTOCOL has been placed on that handle,
but before any time consuming operation is performed. If information
@@ -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
return information on. This is an optional
parameter that may be NULL. It will be
- NULL for device drivers, and for bus
+ NULL for device drivers and for bus
drivers that attempt to get options for
the bus controller. It will not be NULL
for a bus driver that attempts to get
@@ -76,7 +76,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR should not attempt to free ParameterTypeGuid.
@param ParameterBlock The platform returns a pointer to the
- ParameterBlock structure which
+ ParameterBlock structure, which
contains details about the
configuration parameters specific to
the ParameterTypeGuid. This structure
@@ -85,7 +85,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR protocols. UEFI driver decodes this
structure and its contents based on
ProtocolGuid. ParameterBlock is
- allocated by the platform and the
+ allocated by the platform. The
platform is responsible for freeing
the ParameterBlock after Result is
called.
@@ -132,9 +132,9 @@ EFI_STATUS typedef enum {
///
/// The controller specified by ControllerHandle is still
- /// in a usable state, it's configuration has been updated
+ /// in a usable state, and its configuration has been updated
/// via parsing the ParameterBlock. If required by the
- /// parameter block and the module supports an NVRAM store
+ /// parameter block, and the module supports an NVRAM store,
/// the configuration information from PB was successfully
/// saved to the NVRAM. No actions are required before
/// this controller can be used again with the updated
@@ -144,7 +144,7 @@ typedef enum { ///
/// The driver has detected that the controller specified
- /// by ControllerHandle is not in a usable state, and it
+ /// by ControllerHandle is not in a usable state and
/// needs to be stopped. The calling agent can use the
/// DisconnectControservice to perform this operation, and
/// it should be performed as soon as possible.
@@ -156,8 +156,8 @@ typedef enum { /// be stopped and restarted before it can be used again.
/// The calling agent can use the DisconnectController()
/// and ConnectController() services to perform this
- /// operation. The restart operation can be delayed until
- /// all of the configuratiooptions have been set.
+ /// operation. The restart operation can be delayed until
+ /// all of the configuration options have been set.
///
EfiPlatformConfigurationActionRestartController = 2,
@@ -199,7 +199,7 @@ typedef enum { ParameterBlock, and ParameterBlockSize. The UEFI driver may
update values in ParameterBlock based on rules defined by
ParameterTypeGuid. The platform is responsible for freeing
- ParameterBlock and the UEFI driver must not try to free it
+ ParameterBlock and the UEFI driver must not try to free it.
@param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.
@@ -225,7 +225,7 @@ typedef enum { @param ParameterBlockSize The ParameterBlock size returned from Query.
- @param Configuration ActionThe driver tells the platform what
+ @param ConfigurationAction The driver tells the platform what
action is required for ParameterBlock to
take effect.
@@ -285,15 +285,15 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL { EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is platform
firmware and the consumer is the UEFI driver. Note: if future
versions of the DMTF SM CLP Specification require changes to the
- parameter block definition, newer ParameterTypeGuid will be
+ parameter block definition, a newer ParameterTypeGuid will be
used.
**/
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 when this EFI_SUCCESS The platform
+ ///< 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.
+ ///< EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. 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 3de3d28afa..6f4df05158 100644 --- a/MdePkg/Include/Protocol/RealTimeClock.h +++ b/MdePkg/Include/Protocol/RealTimeClock.h @@ -9,7 +9,7 @@ EFI_REAL_TIME_CLOCK_ARCH_PROTOCOL_GUID protocol is registered with a NULL
pointer.
- No CRC of the EFI system table is required, as it is done in the DXE core.
+ No CRC of the EFI system table is required, since that is done in the DXE core.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h index 2dfd320a04..c78ccd1421 100644 --- a/MdePkg/Include/Protocol/Runtime.h +++ b/MdePkg/Include/Protocol/Runtime.h @@ -113,8 +113,8 @@ struct _EFI_RUNTIME_EVENT_ENTRY { struct _EFI_RUNTIME_ARCH_PROTOCOL {
EFI_LIST_ENTRY ImageHead; ///< A list of type EFI_RUNTIME_IMAGE_ENTRY.
EFI_LIST_ENTRY EventHead; ///< A list of type EFI_RUNTIME_EVENT_ENTRY.
- UINTN MemoryDescriptorSize; ///< Size of a memory descriptor that is return by GetMemoryMap().
- UINT32 MemoryDesciptorVersion; ///< Version of a memory descriptor that is return by GetMemoryMap().
+ UINTN MemoryDescriptorSize; ///< Size of a memory descriptor that is returned by GetMemoryMap().
+ UINT32 MemoryDesciptorVersion; ///< Version of a memory descriptor that is returned by GetMemoryMap().
UINTN MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical; ///< Pointer to a runtime buffer that contains a copy of
///< the memory map returned via GetMemoryMap().
diff --git a/MdePkg/Include/Protocol/ScsiIo.h b/MdePkg/Include/Protocol/ScsiIo.h index e0204cce22..66cda35db3 100644 --- a/MdePkg/Include/Protocol/ScsiIo.h +++ b/MdePkg/Include/Protocol/ScsiIo.h @@ -140,7 +140,7 @@ typedef struct { @param DeviceType A pointer to the device type information
retrieved from the SCSI Controller.
- @retval EFI_SUCCESS Retrieves the device type information successfully.
+ @retval EFI_SUCCESS Retrieved the device type information successfully.
@retval EFI_INVALID_PARAMETER The DeviceType is NULL.
**/
@@ -197,7 +197,7 @@ EFI_STATUS @param This Protocol instance pointer.
@retval EFI_SUCCESS Reset the SCSI controller successfully.
- @retval EFI_DEVICE_ERROR Errors are encountered when resetting the
+ @retval EFI_DEVICE_ERROR Errors were encountered when resetting the
SCSI Controller.
@retval EFI_UNSUPPORTED The SCSI bus does not support a device
reset operation.
@@ -218,7 +218,7 @@ EFI_STATUS @param This Protocol instance pointer.
@param Packet The SCSI request packet to send to the SCSI
Controller specified by the device handle.
- @param Event If the SCSI bus where the SCSI device is attached
+ @param Event If the SCSI bus to which the SCSI device is attached
does not support non-blocking I/O, then Event is
ignored, and blocking I/O is performed.
If Event is NULL, then blocking I/O is performed.
@@ -229,7 +229,7 @@ EFI_STATUS @retval EFI_SUCCESS The SCSI Request Packet was sent by the host
successfully, and TransferLength bytes were
- transferred to/from DataBuffer.See
+ transferred to/from DataBuffer. See
HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order
for additional status information.
diff --git a/MdePkg/Include/Protocol/ScsiPassThru.h b/MdePkg/Include/Protocol/ScsiPassThru.h index 1790c1af43..24b70aaca5 100644 --- a/MdePkg/Include/Protocol/ScsiPassThru.h +++ b/MdePkg/Include/Protocol/ScsiPassThru.h @@ -171,8 +171,8 @@ typedef struct { @retval EFI_SUCCESS The SCSI Request Packet was sent by the host, and
TransferLength bytes were transferred to/from
- DataBuffer.See HostAdapterStatus, TargetStatus,
- SenseDataLength,and SenseData in that order
+ DataBuffer. See HostAdapterStatus, TargetStatus,
+ SenseDataLength, and SenseData in that order
for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the
entire DataBuffer could not be transferred.
@@ -223,7 +223,7 @@ EFI_STATUS Target ID of the first SCSI device present on
a SCSI channel.
@param Lun On input, a pointer to the LUN of a SCSI device
- present on the SCSI channel.On output, a pointer
+ present on the SCSI channel. On output, a pointer
to the LUN of the next SCSI device present on a
SCSI channel.
@@ -360,7 +360,7 @@ EFI_STATUS ///
/// The EFI_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel and
-/// the ability to send SCI Request Packets to any SCSI device attached to that SCSI channel. The
+/// the ability to send SCSI Request Packets to any SCSI device attached to that SCSI channel. The
/// information includes the Target ID of the host controller on the SCSI channel, the attributes of
/// the SCSI channel, the printable name for the SCSI controller, and the printable name of the
/// SCSI channel.
diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h index 7ec0dd9737..176db59aee 100644 --- a/MdePkg/Include/Protocol/ScsiPassThruExt.h +++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h @@ -153,9 +153,9 @@ typedef struct { nonblocking I/O functionality is optional.
@param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
- @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
- the id of the SCSI device to send the SCSI Request Packet. Each
- transport driver may chose to utilize a subset of this size to suit the needs
+ @param Target The Target is an array of size TARGET_MAX_BYTES. It represents
+ the id of the SCSI device that will send the SCSI Request Packet. Each
+ transport driver may choose to utilize a subset of this size to suit the needs
of transport target representation. For example, a Fibre Channel driver
may use only 8 bytes (WWN) to represent an FC target.
@param Lun The LUN of the SCSI device to send the SCSI Request Packet.
@@ -201,7 +201,7 @@ EFI_STATUS /**
Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These
can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal
- Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the
+ Target Ids and LUNs for the SCSI channel. Either way, the caller of this function must probe the
Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI
channel.
@@ -317,7 +317,7 @@ EFI_STATUS Resets a SCSI logical unit that is connected to a SCSI channel.
@param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
- @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the
+ @param Target The Target is an array of size TARGET_MAX_BYTE. It represents the
target port ID of the SCSI device containing the SCSI logical unit to
reset. Transport drivers may chose to utilize a subset of this array to suit
the representation of their targets.
@@ -357,7 +357,7 @@ EFI_STATUS @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
channel was returned in Target.
@retval EFI_INVALID_PARAMETER Target or Lun is NULL.
- @retval EFI_TIMEOUT Target array is not all 0xF, and Target were not
+ @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
returned on a previous call to GetNextTarget().
@retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h index 32415ca144..4fbfe027eb 100644 --- a/MdePkg/Include/Protocol/SerialIo.h +++ b/MdePkg/Include/Protocol/SerialIo.h @@ -104,15 +104,20 @@ EFI_STATUS );
/**
- Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,
- data buts, and stop bits on a serial device.
+ Sets the following attributes for a serial device:
+ * baud rate
+ * receive FIFO depth
+ * transmit/receive time out
+ * parity
+ * data bits
+ * stop bits
@param This Protocol instance pointer.
- @param BaudRate The requested baud rate. A BaudRate value of 0 will use the the
+ @param BaudRate The requested baud rate. A BaudRate value of 0 will use the
device's default interface speed.
@param ReveiveFifoDepth The requested depth of the FIFO on the receive side of the
serial interface. A ReceiveFifoDepth value of 0 will use
- the device's dfault FIFO depth.
+ the device's default FIFO depth.
@param Timeout The requested time out for a single character in microseconds.
This timeout applies to both the transmit and receive side of the
interface. A Timeout value of 0 will use the device's default time
@@ -203,7 +208,7 @@ EFI_STATUS @param This Protocol instance pointer.
@param BufferSize On input, the size of the Buffer. On output, the amount of
data returned in Buffer.
- @param Buffer The buffer to return the data into.
+ @param Buffer The buffer to which to return the data.
@retval EFI_SUCCESS The data was read.
@retval EFI_DEVICE_ERROR The device reported an error.
@@ -224,7 +229,7 @@ EFI_STATUS that produces the SERIAL_IO_PROTOCOL member functions.
@param ControlMask
- A mask fo the Control bits that the device supports. The device
+ A mask for the Control bits that the device supports. The device
must always support the Input Buffer Empty control bit.
@param TimeOut
@@ -272,13 +277,13 @@ typedef struct { ///
/// The Serial I/O protocol is used to communicate with UART-style serial devices.
-/// These can be standard UART serial ports in PC-AT systems, serial ports attached
-/// to a USB interface, or potentially any character-based I/O device.
+/// These can be standard UART serial ports in PC-AT systems, or serial ports attached
+/// to a USB interface or any character-based I/O device.
///
struct _EFI_SERIAL_IO_PROTOCOL {
///
/// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions
- /// must be backwards compatible. If a future version is not back wards compatible,
+ /// must be backwards compatible. If a future version is not backwards compatible,
/// it is not the same GUID.
///
UINT32 Revision;
diff --git a/MdePkg/Include/Protocol/SimpleFileSystem.h b/MdePkg/Include/Protocol/SimpleFileSystem.h index ddfbebb80c..0733235180 100644 --- a/MdePkg/Include/Protocol/SimpleFileSystem.h +++ b/MdePkg/Include/Protocol/SimpleFileSystem.h @@ -1,11 +1,11 @@ /** @file
SimpleFileSystem protocol as defined in the UEFI 2.0 specification.
- The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32)
+ The SimpleFileSystem protocol is the programmatic access to the FAT (12,16,32)
file system specified in UEFI 2.0. It can also be used to abstract a file
system other than FAT.
- UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem
+ UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -181,11 +181,11 @@ EFI_STATUS );
/**
- Write data from to the file.
+ Write data from or to the file.
@param This Protocol instance pointer.
- @param BufferSize On input size of buffer, on output amount of data in buffer.
- @param Buffer The buffer in which data to write.
+ @param BufferSize On input: size of buffer. On output: amount of data in buffer.
+ @param Buffer The buffer in which to write data.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORT Writes to Open directory are not supported
@@ -209,7 +209,7 @@ EFI_STATUS Set a files current position
@param This Protocol instance pointer.
- @param Position Byte possition from the start of the file
+ @param Position Byte position, from the start of the file
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
@@ -223,10 +223,10 @@ EFI_STATUS );
/**
- Get a files current position
+ Get a file's current position
@param This Protocol instance pointer.
- @param Position Byte possition from the start of the file
+ @param Position Byte position, from the start of the file
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
@@ -244,7 +244,7 @@ EFI_STATUS @param This Protocol instance pointer.
@param InformationType Type of info to return in Buffer
- @param BufferSize On input size of buffer, on output amount of data in buffer.
+ @param BufferSize On input: size of buffer. On output: amount of data in buffer.
@param Buffer The buffer to return data.
@retval EFI_SUCCESS Data was returned.
diff --git a/MdePkg/Include/Protocol/SimpleNetwork.h b/MdePkg/Include/Protocol/SimpleNetwork.h index 1d9cc67bdf..242e84d6f0 100644 --- a/MdePkg/Include/Protocol/SimpleNetwork.h +++ b/MdePkg/Include/Protocol/SimpleNetwork.h @@ -284,7 +284,7 @@ EFI_STATUS @retval EFI_SUCCESS The network interface was initialized.
@retval EFI_NOT_STARTED The network interface has not been started
@retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and
- receive buffers. .
+ receive buffers.
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
@retval EFI_UNSUPPORTED This function is not supported by the network interface.
diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h index 9b5fb3127b..44d640cc70 100644 --- a/MdePkg/Include/Protocol/SimplePointer.h +++ b/MdePkg/Include/Protocol/SimplePointer.h @@ -1,7 +1,7 @@ /** @file
Simple Pointer protocol from the UEFI 2.0 specification.
- Abstraction of a very simple pointer device like a mice or tracekballs.
+ Abstraction of a very simple pointer device like a mouse or trackball.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h index 430ec601be..df5e6fd393 100644 --- a/MdePkg/Include/Protocol/SimpleTextInEx.h +++ b/MdePkg/Include/Protocol/SimpleTextInEx.h @@ -58,8 +58,8 @@ EFI_STATUS ///
-/// EFI_KEY_TOGGLE_STATE. The toggle state are defined.
-/// They are EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE
+/// EFI_KEY_TOGGLE_STATE. The toggle states are defined.
+/// They are: EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE
/// EFI_NUM_LOCK_ACTIVE, EFI_CAPS_LOCK_ACTIVE
///
typedef UINT8 EFI_KEY_TOGGLE_STATE;
@@ -149,29 +149,28 @@ typedef struct { there is no pending keystroke the function returns
EFI_NOT_READY. If there is a pending keystroke, then
KeyData.Key.ScanCode is the EFI scan code defined in Error!
- Reference source not found.. The KeyData.Key.UnicodeChar is the
- actual printable character or is zero if the key does not
+ Reference source not found. The KeyData.Key.UnicodeChar is the
+ actual printable character, or is zero if the key does not
represent a printable character (control key, function key,
etc.). The KeyData.KeyState is shift state for the character
reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode .
- When interpreting the data from this function, it should be
- noted that if a class of printable characters that are
+ When interpreting the data from this function, printable characters that are
normally adjusted by shift modifiers (e.g. Shift Key + "f"
- key) would be presented solely as a KeyData.Key.UnicodeChar
- without the associated shift state. So in the previous example
- of a Shift Key + "f" key being pressed, the only pertinent
+ key) are presented solely as a KeyData.Key.UnicodeChar
+ without the associated shift state. For example,
+ if Shift Key + "f" key are pressed, the only pertinent
data returned would be KeyData.Key.UnicodeChar with the value
- of "F". This of course would not typically be the case for
- non-printable characters such as the pressing of the Right
- Shift Key + F10 key since the corresponding returned data
+ of "F". This would not typically be the case for
+ non-printable characters such as pressing the Right
+ Shift Key + F10 key, since the corresponding returned data
would be reflected both in the KeyData.KeyState.KeyShiftState
and KeyData.Key.ScanCode values. UEFI drivers which implement
the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return
KeyData.Key and KeyData.KeyState values. These drivers must
always return the most current state of
KeyData.KeyState.KeyShiftState and
- KeyData.KeyState.KeyToggleState. It should also be noted that
- certain input devices may not be able to produce shift or toggle
+ KeyData.KeyState.KeyToggleState.
+ Certain input devices may not be able to produce shift or toggle
state information, and in those cases the high order bit in the
respective Toggle and Shift state fields should not be active.
@@ -238,7 +237,7 @@ EFI_STATUS /**
The RegisterKeystrokeNotify() function registers a function
- which will be called when a specified keystroke will occur.
+ to be called when a specified keystroke will occur.
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
@@ -271,8 +270,8 @@ EFI_STATUS );
/**
- The UnregisterKeystrokeNotify() function removes the
- notification which was previously registered.
+ The UnregisterKeystrokeNotify() function removes a
+ notification that was previously registered.
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h index a55b407f10..3a74416311 100644 --- a/MdePkg/Include/Protocol/SimpleTextOut.h +++ b/MdePkg/Include/Protocol/SimpleTextOut.h @@ -3,7 +3,7 @@ Abstraction of a very simple text based output device like VGA text mode or
a serial terminal. The Simple Text Out protocol instance can represent
- a single hardware device or a virtual device that is an agregation
+ a single hardware device or a virtual device that is an aggregation
of multiple physical devices.
Copyright (c) 2006 - 2008, Intel Corporation
@@ -137,11 +137,11 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; //
// We currently define attributes from 0 - 7F for color manipulations
-// To internally handle the local display characteristics for a particular character, we are defining
-// Bit 7 to signify the local glyph representation for a character. If turned on, glyphs will be
+// To internally handle the local display characteristics for a particular character,
+// Bit 7 signifies the local glyph representation for a character. If turned on, glyphs will be
// pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19)
// If bit 7 is off, the narrow glyph database will be used. This does NOT affect information that is sent to
-// non-local displays (e.g. serial or LAN consoles).
+// non-local displays, such as serial or LAN consoles.
//
#define EFI_WIDE_ATTRIBUTE 0x80
@@ -263,7 +263,7 @@ EFI_STATUS and must be zero. The valid Attributes are defined in this file.
@retval EFI_SUCCESS The attribute was set.
- @retval EFI_DEVICE_ ERROR The device had an error and could not complete the request.
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
@retval EFI_UNSUPPORTED The attribute requested is not defined.
**/
diff --git a/MdePkg/Include/Protocol/SmbusHc.h b/MdePkg/Include/Protocol/SmbusHc.h index 5431c49d5e..f03b6b6d04 100644 --- a/MdePkg/Include/Protocol/SmbusHc.h +++ b/MdePkg/Include/Protocol/SmbusHc.h @@ -51,8 +51,8 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; EFI_SMBUS_DEVICE_COMMAND is defined in
EFI_PEI_SMBUS_PPI.Execute() in the Platform
Initialization SMBus PPI Specification.
- Operation Signifies which particular SMBus
- hardware protocol instance that it will use to
+ @param Operation Signifies the particular SMBus
+ hardware protocol instance it will use to
execute the SMBus transactions. This SMBus
hardware protocol is defined by the SMBus
Specification and is not related to PI
@@ -64,8 +64,9 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; @param PecCheck Defines if Packet Error Code (PEC) checking
is required for this operation. SMBus Host
Controller Code Definitions Version 1.0
- August 21, 2006 13 Length Signifies the
- number of bytes that this operation will do.
+ August 21, 2006 13
+
+ @param Length Signifies the number of bytes that this operation will do.
The maximum number of bytes can be revision
specific and operation specific. This field
will contain the actual number of bytes that
@@ -248,10 +249,10 @@ EFI_STATUS @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
@param SlaveAddress Address that the host controller detects
- as sending a message and calls all the registered function.
+ as sending a message, and that calls all the registered function.
@param Data Data that the host controller detects as sending
- message and calls all the registered function.
+ message, and that calls all the registered function.
@param NotifyFunction The function to call when the bus
diff --git a/MdePkg/Include/Protocol/StatusCode.h b/MdePkg/Include/Protocol/StatusCode.h index 25c1f0dbf8..a0e81459ae 100644 --- a/MdePkg/Include/Protocol/StatusCode.h +++ b/MdePkg/Include/Protocol/StatusCode.h @@ -5,7 +5,7 @@ EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL
pointer.
- No CRC of the EFI system table is required, as it is done in the DXE core.
+ No CRC of the EFI system table is required, since that is done in the DXE core.
This code abstracts Status Code reporting.
diff --git a/MdePkg/Include/Protocol/Tcp4.h b/MdePkg/Include/Protocol/Tcp4.h index d750fe9c78..544236b10d 100644 --- a/MdePkg/Include/Protocol/Tcp4.h +++ b/MdePkg/Include/Protocol/Tcp4.h @@ -279,7 +279,7 @@ EFI_STATUS - This is NULL.
- ConnectionToken is NULL.
- ConnectionToken->CompletionToken.Event is NULL.
- @retval EFI_OUT_OF_RESOURCES The driver can't allocate enough resource to initiate the activeopen.
+ @retval EFI_OUT_OF_RESOURCES The driver can't allocate enough resources to initiate the activeopen.
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
**/
@@ -308,8 +308,8 @@ EFI_STATUS - This is NULL.
- ListenToken is NULL.
- ListentToken->CompletionToken.Event is NULL.
- @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
- @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.
+ @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
+ @retval EFI_DEVICE_ERROR Any unexpected error not covered by another error.
**/
typedef
@@ -389,7 +389,7 @@ EFI_STATUS Tcp4StateListen state.
- User has called Close() to disconnect this connection.
@retval EFI_CONNECTION_FIN The communication peer has closed the connection and there is
- no any buffered data in the receive buffer of this instance.
+ no buffered data in the receive buffer of this instance.
@retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
**/
@@ -419,8 +419,8 @@ EFI_STATUS - This is NULL.
- CloseToken is NULL.
- CloseToken->CompletionToken.Event is NULL.
- @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.
- @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.
+ @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.
+ @retval EFI_DEVICE_ERROR Any unexpected error not covered by another error.
**/
typedef
diff --git a/MdePkg/Include/Protocol/UgaIo.h b/MdePkg/Include/Protocol/UgaIo.h index 0c4d54d125..e58fb56e22 100644 --- a/MdePkg/Include/Protocol/UgaIo.h +++ b/MdePkg/Include/Protocol/UgaIo.h @@ -88,7 +88,7 @@ typedef struct { /**
- Dynamically allocate storage for a child UGA_DEVICE .
+ Dynamically allocate storage for a child UGA_DEVICE.
@param[in] This The EFI_UGA_IO_PROTOCOL instance.
@param[in] ParentDevice ParentDevice specifies a pointer to the parent device of Device.
@@ -116,7 +116,7 @@ EFI_STATUS /**
- Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() .
+ Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice().
@param[in] This The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is
defined in Section 10.7.
diff --git a/MdePkg/Include/Protocol/WatchdogTimer.h b/MdePkg/Include/Protocol/WatchdogTimer.h index 2727862038..efe898765f 100644 --- a/MdePkg/Include/Protocol/WatchdogTimer.h +++ b/MdePkg/Include/Protocol/WatchdogTimer.h @@ -108,8 +108,7 @@ EFI_STATUS will wait before the watchdog timer is fired. If TimerPeriod of
zero is returned, then the watchdog timer is disabled.
- @retval EFI_SUCCESS The amount of time that the system will wait before
- firing the watchdog timer was returned in TimerPeriod.
+ @retval EFI_SUCCESS The function successfully returned TimerPeriod with the amount of time that the system will wait before firing the watchdog timer.
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
**/
|