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