SNIP_CLASSIC_CSM_SECTION_8_3_8_1_Key_Setting_Interface

8.3.8.1 Key Setting Interface [SWS_Csm_00957] Definition of API function Csm_KeyElementSet ⌈ Service Name Csm_KeyElementSet Syntax Std_ReturnType Csm_KeyElementSet ( uint32 keyId, uint32 keyElementId, const uint8* keyElementPtr, uint32 keyElementLength ) Service ID [hex] 0x78 Sync/Async Synchronous Reentrancy Non Reentrant keyId Holds the identifier of the key for which a new material shall be set. keyElementId Holds the identifier of the key element to be written. keyElementPtr Holds the pointer to the key element bytes to be processed. Parameters (in) keyElementLength Contains the number of key element bytes. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: Request successful E_NOT_OK: Request failed CRYPTO_E_BUSY: Request failed, Crypto Driver Object is busy CRYPTO_E_KEY_WRITE_FAIL:Request failed because write access was denied CRYPTO_E_KEY_NOT_AVAILABLE: Request failed because the key is not available CRYPTO_E_KEY_SIZE_MISMATCH: Request failed, key element size does not match size of provided data Description Sets the given key element bytes to the key identified by keyId. Available via Csm.h ⌋ Note: In case of error observed during Csm_KeyElementSet API call, the status of the key element needs to be considered as unknown. The application could explicitly check the key content status by calling Csm_KeyGetStatus. [SWS_Csm_01002] ⌈If no errors are detected by Csm, the service Csm_KeyElementSet shall call CryIf_KeyElementSet.⌋ [SWS_Csm_00958] Definition of API function Csm_KeySetValid ⌈ Service Name Csm_KeySetValid Syntax Std_ReturnType Csm_KeySetValid ( uint32 keyId ) Service ID [hex] 0x67 Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) keyId Holds the identifier of the key for which a new material shall be validated. ▽ △ Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: Request successful E_NOT_OK: Request failed CRYPTO_E_BUSY: Request failed, Crypro Driver Object is busy Description Sets the key state of the key identified by keyId to valid. Available via Csm.h ⌋ [SWS_Csm_01003] ⌈If no errors are detected by Csm, the service Csm_KeySetValid shall call CryIf_KeySetValid.⌋ [SWS_Csm_91075] Definition of API function Csm_KeySetInvalid ⌈ Service Name Csm_KeySetInvalid Syntax Std_ReturnType Csm_KeySetInvalid ( uint32 keyId ) Service ID [hex] 0x85 Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) keyId Holds the identifier of the key which shall be invalidated. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: Request successful E_NOT_OK: Request failed CRYPTO_E_BUSY: Request failed, Crypro Driver Object is busy Description Sets the key status to invalid. The key cannot be used any longer for cryptographic operations until it has been set to valid state again. Available via Csm.h ⌋ [SWS_Csm_91050] Upstream requirements: SRS_CryptoStack_00117 ⌈If no errors are detected by Csm, the service Csm_KeySetInvalid shall call CryIf_KeySetInvalid.⌋