Blame view

RIOT/drivers/include/periph/hwrng.h 2.14 KB
fb11e647   vrobic   reseau statique a...
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
  /*
   * Copyright (C) 2014-2016 Freie Universitรคt Berlin
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    drivers_periph_hwrng HWRNG Abstraction
   * @ingroup     drivers_periph
   * @brief       Peripheral hardware random number generator interface
   *
   * The HWRNG interface abstracts means provided by MCU peripherals to create
   * random number. On most platforms, these peripherals are called something like
   * 'hardware random number generator' or 'pseudo random number generator'. The
   * quality of the created random data does differ quite a bit between different
   * MCUs, so please refer to your MCUs reference manual for information on this!
   *
   * @note    Refer to your platforms MCU reference manual for information on the
   *          quality of the used (pseudo) random number generator!
   *
   * @{
   * @file
   * @brief       Hardware random number generator driver interface
   *
   * @author      Christian Mehlis <mehlis@inf.fu-berlin.de>
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   */
  
  #ifndef PERIPH_HWRNG_H
  #define PERIPH_HWRNG_H
  
  #include <stdint.h>
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Initialize the hardware random number generator
   *
   * On some platforms, the random number generator needs some global
   * initialization before it can be used. This should happen in this function
   * if it would impose too much overhead to do this everytime the hwrng_read
   * function is called. The device should however be put into power-off mode
   * after initialization and will be powered on and of when hwrng_read is called.
   */
  void hwrng_init(void);
  
  /**
   * @brief   Read N bytes of random data from the hardware device
   *
   * The read function should power on the HWRNG MCU peripheral, read the given
   * number of random bytes and than put the peripheral back to sleep.
   *
   * @param[in] buf   destination buffer to write the bytes to
   * @param[in] num   number of bytes to get from device
   */
  void hwrng_read(uint8_t *buf, unsigned int num);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* PERIPH_HWRNG_H */
  /** @} */