1 /*
2  * Copyright (c) 2017, Nordic Semiconductor ASA
3  * All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  *    list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
18  *    contributors may be used to endorse or promote products derived from this
19  *    software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34 
35 /**
36  * @brief Module that defines the pseudo-random number generator Abstraction Layer.
37  *
38  */
39 
40 #ifndef NRF_802154_RANDOM_H_
41 #define NRF_802154_RANDOM_H_
42 
43 #include <stdbool.h>
44 #include <stdint.h>
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 /**
51  * @defgroup nrf_802154_random Random Abstraction Layer for the 802.15.4 driver
52  * @{
53  * @ingroup nrf_802154
54  * @brief The pseudo-random number generator Abstraction Layer interface for the 802.15.4 driver.
55  *
56  * The Random Abstraction Layer is an abstraction layer of a pseudo-random number generator that is
57  * used to perform CSMA-CA procedure correctly.
58  *
59  */
60 
61 /**
62  * @brief Initializes the random number generator.
63  */
64 void nrf_802154_random_init(void);
65 
66 /**
67  * @brief Deinitializes the random number generator.
68  */
69 void nrf_802154_random_deinit(void);
70 
71 /**
72  * @brief Gets a pseudo-random number.
73  *
74  * @returns Pseudo-random number.
75  */
76 uint32_t nrf_802154_random_get(void);
77 
78 /**
79  *@}
80  **/
81 
82 #ifdef __cplusplus
83 }
84 #endif
85 
86 #endif /* NRF_802154_RANDOM_H_ */
87