tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Grammatical and disclaimer changes (does not follow internal C coding stds.) 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10269 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter 2010-03-17 20:48:52 +00:00
parent d96d37d8b9
commit 64a80549c8
37 changed files with 764 additions and 755 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
MdeModulePkg/Include/Guid/CapsuleVendor.h
View File

@ -1,19 +1,19 @@
/** @file
This file defines:
* the capsule vendor GUID for capsule variables and the HOB
* the capsule variable name
* the capsule vendor GUID for capsule variables and the HOB.
* the capsule variable name.
* the capsule GUID HOB data structure.
The capsule HOB and variable can be used to store the capsule image start address and length.
They are used by EDKII implementation of capsule update across a system reset.
@par Note: EDKII implementation of capsule updating has discarded this capsule GUID HOB data
structur and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.
structure and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.
Copyright (c) 2006 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -34,17 +34,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
{ 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
///
/// Name of capsule variable
/// Name of capsule variable.
///
#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
///
/// Data structure of capsule guid hob entry
/// The data structure of the capsule guid hob entry.
/// Note: EDKII implementation has discarded this structure and used
/// UEFI_CAPSULE_HOB instead.
///
typedef struct {
EFI_PHYSICAL_ADDRESS BaseAddress; ///< Capsule data start address
EFI_PHYSICAL_ADDRESS BaseAddress; ///< Capsule data start address.
UINT32 Length; ///< Length of capsule data.
} CAPSULE_HOB_INFO;

10
MdeModulePkg/Include/Guid/ConsoleInDevice.h
View File

@ -2,11 +2,11 @@
This GUID can be installed to the device handle to specify that the device is the console-in device.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

10
MdeModulePkg/Include/Guid/ConsoleOutDevice.h
View File

@ -1,11 +1,11 @@
/** @file
This GUID can be installed to the device handle to specify that the device is the console-out device.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

14
MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
View File

@ -2,14 +2,14 @@
This file defines CRC32 GUID to specify the CRC32
encapsulation scheme for the GUIDed section.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/

14
MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h
View File

@ -3,14 +3,14 @@
This configuration table is to hold the top address below which the Dxe runtime code and
boot time code will be loaded and Tseg base. When this feature is enabled, Build tools will assigned
module loading address relative to these 2 address.
module loading address relative to these two addresses.
Copyright (c) 2010, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -28,7 +28,7 @@ extern EFI_GUID gLoadFixedAddressConfigurationTableGuid;
typedef struct {
EFI_PHYSICAL_ADDRESS DxeCodeTopAddress; ///< The top address below which the Dxe runtime code and below which the Dxe runtime/boot code and PEI code.
EFI_PHYSICAL_ADDRESS SmramBase; ///< SMM RAME base. build tool will assigned an offset relative to SMRAM base for SMM driver
EFI_PHYSICAL_ADDRESS SmramBase; ///< SMM RAME base. build tool will assigned an offset relative to SMRAM base for SMM driver.
} EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE;
#endif

76
MdeModulePkg/Include/Guid/MdeModuleHii.h
View File

@ -1,11 +1,11 @@
/** @file
EDKII extented HII IFR guid opcodes.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -20,13 +20,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define NON_BREAKING_CHAR 0xFFF2
///
/// State defined for password statemachine
/// State defined for password statemachine .
///
#define BROWSER_STATE_VALIDATE_PASSWORD 0
#define BROWSER_STATE_SET_PASSWORD 1
///
/// GUIDed opcodes defined for EDKII implementation
/// GUIDed opcodes defined for EDKII implementation.
///
#define EFI_IFR_TIANO_GUID \
{ 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce} }
@ -43,20 +43,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define EFI_IFR_EXTEND_OP_SUBCLASS 0x4
///
/// Label opcode
/// Label opcode.
///
typedef struct _EFI_IFR_GUID_LABEL {
EFI_IFR_OP_HEADER Header;
///
/// EFI_IFR_TIANO_GUID
/// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_LABEL
/// EFI_IFR_EXTEND_OP_LABEL.
///
UINT8 ExtendOpCode;
///
/// Label Number
/// Label Number.
///
UINT16 Number;
} EFI_IFR_GUID_LABEL;
@ -66,37 +66,37 @@ typedef struct _EFI_IFR_GUID_LABEL {
#define EFI_IFR_BANNER_ALIGN_RIGHT 2
///
/// Banner opcode
/// Banner opcode.
///
typedef struct _EFI_IFR_GUID_BANNER {
EFI_IFR_OP_HEADER Header;
///
/// EFI_IFR_TIANO_GUID
/// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_BANNER
///
UINT8 ExtendOpCode;
EFI_STRING_ID Title; ///< The string token for the banner title
UINT16 LineNumber; ///< 1-based line number
UINT8 Alignment; ///< left, center, or right-aligned
EFI_STRING_ID Title; ///< The string token for the banner title.
UINT16 LineNumber; ///< 1-based line number.
UINT8 Alignment; ///< left, center, or right-aligned.
} EFI_IFR_GUID_BANNER;
///
/// Timeout opcode
/// Timeout opcode.
///
typedef struct _EFI_IFR_GUID_TIMEOUT {
EFI_IFR_OP_HEADER Header;
///
/// EFI_IFR_TIANO_GUID
/// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_TIMEOUT
/// EFI_IFR_EXTEND_OP_TIMEOUT.
///
UINT8 ExtendOpCode;
UINT16 TimeOut; ///< TimeOut Value
UINT16 TimeOut; ///< TimeOut Value.
} EFI_IFR_GUID_TIMEOUT;
#define EFI_NON_DEVICE_CLASS 0x00
@ -108,19 +108,19 @@ typedef struct _EFI_IFR_GUID_TIMEOUT {
#define EFI_OTHER_DEVICE_CLASS 0x20
///
/// Device Class opcode
/// Device Class opcode.
///
typedef struct _EFI_IFR_GUID_CLASS {
EFI_IFR_OP_HEADER Header;
///
/// EFI_IFR_TIANO_GUID
/// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_CLASS
/// EFI_IFR_EXTEND_OP_CLASS.
///
UINT8 ExtendOpCode;
UINT16 Class; ///< Device Class from the above
UINT16 Class; ///< Device Class from the above.
} EFI_IFR_GUID_CLASS;
#define EFI_SETUP_APPLICATION_SUBCLASS 0x00
@ -134,14 +134,14 @@ typedef struct _EFI_IFR_GUID_CLASS {
typedef struct _EFI_IFR_GUID_SUBCLASS {
EFI_IFR_OP_HEADER Header;
///
/// EFI_IFR_TIANO_GUID
/// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_SUBCLASS
/// EFI_IFR_EXTEND_OP_SUBCLASS.
///
UINT8 ExtendOpCode;
UINT16 SubClass; ///< Sub Class type from the above
UINT16 SubClass; ///< Sub Class type from the above.
} EFI_IFR_GUID_SUBCLASS;
///
@ -152,27 +152,27 @@ typedef struct _EFI_IFR_GUID_SUBCLASS {
///
/// Two extended opcodes are added, and new extensions can be added here later.
/// One is for framework OneOf question Option Key value,
/// Another is for framework vareqval.
/// One is for framework OneOf question Option Key value;
/// another is for framework vareqval.
///
#define EFI_IFR_EXTEND_OP_OPTIONKEY 0x0
#define EFI_IFR_EXTEND_OP_VAREQNAME 0x1
///
/// Store the framework vfr option key value
/// Store the framework vfr option key value.
///
typedef struct _EFI_IFR_GUID_OPTIONKEY {
EFI_IFR_OP_HEADER Header;
///
/// EFI_IFR_FRAMEWORK_GUID
/// EFI_IFR_FRAMEWORK_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_OPTIONKEY
/// EFI_IFR_EXTEND_OP_OPTIONKEY.
///
UINT8 ExtendOpCode;
///
/// OneOf Questiond ID binded by OneOf Option
/// OneOf Questiond ID binded by OneOf Option.
///
EFI_QUESTION_ID QuestionId;
///
@ -186,16 +186,16 @@ typedef struct _EFI_IFR_GUID_OPTIONKEY {
} EFI_IFR_GUID_OPTIONKEY;
///
/// Store the framework vfr vareqval name number
/// Store the framework vfr vareqval name number.
///
typedef struct _EFI_IFR_GUID_VAREQNAME {
EFI_IFR_OP_HEADER Header;
///
/// EFI_IFR_FRAMEWORK_GUID
/// EFI_IFR_FRAMEWORK_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_VAREQNAME
/// EFI_IFR_EXTEND_OP_VAREQNAME.
///
UINT8 ExtendOpCode;
///
@ -204,8 +204,8 @@ typedef struct _EFI_IFR_GUID_VAREQNAME {
EFI_QUESTION_ID QuestionId;
///
/// For vareqval (0x100), NameId is 0x100.
/// This value will converte to a Unicode String following this rule.
/// sprintf(StringBuffer, "%d", NameId)
/// This value will convert to a Unicode String following this rule;
/// sprintf(StringBuffer, "%d", NameId) .
/// The the Unicode String will be used as a EFI Variable Name.
///
UINT16 NameId;

16
MdeModulePkg/Include/Guid/MdeModulePkgTokenSpace.h
View File

@ -1,14 +1,14 @@
/** @file
GUID for MdeModulePkg PCD Token Space
GUID for MdeModulePkg PCD Token Space.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/

26
MdeModulePkg/Include/Guid/MemoryStatusCodeRecord.h
View File

@ -1,14 +1,14 @@
/** @file
GUID used to identify status code records HOB that originate from the PEI status code
GUID used to identify status code records HOB that originate from the PEI status code.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -17,7 +17,7 @@
///
/// Global ID used to identify GUIDed HOBs that start with a structure of type
/// MEMORY_STATUSCODE_PACKET_HEADER followed by an array of structures of type
/// MEMORY_STATUSCODE_PACKET_HEADER, followed by an array of structures of type
/// MEMORY_STATUSCODE_RECORD. These GUIDed HOBs record all the information
/// passed into the ReportStatusCode() service of PEI Services Table.
///
@ -42,15 +42,15 @@
///
typedef struct {
///
/// Index of the packet
/// Index of the packet.
///
UINT16 PacketIndex;
///
/// The number of active records in the packet
/// The number of active records in the packet.
///
UINT16 RecordIndex;
///
/// The maximum number of records that the packet can store
/// The maximum number of records that the packet can store.
///
UINT32 MaxRecordsNumber;
} MEMORY_STATUSCODE_PACKET_HEADER;
@ -73,7 +73,7 @@ typedef struct {
///
/// The enumeration of a hardware or software entity within
/// the system. Valid instance numbers start with 1
/// the system. Valid instance numbers start with the number 1.
///
UINT32 Instance;
} MEMORY_STATUSCODE_RECORD;

16
MdeModulePkg/Include/Guid/MemoryTypeInformation.h
View File

@ -1,17 +1,17 @@
/** @file
This file defines:
* Memory Type Information GUID for HOB and Variable
* Memory Type Information Variable Name
* Memory Type Information GUID HOB data structure
* Memory Type Information GUID for HOB and Variable.
* Memory Type Information Variable Name.
* Memory Type Information GUID HOB data structure.
The memory type information HOB and variable can
be used to store the information for each memory type in Variable or HOB.
Copyright (c) 2006 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

24
MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
View File

@ -1,11 +1,11 @@
/** @file
This file defines NIC_IP4_CONFIG_INFO structure.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -48,9 +48,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/// a specific NIC.
///
typedef struct {
UINT16 Type; ///< Interface type
UINT8 Len; ///< Length of MAC address
EFI_MAC_ADDRESS MacAddr; ///< MAC address of interface
UINT16 Type; ///< Interface type.
UINT8 Len; ///< Length of MAC address.
EFI_MAC_ADDRESS MacAddr; ///< MAC address of interface.
} NIC_ADDR;
///
@ -59,10 +59,10 @@ typedef struct {
/// of variable length.
///
typedef struct {
NIC_ADDR NicAddr; ///< Link layer address to identify the NIC
UINT32 Source; ///< Static or DHCP
BOOLEAN Perment; ///< Survive the reboot or not
EFI_IP4_IPCONFIG_DATA Ip4Info; ///< IP addresses
NIC_ADDR NicAddr; ///< Link layer address to identify the NIC.
UINT32 Source; ///< Static or DHCP.
BOOLEAN Perment; ///< Survive the reboot or not.
EFI_IP4_IPCONFIG_DATA Ip4Info; ///< IP addresses.
} NIC_IP4_CONFIG_INFO;
extern EFI_GUID gEfiNicIp4ConfigVariableGuid;

16
MdeModulePkg/Include/Guid/PcdDataBaseHobGuid.h
View File

@ -1,14 +1,14 @@
/** @file
Hob guid for Pcd DataBase
Hob guid for Pcd DataBase.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/

52
MdeModulePkg/Include/Guid/Performance.h
View File

@ -1,14 +1,14 @@
/** @file
This file defines performance-related definitions, including the format of:
* performance GUID HOB
* performance protocol interfaces
* performance GUID HOB.
* performance protocol interfaces.
* performance variables.
Copyright (c) 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -26,17 +26,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct {
EFI_PHYSICAL_ADDRESS Handle;
CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///< Measured token string name
CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///< Module string name
UINT64 StartTimeStamp; ///< Start time point
UINT64 EndTimeStamp; ///< End time point
CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///< Measured token string name.
CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///< Module string name.
UINT64 StartTimeStamp; ///< Start time point.
UINT64 EndTimeStamp; ///< End time point.
} PEI_PERFORMANCE_LOG_ENTRY;
//
// The header must be aligned at 8 bytes.
//
typedef struct {
UINT32 NumberOfEntries; ///< The number of all performance log entries
UINT32 NumberOfEntries; ///< The number of all performance log entries.
UINT32 Reserved;
} PEI_PERFORMANCE_LOG_HEADER;
@ -86,17 +86,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;
typedef struct {
EFI_PHYSICAL_ADDRESS Handle;
CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///< Measured token string name
CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name
UINT64 StartTimeStamp; ///< Start time point
UINT64 EndTimeStamp; ///< End time point
CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///< Measured token string name.
CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name.
UINT64 StartTimeStamp; ///< Start time point.
UINT64 EndTimeStamp; ///< End time point.
} GAUGE_DATA_ENTRY;
//
// The header must be aligned at 8 bytes
//
typedef struct {
UINT32 NumberOfEntries; ///< The number of all performance gauge entries
UINT32 NumberOfEntries; ///< The number of all performance gauge entries.
UINT32 Reserved;
} GAUGE_DATA_HEADER;
@ -110,13 +110,13 @@ typedef struct {
If TimeStamp is zero, the start time in the record is filled in with the value
read from the current time stamp.
@param Handle Pointer to environment specific context used
@param Handle The pointer to environment specific context used
to identify the component being measured.
@param Token Pointer to a Null-terminated ASCII string
@param Token The pointer to a Null-terminated ASCII string
that identifies the component being measured.
@param Module Pointer to a Null-terminated ASCII string
@param Module The pointer to a Null-terminated ASCII string
that identifies the module being measured.
@param TimeStamp 64-bit time stamp.
@param TimeStamp The 64-bit time stamp.
@retval EFI_SUCCESS The data was read correctly from the device.
@retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement.
@ -136,20 +136,20 @@ EFI_STATUS
for the first matching record that contains a zero end time and fills in a valid end time.
Searches the performance measurement log from the beginning of the log
for the first record that matches Handle, Token, and Module and has an end time value of zero.
for the first record that matches Handle, Token, and Module, and has an end time value of zero.
If the record can not be found then return EFI_NOT_FOUND.
If the record is found and TimeStamp is not zero,
then the end time in the record is filled in with the value specified by TimeStamp.
If the record is found and TimeStamp is zero, then the end time in the matching record
is filled in with the current time stamp value.
@param Handle Pointer to environment specific context used
@param Handle The pointer to environment specific context used
to identify the component being measured.
@param Token Pointer to a Null-terminated ASCII string
@param Token The pointer to a Null-terminated ASCII string
that identifies the component being measured.
@param Module Pointer to a Null-terminated ASCII string
@param Module The pointer to a Null-terminated ASCII string
that identifies the module being measured.
@param TimeStamp 64-bit time stamp.
@param TimeStamp The 64-bit time stamp.
@retval EFI_SUCCESS The end of the measurement was recorded.
@retval EFI_NOT_FOUND The specified measurement record could not be found.

12
MdeModulePkg/Include/Guid/StandardErrorDevice.h
View File

@ -1,12 +1,12 @@
/** @file
This GUID is installed to the device handler to specify that the device is StdErr device.
This GUID is installed to the device handler to specify that the device is a StdErr device.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

14
MdeModulePkg/Include/Guid/StatusCodeCallbackGuid.h
View File

@ -2,14 +2,14 @@
GUID used to identify HOB for pointers to callback functios registered on
PEI report status code router.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/

20
MdeModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
View File

@ -2,14 +2,14 @@
This file defines the GUID and data structure used to pass DEBUG() macro
information to the Status Code Protocol and Status Code PPI.
Copyright (c) 2007 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -17,7 +17,7 @@
#define _STATUS_CODE_DATA_TYPE_DEBUG_H_
///
/// Global ID used to identify a structure of type EFI_DEBUG_INFO
/// The Global ID used to identify a structure of type EFI_DEBUG_INFO.
///
#define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \
{ \
@ -25,14 +25,14 @@
}
///
/// The maximum size of an EFI_DEBUG_INFO structure
/// The maximum size of an EFI_DEBUG_INFO structure.
///
#define EFI_STATUS_CODE_DATA_MAX_SIZE 200
///
/// This structure contains the ErrorLevel passed into the DEBUG() macro, followed
/// by a 96-byte buffer that contains the variable argument list passed to the
// DEBUG() macro that has been converted to a BASE_LIST. The 96-byte buffer is
/// DEBUG() macro that has been converted to a BASE_LIST. The 96-byte buffer is
/// followed by a Null-terminated ASCII string that is the Format string passed
/// to the DEBUG() macro. The maximum size of this structure is defined by
/// EFI_STATUS_CODE_DATA_MAX_SIZE.

25
MdeModulePkg/Include/Guid/SystemNvDataGuid.h
View File

@ -4,11 +4,11 @@
this FV image contains NV data, such as NV variable data.
This guid can also be used as the signature of FTW working block header.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
{0xfff12b8d, 0x7696, 0x4c8b, {0xa9, 0x85, 0x27, 0x47, 0x7, 0x5b, 0x4f, 0x50} }
///
/// NvDataFv GUID used as the signature of FTW working block header.
/// An NvDataFv GUID used as the signature of FTW working block header.
///
extern EFI_GUID gEfiSystemNvDataFvGuid;
@ -30,20 +30,20 @@ extern EFI_GUID gEfiSystemNvDataFvGuid;
#define WORKING_BLOCK_INVALID 0x2
///
/// EDKII Fault tolerant working block header
/// The EDKII Fault tolerant working block header.
/// The header is immediately followed by the write queue data.
///
typedef struct {
///
/// System Non Volatile FV Guid
/// System Non Volatile FV Guid.
///
EFI_GUID Signature;
///
/// 32bit CRC caculated for this header
/// 32bit CRC caculated for this header.
///
UINT32 Crc;
///
/// Working block valid bit
/// Working block valid bit.
///
UINT8 WorkingBlockValid : 1;
UINT8 WorkingBlockInvalid : 1;
@ -54,8 +54,9 @@ typedef struct {
///
UINT64 WriteQueueSize;
///
/// Write Queue data
/// UINT8 WriteQueue[WriteQueueSize];
/// Write Queue data.
///
UINT8 WriteQueue[WriteQueueSize];
///
} EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER;

72
MdeModulePkg/Include/Guid/VariableFormat.h
View File

@ -2,14 +2,14 @@
The variable data structures are related to EDK II-specific implementation of UEFI variables.
VariableFormat.h defines variable data headers and variable storage region headers.
Copyright (c) 2006 - 2008 Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -23,8 +23,8 @@ extern EFI_GUID gEfiVariableGuid;
///
/// Alignment of variable name and data, according to the architecture:
/// * For IA-32 and Intel(R) 64 architectures: 1
/// * For IA-64 architecture: 8
/// * For IA-32 and Intel(R) 64 architectures: 1.
/// * For IA-64 architecture: 8.
///
#if defined (MDE_CPU_IPF)
#define ALIGNMENT 8
@ -42,13 +42,13 @@ extern EFI_GUID gEfiVariableGuid;
#endif
///
/// Alignment of Variable Data Header in Variable Store region
/// Alignment of Variable Data Header in Variable Store region.
///
#define HEADER_ALIGNMENT 4
#define HEADER_ALIGN(Header) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))
///
/// Status of Variable Store Region
/// Status of Variable Store Region.
///
typedef enum {
EfiRaw,
@ -62,13 +62,13 @@ typedef enum {
#define VARIABLE_STORE_SIGNATURE EFI_VARIABLE_GUID
///
/// Variable Store Header Format and State
/// Variable Store Header Format and State.
///
#define VARIABLE_STORE_FORMATTED 0x5a
#define VARIABLE_STORE_HEALTHY 0xfe
///
/// Variable Store region header
/// Variable Store region header.
///
typedef struct {
///
@ -81,11 +81,11 @@ typedef struct {
///
UINT32 Size;
///
/// variable region format state
/// Variable region format state.
///
UINT8 Format;
///
/// variable region healthy state
/// Variable region healthy state.
///
UINT8 State;
UINT16 Reserved;
@ -93,41 +93,41 @@ typedef struct {
} VARIABLE_STORE_HEADER;
///
/// Variable data start flag
/// Variable data start flag.
///
#define VARIABLE_DATA 0x55AA
///
/// Variable State flags
/// Variable State flags.
///
#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transition
#define VAR_DELETED 0xfd ///< Variable is obsolete
#define VAR_HEADER_VALID_ONLY 0x7f ///< Variable header has been valid
#define VAR_ADDED 0x3f ///< Variable has been completely added
#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transition.
#define VAR_DELETED 0xfd ///< Variable is obsolete.
#define VAR_HEADER_VALID_ONLY 0x7f ///< Variable header has been valid.
#define VAR_ADDED 0x3f ///< Variable has been completely added.
///
/// Single Variable Data Header Structure
/// Single Variable Data Header Structure.
///
typedef struct {
///
/// Variable Data Start Flag
/// Variable Data Start Flag.
///
UINT16 StartId;
///
/// Variable State defined above
/// Variable State defined above.
///
UINT8 State;
UINT8 Reserved;
///
/// Attributes of variable defined in UEFI spec
/// Attributes of variable defined in UEFI specification.
///
UINT32 Attributes;
///
/// Size of variable null-terminated Unicode string name
/// Size of variable null-terminated Unicode string name.
///
UINT32 NameSize;
///
/// Size of the variable data without this header
/// Size of the variable data without this header.
///
UINT32 DataSize;
///
@ -146,15 +146,15 @@ typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY;
/// This is an optional feature to dump all used variables in shell environment.
///
struct _VARIABLE_INFO_ENTRY {
VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry
EFI_GUID VendorGuid; ///< Guid of Variable
CHAR16 *Name; ///< Name of Variable
UINT32 Attributes; ///< Attributes of variable defined in UEFI spec
UINT32 ReadCount; ///< Number of times to read this variable
UINT32 WriteCount; ///< Number of times to write this variable
UINT32 DeleteCount; ///< Number of times to delete this variable
UINT32 CacheCount; ///< Number of times that cache hits this variable
BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile
VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry.
EFI_GUID VendorGuid; ///< Guid of Variable.
CHAR16 *Name; ///< Name of Variable.
UINT32 Attributes; ///< Attributes of variable defined in UEFI specification.
UINT32 ReadCount; ///< Number of times to read this variable.
UINT32 WriteCount; ///< Number of times to write this variable.
UINT32 DeleteCount; ///< Number of times to delete this variable.
UINT32 CacheCount; ///< Number of times that cache hits this variable.
BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile.
};
#endif // _EFI_VARIABLE_H_

23
MdeModulePkg/Include/Library/CapsuleLib.h
View File

@ -2,14 +2,14 @@
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
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -18,9 +18,10 @@
/**
The firmware checks whether the capsule image is supported
by the CapsuleGuid in CapsuleHeader or other specific information in capsule image.
by the CapsuleGuid in CapsuleHeader or if there is other specific information in
the capsule image.
@param CapsuleHeader Point to the UEFI capsule image to be checked.
@param CapsuleHeader Pointer to the UEFI capsule image to be checked.
@retval EFI_SUCESS Input capsule is supported by firmware.
@retval EFI_UNSUPPORTED Input capsule is not supported by the firmware.
@ -35,9 +36,9 @@ SupportCapsuleImage (
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.
@param CapsuleHeader Pointer to the UEFI capsule image to be processed.
@retval EFI_SUCESS Capsule Image was processed successfully.
@retval EFI_SUCESS Capsule Image processed successfully.
@retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.
**/
EFI_STATUS

18
MdeModulePkg/Include/Library/DebugAgentLib.h
View File

@ -1,14 +1,14 @@
/** @file
Debug Agent Library provide source-level debug capability.
Copyright (c) 2010, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -28,8 +28,8 @@
This function is used to set up debug enviroment.
@param[in] InitFlag Init flag is used to decide initialize process.
@param[in] Context Context needed according to InitFlag, it was optional.
@param[in] InitFlag Init flag is used to decide the initialize process.
@param[in] Context Context needed according to InitFlag; it was optional.
**/
VOID

16
MdeModulePkg/Include/Library/DpcLib.h
View File

@ -1,11 +1,11 @@
/** @file
DpcLib.h
DpcLib.h.
Copyright (c) 2007, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -21,8 +21,8 @@ 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 invoke.
@param[in] DpcProcedure Pointer to the DPC's function.
@param[in] DpcContext Pointer to the DPC's context. Passed to DpcProcedure
@param[in] DpcProcedure The pointer to the DPC's function.
@param[in] DpcContext The pointer to the DPC's context. Passed to DpcProcedure
when DpcProcedure is invoked.
@retval EFI_SUCCESS The DPC was queued.

224
MdeModulePkg/Include/Library/HiiLib.h
View File

@ -1,14 +1,14 @@
/** @file
Public include file for the HII Library
Copyright (c) 2007 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -47,7 +47,7 @@
@param[in] ... The variable argument list that contains pointers
to packages terminated by a NULL.
@retval NULL A HII Handle has already been registered in the HII Database with
@retval NULL An HII Handle has already been registered in the HII Database with
the same PackageListGuid.
@retval NULL The HII Handle could not be created.
@retval NULL An empty list of packages was passed in.
@ -131,7 +131,7 @@ HiiSetString (
/**
Retrieves a string from a string package in a specific 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 is retrieved. If the string cannot be retrieved using the specified
language or the current platform language, then the string is retrieved from
the string package in the first language the string package supports. The
returned string is allocated using AllocatePool(). The caller is responsible
@ -164,7 +164,7 @@ HiiGetString (
/**
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
current platform language is retrieved. If the string cannot be retrieved
using the specified language or the current platform language, then the string
is retrieved from the string package in the first language the string package
supports. The returned string is allocated using AllocatePool(). The caller
@ -259,19 +259,19 @@ HiiGetSupportedLanguages (
GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>
@param[in] Guid Pointer to an EFI_GUID that is the routing information
@param[in] Guid The pointer to an EFI_GUID that is the routing information
GUID. Each of the 16 bytes in Guid is converted to
a 2 Unicode character hexidecimal string. This is
an optional parameter that may be NULL.
@param[in] Name Pointer to a Null-terminated Unicode string that is
@param[in] Name The pointer to a Null-terminated Unicode string that is
the routing information NAME. This is an optional
parameter that may be NULL. Each 16-bit Unicode
character in Name is converted to a 4 character Unicode
hexidecimal string.
@param[in] DriverHandle The driver handle which supports a Device Path Protocol
@param[in] DriverHandle The driver handle that supports a Device Path Protocol
that is the routing information PATH. Each byte of
the Device Path associated with DriverHandle is converted
to a 2 Unicode character hexidecimal string.
to a two (Unicode) character hexidecimal string.
@retval NULL DriverHandle does not support the Device Path Protocol.
@retval NULL DriverHandle does not support the Device Path Protocol.
@ -295,7 +295,7 @@ HiiConstructConfigHdr (
@param Request A null-terminated Unicode string in
<MultiConfigRequest> format. It can be NULL.
If it is NULL, all configuration for the
If it is NULL, all configurations for the
entirety of the current HII database will be reset.
@param DefaultId Specifies the type of defaults to retrieve.
@ -320,8 +320,8 @@ HiiSetToDefaults (
If it is NULL, all current configurations for the
entirety of the current HII database will be validated.
@retval TURE Current configuration is valid.
@retval FALSE Current configuration is invalid.
@retval TURE The current configuration is valid.
@retval FALSE The current configuration is invalid.
**/
BOOLEAN
EFIAPI
@ -335,8 +335,8 @@ HiiValidateSettings (
If ConfigHdr is NULL, then ASSERT().
@param[in] ConfigHdr Either <ConfigRequest> or <ConfigResp>.
@param[in] Guid GUID of the storage.
@param[in] Name NAME of the storage.
@param[in] Guid The GUID of the storage.
@param[in] Name The NAME of the storage.
@retval TRUE Routing information matches <ConfigHdr>.
@retval FALSE Routing information does not match <ConfigHdr>.
@ -354,12 +354,12 @@ HiiIsConfigHdrMatch (
Retrieves uncommitted data from the Form Browser and converts it to a binary
buffer.
@param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional
@param[in] VariableGuid The pointer to an EFI_GUID structure. This is an optional
parameter that may be NULL.
@param[in] VariableName Pointer to a Null-terminated Unicode string. This
@param[in] VariableName The pointer to a Null-terminated Unicode string. This
is an optional parameter that may be NULL.
@param[in] BufferSize Length in bytes of buffer to hold retrieved data.
@param[out] Buffer Buffer of data to be updated.
@param[in] BufferSize The length in bytes of buffer to hold retrieved data.
@param[out] Buffer The buffer of data to be updated.
@retval FALSE The uncommitted data could not be retrieved.
@retval TRUE The uncommitted data was retrieved.
@ -379,12 +379,12 @@ HiiGetBrowserData (
If Buffer is NULL, then ASSERT().
@param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional
@param[in] VariableGuid The pointer to an EFI_GUID structure. This is an optional
parameter that may be NULL.
@param[in] VariableName Pointer to a Null-terminated Unicode string. This
@param[in] VariableName The pointer to a Null-terminated Unicode string. This
is an optional parameter that may be NULL.
@param[in] BufferSize Length, in bytes, of Buffer.
@param[in] Buffer Buffer of data to commit.
@param[in] BufferSize The length, in bytes, of Buffer.
@param[in] Buffer The buffer of data to commit.
@param[in] RequestElement An optional field to specify which part of the
buffer data will be send back to Browser. If NULL,
the whole buffer of data will be committed to
@ -415,7 +415,7 @@ HiiSetBrowserData (
Returns a UINT64 value that contains bitfields for Hour, Minute, and Second.
The lower 8-bits of Hour are placed in bits 0..7. The lower 8-bits of Minute
are placed in bits 8..15, and the lower 8-bits of Second are placed in bits
16..23. This format is selected because it can be easily translated to
16..23. This format was selected because it can be easily translated to
an EFI_HII_TIME structure in an EFI_IFR_TYPE_VALUE union.
@param Hour The hour value to be encoded.
@ -431,7 +431,7 @@ HiiSetBrowserData (
Returns a UINT64 value that contains bit fields for Year, Month, and Day.
The lower 16-bits of Year are placed in bits 0..15. The lower 8-bits of Month
are placed in bits 16..23, and the lower 8-bits of Day are placed in bits
24..31. This format is selected because it can be easily translated to
24..31. This format was selected because it can be easily translated to
an EFI_HII_DATE structure in an EFI_IFR_TYPE_VALUE union.
@param Year The year value to be encoded.
@ -464,7 +464,7 @@ HiiAllocateOpCodeHandle (
If OpCodeHandle is NULL, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] OpCodeHandle The handle to the buffer of opcodes.
**/
VOID
@ -479,8 +479,8 @@ HiiFreeOpCodeHandle (
If OpCodeHandle is NULL, then ASSERT().
If RawBuffer is NULL, then ASSERT();
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] RawBuffer Buffer of opcodes to append.
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] RawBuffer The buffer of opcodes to append.
@param[in] RawBufferSize The size, in bytes, of Buffer.
@retval NULL There is not enough space left in Buffer to add the opcode.
@ -519,11 +519,11 @@ HiiCreateEndOpCode (
If Type is invalid, then ASSERT().
If Flags is invalid, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] StringId StringId for the option
@param[in] Flags Flags for the option
@param[in] Type Type for the option
@param[in] Value Value for the option
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] StringId StringId for the option.
@param[in] Flags The flags for the option.
@param[in] Type The type for the option.
@param[in] Value The value for the option.
@retval NULL There is not enough space left in Buffer to add the opcode.
@retval Other A pointer to the created opcode.
@ -545,10 +545,10 @@ HiiCreateOneOfOptionOpCode (
If OpCodeHandle is NULL, then ASSERT().
If Type is invalid, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] DefaultId DefaultId for the default
@param[in] Type Type for the default
@param[in] Value Value for the default
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] DefaultId The DefaultId for the default.
@param[in] Type The type for the default.
@param[in] Value The value for the default.
@retval NULL There is not enough space left in Buffer to add the opcode.
@retval Other A pointer to the created opcode.
@ -570,9 +570,9 @@ HiiCreateDefaultOpCode (
If Guid is NULL, then ASSERT().
If OpCodeSize < sizeof (EFI_IFR_GUID), then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] Guid Pointer to EFI_GUID of this guided opcode.
@param[in] GuidOpCode Pointer to an EFI_IFR_GUID opcode. This is an
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] Guid The pointer to EFI_GUID of this guided opcode.
@param[in] GuidOpCode The pointer to an EFI_IFR_GUID opcode. This is an
optional parameter that may be NULL. If this
parameter is NULL, then the GUID extension
region of the created opcode is filled with zeros.
@ -601,12 +601,12 @@ HiiCreateGuidOpCode (
If OpCodeHandle is NULL, then ASSERT().
If any reserved bits are set in QuestionFlags, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@param[in] QuestionConfig String ID for configuration
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The Question ID.
@param[in] Prompt The String ID for Prompt.
@param[in] Help The String ID for Help.
@param[in] QuestionFlags The flags in the Question Header.
@param[in] QuestionConfig The String ID for the configuration.
@retval NULL There is not enough space left in Buffer to add the opcode.
@retval Other A pointer to the created opcode.
@ -630,10 +630,10 @@ HiiCreateActionOpCode (
If any reserved bits are set in Flags, then ASSERT().
If Scope > 1, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] Flags Subtitle opcode flags
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] Flags The subtitle opcode flags.
@param[in] Scope 1 if this opcode is the beginning of a new scope.
0 if this opcode is within the current scope.
@ -657,12 +657,12 @@ HiiCreateSubTitleOpCode (
If OpCodeHandle is NULL, then ASSERT().
If any reserved bits are set in QuestionFlags, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] FormId Destination Form ID
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@param[in] QuestionId Question ID
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] FormId The Destination Form ID.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header
@param[in] QuestionId Question ID.
@retval NULL There is not enough space left in Buffer to add the opcode.
@retval Other A pointer to the created opcode.
@ -686,15 +686,15 @@ HiiCreateGotoOpCode (
If any reserved bits are set in QuestionFlags, then ASSERT().
If any reserved bits are set in CheckBoxFlags, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
@param[in] VarOffset Offset in Storage
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@param[in] CheckBoxFlags Flags for checkbox opcode
@param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
@param[in] VarOffset The offset in Storage.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@param[in] CheckBoxFlags The flags for checkbox opcode.
@param[in] DefaultsOpCodeHandle The handle for a buffer of DEFAULT opcodes. This
is an optional parameter that may be NULL.
@retval NULL There is not enough space left in Buffer to add the opcode.
@ -722,18 +722,18 @@ HiiCreateCheckBoxOpCode (
If any reserved bits are set in QuestionFlags, then ASSERT().
If any reserved bits are set in NumericFlags, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
@param[in] VarOffset Offset in Storage
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@param[in] NumericFlags Flags for numeric opcode
@param[in] Minimum Numeric minimum value
@param[in] Maximum Numeric maximum value
@param[in] Step Numeric step for edit
@param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
@param[in] VarOffset The offset in Storage.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@param[in] NumericFlags The flags for a numeric opcode.
@param[in] Minimum The numeric minimum value.
@param[in] Maximum The numeric maximum value.
@param[in] Step The numeric step for edit.
@param[in] DefaultsOpCodeHandle The handle for a buffer of DEFAULT opcodes. This
is an optional parameter that may be NULL.
@retval NULL There is not enough space left in Buffer to add the opcode.
@ -764,17 +764,17 @@ HiiCreateNumericOpCode (
If any reserved bits are set in QuestionFlags, then ASSERT().
If any reserved bits are set in StringFlags, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
@param[in] VarOffset Offset in Storage
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@param[in] StringFlags Flags for string opcode
@param[in] MinSize String minimum length
@param[in] MaxSize String maximum length
@param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
@param[in] VarOffset The offset in Storage.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@param[in] StringFlags The flags for a string opcode.
@param[in] MinSize The string minimum length.
@param[in] MaxSize The string maximum length.
@param[in] DefaultsOpCodeHandle The handle for a buffer of DEFAULT opcodes. This
is an optional parameter that may be NULL.
@retval NULL There is not enough space left in Buffer to add the opcode.
@ -804,16 +804,16 @@ HiiCreateStringOpCode (
If any reserved bits are set in QuestionFlags, then ASSERT().
If any reserved bits are set in OneOfFlags, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
@param[in] VarOffset Offset in Storage
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@param[in] OneOfFlags Flags for oneof opcode
@param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.
@param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
@param[in] VarOffset The offset in Storage.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@param[in] OneOfFlags The flags for a oneof opcode.
@param[in] OptionsOpCodeHandle The handle for a buffer of ONE_OF_OPTION opcodes.
@param[in] DefaultsOpCodeHandle The handle for a buffer of DEFAULT opcodes. This
is an optional parameter that may be NULL.
@retval NULL There is not enough space left in Buffer to add the opcode.
@ -842,17 +842,17 @@ HiiCreateOneOfOpCode (
If any reserved bits are set in QuestionFlags, then ASSERT().
If any reserved bits are set in OrderedListFlags, then ASSERT().
@param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
@param[in] VarOffset Offset in Storage
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@param[in] OrderedListFlags Flags for ordered list opcode
@param[in] DataType Type for option value
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
@param[in] VarOffset The offset in Storage.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@param[in] OrderedListFlags The flags for an ordered list opcode.
@param[in] DataType The type for option value.
@param[in] MaxContainers Maximum count for options in this ordered list
@param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.
@param[in] OptionsOpCodeHandle The handle for a buffer of ONE_OF_OPTION opcodes.
@param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
is an optional parameter that may be NULL.

138
MdeModulePkg/Include/Library/IpIoLib.h
View File

@ -2,11 +2,11 @@
This library is only intended to be used by UEFI network stack modules.
It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.
Copyright (c) 2005 - 2009, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -49,9 +49,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Internet header length in 32-bit words, so HeaderLength<<2 is the real
length of IP header.
@param[out] HdrPtr A pointer to EFI_IP4_HEADER
@param[out] HdrPtr A pointer to EFI_IP4_HEADER.
@return The IP header length
@return The IP header length.
**/
#define EFI_IP4_HEADER_LEN(HdrPtr) ((HdrPtr)->HeaderLength << 2)
@ -60,9 +60,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
datagram's data, get length from sum of ICMP header length, IP header length
and first 64 bits of datagram's data length.
@param[in] IpHdr A pointer to EFI_IP4_HEADER
@param[in] IpHdr A pointer to EFI_IP4_HEADER.
@return The ICMP error length
@return The ICMP error length.
**/
#define ICMP_ERRLEN(IpHdr) \
(sizeof(IP4_ICMP_HEAD) + EFI_IP4_HEADER_LEN(IpHdr) + 8)
@ -70,10 +70,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Get the packet header from NET_BUF.
@param[out] Buf A pointer to NET_BUF
@param[in] Type Header type
@param[out] Buf A pointer to NET_BUF.
@param[in] Type Header type.
@return The pointer to packet header
@return The pointer to packet header.
**/
#define NET_PROTO_HDR(Buf, Type) ((Type *) ((Buf)->BlockOp[0].Head))
@ -157,24 +157,24 @@ typedef union {
/// The IP session for an IP receive packet.
///
typedef struct _EFI_NET_SESSION_DATA {
EFI_IP_ADDRESS Source; ///< Source IP of the received packet
EFI_IP_ADDRESS Dest; ///< Destination IP of the received packet
IP_IO_IP_HEADER IpHdr; ///< IP header of the received packet
EFI_IP_ADDRESS Source; ///< Source IP of the received packet.
EFI_IP_ADDRESS Dest; ///< Destination IP of the received packet.
IP_IO_IP_HEADER IpHdr; ///< IP header of the received packet.
UINT32 IpHdrLen; ///< IP header length of the received packet.
///< For IPv6, it includes the IP6 header
///< length and extension header length. For
///< IPv4, it includes the IP4 header length
///< and options length.
UINT8 IpVersion; ///< The IP version of the received packet
UINT8 IpVersion; ///< The IP version of the received packet.
} EFI_NET_SESSION_DATA;
/**
The prototype is called back when an IP packet is received.
@param[in] Status Result of the receive request
@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] Status The result of the receive request.
@param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR.
@param[in] NetSession The IP session for the received packet.
@param[in] Pkt The packet received.
@param[in] Context The data provided by the user for the received packet when
the callback is registered in IP_IO_OPEN_DATA::RcvdContext.
@ -192,11 +192,11 @@ VOID
/**
The prototype is called back when an IP packet is sent.
@param[in] Status Result of the sending
@param[in] Status Result of the IP packet being sent.
@param[in] Context The data provided by user for the received packet when
the callback is registered in IP_IO_OPEN_DATA::SndContext.
@param[in] Sender A pointer to EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL
@param[in] NotifyData Context data specified when calling IpIoSend()
@param[in] Sender A pointer to EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL.
@param[in] NotifyData The Context data specified when calling IpIoSend()
**/
typedef
@ -233,27 +233,27 @@ typedef struct _IP_IO {
BOOLEAN IsConfigured;
///
/// Some ip config data can be changed
/// Some ip configuration data can be changed.
///
UINT8 Protocol;
///
/// Token and event used to get data from IP
/// Token and event used to get data from IP.
///
IP_IO_IP_COMPLETION_TOKEN RcvToken;
///
/// List entry used to link the token passed to IP_IO
/// List entry used to link the token passed to IP_IO.
///
LIST_ENTRY PendingSndList;
//
// User interface used to get notify from IP_IO
//
VOID *RcvdContext; ///< See IP_IO_OPEN_DATA::RcvdContext
VOID *SndContext; ///< See IP_IO_OPEN_DATA::SndContext
PKT_RCVD_NOTIFY PktRcvdNotify; ///< See IP_IO_OPEN_DATA::PktRcvdNotify
PKT_SENT_NOTIFY PktSentNotify; ///< See IP_IO_OPEN_DATA::PktSentNotify
VOID *RcvdContext; ///< See IP_IO_OPEN_DATA::RcvdContext.
VOID *SndContext; ///< See IP_IO_OPEN_DATA::SndContext.
PKT_RCVD_NOTIFY PktRcvdNotify; ///< See IP_IO_OPEN_DATA::PktRcvdNotify.
PKT_SENT_NOTIFY PktSentNotify; ///< See IP_IO_OPEN_DATA::PktSentNotify.
UINT8 IpVersion;
} IP_IO;
@ -262,11 +262,11 @@ typedef struct _IP_IO {
/// It is used by IpIoOpen().
///
typedef struct _IP_IO_OPEN_DATA {
IP_IO_IP_CONFIG_DATA IpConfigData; ///< Configuration of the IP instance
VOID *RcvdContext; ///< Context data used by receive callback
VOID *SndContext; ///< Context data used by send callback
PKT_RCVD_NOTIFY PktRcvdNotify; ///< Receive callback
PKT_SENT_NOTIFY PktSentNotify; ///< Send callback
IP_IO_IP_CONFIG_DATA IpConfigData; ///< Configuration of the IP instance.
VOID *RcvdContext; ///< Context data used by receive callback.
VOID *SndContext; ///< Context data used by send callback.
PKT_RCVD_NOTIFY PktRcvdNotify; ///< Receive callback.
PKT_SENT_NOTIFY PktSentNotify; ///< Send callback.
} IP_IO_OPEN_DATA;
///
@ -313,7 +313,7 @@ typedef struct _IP_IO_IP_INFO {
@param[in] IpVersion The version of the IP protocol to use, either
IPv4 or IPv6.
@return Pointer to a newly created IP_IO instance, or NULL if failed.
@return The pointer to a newly created IP_IO instance, or NULL if failed.
**/
IP_IO *
@ -330,11 +330,11 @@ IpIoCreate (
This function is paired with IpIoCreate(). The IP_IO will be closed first.
Resource will be freed afterwards. See IpIoClose().
@param[in, out] IpIo Pointer to the IP_IO instance that needs to be
@param[in, out] IpIo The pointer to the IP_IO instance that needs to be
destroyed.
@retval EFI_SUCCESS The IP_IO instance destroyed successfully.
@retval Others Error condition occurred.
@retval EFI_SUCCESS The IP_IO instance was destroyed successfully.
@retval Others An error condition occurred.
**/
EFI_STATUS
@ -349,10 +349,10 @@ IpIoDestroy (
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.
@param[in, out] IpIo The pointer to the IP_IO instance that needs to stop.
@retval EFI_SUCCESS The IP_IO instance stopped successfully.
@retval Others Error condition occurred.
@retval Others Anrror condition occurred.
**/
EFI_STATUS
@ -368,16 +368,16 @@ IpIoStop (
instance and register the callbacks and their context data for sending and
receiving IP packets.
@param[in, out] IpIo Pointer to an IP_IO instance that needs
@param[in, out] IpIo The pointer to an IP_IO instance that needs
to open.
@param[in] OpenData The configuration data and callbacks for
the IP_IO instance.
@retval EFI_SUCCESS The IP_IO instance opened with OpenData
successfully.
@retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
reopen it.
@retval Others Error condition occurred.
@retval EFI_ACCESS_DENIED The IP_IO instance is configured; avoid
reopening it.
@retval Others An error condition occurred.
**/
EFI_STATUS
@ -395,19 +395,19 @@ IpIoOpen (
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
@param[in, out] IpIo The 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, out] Pkt The pointer to the IP packet to be sent.
@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] Context The optional context data.
@param[in] NotifyData The optional notify data.
@param[in] Dest The destination IP address to send this packet to.
@param[in] OverrideData The data to override some configuration of the IP
instance used for sending.
@retval EFI_SUCCESS The operation is completed successfully.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The IpIo is not configured.
@retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
@retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.
**/
EFI_STATUS
@ -423,10 +423,10 @@ IpIoSend (
);
/**
Cancel the IP transmit token which wraps this Packet.
Cancel the IP transmit token that wraps this Packet.
@param[in] IpIo Pointer to the IP_IO instance.
@param[in] Packet Pointer to the packet of NET_BUF to cancel.
@param[in] IpIo The pointer to the IP_IO instance.
@param[in] Packet The pointer to the packet of NET_BUF to cancel.
**/
VOID
@ -443,10 +443,10 @@ IpIoCancelTxToken (
can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
data.
@param[in, out] IpIo Pointer to an IP_IO instance to add a new IP
@param[in, out] IpIo The 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.
@return The pointer to the created IP_IO_IP_INFO structure; NULL if failed.
**/
IP_IO_IP_INFO *
@ -459,16 +459,16 @@ IpIoAddIp (
Configure the IP instance of this IpInfo and start the receiving if IpConfigData
is not NULL.
@param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.
@param[in, out] IpInfo The pointer to the IP_IO_IP_INFO instance.
@param[in, out] IpConfigData The IP4 or IP6 configure data used to configure
the IP 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 IpConfigData.
@retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully,
@retval EFI_SUCCESS The IP instance of this IpInfo was configured successfully,
or there is no need to reconfigure it.
@retval Others Configuration failed.
@retval Others The configuration failed.
**/
EFI_STATUS
@ -486,8 +486,8 @@ IpIoConfigIp (
IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
will be dstroyed if the RefCnt is zero.
@param[in] IpIo Pointer to the IP_IO instance.
@param[in] IpInfo Pointer to the IpInfo to be removed.
@param[in] IpIo The pointer to the IP_IO instance.
@param[in] IpInfo The pointer to the IpInfo to be removed.
**/
VOID
@ -504,12 +504,12 @@ IpIoRemoveIp (
This function is called when the caller needs the IpIo to send data to the
specified Src. The IpIo was added previously by IpIoAddIp().
@param[in, out] IpIo Pointer to the pointer of the IP_IO instance.
@param[in, out] IpIo The pointer to the pointer of the IP_IO instance.
@param[in] IpVersion The version of the IP protocol to use, either
IPv4 or IPv6.
@param[in] Src The local IP address.
@return Pointer to the IP protocol can be used for sending purpose and its local
@return The pointer to the IP protocol can be used for sending purpose and its local
address is the same with Src.
**/
@ -534,7 +534,7 @@ IpIoFindSender (
@param[out] IsHard Whether it is a hard error.
@param[out] Notify Whether it need to notify SockError.
@return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.
@return The ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.
**/
EFI_STATUS
@ -554,20 +554,20 @@ IpIoGetIcmpErrStatus (
node has recently received a confirmation that packets sent recently to the
neighbor were received by its IP layer.
@param[in] IpIo Pointer to an IP_IO instance
@param[in] IpIo The pointer to an IP_IO instance
@param[in] Neighbor The IP address of the neighbor
@param[in] Timeout Time in 100-ns units that this entry will
@param[in] Timeout The time in 100-ns units that this entry will
remain in the neighbor cache. A value of
zero means that the entry is permanent.
A value of non-zero means that the entry is
dynamic and will be deleted after Timeout.
@retval EFI_SUCCESS The operation is completed successfully.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The IpIo is not configured.
@retval EFI_INVALID_PARAMETER Neighbor Address is invalid.
@retval EFI_INVALID_PARAMETER The Neighbor Address is invalid.
@retval EFI_NOT_FOUND The neighbor cache entry is not in the
neighbor table.
@retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
@retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.
**/
EFI_STATUS

234
MdeModulePkg/Include/Library/NetLib.h
View File

@ -2,10 +2,10 @@
This library is only intended to be used by UEFI network stack modules.
It provides basic functions for the UEFI network stack.
Copyright (c) 2005 - 2010, Intel Corporation
Copyright (c) 2005 - 2010, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
which accompanies this distribution. The full text of the license may be found at<BR>
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
@ -282,7 +282,7 @@ typedef struct {
by the Format string.
@return The buffer containing the formatted message,
or NULL if failed to allocate memory.
or NULL if memory allocation failed.
**/
CHAR8 *
@ -410,8 +410,8 @@ NetIp6IsValidUnicast (
@param[in] Ip6 - Ip6 address, in network order.
@retval TRUE - Yes, unspecified
@retval FALSE - No
@retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
@retval FALSE - The incoming Ipv6 address is not the unspecified address
**/
BOOLEAN
@ -424,8 +424,8 @@ NetIp6IsUnspecifiedAddr (
@param[in] Ip6 - Ip6 address, in network order.
@retval TRUE - Yes, link-local address
@retval FALSE - No
@retval TRUE - The incoming Ipv6 address is a link-local address.
@retval FALSE - The incoming Ipv6 address is not a link-local address.
**/
BOOLEAN
@ -440,8 +440,8 @@ NetIp6IsLinkLocalAddr (
@param[in] Ip2 - Ip6 address2, in network order.
@param[in] PrefixLength - The prefix length of the checking net.
@retval TRUE - Yes, connected.
@retval FALSE - No.
@retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
@retval FALSE - No the Ipv6 address1 and address2 are not connected.
**/
BOOLEAN
@ -452,13 +452,13 @@ NetIp6IsNetEqual (
);
/**
Switches the endianess of an IPv6 address
Switches the endianess of an IPv6 address.
This function swaps the bytes in a 128-bit IPv6 address to switch the value
from little endian to big endian or vice versa. The byte swapped value is
returned.
@param Ip6 Points to an IPv6 address
@param Ip6 Points to an IPv6 address.
@return The byte swapped IPv6 address.
@ -503,10 +503,10 @@ NetGetUint32 (
/**
Puts a UINT32 into the byte stream in network byte order.
Converts a UINT32 from host byte order to network byte order, and then copies it to the
Converts a UINT32 from host byte order to network byte order, then copies it to the
byte stream.
@param[in, out] Buf The buffer to put the UINT32.
@param[in, out] Buf The buffer in which to put the UINT32.
@param[in] Data The data to put.
**/
@ -908,8 +908,8 @@ EFI_STATUS
@param[in] CallBack The callback function to call for each item.
@param[in] Arg The opaque parameter to the callback.
@retval EFI_SUCCESS There is no item in the netmap or CallBack for each item
return EFI_SUCCESS.
@retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
returns EFI_SUCCESS.
@retval Others It returns the CallBack's last return value.
**/
@ -963,7 +963,7 @@ NetLibCreateServiceChild (
@param[in] ServiceBindingGuid The service's Guid.
@param[in] ChildHandle The child to destroy.
@retval EFI_SUCCESS The child is successfully destroyed.
@retval EFI_SUCCESS The child was destroyed.
@retval Others Failed to destroy the child.
**/
@ -1051,7 +1051,7 @@ NetLibGetVlanHandle (
@param[out] MacAddress The pointer to store the returned MAC address.
@param[out] AddressSize The length of returned MAC address.
@retval EFI_SUCCESS MAC address is returned successfully.
@retval EFI_SUCCESS MAC address was returned successfully.
@retval Others Failed to get SNP mode data.
**/
@ -1073,14 +1073,14 @@ NetLibGetMacAddress (
Plus one unicode character for the null-terminator.
@param[in] ServiceHandle The handle where network service binding protocol is
installed on.
installed.
@param[in] ImageHandle The image handle used 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.
**/
@ -1097,26 +1097,26 @@ NetLibGetMacString (
The underlying UNDI driver may or may not support reporting media status from
GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
will try to invoke Snp->GetStatus() to get the media status: if media already
present, it return directly; if media not present, it will stop SNP and then
restart SNP to get the latest media status, this give chance to get the correct
media status for old UNDI driver which doesn't support reporting media status
from GET_STATUS command.
Note: there will be two limitations for current algorithm:
1) for UNDI with this capability, in case of cable is not attached, there will
be an redundant Stop/Start() process;
2) for UNDI without this capability, in case cable is attached in UNDI
initialize while unattached latter, NetLibDetectMedia() will report
MediaPresent as TRUE, this cause upper layer apps wait for timeout time.
will try to invoke Snp->GetStatus() to get the media status. Iif media is already
present, it returns directly. If media isnot present, it will stop SNP and then
restart SNP to get the latest media status. This provides an opportunity to get
the correct media status for old UNDI driver, which doesn't support reporting
media status from GET_STATUS command.
Note: there are two limitations for the current algorithm:
1) For UNDI with this capability, when the cable is not attached, there will
be an redundant Stop/Start() process.
2) For UNDI without this capability, when the cable is attached, the UNDI
initializes while unattached. Later, NetLibDetectMedia() will report
MediaPresent as TRUE, causing upper layer apps to wait for timeout time.
@param[in] ServiceHandle The handle where network service binding protocols are
installed on.
installed.
@param[out] MediaPresent The pointer to store the media status.
@retval EFI_SUCCESS Media detection success.
@retval EFI_INVALID_PARAMETER ServiceHandle is not valid network device handle.
@retval EFI_UNSUPPORTED Network device does not support media detection.
@retval EFI_DEVICE_ERROR SNP is in unknown state.
@retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
@retval EFI_UNSUPPORTED The network device does not support media detection.
@retval EFI_DEVICE_ERROR SNP is in an unknown state.
**/
EFI_STATUS
@ -1132,9 +1132,9 @@ NetLibDetectMedia (
The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
The header subtype of IPv4 device path node is MSG_IPv4_DP.
The length of the IPv4 device path node in bytes is 19.
Get other info from parameters to make up the whole IPv4 device path node.
Get other information from parameters to make up the whole IPv4 device path node.
@param[in, out] Node Pointer to the IPv4 device path node.
@param[in, out] Node The pointer to the IPv4 device path node.
@param[in] Controller The controller handle.
@param[in] LocalIp The local IPv4 address.
@param[in] LocalPort The local port.
@ -1163,9 +1163,9 @@ NetLibCreateIPv4DPathNode (
The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
The header subtype of IPv6 device path node is MSG_IPv6_DP.
The length of the IPv6 device path node in bytes is 43.
Get other info from parameters to make up the whole IPv6 device path node.
Get other information from parameters to make up the whole IPv6 device path node.
@param[in, out] Node Pointer to the IPv6 device path node.
@param[in, out] Node The pointer to the IPv6 device path node.
@param[in] Controller The controller handle.
@param[in] LocalIp The local IPv6 address.
@param[in] LocalPort The local port.
@ -1192,13 +1192,13 @@ NetLibCreateIPv6DPathNode (
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
IP opens these handle BY_DRIVER, use that info, we can get the
needs to find its own private data that is related the IP's
service binding instance that is installed on the UNDI/SNP handle.
The controller is then either an MNP or an ARP child handle. Note that
IP opens these handles using BY_DRIVER. Use that infomation to get the
UNDI/SNP handle.
@param[in] Controller Then protocol handle to check.
@param[in] Controller The protocol handle to check.
@param[in] ProtocolGuid The protocol that is related with the handle.
@return The UNDI/SNP handle or NULL for errors.
@ -1235,8 +1235,8 @@ NetLibDefaultUnload (
@param[in] String The pointer to the Ascii string.
@param[out] Ip4Address The pointer to the converted IPv4 address.
@retval EFI_SUCCESS Convert to IPv4 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
@retval EFI_SUCCESS Converted to an IPv4 address successfully.
@retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.
**/
EFI_STATUS
@ -1252,8 +1252,8 @@ NetLibAsciiStrToIp4 (
@param[in] String The pointer to the Ascii string.
@param[out] Ip6Address The pointer to the converted IPv6 address.
@retval EFI_SUCCESS Convert to IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
@retval EFI_SUCCESS Converted to an IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
**/
EFI_STATUS
@ -1268,9 +1268,9 @@ NetLibAsciiStrToIp6 (
@param[in] String The pointer to the Ascii string.
@param[out] Ip4Address The pointer to the converted IPv4 address.
@retval EFI_SUCCESS Convert to IPv4 address successfully.
@retval EFI_SUCCESS Converted to an IPv4 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
@retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
@retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.
**/
EFI_STATUS
@ -1286,9 +1286,9 @@ NetLibStrToIp4 (
@param[in] String The pointer to the Ascii string.
@param[out] Ip6Address The pointer to the converted IPv6 address.
@retval EFI_SUCCESS Convert to IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
@retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
@retval EFI_SUCCESS Converted to an IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
@retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
**/
EFI_STATUS
@ -1306,9 +1306,9 @@ NetLibStrToIp6 (
@param[out] Ip6Address The pointer to the converted IPv6 address.
@param[out] PrefixLength The pointer to the converted prefix length.
@retval EFI_SUCCESS Convert to IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
@retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
@retval EFI_SUCCESS Converted to an IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
@retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
**/
EFI_STATUS
@ -1475,8 +1475,8 @@ typedef struct {
@param[in] Len The length of the block.
@return Pointer to the allocated NET_BUF, or NULL if the
allocation failed due to resource limit.
@return The pointer to the allocated NET_BUF, or NULL if the
allocation failed due to resource limitations.
**/
NET_BUF *
@ -1494,7 +1494,7 @@ NetbufAlloc (
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.
@param[in] Nbuf The pointer to the NET_BUF to be freed.
**/
VOID
@ -1511,12 +1511,12 @@ NetbufFree (
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.
@param[in] Nbuf The pointer to the net buffer.
@param[in] Offset The offset of the byte.
@param[out] Index Index of the NET_BLOCK_OP that contains the byte at
Offset.
@return Pointer to the Offset'th byte of data in the net buffer, or NULL
@return The pointer to the Offset'th byte of data in the net buffer, or NULL
if there is no such data in the net buffer.
**/
@ -1534,10 +1534,10 @@ NetbufGetByte (
The reference count of the newly created net buffer is set to 1. The reference
count of the associated net vector is increased by one.
@param[in] Nbuf Pointer to the net buffer to be cloned.
@param[in] Nbuf The pointer to the net buffer to be cloned.
@return Pointer to the cloned net buffer, or NULL if the
allocation failed due to resource limit.
@return The pointer to the cloned net buffer, or NULL if the
allocation failed due to resource limitations.
**/
NET_BUF *
@ -1553,13 +1553,13 @@ NetbufClone (
The duplicated net buffer will allocate its own memory to hold the data of the
source net buffer.
@param[in] Nbuf Pointer to the net buffer to be duplicated from.
@param[in, out] Duplicate Pointer to the net buffer to duplicate to, if
NULL a new net buffer is allocated.
@param[in] HeadSpace Length of the head space to reserve.
@param[in] Nbuf The pointer to the net buffer to be duplicated from.
@param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
NULL, a new net buffer is allocated.
@param[in] HeadSpace The length of the head space to reserve.
@return Pointer to the duplicated net buffer, or NULL if
the allocation failed due to resource limit.
@return The pointer to the duplicated net buffer, or NULL if
the allocation failed due to resource limitations.
**/
NET_BUF *
@ -1575,16 +1575,16 @@ NetbufDuplicate (
Offset.
A new NET_BUF structure will be created but the associated data in NET_VECTOR
is shared. This function exists to do IP packet fragmentation.
is shared. This function exists to perform IP packet fragmentation.
@param[in] Nbuf Pointer to the net buffer to be extracted.
@param[in] Nbuf The pointer to the net buffer to be extracted.
@param[in] Offset Starting point of the data to be included in the new
net buffer.
@param[in] Len Bytes of data to be included in the new net buffer.
@param[in] HeadSpace Bytes of head space to reserve for protocol header.
@param[in] Len The bytes of data to be included in the new net buffer.
@param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
@return Pointer to the cloned net buffer, or NULL if the
allocation failed due to resource limit.
@return The pointer to the cloned net buffer, or NULL if the
allocation failed due to resource limitations.
**/
NET_BUF *
@ -1600,11 +1600,11 @@ NetbufGetFragment (
Reserve some space in the header room of the net buffer.
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
function to move 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.
built from the external. However, it should be enough for the network stack.
@param[in, out] Nbuf Pointer to the net buffer.
@param[in, out] Nbuf The pointer to the net buffer.
@param[in] Len The length of buffer to be reserved from the header.
**/
@ -1618,13 +1618,13 @@ NetbufReserve (
/**
Allocate Len bytes of space from the header or tail of the buffer.
@param[in, out] Nbuf Pointer to the net buffer.
@param[in, out] Nbuf The pointer to the net buffer.
@param[in] Len The length of the buffer to be allocated.
@param[in] FromHead The flag to indicate whether reserve the data
@param[in] FromHead The flag to indicate whether to reserve the data
from head (TRUE) or tail (FALSE).
@return Pointer to the first byte of the allocated buffer,
or NULL if there is no sufficient space.
@return The pointer to the first byte of the allocated buffer,
or NULL, if there is no sufficient space.
**/
UINT8*
@ -1636,14 +1636,14 @@ NetbufAllocSpace (
);
/**
Trim Len bytes from the header or tail of the net buffer.
Trim Len bytes from the header or the tail of the net buffer.
@param[in, out] Nbuf Pointer to the net buffer.
@param[in, out] Nbuf The pointer to the net buffer.
@param[in] Len The length of the data to be trimmed.
@param[in] FromHead The flag to indicate whether trim data from head
(TRUE) or tail (FALSE).
@param[in] FromHead The flag to indicate whether trim data is from the
head (TRUE) or the tail (FALSE).
@return Length of the actually trimmed data, which may be less
@return The length of the actual trimmed data, which may be less
than Len if the TotalSize of Nbuf is less than Len.
**/
@ -1661,9 +1661,9 @@ NetbufTrim (
The Len bytes of data may cross several fragments of the net buffer.
@param[in] Nbuf Pointer to the net buffer.
@param[in] Nbuf The pointer to the net buffer.
@param[in] Offset The sequence number of the first byte to copy.
@param[in] Len Length of the data to copy.
@param[in] Len The length of the data to copy.
@param[in] Dest The destination of the data to copy to.
@return The length of the actual copied data, or 0 if the offset
@ -1687,16 +1687,16 @@ NetbufCopy (
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] ExtFragment The 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. The function
pulls this amount of data into a linear block.
@param[in] ExtFree Pointer to the caller-provided free function.
@param[in] ExtFree The pointer to the caller-provided free function.
@param[in] Arg The argument passed to ExtFree when ExtFree is
called.
@return Pointer to the net buffer built from the data blocks,
@return The pointer to the net buffer built from the data blocks,
or NULL if the allocation failed due to resource
limit.
@ -1716,13 +1716,13 @@ NetbufFromExt (
Build a fragment table to contain the fragments in the net buffer. This is the
opposite operation of the NetbufFromExt.
@param[in] Nbuf Point to the net buffer.
@param[in, out] ExtFragment Pointer to the data block.
@param[in] Nbuf Points to the net buffer.
@param[in, out] ExtFragment The 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 blocks is bigger than
ExtNum.
@retval EFI_SUCCESS Fragment table is built successfully.
@retval EFI_SUCCESS The fragment table was built successfully.
**/
EFI_STATUS
@ -1736,17 +1736,17 @@ NetbufBuildExt (
/**
Build a net buffer from a list of net buffers.
All the fragments will be collected from the list of NEW_BUF and then a new
All the fragments will be collected from the list of NEW_BUF, and then a new
net buffer will be created through NetbufFromExt.
@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. The function
pulls this amount of data into a linear block.
@param[in] ExtFree Pointer to the caller provided free function.
@param[in] ExtFree The pointer to the caller provided free function.
@param[in] Arg The argument passed to ExtFree when ExtFree is called.
@return Pointer to the net buffer built from the list of net
@return The pointer to the net buffer built from the list of net
buffers.
**/
@ -1763,7 +1763,7 @@ NetbufFromBufList (
/**
Free a list of net buffers.
@param[in, out] Head Pointer to the head of linked net buffers.
@param[in, out] Head The pointer to the head of linked net buffers.
**/
VOID
@ -1775,7 +1775,7 @@ NetbufFreeList (
/**
Initiate the net buffer queue.
@param[in, out] NbufQue Pointer to the net buffer queue to be initialized.
@param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
**/
VOID
@ -1787,7 +1787,7 @@ NetbufQueInit (
/**
Allocate and initialize a net buffer queue.
@return Pointer to the allocated net buffer queue, or NULL if the
@return The pointer to the allocated net buffer queue, or NULL if the
allocation failed due to resource limit.
**/
@ -1804,7 +1804,7 @@ NetbufQueAlloc (
free operation isn't performed until the reference count of the net buffer
queue is decreased to 0.
@param[in] NbufQue Pointer to the net buffer queue to be freed.
@param[in] NbufQue The pointer to the net buffer queue to be freed.
**/
VOID
@ -1816,9 +1816,9 @@ NetbufQueFree (
/**
Remove a net buffer from the head in the specific queue and return it.
@param[in, out] NbufQue Pointer to the net buffer queue.
@param[in, out] NbufQue The pointer to the net buffer queue.
@return Pointer to the net buffer removed from the specific queue,
@return The pointer to the net buffer removed from the specific queue,
or NULL if there is no net buffer in the specific queue.
**/
@ -1831,8 +1831,8 @@ NetbufQueRemove (
/**
Append a net buffer to the net buffer queue.
@param[in, out] NbufQue Pointer to the net buffer queue.
@param[in, out] Nbuf Pointer to the net buffer to be appended.
@param[in, out] NbufQue The pointer to the net buffer queue.
@param[in, out] Nbuf The pointer to the net buffer to be appended.
**/
VOID
@ -1846,12 +1846,12 @@ NetbufQueAppend (
Copy Len bytes of data from the net buffer queue at the specific offset to the
destination memory.
The copying operation is the same as NetbufCopy but applies to the net buffer
The copying operation is the same as NetbufCopy, but applies to the net buffer
queue instead of the net buffer.
@param[in] NbufQue Pointer to the net buffer queue.
@param[in] NbufQue The pointer to the net buffer queue.
@param[in] Offset The sequence number of the first byte to copy.
@param[in] Len Length of the data to copy.
@param[in] Len The length of the data to copy.
@param[out] Dest The destination of the data to copy to.
@return The length of the actual copied data, or 0 if the offset
@ -1874,8 +1874,8 @@ NetbufQueCopy (
The trimming operation is the same as NetbufTrim but applies to the net buffer
queue instead of the net buffer.
@param[in, out] NbufQue Pointer to the net buffer queue.
@param[in] Len Length of the data to trim.
@param[in, out] NbufQue The pointer to the net buffer queue.
@param[in] Len The length of the data to trim.
@return The actual length of the data trimmed.
@ -1891,7 +1891,7 @@ NetbufQueTrim (
/**
Flush the net buffer queue.
@param[in, out] NbufQue Pointer to the queue to be flushed.
@param[in, out] NbufQue The pointer to the queue to be flushed.
**/
VOID
@ -1903,8 +1903,8 @@ NetbufQueFlush (
/**
Compute the checksum for a bulk of data.
@param[in] Bulk Pointer to the data.
@param[in] Len Length of the data, in bytes.
@param[in] Bulk The pointer to the data.
@param[in] Len The length of the data, in bytes.
@return The computed checksum.
@ -1935,7 +1935,7 @@ NetAddChecksum (
/**
Compute the checksum for a NET_BUF.
@param[in] Nbuf Pointer to the net buffer.
@param[in] Nbuf The pointer to the net buffer.
@return The computed checksum.
@ -1969,7 +1969,7 @@ NetPseudoHeadChecksum (
);
/**
Compute the checksum for TCP6/UDP6 pseudo header.
Compute the checksum for the TCP6/UDP6 pseudo header.
Src and Dst are in network byte order, and Len is in host byte order.

44
MdeModulePkg/Include/Library/OemHookStatusCodeLib.h
View File

@ -2,14 +2,14 @@
OEM hook status code library. Platform can implement an instance to
initialize the OEM devices to report status code information.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -18,7 +18,7 @@
/**
Initialize OEM status code device .
Initialize OEM status code device.
@return Status of initialization of OEM status code device.
@ -36,25 +36,33 @@ OemHookStatusCodeInitialize (
@param CodeType Indicates the type of status code being reported.
@param Value Describes the current status of a hardware or software entity.
This includes both an operation and classification information about the class and subclass.
This includes both an operation and classification information
about the class and subclass.
For progress codes, the operation is the current activity.
For error codes, it is the exception. For debug codes, it is not defined at this time.
Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification.
For error codes, it is the exception. For debug codes,
it is not defined at this time.
Specific values are discussed in the Intel Platform Innovation
Framework for EFI Status Code Specification.
@param Instance The enumeration of a hardware or software entity within the system.
A system may contain multiple entities that match a class/subclass pairing.
The instance differentiates between them. An instance of 0 indicates that instance information is unavailable,
not meaningful, or not relevant. Valid instance numbers start with 1.
A system may contain multiple entities that match a class/subclass
pairing.
The instance differentiates between them. An instance of 0
indicates that instance information is unavailable,
not meaningful, or not relevant. Valid instance numbers
start with 1.
@param CallerId This optional parameter may be used to identify the caller.
This parameter allows the status code driver to apply different rules to different callers.
Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
This parameter allows the status code driver to apply
different rules to different callers.
Type EFI_GUID is defined in InstallProtocolInterface()
in the UEFI 2.0 Specification.
@param Data This optional parameter may be used to pass additional data
@param Data This optional parameter may be used to pass additional data.
@return The function always return EFI_SUCCESS.
@return The function always returns EFI_SUCCESS.
**/
EFI_STATUS

16
MdeModulePkg/Include/Library/RecoveryLib.h
View File

@ -1,13 +1,13 @@
/** @file
Recovery library class defines a set of methods related recovery boot mode.
This library class is no longer used and modules using this library should
directly locate EFI_PEI_RECOVERY_MODULE_PPI defined in PI 1.2 specification.
directly locate EFI_PEI_RECOVERY_MODULE_PPI, defined in the PI 1.2 specification.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -20,8 +20,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Calling this function causes the system to carry out a recovery boot path.
@retval EFI_SUCESS Sucess.
@retval Others Failure.
@retval EFI_SUCCESS Recovery boot path succeeded.
@retval Others Recovery boot path failure.
**/
EFI_STATUS

16
MdeModulePkg/Include/Library/ResetSystemLib.h
View File

@ -2,14 +2,14 @@
System reset Library Services. This library class defines a set of
methods that reset the whole system.
Copyright (c) 2005 - 2007, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -46,7 +46,7 @@ ResetWarm (
This function causes the system to enter a power state equivalent
to the ACPI G2/S5 or G3 states.
If this function returns, it means that the system does not support shut down reset.
If this function returns, it means that the system does not support shutdown reset.
**/
VOID
EFIAPI

16
MdeModulePkg/Include/Library/S3Lib.h
View File

@ -1,13 +1,13 @@
/** @file
S3 library class defines a set of methods related to S3 boot mode.
This library class is no longer used and modules using this library should
directly locate EFI_PEI_S3_RESUME_PPI defined in PI 1.2 specification.
directly locate EFI_PEI_S3_RESUME_PPI, defined in the PI 1.2 specification.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -20,8 +20,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 Successfully restored config from S3.
@retval Others Failed to restore config from S3.
@retval EFI_SUCCESS Successfully restored the configuration from S3.
@retval Others Failed to restore the configuration from S3.
**/
EFI_STATUS

40
MdeModulePkg/Include/Library/SecurityManagementLib.h
View File

@ -3,14 +3,14 @@
security measurement by managing the different security measurement services.
The library instances can be implemented according to the different security policy.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -23,7 +23,7 @@
#define EFI_AUTH_OPERATION_MEASURE_IMAGE 0x04
///
/// Image buffer is required by security handler.
/// Image buffer is required by the security handler.
///
#define EFI_AUTH_OPERATION_IMAGE_REQUIRED 0x80000000
@ -47,24 +47,24 @@
then EFI_ACCESS_DENIED is returned.
If the file specified by File with an authentication status specified by
AuthenticationStatus is not safe for the DXE Core to use right now, but it
AuthenticationStatus is not safe for the DXE Core to use at the time, but it
might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
returned.
FileBuffer will be NULL and FileSize will be 0 if the handler being called
has did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.
did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.
@param[in] AuthenticationStatus
This is the authentication status returned from the security
The authentication status returned from the security
measurement services for the input file.
@param[in] File This is a pointer to the device path of the file that is
@param[in] File The pointer to the device path of the file that is
being dispatched. This will optionally be used for logging.
@param[in] FileBuffer File buffer matches the input file device path.
@param[in] FileSize Size of File buffer matches the input file device path.
@param[in] FileBuffer The file buffer matches the input file device path.
@param[in] FileSize The size of File buffer matches the input file device path.
@retval EFI_SUCCESS The file specified by File did authenticate, and the
platform policy dictates that the DXE Core may use File.
@retval EFI_INVALID_PARAMETER File is NULL.
@retval EFI_INVALID_PARAMETER The file is NULL.
@retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
the platform policy dictates that File should be placed
in the untrusted state. A file may be promoted from
@ -85,16 +85,16 @@ EFI_STATUS
);
/**
Register security measurement handler with its operation type. The different
handler with the same operation can all be registered.
Register security measurement handler with its operation type. Different
handlers with the same operation can all be registered.
If SecurityHandler is NULL, then ASSERT().
If no enough resources available to register new handler, then ASSERT().
If AuthenticationOperation is not recongnized, then ASSERT().
If the previous register handler can't be executed before the later register handler, then ASSERT().
@param[in] SecurityHandler Security measurement service handler to be registered.
@param[in] AuthenticationOperation Operation type is specified for the registered handler.
@param[in] SecurityHandler The security measurement service handler to be registered.
@param[in] AuthenticationOperation Theoperation type is specified for the registered handler.
@retval EFI_SUCCESS The handlers were registered successfully.
**/
@ -121,7 +121,7 @@ RegisterSecurityHandler (
@param[in] FilePath This is a pointer to the device path of the file that is
being dispatched. This will optionally be used for logging.
@retval EFI_SUCCESS The file specified by File did authenticate when more
@retval EFI_SUCCESS The file specified by File authenticated when more
than one security handler services were registered,
or the file did not authenticate when no security
handler service was registered. And the platform policy

42
MdeModulePkg/Include/Library/UdpIoLib.h
View File

@ -2,7 +2,7 @@
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 - 2009, Intel Corporation.<BR>
Copyright (c) 2006 - 2010, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at<BR>
@ -49,14 +49,14 @@ typedef struct {
This prototype is used by both receive and sending when calling
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.
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] EndPoint The UDP address pair corresponds to the UDP IO
@param[in] IoStatus Packet receiving or sending status
@param[in] Context User-defined data when calling UdpIoRecvDatagram() or
UdpIoSendDatagram()
@param[in] Packet The packet received or sent.
@param[in] EndPoint The UDP address pair corresponds to the UDP IO.
@param[in] IoStatus The packet receiving or sending status.
@param[in] Context The user-defined data when calling UdpIoRecvDatagram() or
UdpIoSendDatagram().
**/
typedef
VOID
@ -97,8 +97,8 @@ 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. All transmit requests
/// are linked in a list.
/// the CallBack will be called. There can be several transmit requests. All transmit
/// requests are linked in a list.
///
typedef union {
@ -160,16 +160,16 @@ struct _UDP_IO {
};
/**
Prototype called when UdpIo Library configures a UDP instance.
The prototype called when UdpIo Library configures a UDP instance.
The prototype is set and called when creating a UDP_IO in UdpIoCreatePort().
@param[in] UdpIo The UDP_IO to configure
@param[in] Context User-defined data when calling UdpIoCreatePort()
@param[in] UdpIo The UDP_IO to configure.
@param[in] Context The user-defined data when calling UdpIoCreatePort().
@retval EFI_SUCCESS The configuration succeeded
@retval EFI_SUCCESS The configuration succeeded.
@retval Others The UDP_IO fails to configure indicating
UdpIoCreatePort() should fail
UdpIoCreatePort() should fail.
**/
typedef
EFI_STATUS
@ -181,11 +181,11 @@ EFI_STATUS
/**
The select function to decide whether to cancel the UDP_TX_TOKEN.
@param[in] Token The UDP_TX_TOKEN to decide whether to cancel
@param[in] Context User-defined data in UdpIoCancelDgrams()
@param[in] Token The UDP_TX_TOKEN to decide whether to cancel.
@param[in] Context User-defined data in UdpIoCancelDgrams().
@retval TRUE Cancel the UDP_TX_TOKEN
@retval FALSE Do not cancel this UDP_TX_TOKEN
@retval TRUE Cancel the UDP_TX_TOKEN.
@retval FALSE Do not cancel this UDP_TX_TOKEN.
**/
typedef
@ -231,7 +231,7 @@ UdpIoCancelDgrams (
@param[in] UdpVersion The UDP protocol version, UDP4 or UDP6.
@param[in] Context The opaque parameter for the Configure funtion.
@return Newly-created UDP_IO or NULL if failed.
@return The newly-created UDP_IO, or NULL if failed.
**/
UDP_IO *
@ -338,7 +338,7 @@ UdpIoCancelSentDatagram (
@retval EFI_ALREADY_STARTED There is already a pending receive request. Only
one receive request is supported at a time.
@retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.
@retval EFI_SUCCESS The receive request is issued successfully.
@retval EFI_SUCCESS The receive request was issued successfully.
@retval EFI_UNSUPPORTED The UDP version in UDP_IO is not supported.
**/

24
MdeModulePkg/Include/Library/UefiHiiServicesLib.h
View File

@ -4,14 +4,14 @@
library class must verify that the global variable pointers are not NULL before
use.
Copyright (c) 2006 - 2009, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@ -25,27 +25,27 @@
#include <Protocol/HiiConfigRouting.h>
///
/// Pointer to the UEFI HII Font Protocol
/// The pointer to the UEFI HII Font Protocol.
///
extern EFI_HII_FONT_PROTOCOL *gHiiFont;
///
/// Pointer to the UEFI HII String Protocol
/// The pointer to the UEFI HII String Protocol.
///
extern EFI_HII_STRING_PROTOCOL *gHiiString;
///
/// Pointer to the UEFI HII Image Protocol
/// The pointer to the UEFI HII Image Protocol.
///
extern EFI_HII_IMAGE_PROTOCOL *gHiiImage;
///
/// Pointer to the UEFI HII Database Protocol
/// The pointer to the UEFI HII Database Protocol.
///
extern EFI_HII_DATABASE_PROTOCOL *gHiiDatabase;
///
/// Pointer to the UEFI HII Config Rounting Protocol
/// The pointer to the UEFI HII Config Rounting Protocol.
///
extern EFI_HII_CONFIG_ROUTING_PROTOCOL *gHiiConfigRouting;

28
MdeModulePkg/Include/Protocol/Dpc.h
View File

@ -1,12 +1,12 @@
/** @file
EFI Deferred Procedure Call Protocol
EFI Deferred Procedure Call Protocol.
Copyright (c) 2007 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -34,7 +34,7 @@ typedef struct _EFI_DPC_PROTOCOL EFI_DPC_PROTOCOL;
/**
Invoke a Deferred Procedure Call.
@param DpcContext Pointer to the Deferred Procedure Call's context,
@param DpcContext The pointer to the Deferred Procedure Call's context,
which is implementation dependent.
**/
@ -47,10 +47,10 @@ VOID
/**
Add a Deferred Procedure Call to the end of the DPC queue.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param DpcTpl The EFI_TPL that the DPC should invoke.
@param DpcProcedure Pointer to the DPC's function.
@param DpcContext Pointer to the DPC's context. Passed to DpcProcedure
@param DpcProcedure The pointer to the DPC's function.
@param DpcContext The pointer to the DPC's context. Passed to DpcProcedure
when DpcProcedure is invoked.
@retval EFI_SUCCESS The DPC was queued.
@ -73,8 +73,8 @@ EFI_STATUS
Dispatch the queue of DPCs.
DPCs with DpcTpl value greater than the current TPL value are queued, and then DPCs
with DpcTpl value lower than the current TPL value are queued. All DPCs in the first group (higher DpcTpl values)
are invoked before DPCs in the second group (lower DpcTpl values).
with DpcTpl value lower than the current TPL value are queued. All DPCs in the first
group (higher DpcTpl values) are invoked before DPCs in the second group (lower DpcTpl values).
@param This Protocol instance pointer.
@ -89,7 +89,7 @@ EFI_STATUS
);
///
/// DPC Protocol structure
/// DPC Protocol structure.
///
struct _EFI_DPC_PROTOCOL {
EFI_DPC_QUEUE_DPC QueueDpc;
@ -97,7 +97,7 @@ struct _EFI_DPC_PROTOCOL {
};
///
/// DPC Protocol GUID variable
/// DPC Protocol GUID variable.
///
extern EFI_GUID gEfiDpcProtocolGuid;

38
MdeModulePkg/Include/Protocol/FaultTolerantWrite.h
View File

@ -1,14 +1,14 @@
/** @file
Fault Tolerant Write protocol provides boot-time service for fault tolerant
write capability for block devices. The protocol provides for non-volatile
storage of the intermediate data and private information a caller would need to
recover from a critical fault, such as a power failure.
Fault Tolerant Write protocol provides boot-time service for fault tolerant
write capability for block devices. The protocol provides for non-volatile
storage of the intermediate data and private information a caller would need to
recover from a critical fault, such as a power failure.
Copyright (c) 2009 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -36,7 +36,7 @@ typedef struct _EFI_FAULT_TOLERANT_WRITE_PROTOCOL EFI_FAULT_TOLERANT_WRITE_PROT
updated to indicate the size of the largest block
that can be updated.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
**/
@ -83,7 +83,7 @@ EFI_STATUS
manner, ensuring at all times that either the original contents or
the modified contents are available.
@param This Calling context
@param This The calling context.
@param Lba The logical block address of the target block.
@param Offset The offset within the target block to place the
data.
@ -95,7 +95,7 @@ EFI_STATUS
for reading, writing, and erasing the target block.
@param Buffer The data to write.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is not
a valid action.
@ -120,11 +120,11 @@ EFI_STATUS
Restarts a previously interrupted write. The caller must provide the
block protocol needed to complete the interrupted write.
@param This Calling context.
@param FvBlockProtocol The handle of FVB protocol that provides services
@param This The calling context.
@param FvBlockProtocol The handle of FVB protocol that provides services.
for reading, writing, and erasing the target block.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_ACCESS_DENIED No pending writes exist.
@ -139,9 +139,9 @@ EFI_STATUS
/**
Aborts all previously allocated writes.
@param This Calling context
@param This The calling context.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_NOT_FOUND No allocated writes exist.
@ -154,7 +154,7 @@ EFI_STATUS
/**
Starts a target block update. This function records information about the write
in fault tolerant storage and completes the write in a recoverable
in fault-tolerant storage and completes the write in a recoverable
manner, ensuring at all times that either the original contents or
the modified contents are available.
@ -172,7 +172,7 @@ EFI_STATUS
@param Complete A Boolean value with TRUE indicating that the write
was completed.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_NOT_FOUND No allocated writes exist.

22
MdeModulePkg/Include/Protocol/GenericMemoryTest.h
View File

@ -1,11 +1,11 @@
/** @file
This protocol defines the generic memory test interfaces in Dxe phase.
Copyright (c) 2006 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -21,8 +21,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL EFI_GENERIC_MEMORY_TEST_PROTOCOL;
///
/// Memory test coverage level
/// Ignore chooses not to test memory, Quick and Sparse test some memory, and Extensive performs a detailed memory test.
/// Memory test coverage level.
/// Ignore chooses not to test memory. Quick and Sparse test some memory, and Extensive performs a detailed memory test.
///
typedef enum {
IGNORE,
@ -36,7 +36,7 @@ typedef enum {
/**
Initialize the generic memory test.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param Level The coverage level of the memory test.
@param RequireSoftECCInit Indicate if the memory need software ECC init.
@ -56,7 +56,7 @@ EFI_STATUS
/**
Perform the memory test.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param TestedMemorySize Return the tested extended memory size.
@param TotalMemorySize Return the whole system physical memory size.
The total memory size does not include memory in a slot with a disabled DIMM.
@ -82,7 +82,7 @@ EFI_STATUS
/**
Finish the memory test.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@retval EFI_SUCCESS Success. All resources used in the memory test are freed.
@ -96,7 +96,7 @@ EFI_STATUS
/**
Provides the capability to test the compatible range used by some special drivers.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param StartAddress The start address of the compatible memory range that
must be below 16M.
@param Length The compatible memory range's length.

26
MdeModulePkg/Include/Protocol/LoadPe32Image.h
View File

@ -1,13 +1,13 @@
/** @file
Load Pe32 Image protocol enables loading and unloading EFI images into memory and executing those images.
This protocol uses File Device Path to get EFI image.
This protocol uses File Device Path to get an EFI image.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -30,7 +30,7 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;
Loads an EFI image into memory and returns a handle to the image with extended parameters.
@param This Pointer to the LoadPe32Image protocol instance
@param This The pointer to the LoadPe32Image protocol instance
@param ParentImageHandle The caller's image handle.
@param FilePath The specific file path from which the image is loaded.
@param SourceBuffer If not NULL, a pointer to the memory location containing a copy of
@ -39,8 +39,8 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;
@param DstBuffer The buffer to store the image.
@param NumberOfPages For input, specifies the space size of the image by caller if not NULL.
For output, specifies the actual space size needed.
@param ImageHandle Image handle for output.
@param EntryPoint Image entry point for output.
@param ImageHandle The image handle for output.
@param EntryPoint The image entry point for output.
@param Attribute The bit mask of attributes to set for the load PE image.
@retval EFI_SUCCESS The image was loaded into memory.
@ -48,7 +48,7 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
@retval EFI_UNSUPPORTED The image type is not supported, or the device path cannot be
parsed to locate the proper protocol for loading the file.
@retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient memory resources.
@retval EFI_OUT_OF_RESOURCES The image was not loaded due to insufficient memory resources.
**/
typedef
EFI_STATUS
@ -69,12 +69,12 @@ EFI_STATUS
Unload the specified image.
@param This Pointer to the LoadPe32Image protocol instance
@param This The pointer to the LoadPe32Image protocol instance
@param ImageHandle The specified image handle to be unloaded.
@retval EFI_INVALID_PARAMETER Image handle is NULL.
@retval EFI_UNSUPPORTED Attempt to unload an unsupported image.
@retval EFI_SUCCESS Image is successfully unloaded.
@retval EFI_UNSUPPORTED Attempted to unload an unsupported image.
@retval EFI_SUCCESS The image successfully unloaded.
--*/
typedef

14
MdeModulePkg/Include/Protocol/Print2.h
View File

@ -3,11 +3,11 @@
This print protocol defines six basic print functions to
print the format unicode and ascii string.
Copyright (c) 2006 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -222,7 +222,7 @@ UINTN
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
@param Buffer Pointer to the output buffer for the produced Null-terminated
@param Buffer The pointer to the output buffer for the produced Null-terminated
Unicode string.
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
@param Value The 64-bit signed value to convert to a string.
@ -432,7 +432,7 @@ UINTN
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
@param Buffer Pointer to the output buffer for the produced Null-terminated
@param Buffer The pointer to the output buffer for the produced Null-terminated
ASCII string.
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
@param Value The 64-bit signed value to convert to a string.

31
MdeModulePkg/Include/Protocol/SwapAddressRange.h
View File

@ -1,15 +1,15 @@
/** @file
The EFI_SWAP_ADDRESS_RANGE_PROTOCOL is used to abstract the swap operation of boot block
and backup block of FV. This swap is especially needed when updating the boot block of FV. If any
and backup block of FV. This swap is especially needed when updating the boot block of FV. If a
power failure happens during the boot block update, the swapped backup block (now the boot block)
can boot the machine with the old boot block backed up in it. The swap operation is platform dependent, so
other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardware directly.
Copyright (c) 2009 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -44,10 +44,10 @@ typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
boot block and backup block.
@param This Indicates the calling context.
@param BootBlockBase Base address of current boot block.
@param BootBlockSize Size (in bytes) of current boot block.
@param BackupBlockBase Base address of current backup block.
@param BackupBlockSize Size (in bytes) of current backup block.
@param BootBlockBase The base address of current boot block.
@param BootBlockSize The size (in bytes) of current boot block.
@param BackupBlockBase The base address of current backup block.
@param BackupBlockSize The size (in bytes) of current backup block.
@retval EFI_SUCCESS The call was successful.
@ -89,7 +89,7 @@ EFI_STATUS
@param NewSwapState True to swap real boot block and backup block, False to swap them back.
@retval EFI_SUCCESS The call was successful.
@retval EFI_ABORTED Set swap state error
@retval EFI_ABORTED Set swap state error.
**/
typedef
@ -121,11 +121,12 @@ EFI_STATUS
);
/**
This service returns all lock methods for swap operations that the current platform supports. Could be software lock, hardware lock, or unsupport lock.
This service returns all lock methods for swap operations that the current platform
supports. Could be software lock, hardware lock, or unsupport lock.
Note that software and hardware lock methods can be used simultaneously.
@param This Indicates the calling context.
@param LockCapability Current lock method for swap operation.
@param LockCapability The current lock method for swap operations.
@retval EFI_SUCCESS The call was successful.
@ -140,13 +141,13 @@ EFI_STATUS
/**
This service is used to acquire or release appointed kind of lock for Swap Address Range operation.
This service is used to acquire or release appointed kind of lock for Swap Address Range operations.
Note that software and hardware lock mothod can be used simultaneously.
@param This Indicates the calling context.
@param LockCapability Indicates which lock to acquire or release.
@param NewLockState True to acquire lock, False to release lock.
@param NewLockState True to acquire lock; False to release lock.
@retval EFI_SUCCESS The call was successful.

8
MdeModulePkg/MdeModulePkg.dec
View File

@ -4,13 +4,11 @@
# It also provides the defintions(including PPIs/PROTOCOLs/GUIDs and library classes)
# and libraries instances, which are used for those modules.
#
# Copyright (c) 2007 - 2010, Intel Corporation.
#
# All rights reserved.
# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved <BR>
# This program and the accompanying materials are licensed and made available under
# the terms and conditions of the BSD License which accompanies this distribution.
# the terms and conditions of the BSD License that accompanies this distribution.
# The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
# http://opensource.org/licenses/bsd-license.php.
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.