fsl_trng.h

/*
 * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
 * Copyright 2016-2018, 2020-2022 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef _FSL_TRNG_DRIVER_H_
#define _FSL_TRNG_DRIVER_H_
 
#include "fsl_common.h"
 
#if defined(FSL_FEATURE_SOC_TRNG_COUNT) && FSL_FEATURE_SOC_TRNG_COUNT
 
/*******************************************************************************
 * Definitions
 *******************************************************************************/
 
#define FSL_TRNG_DRIVER_VERSION (MAKE_VERSION(2, 0, 15))
typedef enum _trng_sample_mode
{
    kTRNG_SampleModeVonNeumann = 0U, 
    kTRNG_SampleModeRaw        = 1U, 
    kTRNG_SampleModeVonNeumannRaw =
        2U 
} trng_sample_mode_t;
 
typedef enum _trng_clock_mode
{
    kTRNG_ClockModeRingOscillator = 0U, 
    kTRNG_ClockModeSystem         = 1U  
} trng_clock_mode_t;
 
typedef enum _trng_ring_osc_div
{
    kTRNG_RingOscDiv0 = 0U, 
    kTRNG_RingOscDiv2 = 1U, 
    kTRNG_RingOscDiv4 = 2U, 
    kTRNG_RingOscDiv8 = 3U  
} trng_ring_osc_div_t;
 
typedef struct _trng_statistical_check_limit
{
    uint32_t maximum; 
    uint32_t minimum; 
} trng_statistical_check_limit_t;
 
typedef struct _trng_user_config
{
    bool lock;                      
    trng_clock_mode_t clockMode;    
    trng_ring_osc_div_t ringOscDiv; 
    trng_sample_mode_t sampleMode;  
    /* Seed Control*/
    uint16_t
        entropyDelay; 
    uint16_t sampleSize; 
    uint16_t sparseBitLimit; 
    /* Statistical Check Parameters.*/
    uint8_t retryCount;      
    uint8_t longRunMaxLimit; 
    trng_statistical_check_limit_t monobitLimit; 
    trng_statistical_check_limit_t runBit1Limit; 
    trng_statistical_check_limit_t runBit2Limit; 
    trng_statistical_check_limit_t runBit3Limit; 
    trng_statistical_check_limit_t runBit4Limit; 
    trng_statistical_check_limit_t runBit5Limit; 
    trng_statistical_check_limit_t runBit6PlusLimit; 
    trng_statistical_check_limit_t
        pokerLimit; 
    trng_statistical_check_limit_t frequencyCountLimit; 
} trng_config_t;
 
/*******************************************************************************
 * API
 *******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif
 
status_t TRNG_GetDefaultConfig(trng_config_t *userConfig);
 
status_t TRNG_Init(TRNG_Type *base, const trng_config_t *userConfig);
 
void TRNG_Deinit(TRNG_Type *base);
 
status_t TRNG_GetRandomData(TRNG_Type *base, void *data, size_t dataSize);
 
#if defined(__cplusplus)
}
#endif
 
#endif /* FSL_FEATURE_SOC_TRNG_COUNT */
#endif /*_FSL_TRNG_H_*/