Blame view

RIOT/drivers/include/periph/pm.h 1.08 KB
a752c7ab   elopes   add first test an...
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
  /*
   * Copyright (C) 2016 Kaspar Schleiser <kaspar@schleiser.de>
   *
   * 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_pm Power Management
   * @ingroup     drivers_periph
   * @brief       The kernels power management interface
   *
   * @attention This interface *must* be implemented for every platform in RIOT.
   *
   * @{
   *
   * @file
   * @brief       Power management interface
   *
   * @author      Kaspar Schleiser <kaspar@schleiser.de>
   */
  
  #ifndef PERIPH_PM_H
  #define PERIPH_PM_H
  
  #include "assert.h"
  #include "periph_cpu.h"
  
  #ifdef MODULE_PM_LAYERED
  #include "pm_layered.h"
  #endif
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Reboot MCU
   */
  void pm_reboot(void);
  
  /**
   * @brief   Turn off MCU completely
   */
  void pm_off(void);
  
  /**
   * @brief   Switches the MCU to the lowest possible power mode
   *
   * This function will be called by the idle thread.
   */
  void pm_set_lowest(void);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* PERIPH_PM_H */
  /** @} */