Contiki-NG
trng-arch.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, Texas Instruments Incorporated - http://www.ti.com/
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holder nor the names of its
14  * contributors may be used to endorse or promote products derived
15  * from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 /**
31  * \addtogroup cc13xx-cc26xx-cpu
32  * @{
33  *
34  * \defgroup cc13xx-cc26xx-trng True Random Number Generator for CC13xx/CC26xx.
35  * @{
36  *
37  * \file
38  * Header file of True Random Number Generator for CC13xx/CC26xx.
39  * \author
40  * Edvard Pettersen <e.pettersen@ti.com>
41  */
42 /*---------------------------------------------------------------------------*/
43 #ifndef TRNG_ARCH_H_
44 #define TRNG_ARCH_H_
45 /*---------------------------------------------------------------------------*/
46 #include <contiki.h>
47 /*---------------------------------------------------------------------------*/
48 #include <stdbool.h>
49 #include <stdint.h>
50 /*---------------------------------------------------------------------------*/
51 #define TRNG_WAIT_FOREVER (~(uint32_t)0)
52 /*---------------------------------------------------------------------------*/
53 /**
54  * \brief Generates a stream of entropy from which you can create
55  * a true random number from. This is a blocking function
56  * call with a specified timeout.
57  * \param entropy_buf Buffer to store a stream of entropy.
58  * \param entropy_len Length of the entropy buffer.
59  * \param timeout_us How long to wait until timing out the operation. A
60  * timeout of TRNG_WAIT_FOREVER blocks forever.
61  * \return true if successful; else, false.
62  */
63 bool trng_rand(uint8_t *entropy_buf, size_t entropy_len, uint32_t timeout_us);
64 /*---------------------------------------------------------------------------*/
65 #endif /* TRNG_ARCH_H_ */
66 /*---------------------------------------------------------------------------*/
67 /**
68  * @}
69  * @}
70  */
bool trng_rand(uint8_t *entropy_buf, size_t entropy_len, uint32_t timeout_us)
Generates a stream of entropy from which you can create a true random number from.
Definition: trng-arch.c:53