sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-03-12 22:19:12 +00:00
parent 636f2be673
commit af2dc6a70b
85 changed files with 2610 additions and 2573 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
MdePkg/Include/Protocol/Arp.h
View File

@@ -7,17 +7,17 @@
The EFI ARP Protocol provides services to map IP network
address to hardware address used by a data link protocol.
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<BR>
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
This Protocol was introduced in UEFI Specification 2.0.
**/
@@ -65,12 +65,12 @@ typedef struct {
UINT16 SwAddressType;
///
/// Length of the hardware address.
/// The length of the hardware address.
///
UINT8 HwAddressLength;
///
/// Length of the protocol address.
/// The length of the protocol address.
///
UINT8 SwAddressLength;
} EFI_ARP_FIND_DATA;
@@ -82,12 +82,12 @@ typedef struct {
UINT16 SwAddressType;
///
/// Length in bytes of the station's protocol address to register.
/// The length in bytes of the station's protocol address to register.
///
UINT8 SwAddressLength;
///
/// Pointer to the first byte of the protocol address to register. For
/// The pointer to the first byte of the protocol address to register. For
/// example, if SwAddressType is 0x0800 (IP), then
/// StationAddress points to the first byte of this station's IP
/// address stored in network byte order.
@@ -128,8 +128,8 @@ typedef struct {
all the following ARP functions will use this information. Attempting to change
the protocol type or station address to a configured ARP instance will result in errors.
@param This Pointer to the EFI_ARP_PROTOCOL instance.
@param ConfigData Pointer to the EFI_ARP_CONFIG_DATA structure.
@param This The pointer to the EFI_ARP_PROTOCOL instance.
@param ConfigData The pointer to the EFI_ARP_CONFIG_DATA structure.
@retval EFI_SUCCESS The new station address was successfully
registered.
@@ -160,7 +160,7 @@ EFI_STATUS
by the Add() function may be static (will not time out) or dynamic (will time out).
Default ARP cache timeout values are not covered in most network protocol
specifications (although RFC 1122 comes pretty close) and will only be
discussed in general in this specification. The timeout values that are
discussed in general terms in this specification. The timeout values that are
used in the EFI Sample Implementation should be used only as a guideline.
Final product implementations of the EFI network stack should be tuned for
their expected network environments.
@@ -218,16 +218,16 @@ EFI_STATUS
set to TRUE. If the found ARP cache entry is a permanent entry, it is not
affected by Refresh.
@param This Pointer to the EFI_ARP_PROTOCOL instance.
@param This The pointer to the EFI_ARP_PROTOCOL instance.
@param BySwAddress Set to TRUE to look for matching software protocol
addresses. Set to FALSE to look for matching
hardware protocol addresses.
@param AddressBuffer Pointer to address buffer. Set to NULL to match
all addresses.
@param AddressBuffer The pointer to the address buffer. Set to NULL
to match all addresses.
@param EntryLength The size of an entry in the entries buffer.
@param EntryCount The number of ARP cache entries that are found by
the specified criteria.
@param Entries Pointer to the buffer that will receive the ARP
@param Entries The pointer to the buffer that will receive the ARP
cache entries.
@param Refresh Set to TRUE to refresh the timeout value of the
matching ARP cache entry.
@@ -257,11 +257,11 @@ EFI_STATUS
/**
This function removes specified ARP cache entries.
@param This Pointer to the EFI_ARP_PROTOCOL instance.
@param This The pointer to the EFI_ARP_PROTOCOL instance.
@param BySwAddress Set to TRUE to delete matching protocol addresses.
Set to FALSE to delete matching hardware
addresses.
@param AddressBuffer Pointer to the address buffer that is used as a
@param AddressBuffer The pointer to the address buffer that is used as a
key to look for the cache entry. Set to NULL to
delete all entries.
@@ -283,7 +283,7 @@ EFI_STATUS
This function delete all dynamic entries from the ARP cache that match the specified
software protocol type.
@param This Pointer to the EFI_ARP_PROTOCOL instance.
@param This The pointer to the EFI_ARP_PROTOCOL instance.
@retval EFI_SUCCESS The cache has been flushed.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -301,11 +301,11 @@ EFI_STATUS
This function tries to resolve the TargetSwAddress and optionally returns a
TargetHwAddress if it already exists in the ARP cache.
@param This Pointer to the EFI_ARP_PROTOCOL instance.
@param TargetSwAddress Pointer to the protocol address to resolve.
@param ResolvedEvent Pointer to the event that will be signaled when
@param This The pointer to the EFI_ARP_PROTOCOL instance.
@param TargetSwAddress The pointer to the protocol address to resolve.
@param ResolvedEvent The pointer to the event that will be signaled when
the address is resolved or some error occurs.
@param TargetHwAddress Pointer to the buffer for the resolved hardware
@param TargetHwAddress The pointer to the buffer for the resolved hardware
address in network byte order.
@retval EFI_SUCCESS The data is copied from the ARP cache into the
@@ -338,8 +338,8 @@ EFI_STATUS
NULL, all the pending asynchronous requests that have been issued by This
instance will be cancelled and their corresponding events will be signaled.
@param This Pointer to the EFI_ARP_PROTOCOL instance.
@param TargetSwAddress Pointer to the protocol address in previous
@param This The pointer to the EFI_ARP_PROTOCOL instance.
@param TargetSwAddress The pointer to the protocol address in previous
request session.
@param ResolvedEvent Pointer to the event that is used as the
notification event in previous request session.

71
MdePkg/Include/Protocol/AuthenticationInfo.h
View File

@@ -3,14 +3,14 @@
This protocol is used on any device handle to obtain authentication information
associated with the physical or logical device.
Copyright (c) 2006 - 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -51,19 +51,19 @@ typedef struct {
AUTH_NODE_HEADER Header;
///
/// RADIUS Server IPv4 or IPv6 Address
/// RADIUS Server IPv4 or IPv6 Address.
///
UINT8 RadiusIpAddr[16]; ///< IPv4 or IPv6 address
UINT8 RadiusIpAddr[16]; ///< IPv4 or IPv6 address.
///
/// Reserved for future use
/// Reserved for future use.
///
UINT16 Reserved;
///
/// Network Access Server IPv4 or IPv6 Address (OPTIONAL)
/// Network Access Server IPv4 or IPv6 Address (OPTIONAL).
///
UINT8 NasIpAddr[16]; ///< IPv4 or IPv6 address
UINT8 NasIpAddr[16]; ///< IPv4 or IPv6 address.
///
/// Network Access Server Secret Length in bytes (OPTIONAL)
@@ -71,7 +71,7 @@ typedef struct {
UINT16 NasSecretLength;
///
/// Network Access Server Secret (OPTIONAL)
/// Network Access Server Secret (OPTIONAL).
///
UINT8 NasSecret[1];
@@ -84,7 +84,7 @@ typedef struct {
///
/// UINT8 ChapSecret[];
///
/// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength
/// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength.
///
/// UINT16 ChapNameLength;
///
@@ -98,22 +98,22 @@ typedef struct {
AUTH_NODE_HEADER Header;
///
/// Reserved for future use
/// Reserved for future use.
///
UINT16 Reserved;
///
/// User Secret Length in bytes
/// User Secret Length in bytes.
///
UINT16 UserSecretLength;
///
/// User Secret
/// User Secret.
///
UINT8 UserSecret[1];
///
/// User Name Length in bytes on offset UserSecret + UserSecretLength
/// User Name Length in bytes on offset UserSecret + UserSecretLength.
///
/// UINT16 UserNameLength;
///
@@ -143,14 +143,16 @@ typedef struct {
/**
Retrieves the authentication information associated with a particular controller handle.
@param[in] This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL
@param[in] ControllerHandle Handle to the Controller
@param[out] Buffer Pointer to the authentication information.
@param[in] This The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.
@param[in] ControllerHandle The handle to the Controller.
@param[out] Buffer The pointer to the authentication information.
@retval EFI_SUCCESS Successfully retrieved authentication information for the given ControllerHandle
@retval EFI_INVALID_PARAMETER No matching authentication information found for the given ControllerHandle
@retval EFI_DEVICE_ERROR The authentication information could not be retrieved due to a
hardware error.
@retval EFI_SUCCESS Successfully retrieved authentication information
for the given ControllerHandle.
@retval EFI_INVALID_PARAMETER No matching authentication information found for
the given ControllerHandle.
@retval EFI_DEVICE_ERROR The authentication information could not be retrieved
due to a hardware error.
**/
typedef
@@ -164,15 +166,16 @@ EFI_STATUS
/**
Set the authentication information for a given controller handle.
@param[in] This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL
@param[in] ControllerHandle Handle to the Controller
@param[in] Buffer Pointer to the authentication information.
@param[in] This The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.
@param[in] ControllerHandle The handle to the Controller.
@param[in] Buffer The pointer to the authentication information.
@retval EFI_SUCCESS Successfully set authentication information for the given ControllerHandle
@retval EFI_UNSUPPORTED If the platform policies do not allow setting of the authentication
information.
@retval EFI_DEVICE_ERROR The authentication information could not be configured due to a
hardware error.
@retval EFI_SUCCESS Successfully set authentication information for the
given ControllerHandle.
@retval EFI_UNSUPPORTED If the platform policies do not allow setting of
the authentication information.
@retval EFI_DEVICE_ERROR The authentication information could not be configured
due to a hardware error.
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
**/

74
MdePkg/Include/Protocol/Bis.h
View File

@@ -2,17 +2,17 @@
The EFI_BIS_PROTOCOL is used to check a digital signature of a data block
against a digital certificate for the purpose of an integrity and authorization check.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in EFI Specification 1.10
This Protocol is introduced in EFI Specification 1.10.
**/
@@ -51,7 +51,7 @@ typedef UINT32 BIS_CERT_ID;
/// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).
///
typedef struct {
UINT32 Length; ///< Length of Data in 8 bit bytes.
UINT32 Length; ///< The length of Data in 8 bit bytes.
UINT8 *Data; ///< 32 Bit Flat Address of data.
} EFI_BIS_DATA;
@@ -59,8 +59,8 @@ typedef struct {
/// EFI_BIS_VERSION type.
///
typedef struct {
UINT32 Major; ///< the major BIS version number.
UINT32 Minor; ///< a minor BIS version number.
UINT32 Major; ///< The major BIS version number.
UINT32 Minor; ///< A minor BIS version number.
} EFI_BIS_VERSION;
//
@@ -78,12 +78,12 @@ typedef struct {
typedef struct {
BIS_CERT_ID CertificateID; ///< Truncated hash of platform Boot Object
BIS_ALG_ID AlgorithmID; ///< A signature algorithm number.
UINT16 KeyLength; ///< Length of alg. keys in bits.
UINT16 KeyLength; ///< The length of alg. keys in bits.
} EFI_BIS_SIGNATURE_INFO;
///
/// values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.
/// The exact numeric values come from
/// The exact numeric values come from the
/// "Common Data Security Architecture (CDSA) Specification".
///
#define BIS_ALG_DSA (41) // CSSM_ALGID_DSA
@@ -94,7 +94,7 @@ typedef struct {
#define BIS_CERT_ID_DSA BIS_ALG_DSA // CSSM_ALGID_DSA
#define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA
///
/// the mask value that gets applied to the truncated hash of a
/// The mask value that gets applied to the truncated hash of a
/// platform Boot Object Authorization Certificate to create the certificateID.
/// A certificateID must not have any bits set to the value 1 other than bits in
/// this mask.
@@ -103,7 +103,7 @@ typedef struct {
///
/// Macros for dealing with the EFI_BIS_DATA object obtained
/// from BIS_GetSignatureInfo()
/// from BIS_GetSignatureInfo().
/// BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO
/// elements are contained in a EFI_BIS_DATA struct pointed to
/// by the provided EFI_BIS_DATA*.
@@ -117,7 +117,7 @@ typedef struct {
#define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data)
///
/// Support old name for backward compatibility
/// Support an old name for backward compatibility.
///
#define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \
BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID
@@ -154,12 +154,12 @@ typedef struct {
found
* A resource limitation was encountered while using a cryptographic software module.
@retval EFI_INVALID_PARAMETER The This parameter supplied by the caller is NULL or does not
reference a valid EFI_BIS_PROTOCOL object, or
The AppHandle parameter supplied by the caller is NULL or
an invalid memory reference, or
The InterfaceVersion parameter supplied by the caller
is NULL or an invalid memory reference, or
The TargetAddress parameter supplied by the caller is
reference a valid EFI_BIS_PROTOCOL object. Or,
the AppHandle parameter supplied by the caller is NULL or
an invalid memory reference. Or,
the InterfaceVersion parameter supplied by the caller
is NULL or an invalid memory reference. Or,
the TargetAddress parameter supplied by the caller is
NULL or an invalid memory reference.
**/
@@ -203,7 +203,7 @@ EFI_STATUS
of the BIS service.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
@retval EFI_NO_MAPPING The AppHandle parameter is not, or is no longer, a valid
application instance handle associated with the EFI_BIS protocol.
@retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources.
@retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while
@@ -301,11 +301,12 @@ EFI_STATUS
Retrieves a unique token value to be included in the request credential for the next update of any
parameter in the Boot Object Authorization set
@param AppHandle An opaque handle that identifies the caller's instance of initialization
of the BIS service.
@param UpdateToken The function writes an allocated EFI_BIS_DATA* containing the new
unique update token value. The caller must
eventually free the memory allocated by this function using the function Free().
@param AppHandle An opaque handle that identifies the caller's
instance of initialization of the BIS service.
@param UpdateToken The function writes an allocated EFI_BIS_DATA*
containing the newunique update token value.
The caller musteventually free the memory allocated
by this function using the function Free().
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
@@ -326,13 +327,14 @@ EFI_STATUS
/**
Updates one of the configurable parameters of the Boot Object Authorization set.
@param AppHandle An opaque handle that identifies the caller's instance of initialization
of the BIS service.
@param RequestCredential This is a Signed Manifest with embedded attributes that carry the details
of the requested update.
@param NewUpdateToken The function writes an allocated EFI_BIS_DATA* containing the new
unique update token value. The caller must
eventually free the memory allocated by this function using the function Free().
@param AppHandle An opaque handle that identifies the caller's
instance of initialization of the BIS service.
@param RequestCredential This is a Signed Manifest with embedded attributes
that carry the details of the requested update.
@param NewUpdateToken The function writes an allocated EFI_BIS_DATA*
containing the new unique update token value.
The caller must eventually free the memory allocated
by this function using the function Free().
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid

28
MdePkg/Include/Protocol/ComponentName.h
View File

@@ -3,14 +3,14 @@
This protocol is used to retrieve user readable names of EFI Drivers
and controllers managed by EFI Drivers.
Copyright (c) 2006 - 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -18,7 +18,7 @@
#define __EFI_COMPONENT_NAME_H__
///
/// Global ID for the Component Name Protocol
/// The global ID for the Component Name Protocol.
///
#define EFI_COMPONENT_NAME_PROTOCOL_GUID \
{ \
@@ -29,10 +29,10 @@ typedef struct _EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL;
/**
Retrieves a Unicode string that is the user readable name of the EFI Driver.
Retrieves a Unicode string that is the user-readable name of the EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language A pointer to a three character ISO 639-2 language identifier.
@param Language A pointer to a three-character ISO 639-2 language identifier.
This is the language of the driver name that that the caller
is requesting, and it must match one of the languages specified
in SupportedLanguages. The number of languages supported by a
@@ -75,17 +75,17 @@ EFI_STATUS
that wishes to retrieve the name of a child controller.
@param Language A pointer to a three character ISO 639-2 language
identifier. This is the language of the controller name
that that the caller is requesting, and it must match one
that the caller is requesting, and it must match one
of the languages specified in SupportedLanguages. The
number of languages supported by a driver is up to the
driver writer.
@param ControllerName A pointer to the Unicode string to return. This Unicode
string is the name of the controller specified by
ControllerHandle and ChildHandle in the language specified
by Language from the point of view of the driver specified
by Language, from the point of view of the driver specified
by This.
@retval EFI_SUCCESS The Unicode string for the user readable name in the
@retval EFI_SUCCESS The Unicode string for the user-readable name in the
language specified by Language for the driver
specified by This was returned in DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.

59
MdePkg/Include/Protocol/DebugSupport.h
View File

@@ -5,15 +5,14 @@
The DebugSupport protocol is used by source level debuggers to abstract the
processor and handle context save and restore operations.
Copyright (c) 2006 - 2009, Intel Corporation<BR>
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -25,7 +24,7 @@
typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL;
///
/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}
/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}.
///
#define EFI_DEBUG_SUPPORT_PROTOCOL_GUID \
{ \
@@ -39,7 +38,7 @@ typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL;
typedef INTN EFI_EXCEPTION_TYPE;
///
/// IA-32 processor exception types
/// IA-32 processor exception types.
///
#define EXCEPT_IA32_DIVIDE_ERROR 0
#define EXCEPT_IA32_DEBUG 1
@@ -60,8 +59,8 @@ typedef INTN EFI_EXCEPTION_TYPE;
#define EXCEPT_IA32_SIMD 19
///
/// FXSAVE_STATE
/// FP / MMX / XMM registers (see fxrstor instruction definition)
/// FXSAVE_STATE.
/// FP / MMX / XMM registers (see fxrstor instruction definition).
///
typedef struct {
UINT16 Fcw;
@@ -94,7 +93,7 @@ typedef struct {
} EFI_FX_SAVE_STATE_IA32;
///
/// IA-32 processor context definition
/// IA-32 processor context definition.
///
typedef struct {
UINT32 ExceptionData;
@@ -133,7 +132,7 @@ typedef struct {
} EFI_SYSTEM_CONTEXT_IA32;
///
/// x64 processor exception types
/// x64 processor exception types.
///
#define EXCEPT_X64_DIVIDE_ERROR 0
#define EXCEPT_X64_DEBUG 1
@@ -154,8 +153,8 @@ typedef struct {
#define EXCEPT_X64_SIMD 19
///
/// FXSAVE_STATE
/// FP / MMX / XMM registers (see fxrstor instruction definition)
/// FXSAVE_STATE.
/// FP / MMX / XMM registers (see fxrstor instruction definition).
///
typedef struct {
UINT16 Fcw;
@@ -188,7 +187,7 @@ typedef struct {
} EFI_FX_SAVE_STATE_X64;
///
/// x64 processor context definition
/// x64 processor context definition.
///
typedef struct {
UINT64 ExceptionData;
@@ -236,7 +235,7 @@ typedef struct {
} EFI_SYSTEM_CONTEXT_X64;
///
/// Itanium Processor Family Exception types
/// Itanium Processor Family Exception types.
///
#define EXCEPT_IPF_VHTP_TRANSLATION 0
#define EXCEPT_IPF_INSTRUCTION_TLB 1
@@ -281,7 +280,7 @@ typedef struct {
#define EXCEPT_IPF_IA32_INTERRUPT 47
///
/// IPF processor context definition
/// IPF processor context definition.
///
typedef struct {
//
@@ -437,26 +436,26 @@ typedef struct {
} EFI_SYSTEM_CONTEXT_IPF;
///
/// EBC processor exception types
/// EBC processor exception types.
///
#define EXCEPT_EBC_UNDEFINED 0
#define EXCEPT_EBC_DIVIDE_ERROR 1
#define EXCEPT_EBC_DEBUG 2
#define EXCEPT_EBC_BREAKPOINT 3
#define EXCEPT_EBC_OVERFLOW 4
#define EXCEPT_EBC_INVALID_OPCODE 5 ///< opcode out of range
#define EXCEPT_EBC_INVALID_OPCODE 5 ///< Opcode out of range.
#define EXCEPT_EBC_STACK_FAULT 6
#define EXCEPT_EBC_ALIGNMENT_CHECK 7
#define EXCEPT_EBC_INSTRUCTION_ENCODING 8 ///< malformed instruction
#define EXCEPT_EBC_BAD_BREAK 9 ///< BREAK 0 or undefined BREAK
#define EXCEPT_EBC_STEP 10 ///< to support debug stepping
#define EXCEPT_EBC_INSTRUCTION_ENCODING 8 ///< Malformed instruction.
#define EXCEPT_EBC_BAD_BREAK 9 ///< BREAK 0 or undefined BREAK.
#define EXCEPT_EBC_STEP 10 ///< To support debug stepping.
///
/// For coding convenience, define the maximum valid EBC exception.
///
#define MAX_EBC_EXCEPTION EXCEPT_EBC_STEP
///
/// EBC processor context definition
/// EBC processor context definition.
///
typedef struct {
UINT64 R0;
@@ -475,7 +474,7 @@ typedef struct {
///
/// ARM processor exception types
/// ARM processor exception types.
///
#define EXCEPT_ARM_RESET 0
#define EXCEPT_ARM_UNDEFINED_INSTRUCTION 1
@@ -492,7 +491,7 @@ typedef struct {
#define MAX_ARM_EXCEPTION EXCEPT_ARM_FIQ
///
/// ARM processor context definition
/// ARM processor context definition.
///
typedef struct {
UINT32 R0;
@@ -519,7 +518,7 @@ typedef struct {
} EFI_SYSTEM_CONTEXT_ARM;
///
/// Universal EFI_SYSTEM_CONTEXT definition
/// Universal EFI_SYSTEM_CONTEXT definition.
///
typedef union {
EFI_SYSTEM_CONTEXT_EBC *SystemContextEbc;
@@ -536,7 +535,7 @@ typedef union {
/**
Registers and enables an exception callback function for the specified exception.
@param ExceptionType Exception types in EBC, IA-32, x64, or IPF
@param ExceptionType Exception types in EBC, IA-32, x64, or IPF.
@param SystemContext Exception content.
**/

248
MdePkg/Include/Protocol/DevicePath.h
View File

@@ -5,14 +5,14 @@
from a software point of view. The path must persist from boot to boot, so
it can not contain things like PCI bus numbers that change from boot to boot.
Copyright (c) 2006 - 2009, Intel Corporation
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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 @@
#include <Guid/PcAnsi.h>
///
/// Device Path protocol
/// Device Path protocol.
///
#define EFI_DEVICE_PATH_PROTOCOL_GUID \
{ \
@@ -45,17 +45,17 @@
that make up the Device Path.
**/
typedef struct {
UINT8 Type; ///< 0x01 Hardware Device Path
///< 0x02 ACPI Device Path
///< 0x03 Messaging Device Path
///< 0x04 Media Device Path
///< 0x05 BIOS Boot Specification Device Path
///< 0x7F End of Hardware Device Path
UINT8 Type; ///< 0x01 Hardware Device Path.
///< 0x02 ACPI Device Path.
///< 0x03 Messaging Device Path.
///< 0x04 Media Device Path.
///< 0x05 BIOS Boot Specification Device Path.
///< 0x7F End of Hardware Device Path.
UINT8 SubType; ///< Varies by Type
///< 0xFF End Entire Device Path, or
///< 0x01 End This Instance of a Device Path and start a new
///< Device Path
///< Device Path.
UINT8 Length[2]; ///< Specific Device Path data. Type and Sub-Type define
///< type of data. Size of data is included in Length.
@@ -68,53 +68,53 @@ typedef struct {
typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH;
///
/// Hardware Device Paths
/// Hardware Device Paths.
///
#define HARDWARE_DEVICE_PATH 0x01
///
/// PCI Device Path SubType
/// PCI Device Path SubType.
///
#define HW_PCI_DP 0x01
///
/// PCI Device Path
/// PCI Device Path.
///
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// PCI Function Number
/// PCI Function Number.
///
UINT8 Function;
///
/// PCI Device Number
/// PCI Device Number.
///
UINT8 Device;
} PCI_DEVICE_PATH;
///
/// PCCARD Device Path SubType
/// PCCARD Device Path SubType.
///
#define HW_PCCARD_DP 0x02
///
/// PCCARD Device Path
/// PCCARD Device Path.
///
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Function Number (0 = First Function)
/// Function Number (0 = First Function).
///
UINT8 FunctionNumber;
} PCCARD_DEVICE_PATH;
///
/// Memory Mapped Device Path SubType
/// Memory Mapped Device Path SubType.
///
#define HW_MEMMAP_DP 0x03
///
/// Memory Mapped Device Path
/// Memory Mapped Device Path.
///
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
@@ -127,13 +127,13 @@ typedef struct {
///
EFI_PHYSICAL_ADDRESS StartingAddress;
///
/// Ending Memory Address
/// Ending Memory Address.
///
EFI_PHYSICAL_ADDRESS EndingAddress;
} MEMMAP_DEVICE_PATH;
///
/// Hardware Vendor Device Path SubType
/// Hardware Vendor Device Path SubType.
///
#define HW_VENDOR_DP 0x04
@@ -154,12 +154,12 @@ typedef struct {
} VENDOR_DEVICE_PATH;
///
/// Controller Device Path SubType
/// Controller Device Path SubType.
///
#define HW_CONTROLLER_DP 0x05
///
/// Controller Device Path
/// Controller Device Path.
///
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
@@ -170,12 +170,12 @@ typedef struct {
} CONTROLLER_DEVICE_PATH;
///
/// ACPI Device Paths
/// ACPI Device Paths.
///
#define ACPI_DEVICE_PATH 0x02
///
/// ACPI Device Path SubType
/// ACPI Device Path SubType.
///
#define ACPI_DP 0x01
typedef struct {
@@ -190,14 +190,14 @@ typedef struct {
/// Unique ID that is required by ACPI if two devices have the
/// same _HID. This value must also match the corresponding
/// _UID/_HID pair in the ACPI name space. Only the 32-bit
/// numeric value type of _UID is supported; thus strings must
/// numeric value type of _UID is supported. Thus, strings must
/// not be used for the _UID in the ACPI name space.
///
UINT32 UID;
} ACPI_HID_DEVICE_PATH;
///
/// Expanded ACPI Device Path SubType
/// Expanded ACPI Device Path SubType.
///
#define ACPI_EXTENDED_DP 0x02
typedef struct {
@@ -222,9 +222,9 @@ typedef struct {
///
UINT32 CID;
///
/// Optional variable length _HIDSTR
/// Optional variable length _UIDSTR
/// Optional variable length _CIDSTR
/// Optional variable length _HIDSTR.
/// Optional variable length _UIDSTR.
/// Optional variable length _CIDSTR.
///
} ACPI_EXTENDED_HID_DEVICE_PATH;
@@ -244,7 +244,7 @@ typedef struct {
#define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
///
/// ACPI _ADR Device Path SubType
/// ACPI _ADR Device Path SubType.
///
#define ACPI_ADR_DP 0x03
@@ -257,7 +257,7 @@ typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// _ADR value. For video output devices the value of this
/// field comes from Table B-2 ACPI 3.0 specification. At
/// field comes from Table B-2 of the ACPI 3.0 specification. At
/// least one _ADR value is required.
///
UINT32 ADR;
@@ -283,7 +283,7 @@ typedef struct {
((_Index) & 0xf) ))
///
/// Messaging Device Paths
/// Messaging Device Paths.
/// This Device Path is used to describe the connection of devices outside the resource domain of the
/// system. This Device Path can describe physical messaging information like SCSI ID, or abstract
/// information like networking protocol IP addresses.
@@ -297,37 +297,37 @@ typedef struct {
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Set to zero for primary or one for secondary
/// Set to zero for primary, or one for secondary.
///
UINT8 PrimarySecondary;
///
/// Set to zero for master or one for slave mode
/// Set to zero for master, or one for slave mode.
///
UINT8 SlaveMaster;
///
/// Logical Unit Number
/// Logical Unit Number.
///
UINT16 Lun;
} ATAPI_DEVICE_PATH;
///
/// SCSI Device Path SubType
/// SCSI Device Path SubType.
///
#define MSG_SCSI_DP 0x02
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Target ID on the SCSI bus (PUN)
/// Target ID on the SCSI bus (PUN).
///
UINT16 Pun;
///
/// Logical Unit Number (LUN)
/// Logical Unit Number (LUN).
///
UINT16 Lun;
} SCSI_DEVICE_PATH;
///
/// Fibre Channel SubType
/// Fibre Channel SubType.
///
#define MSG_FIBRECHANNEL_DP 0x03
typedef struct {
@@ -363,23 +363,23 @@ typedef struct {
} F1394_DEVICE_PATH;
///
/// USB Device Path SubType
/// USB Device Path SubType.
///
#define MSG_USB_DP 0x05
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// USB Parent Port Number
/// USB Parent Port Number.
///
UINT8 ParentPortNumber;
///
/// USB Interface Number
/// USB Interface Number.
///
UINT8 InterfaceNumber;
} USB_DEVICE_PATH;
///
/// USB Class Device Path SubType
/// USB Class Device Path SubType.
///
#define MSG_USB_CLASS_DP 0x0f
typedef struct {
@@ -412,7 +412,7 @@ typedef struct {
} USB_CLASS_DEVICE_PATH;
///
/// USB WWID Device Path SubType
/// USB WWID Device Path SubType.
///
#define MSG_USB_WWID_DP 0x10
@@ -422,15 +422,15 @@ typedef struct {
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// USB interface number
/// USB interface number.
///
UINT16 InterfaceNumber;
///
/// USB vendor id of the device
/// USB vendor id of the device.
///
UINT16 VendorId;
///
/// USB product id of the device
/// USB product id of the device.
///
UINT16 ProductId;
///
@@ -443,19 +443,19 @@ typedef struct {
} USB_WWID_DEVICE_PATH;
///
/// Device Logical Unit SubType
/// Device Logical Unit SubType.
///
#define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Logical Unit Number for the interface
/// Logical Unit Number for the interface.
///
UINT8 Lun;
} DEVICE_LOGICAL_UNIT_DEVICE_PATH;
///
/// SATA Device Path SubType
/// SATA Device Path SubType.
///
#define MSG_SATA_DP 0x12
typedef struct {
@@ -483,25 +483,25 @@ typedef struct {
#define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000
///
/// I2O Device Path SubType
/// I2O Device Path SubType.
///
#define MSG_I2O_DP 0x06
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Target ID (TID) for a device
/// Target ID (TID) for a device.
///
UINT32 Tid;
} I2O_DEVICE_PATH;
///
/// MAC Address Device Path SubType
/// MAC Address Device Path SubType.
///
#define MSG_MAC_ADDR_DP 0x0b
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// The MAC address for a network interface padded with 0s
/// The MAC address for a network interface padded with 0s.
///
EFI_MAC_ADDRESS MacAddress;
///
@@ -517,19 +517,19 @@ typedef struct {
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// The local IPv4 address
/// The local IPv4 address.
///
EFI_IPv4_ADDRESS LocalIpAddress;
///
/// The remote IPv4 address
/// The remote IPv4 address.
///
EFI_IPv4_ADDRESS RemoteIpAddress;
///
/// The local port number
/// The local port number.
///
UINT16 LocalPort;
///
/// The remote port number
/// The remote port number.
///
UINT16 RemotePort;
///
@@ -537,32 +537,32 @@ typedef struct {
///
UINT16 Protocol;
///
/// 0x00 - The Source IP Address was assigned though DHCP
/// 0x01 - The Source IP Address is statically bound
/// 0x00 - The Source IP Address was assigned though DHCP.
/// 0x01 - The Source IP Address is statically bound.
///
BOOLEAN StaticIpAddress;
} IPv4_DEVICE_PATH;
///
/// IPv6 Device Path SubType
/// IPv6 Device Path SubType.
///
#define MSG_IPv6_DP 0x0d
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// The local IPv6 address
/// The local IPv6 address.
///
EFI_IPv6_ADDRESS LocalIpAddress;
///
/// The remote IPv6 address
/// The remote IPv6 address.
///
EFI_IPv6_ADDRESS RemoteIpAddress;
///
/// The local port number
/// The local port number.
///
UINT16 LocalPort;
///
/// The remote port number
/// The remote port number.
///
UINT16 RemotePort;
///
@@ -570,43 +570,43 @@ typedef struct {
///
UINT16 Protocol;
///
/// 0x00 - The Source IP Address was assigned though DHCP
/// 0x01 - The Source IP Address is statically bound
/// 0x00 - The Source IP Address was assigned though DHCP.
/// 0x01 - The Source IP Address is statically bound.
///
BOOLEAN StaticIpAddress;
} IPv6_DEVICE_PATH;
///
/// InfiniBand Device Path SubType
/// InfiniBand Device Path SubType.
///
#define MSG_INFINIBAND_DP 0x09
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Flags to help identify/manage InfiniBand device path elements:
/// Bit 0 - IOC/Service (0b = IOC, 1b = Service)
/// Bit 1 - Extend Boot Environment
/// Bit 2 - Console Protocol
/// Bit 3 - Storage Protocol
/// Bit 4 - Network Protocol
/// Bit 0 - IOC/Service (0b = IOC, 1b = Service).
/// Bit 1 - Extend Boot Environment.
/// Bit 2 - Console Protocol.
/// Bit 3 - Storage Protocol.
/// Bit 4 - Network Protocol.
/// All other bits are reserved.
///
UINT32 ResourceFlags;
///
/// 128-bit Global Identifier for remote fabric port
/// 128-bit Global Identifier for remote fabric port.
///
UINT8 PortGid[16];
///
/// 64-bit unique identifier to remote IOC or server process.
/// Interpretation of field specified by Resource Flags (bit 0)
/// Interpretation of field specified by Resource Flags (bit 0).
///
UINT64 ServiceId;
///
/// 64-bit persistent ID of remote IOC port
/// 64-bit persistent ID of remote IOC port.
///
UINT64 TargetPortId;
///
/// 64-bit persistent ID of remote device
/// 64-bit persistent ID of remote device.
///
UINT64 DeviceId;
} INFINIBAND_DEVICE_PATH;
@@ -618,13 +618,13 @@ typedef struct {
#define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
///
/// UART Device Path SubType
/// UART Device Path SubType.
///
#define MSG_UART_DP 0x0e
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Reserved
/// Reserved.
///
UINT32 Reserved;
///
@@ -639,20 +639,20 @@ typedef struct {
UINT8 DataBits;
///
/// The parity setting for the UART style device.
/// Parity 0x00 - Default Parity
/// Parity 0x01 - No Parity
/// Parity 0x02 - Even Parity
/// Parity 0x03 - Odd Parity
/// Parity 0x04 - Mark Parity
/// Parity 0x05 - Space Parity
/// Parity 0x00 - Default Parity.
/// Parity 0x01 - No Parity.
/// Parity 0x02 - Even Parity.
/// Parity 0x03 - Odd Parity.
/// Parity 0x04 - Mark Parity.
/// Parity 0x05 - Space Parity.
///
UINT8 Parity;
///
/// The number of stop bits for the UART style device.
/// Stop Bits 0x00 - Default Stop Bits
/// Stop Bits 0x01 - 1 Stop Bit
/// Stop Bits 0x02 - 1.5 Stop Bits
/// Stop Bits 0x03 - 2 Stop Bits
/// Stop Bits 0x00 - Default Stop Bits.
/// Stop Bits 0x01 - 1 Stop Bit.
/// Stop Bits 0x02 - 1.5 Stop Bits.
/// Stop Bits 0x03 - 2 Stop Bits.
///
UINT8 StopBits;
} UART_DEVICE_PATH;
@@ -675,7 +675,7 @@ typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH;
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID
/// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID.
///
EFI_GUID Guid;
///
@@ -694,7 +694,7 @@ typedef struct {
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// DEVICE_PATH_MESSAGING_SAS GUID
/// DEVICE_PATH_MESSAGING_SAS GUID.
///
EFI_GUID Guid;
///
@@ -710,11 +710,11 @@ typedef struct {
///
UINT64 Lun;
///
/// More Information about the device and its interconnect
/// More Information about the device and its interconnect.
///
UINT16 DeviceTopology;
///
/// Relative Target Port (RTP)
/// Relative Target Port (RTP).
///
UINT16 RelativeTargetPort;
} SAS_DEVICE_PATH;
@@ -726,15 +726,15 @@ typedef struct {
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// Network Protocol (0 = TCP, 1+ = reserved)
/// Network Protocol (0 = TCP, 1+ = reserved).
///
UINT16 NetworkProtocol;
///
/// iSCSI Login Options
/// iSCSI Login Options.
///
UINT16 LoginOption;
///
/// iSCSI Logical Unit Number
/// iSCSI Logical Unit Number.
///
UINT64 Lun;
///
@@ -746,7 +746,7 @@ typedef struct {
/// iSCSI NodeTarget Name. The length of the name
/// is determined by subtracting the offset of this field from Length.
///
/// CHAR8 iSCSI Target Name
/// CHAR8 iSCSI Target Name.
} ISCSI_DEVICE_PATH;
#define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
@@ -759,13 +759,13 @@ typedef struct {
#define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
///
/// VLAN Device Path SubType
/// VLAN Device Path SubType.
///
#define MSG_VLAN_DP 0x14
typedef struct {
EFI_DEVICE_PATH_PROTOCOL Header;
///
/// VLAN identifier (0-4094)
/// VLAN identifier (0-4094).
///
UINT16 VlanId;
} VLAN_DEVICE_PATH;
@@ -776,7 +776,7 @@ typedef struct {
#define MEDIA_DEVICE_PATH 0x04
///
/// Hard Drive Media Device Path SubType
/// Hard Drive Media Device Path SubType.
///
#define MEDIA_HARDDRIVE_DP 0x01
@@ -793,11 +793,11 @@ typedef struct {
///
UINT32 PartitionNumber;
///
/// Starting LBA of the partition on the hard drive
/// Starting LBA of the partition on the hard drive.
///
UINT64 PartitionStart;
///
/// Size of the partition in units of Logical Blocks
/// Size of the partition in units of Logical Blocks.
///
UINT64 PartitionSize;
///
@@ -809,13 +809,13 @@ typedef struct {
///
UINT8 Signature[16];
///
/// Partition Format: (Unused values reserved)
/// 0x01 - PC-AT compatible legacy MBR
/// 0x02 - GUID Partition Table
/// Partition Format: (Unused values reserved).
/// 0x01 - PC-AT compatible legacy MBR.
/// 0x02 - GUID Partition Table.
///
UINT8 MBRType;
///
/// Type of Disk Signature: (Unused values reserved)
/// Type of Disk Signature: (Unused values reserved).
/// 0x00 - No Disk Signature.
/// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.
/// 0x02 - GUID signature.
@@ -831,7 +831,7 @@ typedef struct {
#define SIGNATURE_TYPE_GUID 0x02
///
/// CD-ROM Media Device Path SubType
/// CD-ROM Media Device Path SubType.
///
#define MEDIA_CDROM_DP 0x02
@@ -857,7 +857,7 @@ typedef struct {
//
// Use VENDOR_DEVICE_PATH struct
//
#define MEDIA_VENDOR_DP 0x03 ///< Media vendor device path subtype
#define MEDIA_VENDOR_DP 0x03 ///< Media vendor device path subtype.
///
/// File Path Media Device Path SubType
@@ -874,7 +874,7 @@ typedef struct {
#define SIZE_OF_FILEPATH_DEVICE_PATH OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)
///
/// Media Protocol Device Path SubType
/// Media Protocol Device Path SubType.
///
#define MEDIA_PROTOCOL_DP 0x05
@@ -892,7 +892,7 @@ typedef struct {
} MEDIA_PROTOCOL_DEVICE_PATH;
///
/// PIWG Firmware Volume Device Path SubType
/// PIWG Firmware Volume Device Path SubType.
///
#define MEDIA_PIWG_FW_FILE_DP 0x06
@@ -908,7 +908,7 @@ typedef struct {
} MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;
///
/// PIWG Firmware Volume Device Path SubType
/// PIWG Firmware Volume Device Path SubType.
///
#define MEDIA_PIWG_FW_VOL_DP 0x07
@@ -924,7 +924,7 @@ typedef struct {
} MEDIA_FW_VOL_DEVICE_PATH;
///
/// Media relative offset range device path
/// Media relative offset range device path.
///
#define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08
@@ -939,12 +939,12 @@ typedef struct {
} MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH;
///
/// BIOS Boot Specification Device Path
/// BIOS Boot Specification Device Path.
///
#define BBS_DEVICE_PATH 0x05
///
/// BIOS Boot Specification Device Path SubType
/// BIOS Boot Specification Device Path SubType.
///
#define BBS_BBS_DP 0x01
@@ -958,7 +958,7 @@ typedef struct {
///
UINT16 DeviceType;
///
/// Status Flags as defined by the BIOS Boot Specification
/// Status Flags as defined by the BIOS Boot Specification.
///
UINT16 StatusFlag;
///
@@ -981,7 +981,7 @@ typedef struct {
///
/// Union of all possible Device Paths and pointers to Device Paths
/// Union of all possible Device Paths and pointers to Device Paths.
///
typedef union {
EFI_DEVICE_PATH_PROTOCOL DevPath;

110
MdePkg/Include/Protocol/Dhcp4.h
View File

@@ -4,17 +4,17 @@
These protocols are used to collect configuration information for the EFI IPv4 Protocol
drivers and to provide DHCPv4 server and PXE boot server discovery services.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
This Protocol was introduced in UEFI Specification 2.0.
**/
@@ -64,11 +64,11 @@ typedef struct {
UINT32 Xid;
UINT16 Seconds;
UINT16 Reserved;
EFI_IPv4_ADDRESS ClientAddr; ///< Client IP address from client
EFI_IPv4_ADDRESS YourAddr; ///< Client IP address from server
EFI_IPv4_ADDRESS ServerAddr; ///< IP address of next server in bootstrap
EFI_IPv4_ADDRESS GatewayAddr; ///< Relay agent IP address
UINT8 ClientHwAddr[16]; ///< Client hardware address
EFI_IPv4_ADDRESS ClientAddr; ///< Client IP address from client.
EFI_IPv4_ADDRESS YourAddr; ///< Client IP address from server.
EFI_IPv4_ADDRESS ServerAddr; ///< IP address of next server in bootstrap.
EFI_IPv4_ADDRESS GatewayAddr; ///< Relay agent IP address.
UINT8 ClientHwAddr[16]; ///< Client hardware address.
CHAR8 ServerName[64];
CHAR8 BootFileName[128];
}EFI_DHCP4_HEADER;
@@ -107,11 +107,11 @@ typedef struct {
typedef enum {
///
/// The EFI DHCPv4 Protocol driver is stopped
/// The EFI DHCPv4 Protocol driver is stopped.
///
Dhcp4Stopped = 0x0,
///
/// The EFI DHCPv4 Protocol driver is inactive
/// The EFI DHCPv4 Protocol driver is inactive.
///
Dhcp4Init = 0x1,
///
@@ -137,7 +137,7 @@ typedef enum {
///
Dhcp4Rebinding = 0x6,
///
/// The EFI DHCPv4 Protocol driver is initialized with a previously
/// The EFI DHCPv4 Protocol driver was initialized with a previously
/// allocated or known IP address.
///
Dhcp4InitReboot = 0x7,
@@ -216,9 +216,9 @@ typedef enum{
There are three possible returned values, which are described in the following
table.
@param This Pointer to the EFI DHCPv4 Protocol instance that is used to
@param This The pointer to the EFI DHCPv4 Protocol instance that is used to
configure this callback function.
@param Context Pointer to the context that is initialized by
@param Context The pointer to the context that is initialized by
EFI_DHCP4_PROTOCOL.Configure().
@param CurrentState The current operational state of the EFI DHCPv4 Protocol
driver.
@@ -251,25 +251,25 @@ EFI_STATUS
typedef struct {
///
/// Number of times to try sending a packet during the Dhcp4SendDiscover
/// The number of times to try sending a packet during the Dhcp4SendDiscover
/// event and waiting for a response during the Dhcp4RcvdOffer event.
/// Set to zero to use the default try counts and timeout values.
///
UINT32 DiscoverTryCount;
///
/// Maximum amount of time (in seconds) to wait for returned packets in each
/// The maximum amount of time (in seconds) to wait for returned packets in each
/// of the retries. Timeout values of zero will default to a timeout value
/// of one second. Set to NULL to use default timeout values.
///
UINT32 *DiscoverTimeout;
///
/// Number of times to try sending a packet during the Dhcp4SendRequest event
/// The number of times to try sending a packet during the Dhcp4SendRequest event
/// and waiting for a response during the Dhcp4RcvdAck event before accepting
/// failure. Set to zero to use the default try counts and timeout values.
///
UINT32 RequestTryCount;
///
/// Maximum amount of time (in seconds) to wait for return packets in each of the retries.
/// The maximum amount of time (in seconds) to wait for return packets in each of the retries.
/// Timeout values of zero will default to a timeout value of one second.
/// Set to NULL to use default timeout values.
///
@@ -288,7 +288,7 @@ typedef struct {
///
EFI_DHCP4_CALLBACK Dhcp4Callback;
///
/// Pointer to the context that will be passed to Dhcp4Callback when it is called.
/// The pointer to the context that will be passed to Dhcp4Callback when it is called.
///
VOID *CallbackContext;
///
@@ -379,15 +379,15 @@ typedef struct {
///
EFI_EVENT CompletionEvent;
///
/// Pointer to the server IP address. This address may be a unicast, multicast, or broadcast address.
/// The pointer to the server IP address. This address may be a unicast, multicast, or broadcast address.
///
EFI_IPv4_ADDRESS RemoteAddress;
///
/// Server listening port number. If zero, the default server listening port number (67) will be used.
/// The server listening port number. If zero, the default server listening port number (67) will be used.
///
UINT16 RemotePort;
///
/// Pointer to the gateway address to override the existing setting.
/// The pointer to the gateway address to override the existing setting.
///
EFI_IPv4_ADDRESS GatewayAddress;
///
@@ -400,11 +400,11 @@ typedef struct {
///
EFI_DHCP4_LISTEN_POINT *ListenPoints;
///
/// Number of seconds to collect responses. Zero is invalid.
/// The number of seconds to collect responses. Zero is invalid.
///
UINT32 TimeoutValue;
///
/// Pointer to the packet to be transmitted.
/// The pointer to the packet to be transmitted.
///
EFI_DHCP4_PACKET *Packet;
///
@@ -412,7 +412,7 @@ typedef struct {
///
UINT32 ResponseCount;
///
/// Pointer to the allocated list of received packets.
/// The pointer to the allocated list of received packets.
///
EFI_DHCP4_PACKET *ResponseList;
} EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN;
@@ -424,8 +424,8 @@ typedef struct {
The GetModeData() function returns the current operating mode and cached data
packet for the EFI DHCPv4 Protocol driver.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@param Dhcp4ModeData The pointer to storage for the EFI_DHCP4_MODE_DATA structure.
@retval EFI_SUCCESS The mode data was returned.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -453,7 +453,7 @@ EFI_STATUS
When this driver is in the Dhcp4Stopped state, it can transfer into one of the
following two possible initial states:
* Dhcp4Init
* Dhcp4InitReboot
* Dhcp4InitReboot.
The driver can transfer into these states by calling Configure() with a non-NULL
Dhcp4CfgData. The driver will transfer into the appropriate state based on the
supplied client network address in the ClientAddress parameter and DHCP options
@@ -464,8 +464,8 @@ EFI_STATUS
wants to make it possible for another instance to configure the EFI DHCPv4 Protocol
driver, it must call this function with Dhcp4CfgData set to NULL.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@param Dhcp4CfgData The pointer to the EFI_DHCP4_CONFIG_DATA.
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or
Dhcp4InitReboot state, if the original state of this driver
@@ -511,8 +511,8 @@ EFI_STATUS
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this
opportunity to control the process.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param CompletionEvent If not NULL, indicates the event that will be signaled when the
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@param CompletionEvent If not NULL, it indicates the event that will be signaled when the
EFI DHCPv4 Protocol driver is transferred into the
Dhcp4Bound state or when the DHCP process is aborted.
EFI_DHCP4_PROTOCOL.GetModeData() can be called to
@@ -546,7 +546,7 @@ EFI_STATUS
Extends the lease time by sending a request packet.
The RenewRebind() function is used to manually extend the lease time when the
EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has
EFI DHCPv4 Protocol driver is in the Dhcp4Bound state, and the lease time has
not expired yet. This function will send a request packet to the previously
found server (or to any server when RebindRequest is TRUE) and transfer the
state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is
@@ -554,10 +554,10 @@ EFI_STATUS
If no response is received before the try count is exceeded (the RequestTryCount
field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that
was issued by the previous server expires, the driver will return to the Dhcp4Bound
state and the previous configuration is restored. The outgoing and incoming packets
state, and the previous configuration is restored. The outgoing and incoming packets
can be captured by the EFI_DHCP4_CALLBACK function.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@param RebindRequest If TRUE, this function broadcasts the request packets and enters
the Dhcp4Rebinding state. Otherwise, it sends a unicast
request packet and enters the Dhcp4Renewing state.
@@ -599,9 +599,9 @@ EFI_STATUS
EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in
Dhcp4InitReboot state
After a successful call to this function, the EFI DHCPv4 Protocol driver returns
to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.
to the Dhcp4Init state, and any subsequent incoming packets will be discarded silently.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -624,7 +624,7 @@ EFI_STATUS
before DHCP configuration process can be started again. This function can be
called when the EFI DHCPv4 Protocol driver is in any state.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -644,17 +644,17 @@ EFI_STATUS
does not change any state of the EFI DHCPv4 Protocol driver and can be used at
any time.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@param SeedPacket Initial packet to be used as a base for building new packet.
@param DeleteCount Number of opcodes in the DeleteList.
@param DeleteList List of opcodes to be deleted from the seed packet.
Ignored if DeleteCount is zero.
@param AppendCount Number of entries in the OptionList.
@param AppendList Pointer to a DHCP option list to be appended to SeedPacket.
@param AppendList The pointer to a DHCP option list to be appended to SeedPacket.
If SeedPacket also contains options in this list, they are
replaced by new options (except pad option). Ignored if
AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION
@param NewPacket Pointer to storage for the pointer to the new allocated packet.
@param NewPacket The pointer to storage for the pointer to the new allocated packet.
Use the EFI Boot Service FreePool() on the resulting pointer
when done with the packet.
@@ -689,10 +689,10 @@ EFI_STATUS
The TransmitReceive() function is used to transmit a DHCP packet and optionally
wait for the response from servers. This function does not change the state of
the EFI DHCPv4 Protocol driver and thus can be used at any time.
the EFI DHCPv4 Protocol driver. It can be used at any time because of this.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@param Token The pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.
@retval EFI_SUCCESS The packet was successfully queued for transmission.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
@@ -728,25 +728,25 @@ EFI_STATUS
If *OptionCount is zero or there isn't enough space for all of them, the number
of DHCP options in the Packet is returned in OptionCount.
@param This Pointer to the EFI_DHCP4_PROTOCOL instance.
@param Packet Pointer to packet to be parsed.
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.
@param Packet The pointer to packet to be parsed.
@param OptionCount On input, the number of entries in the PacketOptionList.
On output, the number of entries that were written into the
PacketOptionList.
@param PacketOptionList List of packet option entries to be filled in. End option or pad
@param PacketOptionList A list of packet option entries to be filled in. End option or pad
options are not included.
@retval EFI_SUCCESS The packet was successfully parsed.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL.
Packet is NULL.
Packet is not a well-formed DHCP packet.
The packet is NULL.
The packet is not a well-formed DHCP packet.
OptionCount is NULL.
@retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE:
1) *OptionCount is smaller than the number of options that
were found in the Packet.
2) PacketOptionList is NULL.
@retval EFI_OUT_OF_RESOURCE The packet is failed to parse because of resource shortage.
@retval EFI_OUT_OF_RESOURCE The packet failed to parse because of a resource shortage.
**/
typedef

24
MdePkg/Include/Protocol/DriverBinding.h
View File

@@ -4,14 +4,14 @@
This protocol is produced by every driver that follows the UEFI Driver Model,
and it is the central component that allows drivers and controllers to be managed.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -19,7 +19,7 @@
#define __EFI_DRIVER_BINDING_H__
///
/// Global ID for the ControllerHandle Driver Protocol
/// The global ID for the ControllerHandle Driver Protocol.
///
#define EFI_DRIVER_BINDING_PROTOCOL_GUID \
{ \
@@ -42,7 +42,7 @@ typedef struct _EFI_DRIVER_BINDING_PROTOCOL EFI_DRIVER_BINDING_PROTOCOL;
device specified by ControllerHandle may already be managed by the same driver or a
different driver. This function must match its calls to AllocatePages() with FreePages(),
AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
Since ControllerHandle may have been previously started by the same driver, if a protocol is
Because ControllerHandle may have been previously started by the same driver, if a protocol is
already in the opened state, then it must not be closed with CloseProtocol(). This is required
to guarantee the state of ControllerHandle is not modified by this function.
@@ -84,7 +84,7 @@ EFI_STATUS
The Start() function is designed to be invoked from the EFI boot service ConnectController().
As a result, much of the error checking on the parameters to Start() has been moved into this
common boot service. It is legal to call Start() from other locations,
but the following calling restrictions must be followed or the system behavior will not be deterministic.
but the following calling restrictions must be followed, or the system behavior will not be deterministic.
1. ControllerHandle must be a valid EFI_HANDLE.
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
EFI_DEVICE_PATH_PROTOCOL.
@@ -127,7 +127,7 @@ EFI_STATUS
The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
As a result, much of the error checking on the parameters to Stop() has been moved
into this common boot service. It is legal to call Stop() from other locations,
but the following calling restrictions must be followed or the system behavior will not be deterministic.
but the following calling restrictions must be followed, or the system behavior will not be deterministic.
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
same driver's Start() function.
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid

20
MdePkg/Include/Protocol/DriverDiagnostics.h
View File

@@ -1,14 +1,14 @@
/** @file
EFI Driver Diagnostics Protocol
Copyright (c) 2006 - 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -16,7 +16,7 @@
#define __EFI_DRIVER_DIAGNOSTICS_H__
///
/// Global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.
/// The global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.
///
#define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \
{ \
@@ -74,7 +74,7 @@ typedef enum {
@retval EFI_SUCCESS The controller specified by ControllerHandle and
ChildHandle passed the diagnostic.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ErrorType is NULL.
@retval EFI_INVALID_PARAMETER BufferType is NULL.

16
MdePkg/Include/Protocol/DriverFamilyOverride.h
View File

@@ -1,14 +1,14 @@
/** @file
UEFI Driver Family Protocol
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/

38
MdePkg/Include/Protocol/FirmwareVolumeBlock.h
View File

@@ -1,14 +1,14 @@
/** @file
This file provides control over block-oriented firmware devices.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference: PI
Version 1.0 and 1.2.
@@ -98,7 +98,7 @@ EFI_STATUS
return from GetPhysicalAddress(), contains the
base address of the firmware volume.
@retval EFI_SUCCESS The firmware volume base address is returned.
@retval EFI_SUCCESS The firmware volume base address was returned.
@retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.
@@ -131,7 +131,7 @@ EFI_STATUS
BlockSize.
@retval EFI_SUCCESS The firmware volume base address is returned.
@retval EFI_SUCCESS The firmware volume base address was returned.
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.
@@ -177,7 +177,7 @@ EFI_STATUS
@param Buffer Pointer to a caller-allocated buffer that will
be used to hold the data that is read.
@retval EFI_SUCCESS The firmware volume was read successfully
@retval EFI_SUCCESS The firmware volume was read successfully,
and contents are in Buffer.
@retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA
@@ -214,9 +214,9 @@ EFI_STATUS
function, or else the result will be unpredictable. This
unpredictability arises because, for a sticky-write firmware
volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY
state but cannot flip it back again. In general, before
calling the Write() function, the caller should call the
EraseBlocks() function first to erase the specified block to
state but cannot flip it back again. Before calling the
Write() function, it is recommended for the caller to first call
the EraseBlocks() function to erase the specified block to
write. A block erase cycle will transition bits from the
(NOT)EFI_FVB_ERASE_POLARITY state back to the
EFI_FVB_ERASE_POLARITY state. Implementations should be
@@ -239,12 +239,12 @@ EFI_STATUS
@param Offset Offset into the block at which to begin writing.
@param NumBytes Pointer to a UINTN. At entry, *NumBytes
@param NumBytes The pointer to a UINTN. At entry, *NumBytes
contains the total size of the buffer. At
exit, *NumBytes contains the total number of
bytes actually written.
@param Buffer Pointer to a caller-allocated buffer that
@param Buffer The pointer to a caller-allocated buffer that
contains the source for the write.
@retval EFI_SUCCESS The firmware volume was written successfully.
@@ -307,7 +307,7 @@ EFI_STATUS
and consists of the following:
- An EFI_LBA that indicates the starting LBA
- A UINTN that indicates the number of blocks to
erase
erase.
The list is terminated with an
EFI_LBA_LIST_TERMINATOR. For example, the
@@ -315,7 +315,7 @@ EFI_STATUS
(5-7 and 10-11) are to be erased: EraseBlocks
(This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);
@retval EFI_SUCCESS The erase request was successfully
@retval EFI_SUCCESS The erase request successfully
completed.
@retval EFI_ACCESS_DENIED The firmware volume is in the
@@ -354,7 +354,7 @@ struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL{
EFI_FVB_WRITE Write;
EFI_FVB_ERASE_BLOCKS EraseBlocks;
///
/// Handle of the parent firmware volume.
/// The handle of the parent firmware volume.
///
EFI_HANDLE ParentHandle;
};

27
MdePkg/Include/Protocol/FormBrowser2.h
View File

@@ -4,14 +4,14 @@
The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to
leverage the EFI configuration driver interface.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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,19 +30,19 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL;
/**
@param LeftColumn Value that designates the text column
@param LeftColumn The value that designates the text column
where the browser window will begin from
the left-hand side of the screen
@param RightColumn Value that designates the text
@param RightColumn The value that designates the text
column where the browser window will end
on the right-hand side of the screen.
@param TopRow Value that designates the text row from the
@param TopRow The value that designates the text row from the
top of the screen where the browser window
will start.
@param BottomRow Value that designates the text row from the
@param BottomRow The value that designates the text row from the
bottom of the screen where the browser
window will end.
**/
@@ -121,7 +121,8 @@ EFI_STATUS
@param ResultsDataSize A pointer to the size of the buffer
associated with ResultsData. On input, the size in
bytes of ResultsData. On output, the size of data returned in ResultsData.
bytes of ResultsData. On output, the size of data
returned in ResultsData.
@param ResultsData A string returned from an IFR browser or
equivalent. The results string will have

18
MdePkg/Include/Protocol/Hash.h
View File

@@ -5,14 +5,14 @@
provided by a driver and to create and destroy instances of the EFI Hash Protocol
so that a multiple drivers can use the underlying hashing services.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -113,7 +113,7 @@ EFI_STATUS
@retval EFI_SUCCESS Hash returned successfully.
@retval EFI_INVALID_PARAMETER Message or Hash is NULL
@retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this
driver. Or extend is TRUE and the algorithm doesn't support extending the hash.
driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash.
**/
typedef

18
MdePkg/Include/Protocol/HiiConfigAccess.h
View File

@@ -5,14 +5,14 @@
This protocol is published by drivers providing and requesting
configuration data from HII. It may only be invoked by HII.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -72,7 +72,7 @@ typedef UINTN EFI_BROWSER_ACTION;
failing name / value pair (or the beginning
of the string if the failure is in the first
name / value pair) if the request was not
successful
successful.
@param Results A null-terminated Unicode string in
<MultiConfigAltResp> format which has all values

50
MdePkg/Include/Protocol/HiiConfigRouting.h
View File

@@ -5,14 +5,14 @@
information from configuration applications, routing the
results to the appropriate drivers.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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,10 +30,10 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
This function allows the caller to request the current
configuration for one or more named elements from one or more
drivers. The resulting string is in the standard HII
configuration string format. If Successful Results contains an
configuration string format. If Successful, Results contains an
equivalent string with "=" and the values associated with all
names added in. The expected implementation is for each
<ConfigRequest> substring in the Request, call the HII
<ConfigRequest> substring in the Request to call the HII
Configuration Routing Protocol ExtractProtocol function for the
driver corresponding to the <ConfigHdr> at the start of the
<ConfigRequest> substring. The request fails if no driver
@@ -60,7 +60,7 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
@param Progress On return, points to a character in the
Request string. Points to the string's null
terminator if request was successful. Points
terminator if the request was successful. Points
to the most recent '&' before the first
failing name / value pair (or the beginning
of the string if the failure is in the first
@@ -96,8 +96,8 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
configuration extraction.
@retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
to most recent & before the
error or the beginning of the
to the most recent & before the
error, or the beginning of the
string.
@retval EFI_INVALID_PARAMETER Unknown name.
@@ -172,7 +172,7 @@ EFI_STATUS
offset of the most recent '&' before the
first failing name / value pair (or the
beginning of the string if the failure is in
the first name / value pair) or the
the first name / value pair), or the
terminating NULL if all was successful.
@retval EFI_SUCCESS The results have been distributed or are
@@ -187,8 +187,8 @@ EFI_STATUS
Results parameter would result
in this type of error.
@retval EFI_NOT_FOUND Target for the specified routing data
was not found
@retval EFI_NOT_FOUND The target for the specified routing data
was not found.
**/
typedef
@@ -216,12 +216,12 @@ EFI_STATUS
@param ConfigRequest A null-terminated string in <ConfigRequest> format.
@param Block Array of bytes defining the block's
@param Block An array of bytes defining the block's
configuration.
@param BlockSize Length in bytes of Block.
@param BlockSize The length in bytes of Block.
@param Config Filled-in configuration string. String
@param Config The filled-in configuration string. String
allocated by the function. Returned only if
call is successful. The null-terminated string
will be <ConfigResp> format.
@@ -230,7 +230,7 @@ EFI_STATUS
offset of the most recent '&' before the
first failing name / value pair (or the
beginning of the string if the failure is in
the first name / value pair) or the
the first name / value pair), or the
terminating NULL if all was successful.
@retval EFI_SUCCESS The request succeeded. Progress points
@@ -248,11 +248,11 @@ EFI_STATUS
to the first character of
ConfigRequest.
@retval EFI_NOT_FOUND Target for the specified routing data
@retval EFI_NOT_FOUND The target for the specified routing data
was not found. Progress points to the
'G' in "GUID" of the errant routing
data.
@retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
@retval EFI_DEVICE_ERROR The block is not large enough. Progress undefined.
@retval EFI_INVALID_PARAMETER Encountered non <BlockName>
formatted string. Block is
@@ -300,7 +300,7 @@ EFI_STATUS
BlockLength parameter is (on input)
shorter than required by the
Configuration string, only the BlockSize
parameter is updated and an appropriate
parameter is updated, and an appropriate
status (see below) is returned.
@param BlockSize The length of the Block in units of UINT8.
@@ -313,7 +313,7 @@ EFI_STATUS
of the most recent "&" before the first
failing name / value pair (or the beginning
of the string if the failure is in the first
name / value pair) or the terminating NULL
name / value pair), or the terminating NULL
if all was successful.
@retval EFI_SUCCESS The request succeeded. Progress points to the null
@@ -371,7 +371,7 @@ EFI_STATUS
and placed in the newly allocated AltCfgResp buffer.
@retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
@retval EFI_INVALID_PARAMETER Any parameter is invalid.
@retval EFI_NOT_FOUND Target for the specified routing data was not found.
@retval EFI_NOT_FOUND The target for the specified routing data was not found.
**/
typedef
EFI_STATUS

30
MdePkg/Include/Protocol/HiiDatabase.h
View File

@@ -2,14 +2,14 @@
The file provides Database manager for HII-related data
structures.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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,7 +24,7 @@ typedef struct _EFI_HII_DATABASE_PROTOCOL EFI_HII_DATABASE_PROTOCOL;
///
/// EFI_HII_DATABASE_NOTIFY_TYPE
/// EFI_HII_DATABASE_NOTIFY_TYPE.
///
typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE;
@@ -98,7 +98,7 @@ EFI_STATUS
resources for the new database
contents.
@retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.
@retval EFI_INVALID_PARAMETER PackageList is NULL, or Handle is NULL.
**/
typedef
@@ -212,7 +212,7 @@ EFI_STATUS
the length of the handle buffer
that is required for the handles found.
@param Handle An array of EFI_HII_HANDLE instances returned.
@param Handle An array of EFI_HII_HANDLE instances returned.
@retval EFI_SUCCESS The matching handles are outputed successfully.
HandleBufferLength is updated with the actual length.
@@ -222,7 +222,7 @@ EFI_STATUS
handles. HandleBufferLength is
updated with a value that will
enable the data to fit.
@retval EFI_NOT_FOUND No matching handle could not be found in database.
@retval EFI_NOT_FOUND No matching handle could be found in database.
@retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
PackageGuid is not NULL, PackageType is a EFI_HII_
@@ -314,7 +314,7 @@ EFI_STATUS
@param NotifyType Describes the types of notification which
this function will be receiving. See
EFI_HII_DATABASE_NOTIFY_TYPE for more a
EFI_HII_DATABASE_NOTIFY_TYPE for a
list of types.
@param NotifyHandle Points to the unique handle assigned to
@@ -354,7 +354,7 @@ EFI_STATUS
@param NotificationHandle The handle of the notification
function being unregistered.
@retval EFI_SUCCESS Unregister the notification Successsfully
@retval EFI_SUCCESS Successsfully unregistered the notification.
@retval EFI_NOT_FOUND The incoming notification handle does not exist
in the current hii database.
@@ -407,7 +407,7 @@ EFI_STATUS
/**
This routine retrieves the requested keyboard layout. The layout
is a physical description of the keys on a keyboard and the
is a physical description of the keys on a keyboard, and the
character(s) that are associated with a particular set of key
strokes.

46
MdePkg/Include/Protocol/HiiFont.h
View File

@@ -1,14 +1,14 @@
/** @file
The file provides services to retrieve font 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -26,7 +26,7 @@ typedef struct _EFI_HII_FONT_PROTOCOL EFI_HII_FONT_PROTOCOL;
typedef VOID *EFI_FONT_HANDLE;
///
/// EFI_HII_OUT_FLAGS
/// EFI_HII_OUT_FLAGS.
///
typedef UINT32 EFI_HII_OUT_FLAGS;
@@ -110,7 +110,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
This function renders a string to a bitmap or the screen using
the specified font, color and options. It either draws the
string and glyphs on an existing bitmap, allocates a new bitmap
string and glyphs on an existing bitmap, allocates a new bitmap,
or uses the screen. The strings can be clipped or wrapped.
Optionally, the function also returns the information about each
row and the character position on that row. If
@@ -119,7 +119,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
outside the bounding box specified by Width and Height are
ignored. The information in the RowInfoArray only describes
characters which are at least partially displayed. For the final
row, the LineHeight and BaseLine may describe pixels which are
row, the LineHeight and BaseLine may describe pixels that are
outside the limit specified by Height (unless
EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is specified) even though those
pixels were not drawn. The LineWidth may describe pixels which
@@ -180,7 +180,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
containing row information and
RowInfoArraySize will be updated to contain
the number of elements. This array describes
the characters which were at least partially
the characters that were at least partially
drawn and the heights of the rows. It is the
caller's responsibility to free this buffer.
@@ -236,8 +236,8 @@ EFI_STATUS
can be drawn transparently or opaquely. The function can also
return information about each row and each character's
position on the row. If EFI_HII_OUT_FLAG_CLIP is set, then
text will be formatted only based on explicit line breaks and
all pixels which would lie outside the bounding box specified
text will be formatted based only on explicit line breaks, and
all pixels that would lie outside the bounding box specified
by Width and Height are ignored. The information in the
RowInfoArray only describes characters which are at least
partially displayed. For the final row, the LineHeight and
@@ -338,11 +338,11 @@ EFI_STATUS
@retval EFI_OUT_OF_RESOURCES Unable to allocate an output
buffer for RowInfoArray or Blt.
@retval EFI_INVALID_PARAMETER The String or Blt or Height or
@retval EFI_INVALID_PARAMETER The String, or Blt, or Height, or
Width was NULL.
@retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
@retval EFI_INVALID_PARAMETER Flags were invalid combination.
@retval EFI_NOT_FOUND The specified PackageList is not in the Database
@retval EFI_NOT_FOUND The specified PackageList is not in the Database,
or the stringid is not in the specified PackageList.
**/
@@ -370,22 +370,22 @@ EFI_STATUS
@param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
@param Char Character to retrieve.
@param Char The character to retrieve.
@param StringInfo Points to the string font and color
information or NULL if the string should use
the default system font and color.
@param Blt Thus must point to a NULL on entry. A buffer will
@param Blt This must point to a NULL on entry. A buffer will
be allocated to hold the output and the pointer
updated on exit. It is the caller's responsibility
to free this buffer.
@param Baseline Number of pixels from the bottom of the bitmap
@param Baseline The number of pixels from the bottom of the bitmap
to the baseline.
@retval EFI_SUCCESS Glyph bitmap created.
@retval EFI_SUCCESS The glyph bitmap created.
@retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
@@ -393,7 +393,7 @@ EFI_STATUS
replaced with the glyph for
Unicode character code 0xFFFD.
@retval EFI_INVALID_PARAMETER Blt is NULL or Width is NULL or
@retval EFI_INVALID_PARAMETER Blt is NULL, or Width is NULL, or
Height is NULL
@@ -424,8 +424,8 @@ EFI_STATUS
to NULL if there are no more matching fonts.
@param StringInfoIn Upon entry, points to the font to return
information about. If NULL, then the information about the system default
font will be returned.
information about. If NULL, then the information
about the system default font will be returned.
@param StringInfoOut Upon return, contains the matching
font's information. If NULL, then no

24
MdePkg/Include/Protocol/HiiString.h
View File

@@ -1,14 +1,14 @@
/** @file
The file provides services to manipulate string data.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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,12 +24,12 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;
/**
This function adds the string String to the group of strings owned by PackageList, with the
specified font information StringFontInfo and returns a new string id.
specified font information StringFontInfo, and returns a new string id.
The new string identifier is guaranteed to be unique within the package list.
That new string identifier is reserved for all languages in the package list.
@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.
@param PackageList Handle of the package list where this string will
@param PackageList The handle of the package list where this string will
be added.
@param StringId On return, contains the new strings id, which is
unique within PackageList.
@@ -38,7 +38,7 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;
with the passed in Language field.If LanguageName
is not NULL and the string package header's
LanguageName associated with a given Language is
not zero, the LanguageName being passed in will
not zero, the LanguageName being passed in will
be ignored.
@param String Points to the new null-terminated string.
@param StringFontInfo Points to the new string's font information or
@@ -49,7 +49,7 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;
@retval EFI_NOT_FOUND The specified PackageList could not be found in
database.
@retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.
@retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL or Language is NULL.
@retval EFI_INVALID_PARAMETER String is NULL, or StringId is NULL, or Language is NULL.
@retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in
current database.

66
MdePkg/Include/Protocol/IdeControllerInit.h
View File

@@ -13,18 +13,18 @@
A device handle for an IDE controller must contain an EFI_DEVICE_PATH_PROTOCOL.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is defined in UEFI Platform Initialization Specification 1.2
Volume 5: Standards
Volume 5: Standards.
**/
@@ -34,7 +34,7 @@
#include <IndustryStandard/Atapi.h>
///
/// Global ID for the EFI_IDE_CONTROLLER_INIT_PROTOCOL
/// Global ID for the EFI_IDE_CONTROLLER_INIT_PROTOCOL.
///
#define EFI_IDE_CONTROLLER_INIT_PROTOCOL_GUID \
{ \
@@ -42,12 +42,12 @@
}
///
/// Forward declaration for EFI_IDE_CONTROLLER_INIT_PROTOCOL
/// Forward declaration for EFI_IDE_CONTROLLER_INIT_PROTOCOL.
///
typedef struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL EFI_IDE_CONTROLLER_INIT_PROTOCOL;
///
/// The phase of the IDE Controller enumeration
/// The phase of the IDE Controller enumeration.
///
typedef enum {
///
@@ -122,7 +122,7 @@ typedef enum {
#define EFI_SATA_GEN2_SPEED 2
///
/// EFI_ATA_MODE structure
/// EFI_ATA_MODE structure.
///
typedef struct {
BOOLEAN Valid; ///< TRUE if Mode is valid.
@@ -150,7 +150,7 @@ typedef struct {
} EFI_ATA_EXTENDED_MODE;
///
/// EFI_ATA_COLLECTIVE_MODE structure
/// EFI_ATA_COLLECTIVE_MODE structure.
///
typedef struct {
///
@@ -164,7 +164,7 @@ typedef struct {
///
/// This field specifies the single word DMA mode. Single word DMA modes are defined
/// in the ATA/ATAPI specification, versions 1 and 2. Single word DMA support was
/// obsoleted in the ATA/ATAPI specification, version 3; therefore, most devices and
/// obsoleted in the ATA/ATAPI specification, version 3. Therefore, most devices and
/// controllers will not support this transfer mode. The ATA/ATAPI specification defines
/// the enumeration. In other words, a value of 1 in this field means single word DMA
/// mode 1. The actual meaning of single word DMA mode 1 is governed by the ATA/
@@ -221,7 +221,7 @@ typedef ATAPI_IDENTIFY_DATA EFI_ATAPI_IDENTIFY_DATA;
#define EFI_ATAPI_DEVICE_IDENTIFY_DATA 0x8000
///
/// EFI_IDENTIFY_DATA structure
/// EFI_IDENTIFY_DATA structure.
///
typedef union {
///
@@ -248,25 +248,25 @@ typedef union {
For most of today's controllers, MaxDevices will either be 1 or 2. For SATA
controllers, this value will always be 1. SATA configurations can contain SATA
port multipliers. SATA port multipliers behave like SATA bridges and can support
up to 16 devices on the other side. If an SATA port out of the IDE controller
up to 16 devices on the other side. If a SATA port out of the IDE controller
is connected to a port multiplier, MaxDevices will be set to the number of SATA
devices that the port multiplier supports. Because today's port multipliers
support up to 15 SATA devices, this number can be as large as 15. The IDE bus
driver is required to scan for the presence of port multipliers behind an SATA
support up to fifteen SATA devices, this number can be as large as fifteen. The IDE
bus driver is required to scan for the presence of port multipliers behind an SATA
controller and enumerate up to MaxDevices number of devices behind the port
multiplier.
In this context, the devices behind a port multiplier constitute a channel.
@param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel Zero-based channel number.
@param[out] Enabled TRUE if this channel is enabled. Disabled channels
are not scanned to see if any devices are present.
@param[out] MaxDevices The maximum number of IDE devices that the bus driver
can expect on this channel. For the ATA/ATAPI
specification, version 6, this number will either be
1 or 2. For Serial ATA (SATA) configurations with a
port multiplier, this number can be as large as 15.
one or two. For Serial ATA (SATA) configurations with a
port multiplier, this number can be as large as fifteen.
@retval EFI_SUCCESS Information was returned without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
@@ -292,7 +292,7 @@ EFI_STATUS
More synchronization points may be added as required in the future.
@param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Phase The phase during enumeration.
@param[in] Channel Zero-based channel number.
@@ -342,7 +342,7 @@ EFI_STATUS
EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a
given (Channel, Device) pair.
@param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel Zero-based channel number.
@param[in] Device Zero-based device number on the Channel.
@param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command.
@@ -389,9 +389,9 @@ EFI_STATUS
may inform the IDE controller driver to not use second-generation (Gen2) speeds
for a certain SATA drive.
@param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel Zero-based channel number.
@param[in] Device Zero-based device number on the Channel.
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel The zero-based channel number.
@param[in] Device The zero-based device number on the Channel.
@param[in] BadModes The modes that the device does not support and that
should be disqualified.
@@ -431,7 +431,7 @@ EFI_STATUS
The IDE bus driver may collect timing information for various devices in any
order. The IDE bus driver is responsible for making sure that all the dependencies
are satisfied; for example, the SupportedModes information for device A that
are satisfied. For example, the SupportedModes information for device A that
was previously returned may become stale after a call to
EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.
@@ -447,9 +447,9 @@ EFI_STATUS
also allow the IDE bus driver to stay with the speed that has been negotiated
by the physical layer.
@param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel Zero-based channel number.
@param[in] Device Zero-based device number on the Channel.
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel A zero-based channel number.
@param[in] Device A zero-based device number on the Channel.
@param[out] SupportedModes The optimum modes for the device.
@retval EFI_SUCCESS SupportedModes was returned.
@@ -545,7 +545,7 @@ struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL {
///
/// Set to TRUE if the enumeration group includes all the channels that are
/// produced by this controller. FALSE if an enumeration group consists of
/// produced by this controller. Set to FALSE if an enumeration group consists of
/// only one channel.
///
BOOLEAN EnumAll;
@@ -555,7 +555,7 @@ struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL {
/// (PATA) controllers can support up to two channels. Advanced Host Controller
/// Interface (AHCI) Serial ATA (SATA) controllers can support up to 32 channels,
/// each of which can have up to one device. In the presence of a multiplier,
/// each channel can have 15 devices.
/// each channel can have fifteen devices.
///
UINT8 ChannelCount;
};

52
MdePkg/Include/Protocol/Ip4.h
View File

@@ -4,23 +4,23 @@
sections:
- EFI IPv4 Service Binding Protocol
- EFI IPv4 Variable
- EFI IPv4 Protocol
- EFI IPv4 Protocol.
The EFI IPv4 Protocol provides basic network IPv4 packet I/O services,
which includes support foR a subset of the Internet Control Message
Protocol (ICMP) and may include support for the Internet Group Management
Protocol (IGMP).
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
This Protocol is introduced in UEFI Specification 2.0.
**/
@@ -269,10 +269,10 @@ typedef struct {
function is used optionally to retrieve the operational mode data of underlying
networks or drivers.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.
@param MnpConfigData Pointer to the managed network configuration data structure.
@param SnpModeData Pointer to the simple network mode data structure.
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure.
@param MnpConfigData The pointer to the managed network configuration data structure.
@param SnpModeData The pointer to the simple network mode data structure.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -311,8 +311,8 @@ EFI_STATUS
requests will be cancelled. Their completion token status will be set to EFI_ABORTED
and their events will be signaled.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@param IpConfigData The pointer to the EFI IPv4 Protocol configuration data structure.
@retval EFI_SUCCESS The driver instance was successfully opened.
@retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
@@ -350,9 +350,9 @@ EFI_STATUS
If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.
@param GroupAddress Pointer to the IPv4 multicast address.
@param GroupAddress The pointer to the IPv4 multicast address.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
@@ -403,7 +403,7 @@ EFI_STATUS
copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its
instances. As a result, client modification to the routing table will be lost.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@param DeleteRoute Set to TRUE to delete this route from the routing table. Set to
FALSE to add this route to the routing table. SubnetAddress
and SubnetMask are used as the key to each route entry.
@@ -446,8 +446,8 @@ EFI_STATUS
EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some
errors occur, the event in the token will be signaled and the status is updated.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param Token Pointer to the transmit token.
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@param Token The pointer to the transmit token.
@retval EFI_SUCCESS The data has been queued for transmission.
@retval EFI_NOT_STARTED This instance has not been started.
@@ -486,8 +486,8 @@ EFI_STATUS
driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
is signaled.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param Token Pointer to a token that is associated with the receive data descriptor.
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@param Token The pointer to a token that is associated with the receive data descriptor.
@retval EFI_SUCCESS The receive completion token was cached.
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
@@ -524,8 +524,8 @@ EFI_STATUS
asynchronous operation has completed, this function will not signal the token
and EFI_NOT_FOUND is returned.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param Token Pointer to a token that has been issued by
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@param Token The pointer to a token that has been issued by
EFI_IP4_PROTOCOL.Transmit() or
EFI_IP4_PROTOCOL.Receive(). If NULL, all pending
tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is
@@ -564,7 +564,7 @@ EFI_STATUS
experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function
more often.
@param This Pointer to the EFI_IP4_PROTOCOL instance.
@param This The pointer to the EFI_IP4_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.

34
MdePkg/Include/Protocol/Ip4Config.h
View File

@@ -2,17 +2,17 @@
This file provides a definition of the EFI IPv4 Configuration
Protocol.
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<BR>
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.
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
This Protocol is introduced in UEFI Specification 2.0.
**/
#ifndef __EFI_IP4CONFIG_PROTOCOL_H__
@@ -78,13 +78,13 @@ typedef struct {
Until the configuration completes successfully, EFI IPv4 Protocol driver instances
that are attempting to use default configurations must return EFI_NO_MAPPING.
Once the configuration is complete, the EFI IPv4 Configuration Protocol driver
signals DoneEvent. The configuration may need to be updated in the future,
however; in this case, the EFI IPv4 Configuration Protocol driver must signal
signals DoneEvent. The configuration may need to be updated in the future.
Note that in this case the EFI IPv4 Configuration Protocol driver must signal
ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default
configurations must return EFI_NO_MAPPING until the configuration policy has
been rerun.
@param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param DoneEvent Event that will be signaled when the EFI IPv4
Protocol driver configuration policy completes
execution. This event must be of type EVT_NOTIFY_SIGNAL.
@@ -120,7 +120,7 @@ EFI_STATUS
The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver.
All configuration data will be lost after calling Stop().
@param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
driver has been stopped.
@@ -141,11 +141,11 @@ EFI_STATUS
The GetData() function returns the current configuration data for the EFI IPv4
Protocol driver after the configuration policy has completed.
@param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param IpConfigDataSize On input, the size of the IpConfigData buffer.
On output, the count of bytes that were written
into the IpConfigData buffer.
@param IpConfigData Pointer to the EFI IPv4 Configuration Protocol
@param IpConfigData The pointer to the EFI IPv4 Configuration Protocol
driver configuration data structure.
Type EFI_IP4_IPCONFIG_DATA is defined in
"Related Definitions" below.
@@ -169,8 +169,8 @@ EFI_STATUS
);
///
/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent
/// configuration for the EFI IPv4 Protocol driver.
/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent
/// configurations for the EFI IPv4 Protocol driver.
///
struct _EFI_IP4_CONFIG_PROTOCOL {
EFI_IP4_CONFIG_START Start;

20
MdePkg/Include/Protocol/LoadFile.h
View File

@@ -1,20 +1,20 @@
/** @file
Load File protocol as defined in the UEFI 2.0 specification.
Load file protocol exists to supports the addition of new boot devices,
The load file protocol exists to supports the addition of new boot devices,
and to support booting from devices that do not map well to file system.
Network boot is done via a LoadFile protocol.
UEFI 2.0 can boot from any device that produces a LoadFile protocol.
Copyright (c) 2006 - 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -62,7 +62,7 @@ typedef EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_INTERFACE;
@retval EFI_NO_MEDIA No medium was present to load the file.
@retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
@retval EFI_NO_RESPONSE The remote system did not respond.
@retval EFI_NOT_FOUND The file was not found
@retval EFI_NOT_FOUND The file was not found.
@retval EFI_ABORTED The file load process was manually cancelled.
**/

52
MdePkg/Include/Protocol/ManagedNetwork.h
View File

@@ -2,14 +2,14 @@
EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.
EFI_MANAGED_NETWORK_PROTOCOL as defined in UEFI 2.0.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
@@ -150,9 +150,9 @@ typedef struct {
/**
Returns the operational parameters for the current MNP child driver.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData Pointer to storage for MNP operational parameters.
@param SnpModeData Pointer to storage for SNP operational parameters.
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData The pointer to storage for MNP operational parameters.
@param SnpModeData The pointer to storage for SNP operational parameters.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -173,8 +173,8 @@ EFI_STATUS
/**
Sets or clears the operational parameters for the MNP child driver.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData Pointer to configuration data that will be assigned to the MNP
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData The pointer to configuration data that will be assigned to the MNP
child driver instance. If NULL, the MNP child driver instance is
reset to startup defaults and all pending transmit and receive
requests are flushed.
@@ -199,11 +199,11 @@ EFI_STATUS
/**
Translates an IP multicast address to a hardware (MAC) multicast address.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.
Set to FALSE if IpAddress is an IPv4 multicast address.
@param IpAddress Pointer to the multicast IP address (in network byte order) to convert.
@param MacAddress Pointer to the resulting multicast MAC address.
@param IpAddress The pointer to the multicast IP address (in network byte order) to convert.
@param MacAddress The pointer to the resulting multicast MAC address.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:
@@ -229,10 +229,10 @@ EFI_STATUS
/**
Enables and disables receive filters for multicast address.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param JoinFlag Set to TRUE to join this multicast group.
Set to FALSE to leave this multicast group.
@param MacAddress Pointer to the multicast MAC group (address) to join or leave.
@param MacAddress The pointer to the multicast MAC group (address) to join or leave.
@retval EFI_SUCCESS The requested operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
@@ -258,8 +258,8 @@ EFI_STATUS
/**
Places asynchronous outgoing data packets into the transmit queue.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token associated with the transmit data descriptor.
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token The pointer to a token associated with the transmit data descriptor.
@retval EFI_SUCCESS The transmit completion token was cached.
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.
@@ -281,15 +281,15 @@ EFI_STATUS
/**
Places an asynchronous receiving request into the receiving queue.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token associated with the receive data descriptor.
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token The pointer to a token associated with the receive data descriptor.
@retval EFI_SUCCESS The receive completion token was cached.
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- This is NULL.
- Token is NULL.
- Token.Event is NULL
- Token.Event is NULL.
@retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a lack of system resources
(usually memory).
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
@@ -308,8 +308,8 @@ EFI_STATUS
/**
Aborts an asynchronous transmit or receive request.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token that has been issued by
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token The pointer to a token that has been issued by
EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or
EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If
NULL, all pending tokens are aborted.
@@ -334,7 +334,7 @@ EFI_STATUS
/**
Polls for incoming data packets and processes outgoing data packets.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.

20
MdePkg/Include/Protocol/MonotonicCounter.h
View File

@@ -1,16 +1,16 @@
/** @file
Monotonic Counter Architectural Protocol as defined in PI SPEC VOLUME 2 DXE
This code provides the services required to access the systems monotonic counter
This code provides the services required to access the system's monotonic counter
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -18,7 +18,7 @@
#define __ARCH_PROTOCOL_MONTONIC_COUNTER_H__
///
/// Global ID for the Monotonic Counter Architectural Protocol
/// Global ID for the Monotonic Counter Architectural Protocol.
///
#define EFI_MONOTONIC_COUNTER_ARCH_PROTOCOL_GUID \
{0x1da97072, 0xbddc, 0x4b30, {0x99, 0xf1, 0x72, 0xa0, 0xb5, 0x6f, 0xff, 0x2a} }

40
MdePkg/Include/Protocol/MpService.h
View File

@@ -27,14 +27,14 @@
APs to help test system memory in parallel with other device initialization.
Diagnostics applications may also use this protocol for multi-processor.
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<BR>
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.
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.
@par Revision Reference:
This Protocol is defined in the UEFI Platform Initialization Specification 1.2,
@@ -46,7 +46,7 @@
#define _MP_SERVICE_PROTOCOL_H_
///
/// Global ID for the EFI_MP_SERVICES_PROTOCOL
/// Global ID for the EFI_MP_SERVICES_PROTOCOL.
///
#define EFI_MP_SERVICES_PROTOCOL_GUID \
{ \
@@ -54,7 +54,7 @@
}
///
/// Forward declaration for the EFI_MP_SERVICES_PROTOCOL
/// Forward declaration for the EFI_MP_SERVICES_PROTOCOL.
///
typedef struct _EFI_MP_SERVICES_PROTOCOL EFI_MP_SERVICES_PROTOCOL;
@@ -128,14 +128,14 @@ typedef struct {
/// 1 0 0 Invalid. The BSP can never be in the disabled state.
/// 1 0 1 Invalid. The BSP can never be in the disabled state.
/// 1 1 0 Unhealthy Enabled BSP.
/// 1 1 1 Healthy Enabled BSP
/// 1 1 1 Healthy Enabled BSP.
/// </pre>
///
UINT32 StatusFlag;
///
/// The physical location of the processor, including the physical package number
/// that identifies the cartridge, the physical core number within package, and
/// logical threadnumber within core.
/// logical thread number within core.
///
EFI_CPU_PHYSICAL_LOCATION Location;
} EFI_PROCESSOR_INFORMATION;
@@ -146,11 +146,11 @@ typedef struct {
This service may only be called from the BSP.
This function is used to retrieve the following information:
- The number of logical processors that are present in the system
- The number of logical processors that are present in the system.
- The number of enabled logical processors in the system at the instant
this call is made.
Since MP Service Protocol provides services to enable and disable processors
Because MP Service Protocol provides services to enable and disable processors
dynamically, the number of enabled logical processors may vary during the
course of a boot session.
@@ -172,8 +172,8 @@ typedef struct {
@retval EFI_SUCCESS The number of logical processors and enabled
logical processors was retrieved.
@retval EFI_DEVICE_ERROR The calling processor is an AP.
@retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL
@retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL
@retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL.
@retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL.
**/
typedef
@@ -302,7 +302,7 @@ EFI_STATUS
BSP requests the function specified by
Procedure to be started on all the enabled
APs, and go on executing immediately. If
all return from Procedure or TimeoutInMicroSeconds
all return from Procedure, or TimeoutInMicroSeconds
expires, this event is signaled. The BSP
can use the CheckEvent() or WaitForEvent()
services to check the state of event. Type
@@ -538,7 +538,7 @@ EFI_STATUS
bits are ignored. If it is NULL, this parameter
is ignored.
@retval EFI_SUCCESS The specified AP successfully enabled or disabled.
@retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
@retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed
prior to this service returning.
@retval EFI_UNSUPPORTED Enabling or disabling an AP is not supported.
@@ -578,7 +578,7 @@ EFI_STATUS
@retval EFI_SUCCESS The current processor handle number was returned
in ProcessorNumber.
@retval EFI_INVALID_PARAMETER ProcessorNumber is NULL
@retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
**/
typedef
@@ -607,7 +607,7 @@ EFI_STATUS
/// guarantee that all non-blocking mode requests on all APs have been completed
/// before the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled. Since the
/// order that event notification functions in the same event group are executed
/// is not deterministic, an event of type EFI_EVENT_GROUP_READY_TO_BOOT can not
/// is not deterministic, an event of type EFI_EVENT_GROUP_READY_TO_BOOT cannot
/// be used to guarantee that APs have completed their non-blocking mode requests.
///
/// When the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, the StartAllAPs()

92
MdePkg/Include/Protocol/Mtftp4.h
View File

@@ -1,14 +1,14 @@
/** @file
EFI Multicast Trivial File Tranfer Protocol Definition
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
@@ -142,7 +142,7 @@ typedef union {
#pragma pack()
///
/// MTFTP4 option definition
/// MTFTP4 option definition.
///
typedef struct {
UINT8 *OptionStr;
@@ -191,15 +191,15 @@ typedef struct {
EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to
EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token The token that the caller provided in the
EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile()
or ReadDirectory() function.
@param PacketLen Indicates the length of the packet.
@param Packet Pointer to an MTFTPv4 packet.
@param Packet The pointer to an MTFTPv4 packet.
@retval EFI_SUCCESS Operation sucess
@retval Others Abort transfer process
@retval EFI_SUCCESS The operation was successful.
@retval Others Aborts the transfer process.
**/
typedef
@@ -214,14 +214,14 @@ EFI_STATUS
/**
Timeout callback funtion.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token The token that is provided in the
EFI_MTFTP4_PROTOCOL.ReadFile() or
EFI_MTFTP4_PROTOCOL.WriteFile() or
EFI_MTFTP4_PROTOCOL.ReadDirectory() functions
by the caller.
@retval EFI_SUCCESS Operation sucess
@retval EFI_SUCCESS The operation was successful.
@retval Others Aborts download process.
**/
@@ -236,14 +236,14 @@ EFI_STATUS
A callback function that the caller provides to feed data to the
EFI_MTFTP4_PROTOCOL.WriteFile() function.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token The token provided in the
EFI_MTFTP4_PROTOCOL.WriteFile() by the caller.
@param Length Indicates the length of the raw data wanted on input, and the
length the data available on output.
@param Buffer Pointer to the buffer where the data is stored.
@param Buffer The pointer to the buffer where the data is stored.
@retval EFI_SUCCESS Operation sucess
@retval EFI_SUCCESS The operation was successful.
@retval Others Aborts session.
**/
@@ -260,8 +260,8 @@ EFI_STATUS
/**
Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param ModeData Pointer to storage for the EFI MTFTPv4 Protocol driver mode data.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param ModeData The pointer to storage for the EFI MTFTPv4 Protocol driver mode data.
@retval EFI_SUCCESS The configuration data was successfully returned.
@retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.
@@ -280,8 +280,8 @@ EFI_STATUS
Initializes, changes, or resets the default operational setting for this
EFI MTFTPv4 Protocol driver instance.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param MtftpConfigData Pointer to the configuration data structure.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param MtftpConfigData The pointer to the configuration data structure.
@retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured successfully.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@@ -309,14 +309,14 @@ EFI_STATUS
/**
Gets information about a file from an MTFTPv4 server.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param OverrideData Data that is used to override the existing parameters. If NULL,
the default parameters that were set in the
EFI_MTFTP4_PROTOCOL.Configure() function are used.
@param Filename Pointer to ASCIIZ file name string.
@param ModeStr Pointer to ASCIIZ mode string. If NULL, "octet" will be used.
@param Filename The pointer to ASCIIZ file name string.
@param ModeStr The pointer to ASCIIZ mode string. If NULL, "octet" will be used.
@param OptionCount Number of option/value string pairs in OptionList.
@param OptionList Pointer to array of option/value string pairs. Ignored if
@param OptionList The pointer to array of option/value string pairs. Ignored if
OptionCount is zero.
@param PacketLength The number of bytes in the returned packet.
@param Packet The pointer to the received packet. This buffer must be freed by
@@ -366,11 +366,11 @@ EFI_STATUS
/**
Parses the options in an MTFTPv4 OACK packet.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param PacketLen Length of the OACK packet to be parsed.
@param Packet Pointer to the OACK packet to be parsed.
@param OptionCount Pointer to the number of options in following OptionList.
@param OptionList Pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot
@param Packet The pointer to the OACK packet to be parsed.
@param OptionCount The pointer to the number of options in following OptionList.
@param OptionList The pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot
Service FreePool() to release the OptionList if the options
in this OptionList are not needed any more.
@@ -399,8 +399,8 @@ EFI_STATUS
/**
Downloads a file from an MTFTPv4 server.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token Pointer to the token structure to provide the parameters that are
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token The pointer to the token structure to provide the parameters that are
used in this operation.
@retval EFI_SUCCESS The data file has been transferred successfully.
@@ -431,8 +431,8 @@ EFI_STATUS
/**
Sends a file to an MTFTPv4 server.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token Pointer to the token structure to provide the parameters that are
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token The pointer to the token structure to provide the parameters that are
used in this operation.
@retval EFI_SUCCESS The upload session has started.
@@ -461,8 +461,8 @@ EFI_STATUS
Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI
implementations.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token Pointer to the token structure to provide the parameters that are
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token The pointer to the token structure to provide the parameters that are
used in this operation.
@retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.
@@ -489,7 +489,7 @@ EFI_STATUS
/**
Polls for incoming data packets and processes outgoing data packets.
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.
@@ -542,11 +542,11 @@ struct _EFI_MTFTP4_TOKEN {
///
EFI_MTFTP4_OVERRIDE_DATA *OverrideData;
///
/// Pointer to the ASCIIZ file name string.
/// The pointer to the ASCIIZ file name string.
///
UINT8 *Filename;
///
/// Pointer to the ASCIIZ mode string. If NULL, "octet" is used.
/// The pointer to the ASCIIZ mode string. If NULL, "octet" is used.
///
UINT8 *ModeStr;
///
@@ -554,34 +554,34 @@ struct _EFI_MTFTP4_TOKEN {
///
UINT32 OptionCount;
///
/// Pointer to an array of option/value string pairs. Ignored if OptionCount is zero.
/// The pointer to an array of option/value string pairs. Ignored if OptionCount is zero.
///
EFI_MTFTP4_OPTION *OptionList;
///
/// Size of the data buffer.
/// The size of the data buffer.
///
UINT64 BufferSize;
///
/// Pointer to the data buffer. Data that is downloaded from the
/// The pointer to the data buffer. Data that is downloaded from the
/// MTFTPv4 server is stored here. Data that is uploaded to the
/// MTFTPv4 server is read from here. Ignored if BufferSize is zero.
///
VOID *Buffer;
///
/// Pointer to the context that will be used by CheckPacket,
/// The pointer to the context that will be used by CheckPacket,
/// TimeoutCallback and PacketNeeded.
///
VOID *Context;
///
/// Pointer to the callback function to check the contents of the received packet.
/// The pointer to the callback function to check the contents of the received packet.
///
EFI_MTFTP4_CHECK_PACKET CheckPacket;
///
/// Pointer to the function to be called when a timeout occurs.
/// The pointer to the function to be called when a timeout occurs.
///
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;
///
/// Pointer to the function to provide the needed packet contents.
/// The pointer to the function to provide the needed packet contents.
///
EFI_MTFTP4_PACKET_NEEDED PacketNeeded;
};

28
MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h
View File

@@ -1,17 +1,17 @@
/** @file
EFI Network Interface Identifier Protocol
EFI Network Interface Identifier Protocol.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in EFI Specification 1.10
This Protocol is introduced in EFI Specification 1.10.
**/
@@ -32,7 +32,7 @@
#define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION
///
/// Forward reference for pure ANSI compatability
/// Forward reference for pure ANSI compatability.
///
typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;
@@ -47,12 +47,12 @@ typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL EFI_NETWORK_INTERFACE_IDENTI
///
struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {
UINT64 Revision; ///< The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.
UINT64 Id; ///< Address of the first byte of the identifying structure for this network
UINT64 Id; ///< The address of the first byte of the identifying structure for this network
///< interface. This is only valid when the network interface is started
///< (see Start()). When the network interface is not started, this field is set to zero.
UINT64 ImageAddr; ///< Address of the first byte of the identifying structure for this
UINT64 ImageAddr; ///< The address of the first byte of the identifying structure for this
///< network interface. This is set to zero if there is no structure.
UINT32 ImageSize; ///< Size of unrelocated network interface image.
UINT32 ImageSize; ///< The size of unrelocated network interface image.
CHAR8 StringId[4];///< A four-character ASCII string that is sent in the class identifier field of
///< option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.
UINT8 Type; ///< Network interface type. This will be set to one of the values

44
MdePkg/Include/Protocol/Pcd.h
View File

@@ -6,14 +6,14 @@
The interfaces in dynamic type PCD do not require the token space guid as parameter,
but interfaces in dynamic-ex type PCD require token space guid as parameter.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -364,7 +364,7 @@ UINTN
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -390,7 +390,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -416,7 +416,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -442,7 +442,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -472,7 +472,7 @@ EFI_STATUS
the maximum size supported for this TokenNumber.
@param[in] Buffer The buffer to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -499,7 +499,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -526,7 +526,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -554,7 +554,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -582,7 +582,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -610,7 +610,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -642,7 +642,7 @@ EFI_STATUS
the maximum size supported for this TokenNumber.
@param[in] Buffer The buffer to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -671,7 +671,7 @@ EFI_STATUS
@param[in] TokenNumber The PCD token number.
@param[in] Value The value to set for the PCD token.
@retval EFI_SUCCESS Procedure returned successfully.
@retval EFI_SUCCESS The procedure returned successfully.
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
being set was incompatible with a call to this function.
Use GetSize() to retrieve the size of the target data.
@@ -766,7 +766,7 @@ EFI_STATUS
Retrieves the next valid token number in a given namespace.
This is useful since the PCD infrastructure contains a sparse list of token numbers,
and one cannot a priori know what token numbers are valid in the database.
and one cannot know without examination or by deduction what token numbers are valid in the database.
If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned.
If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned.
@@ -815,7 +815,7 @@ EFI_STATUS
EFI_SUCCESS.
@retval EFI_SUCCESS The PCD service retrieved the next valid token space Guid.
Or the input token space Guid is already the last valid token space Guid
Or, the input token space Guid is already the last valid token space Guid
in the PCD database. In the later case, *Guid is updated with the value of NULL.
@retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.

46
MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
View File

@@ -3,18 +3,18 @@
provides the basic interfaces to abstract a PCI host bridge resource allocation.
This protocol is mandatory if the system includes PCI devices.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is defined in UEFI Platform Initialization Specification 1.2
Volume 5: Standards
Volume 5: Standards.
**/
@@ -28,7 +28,7 @@
#include <Protocol/PciRootBridgeIo.h>
///
/// Global ID for the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
/// Global ID for the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
///
#define EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GUID \
{ \
@@ -36,7 +36,7 @@
}
///
/// Forward declaration for EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
/// Forward declaration for EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
///
typedef struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL;
@@ -78,7 +78,7 @@ typedef UINT64 EFI_RESOURCE_ALLOCATION_STATUS;
#define EFI_RESOURCE_NOT_SATISFIED 0xFFFFFFFFFFFFFFFFULL
///
/// This enum is used to specify the phase of the PCI enumaeration process
/// This enum is used to specify the phase of the PCI enumaeration process.
///
typedef enum {
///
@@ -167,9 +167,9 @@ typedef enum {
These are the notifications from the PCI bus driver that it is about to enter a certain phase of the PCI
enumeration process.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
instance.
@param[in] Phase The phase during enumeration
@param[in] Phase The phase during enumeration.
@retval EFI_SUCCESS The notification was accepted without any errors.
@retval EFI_INVALID_PARAMETER The Phase is invalid.
@@ -195,7 +195,7 @@ EFI_STATUS
/**
Returns the device handle of the next PCI root bridge that is associated with this host bridge.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
instance.
@param[in,out] RootBridgeHandle Returns the device handle of the next PCI root bridge. On input, it holds the
RootBridgeHandle that was returned by the most recent call to
@@ -218,7 +218,7 @@ EFI_STATUS
/**
Returns the allocation attributes of a PCI root bridge.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
instance.
@param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested.
@param[out] Attribute The pointer to attributes of the PCI root bridge.
@@ -239,10 +239,10 @@ EFI_STATUS
/**
Sets up the specified PCI root bridge for the bus enumeration process.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
instance.
@param[in] RootBridgeHandle The PCI root bridge to be set up.
@param[out] Configuration Pointer to the pointer to the PCI bus resource descriptor.
@param[out] Configuration The pointer to the pointer to the PCI bus resource descriptor.
@retval EFI_SUCCESS The PCI root bridge was set up and the bus range was returned in
Configuration.
@@ -262,10 +262,10 @@ EFI_STATUS
/**
Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
instance.
@param[in] RootBridgeHandle The PCI root bridge whose bus range is to be programmed.
@param[in] Configuration The pointer to the PCI bus resource descriptor..
@param[in] Configuration The pointer to the PCI bus resource descriptor.
@retval EFI_SUCCESS The bus range for the PCI root bridge was programmed.
@retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
@@ -294,7 +294,7 @@ EFI_STATUS
/**
Submits the I/O and memory resource requirements for the specified PCI root bridge.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
instance.
@param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being
submitted.
@@ -326,7 +326,7 @@ EFI_STATUS
/**
Returns the proposed resource settings for the specified PCI root bridge.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
instance.
@param[in] RootBridgeHandle The PCI root bridge handle.
@param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor.
@@ -350,7 +350,7 @@ EFI_STATUS
stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual
PCI controllers before enumeration.
@param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
@param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
@param[in] RootBridgeHandle The associated PCI root bridge handle.
@param[in] PciAddress The address of the PCI device on the PCI bus.
@param[in] Phase The phase of the PCI device enumeration.

48
MdePkg/Include/Protocol/PciPlatform.h
View File

@@ -1,17 +1,17 @@
/** @file
This file declares PlatfromOpRom protocols which provides the interface between
This file declares PlatfromOpRom protocols that provide the interface between
the PCI bus driver/PCI Host Bridge Resource Allocation driver and a platform-specific
driver to describe the unique features of a platform.
This protocol is optional.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is defined in UEFI Platform Initialization Specification 1.2
@@ -24,12 +24,12 @@
///
/// This file must be included because the EFI_PCI_PLATFORM_PROTOCOL uses
/// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE
/// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE.
///
#include <Protocol/PciHostBridgeResourceAllocation.h>
///
/// Global ID for the EFI_PCI_PLATFORM_PROTOCOL
/// Global ID for the EFI_PCI_PLATFORM_PROTOCOL.
///
#define EFI_PCI_PLATFORM_PROTOCOL_GUID \
{ \
@@ -37,7 +37,7 @@
}
///
/// Forward declaration for EFI_PCI_PLATFORM_PROTOCOL
/// Forward declaration for EFI_PCI_PLATFORM_PROTOCOL.
///
typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;
@@ -52,7 +52,7 @@ typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;
/// - EFI_RESERVE_ISA_IO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS:<BR>
/// Sets aside the ISA I/O range and all the aliases during PCI
/// enumeration. VGA I/O ranges and aliases are included in ISA alias
/// ranges. In this scheme, 75 percent of the I/O space remains unused.
/// ranges. In this scheme, seventy-five percent of the I/O space remains unused.
/// By using this selection, the platform indicates that it wants to support
/// PCI devices that require the following, at the cost of wasted I/O space:
/// ISA range and its aliases
@@ -70,7 +70,7 @@ typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;
/// The first device that requests the legacy VGA range will get all the
/// legacy VGA range plus its aliased addresses forwarded to it. The first
/// device that requests the legacy ISA range will get all the legacy ISA
/// range plus its aliased addresses forwarded to it.
/// range, plus its aliased addresses, forwarded to it.
/// - EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS:<BR>
/// Sets aside the ISA I/O range (0x100 - 0x3FF) during PCI enumeration
/// and the aliases of the VGA I/O ranges. By using this selection, the
@@ -125,26 +125,26 @@ typedef UINT32 EFI_PCI_PLATFORM_POLICY;
#define EFI_RESERVE_NONE_IO_ALIAS 0x0000
///
/// Sets aside ISA I/O range and all aliases
/// Sets aside ISA I/O range and all aliases:
/// - n100..n3FF
/// - n500..n7FF
/// - n900..nBFF
/// - nD00..nFFF
/// - nD00..nFFF.
///
#define EFI_RESERVE_ISA_IO_ALIAS 0x0001
///
/// Sets aside ISA I/O range 0x100-0x3FF
/// Sets aside ISA I/O range 0x100-0x3FF.
///
#define EFI_RESERVE_ISA_IO_NO_ALIAS 0x0002
///
/// Sets aside VGA I/O ranges and all aliases
/// Sets aside VGA I/O ranges and all aliases.
///
#define EFI_RESERVE_VGA_IO_ALIAS 0x0004
///
/// Sets aside VGA I/O rangess
/// Sets aside VGA I/O ranges
///
#define EFI_RESERVE_VGA_IO_NO_ALIAS 0x0008
@@ -200,7 +200,7 @@ typedef EFI_PCI_EXECUTION_PHASE EFI_PCI_CHIPSET_EXECUTION_PHASE;
it needs to handle those errors on its own because there is no way to surface any
errors to the caller.
@param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[in] HostBridge The handle of the host bridge controller.
@param[in] Phase The phase of the PCI bus enumeration.
@param[in] ExecPhase Defines the execution phase of the PCI chipset driver.
@@ -233,7 +233,7 @@ EFI_STATUS
needs to handle those errors on its own because there is no way to surface any errors to
the caller.
@param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[in] HostBridge The associated PCI host bridge handle.
@param[in] RootBridge The associated PCI root bridge handle.
@param[in] PciAddress The address of the PCI device on the PCI bus.
@@ -261,7 +261,7 @@ EFI_STATUS
enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol
driver can call this member function to retrieve the policy.
@param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[out] PciPolicy The platform policy with respect to VGA and ISA aliasing.
@retval EFI_SUCCESS The function completed successfully.
@@ -288,7 +288,7 @@ EFI_STATUS
scanning the ROM that is attached to any controller, which allows a platform to specify a ROM
image that is different from the ROM image on a PCI card.
@param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param[in] PciHandle The handle of the PCI device.
@param[out] RomImage If the call succeeds, the pointer to the pointer to the option ROM image.
Otherwise, this field is undefined. The memory for RomImage is allocated
@@ -301,7 +301,7 @@ EFI_STATUS
@retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.
@retval EFI_NOT_FOUND No option ROM was available for this device.
@retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.
@retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.
@retval EFI_DEVICE_ERROR An error occurred in obtaining the option ROM.
**/
typedef

108
MdePkg/Include/Protocol/PxeBaseCode.h
View File

@@ -2,24 +2,24 @@
EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible
devices for network access and network booting.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in EFI Specification 1.10
This Protocol is introduced in EFI Specification 1.10.
**/
#ifndef __PXE_BASE_CODE_PROTOCOL_H__
#define __PXE_BASE_CODE_PROTOCOL_H__
///
/// PXE Base Code protocol
/// PXE Base Code protocol.
///
#define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
{ \
@@ -40,7 +40,7 @@ typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE;
#define DEFAULT_ToS 0
///
/// ICMP error format
/// ICMP error format.
///
typedef struct {
UINT8 Type;
@@ -59,7 +59,7 @@ typedef struct {
} EFI_PXE_BASE_CODE_ICMP_ERROR;
///
/// TFTP error format
/// TFTP error format.
///
typedef struct {
UINT8 ErrorCode;
@@ -67,12 +67,12 @@ typedef struct {
} EFI_PXE_BASE_CODE_TFTP_ERROR;
///
/// IP Receive Filter definitions
/// IP Receive Filter definitions.
///
#define EFI_PXE_BASE_CODE_MAX_IPCNT 8
///
/// IP Receive Filter structure
/// IP Receive Filter structure.
///
typedef struct {
UINT8 Filters;
@@ -87,7 +87,7 @@ typedef struct {
#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008
///
/// ARP cache entries
/// ARP cache entries.
///
typedef struct {
EFI_IP_ADDRESS IpAddr;
@@ -95,7 +95,7 @@ typedef struct {
} EFI_PXE_BASE_CODE_ARP_ENTRY;
///
/// ARP route table entries
/// ARP route table entries.
///
typedef struct {
EFI_IP_ADDRESS IpAddr;
@@ -184,7 +184,7 @@ typedef struct {
} EFI_PXE_BASE_CODE_DISCOVER_INFO;
///
/// TFTP opcode definitions
/// TFTP opcode definitions.
///
typedef enum {
EFI_PXE_BASE_CODE_TFTP_FIRST,
@@ -212,7 +212,7 @@ typedef struct {
} EFI_PXE_BASE_CODE_MTFTP_INFO;
///
/// DHCPV4 Packet structure
/// DHCPV4 Packet structure.
///
typedef struct {
UINT8 BootpOpcode;
@@ -243,7 +243,7 @@ typedef struct {
} EFI_PXE_BASE_CODE_DHCPV6_PACKET;
///
/// Packet structure
/// Packet structure.
///
typedef union {
UINT8 Raw[1472];
@@ -258,7 +258,7 @@ typedef union {
#define EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES 8
///
/// EFI_PXE_BASE_CODE_MODE
/// EFI_PXE_BASE_CODE_MODE.
/// The data values in this structure are read-only and
/// are updated by the code that produces the
/// EFI_PXE_BASE_CODE_PROTOCOL functions.
@@ -352,7 +352,7 @@ typedef struct {
MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.
Set to FALSE if the PXE Base Code Callback Protocol is not available.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param UseIpv6 Specifies the type of IP addresses that are to be used during the session
that is being started. Set to TRUE for IPv6 addresses, and FALSE for
IPv4 addresses.
@@ -383,7 +383,7 @@ EFI_STATUS
set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE
structure is already FALSE, then EFI_NOT_STARTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@retval EFI_SUCCESS The PXE Base Code Protocol was stopped.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.
@@ -415,7 +415,7 @@ EFI_STATUS
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
then the DHCP sequence will be stopped and EFI_ABORTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the
offers in the order that they are received.
@@ -461,13 +461,13 @@ EFI_STATUS
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
then the Discovery sequence is stopped and EFI_ABORTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param Type The type of bootstrap to perform.
@param Layer Pointer to the boot server layer number to discover, which must be
@param Layer The pointer to the boot server layer number to discover, which must be
PXE_BOOT_LAYER_INITIAL when a new server type is being
discovered.
@param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.
@param Info Pointer to a data structure that contains additional information on the
@param Info The pointer to a data structure that contains additional information on the
type of discovery operation that is to be performed.
@retval EFI_SUCCESS The Discovery sequence has been completed.
@@ -537,7 +537,7 @@ EFI_STATUS
entry is itself null-terminated, so that the final information string is terminated
with two null octets.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param Operation The type of operation to perform.
@param BufferPtr A pointer to the data buffer.
@param Overwrite Only used on write file operations. TRUE if a file on a remote server can
@@ -548,7 +548,7 @@ EFI_STATUS
@param ServerIp The TFTP / MTFTP server IP address.
@param Filename A Null-terminated ASCII string that specifies a directory name or a file
name.
@param Info Pointer to the MTFTP information.
@param Info The pointer to the MTFTP information.
@param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.
@retval EFI_SUCCESS The TFTP/MTFTP operation was completed.
@@ -591,7 +591,7 @@ EFI_STATUS
EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param OpFlags The UDP operation flags.
@param DestIp The destination IP address.
@param DestPort The destination UDP port number.
@@ -635,7 +635,7 @@ EFI_STATUS
This function reads a UDP packet from a network interface. The data contents
are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
buffer received is returned in BufferSize . If the input BufferSize is smaller
buffer received is returned in BufferSize. If the input BufferSize is smaller
than the UDP packet received (less optional HeaderSize), it will be set to the
required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
@@ -646,7 +646,7 @@ EFI_STATUS
input values, different types of UDP packet receive filtering will be performed.
The following tables summarize these receive filter operations.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param OpFlags The UDP operation flags.
@param DestIp The destination IP address.
@param DestPort The destination UDP port number.
@@ -700,15 +700,15 @@ EFI_STATUS
If an application or driver wishes to preserve the IP receive filter settings,
it will have to preserve the IP receive filter settings before these calls, and
use SetIpFilter() to restore them after the calls. If incompatible filtering is
requested (for example, PROMISCUOUS with anything else) or if the device does not
requested (for example, PROMISCUOUS with anything else), or if the device does not
support a requested filter setting and it cannot be accommodated in software
(for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
The IPlist field is used to enable IPs other than the StationIP. They may be
multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
then both the StationIP and the IPs from the IPlist will be used.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewFilter Pointer to the new set of IP receive filters.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewFilter The pointer to the new set of IP receive filters.
@retval EFI_SUCCESS The IP receive filter settings were updated.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@@ -738,8 +738,8 @@ EFI_STATUS
does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is
returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param IpAddr Pointer to the IP address that is used to resolve a MAC address.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param IpAddr The pointer to the IP address that is used to resolve a MAC address.
@param MacAddr If not NULL, a pointer to the MAC address that was resolved with the
ARP protocol.
@@ -774,7 +774,7 @@ EFI_STATUS
The SetParameters() call must be invoked after a Callback Protocol is installed
to enable the use of callbacks.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
current value of AutoARP.
@param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
@@ -816,9 +816,9 @@ EFI_STATUS
Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
structure with NewSubnetMask.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewStationIp Pointer to the new IP address to be used by the network device.
@param NewSubnetMask Pointer to the new subnet mask to be used by the network device.
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewStationIp The pointer to the new IP address to be used by the network device.
@param NewSubnetMask The pointer to the new subnet mask to be used by the network device.
@retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@@ -839,25 +839,25 @@ EFI_STATUS
The pointers to the new packets are used to update the contents of the cached
packets in the EFI_PXE_BASE_CODE_MODE structure.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewDhcpDiscoverValid Pointer to a value that will replace the current
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewDhcpDiscoverValid The pointer to a value that will replace the current
DhcpDiscoverValid field.
@param NewDhcpAckReceived Pointer to a value that will replace the current
@param NewDhcpAckReceived The pointer to a value that will replace the current
DhcpAckReceived field.
@param NewProxyOfferReceived Pointer to a value that will replace the current
@param NewProxyOfferReceived The pointer to a value that will replace the current
ProxyOfferReceived field.
@param NewPxeDiscoverValid Pointer to a value that will replace the current
@param NewPxeDiscoverValid The pointer to a value that will replace the current
ProxyOfferReceived field.
@param NewPxeReplyReceived Pointer to a value that will replace the current
@param NewPxeReplyReceived The pointer to a value that will replace the current
PxeReplyReceived field.
@param NewPxeBisReplyReceived Pointer to a value that will replace the current
@param NewPxeBisReplyReceived The pointer to a value that will replace the current
PxeBisReplyReceived field.
@param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
@param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
@param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
@param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
@param NewPxeReply Pointer to the new cached PXE Reply packet contents.
@param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
@param NewDhcpDiscover The pointer to the new cached DHCP Discover packet contents.
@param NewDhcpAck The pointer to the new cached DHCP Ack packet contents.
@param NewProxyOffer The pointer to the new cached Proxy Offer packet contents.
@param NewPxeDiscover The pointer to the new cached PXE Discover packet contents.
@param NewPxeReply The pointer to the new cached PXE Reply packet contents.
@param NewPxeBisReply The pointer to the new cached PXE BIS Reply packet contents.
@retval EFI_SUCCESS The cached packet contents were updated.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@@ -920,7 +920,7 @@ struct _EFI_PXE_BASE_CODE_PROTOCOL {
EFI_PXE_BASE_CODE_SET_STATION_IP SetStationIp;
EFI_PXE_BASE_CODE_SET_PACKETS SetPackets;
///
/// Pointer to the EFI_PXE_BASE_CODE_MODE data for this device.
/// The pointer to the EFI_PXE_BASE_CODE_MODE data for this device.
///
EFI_PXE_BASE_CODE_MODE *Mode;
};

32
MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
View File

@@ -2,14 +2,14 @@
It is invoked when the PXE Base Code Protocol is about to transmit, has received,
or is waiting to receive a packet.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in EFI Specification 1.10
@@ -20,7 +20,7 @@
#define _PXE_BASE_CODE_CALLBACK_H_
///
/// Call Back Definitions
/// Call Back Definitions.
///
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \
{ \
@@ -28,28 +28,28 @@
}
///
/// UEFI Revision Number Definition
/// UEFI Revision Number Definition.
///
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000
///
/// EFI 1.1 Revision Number defintion
/// EFI 1.1 Revision Number defintion.
///
#define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION \
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION
///
/// UEFI Protocol name
/// UEFI Protocol name.
///
typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;
///
/// EFI1.1 Protocol name
/// EFI1.1 Protocol name.
///
typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK;
///
/// Event type list for PXE Base Code Protocol function
/// Event type list for PXE Base Code Protocol function.
///
typedef enum {
EFI_PXE_BASE_CODE_FUNCTION_FIRST,
@@ -64,7 +64,7 @@ typedef enum {
} EFI_PXE_BASE_CODE_FUNCTION;
///
/// Callback status type
/// Callback status type.
///
typedef enum {
EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST,
@@ -87,7 +87,7 @@ typedef enum {
The SetParameters() function must be called after a Callback Protocol is installed to enable the
use of callbacks.
@param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
@param This The pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
@param Function The PXE Base Code Protocol function that is waiting for an event.
@param Received TRUE if the callback is being invoked due to a receive event. FALSE if
the callback is being invoked due to a transmit event.

122
MdePkg/Include/Protocol/SimpleFileSystem.h
View File

@@ -7,14 +7,14 @@
UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -52,9 +52,9 @@ typedef EFI_FILE_PROTOCOL EFI_FILE;
@retval EFI_UNSUPPORTED This volume does not support the file system.
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
@retval EFI_ACCESS_DENIED The service denied access to the file
@retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_ACCESS_DENIED The service denied access to the file.
@retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.
**/
typedef
@@ -84,20 +84,20 @@ struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {
/**
Opens a new file relative to the source file's location.
@param This Protocol instance pointer.
@param NewHandle Returns File Handle for FileName
@param FileName Null terminated string. "\", ".", and ".." are supported
@param This The protocol instance pointer.
@param NewHandle Returns File Handle for FileName.
@param FileName Null terminated string. "\", ".", and ".." are supported.
@param OpenMode Open mode for file.
@param Attributes Only used for EFI_FILE_MODE_CREATE
@param Attributes Only used for EFI_FILE_MODE_CREATE.
@retval EFI_SUCCESS The device was opened.
@retval EFI_NOT_FOUND The specified file could not be found on the device
@retval EFI_NOT_FOUND The specified file could not be found on the device.
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_MEDIA_CHANGED The media has changed
@retval EFI_MEDIA_CHANGED The media has changed.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
@retval EFI_ACCESS_DENIED The service denied access to the file
@retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_ACCESS_DENIED The service denied access to the file.
@retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.
@retval EFI_VOLUME_FULL The volume is full.
**/
@@ -144,12 +144,12 @@ EFI_STATUS
);
/**
Close and delete the file handle
Close and delete the file handle.
@param This Protocol instance pointer.
@retval EFI_SUCCESS The device was opened.
@retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted
@retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
**/
typedef
@@ -166,10 +166,10 @@ EFI_STATUS
@param Buffer The buffer in which data is read.
@retval EFI_SUCCESS Data was read.
@retval EFI_NO_MEDIA The device has no media
@retval EFI_DEVICE_ERROR The device reported an error
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
@retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size.
**/
typedef
@@ -188,14 +188,14 @@ EFI_STATUS
@param Buffer The buffer in which data to write.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORT Writes to Open directory are not supported
@retval EFI_NO_MEDIA The device has no media
@retval EFI_DEVICE_ERROR The device reported an error
@retval EFI_DEVICE_ERROR An attempt was made to write to a deleted file
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
@retval EFI_WRITE_PROTECTED The device is write protected
@retval EFI_ACCESS_DENIED The file was open for read only
@retval EFI_VOLUME_FULL The volume is full
@retval EFI_UNSUPPORT Writes to Open directory are not supported.
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_DEVICE_ERROR An attempt was made to write to a deleted file.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_WRITE_PROTECTED The device is write protected.
@retval EFI_ACCESS_DENIED The file was open for read only.
@retval EFI_VOLUME_FULL The volume is full.
**/
typedef
@@ -210,7 +210,7 @@ EFI_STATUS
Set a files current position
@param This Protocol instance pointer.
@param Position Byte position from the start of the file
@param Position Byte position from the start of the file.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
@@ -227,10 +227,10 @@ EFI_STATUS
Get a file's current position
@param This Protocol instance pointer.
@param Position Byte position from the start of the file
@param Position Byte position from the start of the file.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open..
**/
typedef
@@ -241,21 +241,21 @@ EFI_STATUS
);
/**
Get information about a file
Get information about a file.
@param This Protocol instance pointer.
@param InformationType Type of info to return in Buffer
@param InformationType Type of information to return in Buffer.
@param BufferSize On input size of buffer, on output amount of data in buffer.
@param Buffer The buffer to return data.
@retval EFI_SUCCESS Data was returned.
@retval EFI_UNSUPPORT InformationType is not supported
@retval EFI_NO_MEDIA The device has no media
@retval EFI_DEVICE_ERROR The device reported an error
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
@retval EFI_WRITE_PROTECTED The device is write protected
@retval EFI_ACCESS_DENIED The file was open for read only
@retval EFI_BUFFER_TOO_SMALL Buffer was too small, required size returned in BufferSize
@retval EFI_UNSUPPORT InformationType is not supported.
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_WRITE_PROTECTED The device is write protected.
@retval EFI_ACCESS_DENIED The file was open for read only.
@retval EFI_BUFFER_TOO_SMALL Buffer was too small; required size returned in BufferSize.
**/
typedef
@@ -271,17 +271,17 @@ EFI_STATUS
Set information about a file
@param File Protocol instance pointer.
@param InformationType Type of info in Buffer
@param InformationType Type of information in Buffer.
@param BufferSize Size of buffer.
@param Buffer The data to write.
@retval EFI_SUCCESS Data was returned.
@retval EFI_UNSUPPORT InformationType is not supported
@retval EFI_NO_MEDIA The device has no media
@retval EFI_DEVICE_ERROR The device reported an error
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
@retval EFI_WRITE_PROTECTED The device is write protected
@retval EFI_ACCESS_DENIED The file was open for read only
@retval EFI_UNSUPPORT InformationType is not supported.
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_WRITE_PROTECTED The device is write protected.
@retval EFI_ACCESS_DENIED The file was open for read only.
**/
typedef
@@ -294,18 +294,18 @@ EFI_STATUS
);
/**
Flush data back for the file handle
Flush data back for the file handle.
@param This Protocol instance pointer.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORT Writes to Open directory are not supported
@retval EFI_NO_MEDIA The device has no media
@retval EFI_DEVICE_ERROR The device reported an error
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
@retval EFI_WRITE_PROTECTED The device is write protected
@retval EFI_ACCESS_DENIED The file was open for read only
@retval EFI_VOLUME_FULL The volume is full
@retval EFI_UNSUPPORT Writes to Open directory are not supported.
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_WRITE_PROTECTED The device is write protected.
@retval EFI_ACCESS_DENIED The file was open for read only.
@retval EFI_VOLUME_FULL The volume is full.
**/
typedef

52
MdePkg/Include/Protocol/SimpleNetwork.h
View File

@@ -9,17 +9,17 @@
MCast - MultiCast
...
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in EFI Specification 1.10
This Protocol is introduced in EFI Specification 1.10.
**/
@@ -40,7 +40,7 @@ typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK_PROTOCOL;
typedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK;
///
/// Simple Network Protocol data structures
/// Simple Network Protocol data structures.
///
typedef struct {
///
@@ -124,7 +124,7 @@ typedef struct {
} EFI_NETWORK_STATISTICS;
///
/// State of the network interface
/// The state of the network interface.
/// When an EFI_SIMPLE_NETWORK_PROTOCOL driver initializes a
/// network interface, the network interface is left in the EfiSimpleNetworkStopped state.
///
@@ -273,7 +273,7 @@ EFI_STATUS
required by the network interface; optionally, also requests allocation
of additional transmit and receive buffers.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space
that the driver should allocate for the network interface.
Some network interfaces will not be able to use the extra
@@ -286,7 +286,7 @@ EFI_STATUS
being used.
@retval EFI_SUCCESS The network interface was initialized.
@retval EFI_NOT_STARTED The network interface has not been started
@retval EFI_NOT_STARTED The network interface has not been started.
@retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and
receive buffers.
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
@@ -306,13 +306,13 @@ EFI_STATUS
Resets a network adapter and re-initializes it with the parameters that were
provided in the previous call to Initialize().
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param ExtendedVerification Indicates that the driver may perform a more
exhaustive verification operation of the device
during reset.
@retval EFI_SUCCESS The network interface was reset.
@retval EFI_NOT_STARTED The network interface has not been started
@retval EFI_NOT_STARTED The network interface has not been started.
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
@retval EFI_UNSUPPORTED This function is not supported by the network interface.
@@ -332,7 +332,7 @@ EFI_STATUS
@param This Protocol instance pointer.
@retval EFI_SUCCESS The network interface was shutdown.
@retval EFI_NOT_STARTED The network interface has not been started
@retval EFI_NOT_STARTED The network interface has not been started.
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
@retval EFI_UNSUPPORTED This function is not supported by the network interface.
@@ -347,7 +347,7 @@ EFI_STATUS
/**
Manages the multicast receive filters of a network interface.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param Enable A bit mask of receive filters to enable on the network interface.
@param Disable A bit mask of receive filters to disable on the network interface.
@param ResetMCastFilter Set to TRUE to reset the contents of the multicast receive
@@ -362,7 +362,7 @@ EFI_STATUS
ResetMCastFilter is TRUE.
@retval EFI_SUCCESS The multicast receive filter list was updated.
@retval EFI_NOT_STARTED The network interface has not been started
@retval EFI_NOT_STARTED The network interface has not been started.
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
@retval EFI_UNSUPPORTED This function is not supported by the network interface.
@@ -382,13 +382,13 @@ EFI_STATUS
/**
Modifies or resets the current station address, if supported.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param Reset Flag used to reset the station address to the network interfaces
permanent address.
@param New New station address to be used for the network interface.
@param New The new station address to be used for the network interface.
@retval EFI_SUCCESS The network interfaces station address was updated.
@retval EFI_NOT_STARTED The network interface has not been started
@retval EFI_NOT_STARTED The network interface has not been started.
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
@retval EFI_UNSUPPORTED This function is not supported by the network interface.
@@ -435,7 +435,7 @@ EFI_STATUS
/**
Converts a multicast IP address to a multicast HW MAC address.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set
to FALSE if the multicast IP address is IPv4 [RFC 791].
@param IP The multicast IP address that is to be converted to a multicast
@@ -466,7 +466,7 @@ EFI_STATUS
Performs read and write operations on the NVRAM device attached to a
network interface.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param ReadWrite TRUE for read operations, FALSE for write operations.
@param Offset Byte offset in the NVRAM device at which to start the read or
write operation. This must be a multiple of NvRamAccessSize and
@@ -496,7 +496,7 @@ EFI_STATUS
Reads the current interrupt status and recycled transmit buffer status from
a network interface.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param InterruptStatus A pointer to the bit mask of the currently active interrupts
If this is NULL, the interrupt status will not be read from
the device. If this is not NULL, the interrupt status will
@@ -528,7 +528,7 @@ EFI_STATUS
/**
Places a packet in the transmit queue of a network interface.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param HeaderSize The size, in bytes, of the media header to be filled in by
the Transmit() function. If HeaderSize is non-zero, then it
must be equal to This->Mode->MediaHeaderSize and the DestAddr
@@ -573,7 +573,7 @@ EFI_STATUS
/**
Receives a packet from a network interface.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param HeaderSize The size, in bytes, of the media header received on the network
interface. If this parameter is NULL, then the media header size
will not be returned.

36
MdePkg/Include/Protocol/SimpleTextOut.h
View File

@@ -6,14 +6,14 @@
a single hardware device or a virtual device that is an aggregation
of multiple physical devices.
Copyright (c) 2006 - 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -148,7 +148,7 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE;
/**
Reset the text output device hardware and optionaly run diagnostics
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param ExtendedVerification Driver may perform more exhaustive verfication
operation of the device during reset.
@@ -167,7 +167,7 @@ EFI_STATUS
/**
Write a string to the output device.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param String The NULL-terminated string to be displayed on the output
device(s). All output devices must also support the Unicode
drawing character codes defined in this file.
@@ -193,7 +193,7 @@ EFI_STATUS
Verifies that all characters in a string can be output to the
target device.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param String The NULL-terminated string to be examined for the output
device(s).
@@ -214,7 +214,7 @@ EFI_STATUS
Returns information for an available text mode that the output device(s)
supports.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param ModeNumber The mode number to return information on.
@param Columns Returns the geometry of the text output device for the
requested ModeNumber.
@@ -238,7 +238,7 @@ EFI_STATUS
/**
Sets the output device(s) to a specified mode.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param ModeNumber The mode number to set.
@retval EFI_SUCCESS The requested text mode was set.
@@ -257,7 +257,7 @@ EFI_STATUS
Sets the background and foreground colors for the OutputString () and
ClearScreen () functions.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param Attribute The attribute to set. Bits 0..3 are the foreground color, and
bits 4..6 are the background color. All other bits are undefined
and must be zero. The valid Attributes are defined in this file.
@@ -278,7 +278,7 @@ EFI_STATUS
Clears the output device(s) display to the currently selected background
color.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
@@ -294,7 +294,7 @@ EFI_STATUS
/**
Sets the current coordinates of the cursor position
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param Column The position to set the cursor to. Must be greater than or
equal to zero and less than the number of columns and rows
by QueryMode ().
@@ -319,7 +319,7 @@ EFI_STATUS
/**
Makes the cursor visible or invisible
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param Visible If TRUE, the cursor is set to be visible. If FALSE, the cursor is
set to be invisible.
@@ -356,7 +356,7 @@ typedef struct {
///
INT32 Mode;
///
/// The current character output attribute
/// The current character output attribute.
///
INT32 Attribute;
///

26
MdePkg/Include/Protocol/TapeIo.h
View File

@@ -2,14 +2,14 @@
EFI_TAPE_IO_PROTOCOL as defined in the UEFI 2.0.
Provide services to control and access a tape device.
Copyright (c) 2006 - 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -47,8 +47,8 @@ typedef struct _EFI_TAPE_HEADER {
Reads from the tape.
@param This A pointer to the EFI_TAPE_IO_PROTOCOL instance.
@param BufferSize Size of the buffer in bytes pointed to by Buffer.
@param Buffer Pointer to the buffer for data to be read into.
@param BufferSize The size of the buffer in bytes pointed to by Buffer.
@param Buffer The pointer to the buffer for data to be read into.
@retval EFI_SUCCESS Data was successfully transferred from the media.
@retval EFI_END_OF_FILE A filemark was encountered which limited the data
@@ -63,7 +63,7 @@ typedef struct _EFI_TAPE_HEADER {
The transfer was aborted since the current position of the
media may be incorrect.
@retval EFI_INVALID_PARAMETER A NULL Buffer was specified with a non-zero
BufferSize or the device is operating in fixed block
BufferSize, or the device is operating in fixed block
size mode and the BufferSize was not a multiple of
device's fixed block size
@retval EFI_DEVICE_ERROR A device error occurred while attempting to transfer data
@@ -83,7 +83,7 @@ EFI_STATUS
@param This A pointer to the EFI_TAPE_IO_PROTOCOL instance.
@param BufferSize Size of the buffer in bytes pointed to by Buffer.
@param Buffer Pointer to the buffer for data to be written from.
@param Buffer The pointer to the buffer for data to be written from.
@retval EFI_SUCCESS Data was successfully transferred to the media.
@retval EFI_END_OF_MEDIA The logical end of media has been reached. Data may have
@@ -99,7 +99,7 @@ EFI_STATUS
@retval EFI_WRITE_PROTECTED The media in the device is write-protected. The transfer
was aborted since a write cannot be completed.
@retval EFI_INVALID_PARAMETER A NULL Buffer was specified with a non-zero
BufferSize or the device is operating in fixed block
BufferSize, or the device is operating in fixed block
size mode and the BufferSize was not a multiple of
device's fixed block size
@retval EFI_DEVICE_ERROR A device error occurred while attempting to transfer data

68
MdePkg/Include/Protocol/TcgService.h
View File

@@ -2,14 +2,14 @@
TCG Service Protocol as defined in TCG_EFI_Protocol_1_20_Final
See http://trustedcomputinggroup.org for the latest specification
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -31,13 +31,13 @@ typedef struct {
} TCG_VERSION;
typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {
UINT8 Size; /// Size of this structure
UINT8 Size; /// Size of this structure.
TCG_VERSION StructureVersion;
TCG_VERSION ProtocolSpecVersion;
UINT8 HashAlgorithmBitmap; /// Hash algorithms
/// this protocol is capable of : 01=SHA-1
BOOLEAN TPMPresentFlag; /// 00h = TPM not present
BOOLEAN TPMDeactivatedFlag; /// 01h = TPM currently deactivated
UINT8 HashAlgorithmBitmap; /// Hash algorithms .
/// This protocol is capable of : 01=SHA-1.
BOOLEAN TPMPresentFlag; /// 00h = TPM not present.
BOOLEAN TPMDeactivatedFlag; /// 01h = TPM currently deactivated.
} TCG_EFI_BOOT_SERVICE_CAPABILITY;
typedef UINT32 TCG_ALGORITHM_ID;
@@ -66,7 +66,7 @@ typedef UINT32 TCG_ALGORITHM_ID;
this is a pointer to the address of the start of
the last entry in the event log in memory.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER ProtocolCapability does not match TCG capability.
**/
typedef
@@ -83,14 +83,14 @@ EFI_STATUS
/**
This service abstracts the capability to do a hash operation on a data buffer.
@param This Indicates the calling context
@param HashData Pointer to the data buffer to be hashed
@param HashDataLen Length of the data buffer to be hashed
@param AlgorithmId Identification of the Algorithm to use for the hashing operation
@param HashedDataLen Resultant length of the hashed data
@param HashedDataResult Resultant buffer of the hashed data
@param This Indicates the calling context.
@param HashData The pointer to the data buffer to be hashed.
@param HashDataLen The length of the data buffer to be hashed.
@param AlgorithmId Identification of the Algorithm to use for the hashing operation.
@param HashedDataLen Resultant length of the hashed data.
@param HashedDataResult Resultant buffer of the hashed data.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER HashDataLen is NULL.
@retval EFI_INVALID_PARAMETER HashDataLenResult is NULL.
@retval EFI_OUT_OF_RESOURCES Cannot allocate buffer of size *HashedDataLen.
@@ -112,16 +112,16 @@ EFI_STATUS
This service abstracts the capability to add an entry to the Event Log.
@param This Indicates the calling context
@param TCGLogData Pointer to the start of the data buffer containing
@param TCGLogData The pointer to the start of the data buffer containing
the TCG_PCR_EVENT data structure. All fields in
this structure are properly filled by the caller.
@param EventNumber The event number of the event just logged
@param Flags Indicate additional flags. Only one flag has been
@param EventNumber The event number of the event just logged.
@param Flags Indicates additional flags. Only one flag has been
defined at this time, which is 0x01 and means the
extend operation should not be performed. All
other bits are reserved.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_OUT_OF_RESOURCES Insufficient memory in the event log to complete this action.
**/
typedef
@@ -136,13 +136,13 @@ EFI_STATUS
/**
This service is a proxy for commands to the TPM.
@param This Indicates the calling context
@param TpmInputParameterBlockSize Size of the TPM input parameter block
@param TpmInputParameterBlock Pointer to the TPM input parameter block
@param TpmOutputParameterBlockSize Size of the TPM output parameter block
@param TpmOutputParameterBlock Pointer to the TPM output parameter block
@param This Indicates the calling context.
@param TpmInputParameterBlockSize Size of the TPM input parameter block.
@param TpmInputParameterBlock The pointer to the TPM input parameter block.
@param TpmOutputParameterBlockSize Size of the TPM output parameter block.
@param TpmOutputParameterBlock The pointer to the TPM output parameter block.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER Invalid ordinal.
@retval EFI_UNSUPPORTED Current Task Priority Level >= EFI_TPL_CALLBACK.
@retval EFI_TIMEOUT The TIS timed-out.
@@ -161,20 +161,20 @@ EFI_STATUS
This service abstracts the capability to do a hash operation on a data buffer, extend a specific TPM PCR with the hash result, and add an entry to the Event Log
@param This Indicates the calling context
@param HashData Physical address of the start of the data buffer
@param HashData The physical address of the start of the data buffer
to be hashed, extended, and logged.
@param HashDataLen The length, in bytes, of the buffer referenced by HashData
@param AlgorithmId Identification of the Algorithm to use for the hashing operation
@param TCGLogData The physical address of the start of the data
buffer containing the TCG_PCR_EVENT data structure.
@param EventNumber The event number of the event just logged.
@param EventLogLastEntry Physical address of the first byte of the entry
@param EventLogLastEntry The physical address of the first byte of the entry
just placed in the Event Log. If the Event Log was
empty when this function was called then this physical
address will be the same as the physical address of
the start of the Event Log.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_UNSUPPORTED AlgorithmId != TPM_ALG_SHA.
@retval EFI_UNSUPPORTED Current TPL >= EFI_TPL_CALLBACK.
@retval EFI_DEVICE_ERROR The command was unsuccessful.

62
MdePkg/Include/Protocol/Tcp4.h
View File

@@ -4,17 +4,17 @@
and destroy child of the driver to communicate with other host using TCP protocol.
The EFI TCPv4 Protocol provides services to send and receive data stream.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
This Protocol is introduced in UEFI Specification 2.0.
**/
@@ -225,14 +225,14 @@ typedef struct {
/**
Get the current operational status.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param Tcp4State Pointer to the buffer to receive the current TCP state.
@param Tcp4ConfigData Pointer to the buffer to receive the current TCP configuration.
@param Ip4ModeData Pointer to the buffer to receive the current IPv4 configuration
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param Tcp4State The pointer to the buffer to receive the current TCP state.
@param Tcp4ConfigData The pointer to the buffer to receive the current TCP configuration.
@param Ip4ModeData The pointer to the buffer to receive the current IPv4 configuration
data used by the TCPv4 instance.
@param MnpConfigData Pointer to the buffer to receive the current MNP configuration
@param MnpConfigData The pointer to the buffer to receive the current MNP configuration
data used indirectly by the TCPv4 instance.
@param SnpModeData Pointer to the buffer to receive the current SNP configuration
@param SnpModeData The pointer to the buffer to receive the current SNP configuration
data used indirectly by the TCPv4 instance.
@retval EFI_SUCCESS The mode data was read.
@@ -255,8 +255,8 @@ EFI_STATUS
/**
Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param Tcp4ConfigData Pointer to the configure data to configure the instance.
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param Tcp4ConfigData The pointer to the configure data to configure the instance.
@retval EFI_SUCCESS The operational settings are set, changed, or reset
successfully.
@@ -283,7 +283,7 @@ EFI_STATUS
/**
Add or delete a route entry to the route table
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param DeleteRoute Set it to TRUE to delete this route from the routing table. Set it to
FALSE to add this route to the routing table.
DestinationAddress and SubnetMask are used as the
@@ -326,8 +326,8 @@ EFI_STATUS
/**
Initiate a nonblocking TCP connection request for an active TCP instance.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param ConnectionToken Pointer to the connection token to return when the TCP three
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param ConnectionToken The pointer to the connection token to return when the TCP three
way handshake finishes.
@retval EFI_SUCCESS The connection request is successfully initiated and the state
@@ -355,8 +355,8 @@ EFI_STATUS
/**
Listen on the passive instance to accept an incoming connection request. This is a nonblocking operation.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param ListenToken Pointer to the listen token to return when operation finishes.
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param ListenToken The pointer to the listen token to return when operation finishes.
@retval EFI_SUCCESS The listen token has been queued successfully.
@retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
@@ -383,8 +383,8 @@ EFI_STATUS
/**
Queues outgoing data into the transmit queue.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param Token Pointer to the completion token to queue to the transmit queue.
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param Token The pointer to the completion token to queue to the transmit queue.
@retval EFI_SUCCESS The data has been queued for transmission.
@retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
@@ -422,8 +422,8 @@ EFI_STATUS
/**
Places an asynchronous receive request into the receiving queue.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param Token Pointer to a token that is associated with the receive data
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param Token The pointer to a token that is associated with the receive data
descriptor.
@retval EFI_SUCCESS The receive completion token was cached.
@@ -465,8 +465,8 @@ EFI_STATUS
Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a
nonblocking operation.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param CloseToken Pointer to the close token to return when operation finishes.
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param CloseToken The pointer to the close token to return when operation finishes.
@retval EFI_SUCCESS The Close() is called successfully.
@retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.
@@ -494,8 +494,8 @@ EFI_STATUS
/**
Abort an asynchronous connection, listen, transmission or receive request.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param Token Pointer to a token that has been issued by
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@param Token The pointer to a token that has been issued by
EFI_TCP4_PROTOCOL.Connect(),
EFI_TCP4_PROTOCOL.Accept(),
EFI_TCP4_PROTOCOL.Transmit() or
@@ -527,7 +527,7 @@ EFI_STATUS
/**
Poll to receive incoming data and transmit outgoing segments.
@param This Pointer to the EFI_TCP4_PROTOCOL instance.
@param This The pointer to the EFI_TCP4_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_INVALID_PARAMETER This is NULL.

52
MdePkg/Include/Protocol/Udp4.h
View File

@@ -4,17 +4,17 @@
The EFI UDPv4 Protocol provides simple packet-oriented services
to transmit and receive UDP packets.
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.0
This Protocol is introduced in UEFI Specification 2.0.
**/
@@ -124,11 +124,11 @@ typedef struct {
optionally to retrieve the operational mode data of underlying networks or
drivers.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param Udp4ConfigData Pointer to the buffer to receive the current configuration data.
@param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.
@param MnpConfigData Pointer to the managed network configuration data structure.
@param SnpModeData Pointer to the simple network mode data structure.
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@param Udp4ConfigData The pointer to the buffer to receive the current configuration data.
@param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure.
@param MnpConfigData The pointer to the managed network configuration data structure.
@param SnpModeData The pointer to the simple network mode data structure.
@retval EFI_SUCCESS The mode data was read.
@retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is
@@ -162,8 +162,8 @@ EFI_STATUS
With different parameters in UdpConfigData, Configure() can be used to bind
this instance to specified port.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param Udp4ConfigData Pointer to the buffer to receive the current configuration data.
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@param Udp4ConfigData The pointer to the buffer to receive the current configuration data.
@retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
@@ -194,10 +194,10 @@ EFI_STATUS
filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all
currently joined groups are left.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one
or all multicast groups.
@param MulticastAddress Pointer to multicast group address to join or leave.
@param MulticastAddress The pointer to multicast group address to join or leave.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.
@@ -245,7 +245,7 @@ EFI_STATUS
copies will be updated automatically whenever the IP driver reconfigures its
instances; as a result, the previous modification to these copies will be lost.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@param DeleteRoute Set to TRUE to delete this route from the routing table.
Set to FALSE to add this route to the routing table.
@param SubnetAddress The destination network address that needs to be routed.
@@ -284,7 +284,7 @@ EFI_STATUS
Drivers and applications that are experiencing packet loss should try calling
the Poll() function more often.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -310,8 +310,8 @@ EFI_STATUS
will enable the user to receive the notification and receiving status. That
notification function is guaranteed to not be re-entered.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param Token Pointer to a token that is associated with the receive data
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@param Token The pointer to a token that is associated with the receive data
descriptor.
@retval EFI_SUCCESS The receive completion token was cached.
@@ -344,8 +344,8 @@ EFI_STATUS
and context for the event will enable the user to receive the notification and
transmitting status.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param Token Pointer to the completion token that will be placed into the
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@param Token The pointer to the completion token that will be placed into the
transmit queue.
@retval EFI_SUCCESS The data has been queued for transmission.
@@ -381,8 +381,8 @@ EFI_STATUS
the asynchronous operation has completed, this function will not signal the
token and EFI_NOT_FOUND is returned.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param Token Pointer to a token that has been issued by
@param This The pointer to the EFI_UDP4_PROTOCOL instance.
@param Token The pointer to a token that has been issued by
EFI_UDP4_PROTOCOL.Transmit() or
EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
tokens are aborted.

22
MdePkg/Include/Protocol/UnicodeCollation.h
View File

@@ -3,14 +3,14 @@
This protocol is used to allow code running in the boot services environment
to perform lexical comparison functions on Unicode strings for given languages.
Copyright (c) 2006 - 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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.
**/
@@ -55,9 +55,9 @@ typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE;
@param Str1 A pointer to a Null-terminated string.
@param Str2 A pointer to a Null-terminated string.
@retval 0 Str1 is equivalent to Str2
@retval >0 Str1 is lexically greater than Str2
@retval <0 Str1 is lexically less than Str2
@retval 0 Str1 is equivalent to Str2.
@retval >0 Str1 is lexically greater than Str2.
@retval <0 Str1 is lexically less than Str2.
**/
typedef