sleepmgr.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. /**
  2. * \file
  3. *
  4. * \brief Chip-specific sleep manager configuration
  5. *
  6. * Copyright (c) 2014-2015 Atmel Corporation. All rights reserved.
  7. *
  8. * \asf_license_start
  9. *
  10. * \page License
  11. *
  12. * Redistribution and use in source and binary forms, with or without
  13. * modification, are permitted provided that the following conditions are met:
  14. *
  15. * 1. Redistributions of source code must retain the above copyright notice,
  16. * this list of conditions and the following disclaimer.
  17. *
  18. * 2. Redistributions in binary form must reproduce the above copyright notice,
  19. * this list of conditions and the following disclaimer in the documentation
  20. * and/or other materials provided with the distribution.
  21. *
  22. * 3. The name of Atmel may not be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * 4. This software may only be redistributed and used in connection with an
  26. * Atmel microcontroller product.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
  29. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
  31. * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
  32. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  37. * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38. * POSSIBILITY OF SUCH DAMAGE.
  39. *
  40. * \asf_license_stop
  41. *
  42. */
  43. /*
  44. * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
  45. */
  46. #ifndef SAM_SLEEPMGR_INCLUDED
  47. #define SAM_SLEEPMGR_INCLUDED
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51. #include <compiler.h>
  52. #include <conf_sleepmgr.h>
  53. #include <interrupt.h>
  54. #include "system.h"
  55. /**
  56. * \weakgroup sleepmgr_group
  57. * @{
  58. */
  59. enum sleepmgr_mode {
  60. /** Active mode. */
  61. SLEEPMGR_ACTIVE = 0,
  62. /**
  63. * Idle 0 mode.
  64. * Potential Wake Up sources: Synchronous(APB, AHB), asynchronous.
  65. */
  66. SLEEPMGR_IDLE_0,
  67. /**
  68. * Idle 1 mode.
  69. * Potential Wake Up sources: Synchronous (APB), asynchronous
  70. */
  71. SLEEPMGR_IDLE_1,
  72. /**
  73. * Idle 2 mode.
  74. * Potential Wake Up sources: Asynchronous
  75. */
  76. SLEEPMGR_IDLE_2,
  77. /**
  78. * Standby mode.
  79. * Potential Wake Up sources: Asynchronous
  80. */
  81. SLEEPMGR_STANDBY,
  82. SLEEPMGR_NR_OF_MODES,
  83. };
  84. /**
  85. * \internal
  86. * \name Internal arrays
  87. * @{
  88. */
  89. #if defined(CONFIG_SLEEPMGR_ENABLE) || defined(__DOXYGEN__)
  90. /** Sleep mode lock counters */
  91. extern uint8_t sleepmgr_locks[];
  92. #endif /* CONFIG_SLEEPMGR_ENABLE */
  93. /** @} */
  94. static inline void sleepmgr_sleep(const enum sleepmgr_mode sleep_mode)
  95. {
  96. Assert(sleep_mode != SLEEPMGR_ACTIVE);
  97. #ifdef CONFIG_SLEEPMGR_ENABLE
  98. cpu_irq_disable();
  99. /* Enter the sleep mode. */
  100. system_set_sleepmode((enum system_sleepmode)(sleep_mode - 1));
  101. cpu_irq_enable();
  102. system_sleep();
  103. #else
  104. UNUSED(sleep_mode);
  105. cpu_irq_enable();
  106. #endif /* CONFIG_SLEEPMGR_ENABLE */
  107. }
  108. /** @} */
  109. #ifdef __cplusplus
  110. }
  111. #endif
  112. #endif /* SAM_SLEEPMGR_INCLUDED */