From 065d4d151e11fdf75e4f05e6abe3df7ff6dc18a6 Mon Sep 17 00:00:00 2001 From: Vicky Min Date: Mon, 28 Aug 2023 12:05:33 -0700 Subject: [PATCH] Update C function/field documentation to match behavior in ODK PiperOrigin-RevId: 560780563 Change-Id: Ibd88398b06cca7a51d152fb6da95afd40cdd5a8b --- libwvdrmengine/oemcrypto/odk/include/odk.h | 16 +++++++++------- .../oemcrypto/odk/include/odk_structs.h | 16 +++++++++------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/libwvdrmengine/oemcrypto/odk/include/odk.h b/libwvdrmengine/oemcrypto/odk/include/odk.h index 16af94af..2df08e17 100644 --- a/libwvdrmengine/oemcrypto/odk/include/odk.h +++ b/libwvdrmengine/oemcrypto/odk/include/odk.h @@ -340,7 +340,7 @@ OEMCryptoResult ODK_PrepareCoreRenewalRequest(uint8_t* message, * of the message. (in) size of buffer reserved for the core message, in * bytes. (out) actual length of the core message, in bytes. * @param[in] nonce_values: pointer to the session's nonce data. - * @param[in] message_count_info: information used for server-side anomaly + * @param[in] counter_info: information used for server-side anomaly * detection * * @retval OEMCrypto_SUCCESS @@ -559,14 +559,17 @@ OEMCryptoResult ODK_RefreshV15Values(const ODK_TimerLimits* timer_limits, * @param[in,out] nonce_values: The session's nonce values. These will be * updated. * @param[out] parsed_license: the destination for the data. - * @param[out] timer_value: set if playback timer should be started. + * @param[out] timer_value: set to the new timer value. Only used if the return + * value is ODK_SET_TIMER. This must be non-null if OEMCrypto uses a + * hardware timer. * * @retval OEMCrypto_SUCCESS * @retval ODK_ERROR_CORE_MESSAGE: if the message did not parse correctly, or * there were other incorrect values. An error should be returned to the * CDM layer. * @retval ODK_UNSUPPORTED_API - * @retval ODK_SET_TIMER: if the playback timer has been started successfully + * @retval ODK_SET_TIMER: Success. The timer should be reset to the specified + * timer value. * @retval ODK_DISABLE_TIMER: if the playtime timer has been started * successfully then is disabled. * @retval ODK_TIMER_EXPIRED: if the license is attempted to be loaded after the @@ -574,7 +577,7 @@ OEMCryptoResult ODK_RefreshV15Values(const ODK_TimerLimits* timer_limits, * @retval OEMCrypto_ERROR_INVALåID_NONCE * * @version - * This method is new in version 16 of the API. + * This method changed in version 18 of the API. */ OEMCryptoResult ODK_ParseLicense( const uint8_t* message, size_t message_length, size_t core_message_length, @@ -632,7 +635,7 @@ OEMCryptoResult ODK_ParseLicense( * @retval OEMCrypto_ERROR_INVALID_NONCE * * @version - * This method is new in version 16 of the API. + * This method changed in version 18 of the API. */ OEMCryptoResult ODK_ParseRenewal(const uint8_t* message, size_t message_length, size_t core_message_length, @@ -670,7 +673,6 @@ OEMCryptoResult ODK_ParseRenewal(const uint8_t* message, size_t message_length, * @param[in] device_id: a pointer to a buffer containing the device ID of the * device. The ODK function will verify it matches that in the message. * @param[in] device_id_length: the length of the device ID. - * @param[out] counter_info: destination for counter portion of parse data. * @param[out] parsed_response: destination for response portion of parse data. * * @retval OEMCrypto_SUCCESS @@ -681,7 +683,7 @@ OEMCryptoResult ODK_ParseRenewal(const uint8_t* message, size_t message_length, * @retval OEMCrypto_ERROR_INVALID_NONCE * * @version - * This method is new in version 16 of the API. + * This method changed in version 18 of the API. */ OEMCryptoResult ODK_ParseProvisioning( const uint8_t* message, size_t message_length, size_t core_message_length, diff --git a/libwvdrmengine/oemcrypto/odk/include/odk_structs.h b/libwvdrmengine/oemcrypto/odk/include/odk_structs.h index 88701dba..ad342018 100644 --- a/libwvdrmengine/oemcrypto/odk/include/odk_structs.h +++ b/libwvdrmengine/oemcrypto/odk/include/odk_structs.h @@ -19,7 +19,7 @@ extern "C" { #define ODK_MINOR_VERSION 0 /* ODK Version string. Date changed automatically on each release. */ -#define ODK_RELEASE_DATE "ODK v19.0 2023-08-22" +#define ODK_RELEASE_DATE "ODK v19.0 2023-08-28" /* The lowest version number for an ODK message. */ #define ODK_FIRST_VERSION 16 @@ -223,9 +223,10 @@ typedef struct { * entitlement keys. * @param nonce_required: indicates if the license requires a nonce. * @param timer_limits: time limits of the for the license. - * @param watermarking: specifies if device supports watermarking. - * @param dtcp2_required: specifies if device supports DTCP. - * @param renewal_delay_base: what time the timer starting is based off of. + * @param watermarking: indicates watermarking requirements of the license. + * @param dtcp2_required: indicates dtcp2 requirements of the license. + * @param renewal_delay_base: indicates which time is used for the renewal timer + * and playback timer starting point. * @param key_array_length: number of keys present. * @param key_array: set of keys to be installed. * @@ -262,9 +263,10 @@ typedef struct { * entitlement keys. * @param nonce_required: indicates if the license requires a nonce. * @param timer_limits: time limits of the for the license. - * @param watermarking: specifies if device supports watermarking. - * @param dtcp2_required: specifies if device supports DTCP. - * @param renewal_delay_base: what time the timer starting is based off of. + * @param watermarking: indicates watermarking requirements of the license. + * @param dtcp2_required: indicates dtcp2 requirements of the license. + * @param renewal_delay_base: indicates which time is used for the renewal timer + * and playback timer starting point. * @param key_array_length: number of keys present. * @param key_array: set of keys to be installed. This is a pointer to an array * to allow packing a number of keys greater than |ODK_MAX_NUM_KEYS|.