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@147:a97add6d7e64, 2017-07-19 (annotated)
- Committer:
- Kojto
- Date:
- Wed Jul 19 16:46:19 2017 +0100
- Revision:
- 147:a97add6d7e64
- Parent:
- 145:64910690c574
- Child:
- 152:235179ab3f27
Release 147 of the mbed library.
Who changed what in which revision?
User | Revision | Line number | New 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. |
AnnaBridge | 145:64910690c574 | 31 | * @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined). |
AnnaBridge | 145:64910690c574 | 32 | * @note This function will be a noop while uVisor is in use. |
<> | 138:093f2bd7b9eb | 33 | * |
<> | 138:093f2bd7b9eb | 34 | * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the |
<> | 138:093f2bd7b9eb | 35 | * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates |
<> | 138:093f2bd7b9eb | 36 | * dynamic power used by the processor, memory systems and buses. The processor, peripheral and |
<> | 138:093f2bd7b9eb | 37 | * memory state are maintained, and the peripherals continue to work and can generate interrupts. |
<> | 138:093f2bd7b9eb | 38 | * |
<> | 138:093f2bd7b9eb | 39 | * The processor can be woken up by any internal peripheral interrupt or external pin interrupt. |
<> | 138:093f2bd7b9eb | 40 | * |
<> | 138:093f2bd7b9eb | 41 | * @note |
<> | 138:093f2bd7b9eb | 42 | * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. |
<> | 138:093f2bd7b9eb | 43 | * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be |
<> | 138:093f2bd7b9eb | 44 | * able to access the LocalFileSystem |
<> | 138:093f2bd7b9eb | 45 | */ |
<> | 138:093f2bd7b9eb | 46 | __INLINE static void sleep(void) |
<> | 138:093f2bd7b9eb | 47 | { |
AnnaBridge | 145:64910690c574 | 48 | #if !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED)) |
AnnaBridge | 145:64910690c574 | 49 | #ifndef MBED_DEBUG |
<> | 138:093f2bd7b9eb | 50 | #if DEVICE_SLEEP |
<> | 138:093f2bd7b9eb | 51 | hal_sleep(); |
<> | 138:093f2bd7b9eb | 52 | #endif /* DEVICE_SLEEP */ |
AnnaBridge | 145:64910690c574 | 53 | #endif /* MBED_DEBUG */ |
AnnaBridge | 145:64910690c574 | 54 | #endif /* !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED)) */ |
<> | 138:093f2bd7b9eb | 55 | } |
<> | 138:093f2bd7b9eb | 56 | |
<> | 138:093f2bd7b9eb | 57 | /** Send the microcontroller to deep sleep |
<> | 138:093f2bd7b9eb | 58 | * |
<> | 138:093f2bd7b9eb | 59 | * @note This function can be a noop if not implemented by the platform. |
AnnaBridge | 145:64910690c574 | 60 | * @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined) |
AnnaBridge | 145:64910690c574 | 61 | * @note This function will be a noop while uVisor is in use. |
<> | 138:093f2bd7b9eb | 62 | * |
<> | 138:093f2bd7b9eb | 63 | * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode |
<> | 138:093f2bd7b9eb | 64 | * has the same sleep features as sleep plus it powers down peripherals and clocks. All state |
<> | 138:093f2bd7b9eb | 65 | * is still maintained. |
<> | 138:093f2bd7b9eb | 66 | * |
<> | 138:093f2bd7b9eb | 67 | * The processor can only be woken up by an external interrupt on a pin or a watchdog timer. |
<> | 138:093f2bd7b9eb | 68 | * |
<> | 138:093f2bd7b9eb | 69 | * @note |
<> | 138:093f2bd7b9eb | 70 | * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. |
<> | 138:093f2bd7b9eb | 71 | * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be |
<> | 138:093f2bd7b9eb | 72 | * able to access the LocalFileSystem |
<> | 138:093f2bd7b9eb | 73 | */ |
<> | 138:093f2bd7b9eb | 74 | __INLINE static void deepsleep(void) |
<> | 138:093f2bd7b9eb | 75 | { |
AnnaBridge | 145:64910690c574 | 76 | #if !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED)) |
AnnaBridge | 145:64910690c574 | 77 | #ifndef MBED_DEBUG |
<> | 138:093f2bd7b9eb | 78 | #if DEVICE_SLEEP |
<> | 138:093f2bd7b9eb | 79 | hal_deepsleep(); |
<> | 138:093f2bd7b9eb | 80 | #endif /* DEVICE_SLEEP */ |
AnnaBridge | 145:64910690c574 | 81 | #endif /* MBED_DEBUG */ |
AnnaBridge | 145:64910690c574 | 82 | #endif /* !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED)) */ |
<> | 138:093f2bd7b9eb | 83 | } |
<> | 138:093f2bd7b9eb | 84 | |
<> | 138:093f2bd7b9eb | 85 | #ifdef __cplusplus |
<> | 138:093f2bd7b9eb | 86 | } |
<> | 138:093f2bd7b9eb | 87 | #endif |
<> | 138:093f2bd7b9eb | 88 | |
<> | 138:093f2bd7b9eb | 89 | #endif |
<> | 138:093f2bd7b9eb | 90 | |
<> | 138:093f2bd7b9eb | 91 | /** @}*/ |