SNIP_CLASSIC_CRYIF_SECTION_8_3_3_Job_Cancellation_Interface

8.3.3 Job Cancellation Interface [SWS_CryIf_91014] Definition of API function CryIf_CancelJob ⌈ Service Name CryIf_CancelJob Syntax Std_ReturnType CryIf_CancelJob ( uint32 channelId, Crypto_JobType* job ) Service ID [hex] 0x0e Sync/Async Synchronous Reentrancy Reentrant Parameters (in) channelId Holds the identifier of the crypto channel. ▽ △ Parameters (inout) job Pointer to the configuration of the job. Contains structures with user and primitive relevant information. Parameters (out) None Return value Std_ReturnType E_OK: Request successful, job has been removed E_NOT_OK: Request failed, job couldn’t be removed CRYPTO_E_JOB_CANCELED Description This interface dispatches the job cancellation function to the configured crypto driver object. Available via CryIf.h ⌋ [SWS_CryIf_00129] CryIf_CancelJob API: Report CRYIF_E_UNINIT error Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369, SRS_BSW_00406 ⌈If development error detection for the CRYIF is enabled: The function CryIf_CancelJob shall report CRYIF_E_UNINIT to the DET if the module is not yet initialized.⌋ [SWS_CryIf_00130] CryIf_CancelJob API: Report CRYIF_E_PARAM_HANDLE error Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369 ⌈If development error detection for the CRYIF is enabled: The function CryIf_CancelJob shall report CRYIF_E_PARAM_HANDLE to the DET if the parameter channelId is out of range.⌋ [SWS_CryIf_00131] CryIf_CancelJob API: Report CRYIF_E_PARAM_POINTER error Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369 ⌈If development error detection for the CRYIF is enabled: The function CryIf_CancelJob shall report CRYIF_E_PARAM_POINTER to the DET if the parameter job is a null pointer.⌋ [SWS_CryIf_00132] CryIf_CancelJob API: Forward job cancel to the mapped driver Upstream requirements: SRS_CryptoStack_00006, SRS_CryptoStack_00015 ⌈If no errors are detected by CRYIF, the service CryIf_CancelJob shall call Crypto_<vi>_<ai>_CancelJob for the driver configuration mapped to the service and pass on the return value.⌋