/** @file\r
- This file defines capsule vendor guid for capsule variable and hob.\r
- It also defines capsule variable name and capsule guid hob data structure,\r
- which can be used to store the capsule image start address and length.\r
+ This file defines:\r
+ * the capsule vendor GUID for capsule variables and the HOB\r
+ * the capsule variable name\r
+ * the capsule GUID HOB data structure.\r
+ The capsule HOB and variable can be used to store the capsule image start address and length.\r
They are used by EDKII implementation of capsule update across a system reset.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
/** @file\r
- This guid is used to specify the device is the console in device.\r
- If the device is the console in device, this guid as the protocol guid\r
- will be installed into this device handle.\r
+ This GUID can be installed to the device handle to specify that the device is the console-in device.\r
+ \r
\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
- This guid is used to specify the device is the console out device.\r
- If the device is the console out device, this guid as the protocol guid\r
- will be installed into this device handle.\r
+ This GUID can be installed to the device handle to specify that the device is the console-out device.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
\r
This file defines a group of guids to specify the different \r
- encapsulation scheme for the guided section.\r
+ encapsulation scheme for the GUIDed section.\r
\r
- Now, only one guid is defined for CRC32 encapsulation scheme.\r
+ Only one GUID is defined for the CRC32 encapsulation scheme.\r
\r
Copyright (c) 2006 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
#define __CRC32_GUIDED_SECTION_EXTRACTION_H__\r
\r
//\r
-// GUID definition. Each GUIDed section extraction protocol has the\r
-// same interface but with different GUID. All the GUIDs is defined here.\r
-// May add more GUIDs here in future.\r
+// GUID definition. All GUIDed section extraction protocols share the\r
+// same interface, but each has a different GUID. All the GUIDs are defined here.\r
//\r
#define EFI_CRC32_GUIDED_SECTION_EXTRACTION_GUID \\r
{ 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }\r
{ 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 } }\r
\r
///\r
-/// Two extended opcode are added, new extension can be added here later.\r
+/// Two extended opcodes are added, and new extensions can be added here later.\r
/// One is for framework OneOf question Option Key value,\r
/// Another is for framework vareqval.\r
///\r
/** @file\r
- This file defines the memory type information guid for its variable and guid. \r
- It also defines memory type info variable name and data structure for variable and hob both,\r
+ This file defines the memory type information GUID for its variable and guid. \r
+ It also defines memory type info variable name and data structure for both variable and hob,\r
which can be used to store the information for each memory type in EFI variable or HOB.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
\r
//\r
// The following structures are used by drivers/applications other\r
-// than EFI_IP4_PROTOCOL, such as ifconfig shell application, to\r
-// communicate the IP configuration information to EFI_IP4_CONFIG_PROTOCOL.\r
-// EFI_IP4_CONFIG_PROTOCOL in turn is used by EFI_IP4_PROTOCOL to get\r
-// the default IP4 configuration. ifconfig can't use the EFI_IP4_PROTOCOL\r
-// because it don't know how to configure the default IP address even\r
-// it has got the address.\r
+// than EFI_IP4_PROTOCOL, such as the ifconfig shell application, to\r
+// communicate the IP configuration information to the EFI_IP4_CONFIG_PROTOCOL.\r
+// The EFI_IP4_PROTOCOL uses the EFI_IP4_CONFIG_PROTOCOL to get\r
+// the default IP4 configuration.\r
//\r
\r
///\r
/** @file\r
- This file defines performance related definitions: the format of performance\r
- GUID HOB, performance protocol interfaces and performance variable format. \r
+ This file defines performance-related definitions, including the format of:\r
+ * performance GUID HOB\r
+ * performance protocol interfaces\r
+ * performance variables. \r
\r
Copyright (c) 2009, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
// The header must be aligned at 8 bytes\r
//\r
typedef struct {\r
- UINT32 NumberOfEntries; ///> The number of all performance guage entries\r
+ UINT32 NumberOfEntries; ///> The number of all performance gauge entries\r
UINT32 Reserved;\r
} GAUGE_DATA_HEADER;\r
\r
Adds a record at the end of the performance measurement log\r
that records the start time of a performance measurement.\r
\r
- Adds a record to the end of the performance measurement log\r
- that contains the Handle, Token, and Module.\r
- The end time of the new record must be set to zero.\r
+ The added record contains the Handle, Token, and Module.\r
+ The end time of the new record is not recorded, so it is set to zero.\r
If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r
If TimeStamp is zero, the start time in the record is filled in with the value\r
read from the current time stamp.\r
\r
@param LogEntryKey The key for the previous performance measurement log entry.\r
If 0, then the first performance measurement log entry is retrieved.\r
- @param GaugeDataEntry The indirect pointer to the gauge data entry specified by LogEntryKey\r
- if the retrieval is successful.\r
-\r
+ @param GaugeDataEntry Out parameter for the indirect pointer to the gauge data entry specified by LogEntryKey.\r
+ \r
@retval EFI_SUCCESS The GuageDataEntry is successfully found based on LogEntryKey.\r
- @retval EFI_NOT_FOUND The LogEntryKey is the last entry (equals to the total entry number).\r
- @retval EFI_INVALIDE_PARAMETER The LogEntryKey is not a valid entry (greater than the total entry number).\r
- @retval EFI_INVALIDE_PARAMETER GaugeDataEntry is NULL.\r
+ @retval EFI_NOT_FOUND There is no entry after the measurement referred to by LogEntryKey.\r
+ @retval EFI_INVALID_PARAMETER The LogEntryKey is not a valid entry, or GaugeDataEntry is NULL.\r
\r
**/\r
typedef\r
/** @file\r
- This guid is used to specify the device is the StdErr device.\r
- If the device is the StdErr device, this guid as the protocol guid\r
- will be installed into this device handle.\r
+ This GUID is installed to the device handler to specify that the device is StdErr device.\r
+ \r
\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
- The variable data structures are related to EDK II specific UEFI variable implementation.\r
- Variable data header and Variable storage region header are defined here.\r
+ The variable data structures are related to EDK II-specific implementation of UEFI variables.\r
+ VariableFormat.h defines variable data headers and variable storage region headers.\r
\r
Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
extern EFI_GUID gEfiVariableGuid;\r
\r
///\r
-/// Alignment of variable name and data.\r
-/// For IA32/X64 architecture, the alignment is set to 1, and 8 is for IPF archtecture.\r
+/// Alignment of variable name and data, according to the architecture:\r
+/// * For IA-32 and Intel(R) 64 architectures: 1\r
+/// * For IA-64 architecture: 8\r
///\r
#if defined (MDE_CPU_IPF)\r
#define ALIGNMENT 8\r
#endif\r
\r
//\r
-// GET_PAD_SIZE to calculate miminal pad bytes to make current size satisfy the alignment requirement\r
+// GET_PAD_SIZE calculates the miminal pad bytes needed to make the current pad size satisfy the alignment requirement.\r
//\r
#if (ALIGNMENT == 1)\r
#define GET_PAD_SIZE(a) (0)\r
///\r
/// Variable State flags\r
///\r
-#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transistion\r
+#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transition\r
#define VAR_DELETED 0xfd ///< Variable is obsolete\r
#define VAR_HEADER_VALID_ONLY 0x7f ///< Variable header has been valid\r
#define VAR_ADDED 0x3f ///< Variable has been completely added\r
///\r
UINT32 Attributes;\r
///\r
- /// Size of variable Null-terminated Unicode string name\r
+ /// Size of variable null-terminated Unicode string name\r
///\r
UINT32 NameSize;\r
///\r
///\r
UINT32 DataSize;\r
///\r
- /// A unique identifier for the vendor that produce and consume this varaible.\r
+ /// A unique identifier for the vendor that produces and consumes this varaible.\r
///\r
EFI_GUID VendorGuid;\r
} VARIABLE_HEADER;\r
\r
///\r
/// This structure contains the variable list that is put in EFI system table.\r
-/// The variable driver collects all used variables at boot service time and produce this list.\r
+/// The variable driver collects all variables that were used at boot service time and produces this list.\r
/// This is an optional feature to dump all used variables in shell environment. \r
///\r
struct _VARIABLE_INFO_ENTRY {\r
EFI_GUID VendorGuid; ///> Guid of Variable \r
CHAR16 *Name; ///> Name of Variable \r
UINT32 Attributes; ///> Attributes of variable defined in UEFI spec\r
- UINT32 ReadCount; ///> Times to read this variable\r
- UINT32 WriteCount; ///> Times to write this variable\r
- UINT32 DeleteCount; ///> Times to delete this variable\r
- UINT32 CacheCount; ///> Times that cache hits this variable\r
- BOOLEAN Volatile; ///> TRUE if volatile FALSE if non-volatile\r
+ UINT32 ReadCount; ///> Number of times to read this variable\r
+ UINT32 WriteCount; ///> Number of times to write this variable\r
+ UINT32 DeleteCount; ///> Number of times to delete this variable\r
+ UINT32 CacheCount; ///> Number of times that cache hits this variable\r
+ BOOLEAN Volatile; ///> TRUE if volatile, FALSE if non-volatile\r
};\r
\r
#endif // _EFI_VARIABLE_H_\r
/** @file\r
\r
- This library class defines a set of interfaces on how to process capusle image update.\r
+ This library class defines a set of interfaces for how to process capsule image updates.\r
\r
Copyright (c) 2007 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
);\r
\r
/**\r
- The firmware specific implementation processes the capsule image\r
+ The firmware-specific implementation processes the capsule image\r
if it recognized the format of this capsule image.\r
\r
@param CapsuleHeader Point to the UEFI capsule image to be processed. \r
\r
- @retval EFI_SUCESS Process Capsule Image successfully. \r
+ @retval EFI_SUCESS Capsule Image was processed successfully. \r
@retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.\r
**/\r
EFI_STATUS\r
/**\r
Add a Deferred Procedure Call to the end of the DPC queue.\r
\r
- @param[in] DpcTpl The EFI_TPL that the DPC should be invoked.\r
+ @param[in] DpcTpl The EFI_TPL that the DPC should invoke.\r
@param[in] DpcProcedure Pointer to the DPC's function.\r
@param[in] DpcContext Pointer to the DPC's context. Passed to DpcProcedure\r
when DpcProcedure is invoked.\r
);\r
\r
/**\r
- Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl\r
+ Dispatch the queue of DPCs. All DPCs that have been queued with a DpcTpl\r
value greater than or equal to the current TPL are invoked in the order that\r
they were queued. DPCs with higher DpcTpl values are invoked before DPCs with\r
lower DpcTpl values.\r
of packages is passed in, then NULL is returned. If the size of the list of \r
package is 0, then NULL is returned.\r
\r
- The variable arguments are pointers which point to package header that defined \r
+ The variable arguments are pointers that point to package headers defined \r
by UEFI VFR compiler and StringGather tool.\r
\r
#pragma pack (push, 1)\r
/**\r
Removes a package list from the HII database.\r
\r
- If HiiHandle is NULL, then ASSERT.\r
- If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT.\r
+ If HiiHandle is NULL, then ASSERT().\r
+ If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT().\r
\r
@param[in] HiiHandle The handle that was previously registered in the HII database\r
\r
;\r
\r
/**\r
- This function create a new string in String Package or updates an existing \r
+ This function creates a new string in String Package or updates an existing \r
string in a String Package. If StringId is 0, then a new string is added to\r
a String Package. If StringId is not zero, then a string in String Package is\r
updated. If SupportedLanguages is NULL, then the string is added or updated\r
@param[in] StringId If zero, then a new string is created in the \r
String Package associated with HiiHandle. If \r
non-zero, then the string specified by StringId \r
- is updated in the String Package associated \r
+ is updated in the String Package associated \r
with HiiHandle. \r
@param[in] String A pointer to the Null-terminated Unicode string \r
to add or update in the String Package associated \r
String is added or updated in the String Package \r
associated with HiiHandle for all the languages \r
that the String Package supports. If this \r
- parameter is not NULL, then then String is added \r
+ parameter is not NULL, then String is added \r
or updated in the String Package associated with \r
- HiiHandle for the set oflanguages specified by \r
+ HiiHandle for the set of languages specified by \r
SupportedLanguages. The format of \r
SupportedLanguages must follow the language \r
- format assumed the HII Database.\r
+ format assumed in the HII Database.\r
\r
@retval 0 The string could not be added or updated in the String Package.\r
@retval Other The EFI_STRING_ID of the newly added or updated string.\r
for freeing the allocated buffer using FreePool().\r
\r
If HiiHandle is NULL, then ASSERT().\r
- If StringId is 0, then ASSET.\r
+ If StringId is 0, then ASSERT().\r
\r
@param[in] HiiHandle A handle that was previously registered in the HII Database.\r
@param[in] StringId The identifier of the string to retrieved from the string \r
package associated with HiiHandle.\r
@param[in] Language The language of the string to retrieve. If this parameter \r
is NULL, then the current platform language is used. The \r
- format of Language must follow the language format assumed \r
+ format of Language must follow the language format assumed in\r
the HII Database.\r
\r
@retval NULL The string specified by StringId is not present in the string package.\r
;\r
\r
/**\r
- Retrieves a string from a string package names by GUID in a specific language. \r
+ Retrieves a string from a string package named by GUID, in the specified language. \r
If the language is not specified, then a string from a string package in the \r
current platform language is retrieved. If the string can not be retrieved \r
using the specified language or the current platform language, then the string \r
is responsible for freeing the allocated buffer using FreePool().\r
\r
If PackageListGuid is NULL, then ASSERT().\r
- If StringId is 0, then ASSERT.\r
+ If StringId is 0, then ASSERT().\r
\r
@param[in] PackageListGuid The GUID of a package list that was previously \r
registered in the HII Database.\r
@param[in] Language The language of the string to retrieve. If this \r
parameter is NULL, then the current platform \r
language is used. The format of Language must \r
- follow the language format assumed the HII Database.\r
+ follow the language format assumed in the HII Database.\r
\r
@retval NULL The package list specified by PackageListGuid is not present in the\r
HII Database.\r
The caller is responsible for freeing the array with FreePool().\r
\r
@param[in] PackageListGuid An optional parameter that is used to request \r
- an HII Handle that is associatd with a specific\r
- Package List GUID. If this parameter is NULL\r
+ an HII Handle associated with a specific\r
+ Package List GUID. If this parameter is NULL,\r
then all the HII Handles in the HII Database\r
- are returned. If this parameter is not NULL\r
+ are returned. If this parameter is not NULL,\r
then at most 1 HII Handle is returned.\r
\r
@retval NULL No HII handles were found in the HII database\r
;\r
\r
/**\r
- Retrieves a pointer to the a Null-terminated ASCII string containing the list \r
+ Retrieves a pointer to a Null-terminated ASCII string containing the list \r
of languages that an HII handle in the HII Database supports. The returned \r
string is allocated using AllocatePool(). The caller is responsible for freeing\r
the returned string using FreePool(). The format of the returned string follows\r
- the language format assumed the HII Database.\r
+ the language format assumed in the HII Database.\r
\r
If HiiHandle is NULL, then ASSERT().\r
\r
/**\r
Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing \r
information that includes a GUID, an optional Unicode string name, and a device\r
- path. The string returned is allocated with AllocatePool(). The caller is \r
+ path. The string returned is allocated with AllocatePool(). The caller is \r
responsible for freeing the allocated string with FreePool().\r
\r
The format of a <ConfigHdr> is as follows:\r
\r
/**\r
Reset the default value specified by DefaultId to the driver\r
- configuration got by Request string. \r
+ configuration specified by the Request string. \r
\r
NULL request string support depends on the ExportConfig interface of\r
HiiConfigRouting protocol in UEFI specification.\r
entirety of the current HII database will be reset.\r
@param DefaultId Specifies the type of defaults to retrieve.\r
\r
- @retval TURE The default value is set successfully.\r
- @retval FALSE The default value can't be found and set.\r
+ @retval TURE The default value was set successfully.\r
+ @retval FALSE The default value was not found.\r
**/\r
BOOLEAN\r
EFIAPI \r
);\r
\r
/**\r
- Validate the current configuration by parsing HII form IFR opcode.\r
+ Validate the current configuration by parsing the IFR opcode in HII form.\r
\r
NULL request string support depends on the ExtractConfig interface of\r
- HiiConfigRouting protocol in UEFI specification.\r
+ HiiConfigRouting protocol in the UEFI specification.\r
\r
@param Request A null-terminated Unicode string in \r
<MultiConfigRequest> format. It can be NULL.\r
- If it is NULL, all current configuration for the\r
+ If it is NULL, all current configurations for the\r
entirety of the current HII database will be validated.\r
\r
@retval TURE Current configuration is valid.\r
);\r
\r
/**\r
- Retrieves uncommited data from the Form Browser and converts it to a binary\r
+ Retrieves uncommitted data from the Form Browser and converts it to a binary\r
buffer.\r
\r
@param[in] VariableName Pointer to a Null-terminated Unicode string. This \r
an EFI_HII_TIME structure in an EFI_IFR_TYPE_VALUE union.\r
\r
@param Hour The hour value to be encoded.\r
- @param Minute The miniute value to be encoded.\r
+ @param Minute The minute value to be encoded.\r
@param Second The second value to be encoded.\r
\r
@return A 64-bit containing Hour, Minute, and Second.\r
comparisons of IFR opcodes are performed from the beginning of the form being \r
updated until an IFR opcode is found that exactly matches the first IFR opcode \r
specifed by StartOpCodeHandle. The following rules are used to determine if\r
- an insert, replace, or delete operation is performed.\r
+ an insert, replace, or delete operation is performed:\r
\r
1) If no matches are found, then NULL is returned. \r
2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes\r
from StartOpcodeHandle except the first opcode are inserted immediately after \r
the matching IFR opcode in the form beng updated.\r
3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made \r
- from the matching IFR opcode until an IFR opcode exatly matches the first \r
+ from the matching IFR opcode until an IFR opcode exactly matches the first \r
IFR opcode specified by EndOpCodeHandle. If no match is found for the first\r
IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match\r
is found, then all of the IFR opcodes between the start match and the end \r
@param[in] EndOpCodeHandle An OpCcode Handle that contains the IFR opcode\r
that marks the end of a replace operation in\r
the form. This is an optional parameter that\r
- may be NULL. If it is NULL, then an the IFR\r
+ may be NULL. If it is NULL, then the IFR\r
opcodes specified by StartOpCodeHandle are \r
inserted into the form.\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated.\r
- @retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough memory resources are allocated.\r
+ @retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND:\r
1) The form specified by HiiHandle, FormSetGuid, \r
and FormId could not be found in the HII Database.\r
2) No IFR opcodes in the target form match the first\r
/** @file\r
Ihis library is only intended to be used by UEFI network stack modules.\r
- It provides IpIo layer upon EFI IP4 Protocol.\r
+ It provides the IpIo layer on the EFI IP4 Protocol.\r
\r
Copyright (c) 2005 - 2008, Intel Corporation.<BR>\r
All rights reserved. This program and the accompanying materials\r
#include <Library/NetLib.h>\r
\r
//\r
-// type and code define for ICMP protocol error got\r
+// type and code define for ICMP protocol error \r
// from IP\r
//\r
#define ICMP_TYPE_UNREACH 3\r
#define ICMP_CODE_UNREACH_TOSHOST 12\r
\r
/**\r
- Get the IP header length from EFI_IP4_HEADER struct. HeaderLength is\r
+ Get the IP header length from the struct EFI_IP4_HEADER. HeaderLength is\r
Internet header length in 32-bit words, so HeaderLength<<2 is the real\r
length of IP header.\r
\r
} ICMP_ERROR;\r
\r
///\r
-/// The helper struct for IpIoGetIcmpErrStatus(). It is internal-use only.\r
+/// The helper struct for IpIoGetIcmpErrStatus(). It is for internal use only.\r
///\r
typedef struct {\r
BOOLEAN IsHard;\r
@param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR\r
@param[in] NetSession The IP session for the received packet\r
@param[in] Pkt Packet received\r
- @param[in] Context The data provided by user for the received packet when\r
+ @param[in] Context The data provided by the user for the received packet when\r
the callback is registered in IP_IO_OPEN_DATA::RcvdContext.\r
\r
**/\r
);\r
\r
///\r
-/// The data structure wraps Ip4 instance. It is used by IpIo Library to do all\r
+/// This data structure wraps Ip4 instances. The IpIo Library uses it for all\r
/// Ip4 operations.\r
///\r
typedef struct _IP_IO {\r
} IP_IO;\r
\r
///\r
-/// The struct is used for user to pass IP configuration and callbacks to IP_IO.\r
+/// The struct is for the user to pass IP configuration and callbacks to IP_IO.\r
/// It is used by IpIoOpen().\r
///\r
typedef struct _IP_IO_OPEN_DATA {\r
/**\r
Stop an IP_IO instance.\r
\r
- This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all\r
- the pending send/receive tokens will be canceled.\r
+ This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all\r
+ pending send/receive tokens will be canceled.\r
\r
@param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.\r
\r
Send out an IP packet.\r
\r
This function is called after IpIoOpen(). The data to be sent are wrapped in\r
- Pkt. The IP instance wrapped in IpIo is used for sending by default but can be\r
- overriden by Sender. Other sending configs, like source address and gateway\r
- address etc., are specified in OverrideData.\r
+ Pkt. The IP instance wrapped in IpIo is used for sending by default, but can be\r
+ overriden by Sender. Other sending configurations, such as source address and gateway\r
+ address, are specified in OverrideData.\r
\r
@param[in, out] IpIo Pointer to an IP_IO instance used for sending IP\r
packet.\r
@param[in, out] Pkt Pointer to the IP packet to be sent.\r
- @param[in] Sender The IP protocol instance used for sending.\r
+ @param[in] Sender Optional. The IP protocol instance used for sending.\r
@param[in] Context Optional context data.\r
@param[in] NotifyData Optional notify data.\r
@param[in] Dest The destination IP address to send this packet to.\r
can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send\r
data.\r
\r
- @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP\r
- instance for sending purpose.\r
+ @param[in, out] IpIo Pointer to an IP_IO instance to add a new IP\r
+ instance for sending purposes.\r
\r
@return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.\r
\r
\r
@param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.\r
@param[in, out] Ip4ConfigData The IP4 configure data used to configure the IP\r
- instance, if NULL the IP instance is reset. If\r
+ instance. If NULL, the IP instance is reset. If\r
UseDefaultAddress is set to TRUE, and the configure\r
operation succeeds, the default address information\r
is written back in this Ip4ConfigData.\r
\r
- @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully\r
- or no need to reconfigure it.\r
- @retval Others Configuration fails.\r
+ @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully,\r
+ or there is no need to reconfigure it.\r
+ @retval Others Configuration failed.\r
\r
**/\r
EFI_STATUS\r
\r
/**\r
Find the first IP protocol maintained in IpIo whose local\r
- address is the same with Src.\r
+ address is the same as Src.\r
\r
This function is called when the caller needs the IpIo to send data to the\r
specified Src. The IpIo was added previously by IpIoAddIp().\r
@param Length Length of the memory range to test.\r
@param ErrorAddress Address of the memory where error is encountered.\r
\r
- @retval RETURN_SUCCESS The memory range passes test.\r
- @retval RETURN_DEVICE_ERROR The memory range does not pass test.\r
+ @retval RETURN_SUCCESS The memory range passed the test.\r
+ @retval RETURN_DEVICE_ERROR The memory range failed the test.\r
\r
**/\r
RETURN_STATUS\r
);\r
\r
/**\r
- Test a system memory range with sparsely sampled memory units.\r
+ Tests a system memory range with sparsely sampled memory units.\r
\r
This function tests a system memory range, whose memory units\r
are sampled sparsely. It leads to relatively good performance\r
@param Length Length of the memory range to test.\r
@param ErrorAddress Address of the memory where error is encountered.\r
\r
- @retval RETURN_SUCCESS The memory range passes test.\r
- @retval RETURN_DEVICE_ERROR The memory range does not pass test.\r
+ @retval RETURN_SUCCESS The memory range passed the test.\r
+ @retval RETURN_DEVICE_ERROR The memory range failed the test.\r
\r
**/\r
RETURN_STATUS\r
/**\r
Test a system memory range with extensively sampled memory units.\r
\r
- This function tests a system memory range, whose memory units\r
+ This function tests a system memory range whose memory units\r
are sampled extensively. Compared with SparseMemoryTest, it achieves\r
more reliability and less performance.\r
\r
@param Length Length of the memory range to test.\r
@param ErrorAddress Address of the memory where error is encountered.\r
\r
- @retval RETURN_SUCCESS The memory range passes test.\r
- @retval RETURN_DEVICE_ERROR The memory range does not pass test.\r
+ @retval RETURN_SUCCESS The memory range passed the test.\r
+ @retval RETURN_DEVICE_ERROR The memory range failed the test.\r
\r
**/\r
RETURN_STATUS\r
/** @file\r
Ihis library is only intended to be used by UEFI network stack modules.\r
- It provides basic function for UEFI network stack.\r
+ It provides basic functions for the UEFI network stack.\r
\r
Copyright (c) 2005 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
\r
\r
//\r
-// ICMP head definition. ICMP message is categoried as either an error\r
+// ICMP head definition. Each ICMP message is categorized as either an error\r
// message or query message. Two message types have their own head format.\r
//\r
typedef struct {\r
/**\r
Return the length of the mask. \r
\r
- Return the length of the mask, the correct value is from 0 to 32.\r
+ Return the length of the mask. Valid values are 0 to 32.\r
If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.\r
NetMask is in the host byte order.\r
\r
@param[in] NetMask The netmask to get the length from.\r
\r
- @return The length of the netmask, IP4_MASK_NUM if the mask is invalid.\r
+ @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.\r
\r
**/\r
INTN\r
\r
If Ip is 0, IP is not a valid unicast address.\r
Class D address is used for multicasting and class E address is reserved for future. If Ip\r
- belongs to class D or class E, IP is not a valid unicast address. \r
- If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address.\r
+ belongs to class D or class E, Ip is not a valid unicast address. \r
+ If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.\r
\r
@param[in] Ip The IP to check against.\r
@param[in] NetMask The mask of the IP.\r
\r
- @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.\r
+ @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.\r
\r
**/\r
BOOLEAN\r
/**\r
Extract a UINT32 from a byte stream.\r
\r
- Copy a UINT32 from a byte stream, then converts it from Network \r
+ This function copies a UINT32 from a byte stream, and then converts it from Network \r
byte order to host byte order. Use this function to avoid alignment error.\r
\r
@param[in] Buf The buffer to extract the UINT32.\r
);\r
\r
/**\r
- Put a UINT32 to the byte stream in network byte order. \r
+ Puts a UINT32 into the byte stream in network byte order. \r
\r
- Converts a UINT32 from host byte order to network byte order. Then copy it to the \r
+ Converts a UINT32 from host byte order to network byte order, and then copies it to the \r
byte stream.\r
\r
@param[in, out] Buf The buffer to put the UINT32.\r
Initialize a random seed using current time.\r
\r
Get current time first. Then initialize a random seed based on some basic \r
- mathematics operation on the hour, day, minute, second, nanosecond and year \r
+ mathematical operations on the hour, day, minute, second, nanosecond and year \r
of the current time.\r
\r
- @return The random seed initialized with current time.\r
+ @return The random seed, initialized with current time.\r
\r
**/\r
UINT32\r
CR(Entry, Type, Field, Sig)\r
\r
//\r
-// Iterate through the doule linked list. It is NOT delete safe\r
+// Iterate through the double linked list. It is NOT delete safe\r
//\r
#define NET_LIST_FOR_EACH(Entry, ListHead) \\r
for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)\r
\r
//\r
-// Iterate through the doule linked list. This is delete-safe.\r
+// Iterate through the double linked list. This is delete-safe.\r
// Don't touch NextEntry. Also, don't use this macro if list\r
// entries other than the Entry may be deleted when processing\r
// the current Entry.\r
)\r
\r
//\r
-// Make sure the list isn't empty before get the frist/last record.\r
+// Make sure the list isn't empty before getting the first/last record.\r
//\r
#define NET_LIST_HEAD(ListHead, Type, Field) \\r
NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)\r
/**\r
Remove the first node entry on the list, and return the removed node entry.\r
\r
- Removes the first node Entry from a doubly linked list. It is up to the caller of\r
- this function to release the memory used by the first node if that is required. On\r
+ Removes the first node entry from a doubly linked list. It is up to the caller of\r
+ this function to release the memory used by the first node, if that is required. On\r
exit, the removed node is returned. \r
\r
If Head is NULL, then ASSERT().\r
);\r
\r
/**\r
- Remove the last node entry on the list and and return the removed node entry.\r
+ Remove the last node entry on the list and return the removed node entry.\r
\r
Removes the last node entry from a doubly linked list. It is up to the caller of\r
- this function to release the memory used by the first node if that is required. On\r
+ this function to release the memory used by the first node, if that is required. On\r
exit, the removed node is returned. \r
\r
If Head is NULL, then ASSERT().\r
/**\r
Insert a new node entry after a designated node entry of a doubly linked list.\r
\r
- Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry\r
+ Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry\r
of the doubly linked list.\r
\r
- @param[in, out] PrevEntry The previous entry to insert after.\r
+ @param[in, out] PrevEntry The entry after which to insert. \r
@param[in, out] NewEntry The new entry to insert.\r
\r
**/\r
/**\r
Insert a new node entry before a designated node entry of a doubly linked list.\r
\r
- Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry\r
+ Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry\r
of the doubly linked list.\r
\r
@param[in, out] PostEntry The entry to insert before.\r
/**\r
To clean up the netmap, that is, release allocated memories.\r
\r
- Removes all nodes of the Used doubly linked list and free memory of all related netmap items.\r
+ Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.\r
Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.\r
- The number of the <Key, Value> pairs in the netmap is set to be zero.\r
+ The number of the <Key, Value> pairs in the netmap is set to zero.\r
\r
If Map is NULL, then ASSERT().\r
\r
);\r
\r
/**\r
- Find the key in the netmap and returns the point to the item contains the Key.\r
+ Finds the key in the netmap and returns the point to the item containing the Key.\r
\r
Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every \r
item with the key to search. It returns the point to the item contains the Key if found.\r
@param[in] Controller The controller which has the service installed.\r
@param[in] Image The image handle used to open service.\r
@param[in] ServiceBindingGuid The service's Guid.\r
- @param[in, out] ChildHandle The handle to receive the create child.\r
+ @param[in, out] ChildHandle The handle to receive the created child.\r
\r
- @retval EFI_SUCCESS The child is successfully created.\r
+ @retval EFI_SUCCESS The child was successfully created.\r
@retval Others Failed to create the child.\r
\r
**/\r
);\r
\r
/**\r
- Destory a child of the service that is identified by ServiceBindingGuid.\r
+ Destroy a child of the service that is identified by ServiceBindingGuid.\r
\r
Get the ServiceBinding Protocol first, then use it to destroy a child.\r
\r
@param[in] Controller The controller which has the service installed.\r
@param[in] Image The image handle used to open service.\r
@param[in] ServiceBindingGuid The service's Guid.\r
- @param[in] ChildHandle The child to destory.\r
+ @param[in] ChildHandle The child to destroy.\r
\r
- @retval EFI_SUCCESS The child is successfully destoried.\r
- @retval Others Failed to destory the child.\r
+ @retval EFI_SUCCESS The child is successfully destroyed.\r
+ @retval Others Failed to destroy the child.\r
\r
**/\r
EFI_STATUS\r
\r
Get the mac address of the Simple Network protocol from the SnpHandle. Then convert\r
the mac address into a unicode string. It takes 2 unicode characters to represent \r
- a 1 byte binary buffer. Plus one unicode character for the null-terminator.\r
+ a 1 byte binary buffer, plus one unicode character for the null terminator.\r
\r
\r
- @param[in] SnpHandle The handle where the simple network protocol is\r
- installed on.\r
- @param[in] ImageHandle The image handle used to act as the agent handle to\r
+ @param[in] SnpHandle The handle on which the simple network protocol is\r
+ installed.\r
+ @param[in] ImageHandle The image handle to act as the agent handle to\r
get the simple network protocol.\r
@param[out] MacString The pointer to store the address of the string\r
representation of the mac address.\r
\r
- @retval EFI_SUCCESS Convert the mac address a unicode string successfully.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.\r
+ @retval EFI_SUCCESS Converted the mac address a unicode string successfully.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.\r
@retval Others Failed to open the simple network protocol.\r
\r
**/\r
/**\r
Find the UNDI/SNP handle from controller and protocol GUID.\r
\r
- For example, IP will open a MNP child to transmit/receive\r
- packets, when MNP is stopped, IP should also be stopped. IP\r
+ For example, IP will open an MNP child to transmit/receive\r
+ packets. When MNP is stopped, IP should also be stopped. IP\r
needs to find its own private data which is related the IP's\r
service binding instance that is install on UNDI/SNP handle.\r
Now, the controller is either a MNP or ARP child handle. But\r
} NET_VECTOR;\r
\r
//\r
-//NET_BLOCK_OP operate on the NET_BLOCK, It specifies\r
-//where the actual fragment begins and where it ends\r
+//NET_BLOCK_OP operates on the NET_BLOCK. It specifies\r
+//where the actual fragment begins and ends\r
//\r
typedef struct {\r
UINT8 *BlockHead; // Block's head, or the smallest valid Head\r
\r
//\r
//NET_BUF is the buffer manage structure used by the\r
-//network stack. Every network packet may be fragmented,\r
-//and contains multiple fragments. The Vector points to\r
-//memory blocks used by the each fragment, and BlockOp\r
+//network stack. Every network packet may be fragmented. The Vector points to\r
+//memory blocks used by each fragment, and BlockOp\r
//specifies where each fragment begins and ends.\r
//\r
-//It also contains a opaque area for protocol to store\r
-//per-packet informations. Protocol must be caution not\r
+//It also contains an opaque area for the protocol to store\r
+//per-packet information. Protocol must be careful not\r
//to overwrite the members after that.\r
//\r
typedef struct {\r
\r
\r
//\r
-//A queue of NET_BUFs, It is just a thin extension of\r
+//A queue of NET_BUFs. It is a thin extension of\r
//NET_BUF functions.\r
//\r
typedef struct {\r
\r
Decrease the reference count of the net buffer by one. Free the associated net\r
vector and itself if the reference count of the net buffer is decreased to 0. \r
- The net vector free operation just decrease the reference count of the net \r
- vector by one and do the real resource free operation when the reference count\r
+ The net vector free operation decreases the reference count of the net \r
+ vector by one, and performs the resource free operation when the reference count\r
of the net vector is 0. \r
\r
@param[in] Nbuf Pointer to the NET_BUF to be freed.\r
Get the index of NET_BLOCK_OP that contains the byte at Offset in the net \r
buffer. \r
\r
- This can be used to, for example, retrieve the IP header in the packet. It \r
- also can be used to get the fragment that contains the byte which is used \r
+ For example, this function can be used to retrieve the IP header in the packet. It \r
+ also can be used to get the fragment that contains the byte used \r
mainly by the library implementation itself. \r
\r
@param[in] Nbuf Pointer to the net buffer.\r
/**\r
Reserve some space in the header room of the net buffer.\r
\r
- Upon allocation, all the space are in the tail room of the buffer. Call this \r
+ Upon allocation, all the space is in the tail room of the buffer. Call this \r
function to move some space to the header room. This function is quite limited\r
in that it can only reserve space from the first block of an empty NET_BUF not \r
built from the external. But it should be enough for the network stack. \r
@param[in] FromHead The flag to indicate whether trim data from head \r
(TRUE) or tail (FALSE).\r
\r
- @return Length of the actually trimmed data, which is possible to be less \r
- than Len because the TotalSize of Nbuf is less than Len.\r
+ @return Length of the actually trimmed data, which may be less \r
+ than Len if the TotalSize of Nbuf is less than Len.\r
\r
**/\r
UINT32\r
Copy Len bytes of data from the specific offset of the net buffer to the \r
destination memory.\r
\r
- The Len bytes of data may cross the several fragments of the net buffer.\r
+ The Len bytes of data may cross several fragments of the net buffer.\r
\r
@param[in] Nbuf Pointer to the net buffer.\r
@param[in] Offset The sequence number of the first byte to copy.\r
/**\r
Build a NET_BUF from external blocks. \r
\r
- A new NET_BUF structure will be created from external blocks. Additional block\r
+ A new NET_BUF structure will be created from external blocks. An additional block\r
of memory will be allocated to hold reserved HeadSpace bytes of header room\r
- and existing HeadLen bytes of header but the external blocks are shared by the\r
+ and existing HeadLen bytes of header, but the external blocks are shared by the\r
net buffer to avoid data copying.\r
\r
@param[in] ExtFragment Pointer to the data block.\r
@param[in] ExtNum The number of the data blocks.\r
@param[in] HeadSpace The head space to be reserved.\r
- @param[in] HeadLen The length of the protocol header, This function\r
- will pull that number of data into a linear block.\r
- @param[in] ExtFree Pointer to the caller provided free function.\r
+ @param[in] HeadLen The length of the protocol header. The function\r
+ pulls this amount of data into a linear block.\r
+ @param[in] ExtFree Pointer to the caller-provided free function.\r
@param[in] Arg The argument passed to ExtFree when ExtFree is\r
called.\r
\r
@param[in, out] ExtFragment Pointer to the data block.\r
@param[in, out] ExtNum The number of the data blocks.\r
\r
- @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than \r
+ @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than \r
ExtNum.\r
@retval EFI_SUCCESS Fragment table is built successfully.\r
\r
\r
@param[in] BufList A List of the net buffer.\r
@param[in] HeadSpace The head space to be reserved.\r
- @param[in] HeaderLen The length of the protocol header, This function\r
- will pull that number of data into a linear block.\r
+ @param[in] HeaderLen The length of the protocol header. The function\r
+ pulls this amount of data into a linear block.\r
@param[in] ExtFree Pointer to the caller provided free function.\r
@param[in] Arg The argument passed to ExtFree when ExtFree is called.\r
\r
);\r
\r
/**\r
- Trim Len bytes of data from the queue header, release any of the net buffer \r
- whom is trimmed wholely.\r
+ Trim Len bytes of data from the queue header and release any net buffer \r
+ that is trimmed wholely.\r
\r
The trimming operation is the same as NetbufTrim but applies to the net buffer\r
queue instead of the net buffer.\r
#define __RECOVERY_LIB_H__\r
\r
/**\r
- Calling this function causes the system do recovery boot path.\r
+ Calling this function causes the system to carry out a recovery boot path.\r
\r
- @retval EFI_SUCESS Sucess to do recovery.\r
- @retval Others Fail to do recovery.\r
+ @retval EFI_SUCESS Sucess.\r
+ @retval Others Failure.\r
\r
**/\r
EFI_STATUS\r
/** @file\r
System reset Library Services. This library class defines a set of\r
- methods to reset whole system.\r
+ methods that reset the whole system.\r
\r
Copyright (c) 2005 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
#define __RESET_SYSTEM_LIB_H__\r
\r
/**\r
- Calling this function causes a system-wide reset. This sets\r
- all circuitry within the system to its initial state. This type of reset \r
+ This function causes a system-wide reset (cold reset), in which\r
+ all circuitry within the system returns to its initial state. This type of reset \r
is asynchronous to system operation and operates without regard to \r
cycle boundaries.\r
\r
- System reset should not return, if it returns, it means the system does \r
- not support cold reset.\r
+ If this function returns, it means that the system does not support cold reset. \r
**/\r
VOID\r
EFIAPI\r
);\r
\r
/**\r
- Calling this function causes a system-wide initialization. The processors \r
- are set to their initial state, and pending cycles are not corrupted.\r
+ This function causes a system-wide initialization (warm reset), in which all processors \r
+ are set to their initial state. Pending cycles are not corrupted.\r
\r
- System reset should not return, if it returns, it means the system does \r
- not support warm reset.\r
+ If this function returns, it means that the system does not support warm reset.\r
**/\r
VOID\r
EFIAPI\r
);\r
\r
/**\r
- Calling this function causes the system to enter a power state equivalent \r
+ This function causes the system to enter a power state equivalent \r
to the ACPI G2/S5 or G3 states.\r
\r
- System shutdown should not return, if it returns, it means the system does \r
+ If this function returns, it means the system does \r
not support shut down reset.\r
**/\r
VOID\r
);\r
\r
/**\r
- Calling this function causes the system to enter S3 and then\r
+ This function causes the system to enter S3 and then\r
wake up immediately.\r
\r
- Reset update should not return, if it returns, it means the\r
- library does not the feature.\r
+ If this function returns, it means the\r
+ system does not support the feature.\r
**/\r
VOID\r
EFIAPI\r
/** @file\r
- S3 library class defines a set of methods related do S3 boot mode.\r
+ S3 library class defines a set of methods related to S3 boot mode.\r
\r
Copyright (c) 2005 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
/**\r
This function is responsible for calling the S3 resume vector in the ACPI Tables.\r
\r
- @retval EFI_SUCESS Sucess to restore config from S3.\r
- @retval Others Fail to restore config from S3.\r
+ @retval EFI_SUCESS Successfully restored config from S3.\r
+ @retval Others Failed to restore config from S3.\r
\r
**/\r
EFI_STATUS\r
/** @file\r
- Ihis library is only intended to be used by UEFI network stack modules.\r
+ This library is used to share code between UEFI network stack modules.\r
It provides the helper routines to access UDP service. It is used by both DHCP and MTFTP.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation.<BR>\r
} UDP_POINTS;\r
\r
/**\r
- Prototype called when receiving or sending packets from/to a UDP point.\r
+ Prototype called when receiving or sending packets to or from a UDP point.\r
\r
This prototype is used by both receive and sending when calling\r
- UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by\r
- UDP access point, and released by user. When sending, the NetBuf is from user,\r
- and provided to the callback as a reference.\r
+ UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the\r
+ UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then\r
+ provided to the callback as a reference.\r
\r
@param[in] Packet Packet received or sent\r
@param[in] Points The Udp4 address pair corresponds to the Udp4 IO\r
);\r
\r
///\r
-/// This structure is used internally by UdpIo Library.\r
+/// This structure is used internally by the UdpIo Library.\r
///\r
/// Each receive request is wrapped in an UDP_RX_TOKEN. Upon completion,\r
/// the CallBack will be called. Only one receive request is sent to UDP at a\r
/// This structure is used internally by UdpIo Library.\r
///\r
/// Each transmit request is wrapped in an UDP_TX_TOKEN. Upon completion,\r
-/// the CallBack will be called. There can be several transmit requests and they\r
+/// the CallBack will be called. There can be several transmit requests. All transmit requests\r
/// are linked in a list.\r
///\r
typedef struct {\r
///\r
/// Type defined as UDP_IO_PORT.\r
///\r
-/// The data structure wraps Udp4 instance and its configuration. It is used by\r
-/// UdpIo Library to do all Udp4 operations.\r
+/// This data structure wraps the Udp4 instance and configuration. \r
+/// UdpIo Library uses this structure for all Udp4 operations.\r
///\r
struct _UDP_IO_PORT {\r
UINT32 Signature;\r
@param[in] UdpIo The UDP_IO_PORT to configure\r
@param[in] Context User-defined data when calling UdpIoCreatePort()\r
\r
- @retval EFI_SUCCESS The configure process succeeds\r
+ @retval EFI_SUCCESS The configuration succeeded\r
@retval Others The UDP_IO_PORT fails to configure indicating\r
UdpIoCreatePort() should fail\r
**/\r
@param[in] Token The UDP_TX_TOKEN to decide whether to cancel\r
@param[in] Context User-defined data in UdpIoCancelDgrams()\r
\r
- @retval TRUE To cancel the UDP_TX_TOKEN\r
+ @retval TRUE Cancel the UDP_TX_TOKEN\r
@retval FALSE Do not cancel this UDP_TX_TOKEN\r
\r
**/\r
);\r
\r
/**\r
- Cancel all the sent datagram that pass the selection criteria of ToCancel.\r
+ Cancel all sent datagrams selected by the parameter ToCancel.\r
If ToCancel is NULL, all the datagrams are cancelled.\r
\r
@param[in] UdpIo The UDP_IO_PORT to cancel packet.\r
@param[in] IoStatus The IoStatus to return to the packet owners.\r
- @param[in] ToCancel The select funtion to test whether to cancel this\r
- packet or not.\r
+ @param[in] ToCancel Sets the criteria for canceling a packet. \r
@param[in] Context The opaque parameter to the ToCancel.\r
\r
**/\r
);\r
\r
/**\r
- Create a UDP_IO_PORT to access the UDP service. It will create and configure\r
+ Creates a UDP_IO_PORT to access the UDP service. It creates and configures\r
a UDP child.\r
\r
- The function will locate the UDP service binding prototype on the Controller\r
- parameter and use it to create a UDP child (aka Udp instance). Then the UDP\r
- child will be configured by calling Configure function prototype. Any failures\r
- in creating or configure the UDP child will lead to the failure of UDP_IO_PORT\r
- creation.\r
+ This function:\r
+ # locates the UDP service binding prototype on the Controller parameter\r
+ # uses the UDP service binding prototype to create a UDP child (also known as a UDP instance)\r
+ # configures the UDP child by calling Configure function prototype. \r
+ Any failures in creating or configuring the UDP child return NULL for failure. \r
\r
@param[in] Controller The controller that has the UDP service binding.\r
protocol installed.\r
/**\r
Free the UDP_IO_PORT and all its related resources.\r
\r
- The function will cancel all sent datagram and receive request.\r
+ The function cancels all sent datagrams and receive requests.\r
\r
@param[in] UdpIo The UDP_IO_PORT to free.\r
\r
);\r
\r
/**\r
- Clean up the UDP_IO_PORT without freeing it. The function is called when\r
- user wants to re-use the UDP_IO_PORT later.\r
+ Cleans up the UDP_IO_PORT without freeing it. Call this function \r
+ if you intend to later re-use the UDP_IO_PORT.\r
\r
- It will release all the transmitted datagrams and receive request. It will\r
- also configure NULL for the UDP instance.\r
+ This function releases all transmitted datagrams and receive requests and configures NULL for the UDP instance.\r
\r
@param[in] UdpIo The UDP_IO_PORT to clean up.\r
\r
);\r
\r
/**\r
- Send a packet through the UDP_IO_PORT.\r
+ Sends a packet through the UDP_IO_PORT.\r
\r
- The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called\r
- when the packet is sent. The optional parameter EndPoint overrides the default\r
- address pair if specified.\r
+ The packet will be wrapped in UDP_TX_TOKEN. The function specific in the CallBack parameter will be called\r
+ when the packet is sent. If specified, the optional parameter EndPoint overrides the default\r
+ address pair.\r
\r
@param[in] UdpIo The UDP_IO_PORT to send the packet through.\r
@param[in] Packet The packet to send.\r
- @param[in] EndPoint The local and remote access point. Override the\r
+ @param[in] EndPoint The local and remote access point. Overrides the\r
default address pair set during configuration.\r
@param[in] Gateway The gateway to use.\r
@param[in] CallBack The function being called when packet is\r
/**\r
Cancel a single sent datagram.\r
\r
- @param[in] UdpIo The UDP_IO_PORT to cancel the packet from\r
+ @param[in] UdpIo The UDP_IO_PORT from which to cancel the packet \r
@param[in] Packet The packet to cancel\r
\r
**/\r
Issue a receive request to the UDP_IO_PORT.\r
\r
This function is called when upper-layer needs packet from UDP for processing.\r
- Only one receive request is acceptable at a time so a common usage model is\r
+ Only one receive request is acceptable at a time. Therefore, one common usage model is\r
to invoke this function inside its Callback function when the former packet\r
is processed.\r
\r
Add a Deferred Procedure Call to the end of the DPC queue.\r
\r
@param This Protocol instance pointer.\r
- @param DpcTpl The EFI_TPL that the DPC should be invoked.\r
+ @param DpcTpl The EFI_TPL that the DPC should invoke.\r
@param DpcProcedure Pointer to the DPC's function.\r
@param DpcContext Pointer to the DPC's context. Passed to DpcProcedure\r
when DpcProcedure is invoked.\r
);\r
\r
/**\r
- Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl\r
- value greater than or equal to the current TPL are invoked in the order that\r
- they were queued. DPCs with higher DpcTpl values are invoked before DPCs with\r
- lower DpcTpl values.\r
+ Dispatch the queue of DPCs. \r
+ \r
+ DPCs with DpcTpl value greater than the current TPL value are queued, and then DPCs\r
+ with DpcTpl value lower than the current TPL value are queued. All DPCs in the first group (higher DpcTpl values) \r
+ are invoked before DPCs in the second group (lower DpcTpl values). \r
\r
@param This Protocol instance pointer.\r
\r
/** @file\r
-Fault Tolerant Write protocol provides boot-time service to do fault tolerant \r
+Fault Tolerant Write protocol provides boot-time service for fault tolerant \r
write capability for block devices. The protocol provides for non-volatile \r
-intermediate storage of the data and private information a caller would need to \r
-recover from a critical fault, such as power failure. \r
+storage of the intermediate data and private information a caller would need to \r
+recover from a critical fault, such as a power failure. \r
\r
Copyright (c) 2009, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
typedef struct _EFI_FAULT_TOLERANT_WRITE_PROTOCOL EFI_FAULT_TOLERANT_WRITE_PROTOCOL;\r
\r
/**\r
- Query the largest block that may be updated in a fault tolerant manner.\r
+ Get the size of the largest block that can be updated in a fault-tolerant manner.\r
\r
@param This Indicates a pointer to the calling context.\r
- @param BlockSize A pointer to a caller allocated UINTN that is\r
- updated to indicate the size of the largest block\r
+ @param BlockSize A pointer to a caller-allocated UINTN that is\r
+ updated to indicate the size of the largest block\r
that can be updated.\r
\r
@retval EFI_SUCCESS The function completed successfully\r
\r
/**\r
Allocates space for the protocol to maintain information about writes.\r
- Since writes must be completed in a fault tolerant manner and multiple\r
- updates will require more resources to be successful, this function\r
+ Since writes must be completed in a fault-tolerant manner and multiple\r
+ writes require more resources to be successful, this function\r
enables the protocol to ensure that enough space exists to track\r
- information about the upcoming writes.\r
+ information about upcoming writes.\r
\r
- @param This Indicates a pointer to the calling context.\r
+ @param This A pointer to the calling context.\r
@param CallerId The GUID identifying the write.\r
@param PrivateDataSize The size of the caller's private data that must be\r
recorded for each write.\r
- @param NumberOfWrites The number of fault tolerant block writes that will\r
+ @param NumberOfWrites The number of fault tolerant block writes that will\r
need to occur.\r
\r
@retval EFI_SUCCESS The function completed successfully\r
@retval EFI_ABORTED The function could not complete successfully.\r
- @retval EFI_ACCESS_DENIED All allocated writes have not been completed. All\r
- writes must be completed or aborted before another\r
+ @retval EFI_ACCESS_DENIED Not all allocated writes have been completed. All\r
+ writes must be completed or aborted before another\r
fault tolerant write can occur.\r
\r
**/\r
\r
/**\r
Starts a target block update. This records information about the write\r
- in fault tolerant storage and will complete the write in a recoverable\r
+ in fault tolerant storage, and will complete the write in a recoverable\r
manner, ensuring at all times that either the original contents or\r
the modified contents are available.\r
\r
data.\r
@param Length The number of bytes to write to the target block.\r
@param PrivateData A pointer to private data that the caller requires\r
- to complete any pending writes in the event of a\r
+ to complete any pending writes in the event of a\r
fault.\r
@param FvBlockHandle The handle of FVB protocol that provides services\r
- for reading, writing, and erasing the target block.\r
+ for reading, writing, and erasing the target block.\r
@param Buffer The data to write.\r
\r
@retval EFI_SUCCESS The function completed successfully\r
@retval EFI_ABORTED The function could not complete successfully.\r
- @retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is not\r
+ @retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is not\r
a valid action.\r
@retval EFI_ACCESS_DENIED No writes have been allocated.\r
- @retval EFI_NOT_READY The last write has not been completed. Restart ()\r
+ @retval EFI_NOT_READY The last write has not been completed. Restart()\r
must be called to complete it.\r
\r
**/\r
\r
@param This Calling context.\r
@param FvBlockProtocol The handle of FVB protocol that provides services\r
- for reading, writing, and erasing the target block.\r
+ for reading, writing, and erasing the target block.\r
\r
@retval EFI_SUCCESS The function completed successfully\r
@retval EFI_ABORTED The function could not complete successfully.\r
);\r
\r
/**\r
- Aborts all previous allocated writes.\r
+ Aborts all previously allocated writes.\r
\r
@param This Calling context\r
\r
);\r
\r
/**\r
- Starts a target block update. This records information about the write\r
- in fault tolerant storage and will complete the write in a recoverable\r
+ Starts a target block update. This function records information about the write\r
+ in fault tolerant storage and completes the write in a recoverable\r
manner, ensuring at all times that either the original contents or\r
the modified contents are available.\r
\r
@param Lba The logical block address of the last write.\r
@param Offset The offset within the block of the last write.\r
@param Length The length of the last write.\r
- @param PrivateDataSize On input, the size of the PrivateData buffer. On\r
- output, the size of the private data stored for\r
+ @param PrivateDataSize On input, the size of the PrivateData buffer. On\r
+ output, the size of the private data stored for\r
this write.\r
@param PrivateData A pointer to a buffer. The function will copy\r
- PrivateDataSize bytes from the private data stored\r
+ PrivateDataSize bytes from the private data stored\r
for this write.\r
- @param Complete A Boolean value with TRUE indicating that the write\r
+ @param Complete A Boolean value with TRUE indicating that the write\r
was completed.\r
\r
@retval EFI_SUCCESS The function completed successfully\r
\r
///\r
/// Memory test coverage level\r
-/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\r
+/// Ignore chooses not to test memory, Quick and Sparse test some memory, and Extensive performs a detailed memory test.\r
///\r
typedef enum {\r
IGNORE,\r
@param RequireSoftECCInit Indicate if the memory need software ECC init. \r
\r
@retval EFI_SUCCESS The generic memory test is initialized correctly. \r
- @retval EFI_NO_MEDIA There is not any non-tested memory found, which means \r
- that the memory test driver have not detect any \r
- non-tested extended memory in current system. \r
+ @retval EFI_NO_MEDIA The system had no memory to be tested. \r
\r
**/\r
typedef\r
\r
@param This Protocol instance pointer. \r
@param TestedMemorySize Return the tested extended memory size. \r
- @param TotalMemorySize Return the whole system physical memory size, this \r
- value may be changed if some error DIMMs is disabled in some case. \r
- @param ErrorOut TRUE if the memory error occurs.\r
- @param IfTestAbort Indicate if the user press "ESC" to skip the memory test. \r
+ @param TotalMemorySize Return the whole system physical memory size. \r
+ The total memory size does not include memory in a slot with a disabled DIMM. \r
+ @param ErrorOut TRUE if the memory error occured.\r
+ @param IfTestAbort Indicates that the user pressed "ESC" to skip the memory test. \r
\r
- @retval EFI_SUCCESS One block of memory pass test.\r
- @retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have been\r
- already gone through.\r
- @retval EFI_DEVICE_ERROR Memory device error occurs and no agent can handle it.\r
+ @retval EFI_SUCCESS One block of memory passed the test.\r
+ @retval EFI_NOT_FOUND All memory blocks have already been tested.\r
+ @retval EFI_DEVICE_ERROR Memory device error occured, and no agent can handle it.\r
\r
**/\r
typedef\r
\r
@param This Protocol instance pointer. \r
\r
- @retval EFI_SUCCESS Success. Then free all the generic memory test driver\r
- allocated resource and notify to platform memory\r
- test driver that memory test finished.\r
+ @retval EFI_SUCCESS Success. All resources used in the memory test are freed.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- Provide capability to test compatible range used by some sepcial\r
- driver before BDS perform memory test.\r
+ Provides the capability to test the compatible range used by a special\r
+ driver.\r
\r
@param This Protocol instance pointer. \r
@param StartAddress The start address of the compatible memory range that\r
/** @file\r
\r
- Load Pe32 Image protocol provides capability to load and unload EFI image into memory and execute it.\r
- This protocol bases on File Device Path to get EFI image.\r
+ Load Pe32 Image protocol enables loading and unloading EFI images into memory and executing those images.\r
+ This protocol uses File Device Path to get EFI image.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;\r
\r
/**\r
- Produces a Null-terminated Unicode string in an output buffer based on \r
+ Produces a Null-terminated Unicode string in an output buffer, based on \r
a Null-terminated Unicode format string and a BASE_LIST argument list\r
\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize. \r
The Unicode string is produced by parsing the format string specified by FormatString. \r
- Arguments are pulled from the variable argument list specified by Marker based on the \r
+ Arguments are pulled from the variable argument list specified by Marker. Marker is constructed based on the \r
contents of the format string. \r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ This function returns the number of Unicode characters in the produced output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
@param FormatString Null-terminated Unicode format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
\r
- @return The number of Unicode characters in the produced output buffer not including the\r
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
and BufferSize.\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ This function returns the number of Unicode characters in the produced output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
);\r
\r
/**\r
- Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+ Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated\r
ASCII format string and a BASE_LIST argument list\r
\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on the \r
contents of the format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ This function returns the number of Unicode characters in the produced output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
\r
/**\r
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
- ASCII format string and variable argument list.\r
+ ASCII format string and a variable argument list.\r
\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the \r
format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ This function returns the number of Unicode characters in the produced output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
\r
Converts the decimal number specified by Value to a Null-terminated Unicode \r
string specified by Buffer containing at most Width characters. No padding of spaces \r
- is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
- If the conversion contains more than Width characters, then only the first\r
- Width characters are returned, and the total number of characters \r
- required to perform the conversion is returned.\r
+ is ever performed. If Width is 0, then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+ This function returns the number of Unicode characters in Buffer, not including\r
+ the Null-terminator.\r
+ If the conversion contains more than Width characters, this function returns \r
+ the first Width characters in the conversion, along with the total number of characters in the conversion.\r
Additional conversion parameters are specified in Flags. \r
\r
The Flags bit LEFT_JUSTIFY is always ignored.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on \r
the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ This function returns the number of ASCII characters in the output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and variable argument list.\r
+ ASCII format string and variable argument list.\r
\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the \r
format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ This function returns the number of ASCII characters in the output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on \r
the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ This function returns the number of ASCII characters in the output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the \r
format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ This function returns the number of ASCII characters in the output buffer, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
Converts the decimal number specified by Value to a Null-terminated ASCII string \r
specified by Buffer containing at most Width characters. No padding of spaces \r
is ever performed.\r
- If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+ If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
If the conversion contains more than Width characters, then only the first Width\r
characters are returned, and the total number of characters required to perform\r
/** @file\r
The EFI_SWAP_ADDRESS_RANGE_PROTOCOL is used to abstract the swap operation of boot block \r
and backup block of FV. This swap is especially needed when updating the boot block of FV. If any \r
-power failure happens during updating boot block, the swapped backup block (now is the boot block) \r
-can boot the machine with old boot block backuped in it. The swap operation is platform dependent, so \r
-other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardward directly.\r
+power failure happens during the boot block update, the swapped backup block (now the boot block) \r
+can boot the machine with the old boot block backed up in it. The swap operation is platform dependent, so \r
+other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardware directly.\r
\r
Copyright (c) 2009, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;\r
\r
//\r
-// Protocl APIs\r
+// Protocol APIs\r
//\r
\r
/**\r
- This service gets the address range location of boot block and backup block.\r
- The EFI_GET_RANGE_LOCATION service allows caller to get the range location of \r
+ This function gets the address range location of \r
boot block and backup block. \r
\r
@param This Indicates the calling context. \r
/**\r
This service checks if the boot block and backup block has been swapped.\r
\r
- The EFI_GET_SWAP_STATE service allows caller to get current swap state of boot block and backup block.\r
-\r
@param This Indicates the calling context. \r
@param SwapState True if the boot block and backup block has been swapped. \r
False if the boot block and backup block has not been swapped.\r
/**\r
This service swaps the boot block and backup block, or swaps them back.\r
\r
- The EFI_SET_SWAP_STATE service allows caller to set the swap state of boot block and backup block. \r
- It also acquires and releases software swap lock during operation. Note the setting of new swap state \r
+ It also acquires and releases software swap lock during operation. The setting of the new swap state \r
is not affected by the old swap state.\r
\r
@param This Indicates the calling context. \r
- @param NewSwapState True to swap real boot block and backup block , False to swap them back..\r
+ @param NewSwapState True to swap real boot block and backup block, False to swap them back.\r
\r
@retval EFI_SUCCESS The call was successful.\r
@retval EFI_ABORTED Set swap state error\r
\r
\r
/**\r
- This service checks if a RTC (Real Time Clock) power failure happened.\r
+ This service checks if a Real Time Clock (RTC) power failure happened.\r
\r
- The EFI_GET_RTC_POWER_STATUS service allows caller to get Real Time Clock power failure status. \r
- If parameter RtcPowerFailed is true after function returns, the trickle current (from the main battery or trickle supply) \r
- has been removed or failed, this means the swap status was lost in some platform (such as IA32). \r
- So it is recommended to check RTC power status before calling GetSwapState().\r
+ If parameter RtcPowerFailed is true after the function returns, RTC power supply failed or was removed. \r
+ It is recommended to check RTC power status before calling GetSwapState().\r
\r
@param This Indicates the calling context. \r
- @param RtcPowerFailed True if a RTC (Real Time Clock) power failure has happened.\r
+ @param RtcPowerFailed True if the RTC (Real Time Clock) power failed or was removed. \r
\r
@retval EFI_SUCCESS The call was successful.\r
\r
);\r
\r
/**\r
- This service returns supported lock methods for swap operation in current platform. Could be software lock, hardware lock, or unsupport lock.\r
-\r
- The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform. \r
- Note that software and hardware lock mothod can be used simultaneously.\r
+ This service returns all lock methods for swap operations that the current platform supports. Could be software lock, hardware lock, or unsupport lock.\r
+ Note that software and hardware lock methods can be used simultaneously.\r
\r
@param This Indicates the calling context.\r
@param LockCapability Current lock method for swap operation. \r
/**\r
This service is used to acquire or release appointed kind of lock for Swap Address Range operation.\r
\r
- The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform. \r
Note that software and hardware lock mothod can be used simultaneously.\r
\r
@param This Indicates the calling context.\r
projects / mirror_edk2.git / commitdiff