MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClKey_Types

Defines all types of mcuxClKey. More...

Data Structures

struct  mcuxClKey_SrcAuxDataProvider
 Type of source information structure. More...
 
struct  mcuxClKey_DstDataProvider
 Type of destination information structure. More...
 
struct  mcuxClKey_Descriptor
 Type of the key handle. More...
 
struct  mcuxClKey_Protection
 Type to map load and flush functions. More...
 

Typedefs

typedef uint32_t mcuxClKey_Status_t
 Type for Key component error codes. More...
 
typedef uint64_t mcuxClKey_Status_Protected_t
 Type for Key component error codes, returned by functions with code-flow protection. More...
 
typedef struct mcuxClKey_SrcAuxDataProvider mcuxClKey_SrcAuxDataProvider_t
 Type of source information structure. More...
 
typedef enum mcuxClKey_LoadLocation mcuxClKey_LoadLocation_t
 Type of key location definition. More...
 
typedef struct mcuxClKey_DstDataProvider mcuxClKey_DstDataProvider_t
 Type of destination information structure. More...
 
typedef struct mcuxClKey_Descriptor mcuxClKey_Descriptor_t
 Type of the key handle. More...
 
typedef mcuxClKey_Descriptor_tmcuxClKey_Handle_t
 Type of opaque key handle. More...
 
typedef mcuxClKey_Status_Protected_t(* mcuxClKey_LoadFuncPtr_t) (mcuxClKey_Handle_t key)
 Functions to load a key into coprocessor or memory buffer. More...
 
typedef mcuxClKey_Status_Protected_t(* mcuxClKey_FlushFuncPtr_t) (mcuxClKey_Handle_t key)
 Functions to flush a key from coprocessor or memory buffer. More...
 
typedef struct mcuxClKey_Protection mcuxClKey_Protection_t
 Type to map load and flush functions. More...
 

Enumerations

enum  mcuxClKey_LoadLocation { mcuxClKey_LoadLocation_NOTLOADED, mcuxClKey_LoadLocation_MEMORY, mcuxClKey_LoadLocation_COPRO }
 Type of key location definition. More...
 

Detailed Description

Defines all types of mcuxClKey.

Typedef Documentation

◆ mcuxClKey_Status_t

typedef uint32_t mcuxClKey_Status_t

Type for Key component error codes.

◆ mcuxClKey_Status_Protected_t

typedef uint64_t mcuxClKey_Status_Protected_t

Type for Key component error codes, returned by functions with code-flow protection.

◆ mcuxClKey_SrcAuxDataProvider_t

Type of source information structure.

◆ mcuxClKey_LoadLocation_t

Type of key location definition.

◆ mcuxClKey_DstDataProvider_t

Type of destination information structure.

◆ mcuxClKey_Descriptor_t

Type of the key handle.

◆ mcuxClKey_Handle_t

Type of opaque key handle.

◆ mcuxClKey_LoadFuncPtr_t

typedef mcuxClKey_Status_Protected_t(* mcuxClKey_LoadFuncPtr_t) (mcuxClKey_Handle_t key)

Functions to load a key into coprocessor or memory buffer.

Parameters
[in]keyKey handle that provides information to load the key
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information

◆ mcuxClKey_FlushFuncPtr_t

typedef mcuxClKey_Status_Protected_t(* mcuxClKey_FlushFuncPtr_t) (mcuxClKey_Handle_t key)

Functions to flush a key from coprocessor or memory buffer.

Parameters
[in]keyKey handle that provides information to flush the key
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information

◆ mcuxClKey_Protection_t

Type to map load and flush functions.

Enumeration Type Documentation

◆ mcuxClKey_LoadLocation

Type of key location definition.

Enumerator
mcuxClKey_LoadLocation_NOTLOADED 

Key not loaded.

mcuxClKey_LoadLocation_MEMORY 

Use key from memory.

mcuxClKey_LoadLocation_COPRO 

Use key from HW IP.