rng.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023 Texas Instruments Incorporated
 *
 *  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 RNG_H_
#define RNG_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <string.h>
#include <security/crypto/pka/hw_include/cslr_cp_ace.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define RNG_DRBG_MODE                                           (TRUE)
 
#define RNG_DRBG_DISABLE_MODE                                   (FALSE)
 
#define RNG_CONTROL_REQUEST_DATA_MASK                           (0x00010000U)
 
#define RNG_CONTROL_DATA_BLOCKS_MASK                            (0xFFF00000U)
 
#define RNG_CONTROL_DRBG_EN_SHIFT                               (0x0000000CU)
 
#define RNG_CONTROL_ENABLE_TRNG_SHIFT                           (0x0000000AU)
 
#define RNG_STATUS_RESEED_AI_MASK                               (0x00000400U)
 
#define RNG_DRBG_SEED_MAX_ARRY_SIZE_IN_DWORD                    (12U)
 
typedef void *RNG_Handle;
 
typedef enum RNG_Return_e
{
    RNG_RETURN_SUCCESS                  = 0xDE3BA502U, 
    RNG_RETURN_FAILURE                  = 0xF33BE03EU, 
}RNG_Return_t;
 
typedef struct
{
    /*
     * SOC configuration
     */
    uint32_t                caBaseAddr;
    uint32_t                rngBaseAddr;
    uint32_t                mode;
    uint32_t                isOpen;
    uint32_t                faultStatus;
    uint32_t                *seedValue;
    uint32_t                seedSizeInDwords;
} RNG_Attrs;
 
typedef struct
{
    RNG_Attrs             *attrs;
} RNG_Config;
 
#define DEVTYPE_HSSE         (0x0AU)
 
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
 
extern RNG_Config            gRngConfig[];
extern uint32_t              gRngConfigNum;
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
RNG_Handle RNG_open(uint32_t index);
 
RNG_Return_t RNG_close(RNG_Handle handle);
 
RNG_Return_t RNG_setup(RNG_Handle handle);
 
RNG_Return_t RNG_read(RNG_Handle handle, uint32_t *out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RNG_H_ */