From 5975b4e70abbcd2319df0451f73c51bd9e9c342c Mon Sep 17 00:00:00 2001 From: Alex Dale Date: Mon, 27 Sep 2021 22:22:24 -0700 Subject: [PATCH] Formatted OTA keybox function comments. The API comments for the two new OTA keybox OEMCrypto functions required formatting to be compatible with the doxygen comment strings. Bug: 190505461 Test: Android unit tests and GTS Merged-In: Ia45dc9d727a2a904170912193709cd9416b8fe27 Change-Id: Ia45dc9d727a2a904170912193709cd9416b8fe27 (cherry picked from commit 9f2364cefd71d00b87d606dff3a3bb3287fa673f) --- .../oemcrypto/include/OEMCryptoCENC.h | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/libwvdrmengine/oemcrypto/include/OEMCryptoCENC.h b/libwvdrmengine/oemcrypto/include/OEMCryptoCENC.h index e40a340c..439b5b76 100644 --- a/libwvdrmengine/oemcrypto/include/OEMCryptoCENC.h +++ b/libwvdrmengine/oemcrypto/include/OEMCryptoCENC.h @@ -624,9 +624,10 @@ typedef enum OEMCrypto_ProvisioningMethod { #define OEMCrypto_MinorAPIVersion _oecc108 #define OEMCrypto_AllocateSecureBuffer _oecc109 #define OEMCrypto_FreeSecureBuffer _oecc110 -// Reserved 111-112. +// Reserved 111-112 #define OEMCrypto_GenerateOTARequest _oecc113 #define OEMCrypto_ProcessOTAKeybox _oecc114 +// Reserved 115-121 // clang-format on /// @addtogroup initcontrol @@ -4737,9 +4738,7 @@ OEMCryptoResult OEMCrypto_FreeSecureBuffer( * security implications of using Keybox OTA Provisioning. */ -/* - * OEMCrypto_GenerateOTARequest - * +/** * Generate an OTA Keybox provisioning request. The format of the * message is specified in the document Keybox OTA Reprovisioning. If * use_test_key is true, then the debug model key and id should be @@ -4749,7 +4748,7 @@ OEMCryptoResult OEMCrypto_FreeSecureBuffer( * * @param[in] session: handle for the session to be used. * @param[out] buffer: where the provisioning request is stored. - * @param[in/out] buffer_length: length of the request, in bytes. + * @param[in,out] buffer_length: length of the request, in bytes. * @param[in] use_test_key: If non-zero, use the debug model key. This is used * for testing the workflow. * @@ -4773,28 +4772,27 @@ OEMCryptoResult OEMCrypto_GenerateOTARequest(OEMCrypto_SESSION session, uint8_t* buffer, size_t* buffer_length, uint32_t use_test_key); -/* - * OEMCrypto_ProcessOTAKeybox - * + +/** * The buffer will be parsed as an OTA Keybox provisioning message, as * described in the document OTA Keybox Reprovisioning. The * signature will be verified. The keybox will be decrypted and verified. If - * use_test_key is false, the keybox will be installed permanently. + * |use_test_key| is false, the keybox will be installed permanently. * - * If use_test_keybox is true, do not use the real model key, use the debug + * If |use_test_key| is true, do not use the real model key, use the debug * model key specified in OTA Keybox Reprovisioning. * * @param[in] session: handle for the session to be used. * @param[in] buffer: pointer to provisioning response. * @param[in] buffer_length: length of the buffer, in bytes. * @param[in] use_test_key: If non-zero, use the debug model key. This is used - * for testing the workflow. + * for testing the workflow. * * @retval OEMCrypto_SUCCESS on success * @retval OEMCrypto_ERROR_NOT_IMPLEMENTED * @retval OEMCrypto_ERROR_SIGNATURE_FAILURE - signature of message was wrong. * @retval OEMCrypto_ERROR_KEYBOX_INVALID - if the keybox was unpacked, but is - * invalid. + * invalid. * @retval OEMCrypto_ERROR_WRITE_KEYBOX - could not save keybox. * Any other error will be logged. *