mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_sleep.h@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
138:093f2bd7b9eb
Child:
145:64910690c574
Release 143 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 138:093f2bd7b9eb 1
<> 138:093f2bd7b9eb 2 /** \addtogroup platform */
<> 138:093f2bd7b9eb 3 /** @{*/
<> 138:093f2bd7b9eb 4 /* mbed Microcontroller Library
<> 138:093f2bd7b9eb 5 * Copyright (c) 2006-2017 ARM Limited
<> 138:093f2bd7b9eb 6 *
<> 138:093f2bd7b9eb 7 * Licensed under the Apache License, Version 2.0 (the "License");
<> 138:093f2bd7b9eb 8 * you may not use this file except in compliance with the License.
<> 138:093f2bd7b9eb 9 * You may obtain a copy of the License at
<> 138:093f2bd7b9eb 10 *
<> 138:093f2bd7b9eb 11 * http://www.apache.org/licenses/LICENSE-2.0
<> 138:093f2bd7b9eb 12 *
<> 138:093f2bd7b9eb 13 * Unless required by applicable law or agreed to in writing, software
<> 138:093f2bd7b9eb 14 * distributed under the License is distributed on an "AS IS" BASIS,
<> 138:093f2bd7b9eb 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 138:093f2bd7b9eb 16 * See the License for the specific language governing permissions and
<> 138:093f2bd7b9eb 17 * limitations under the License.
<> 138:093f2bd7b9eb 18 */
<> 138:093f2bd7b9eb 19 #ifndef MBED_SLEEP_H
<> 138:093f2bd7b9eb 20 #define MBED_SLEEP_H
<> 138:093f2bd7b9eb 21
<> 138:093f2bd7b9eb 22 #include "sleep_api.h"
<> 138:093f2bd7b9eb 23
<> 138:093f2bd7b9eb 24 #ifdef __cplusplus
<> 138:093f2bd7b9eb 25 extern "C" {
<> 138:093f2bd7b9eb 26 #endif
<> 138:093f2bd7b9eb 27
<> 138:093f2bd7b9eb 28 /** Send the microcontroller to sleep
<> 138:093f2bd7b9eb 29 *
<> 138:093f2bd7b9eb 30 * @note This function can be a noop if not implemented by the platform.
<> 138:093f2bd7b9eb 31 * @note This function will only put device to sleep in release mode (small profile or when NDEBUG is defined).
<> 138:093f2bd7b9eb 32 *
<> 138:093f2bd7b9eb 33 * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the
<> 138:093f2bd7b9eb 34 * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
<> 138:093f2bd7b9eb 35 * dynamic power used by the processor, memory systems and buses. The processor, peripheral and
<> 138:093f2bd7b9eb 36 * memory state are maintained, and the peripherals continue to work and can generate interrupts.
<> 138:093f2bd7b9eb 37 *
<> 138:093f2bd7b9eb 38 * The processor can be woken up by any internal peripheral interrupt or external pin interrupt.
<> 138:093f2bd7b9eb 39 *
<> 138:093f2bd7b9eb 40 * @note
<> 138:093f2bd7b9eb 41 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
<> 138:093f2bd7b9eb 42 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
<> 138:093f2bd7b9eb 43 * able to access the LocalFileSystem
<> 138:093f2bd7b9eb 44 */
<> 138:093f2bd7b9eb 45 __INLINE static void sleep(void)
<> 138:093f2bd7b9eb 46 {
<> 138:093f2bd7b9eb 47 #ifdef NDEBUG
<> 138:093f2bd7b9eb 48 #if DEVICE_SLEEP
<> 138:093f2bd7b9eb 49 hal_sleep();
<> 138:093f2bd7b9eb 50 #endif /* DEVICE_SLEEP */
<> 138:093f2bd7b9eb 51 #endif /* NDEBUG */
<> 138:093f2bd7b9eb 52 }
<> 138:093f2bd7b9eb 53
<> 138:093f2bd7b9eb 54 /** Send the microcontroller to deep sleep
<> 138:093f2bd7b9eb 55 *
<> 138:093f2bd7b9eb 56 * @note This function can be a noop if not implemented by the platform.
<> 138:093f2bd7b9eb 57 * @note This function will only put device to sleep in release mode (small profile or when NDEBUG is defined).
<> 138:093f2bd7b9eb 58 *
<> 138:093f2bd7b9eb 59 * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode
<> 138:093f2bd7b9eb 60 * has the same sleep features as sleep plus it powers down peripherals and clocks. All state
<> 138:093f2bd7b9eb 61 * is still maintained.
<> 138:093f2bd7b9eb 62 *
<> 138:093f2bd7b9eb 63 * The processor can only be woken up by an external interrupt on a pin or a watchdog timer.
<> 138:093f2bd7b9eb 64 *
<> 138:093f2bd7b9eb 65 * @note
<> 138:093f2bd7b9eb 66 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
<> 138:093f2bd7b9eb 67 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
<> 138:093f2bd7b9eb 68 * able to access the LocalFileSystem
<> 138:093f2bd7b9eb 69 */
<> 138:093f2bd7b9eb 70 __INLINE static void deepsleep(void)
<> 138:093f2bd7b9eb 71 {
<> 138:093f2bd7b9eb 72 #ifdef NDEBUG
<> 138:093f2bd7b9eb 73 #if DEVICE_SLEEP
<> 138:093f2bd7b9eb 74 hal_deepsleep();
<> 138:093f2bd7b9eb 75 #endif /* DEVICE_SLEEP */
<> 138:093f2bd7b9eb 76 #endif /* NDEBUG */
<> 138:093f2bd7b9eb 77 }
<> 138:093f2bd7b9eb 78
<> 138:093f2bd7b9eb 79 #ifdef __cplusplus
<> 138:093f2bd7b9eb 80 }
<> 138:093f2bd7b9eb 81 #endif
<> 138:093f2bd7b9eb 82
<> 138:093f2bd7b9eb 83 #endif
<> 138:093f2bd7b9eb 84
<> 138:093f2bd7b9eb 85 /** @}*/