MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClKey_Types.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------*/
2 /* Copyright 2020-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 
19 #ifndef MCUXCLKEY_TYPES_H_
20 #define MCUXCLKEY_TYPES_H_
21 
22 #include <stdint.h>
23 #include <stdbool.h>
24 #include <mcuxClConfig.h> // Exported features flags header
25 #include <mcuxCsslFlowProtection.h>
27 #include <mcuxClCore_Buffer.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /**********************************************
34  * TYPEDEFS
35  **********************************************/
46 typedef uint32_t mcuxClKey_Status_t;
47 
51 typedef uint16_t mcuxClKey_AlgorithmId_t;
52 
56 typedef uint32_t mcuxClKey_Size_t;
57 
61 typedef MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClKey_Status_t) mcuxClKey_Status_Protected_t;
62 
63 /* Forward declaration */
64 struct mcuxClKey_Protection;
65 
72 struct mcuxClKey_Descriptor;
73 
80 typedef struct mcuxClKey_Descriptor mcuxClKey_Descriptor_t;
81 
88 
95 struct mcuxClKey_TypeDescriptor;
96 
103 typedef struct mcuxClKey_TypeDescriptor mcuxClKey_TypeDescriptor_t;
104 
111 
118 
125 struct mcuxClKey_ProtectionDescriptor;
126 
133 typedef struct mcuxClKey_ProtectionDescriptor mcuxClKey_ProtectionDescriptor_t;
134 
141 
142 
149 struct mcuxClKey_GenerationDescriptor;
150 
157 typedef struct mcuxClKey_GenerationDescriptor mcuxClKey_GenerationDescriptor_t;
158 
165 
166 
167 
168  /* mcuxClKey_Types */
172 
173 #ifdef __cplusplus
174 } /* extern "C" */
175 #endif
176 
177 #endif /* MCUXCLKEY_TYPES_H_ */
const mcuxClKey_ProtectionDescriptor_t * mcuxClKey_Protection_t
Key protection mechanism type.
Definition: mcuxClKey_Types.h:140
struct mcuxClKey_TypeDescriptor mcuxClKey_TypeDescriptor_t
Key type descriptor type.
Definition: mcuxClKey_Types.h:103
mcuxClKey_Descriptor_t *const mcuxClKey_Handle_t
Key handle type.
Definition: mcuxClKey_Types.h:87
uint16_t mcuxClKey_AlgorithmId_t
Type for algorithm based key id.
Definition: mcuxClKey_Types.h:51
struct mcuxClKey_Descriptor mcuxClKey_Descriptor_t
Key descriptor type.
Definition: mcuxClKey_Types.h:80
uint32_t mcuxClKey_Size_t
Type for algorithm based key size.
Definition: mcuxClKey_Types.h:56
typedef MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClKey_Status_t) mcuxClKey_Status_Protected_t
Deprecated type for Key component error codes, returned by functions with code-flow protection.
Definition: mcuxCsslFlowProtection_example.c:137
Definition of function identifiers for the flow protection mechanism.
uint32_t mcuxClKey_Status_t
Type for Key component error codes.
Definition: mcuxClKey_Types.h:46
struct mcuxClKey_GenerationDescriptor mcuxClKey_GenerationDescriptor_t
Key generation descriptor type.
Definition: mcuxClKey_Types.h:157
const mcuxClKey_TypeDescriptor_t * mcuxClKey_Type_t
Key type handle type.
Definition: mcuxClKey_Types.h:110
const mcuxClKey_GenerationDescriptor_t *const mcuxClKey_Generation_t
Key generation type.
Definition: mcuxClKey_Types.h:164
struct mcuxClKey_ProtectionDescriptor mcuxClKey_ProtectionDescriptor_t
Key protection mechanism descriptor type.
Definition: mcuxClKey_Types.h:133
Provides the API for the CSSL flow protection mechanism.
mcuxClKey_TypeDescriptor_t * mcuxClKey_CustomType_t
Custom key type handle type.
Definition: mcuxClKey_Types.h:117