SNIP_CLASSIC_CSM_SECTION_8_3_11_Job_Cancellation_Interface

8.3.11 Job Cancellation Interface [SWS_Csm_00968] Definition of API function Csm_CancelJob ⌈ Service Name Csm_CancelJob Syntax Std_ReturnType Csm_CancelJob ( uint32 job, Crypto_OperationModeType mode ) Service ID [hex] 0x6f Sync/Async Synchronous Reentrancy Non Reentrant job Holds the identifier of the job to be canceled Parameters (in) mode Not used, just for interface compatibility provided. ▽ △ Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: Request successful. Job removed from any queue and potentially from crypto driver hardware. E_NOT_OK: Request failed CRYPTO_E_JOB_CANCELED: Immediate cancelation not possible. The cancelation will be done at next suitable processing step and notified via a negative job’s closing callback. Description Cancels the job processing from asynchronous or streaming jobs. Available via Csm.h ⌋ [SWS_Csm_01086] Upstream requirements: SRS_CryptoStack_00087 ⌈If development error detection for the CSM is enabled: The function Csm_CancelJob shall raise the error CSM_E_PROCESSING_MODE and return E_NOT_OK if the Csm_ CancelJob is called for a synchronous job.⌋ [SWS_Csm_01021] ⌈The Csm shall remove the job from its own queue or call CryIf_CancelJob to cancel a potential job in the driver.⌋ [SWS_Csm_01030] ⌈In case the CryIf_CancelJob returns E_OK, the job’s closing callback CallbackNotification shall be called with a result value of CRYPTO_E_JOB_ CANCELED.⌋ [SWS_Csm_01087] Upstream requirements: SRS_CryptoStack_00082 ⌈In case the CryIf_CancelJob returns CRYPTO_E_JOB_CANCELED (i.e. the job was not instantly cancled) the CSM shall postpone the call of the job’s closing callback until the next call of Csm_CallbackNotification. The result of the job’s closing callback shall be CRYPTO_E_JOB_CANCELED.⌋ Note: In case the crypto driver does not support an instant cancelation of the job, the application need to wait for the job’s closing callback to free the buffers. The crypto driver could potentially still write to the output buffer(s).