SecurityPkg: Change OPTIONAL keyword usage style

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3760

Update all use of ', OPTIONAL' to ' OPTIONAL,' for function params.

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
This commit is contained in:
Michael D Kinney 2021-12-02 18:00:56 -08:00 committed by mergify[bot]
parent dc8fe5ec95
commit 12710fe93b
20 changed files with 31 additions and 31 deletions

View File

@ -40,7 +40,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
UINT32 UINT32
EFIAPI EFIAPI
Tcg2PpVendorLibExecutePendingRequest ( Tcg2PpVendorLibExecutePendingRequest (
IN TPM2B_AUTH *PlatformAuth, OPTIONAL IN TPM2B_AUTH *PlatformAuth OPTIONAL,
IN UINT32 OperationRequest, IN UINT32 OperationRequest,
IN OUT UINT32 *ManagementFlags, IN OUT UINT32 *ManagementFlags,
OUT BOOLEAN *ResetRequired OUT BOOLEAN *ResetRequired

View File

@ -186,7 +186,7 @@ EFI_STATUS
EFIAPI EFIAPI
Tpm2ClearControl ( Tpm2ClearControl (
IN TPMI_RH_CLEAR AuthHandle, IN TPMI_RH_CLEAR AuthHandle,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPMI_YES_NO Disable IN TPMI_YES_NO Disable
); );
@ -340,7 +340,7 @@ EFI_STATUS
EFIAPI EFIAPI
Tpm2NvDefineSpace ( Tpm2NvDefineSpace (
IN TPMI_RH_PROVISION AuthHandle, IN TPMI_RH_PROVISION AuthHandle,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPM2B_AUTH *Auth, IN TPM2B_AUTH *Auth,
IN TPM2B_NV_PUBLIC *NvPublic IN TPM2B_NV_PUBLIC *NvPublic
); );
@ -383,7 +383,7 @@ EFIAPI
Tpm2NvRead ( Tpm2NvRead (
IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_AUTH AuthHandle,
IN TPMI_RH_NV_INDEX NvIndex, IN TPMI_RH_NV_INDEX NvIndex,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN UINT16 Size, IN UINT16 Size,
IN UINT16 Offset, IN UINT16 Offset,
IN OUT TPM2B_MAX_BUFFER *OutData IN OUT TPM2B_MAX_BUFFER *OutData
@ -407,7 +407,7 @@ EFIAPI
Tpm2NvWrite ( Tpm2NvWrite (
IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_AUTH AuthHandle,
IN TPMI_RH_NV_INDEX NvIndex, IN TPMI_RH_NV_INDEX NvIndex,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPM2B_MAX_BUFFER *InData, IN TPM2B_MAX_BUFFER *InData,
IN UINT16 Offset IN UINT16 Offset
); );
@ -566,7 +566,7 @@ Tpm2PcrAllocate (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
Tpm2PcrAllocateBanks ( Tpm2PcrAllocateBanks (
IN TPM2B_AUTH *PlatformAuth, OPTIONAL IN TPM2B_AUTH *PlatformAuth OPTIONAL,
IN UINT32 SupportedPCRBanks, IN UINT32 SupportedPCRBanks,
IN UINT32 PCRBanks IN UINT32 PCRBanks
); );
@ -908,7 +908,7 @@ EFIAPI
Tpm2PolicySecret ( Tpm2PolicySecret (
IN TPMI_DH_ENTITY AuthHandle, IN TPMI_DH_ENTITY AuthHandle,
IN TPMI_SH_POLICY PolicySession, IN TPMI_SH_POLICY PolicySession,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPM2B_NONCE *NonceTPM, IN TPM2B_NONCE *NonceTPM,
IN TPM2B_DIGEST *CpHashA, IN TPM2B_DIGEST *CpHashA,
IN TPM2B_NONCE *PolicyRef, IN TPM2B_NONCE *PolicyRef,
@ -1004,7 +1004,7 @@ Tpm2ReadPublic (
UINT32 UINT32
EFIAPI EFIAPI
CopyAuthSessionCommand ( CopyAuthSessionCommand (
IN TPMS_AUTH_COMMAND *AuthSessionIn, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSessionIn OPTIONAL,
OUT UINT8 *AuthSessionOut OUT UINT8 *AuthSessionOut
); );

View File

@ -1183,9 +1183,9 @@ FindCertsFromDb (
IN EFI_GUID *VendorGuid, IN EFI_GUID *VendorGuid,
IN UINT8 *Data, IN UINT8 *Data,
IN UINTN DataSize, IN UINTN DataSize,
OUT UINT32 *CertOffset, OPTIONAL OUT UINT32 *CertOffset OPTIONAL,
OUT UINT32 *CertDataSize, OPTIONAL OUT UINT32 *CertDataSize OPTIONAL,
OUT UINT32 *CertNodeOffset,OPTIONAL OUT UINT32 *CertNodeOffset OPTIONAL,
OUT UINT32 *CertNodeSize OPTIONAL OUT UINT32 *CertNodeSize OPTIONAL
) )
{ {

View File

@ -32,7 +32,7 @@ EFI_STATUS
EFIAPI EFIAPI
DxeImageAuthenticationStatusHandler ( DxeImageAuthenticationStatusHandler (
IN UINT32 AuthenticationStatus, IN UINT32 AuthenticationStatus,
IN CONST EFI_DEVICE_PATH_PROTOCOL *File, OPTIONAL IN CONST EFI_DEVICE_PATH_PROTOCOL *File OPTIONAL,
IN VOID *FileBuffer, IN VOID *FileBuffer,
IN UINTN FileSize, IN UINTN FileSize,
IN BOOLEAN BootPolicy IN BOOLEAN BootPolicy

View File

@ -1636,7 +1636,7 @@ EFI_STATUS
EFIAPI EFIAPI
DxeImageVerificationHandler ( DxeImageVerificationHandler (
IN UINT32 AuthenticationStatus, IN UINT32 AuthenticationStatus,
IN CONST EFI_DEVICE_PATH_PROTOCOL *File, OPTIONAL IN CONST EFI_DEVICE_PATH_PROTOCOL *File OPTIONAL,
IN VOID *FileBuffer, IN VOID *FileBuffer,
IN UINTN FileSize, IN UINTN FileSize,
IN BOOLEAN BootPolicy IN BOOLEAN BootPolicy

View File

@ -123,7 +123,7 @@ EFIAPI
Rsa2048Sha256GuidedSectionHandler ( Rsa2048Sha256GuidedSectionHandler (
IN CONST VOID *InputSection, IN CONST VOID *InputSection,
OUT VOID **OutputBuffer, OUT VOID **OutputBuffer,
IN VOID *ScratchBuffer, OPTIONAL IN VOID *ScratchBuffer OPTIONAL,
OUT UINT32 *AuthenticationStatus OUT UINT32 *AuthenticationStatus
) )
{ {

View File

@ -147,7 +147,7 @@ Tpm2CommandChangeEps (
**/ **/
UINT32 UINT32
Tcg2ExecutePhysicalPresence ( Tcg2ExecutePhysicalPresence (
IN TPM2B_AUTH *PlatformAuth, OPTIONAL IN TPM2B_AUTH *PlatformAuth OPTIONAL,
IN UINT32 CommandCode, IN UINT32 CommandCode,
IN UINT32 CommandParameter, IN UINT32 CommandParameter,
IN OUT EFI_TCG2_PHYSICAL_PRESENCE_FLAGS *PpiFlags IN OUT EFI_TCG2_PHYSICAL_PRESENCE_FLAGS *PpiFlags
@ -720,7 +720,7 @@ Tcg2HaveValidTpmRequest (
**/ **/
VOID VOID
Tcg2ExecutePendingTpmRequest ( Tcg2ExecutePendingTpmRequest (
IN TPM2B_AUTH *PlatformAuth, OPTIONAL IN TPM2B_AUTH *PlatformAuth OPTIONAL,
IN OUT EFI_TCG2_PHYSICAL_PRESENCE *TcgPpData, IN OUT EFI_TCG2_PHYSICAL_PRESENCE *TcgPpData,
IN OUT EFI_TCG2_PHYSICAL_PRESENCE_FLAGS *Flags IN OUT EFI_TCG2_PHYSICAL_PRESENCE_FLAGS *Flags
) )

View File

@ -416,7 +416,7 @@ EFI_STATUS
EFIAPI EFIAPI
DxeTpm2MeasureBootHandler ( DxeTpm2MeasureBootHandler (
IN UINT32 AuthenticationStatus, IN UINT32 AuthenticationStatus,
IN CONST EFI_DEVICE_PATH_PROTOCOL *File, OPTIONAL IN CONST EFI_DEVICE_PATH_PROTOCOL *File OPTIONAL,
IN VOID *FileBuffer, IN VOID *FileBuffer,
IN UINTN FileSize, IN UINTN FileSize,
IN BOOLEAN BootPolicy IN BOOLEAN BootPolicy

View File

@ -710,7 +710,7 @@ EFI_STATUS
EFIAPI EFIAPI
DxeTpmMeasureBootHandler ( DxeTpmMeasureBootHandler (
IN UINT32 AuthenticationStatus, IN UINT32 AuthenticationStatus,
IN CONST EFI_DEVICE_PATH_PROTOCOL *File, OPTIONAL IN CONST EFI_DEVICE_PATH_PROTOCOL *File OPTIONAL,
IN VOID *FileBuffer, IN VOID *FileBuffer,
IN UINTN FileSize, IN UINTN FileSize,
IN BOOLEAN BootPolicy IN BOOLEAN BootPolicy

View File

@ -121,7 +121,7 @@ EFIAPI
Rsa2048Sha256GuidedSectionHandler ( Rsa2048Sha256GuidedSectionHandler (
IN CONST VOID *InputSection, IN CONST VOID *InputSection,
OUT VOID **OutputBuffer, OUT VOID **OutputBuffer,
IN VOID *ScratchBuffer, OPTIONAL IN VOID *ScratchBuffer OPTIONAL,
OUT UINT32 *AuthenticationStatus OUT UINT32 *AuthenticationStatus
) )
{ {

View File

@ -30,7 +30,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
UINT32 UINT32
EFIAPI EFIAPI
Tcg2PpVendorLibExecutePendingRequest ( Tcg2PpVendorLibExecutePendingRequest (
IN TPM2B_AUTH *PlatformAuth, OPTIONAL IN TPM2B_AUTH *PlatformAuth OPTIONAL,
IN UINT32 OperationRequest, IN UINT32 OperationRequest,
IN OUT UINT32 *ManagementFlags, IN OUT UINT32 *ManagementFlags,
OUT BOOLEAN *ResetRequired OUT BOOLEAN *ResetRequired

View File

@ -90,7 +90,7 @@ EFIAPI
Tpm2PolicySecret ( Tpm2PolicySecret (
IN TPMI_DH_ENTITY AuthHandle, IN TPMI_DH_ENTITY AuthHandle,
IN TPMI_SH_POLICY PolicySession, IN TPMI_SH_POLICY PolicySession,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPM2B_NONCE *NonceTPM, IN TPM2B_NONCE *NonceTPM,
IN TPM2B_DIGEST *CpHashA, IN TPM2B_DIGEST *CpHashA,
IN TPM2B_NONCE *PolicyRef, IN TPM2B_NONCE *PolicyRef,

View File

@ -84,7 +84,7 @@ GetHashMaskFromAlgo (
UINT32 UINT32
EFIAPI EFIAPI
CopyAuthSessionCommand ( CopyAuthSessionCommand (
IN TPMS_AUTH_COMMAND *AuthSessionIn, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSessionIn OPTIONAL,
OUT UINT8 *AuthSessionOut OUT UINT8 *AuthSessionOut
) )
{ {

View File

@ -305,7 +305,7 @@ EFI_STATUS
EFIAPI EFIAPI
Tpm2ClearControl ( Tpm2ClearControl (
IN TPMI_RH_CLEAR AuthHandle, IN TPMI_RH_CLEAR AuthHandle,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPMI_YES_NO Disable IN TPMI_YES_NO Disable
) )
{ {

View File

@ -566,7 +566,7 @@ Done:
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
Tpm2PcrAllocateBanks ( Tpm2PcrAllocateBanks (
IN TPM2B_AUTH *PlatformAuth, OPTIONAL IN TPM2B_AUTH *PlatformAuth OPTIONAL,
IN UINT32 SupportedPCRBanks, IN UINT32 SupportedPCRBanks,
IN UINT32 PCRBanks IN UINT32 PCRBanks
) )

View File

@ -281,7 +281,7 @@ EFI_STATUS
EFIAPI EFIAPI
Tpm2NvDefineSpace ( Tpm2NvDefineSpace (
IN TPMI_RH_PROVISION AuthHandle, IN TPMI_RH_PROVISION AuthHandle,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPM2B_AUTH *Auth, IN TPM2B_AUTH *Auth,
IN TPM2B_NV_PUBLIC *NvPublic IN TPM2B_NV_PUBLIC *NvPublic
) )
@ -525,7 +525,7 @@ EFIAPI
Tpm2NvRead ( Tpm2NvRead (
IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_AUTH AuthHandle,
IN TPMI_RH_NV_INDEX NvIndex, IN TPMI_RH_NV_INDEX NvIndex,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN UINT16 Size, IN UINT16 Size,
IN UINT16 Offset, IN UINT16 Offset,
IN OUT TPM2B_MAX_BUFFER *OutData IN OUT TPM2B_MAX_BUFFER *OutData
@ -670,7 +670,7 @@ EFIAPI
Tpm2NvWrite ( Tpm2NvWrite (
IN TPMI_RH_NV_AUTH AuthHandle, IN TPMI_RH_NV_AUTH AuthHandle,
IN TPMI_RH_NV_INDEX NvIndex, IN TPMI_RH_NV_INDEX NvIndex,
IN TPMS_AUTH_COMMAND *AuthSession, OPTIONAL IN TPMS_AUTH_COMMAND *AuthSession OPTIONAL,
IN TPM2B_MAX_BUFFER *InData, IN TPM2B_MAX_BUFFER *InData,
IN UINT16 Offset IN UINT16 Offset
) )

View File

@ -53,7 +53,7 @@ EFI_STATUS
EFIAPI EFIAPI
RngGetRNG ( RngGetRNG (
IN EFI_RNG_PROTOCOL *This, IN EFI_RNG_PROTOCOL *This,
IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL IN EFI_RNG_ALGORITHM *RNGAlgorithm OPTIONAL,
IN UINTN RNGValueLength, IN UINTN RNGValueLength,
OUT UINT8 *RNGValue OUT UINT8 *RNGValue
) )

View File

@ -49,7 +49,7 @@ EFI_STATUS
EFIAPI EFIAPI
RngGetRNG ( RngGetRNG (
IN EFI_RNG_PROTOCOL *This, IN EFI_RNG_PROTOCOL *This,
IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL IN EFI_RNG_ALGORITHM *RNGAlgorithm OPTIONAL,
IN UINTN RNGValueLength, IN UINTN RNGValueLength,
OUT UINT8 *RNGValue OUT UINT8 *RNGValue
) )

View File

@ -67,7 +67,7 @@ EFI_STATUS
EFIAPI EFIAPI
RngGetRNG ( RngGetRNG (
IN EFI_RNG_PROTOCOL *This, IN EFI_RNG_PROTOCOL *This,
IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL IN EFI_RNG_ALGORITHM *RNGAlgorithm OPTIONAL,
IN UINTN RNGValueLength, IN UINTN RNGValueLength,
OUT UINT8 *RNGValue OUT UINT8 *RNGValue
); );

View File

@ -56,7 +56,7 @@ HII_VENDOR_DEVICE_PATH mTcgHiiVendorDevicePath = {
EFI_STATUS EFI_STATUS
GetTpmState ( GetTpmState (
IN EFI_TCG_PROTOCOL *TcgProtocol, IN EFI_TCG_PROTOCOL *TcgProtocol,
OUT BOOLEAN *TpmEnable, OPTIONAL OUT BOOLEAN *TpmEnable OPTIONAL,
OUT BOOLEAN *TpmActivate OPTIONAL OUT BOOLEAN *TpmActivate OPTIONAL
) )
{ {