MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClMemory_Clear.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------*/
2 /* Copyright 2020-2021, 2023 NXP */
3 /* */
4 /* NXP Confidential. This software is owned or controlled by NXP and may */
5 /* only be used strictly in accordance with the applicable license terms. */
6 /* By expressly accepting such terms or by downloading, installing, */
7 /* activating and/or otherwise using the software, you are agreeing that */
8 /* you have read, and that you agree to comply with and are bound by, such */
9 /* license terms. If you do not agree to be bound by the applicable license */
10 /* terms, then you may not retain, install, activate or otherwise use the */
11 /* software. */
12 /*--------------------------------------------------------------------------*/
13 
28 #ifndef MCUXCLMEMORY_CLEAR_H_
29 #define MCUXCLMEMORY_CLEAR_H_
30 
31 #include <mcuxClConfig.h> // Exported features flags header
32 
33 #include <mcuxClMemory_Types.h>
34 #include <mcuxCsslAnalysis.h>
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 /**********************************************
41  * FUNCTIONS
42  **********************************************/
43 
56 MCUX_CSSL_FP_PROTECTED_TYPE(void) mcuxClMemory_clear (uint8_t *pDst, size_t length, size_t bufLength);
57 
58 
59 /**********************************************
60  * MACROS
61  **********************************************/
62 
64 #define MCUXCLMEMORY_FP_MEMORY_CLEAR(pTarget, byteLen) \
65  MCUX_CSSL_FP_FUNCTION_CALL_VOID(mcuxClMemory_clear((uint8_t *) (pTarget), byteLen, byteLen))
66 
68 #define MCUXCLMEMORY_FP_MEMORY_CLEAR_WITH_BUFF(pTarget, byteLen, buffLen) \
69  MCUX_CSSL_FP_FUNCTION_CALL_VOID(mcuxClMemory_clear((uint8_t *) (pTarget), byteLen, buffLen))
70 
71 
72 #ifdef __cplusplus
73 } /* extern "C" */
74 #endif
75 
76 #endif /* MCUXCLMEMORY_CLEAR_H_ */
77 
Memory type header.
void mcuxClMemory_clear(uint8_t *pDst, size_t length, size_t bufLength)
Overwrites a memory buffer with null bytes.
#define MCUX_CSSL_FP_FUNCTION_DECL(...)
Declaration of a flow protected function.
Definition: mcuxCsslFlowProtection.h:125
#define MCUX_CSSL_FP_PROTECTED_TYPE(resultType)
Based on a given base type, builds a return type with flow protection.
Definition: mcuxCsslFlowProtection.h:81