MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClSession_Types.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------*/
2 /* Copyright 2020-2021 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 
17 #ifndef MCUXCLSESSION_TYPES_H_
18 #define MCUXCLSESSION_TYPES_H_
19 
20 #include <stdint.h>
21 #include <stdbool.h>
22 
23 /**********************************************
24  * CONSTANTS
25  **********************************************/
37 #define MCUXCLSESSION_STATUS_OK ((mcuxClSession_Status_t) 0xE8E8E8E8u )
38 #define MCUXCLSESSION_STATUS_ERROR ((mcuxClSession_Status_t) 0xE8E88E8Eu )
39 
45 #define MCUXCLSESSION_RTF_UPDATE_TRUE ((mcuxClSession_Rtf_t) 0xF0F00F0Fu )
46 #define MCUXCLSESSION_RTF_UPDATE_FALSE ((mcuxClSession_Rtf_t) 0x0F0F0F0Fu )
47  /* mcuxClSession_Constants */
52 
53 
54 /**********************************************
55  * TYPEDEFS
56  **********************************************/
67 typedef uint32_t mcuxClSession_Status_t;
68 
73 
77 typedef uint32_t mcuxClSession_Rtf_t;
78 
82 typedef struct mcuxClSession_WorkArea
83 {
84  uint32_t * buffer;
85  uint32_t size;
86  uint32_t used;
88 
93 {
94  uint32_t securityCounter;
96 
101 {
105  /* TBD: DMA handling */
111  /* mcuxClSession_Types */
115 
116 #endif /* MCUXCLSESSION_TYPES_H_ */
mcuxClSession_Rtf_t rtf
Configuration of the RTF.
Definition: mcuxClSession_Types.h:104
Type for mcuxClSession security context.
Definition: mcuxClSession_Types.h:92
uint32_t securityCounter
Security counter.
Definition: mcuxClSession_Types.h:94
mcuxClSession_Descriptor_t *const mcuxClSession_Handle_t
Type for mcuxClSession Handle.
Definition: mcuxClSession_Types.h:110
uint64_t mcuxClSession_Status_Protected_t
Type for mcuxClSession protected status codes.
Definition: mcuxClSession_Types.h:72
struct mcuxClSession_Descriptor mcuxClSession_Descriptor_t
Type for mcuxClSession Descriptor.
mcuxClSession_WorkArea_t cpuWa
Workarea for the CPU.
Definition: mcuxClSession_Types.h:102
uint32_t size
Size of the workarea buffer in words (uint32_t)
Definition: mcuxClSession_Types.h:85
uint32_t mcuxClSession_Rtf_t
Type for mcuxClSession RTF configuration flags.
Definition: mcuxClSession_Types.h:77
uint32_t * buffer
Pointer to the starting address of the workarea buffer.
Definition: mcuxClSession_Types.h:84
Type for mcuxClSession workareas flags.
Definition: mcuxClSession_Types.h:82
uint32_t mcuxClSession_Status_t
Type for mcuxClSession status codes.
Definition: mcuxClSession_Types.h:67
struct mcuxClSession_SecurityContext mcuxClSession_SecurityContext_t
Type for mcuxClSession security context.
Type for mcuxClSession Descriptor.
Definition: mcuxClSession_Types.h:100
uint32_t used
Used portion of the workarea buffer in words (uint32_t)
Definition: mcuxClSession_Types.h:86
mcuxClSession_WorkArea_t pkcWa
Workarea for the PKC.
Definition: mcuxClSession_Types.h:103
struct mcuxClSession_WorkArea mcuxClSession_WorkArea_t
Type for mcuxClSession workareas flags.