7. CMOX_INIT

7.1. Initialization module

group CMOX_INIT

Defines

CMOX_INIT_TARGET_AUTO

Let the cryptographic library auto-detect running STM32 target Series

CMOX_INIT_TARGET_F0

Select a STM32F0 Series target

CMOX_INIT_TARGET_F1

Select a STM32F1 Series target

CMOX_INIT_TARGET_F2

Select a STM32F2 Series target

CMOX_INIT_TARGET_F3

Select a STM32F3 Series target

CMOX_INIT_TARGET_F4

Select a STM32F4 Series target

CMOX_INIT_TARGET_F7

Select a STM32F7 Series target

CMOX_INIT_TARGET_H5

Select a STM32H5 Series target

CMOX_INIT_TARGET_H7

Select a STM32H72x/STM32H73x/STM32H74x/STM32H75x Series target

CMOX_INIT_TARGET_H7AB

Select a STM32H7Ax/STM32H7Bx Series target

CMOX_INIT_TARGET_H7RS

Select a STM32H7Rx/STM32H7Sx Series target

CMOX_INIT_TARGET_G0

Select a STM32G0 Series target

CMOX_INIT_TARGET_G4

Select a STM32G4 Series target

CMOX_INIT_TARGET_L0

Select a STM32L0 Series target

CMOX_INIT_TARGET_L1

Select a STM32L1 Series target

CMOX_INIT_TARGET_L4

Select a STM32L4/4+ Series target

CMOX_INIT_TARGET_L5

Select a STM32L5 Series target

CMOX_INIT_TARGET_U0

Select a STM32U0 Series target

CMOX_INIT_TARGET_U3

Select a STM32U3 Series target

CMOX_INIT_TARGET_WB

Select a STM32WB Series target

CMOX_INIT_TARGET_WBA

Select a STM32WBA Series target

CMOX_INIT_TARGET_WL

Select a STM32WL Series target

CMOX_INIT_SUCCESS

Init operation successfully performed

CMOX_INIT_FAIL

Init operation failed

Typedefs

typedef uint32_t cmox_init_target_t

Initialization target type.

typedef uint32_t cmox_init_retval_t

Return value type for Initialization module.

Initialization return value type

Functions

cmox_init_retval_t cmox_initialize ( cmox_init_arg_t * pInitArg )

Initialize CMOX library.

Note

pInitArg can be set to NULL: is equivalent to pInitArg->target = CMOX_INIT_TARGET_AUTO pInitArg->pArg = NULL

Parameters :

pInitArg – Initialization parameter see cmox_init_arg_t

Return values :

Initialization – status: CMOX_INIT_SUCCESS / CMOX_INIT_FAIL

cmox_init_retval_t cmox_finalize ( void * pArg )

Finalize CMOX library.

Parameters :

pArg – User defined parameter that is transmitted to Low Level services

Return values :

Finalization – status: CMOX_INIT_SUCCESS / CMOX_INIT_FAIL

cmox_init_retval_t cmox_ll_init ( void * pArg )

CMOX library low level initialization.

Note

Implements low level initialization required by cryptographic library to operate properly

Parameters :

pArg – User defined parameter that is transmitted from Initialize service

Return values :

Initialization – status: CMOX_INIT_SUCCESS / CMOX_INIT_FAIL

cmox_init_retval_t cmox_ll_deInit ( void * pArg )

CMOX library low level de-initialization.

Parameters :

pArg – User defined parameter that is transmitted from Finalize service

Return values :

De-initialization – status: CMOX_INIT_SUCCESS / CMOX_INIT_FAIL

struct cmox_init_arg_t

#include <cmox_init.h>

Initialization structure.

Public Members

cmox_init_target_t target

User target specification

void * pArg

User defined parameter that is transmitted to Low Level services