aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api/random.h
blob: 3451b0d1d5e4be6a4748ddef16c9cda2ac03dadc (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
/* Copyright (c) 2015, Linaro Limited
 * All rights reserved.
 *
 * SPDX-License-Identifier:     BSD-3-Clause
 */


/**
 * @file
 *
 * ODP random number API
 */

#ifndef ODP_API_RANDOM_H_
#define ODP_API_RANDOM_H_

#ifdef __cplusplus
extern "C" {
#endif

/** @defgroup odp_random ODP RANDOM
 *  @{
 */


/**
 * Generate random byte data
 *
 * @param[out]    buf   Output buffer
 * @param         size  Size of output buffer
 * @param use_entropy   Use entropy
 *
 * @todo Define the implication of the use_entropy parameter
 *
 * @return Number of bytes written
 * @retval <0 on failure
 */
int32_t
odp_random_data(uint8_t *buf, int32_t size, odp_bool_t use_entropy);

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif