
test
mbed/sleep_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)
- Committer:
- ommpy
- Date:
- Mon Jul 06 17:18:59 2020 +0530
- Revision:
- 0:d383e2dee0f7
first commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
ommpy | 0:d383e2dee0f7 | 1 | /* mbed Microcontroller Library |
ommpy | 0:d383e2dee0f7 | 2 | * Copyright (c) 2006-2013 ARM Limited |
ommpy | 0:d383e2dee0f7 | 3 | * |
ommpy | 0:d383e2dee0f7 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
ommpy | 0:d383e2dee0f7 | 5 | * you may not use this file except in compliance with the License. |
ommpy | 0:d383e2dee0f7 | 6 | * You may obtain a copy of the License at |
ommpy | 0:d383e2dee0f7 | 7 | * |
ommpy | 0:d383e2dee0f7 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
ommpy | 0:d383e2dee0f7 | 9 | * |
ommpy | 0:d383e2dee0f7 | 10 | * Unless required by applicable law or agreed to in writing, software |
ommpy | 0:d383e2dee0f7 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
ommpy | 0:d383e2dee0f7 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
ommpy | 0:d383e2dee0f7 | 13 | * See the License for the specific language governing permissions and |
ommpy | 0:d383e2dee0f7 | 14 | * limitations under the License. |
ommpy | 0:d383e2dee0f7 | 15 | */ |
ommpy | 0:d383e2dee0f7 | 16 | #ifndef MBED_SLEEP_API_H |
ommpy | 0:d383e2dee0f7 | 17 | #define MBED_SLEEP_API_H |
ommpy | 0:d383e2dee0f7 | 18 | |
ommpy | 0:d383e2dee0f7 | 19 | #include "device.h" |
ommpy | 0:d383e2dee0f7 | 20 | |
ommpy | 0:d383e2dee0f7 | 21 | #if DEVICE_SLEEP |
ommpy | 0:d383e2dee0f7 | 22 | |
ommpy | 0:d383e2dee0f7 | 23 | #ifdef __cplusplus |
ommpy | 0:d383e2dee0f7 | 24 | extern "C" { |
ommpy | 0:d383e2dee0f7 | 25 | #endif |
ommpy | 0:d383e2dee0f7 | 26 | |
ommpy | 0:d383e2dee0f7 | 27 | /** Send the microcontroller to sleep |
ommpy | 0:d383e2dee0f7 | 28 | * |
ommpy | 0:d383e2dee0f7 | 29 | * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the |
ommpy | 0:d383e2dee0f7 | 30 | * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates |
ommpy | 0:d383e2dee0f7 | 31 | * dynamic power used by the processor, memory systems and buses. The processor, peripheral and |
ommpy | 0:d383e2dee0f7 | 32 | * memory state are maintained, and the peripherals continue to work and can generate interrupts. |
ommpy | 0:d383e2dee0f7 | 33 | * |
ommpy | 0:d383e2dee0f7 | 34 | * The processor can be woken up by any internal peripheral interrupt or external pin interrupt. |
ommpy | 0:d383e2dee0f7 | 35 | * |
ommpy | 0:d383e2dee0f7 | 36 | * @note |
ommpy | 0:d383e2dee0f7 | 37 | * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. |
ommpy | 0:d383e2dee0f7 | 38 | * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be |
ommpy | 0:d383e2dee0f7 | 39 | * able to access the LocalFileSystem |
ommpy | 0:d383e2dee0f7 | 40 | */ |
ommpy | 0:d383e2dee0f7 | 41 | void sleep(void); |
ommpy | 0:d383e2dee0f7 | 42 | |
ommpy | 0:d383e2dee0f7 | 43 | /** Send the microcontroller to deep sleep |
ommpy | 0:d383e2dee0f7 | 44 | * |
ommpy | 0:d383e2dee0f7 | 45 | * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode |
ommpy | 0:d383e2dee0f7 | 46 | * has the same sleep features as sleep plus it powers down peripherals and clocks. All state |
ommpy | 0:d383e2dee0f7 | 47 | * is still maintained. |
ommpy | 0:d383e2dee0f7 | 48 | * |
ommpy | 0:d383e2dee0f7 | 49 | * The processor can only be woken up by an external interrupt on a pin or a watchdog timer. |
ommpy | 0:d383e2dee0f7 | 50 | * |
ommpy | 0:d383e2dee0f7 | 51 | * @note |
ommpy | 0:d383e2dee0f7 | 52 | * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. |
ommpy | 0:d383e2dee0f7 | 53 | * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be |
ommpy | 0:d383e2dee0f7 | 54 | * able to access the LocalFileSystem |
ommpy | 0:d383e2dee0f7 | 55 | */ |
ommpy | 0:d383e2dee0f7 | 56 | void deepsleep(void); |
ommpy | 0:d383e2dee0f7 | 57 | |
ommpy | 0:d383e2dee0f7 | 58 | #ifdef __cplusplus |
ommpy | 0:d383e2dee0f7 | 59 | } |
ommpy | 0:d383e2dee0f7 | 60 | #endif |
ommpy | 0:d383e2dee0f7 | 61 | |
ommpy | 0:d383e2dee0f7 | 62 | #endif |
ommpy | 0:d383e2dee0f7 | 63 | |
ommpy | 0:d383e2dee0f7 | 64 | #endif |