aboutsummaryrefslogtreecommitdiff
path: root/KSDK_1.2.0/platform/drivers/inc/fsl_rnga_driver.h
blob: c00f5b7b47e1b66e2b5d3a0c9cfbae5a16fb8275 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
 * Copyright (c) 2014, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. 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 HOLDER 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 __FSL_RNGA_DRIVER_H__
#define __FSL_RNGA_DRIVER_H__

#include <assert.h>
#include <stdint.h>
#include <stdbool.h>
#include "fsl_rnga_hal.h"
#if FSL_FEATURE_SOC_RNG_COUNT
/*! 
 * @addtogroup rnga_driver
 * @{
 */

/*******************************************************************************
 * Definitions
 *******************************************************************************/

/*! @brief Table of base addresses for RNGA instances. */
extern RNG_Type * const g_rngaBase[];

/*! @brief Table to save RNGA IRQ enumeration numbers defined in the CMSIS header file. */
extern const IRQn_Type g_rngaIrqId[RNG_INSTANCE_COUNT];

/*! 
 * @brief Data structure for the RNGA initialization
 *
 * This structure initializes the RNGA by calling the the rnga_init function.
 * It contains all RNGA configurations.
 * @internal gui name="Basic configuration" id="rngaCfg"
 */
typedef struct _rnga_user_config
{
   bool isIntMasked; /*!< Mask the triggering of error interrupt @internal gui name="Interrupt mask" id="isIntMasked" */
   bool highAssuranceEnable; /*!< Enable notification of security violations @internal gui name="High assurance" id="highAssurance" */  
} rnga_user_config_t;


/*******************************************************************************
 * API
 *******************************************************************************/

#if defined(__cplusplus)
extern "C" {
#endif

/*!
 * @brief Initializes the RNGA.
 *
 * This function initializes the RNGA. When called, the RNGA
 * runs immediately according to the specifications in the configuration.
 *
 * @param instance, RNGA instance ID
 * @param config, pointer to initialize configuration structure
 * @return RNGA status
 */
rnga_status_t RNGA_DRV_Init(uint32_t instance, const rnga_user_config_t *config);


/*!
 * @brief Shuts down the RNGA.
 *
 * This function shuts down the RNGA.
 *
 * @param instance, RNGA instance ID
 */
void RNGA_DRV_Deinit(uint32_t instance);


/*!
 * @brief Sets the RNGA in normal mode or sleep mode.
 *
 * This function sets the RNGA in sleep mode or normal mode.
 *
 * @param instance, RNGA instance ID
 * @param mode, normal mode or sleep mode
 */
static inline void RNGA_DRV_SetMode(uint32_t instance, rnga_mode_t mode)
{
    RNGA_HAL_SetWorkModeCmd(g_rngaBase[instance], mode);
}


/*!
 * @brief Gets the RNGA working mode.
 *
 * This function gets the RNGA working mode.
 *
 * @param instance, RNGA instance ID
 * @return normal mode or sleep mode
 */
static inline rnga_mode_t RNGA_DRV_GetMode(uint32_t instance)
{
    return RNGA_HAL_GetWorkMode(g_rngaBase[instance]);
}


/*!
 * @brief Gets random data.
 *
 * This function gets random data from the RNGA.
 *
 * @param instance, RNGA instance ID
 * @param data, pointer address used to store random data
 * @return one random data
 */
static inline rnga_status_t RNGA_DRV_GetRandomData(uint32_t instance, uint32_t *data)
{
    return RNGA_HAL_GetRandomData(g_rngaBase[instance], data);
}


/*!
 * @brief Feeds the RNGA module.
 *
 * This function inputs an entropy value that the RNGA uses to seed its
 * pseudo-random algorithm.
 *
 * @param instance, RNGA instance ID
 * @param seed, input seed value
 */
static inline void RNGA_DRV_Seed(uint32_t instance, uint32_t seed)
{
    RNGA_HAL_WriteSeed(g_rngaBase[instance],seed);
}

/*!
 * @brief RNGA interrupt handler.
 *
 * This function handles the error interrupt caused by the RNGA underflow.
 *
 * @param instance, RNGA instance ID
 */
void RNGA_DRV_IRQHandler(uint32_t instance);

#if defined(__cplusplus)
}
#endif

/*! @}*/

#endif
#endif /* __FSL_RNGA_H__*/
/*******************************************************************************
 * EOF
 *******************************************************************************/