summaryrefslogtreecommitdiff
path: root/MdeModulePkg/Include/Library
diff options
context:
space:
mode:
Diffstat (limited to 'MdeModulePkg/Include/Library')
-rw-r--r--MdeModulePkg/Include/Library/CapsuleLib.h6
-rw-r--r--MdeModulePkg/Include/Library/DpcLib.h4
-rw-r--r--MdeModulePkg/Include/Library/HiiLib.h64
-rw-r--r--MdeModulePkg/Include/Library/IpIoLib.h40
-rw-r--r--MdeModulePkg/Include/Library/MemoryTestLib.h16
-rw-r--r--MdeModulePkg/Include/Library/NetLib.h129
-rw-r--r--MdeModulePkg/Include/Library/RecoveryLib.h6
-rw-r--r--MdeModulePkg/Include/Library/ResetSystemLib.h26
-rw-r--r--MdeModulePkg/Include/Library/S3Lib.h6
-rw-r--r--MdeModulePkg/Include/Library/UdpIoLib.h62
10 files changed, 177 insertions, 182 deletions
diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h
index 662e4def95..34e71313d3 100644
--- a/MdeModulePkg/Include/Library/CapsuleLib.h
+++ b/MdeModulePkg/Include/Library/CapsuleLib.h
@@ -1,6 +1,6 @@
/** @file
- This library class defines a set of interfaces on how to process capusle image update.
+ This library class defines a set of interfaces for how to process capsule image updates.
Copyright (c) 2007 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -32,12 +32,12 @@ SupportCapsuleImage (
);
/**
- The firmware specific implementation processes the capsule image
+ The firmware-specific implementation processes the capsule image
if it recognized the format of this capsule image.
@param CapsuleHeader Point to the UEFI capsule image to be processed.
- @retval EFI_SUCESS Process Capsule Image successfully.
+ @retval EFI_SUCESS Capsule Image was processed successfully.
@retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.
**/
EFI_STATUS
diff --git a/MdeModulePkg/Include/Library/DpcLib.h b/MdeModulePkg/Include/Library/DpcLib.h
index 68e8530d0d..09c22e4b25 100644
--- a/MdeModulePkg/Include/Library/DpcLib.h
+++ b/MdeModulePkg/Include/Library/DpcLib.h
@@ -20,7 +20,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Add a Deferred Procedure Call to the end of the DPC queue.
- @param[in] DpcTpl The EFI_TPL that the DPC should be invoked.
+ @param[in] DpcTpl The EFI_TPL that the DPC should invoke.
@param[in] DpcProcedure Pointer to the DPC's function.
@param[in] DpcContext Pointer to the DPC's context. Passed to DpcProcedure
when DpcProcedure is invoked.
@@ -41,7 +41,7 @@ QueueDpc (
);
/**
- Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl
+ Dispatch the queue of DPCs. All DPCs that have been queued with a DpcTpl
value greater than or equal to the current TPL are invoked in the order that
they were queued. DPCs with higher DpcTpl values are invoked before DPCs with
lower DpcTpl values.
diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h
index 1f68261522..af3ed0eb2b 100644
--- a/MdeModulePkg/Include/Library/HiiLib.h
+++ b/MdeModulePkg/Include/Library/HiiLib.h
@@ -29,7 +29,7 @@
of packages is passed in, then NULL is returned. If the size of the list of
package is 0, then NULL is returned.
- The variable arguments are pointers which point to package header that defined
+ The variable arguments are pointers that point to package headers defined
by UEFI VFR compiler and StringGather tool.
#pragma pack (push, 1)
@@ -67,8 +67,8 @@ HiiAddPackages (
/**
Removes a package list from the HII database.
- If HiiHandle is NULL, then ASSERT.
- If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT.
+ If HiiHandle is NULL, then ASSERT().
+ If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT().
@param[in] HiiHandle The handle that was previously registered in the HII database
@@ -81,7 +81,7 @@ HiiRemovePackages (
;
/**
- This function create a new string in String Package or updates an existing
+ This function creates a new string in String Package or updates an existing
string in a String Package. If StringId is 0, then a new string is added to
a String Package. If StringId is not zero, then a string in String Package is
updated. If SupportedLanguages is NULL, then the string is added or updated
@@ -97,7 +97,7 @@ HiiRemovePackages (
@param[in] StringId If zero, then a new string is created in the
String Package associated with HiiHandle. If
non-zero, then the string specified by StringId
- is updated in the String Package associated
+ is updated in the String Package associated
with HiiHandle.
@param[in] String A pointer to the Null-terminated Unicode string
to add or update in the String Package associated
@@ -107,12 +107,12 @@ HiiRemovePackages (
String is added or updated in the String Package
associated with HiiHandle for all the languages
that the String Package supports. If this
- parameter is not NULL, then then String is added
+ parameter is not NULL, then String is added
or updated in the String Package associated with
- HiiHandle for the set oflanguages specified by
+ HiiHandle for the set of languages specified by
SupportedLanguages. The format of
SupportedLanguages must follow the language
- format assumed the HII Database.
+ format assumed in the HII Database.
@retval 0 The string could not be added or updated in the String Package.
@retval Other The EFI_STRING_ID of the newly added or updated string.
@@ -138,14 +138,14 @@ HiiSetString (
for freeing the allocated buffer using FreePool().
If HiiHandle is NULL, then ASSERT().
- If StringId is 0, then ASSET.
+ If StringId is 0, then ASSERT().
@param[in] HiiHandle A handle that was previously registered in the HII Database.
@param[in] StringId The identifier of the string to retrieved from the string
package associated with HiiHandle.
@param[in] Language The language of the string to retrieve. If this parameter
is NULL, then the current platform language is used. The
- format of Language must follow the language format assumed
+ format of Language must follow the language format assumed in
the HII Database.
@retval NULL The string specified by StringId is not present in the string package.
@@ -162,7 +162,7 @@ HiiGetString (
;
/**
- Retrieves a string from a string package names by GUID in a specific language.
+ Retrieves a string from a string package named by GUID, in the specified language.
If the language is not specified, then a string from a string package in the
current platform language is retrieved. If the string can not be retrieved
using the specified language or the current platform language, then the string
@@ -171,7 +171,7 @@ HiiGetString (
is responsible for freeing the allocated buffer using FreePool().
If PackageListGuid is NULL, then ASSERT().
- If StringId is 0, then ASSERT.
+ If StringId is 0, then ASSERT().
@param[in] PackageListGuid The GUID of a package list that was previously
registered in the HII Database.
@@ -180,7 +180,7 @@ HiiGetString (
@param[in] Language The language of the string to retrieve. If this
parameter is NULL, then the current platform
language is used. The format of Language must
- follow the language format assumed the HII Database.
+ follow the language format assumed in the HII Database.
@retval NULL The package list specified by PackageListGuid is not present in the
HII Database.
@@ -205,10 +205,10 @@ HiiGetPackageString (
The caller is responsible for freeing the array with FreePool().
@param[in] PackageListGuid An optional parameter that is used to request
- an HII Handle that is associatd with a specific
- Package List GUID. If this parameter is NULL
+ an HII Handle associated with a specific
+ Package List GUID. If this parameter is NULL,
then all the HII Handles in the HII Database
- are returned. If this parameter is not NULL
+ are returned. If this parameter is not NULL,
then at most 1 HII Handle is returned.
@retval NULL No HII handles were found in the HII database
@@ -224,11 +224,11 @@ HiiGetHiiHandles (
;
/**
- Retrieves a pointer to the a Null-terminated ASCII string containing the list
+ Retrieves a pointer to a Null-terminated ASCII string containing the list
of languages that an HII handle in the HII Database supports. The returned
string is allocated using AllocatePool(). The caller is responsible for freeing
the returned string using FreePool(). The format of the returned string follows
- the language format assumed the HII Database.
+ the language format assumed in the HII Database.
If HiiHandle is NULL, then ASSERT().
@@ -251,7 +251,7 @@ HiiGetSupportedLanguages (
/**
Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing
information that includes a GUID, an optional Unicode string name, and a device
- path. The string returned is allocated with AllocatePool(). The caller is
+ path. The string returned is allocated with AllocatePool(). The caller is
responsible for freeing the allocated string with FreePool().
The format of a <ConfigHdr> is as follows:
@@ -287,7 +287,7 @@ HiiConstructConfigHdr (
/**
Reset the default value specified by DefaultId to the driver
- configuration got by Request string.
+ configuration specified by the Request string.
NULL request string support depends on the ExportConfig interface of
HiiConfigRouting protocol in UEFI specification.
@@ -298,8 +298,8 @@ HiiConstructConfigHdr (
entirety of the current HII database will be reset.
@param DefaultId Specifies the type of defaults to retrieve.
- @retval TURE The default value is set successfully.
- @retval FALSE The default value can't be found and set.
+ @retval TURE The default value was set successfully.
+ @retval FALSE The default value was not found.
**/
BOOLEAN
EFIAPI
@@ -309,14 +309,14 @@ HiiSetToDefaults (
);
/**
- Validate the current configuration by parsing HII form IFR opcode.
+ Validate the current configuration by parsing the IFR opcode in HII form.
NULL request string support depends on the ExtractConfig interface of
- HiiConfigRouting protocol in UEFI specification.
+ HiiConfigRouting protocol in the UEFI specification.
@param Request A null-terminated Unicode string in
<MultiConfigRequest> format. It can be NULL.
- If it is NULL, all current configuration for the
+ If it is NULL, all current configurations for the
entirety of the current HII database will be validated.
@retval TURE Current configuration is valid.
@@ -350,7 +350,7 @@ HiiIsConfigHdrMatch (
);
/**
- Retrieves uncommited data from the Form Browser and converts it to a binary
+ Retrieves uncommitted data from the Form Browser and converts it to a binary
buffer.
@param[in] VariableName Pointer to a Null-terminated Unicode string. This
@@ -418,7 +418,7 @@ HiiSetBrowserData (
an EFI_HII_TIME structure in an EFI_IFR_TYPE_VALUE union.
@param Hour The hour value to be encoded.
- @param Minute The miniute value to be encoded.
+ @param Minute The minute value to be encoded.
@param Second The second value to be encoded.
@return A 64-bit containing Hour, Minute, and Second.
@@ -882,14 +882,14 @@ HiiCreateOrderedListOpCode (
comparisons of IFR opcodes are performed from the beginning of the form being
updated until an IFR opcode is found that exactly matches the first IFR opcode
specifed by StartOpCodeHandle. The following rules are used to determine if
- an insert, replace, or delete operation is performed.
+ an insert, replace, or delete operation is performed:
1) If no matches are found, then NULL is returned.
2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes
from StartOpcodeHandle except the first opcode are inserted immediately after
the matching IFR opcode in the form beng updated.
3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made
- from the matching IFR opcode until an IFR opcode exatly matches the first
+ from the matching IFR opcode until an IFR opcode exactly matches the first
IFR opcode specified by EndOpCodeHandle. If no match is found for the first
IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match
is found, then all of the IFR opcodes between the start match and the end
@@ -915,12 +915,12 @@ HiiCreateOrderedListOpCode (
@param[in] EndOpCodeHandle An OpCcode Handle that contains the IFR opcode
that marks the end of a replace operation in
the form. This is an optional parameter that
- may be NULL. If it is NULL, then an the IFR
+ may be NULL. If it is NULL, then the IFR
opcodes specified by StartOpCodeHandle are
inserted into the form.
- @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated.
- @retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory resources are allocated.
+ @retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND:
1) The form specified by HiiHandle, FormSetGuid,
and FormId could not be found in the HII Database.
2) No IFR opcodes in the target form match the first
diff --git a/MdeModulePkg/Include/Library/IpIoLib.h b/MdeModulePkg/Include/Library/IpIoLib.h
index a4fbcfd1a3..daf8c308a1 100644
--- a/MdeModulePkg/Include/Library/IpIoLib.h
+++ b/MdeModulePkg/Include/Library/IpIoLib.h
@@ -1,6 +1,6 @@
/** @file
Ihis library is only intended to be used by UEFI network stack modules.
- It provides IpIo layer upon EFI IP4 Protocol.
+ It provides the IpIo layer on the EFI IP4 Protocol.
Copyright (c) 2005 - 2008, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
@@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Library/NetLib.h>
//
-// type and code define for ICMP protocol error got
+// type and code define for ICMP protocol error
// from IP
//
#define ICMP_TYPE_UNREACH 3
@@ -44,7 +44,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define ICMP_CODE_UNREACH_TOSHOST 12
/**
- Get the IP header length from EFI_IP4_HEADER struct. HeaderLength is
+ Get the IP header length from the struct EFI_IP4_HEADER. HeaderLength is
Internet header length in 32-bit words, so HeaderLength<<2 is the real
length of IP header.
@@ -98,7 +98,7 @@ typedef enum {
} ICMP_ERROR;
///
-/// The helper struct for IpIoGetIcmpErrStatus(). It is internal-use only.
+/// The helper struct for IpIoGetIcmpErrStatus(). It is for internal use only.
///
typedef struct {
BOOLEAN IsHard;
@@ -121,7 +121,7 @@ typedef struct _EFI_NET_SESSION_DATA {
@param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR
@param[in] NetSession The IP session for the received packet
@param[in] Pkt Packet received
- @param[in] Context The data provided by user for the received packet when
+ @param[in] Context The data provided by the user for the received packet when
the callback is registered in IP_IO_OPEN_DATA::RcvdContext.
**/
@@ -155,7 +155,7 @@ VOID
);
///
-/// The data structure wraps Ip4 instance. It is used by IpIo Library to do all
+/// This data structure wraps Ip4 instances. The IpIo Library uses it for all
/// Ip4 operations.
///
typedef struct _IP_IO {
@@ -203,7 +203,7 @@ typedef struct _IP_IO {
} IP_IO;
///
-/// The struct is used for user to pass IP configuration and callbacks to IP_IO.
+/// The struct is for the user to pass IP configuration and callbacks to IP_IO.
/// It is used by IpIoOpen().
///
typedef struct _IP_IO_OPEN_DATA {
@@ -289,8 +289,8 @@ IpIoDestroy (
/**
Stop an IP_IO instance.
- This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all
- the pending send/receive tokens will be canceled.
+ This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all
+ pending send/receive tokens will be canceled.
@param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.
@@ -334,14 +334,14 @@ IpIoOpen (
Send out an IP packet.
This function is called after IpIoOpen(). The data to be sent are wrapped in
- Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
- overriden by Sender. Other sending configs, like source address and gateway
- address etc., are specified in OverrideData.
+ Pkt. The IP instance wrapped in IpIo is used for sending by default, but can be
+ overriden by Sender. Other sending configurations, such as source address and gateway
+ address, are specified in OverrideData.
@param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
packet.
@param[in, out] Pkt Pointer to the IP packet to be sent.
- @param[in] Sender The IP protocol instance used for sending.
+ @param[in] Sender Optional. The IP protocol instance used for sending.
@param[in] Context Optional context data.
@param[in] NotifyData Optional notify data.
@param[in] Dest The destination IP address to send this packet to.
@@ -386,8 +386,8 @@ IpIoCancelTxToken (
can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
data.
- @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP
- instance for sending purpose.
+ @param[in, out] IpIo Pointer to an IP_IO instance to add a new IP
+ instance for sending purposes.
@return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.
@@ -404,14 +404,14 @@ IpIoAddIp (
@param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.
@param[in, out] Ip4ConfigData The IP4 configure data used to configure the IP
- instance, if NULL the IP instance is reset. If
+ instance. If NULL, the IP instance is reset. If
UseDefaultAddress is set to TRUE, and the configure
operation succeeds, the default address information
is written back in this Ip4ConfigData.
- @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully
- or no need to reconfigure it.
- @retval Others Configuration fails.
+ @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully,
+ or there is no need to reconfigure it.
+ @retval Others Configuration failed.
**/
EFI_STATUS
@@ -442,7 +442,7 @@ IpIoRemoveIp (
/**
Find the first IP protocol maintained in IpIo whose local
- address is the same with Src.
+ address is the same as Src.
This function is called when the caller needs the IpIo to send data to the
specified Src. The IpIo was added previously by IpIoAddIp().
diff --git a/MdeModulePkg/Include/Library/MemoryTestLib.h b/MdeModulePkg/Include/Library/MemoryTestLib.h
index 12c043c193..39d96d7682 100644
--- a/MdeModulePkg/Include/Library/MemoryTestLib.h
+++ b/MdeModulePkg/Include/Library/MemoryTestLib.h
@@ -26,8 +26,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@param Length Length of the memory range to test.
@param ErrorAddress Address of the memory where error is encountered.
- @retval RETURN_SUCCESS The memory range passes test.
- @retval RETURN_DEVICE_ERROR The memory range does not pass test.
+ @retval RETURN_SUCCESS The memory range passed the test.
+ @retval RETURN_DEVICE_ERROR The memory range failed the test.
**/
RETURN_STATUS
@@ -39,7 +39,7 @@ QuickMemoryTest (
);
/**
- Test a system memory range with sparsely sampled memory units.
+ Tests a system memory range with sparsely sampled memory units.
This function tests a system memory range, whose memory units
are sampled sparsely. It leads to relatively good performance
@@ -49,8 +49,8 @@ QuickMemoryTest (
@param Length Length of the memory range to test.
@param ErrorAddress Address of the memory where error is encountered.
- @retval RETURN_SUCCESS The memory range passes test.
- @retval RETURN_DEVICE_ERROR The memory range does not pass test.
+ @retval RETURN_SUCCESS The memory range passed the test.
+ @retval RETURN_DEVICE_ERROR The memory range failed the test.
**/
RETURN_STATUS
@@ -64,7 +64,7 @@ SparseMemoryTest (
/**
Test a system memory range with extensively sampled memory units.
- This function tests a system memory range, whose memory units
+ This function tests a system memory range whose memory units
are sampled extensively. Compared with SparseMemoryTest, it achieves
more reliability and less performance.
@@ -72,8 +72,8 @@ SparseMemoryTest (
@param Length Length of the memory range to test.
@param ErrorAddress Address of the memory where error is encountered.
- @retval RETURN_SUCCESS The memory range passes test.
- @retval RETURN_DEVICE_ERROR The memory range does not pass test.
+ @retval RETURN_SUCCESS The memory range passed the test.
+ @retval RETURN_DEVICE_ERROR The memory range failed the test.
**/
RETURN_STATUS
diff --git a/MdeModulePkg/Include/Library/NetLib.h b/MdeModulePkg/Include/Library/NetLib.h
index b057cbd2ce..c1519fea23 100644
--- a/MdeModulePkg/Include/Library/NetLib.h
+++ b/MdeModulePkg/Include/Library/NetLib.h
@@ -1,6 +1,6 @@
/** @file
Ihis library is only intended to be used by UEFI network stack modules.
- It provides basic function for UEFI network stack.
+ It provides basic functions for the UEFI network stack.
Copyright (c) 2005 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -76,7 +76,7 @@ typedef struct {
//
-// ICMP head definition. ICMP message is categoried as either an error
+// ICMP head definition. Each ICMP message is categorized as either an error
// message or query message. Two message types have their own head format.
//
typedef struct {
@@ -163,13 +163,13 @@ typedef struct {
/**
Return the length of the mask.
- Return the length of the mask, the correct value is from 0 to 32.
+ Return the length of the mask. Valid values are 0 to 32.
If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
NetMask is in the host byte order.
@param[in] NetMask The netmask to get the length from.
- @return The length of the netmask, IP4_MASK_NUM if the mask is invalid.
+ @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
**/
INTN
@@ -211,13 +211,13 @@ NetGetIpClass (
If Ip is 0, IP is not a valid unicast address.
Class D address is used for multicasting and class E address is reserved for future. If Ip
- belongs to class D or class E, IP is not a valid unicast address.
- If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address.
+ belongs to class D or class E, Ip is not a valid unicast address.
+ If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
@param[in] Ip The IP to check against.
@param[in] NetMask The mask of the IP.
- @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
+ @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
**/
BOOLEAN
@@ -245,7 +245,7 @@ extern EFI_IPv4_ADDRESS mZeroIp4Addr;
/**
Extract a UINT32 from a byte stream.
- Copy a UINT32 from a byte stream, then converts it from Network
+ This function copies a UINT32 from a byte stream, and then converts it from Network
byte order to host byte order. Use this function to avoid alignment error.
@param[in] Buf The buffer to extract the UINT32.
@@ -260,9 +260,9 @@ NetGetUint32 (
);
/**
- Put a UINT32 to the byte stream in network byte order.
+ Puts a UINT32 into the byte stream in network byte order.
- Converts a UINT32 from host byte order to network byte order. Then copy it to the
+ Converts a UINT32 from host byte order to network byte order, and then copies it to the
byte stream.
@param[in, out] Buf The buffer to put the UINT32.
@@ -280,10 +280,10 @@ NetPutUint32 (
Initialize a random seed using current time.
Get current time first. Then initialize a random seed based on some basic
- mathematics operation on the hour, day, minute, second, nanosecond and year
+ mathematical operations on the hour, day, minute, second, nanosecond and year
of the current time.
- @return The random seed initialized with current time.
+ @return The random seed, initialized with current time.
**/
UINT32
@@ -300,13 +300,13 @@ NetRandomInitSeed (
CR(Entry, Type, Field, Sig)
//
-// Iterate through the doule linked list. It is NOT delete safe
+// Iterate through the double linked list. It is NOT delete safe
//
#define NET_LIST_FOR_EACH(Entry, ListHead) \
for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
//
-// Iterate through the doule linked list. This is delete-safe.
+// Iterate through the double linked list. This is delete-safe.
// Don't touch NextEntry. Also, don't use this macro if list
// entries other than the Entry may be deleted when processing
// the current Entry.
@@ -318,7 +318,7 @@ NetRandomInitSeed (
)
//
-// Make sure the list isn't empty before get the frist/last record.
+// Make sure the list isn't empty before getting the first/last record.
//
#define NET_LIST_HEAD(ListHead, Type, Field) \
NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
@@ -330,8 +330,8 @@ NetRandomInitSeed (
/**
Remove the first node entry on the list, and return the removed node entry.
- Removes the first node Entry from a doubly linked list. It is up to the caller of
- this function to release the memory used by the first node if that is required. On
+ Removes the first node entry from a doubly linked list. It is up to the caller of
+ this function to release the memory used by the first node, if that is required. On
exit, the removed node is returned.
If Head is NULL, then ASSERT().
@@ -352,10 +352,10 @@ NetListRemoveHead (
);
/**
- Remove the last node entry on the list and and return the removed node entry.
+ Remove the last node entry on the list and return the removed node entry.
Removes the last node entry from a doubly linked list. It is up to the caller of
- this function to release the memory used by the first node if that is required. On
+ this function to release the memory used by the first node, if that is required. On
exit, the removed node is returned.
If Head is NULL, then ASSERT().
@@ -378,10 +378,10 @@ NetListRemoveTail (
/**
Insert a new node entry after a designated node entry of a doubly linked list.
- Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry
+ Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
of the doubly linked list.
- @param[in, out] PrevEntry The previous entry to insert after.
+ @param[in, out] PrevEntry The entry after which to insert.
@param[in, out] NewEntry The new entry to insert.
**/
@@ -395,7 +395,7 @@ NetListInsertAfter (
/**
Insert a new node entry before a designated node entry of a doubly linked list.
- Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry
+ Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
of the doubly linked list.
@param[in, out] PostEntry The entry to insert before.
@@ -451,9 +451,9 @@ NetMapInit (
/**
To clean up the netmap, that is, release allocated memories.
- Removes all nodes of the Used doubly linked list and free memory of all related netmap items.
+ Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
- The number of the <Key, Value> pairs in the netmap is set to be zero.
+ The number of the <Key, Value> pairs in the netmap is set to zero.
If Map is NULL, then ASSERT().
@@ -550,7 +550,7 @@ NetMapInsertTail (
);
/**
- Find the key in the netmap and returns the point to the item contains the Key.
+ Finds the key in the netmap and returns the point to the item containing the Key.
Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
item with the key to search. It returns the point to the item contains the Key if found.
@@ -695,9 +695,9 @@ NetMapIterate (
@param[in] Controller The controller which has the service installed.
@param[in] Image The image handle used to open service.
@param[in] ServiceBindingGuid The service's Guid.
- @param[in, out] ChildHandle The handle to receive the create child.
+ @param[in, out] ChildHandle The handle to receive the created child.
- @retval EFI_SUCCESS The child is successfully created.
+ @retval EFI_SUCCESS The child was successfully created.
@retval Others Failed to create the child.
**/
@@ -711,7 +711,7 @@ NetLibCreateServiceChild (
);
/**
- Destory a child of the service that is identified by ServiceBindingGuid.
+ Destroy a child of the service that is identified by ServiceBindingGuid.
Get the ServiceBinding Protocol first, then use it to destroy a child.
@@ -720,10 +720,10 @@ NetLibCreateServiceChild (
@param[in] Controller The controller which has the service installed.
@param[in] Image The image handle used to open service.
@param[in] ServiceBindingGuid The service's Guid.
- @param[in] ChildHandle The child to destory.
+ @param[in] ChildHandle The child to destroy.
- @retval EFI_SUCCESS The child is successfully destoried.
- @retval Others Failed to destory the child.
+ @retval EFI_SUCCESS The child is successfully destroyed.
+ @retval Others Failed to destroy the child.
**/
EFI_STATUS
@@ -742,18 +742,18 @@ NetLibDestroyServiceChild (
Get the mac address of the Simple Network protocol from the SnpHandle. Then convert
the mac address into a unicode string. It takes 2 unicode characters to represent
- a 1 byte binary buffer. Plus one unicode character for the null-terminator.
+ a 1 byte binary buffer, plus one unicode character for the null terminator.
- @param[in] SnpHandle The handle where the simple network protocol is
- installed on.
- @param[in] ImageHandle The image handle used to act as the agent handle to
+ @param[in] SnpHandle The handle on which the simple network protocol is
+ installed.
+ @param[in] ImageHandle The image handle to act as the agent handle to
get the simple network protocol.
@param[out] MacString The pointer to store the address of the string
representation of the mac address.
- @retval EFI_SUCCESS Convert the mac address a unicode string successfully.
- @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.
+ @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
+ @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
@retval Others Failed to open the simple network protocol.
**/
@@ -799,8 +799,8 @@ NetLibCreateIPv4DPathNode (
/**
Find the UNDI/SNP handle from controller and protocol GUID.
- For example, IP will open a MNP child to transmit/receive
- packets, when MNP is stopped, IP should also be stopped. IP
+ For example, IP will open an MNP child to transmit/receive
+ packets. When MNP is stopped, IP should also be stopped. IP
needs to find its own private data which is related the IP's
service binding instance that is install on UNDI/SNP handle.
Now, the controller is either a MNP or ARP child handle. But
@@ -926,8 +926,8 @@ typedef struct {
} NET_VECTOR;
//
-//NET_BLOCK_OP operate on the NET_BLOCK, It specifies
-//where the actual fragment begins and where it ends
+//NET_BLOCK_OP operates on the NET_BLOCK. It specifies
+//where the actual fragment begins and ends
//
typedef struct {
UINT8 *BlockHead; // Block's head, or the smallest valid Head
@@ -940,13 +940,12 @@ typedef struct {
//
//NET_BUF is the buffer manage structure used by the
-//network stack. Every network packet may be fragmented,
-//and contains multiple fragments. The Vector points to
-//memory blocks used by the each fragment, and BlockOp
+//network stack. Every network packet may be fragmented. The Vector points to
+//memory blocks used by each fragment, and BlockOp
//specifies where each fragment begins and ends.
//
-//It also contains a opaque area for protocol to store
-//per-packet informations. Protocol must be caution not
+//It also contains an opaque area for the protocol to store
+//per-packet information. Protocol must be careful not
//to overwrite the members after that.
//
typedef struct {
@@ -967,7 +966,7 @@ typedef struct {
//
-//A queue of NET_BUFs, It is just a thin extension of
+//A queue of NET_BUFs. It is a thin extension of
//NET_BUF functions.
//
typedef struct {
@@ -1043,8 +1042,8 @@ NetbufAlloc (
Decrease the reference count of the net buffer by one. Free the associated net
vector and itself if the reference count of the net buffer is decreased to 0.
- The net vector free operation just decrease the reference count of the net
- vector by one and do the real resource free operation when the reference count
+ The net vector free operation decreases the reference count of the net
+ vector by one, and performs the resource free operation when the reference count
of the net vector is 0.
@param[in] Nbuf Pointer to the NET_BUF to be freed.
@@ -1060,8 +1059,8 @@ NetbufFree (
Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
buffer.
- This can be used to, for example, retrieve the IP header in the packet. It
- also can be used to get the fragment that contains the byte which is used
+ For example, this function can be used to retrieve the IP header in the packet. It
+ also can be used to get the fragment that contains the byte used
mainly by the library implementation itself.
@param[in] Nbuf Pointer to the net buffer.
@@ -1152,7 +1151,7 @@ NetbufGetFragment (
/**
Reserve some space in the header room of the net buffer.
- Upon allocation, all the space are in the tail room of the buffer. Call this
+ Upon allocation, all the space is in the tail room of the buffer. Call this
function to move some space to the header room. This function is quite limited
in that it can only reserve space from the first block of an empty NET_BUF not
built from the external. But it should be enough for the network stack.
@@ -1196,8 +1195,8 @@ NetbufAllocSpace (
@param[in] FromHead The flag to indicate whether trim data from head
(TRUE) or tail (FALSE).
- @return Length of the actually trimmed data, which is possible to be less
- than Len because the TotalSize of Nbuf is less than Len.
+ @return Length of the actually trimmed data, which may be less
+ than Len if the TotalSize of Nbuf is less than Len.
**/
UINT32
@@ -1212,7 +1211,7 @@ NetbufTrim (
Copy Len bytes of data from the specific offset of the net buffer to the
destination memory.
- The Len bytes of data may cross the several fragments of the net buffer.
+ The Len bytes of data may cross several fragments of the net buffer.
@param[in] Nbuf Pointer to the net buffer.
@param[in] Offset The sequence number of the first byte to copy.
@@ -1235,17 +1234,17 @@ NetbufCopy (
/**
Build a NET_BUF from external blocks.
- A new NET_BUF structure will be created from external blocks. Additional block
+ A new NET_BUF structure will be created from external blocks. An additional block
of memory will be allocated to hold reserved HeadSpace bytes of header room
- and existing HeadLen bytes of header but the external blocks are shared by the
+ and existing HeadLen bytes of header, but the external blocks are shared by the
net buffer to avoid data copying.
@param[in] ExtFragment Pointer to the data block.
@param[in] ExtNum The number of the data blocks.
@param[in] HeadSpace The head space to be reserved.
- @param[in] HeadLen The length of the protocol header, This function
- will pull that number of data into a linear block.
- @param[in] ExtFree Pointer to the caller provided free function.
+ @param[in] HeadLen The length of the protocol header. The function
+ pulls this amount of data into a linear block.
+ @param[in] ExtFree Pointer to the caller-provided free function.
@param[in] Arg The argument passed to ExtFree when ExtFree is
called.
@@ -1273,7 +1272,7 @@ NetbufFromExt (
@param[in, out] ExtFragment Pointer to the data block.
@param[in, out] ExtNum The number of the data blocks.
- @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than
+ @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
ExtNum.
@retval EFI_SUCCESS Fragment table is built successfully.
@@ -1294,8 +1293,8 @@ NetbufBuildExt (
@param[in] BufList A List of the net buffer.
@param[in] HeadSpace The head space to be reserved.
- @param[in] HeaderLen The length of the protocol header, This function
- will pull that number of data into a linear block.
+ @param[in] HeaderLen The length of the protocol header. The function
+ pulls this amount of data into a linear block.
@param[in] ExtFree Pointer to the caller provided free function.
@param[in] Arg The argument passed to ExtFree when ExtFree is called.
@@ -1421,8 +1420,8 @@ NetbufQueCopy (
);
/**
- Trim Len bytes of data from the queue header, release any of the net buffer
- whom is trimmed wholely.
+ Trim Len bytes of data from the queue header and release any net buffer
+ that is trimmed wholely.
The trimming operation is the same as NetbufTrim but applies to the net buffer
queue instead of the net buffer.
diff --git a/MdeModulePkg/Include/Library/RecoveryLib.h b/MdeModulePkg/Include/Library/RecoveryLib.h
index a724c9ed28..484ff76c3a 100644
--- a/MdeModulePkg/Include/Library/RecoveryLib.h
+++ b/MdeModulePkg/Include/Library/RecoveryLib.h
@@ -16,10 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define __RECOVERY_LIB_H__
/**
- Calling this function causes the system do recovery boot path.
+ Calling this function causes the system to carry out a recovery boot path.
- @retval EFI_SUCESS Sucess to do recovery.
- @retval Others Fail to do recovery.
+ @retval EFI_SUCESS Sucess.
+ @retval Others Failure.
**/
EFI_STATUS
diff --git a/MdeModulePkg/Include/Library/ResetSystemLib.h b/MdeModulePkg/Include/Library/ResetSystemLib.h
index fd92135d7a..f77c441ad5 100644
--- a/MdeModulePkg/Include/Library/ResetSystemLib.h
+++ b/MdeModulePkg/Include/Library/ResetSystemLib.h
@@ -1,6 +1,6 @@
/** @file
System reset Library Services. This library class defines a set of
- methods to reset whole system.
+ methods that reset the whole system.
Copyright (c) 2005 - 2007, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -17,13 +17,12 @@
#define __RESET_SYSTEM_LIB_H__
/**
- Calling this function causes a system-wide reset. This sets
- all circuitry within the system to its initial state. This type of reset
+ This function causes a system-wide reset (cold reset), in which
+ all circuitry within the system returns to its initial state. This type of reset
is asynchronous to system operation and operates without regard to
cycle boundaries.
- System reset should not return, if it returns, it means the system does
- not support cold reset.
+ If this function returns, it means that the system does not support cold reset.
**/
VOID
EFIAPI
@@ -32,11 +31,10 @@ ResetCold (
);
/**
- Calling this function causes a system-wide initialization. The processors
- are set to their initial state, and pending cycles are not corrupted.
+ This function causes a system-wide initialization (warm reset), in which all processors
+ are set to their initial state. Pending cycles are not corrupted.
- System reset should not return, if it returns, it means the system does
- not support warm reset.
+ If this function returns, it means that the system does not support warm reset.
**/
VOID
EFIAPI
@@ -45,10 +43,10 @@ ResetWarm (
);
/**
- Calling this function causes the system to enter a power state equivalent
+ This function causes the system to enter a power state equivalent
to the ACPI G2/S5 or G3 states.
- System shutdown should not return, if it returns, it means the system does
+ If this function returns, it means the system does
not support shut down reset.
**/
VOID
@@ -58,11 +56,11 @@ ResetShutdown (
);
/**
- Calling this function causes the system to enter S3 and then
+ This function causes the system to enter S3 and then
wake up immediately.
- Reset update should not return, if it returns, it means the
- library does not the feature.
+ If this function returns, it means the
+ system does not support the feature.
**/
VOID
EFIAPI
diff --git a/MdeModulePkg/Include/Library/S3Lib.h b/MdeModulePkg/Include/Library/S3Lib.h
index c8fa22aaba..f97b6b5460 100644
--- a/MdeModulePkg/Include/Library/S3Lib.h
+++ b/MdeModulePkg/Include/Library/S3Lib.h
@@ -1,5 +1,5 @@
/** @file
- S3 library class defines a set of methods related do S3 boot mode.
+ S3 library class defines a set of methods related to S3 boot mode.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -18,8 +18,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
This function is responsible for calling the S3 resume vector in the ACPI Tables.
- @retval EFI_SUCESS Sucess to restore config from S3.
- @retval Others Fail to restore config from S3.
+ @retval EFI_SUCESS Successfully restored config from S3.
+ @retval Others Failed to restore config from S3.
**/
EFI_STATUS
diff --git a/MdeModulePkg/Include/Library/UdpIoLib.h b/MdeModulePkg/Include/Library/UdpIoLib.h
index 8d6b11940c..30a46fab04 100644
--- a/MdeModulePkg/Include/Library/UdpIoLib.h
+++ b/MdeModulePkg/Include/Library/UdpIoLib.h
@@ -1,5 +1,5 @@
/** @file
- Ihis library is only intended to be used by UEFI network stack modules.
+ This library is used to share code between UEFI network stack modules.
It provides the helper routines to access UDP service. It is used by both DHCP and MTFTP.
Copyright (c) 2006 - 2008, Intel Corporation.<BR>
@@ -42,12 +42,12 @@ typedef struct {
} UDP_POINTS;
/**
- Prototype called when receiving or sending packets from/to a UDP point.
+ Prototype called when receiving or sending packets to or from a UDP point.
This prototype is used by both receive and sending when calling
- UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by
- UDP access point, and released by user. When sending, the NetBuf is from user,
- and provided to the callback as a reference.
+ UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the
+ UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then
+ provided to the callback as a reference.
@param[in] Packet Packet received or sent
@param[in] Points The Udp4 address pair corresponds to the Udp4 IO
@@ -65,7 +65,7 @@ VOID
);
///
-/// This structure is used internally by UdpIo Library.
+/// This structure is used internally by the UdpIo Library.
///
/// Each receive request is wrapped in an UDP_RX_TOKEN. Upon completion,
/// the CallBack will be called. Only one receive request is sent to UDP at a
@@ -87,7 +87,7 @@ typedef struct {
/// This structure is used internally by UdpIo Library.
///
/// Each transmit request is wrapped in an UDP_TX_TOKEN. Upon completion,
-/// the CallBack will be called. There can be several transmit requests and they
+/// the CallBack will be called. There can be several transmit requests. All transmit requests
/// are linked in a list.
///
typedef struct {
@@ -109,8 +109,8 @@ typedef struct {
///
/// Type defined as UDP_IO_PORT.
///
-/// The data structure wraps Udp4 instance and its configuration. It is used by
-/// UdpIo Library to do all Udp4 operations.
+/// This data structure wraps the Udp4 instance and configuration.
+/// UdpIo Library uses this structure for all Udp4 operations.
///
struct _UDP_IO_PORT {
UINT32 Signature;
@@ -140,7 +140,7 @@ struct _UDP_IO_PORT {
@param[in] UdpIo The UDP_IO_PORT to configure
@param[in] Context User-defined data when calling UdpIoCreatePort()
- @retval EFI_SUCCESS The configure process succeeds
+ @retval EFI_SUCCESS The configuration succeeded
@retval Others The UDP_IO_PORT fails to configure indicating
UdpIoCreatePort() should fail
**/
@@ -157,7 +157,7 @@ EFI_STATUS
@param[in] Token The UDP_TX_TOKEN to decide whether to cancel
@param[in] Context User-defined data in UdpIoCancelDgrams()
- @retval TRUE To cancel the UDP_TX_TOKEN
+ @retval TRUE Cancel the UDP_TX_TOKEN
@retval FALSE Do not cancel this UDP_TX_TOKEN
**/
@@ -169,13 +169,12 @@ BOOLEAN
);
/**
- Cancel all the sent datagram that pass the selection criteria of ToCancel.
+ Cancel all sent datagrams selected by the parameter ToCancel.
If ToCancel is NULL, all the datagrams are cancelled.
@param[in] UdpIo The UDP_IO_PORT to cancel packet.
@param[in] IoStatus The IoStatus to return to the packet owners.
- @param[in] ToCancel The select funtion to test whether to cancel this
- packet or not.
+ @param[in] ToCancel Sets the criteria for canceling a packet.
@param[in] Context The opaque parameter to the ToCancel.
**/
@@ -189,14 +188,14 @@ UdpIoCancelDgrams (
);
/**
- Create a UDP_IO_PORT to access the UDP service. It will create and configure
+ Creates a UDP_IO_PORT to access the UDP service. It creates and configures
a UDP child.
- The function will locate the UDP service binding prototype on the Controller
- parameter and use it to create a UDP child (aka Udp instance). Then the UDP
- child will be configured by calling Configure function prototype. Any failures
- in creating or configure the UDP child will lead to the failure of UDP_IO_PORT
- creation.
+ This function:
+ # locates the UDP service binding prototype on the Controller parameter
+ # uses the UDP service binding prototype to create a UDP child (also known as a UDP instance)
+ # configures the UDP child by calling Configure function prototype.
+ Any failures in creating or configuring the UDP child return NULL for failure.
@param[in] Controller The controller that has the UDP service binding.
protocol installed.
@@ -219,7 +218,7 @@ UdpIoCreatePort (
/**
Free the UDP_IO_PORT and all its related resources.
- The function will cancel all sent datagram and receive request.
+ The function cancels all sent datagrams and receive requests.
@param[in] UdpIo The UDP_IO_PORT to free.
@@ -233,11 +232,10 @@ UdpIoFreePort (
);
/**
- Clean up the UDP_IO_PORT without freeing it. The function is called when
- user wants to re-use the UDP_IO_PORT later.
+ Cleans up the UDP_IO_PORT without freeing it. Call this function
+ if you intend to later re-use the UDP_IO_PORT.
- It will release all the transmitted datagrams and receive request. It will
- also configure NULL for the UDP instance.
+ This function releases all transmitted datagrams and receive requests and configures NULL for the UDP instance.
@param[in] UdpIo The UDP_IO_PORT to clean up.
@@ -249,15 +247,15 @@ UdpIoCleanPort (
);
/**
- Send a packet through the UDP_IO_PORT.
+ Sends a packet through the UDP_IO_PORT.
- The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called
- when the packet is sent. The optional parameter EndPoint overrides the default
- address pair if specified.
+ The packet will be wrapped in UDP_TX_TOKEN. The function specific in the CallBack parameter will be called
+ when the packet is sent. If specified, the optional parameter EndPoint overrides the default
+ address pair.
@param[in] UdpIo The UDP_IO_PORT to send the packet through.
@param[in] Packet The packet to send.
- @param[in] EndPoint The local and remote access point. Override the
+ @param[in] EndPoint The local and remote access point. Overrides the
default address pair set during configuration.
@param[in] Gateway The gateway to use.
@param[in] CallBack The function being called when packet is
@@ -283,7 +281,7 @@ UdpIoSendDatagram (
/**
Cancel a single sent datagram.
- @param[in] UdpIo The UDP_IO_PORT to cancel the packet from
+ @param[in] UdpIo The UDP_IO_PORT from which to cancel the packet
@param[in] Packet The packet to cancel
**/
@@ -298,7 +296,7 @@ UdpIoCancelSentDatagram (
Issue a receive request to the UDP_IO_PORT.
This function is called when upper-layer needs packet from UDP for processing.
- Only one receive request is acceptable at a time so a common usage model is
+ Only one receive request is acceptable at a time. Therefore, one common usage model is
to invoke this function inside its Callback function when the former packet
is processed.
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-08 09:31:41 +0000