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

Fix doxygen comment for structure and macro 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6091 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-10-09 17:40:26 +00:00
parent 7b98db894f
commit 107ffdc9ce
5 changed files with 23 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
MdePkg/Include/Protocol/AcpiTable.h
View File

@ -108,13 +108,6 @@ EFI_STATUS
@par Protocol Description:
The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component
to install and uninstall ACPI tables from a platform.
@param InstallAcpiTable Installs an ACPI table into the system.
@param UninstallAcpiTable Removes a previously installed ACPI
table from the system.
**/
struct _EFI_ACPI_TABLE_PROTOCOL {
EFI_ACPI_TABLE_INSTALL_ACPI_TABLE InstallAcpiTable;

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

@ -9,7 +9,6 @@
The EFI ARP Protocol provides services to map IP network
address to hardware address used by a data link 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
@ -37,19 +36,19 @@
typedef struct _EFI_ARP_PROTOCOL EFI_ARP_PROTOCOL;
typedef struct {
UINT32 Size;
BOOLEAN DenyFlag;
BOOLEAN StaticFlag;
UINT16 HwAddressType;
UINT16 SwAddressType;
UINT8 HwAddressLength;
UINT8 SwAddressLength;
UINT32 Size;
BOOLEAN DenyFlag;
BOOLEAN StaticFlag;
UINT16 HwAddressType;
UINT16 SwAddressType;
UINT8 HwAddressLength;
UINT8 SwAddressLength;
} EFI_ARP_FIND_DATA;
typedef struct {
UINT16 SwAddressType; // Host byte order
UINT16 SwAddressType; ///< Host byte order
UINT8 SwAddressLength;
VOID *StationAddress; // Network byte order
VOID *StationAddress; ///< Network byte order
UINT32 EntryTimeOut;
UINT32 RetryCount;
UINT32 RetryTimeOut;
@ -254,28 +253,6 @@ EFI_STATUS
@par Protocol Description:
ARP is used to resolve local network protocol addresses into
network hardware addresses.
@param Configure
Adds a new station address (protocol type and network address) to the ARP cache.
@param Add
Manually inserts an entry to the ARP cache for administrative purpose.
@param Find
Locates one or more entries in the ARP cache.
@param Delete
Removes an entry from the ARP cache.
@param Flush
Removes all dynamic ARP cache entries of a specified protocol type.
@param Request
Starts an ARP request session.
@param Cancel
Abort previous ARP request session.
**/
struct _EFI_ARP_PROTOCOL {
EFI_ARP_CONFIGURE Configure;

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

@ -41,9 +41,9 @@ typedef struct {
typedef struct {
AUTH_NODE_HEADER Header;
EFI_IPv6_ADDRESS RadiusIpAddr; // IPv4 or IPv6 address
EFI_IPv6_ADDRESS RadiusIpAddr; ///< IPv4 or IPv6 address
UINT16 Reserved;
EFI_IPv6_ADDRESS NasIpAddr; // IPv4 or IPv6 address
EFI_IPv6_ADDRESS NasIpAddr; ///< IPv4 or IPv6 address
UINT16 NasSecretLength;
UINT8 *NasSecret;
UINT16 ChapSecretLength;
@ -113,13 +113,6 @@ EFI_STATUS
@par Protocol Description:
This protocol is used on any device handle to obtain authentication
information associated with the physical or logical device.
@param Get
Used to retrieve the Authentication Information associated with the controller handle
@param Set
Used to set the Authentication information associated with the controller handle
**/
struct _EFI_AUTHENTICATION_INFO_PROTOCOL {
EFI_AUTHENTICATION_PROTOCOL_INFO_GET Get;

6
MdePkg/Include/Protocol/Bds.h
View File

@ -66,12 +66,6 @@ VOID
back to the dispatcher. Once the required boot devices are available, then
the boot device can be used to load and invoke an OS or a system utility.
@par Protocol Parameters:
Entry - The entry point to BDS. This call does not take any parameters,
and the return value can be ignored. If it returns, then the
dispatcher must be invoked again, if it never returns, then an
operating system or a system utility have been invoked.
**/
struct _EFI_BDS_ARCH_PROTOCOL {
EFI_BDS_ENTRY Entry;

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

@ -45,22 +45,20 @@ typedef VOID *BIS_APPLICATION_HANDLE;
typedef UINT16 BIS_ALG_ID;
typedef UINT32 BIS_CERT_ID;
///
/// EFI_BIS_DATA type.
///
/// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).
///
typedef struct {
UINT32 Length; // Length of Data in 8 bit bytes.
UINT8 *Data; // 32 Bit Flat Address of data.
UINT32 Length; ///< Length of Data in 8 bit bytes.
UINT8 *Data; ///< 32 Bit Flat Address of data.
} EFI_BIS_DATA;
///
/// EFI_BIS_VERSION type.
///
typedef struct {
UINT32 Major; // BIS Interface version number.
UINT32 Minor; // Build number.
UINT32 Major; ///< BIS Interface version number.
UINT32 Minor; ///< Build number.
} EFI_BIS_VERSION;
//
@ -76,25 +74,25 @@ typedef struct {
/// EFI_BIS_SIGNATURE_INFO type.
///
typedef struct {
BIS_CERT_ID CertificateID; // Truncated hash of platform Boot Object
/// authorization certificate.
///
BIS_ALG_ID AlgorithmID; // A signature algorithm number.
UINT16 KeyLength; // Length of alg. keys in bits.
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.
} EFI_BIS_SIGNATURE_INFO;
///
/// Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.
/// values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.
/// The exact numeric values come from
/// "Common Data Security Architecture (CDSA) Specification".
///
#define BIS_ALG_DSA (41) // CSSM_ALGID_DSA
#define BIS_ALG_RSA_MD5 (42) // CSSM_ALGID_MD5_WITH_RSA
/// Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId.
///
/// values for EFI_BIS_SIGNATURE_INFO.CertificateId.
///
#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 following is a 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.
@ -403,55 +401,6 @@ EFI_STATUS
@par Protocol Description:
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.
@param initialize
Initializes an application instance of the EFI_BIS protocol,
returning a handle for the application instance. Other functions in
the EFI_BIS protocol require a valid application instance
handle obtained from this function.
@param Shutdown
Ends the lifetime of an application instance of the EFI_BIS
protocol, invalidating its application instance handle. The
application instance handle may no longer be used in other
functions in the EFI_BIS protocol.
@param Free
Frees memory structures allocated and returned by other
functions in the EFI_BIS protocol.
@param GetBootObjectAuthorizationCertificate
Retrieves the current digital certificate (if any) used by the
EFI_BIS protocol as the source of authorization for verifying
boot objects and altering configuration parameters.
@param GetBootObjectAuthorizationCheckFlag
Retrieves the current setting of the authorization check flag that
indicates whether or not authorization checks are required for
boot objects.
@param GetBootObjectAuthorizationUpdateToken
Retrieves an uninterpreted token whose value gets included and
signed in a subsequent request to alter the configuration
parameters, to protect against attempts to replay such a request.
@param GetSignatureInfo
Retrieves information about the digital signature algorithms
supported and the identity of the installed authorization
certificate, if any.
@param UpdateBootObjectAuthorization
Requests that the configuration parameters be altered by
installing or removing an authorization certificate or changing the
setting of the check flag.
@param VerifyBootObject
Verifies a boot object according to the supplied digital signature
and the current authorization certificate and check flag setting.
@param VerifyObjectWithCredential
Verifies a data object according to a supplied digital signature
and a supplied digital certificate.
**/
struct _EFI_BIS_PROTOCOL {
EFI_BIS_INITIALIZE Initialize;