fsl_iee.h

/*
 * Copyright (c) 2016, Freescale Semiconductor, Inc.
 * Copyright 2017-2021 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _FSL_IEE_H_
#define _FSL_IEE_H_
 
#include "fsl_common.h"

 
/*******************************************************************************
 * Definitions
 ******************************************************************************/

#define FSL_IEE_DRIVER_VERSION (MAKE_VERSION(2, 1, 1))

typedef enum _iee_region
{
    kIEE_Region0 = 0U, 
    kIEE_Region1 = 1U, 
    kIEE_Region2 = 2U, 
    kIEE_Region3 = 3U, 
    kIEE_Region4 = 4U, 
    kIEE_Region5 = 5U, 
    kIEE_Region6 = 6U, 
    kIEE_Region7 = 7U  
} iee_region_t;

typedef enum _iee_aes_bypass
{
    kIEE_AesUseMdField = 0U, 
    kIEE_AesBypass     = 1U  
} iee_aes_bypass_t;

typedef enum _iee_aes_mode
{
    kIEE_ModeNone            = 0U, 
    kIEE_ModeAesXTS          = 1U, 
    kIEE_ModeAesCTRWAddress  = 2U, 
    kIEE_ModeAesCTRWOAddress = 3U, 
    kIEE_ModeAesCTRkeystream = 4U  
} iee_aes_mode_t;

typedef enum _iee_aes_key_size
{
    kIEE_AesCTR128XTS256 = 0U, 
    kIEE_AesCTR256XTS512 = 1U  
} iee_aes_key_size_t;

typedef enum _iee_aes_key_num
{
    kIEE_AesKey1 = 1U, 
    kIEE_AesKey2 = 2U  
} iee_aes_key_num_t;

typedef struct _iee_config
{
    iee_aes_bypass_t bypass;    
    iee_aes_mode_t mode;        
    iee_aes_key_size_t keySize; 
    uint32_t pageOffset;        
} iee_config_t;
 
/*******************************************************************************
 * API
 ******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif

void IEE_Init(IEE_Type *base);

void IEE_GetDefaultConfig(iee_config_t *config);

void IEE_SetRegionConfig(IEE_Type *base, iee_region_t region, iee_config_t *config);

status_t IEE_SetRegionKey(
    IEE_Type *base, iee_region_t region, iee_aes_key_num_t keyNum, const uint8_t *key, size_t keySize);

static inline uint32_t IEE_GetOffset(uint32_t addressIee, uint32_t addressMemory)
{
    return (addressMemory - addressIee) >> 12;
}

void IEE_LockRegionConfig(IEE_Type *base, iee_region_t region);
 
#if defined(__cplusplus)
}
#endif

 
#endif /* _FSL_IEE_H_ */