fsl_bee.h

/*
 * Copyright 2017, 2019 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _FSL_BEE_H_
#define _FSL_BEE_H_
 
#include "fsl_common.h"
 
/*******************************************************************************
 * Definitions
 *******************************************************************************/
 
#define FSL_BEE_DRIVER_VERSION (MAKE_VERSION(2, 0, 2))
typedef enum _bee_aes_mode
{
    kBEE_AesEcbMode = 0U, 
    kBEE_AesCtrMode = 1U  
} bee_aes_mode_t;
 
typedef enum _bee_region
{
    kBEE_Region0 = 0U, 
    kBEE_Region1 = 1U  
} bee_region_t;
 
typedef enum _bee_ac_prot_enable
{
    kBEE_AccessProtDisabled = 0U, 
    kBEE_AccessProtEnabled  = 1U  
} bee_ac_prot_enable;
 
typedef enum _bee_endian_swap_enable
{
    kBEE_EndianSwapDisabled = 1U, 
    kBEE_EndianSwapEnabled  = 0U  
} bee_endian_swap_enable;
 
typedef enum _bee_security_level
{
    kBEE_SecurityLevel0 = 0U, 
    kBEE_SecurityLevel1 = 1U, 
    kBEE_SecurityLevel2 = 2U, 
    kBEE_SecurityLevel3 = 3U  
} bee_security_level;
 
typedef enum _bee_status_flags
{
    kBEE_DisableAbortFlag     = 1U,                      
    kBEE_Reg0ReadSecViolation = 2U,                      
    kBEE_ReadIllegalAccess    = 4U,                      
    kBEE_Reg1ReadSecViolation = 8U,                      
    kBEE_Reg0AccessViolation  = 16U,                     
    kBEE_Reg1AccessViolation  = 32U,                     
    kBEE_IdleFlag             = BEE_STATUS_BEE_IDLE_MASK 
} bee_status_flags_t;
 
typedef struct _bee_region_config
{
    bee_aes_mode_t region0Mode;          
    bee_aes_mode_t region1Mode;          
    uint32_t region0AddrOffset;          
    uint32_t region1AddrOffset;          
    bee_security_level region0SecLevel;  
    bee_security_level region1SecLevel;  
    uint32_t region1Bot;                 
    uint32_t region1Top;                 
    bee_ac_prot_enable accessPermission; 
    bee_endian_swap_enable endianSwapEn; 
} bee_region_config_t;
 
/*******************************************************************************
 * API
 ******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
 
void BEE_Init(BEE_Type *base);
 
void BEE_Deinit(BEE_Type *base);
 
static inline void BEE_Enable(BEE_Type *base)
{
    base->CTRL |= BEE_CTRL_BEE_ENABLE_MASK;
}
 
static inline void BEE_Disable(BEE_Type *base)
{
    base->CTRL &= ~BEE_CTRL_BEE_ENABLE_MASK;
}
 
void BEE_GetDefaultConfig(bee_region_config_t *config);
 
void BEE_SetConfig(BEE_Type *base, const bee_region_config_t *config);
 
status_t BEE_SetRegionKey(BEE_Type *base, bee_region_t region, const uint8_t *key, size_t keySize);
 
status_t BEE_SetRegionNonce(BEE_Type *base, bee_region_t region, const uint8_t *nonce, size_t nonceSize);
 
uint32_t BEE_GetStatusFlags(BEE_Type *base);
 
void BEE_ClearStatusFlags(BEE_Type *base, uint32_t mask);
 
#if defined(__cplusplus)
}
#endif
 
#endif /* _FSL_BEE_H_ */