aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/ports/STM32/LLD/RNGv1/hal_trng_lld.h
blob: 3f04adcde7f642757125f1a422dead97c28e9e79 (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
/*
    ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

/**
 * @file    hal_trng_lld.h
 * @brief   STM32 TRNG subsystem low level driver header.
 *
 * @addtogroup TRNG
 * @{
 */

#ifndef HAL_TRNG_LLD_H
#define HAL_TRNG_LLD_H

#if (HAL_USE_TRNG == TRUE) || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/**
 * @name    STM32 configuration options
 * @{
 */
/**
 * @brief   TRNGD1 driver enable switch.
 * @details If set to @p TRUE the support for TRNGD1 is included.
 * @note    The default is @p FALSE.
 */
#if !defined(STM32_TRNG_USE_RNG1) || defined(__DOXYGEN__)
#define STM32_TRNG_USE_RNG1                 FALSE
#endif

/**
 * @brief   TRNGD1 error clear timeout counter.
 * @details Number of status register fetches before failing.
 */
#if !defined(STM32_TRNG_ERROR_CLEAR_ATTEMPTS) || defined(__DOXYGEN__)
#define STM32_TRNG_ERROR_CLEAR_ATTEMPTS     1000
#endif

/**
 * @brief   TRNGD1 data available timeout counter.
 * @details Number of status register fetches before failing.
 */
#if !defined(STM32_DATA_FETCH_ATTEMPTS) || defined(__DOXYGEN__)
#define STM32_DATA_FETCH_ATTEMPTS           1000
#endif
/** @} */

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

#if !defined(STM32_HAS_RNG1)
#define STM32_HAS_RNG1                      FALSE
#endif

#if STM32_TRNG_USE_RNG1 && !STM32_HAS_RNG1
#error "RNG1 not present in the selected device"
#endif

#if !STM32_TRNG_USE_RNG1
#error "TRNG driver activated but no RNG peripheral assigned"
#endif

#if !defined(STM32_RNGCLK)
#error "STM32_RNGCLK not defined in this HAL"
#endif

#if STM32_RNGCLK != 48000000
#error "STM32_RNGCLK is not exactly 48000000"
#endif

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/

/**
 * @brief   Driver configuration structure.
 * @note    It could be empty on some architectures.
 */
typedef struct {
  /* End of the mandatory fields.*/
  /**
   * @brief   Dummy configuration, it is not needed.
   */
  uint32_t                   dummy;
} TRNGConfig;

/**
 * @brief   Structure representing a TRNG driver.
 */
struct TRNGDriver {
  /**
   * @brief Driver state.
   */
  trngstate_t                state;
  /**
   * @brief Current configuration data.
   */
  const TRNGConfig           *config;
#if defined(TRNG_DRIVER_EXT_FIELDS)
  TRNG_DRIVER_EXT_FIELDS
#endif
  /* End of the mandatory fields.*/
  /**
    * @brief Pointer to the RNG registers block.
    */
  RNG_TypeDef                *rng;
};

/*===========================================================================*/
/* Driver macros.                                                            */
/*===========================================================================*/

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#if (STM32_TRNG_USE_RNG1 == TRUE) && !defined(__DOXYGEN__)
extern TRNGDriver TRNGD1;
#endif

#ifdef __cplusplus
extern "C" {
#endif
  void trng_lld_init(void);
  void trng_lld_start(TRNGDriver *trngp);
  void trng_lld_stop(TRNGDriver *trngp);
  bool trng_lld_generate(TRNGDriver *trngp, size_t size, uint8_t *out);
#ifdef __cplusplus
}
#endif

#endif /* HAL_USE_TRNG == TRUE */

#endif /* HAL_TRNG_LLD_H */

/** @} */