TRNGCC26XX.h

Go to the documentation of this file.

/******************************************************************************

 @file  TRNGCC26XX.h

 @brief This file contains header information for a True Random
        Number Generator driver.

 Group: WCS, LPC, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: BSD3 2016 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef ti_drivers_TRNGCC26XX__include
#define ti_drivers_TRNGCC26XX__include

#ifdef __cplusplus
extern "C"
{
#endif

#include <stdint.h>

/* Add ECCROMCC26XX_STATUS_* macros here */
#define TRNGCC26XX_STATUS_SUCCESS        0 
#define TRNGCC26XX_STATUS_ILLEGAL_PARAM -1 
#define TRNGCC26XX_MIN_SAMPLES_MIN            64        
#define TRNGCC26XX_MIN_SAMPLES_MAX            16384     
#define TRNGCC26XX_MAX_SAMPLES_MIN            256       
#define TRNGCC26XX_MAX_SAMPLES_MAX            16777216  
#define TRNGCC26XX_CLOCKS_PER_SAMPLES_MAX     15

#define TRNGCC26XX_ILLEGAL_PARAM_RETURN_VALUE 0

typedef struct TRNGCC26XX_Params
{
  uint32_t                        minSamplesPerCycle;   
  uint32_t                        maxSamplesPerCycle;   
  uint32_t                        clocksPerSample;      
} TRNGCC26XX_Params;

typedef struct TRNGCC26XX_HWAttrs {
    int        powerMngrId;
} TRNGCC26XX_HWAttrs;

typedef struct TRNGCC26XX_Object {
    uint8_t           state;
} TRNGCC26XX_Object;

typedef struct TRNGCC26XX_Config {
    void                   *object;

    void          const    *hwAttrs;
} TRNGCC26XX_Config;

typedef struct TRNGCC26XX_Config      *TRNGCC26XX_Handle;

void TRNGCC26XX_init(void);

TRNGCC26XX_Handle TRNGCC26XX_open(uint8_t index);

void TRNGCC26XX_close(TRNGCC26XX_Handle handle);

int8_t TRNGCC26XX_Params_init(TRNGCC26XX_Params *params);

uint32_t TRNGCC26XX_getNumber(TRNGCC26XX_Handle handle,
                              TRNGCC26XX_Params *params, int8_t *status);

int8_t TRNGCC26XX_isParamValid(TRNGCC26XX_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_TRNGCC26XX__include */