mcuxClOsccaSafo_Functions.h

/*--------------------------------------------------------------------------*/
/* Copyright 2023-2024 NXP                                                  */
/*                                                                          */
/* NXP Proprietary. This software is owned or controlled by NXP and may     */
/* only be used strictly in accordance with the applicable license terms.   */
/* By expressly accepting such terms or by downloading, installing,         */
/* activating and/or otherwise using the software, you are agreeing that    */
/* you have read, and that you agree to comply with and are bound by, such  */
/* license terms.  If you do not agree to be bound by the applicable        */
/* license terms, then you may not retain, install, activate or otherwise   */
/* use the software.                                                        */
/*--------------------------------------------------------------------------*/
 
#ifndef MCUXCLOSCCASAFO_FUNCTIONS_H_
#define MCUXCLOSCCASAFO_FUNCTIONS_H_
 
#include <mcuxCsslFlowProtection.h>
#include <stdbool.h>
#include <mcuxClOsccaSafo_Types.h>
#include <mcuxClOsccaSafo_Sfr_Ctrl.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*****************************************************
 * Functions related to controlling SAFO
 *****************************************************/
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_wait)
void mcuxClOsccaSafo_Drv_wait(void);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_init)
void mcuxClOsccaSafo_Drv_init(uint32_t mode);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_close)
mcuxClOsccaSafo_Status_t mcuxClOsccaSafo_Drv_close(void);
 
#ifdef MCUXCL_FEATURE_HW_SAFO_SM3
#define MCUXCLOSCCASAFO_DRV_START_SM3   (MCUXCLOSCCASAFO_SFR_CTRL_SM3 | MCUXCLOSCCASAFO_SFR_CTRL_DATOUT_RES_END_UP)
#endif
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_start)
void mcuxClOsccaSafo_Drv_start(uint32_t operation);
 
#ifdef MCUXCL_FEATURE_HW_SAFO_SM3
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_stopSm3)
void mcuxClOsccaSafo_Drv_stopSm3(void);
#endif
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_setControl2)
void mcuxClOsccaSafo_Drv_setControl2(uint32_t control);
 
#ifdef MCUXCL_FEATURE_HW_SAFO_SM3
#define MCUXCLOSCCASAFO_DRV_STATE_SIZE_SM3  (32u)
 
#define MCUXCLOSCCASAFO_DRV_DIGEST_SIZE_SM3 (32u)
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3       (MCUXCLOSCCASAFO_SFR_CTRL_SM3_EN \
                                      | MCUXCLOSCCASAFO_SFR_CTRL_SM3_LOW_LIM) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_LOAD_IV (MCUXCLOSCCASAFO_SFR_CTRL_SM3_HASH_RELOAD \
                                          | MCUXCLOSCCASAFO_SFR_CTRL_SM3_NO_AUTO_INIT) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_USE_LOADED_IV (MCUXCLOSCCASAFO_SFR_CTRL_SM3_NO_AUTO_INIT) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_AUTO_MODE (MCUXCLOSCCASAFO_SFR_CTRL_SM3_MODE_AUTO \
                                            | MCUXCLOSCCASAFO_SFR_CTRL_SM3_HIGH_LIM) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_FIFO_HILIM (MCUXCLOSCCASAFO_SFR_CTRL_SM3_HIGH_LIM) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_AUTOMODE_LOADDATA_USESTANDARDIV (MCUXCLOSCCASAFO_DRV_CONFIG_SM3 \
                                                                      | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_AUTO_MODE) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_AUTOMODE_LOADIV (MCUXCLOSCCASAFO_DRV_CONFIG_SM3 \
                                                      | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_AUTO_MODE \
                                                      | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_LOAD_IV) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_AUTOMODE_LOADDATA_USELOADEDIV (MCUXCLOSCCASAFO_DRV_CONFIG_SM3 \
                                                                    | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_AUTO_MODE \
                                                                    | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_USE_LOADED_IV) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_NORMALMODE_LOADDATA_USESTANDARDIV (MCUXCLOSCCASAFO_DRV_CONFIG_SM3 \
                                                                        | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_FIFO_HILIM) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_NORMALMODE_LOADIV (MCUXCLOSCCASAFO_DRV_CONFIG_SM3 \
                                                        | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_FIFO_HILIM \
                                                        | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_LOAD_IV) 
 
#define MCUXCLOSCCASAFO_DRV_CONFIG_SM3_NORMALMODE_LOADDATA_USELOADEDIV (MCUXCLOSCCASAFO_DRV_CONFIG_SM3 \
                                                                      | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_FIFO_HILIM \
                                                                      | MCUXCLOSCCASAFO_DRV_CONFIG_SM3_USE_LOADED_IV) 
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_configureSm3)
void mcuxClOsccaSafo_Drv_configureSm3(uint32_t control);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_enableHashReload)
void mcuxClOsccaSafo_Drv_enableHashReload(void);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_disableHashReload)
void mcuxClOsccaSafo_Drv_disableHashReload(void);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_disableIvAutoInit)
void mcuxClOsccaSafo_Drv_disableIvAutoInit(void);
 
MCUX_CSSL_FP_FUNCTION_DEF(mcuxClOsccaSafo_Drv_enableIvAutoInit)
void mcuxClOsccaSafo_Drv_enableIvAutoInit(void);
#endif
 
/*****************************************************
 * Functions related to security features
 *****************************************************/
 
#define MCUXCLOSCCASAFO_DRV_FLUSH_ALL  (MCUXCLOSCCASAFO_SFR_CTRL2_FLUSH)
#define MCUXCLOSCCASAFO_DRV_FLUSH_KEY  (MCUXCLOSCCASAFO_SFR_CTRL2_FLUSHKEY)
#define MCUXCLOSCCASAFO_DRV_FLUSH_DATA (MCUXCLOSCCASAFO_SFR_CTRL2_FLUSHDATA)
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_enableFlush)
void mcuxClOsccaSafo_Drv_enableFlush(uint32_t option);
 
/*****************************************************
 * Functions related to input output handling
 *****************************************************/
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_loadKey)
void mcuxClOsccaSafo_Drv_loadKey(uint32_t offset, uint32_t key);
 
#ifdef MCUXCL_FEATURE_HW_SAFO_SM4
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_incrementData)
void mcuxClOsccaSafo_Drv_incrementData(uint32_t offset, uint32_t length);
#endif
 
#define MCUXCLOSCCASAFO_DRV_BYTE_ORDER_LE (MCUXCLOSCCASAFO_SFR_CTRL2_BYTES_ORDER)
#define MCUXCLOSCCASAFO_DRV_BYTE_ORDER_BE (0u)
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_setByteOrder)
uint32_t mcuxClOsccaSafo_Drv_setByteOrder(uint32_t mode);
 
#ifdef MCUXCL_FEATURE_HW_SAFO_SM4
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_enableXorWrite)
uint32_t mcuxClOsccaSafo_Drv_enableXorWrite(void);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_disableXorWrite)
void mcuxClOsccaSafo_Drv_disableXorWrite(void);
#endif
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_load)
void mcuxClOsccaSafo_Drv_load(uint32_t offset, uint32_t data);
 
#ifdef MCUXCL_FEATURE_HW_SAFO_SM3
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_loadFifo)
void mcuxClOsccaSafo_Drv_loadFifo(uint32_t data);
#endif
 
#ifdef MCUXCL_FEATURE_HW_SAFO_SM4
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_dataOut_res)
uint32_t mcuxClOsccaSafo_Drv_dataOut_res(uint32_t mode);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_enableOutputToKey)
uint32_t mcuxClOsccaSafo_Drv_enableOutputToKey(uint32_t keyIndex);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_disableOutputToKey)
void mcuxClOsccaSafo_Drv_disableOutputToKey(void);
#endif
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_triggerOutput)
void mcuxClOsccaSafo_Drv_triggerOutput(void);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_store)
uint32_t mcuxClOsccaSafo_Drv_store(uint32_t offset);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_storeInput)
uint32_t mcuxClOsccaSafo_Drv_storeInput(uint32_t offset);
 
 
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_storeKey)
uint32_t mcuxClOsccaSafo_Drv_storeKey(uint32_t offset);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSafo_Drv_isStatusError)
bool mcuxClOsccaSafo_Drv_isStatusError(void);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* MCUXCLOSCCASAFO_FUNCTIONS_H_ */