TRNG.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_TRNG__include
#define ti_drivers_TRNG__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/drivers/cryptoutils/cryptokey/CryptoKey.h>

#define TRNG_CMD_RESERVED           (32)

#define TRNG_STATUS_RESERVED        (-32)

#define TRNG_STATUS_SUCCESS         (0)

#define TRNG_STATUS_ERROR           (-1)

#define TRNG_STATUS_UNDEFINEDCMD    (-2)

#define TRNG_STATUS_RESOURCE_UNAVAILABLE (-3)

/* Add TRNG_CMD_<commands> here */

typedef struct TRNG_Config_    *TRNG_Handle;

typedef enum TRNG_ReturnBehavior_ {
    TRNG_RETURN_BEHAVIOR_CALLBACK = 1,    
    TRNG_RETURN_BEHAVIOR_BLOCKING = 2,    
    TRNG_RETURN_BEHAVIOR_POLLING  = 4,    
} TRNG_ReturnBehavior;

typedef struct TRNG_Config_ {
    void               *object;

    void         const *hwAttrs;
} TRNG_Config;

typedef void (*TRNG_CallbackFxn) (TRNG_Handle handle,
                                  int_fast16_t returnValue,
                                  CryptoKey *entropy);

typedef struct TRNG_Params_ {
    TRNG_ReturnBehavior     returnBehavior;             
    TRNG_CallbackFxn        callbackFxn;                
    uint32_t                timeout;                    
    void                   *custom;                     
} TRNG_Params;

extern const TRNG_Params TRNG_defaultParams;

void TRNG_init(void);

void TRNG_Params_init(TRNG_Params *params);

TRNG_Handle TRNG_open(uint_least8_t index, TRNG_Params *params);

void TRNG_close(TRNG_Handle handle);

int_fast16_t TRNG_control(TRNG_Handle handle, uint32_t cmd, void *args);

int_fast16_t TRNG_generateEntropyLessThan(TRNG_Handle handle, CryptoKey *entropy, const uint8_t *upperBound);

int_fast16_t TRNG_generateEntropyNonZeroLessThan(TRNG_Handle handle, CryptoKey *entropy, const uint8_t *upperBound);

int_fast16_t TRNG_generateEntropy(TRNG_Handle handle, CryptoKey *entropy);




#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_TRNG__include */