TRNGCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2019, 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_TRNGCC26XX__include
#define ti_drivers_TRNG_TRNGCC26XX__include

#ifdef __cplusplus
extern "C" {
#endif

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

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

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>

#define TRNGCC26XX_SAMPLES_PER_CYCLE_MIN        256

#define TRNGCC26XX_SAMPLES_PER_CYCLE_DEFAULT    240000

#define TRNGCC26XX_SAMPLES_PER_CYCLE_MAX        16777216

#define TRNGCC26XX_MIN_BYTES_PER_ITERATION      8

typedef struct TRNGCC26XX_HWAttrs {
    uint8_t    intPriority;
    uint32_t   swiPriority;
    uint32_t   samplesPerCycle;
} TRNGCC26XX_HWAttrs;

typedef struct TRNGCC26XX_Object {
    bool                            isOpen;
    TRNG_ReturnBehavior             returnBehavior;
    int_fast16_t                    returnStatus;
    size_t                          entropyGenerated;
    size_t                          entropyRequested;
    uint32_t                        semaphoreTimeout;
    uint8_t                         *entropyBuffer;
    CryptoKey                       *entropyKey;
    uint32_t                        samplesPerCycle;
    TRNG_CallbackFxn                callbackFxn;
} TRNGCC26XX_Object;

extern int_fast16_t TRNGCC26XX_setSamplesPerCycle(TRNG_Handle handle, uint32_t samplesPerCycle);

/*
 * This function exists for internal use only. It is not a
 * top-level function for now.
 *
 * Use it like this:
 *
 * TRNGCC26XX_Object object = {0};
 * const TRNGCC26XX_HWAttrs hwAttrs = {
 *     .intPriority = 0xFF
 * };
 *
 * TRNG_Config config = {
 *     .object = &object,
 *     .hwAttrs = &hwAttrs
 * };
 *
 * TRNG_Handle handle = TRNG_construct(&config, ...);
 *
 */
extern TRNG_Handle TRNGCC26XX_construct(TRNG_Config *config, const TRNG_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_TRNG_TRNGCC26XX__include */