Blame view

RIOT/core/include/lpm.h 1.5 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
68
69
70
71
72
73
74
75
76
77
  /*
   * Copyright (C) 2013 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    core_lpm Power Management
   * @ingroup     core
   * @brief       The kernels power management interface
   * @{
   *
   * @file
   * @brief       Power management interface
   *
   * This interface needs to be implemented for each platform.
   *
   * @author      Freie Universität Berlin, Computer Systems & Telematics
   */
  
  #ifndef LPM_H_
  #define LPM_H_
  
  #include "arch/lpm_arch.h"
  
  #ifdef __cplusplus
   extern "C" {
  #endif
  
  /**
   * @brief   Initialization of power management (including clock setup)
   *
   * This function is invoked once during boot.
   */
  void lpm_init(void);
  
  /**
   * @brief   Switches the MCU to a new power mode
   * @param[in]   target      Target power mode
   * @return                  The previous power mode
   */
  enum lpm_mode lpm_set(enum lpm_mode target);
  
  /**
   * @brief   Switches the MCU to active power mode LPM_ON
   */
  void lpm_awake(void);
  
  /**
   * @brief   Begin to switch MCU to active power mode.
   */
  void lpm_begin_awake(void);
  
  /**
   * @brief   Finish to switch MCU to active power mode.
   */
  void lpm_end_awake(void);
  
  /**
   * @brief   Returns the current power mode
   * @return  Current power mode
   */
  enum lpm_mode lpm_get(void);
  
  /**
   * @brief LPM-internal variable
   */
  extern volatile int lpm_prevent_sleep;
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* __LPM_H_ */
  /** @} */