CryptoPkg: 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:39 -08:00 committed by mergify[bot]
parent 9607597a74
commit c8f46130f8
13 changed files with 63 additions and 69 deletions

View File

@ -2638,7 +2638,7 @@ EFIAPI
CryptoServiceX509GetCommonName ( CryptoServiceX509GetCommonName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
) )
{ {
@ -2676,7 +2676,7 @@ EFIAPI
CryptoServiceX509GetOrganizationName ( CryptoServiceX509GetOrganizationName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *NameBuffer, OPTIONAL OUT CHAR8 *NameBuffer OPTIONAL,
IN OUT UINTN *NameBufferSize IN OUT UINTN *NameBufferSize
) )
{ {
@ -2945,8 +2945,8 @@ CryptoServicePkcs1v2Encrypt (
IN UINTN PublicKeySize, IN UINTN PublicKeySize,
IN UINT8 *InData, IN UINT8 *InData,
IN UINTN InDataSize, IN UINTN InDataSize,
IN CONST UINT8 *PrngSeed, OPTIONAL IN CONST UINT8 *PrngSeed OPTIONAL,
IN UINTN PrngSeedSize, OPTIONAL IN UINTN PrngSeedSize OPTIONAL,
OUT UINT8 **EncryptedData, OUT UINT8 **EncryptedData,
OUT UINTN *EncryptedDataSize OUT UINTN *EncryptedDataSize
) )
@ -3697,9 +3697,9 @@ EFI_STATUS
EFIAPI EFIAPI
CryptoServiceTlsDoHandshake ( CryptoServiceTlsDoHandshake (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {
@ -3735,9 +3735,9 @@ EFI_STATUS
EFIAPI EFIAPI
CryptoServiceTlsHandleAlert ( CryptoServiceTlsHandleAlert (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {

View File

@ -1550,7 +1550,7 @@ EFIAPI
X509GetCommonName ( X509GetCommonName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
); );
@ -1585,7 +1585,7 @@ EFIAPI
X509GetOrganizationName ( X509GetOrganizationName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *NameBuffer, OPTIONAL OUT CHAR8 *NameBuffer OPTIONAL,
IN OUT UINTN *NameBufferSize IN OUT UINTN *NameBufferSize
); );
@ -1821,8 +1821,8 @@ Pkcs1v2Encrypt (
IN UINTN PublicKeySize, IN UINTN PublicKeySize,
IN UINT8 *InData, IN UINT8 *InData,
IN UINTN InDataSize, IN UINTN InDataSize,
IN CONST UINT8 *PrngSeed, OPTIONAL IN CONST UINT8 *PrngSeed OPTIONAL,
IN UINTN PrngSeedSize, OPTIONAL IN UINTN PrngSeedSize OPTIONAL,
OUT UINT8 **EncryptedData, OUT UINT8 **EncryptedData,
OUT UINTN *EncryptedDataSize OUT UINTN *EncryptedDataSize
); );

View File

@ -137,9 +137,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsDoHandshake ( TlsDoHandshake (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
); );
@ -172,9 +172,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsHandleAlert ( TlsHandleAlert (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
); );
@ -811,4 +811,3 @@ TlsGetCertRevocationList (
); );
#endif // __TLS_LIB_H__ #endif // __TLS_LIB_H__

View File

@ -50,8 +50,8 @@ Pkcs1v2Encrypt (
IN UINTN PublicKeySize, IN UINTN PublicKeySize,
IN UINT8 *InData, IN UINT8 *InData,
IN UINTN InDataSize, IN UINTN InDataSize,
IN CONST UINT8 *PrngSeed, OPTIONAL IN CONST UINT8 *PrngSeed OPTIONAL,
IN UINTN PrngSeedSize, OPTIONAL IN UINTN PrngSeedSize OPTIONAL,
OUT UINT8 **EncryptedData, OUT UINT8 **EncryptedData,
OUT UINTN *EncryptedDataSize OUT UINTN *EncryptedDataSize
) )
@ -205,4 +205,3 @@ _Exit:
return Result; return Result;
} }

View File

@ -39,8 +39,8 @@ Pkcs1v2Encrypt (
IN UINTN PublicKeySize, IN UINTN PublicKeySize,
IN UINT8 *InData, IN UINT8 *InData,
IN UINTN InDataSize, IN UINTN InDataSize,
IN CONST UINT8 *PrngSeed, OPTIONAL IN CONST UINT8 *PrngSeed OPTIONAL,
IN UINTN PrngSeedSize, OPTIONAL IN UINTN PrngSeedSize OPTIONAL,
OUT UINT8 **EncryptedData, OUT UINT8 **EncryptedData,
OUT UINTN *EncryptedDataSize OUT UINTN *EncryptedDataSize
) )
@ -48,4 +48,3 @@ Pkcs1v2Encrypt (
ASSERT (FALSE); ASSERT (FALSE);
return FALSE; return FALSE;
} }

View File

@ -354,7 +354,7 @@ InternalX509GetNIDName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
IN INT32 Request_NID, IN INT32 Request_NID,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
) )
{ {
@ -496,7 +496,7 @@ EFIAPI
X509GetCommonName ( X509GetCommonName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
) )
{ {
@ -534,7 +534,7 @@ EFIAPI
X509GetOrganizationName ( X509GetOrganizationName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *NameBuffer, OPTIONAL OUT CHAR8 *NameBuffer OPTIONAL,
IN OUT UINTN *NameBufferSize IN OUT UINTN *NameBufferSize
) )
{ {

View File

@ -175,7 +175,7 @@ EFIAPI
X509GetCommonName ( X509GetCommonName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
) )
{ {
@ -207,7 +207,7 @@ EFIAPI
X509GetOrganizationName ( X509GetOrganizationName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *NameBuffer, OPTIONAL OUT CHAR8 *NameBuffer OPTIONAL,
IN OUT UINTN *NameBufferSize IN OUT UINTN *NameBufferSize
) )
{ {

View File

@ -39,8 +39,8 @@ Pkcs1v2Encrypt (
IN UINTN PublicKeySize, IN UINTN PublicKeySize,
IN UINT8 *InData, IN UINT8 *InData,
IN UINTN InDataSize, IN UINTN InDataSize,
IN CONST UINT8 *PrngSeed, OPTIONAL IN CONST UINT8 *PrngSeed OPTIONAL,
IN UINTN PrngSeedSize, OPTIONAL IN UINTN PrngSeedSize OPTIONAL,
OUT UINT8 **EncryptedData, OUT UINT8 **EncryptedData,
OUT UINTN *EncryptedDataSize OUT UINTN *EncryptedDataSize
) )
@ -48,4 +48,3 @@ Pkcs1v2Encrypt (
ASSERT (FALSE); ASSERT (FALSE);
return FALSE; return FALSE;
} }

View File

@ -175,7 +175,7 @@ EFIAPI
X509GetCommonName ( X509GetCommonName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
) )
{ {
@ -207,7 +207,7 @@ EFIAPI
X509GetOrganizationName ( X509GetOrganizationName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *NameBuffer, OPTIONAL OUT CHAR8 *NameBuffer OPTIONAL,
IN OUT UINTN *NameBufferSize IN OUT UINTN *NameBufferSize
) )
{ {

View File

@ -1752,7 +1752,7 @@ EFIAPI
X509GetCommonName ( X509GetCommonName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
) )
{ {
@ -1790,7 +1790,7 @@ EFIAPI
X509GetOrganizationName ( X509GetOrganizationName (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *NameBuffer, OPTIONAL OUT CHAR8 *NameBuffer OPTIONAL,
IN OUT UINTN *NameBufferSize IN OUT UINTN *NameBufferSize
) )
{ {
@ -2060,8 +2060,8 @@ Pkcs1v2Encrypt (
IN UINTN PublicKeySize, IN UINTN PublicKeySize,
IN UINT8 *InData, IN UINT8 *InData,
IN UINTN InDataSize, IN UINTN InDataSize,
IN CONST UINT8 *PrngSeed, OPTIONAL IN CONST UINT8 *PrngSeed OPTIONAL,
IN UINTN PrngSeedSize, OPTIONAL IN UINTN PrngSeedSize OPTIONAL,
OUT UINT8 **EncryptedData, OUT UINT8 **EncryptedData,
OUT UINTN *EncryptedDataSize OUT UINTN *EncryptedDataSize
) )
@ -2812,9 +2812,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsDoHandshake ( TlsDoHandshake (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {
@ -2850,9 +2850,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsHandleAlert ( TlsHandleAlert (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {

View File

@ -72,9 +72,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsDoHandshake ( TlsDoHandshake (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {
@ -193,9 +193,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsHandleAlert ( TlsHandleAlert (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {
@ -454,4 +454,3 @@ TlsWrite (
// //
return SSL_write (TlsConn->Ssl, Buffer, (UINT32) BufferSize); return SSL_write (TlsConn->Ssl, Buffer, (UINT32) BufferSize);
} }

View File

@ -61,9 +61,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsDoHandshake ( TlsDoHandshake (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {
@ -100,9 +100,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsHandleAlert ( TlsHandleAlert (
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
) )
{ {
@ -244,4 +244,3 @@ TlsWrite (
ASSERT(FALSE); ASSERT(FALSE);
return 0; return 0;
} }

View File

@ -1991,7 +1991,7 @@ EFI_STATUS
(EFIAPI *EDKII_CRYPTO_X509_GET_COMMON_NAME) ( (EFIAPI *EDKII_CRYPTO_X509_GET_COMMON_NAME) (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *CommonName, OPTIONAL OUT CHAR8 *CommonName OPTIONAL,
IN OUT UINTN *CommonNameSize IN OUT UINTN *CommonNameSize
); );
@ -2026,7 +2026,7 @@ EFI_STATUS
(EFIAPI *EDKII_CRYPTO_X509_GET_ORGANIZATION_NAME) ( (EFIAPI *EDKII_CRYPTO_X509_GET_ORGANIZATION_NAME) (
IN CONST UINT8 *Cert, IN CONST UINT8 *Cert,
IN UINTN CertSize, IN UINTN CertSize,
OUT CHAR8 *NameBuffer, OPTIONAL OUT CHAR8 *NameBuffer OPTIONAL,
IN OUT UINTN *NameBufferSize IN OUT UINTN *NameBufferSize
); );
@ -2735,9 +2735,9 @@ typedef
EFI_STATUS EFI_STATUS
(EFIAPI* EDKII_CRYPTO_TLS_DO_HANDSHAKE)( (EFIAPI* EDKII_CRYPTO_TLS_DO_HANDSHAKE)(
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
); );
@ -2770,9 +2770,9 @@ typedef
EFI_STATUS EFI_STATUS
(EFIAPI* EDKII_CRYPTO_TLS_HANDLE_ALERT)( (EFIAPI* EDKII_CRYPTO_TLS_HANDLE_ALERT)(
IN VOID *Tls, IN VOID *Tls,
IN UINT8 *BufferIn, OPTIONAL IN UINT8 *BufferIn OPTIONAL,
IN UINTN BufferInSize, OPTIONAL IN UINTN BufferInSize OPTIONAL,
OUT UINT8 *BufferOut, OPTIONAL OUT UINT8 *BufferOut OPTIONAL,
IN OUT UINTN *BufferOutSize IN OUT UINTN *BufferOutSize
); );