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:
@@ -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;
|
||||
|
Reference in New Issue
Block a user