The EFI ARP Protocol provides services to map IP network\r
address to hardware address used by a data link protocol.\r
\r
- \r
Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
typedef struct _EFI_ARP_PROTOCOL EFI_ARP_PROTOCOL;\r
\r
typedef struct {\r
-UINT32 Size;\r
-BOOLEAN DenyFlag;\r
-BOOLEAN StaticFlag;\r
-UINT16 HwAddressType;\r
-UINT16 SwAddressType;\r
-UINT8 HwAddressLength;\r
-UINT8 SwAddressLength;\r
+ UINT32 Size;\r
+ BOOLEAN DenyFlag;\r
+ BOOLEAN StaticFlag;\r
+ UINT16 HwAddressType;\r
+ UINT16 SwAddressType;\r
+ UINT8 HwAddressLength;\r
+ UINT8 SwAddressLength;\r
} EFI_ARP_FIND_DATA;\r
\r
typedef struct {\r
- UINT16 SwAddressType; // Host byte order\r
+ UINT16 SwAddressType; ///< Host byte order\r
UINT8 SwAddressLength;\r
- VOID *StationAddress; // Network byte order\r
+ VOID *StationAddress; ///< Network byte order\r
UINT32 EntryTimeOut;\r
UINT32 RetryCount;\r
UINT32 RetryTimeOut;\r
@par Protocol Description:\r
ARP is used to resolve local network protocol addresses into \r
network hardware addresses.\r
-\r
- @param Configure\r
- Adds a new station address (protocol type and network address) to the ARP cache.\r
- \r
- @param Add\r
- Manually inserts an entry to the ARP cache for administrative purpose.\r
-\r
- @param Find\r
- Locates one or more entries in the ARP cache.\r
-\r
- @param Delete\r
- Removes an entry from the ARP cache.\r
- \r
- @param Flush\r
- Removes all dynamic ARP cache entries of a specified protocol type.\r
- \r
- @param Request\r
- Starts an ARP request session.\r
- \r
- @param Cancel\r
- Abort previous ARP request session.\r
-\r
**/\r
struct _EFI_ARP_PROTOCOL {\r
EFI_ARP_CONFIGURE Configure;\r
typedef UINT16 BIS_ALG_ID;\r
typedef UINT32 BIS_CERT_ID;\r
\r
-///\r
-/// EFI_BIS_DATA type.\r
///\r
/// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).\r
///\r
typedef struct {\r
- UINT32 Length; // Length of Data in 8 bit bytes.\r
- UINT8 *Data; // 32 Bit Flat Address of data.\r
+ UINT32 Length; ///< Length of Data in 8 bit bytes.\r
+ UINT8 *Data; ///< 32 Bit Flat Address of data.\r
} EFI_BIS_DATA;\r
\r
///\r
/// EFI_BIS_VERSION type.\r
///\r
typedef struct {\r
- UINT32 Major; // BIS Interface version number.\r
- UINT32 Minor; // Build number.\r
+ UINT32 Major; ///< BIS Interface version number.\r
+ UINT32 Minor; ///< Build number.\r
} EFI_BIS_VERSION;\r
\r
//\r
/// EFI_BIS_SIGNATURE_INFO type.\r
///\r
typedef struct {\r
- BIS_CERT_ID CertificateID; // Truncated hash of platform Boot Object\r
- /// authorization certificate.\r
- ///\r
- BIS_ALG_ID AlgorithmID; // A signature algorithm number.\r
- UINT16 KeyLength; // Length of alg. keys in bits.\r
+ BIS_CERT_ID CertificateID; ///< Truncated hash of platform Boot Object\r
+ BIS_ALG_ID AlgorithmID; ///< A signature algorithm number.\r
+ UINT16 KeyLength; ///< Length of alg. keys in bits.\r
} EFI_BIS_SIGNATURE_INFO;\r
\r
///\r
-/// Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r
+/// values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r
/// The exact numeric values come from\r
/// "Common Data Security Architecture (CDSA) Specification".\r
///\r
#define BIS_ALG_DSA (41) // CSSM_ALGID_DSA\r
#define BIS_ALG_RSA_MD5 (42) // CSSM_ALGID_MD5_WITH_RSA\r
-/// Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId.\r
+///\r
+/// values for EFI_BIS_SIGNATURE_INFO.CertificateId.\r
///\r
#define BIS_CERT_ID_DSA BIS_ALG_DSA // CSSM_ALGID_DSA\r
#define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA\r
-/// The following is a mask value that gets applied to the truncated hash of a\r
+///\r
+/// the mask value that gets applied to the truncated hash of a\r
/// platform Boot Object Authorization Certificate to create the certificateID.\r
/// A certificateID must not have any bits set to the value 1 other than bits in\r
/// this mask.\r
@par Protocol Description:\r
The EFI_BIS_PROTOCOL is used to check a digital signature of a data block against a digital\r
certificate for the purpose of an integrity and authorization check.\r
-\r
- @param initialize\r
- Initializes an application instance of the EFI_BIS protocol,\r
- returning a handle for the application instance. Other functions in\r
- the EFI_BIS protocol require a valid application instance\r
- handle obtained from this function.\r
- \r
- @param Shutdown \r
- Ends the lifetime of an application instance of the EFI_BIS\r
- protocol, invalidating its application instance handle. The\r
- application instance handle may no longer be used in other\r
- functions in the EFI_BIS protocol.\r
-\r
- @param Free \r
- Frees memory structures allocated and returned by other\r
- functions in the EFI_BIS protocol. \r
-\r
- @param GetBootObjectAuthorizationCertificate\r
- Retrieves the current digital certificate (if any) used by the\r
- EFI_BIS protocol as the source of authorization for verifying\r
- boot objects and altering configuration parameters.\r
-\r
- @param GetBootObjectAuthorizationCheckFlag\r
- Retrieves the current setting of the authorization check flag that\r
- indicates whether or not authorization checks are required for\r
- boot objects.\r
-\r
- @param GetBootObjectAuthorizationUpdateToken\r
- Retrieves an uninterpreted token whose value gets included and\r
- signed in a subsequent request to alter the configuration\r
- parameters, to protect against attempts to replay such a request.\r
-\r
- @param GetSignatureInfo \r
- Retrieves information about the digital signature algorithms\r
- supported and the identity of the installed authorization\r
- certificate, if any.\r
-\r
- @param UpdateBootObjectAuthorization\r
- Requests that the configuration parameters be altered by\r
- installing or removing an authorization certificate or changing the\r
- setting of the check flag. \r
-\r
- @param VerifyBootObject\r
- Verifies a boot object according to the supplied digital signature\r
- and the current authorization certificate and check flag setting.\r
-\r
- @param VerifyObjectWithCredential\r
- Verifies a data object according to a supplied digital signature\r
- and a supplied digital certificate. \r
**/\r
struct _EFI_BIS_PROTOCOL {\r
EFI_BIS_INITIALIZE Initialize;\r
projects / mirror_edk2.git / commitdiff