erez i
version_2.0
Dependents: cc3000_ping_demo_try_2
Fork of
mbed
by 
mbed official
sleep_api.h@44:24d45a770a51, 2012-11-21 (annotated)
- Committer:
- emilmont
- Date:
- Wed Nov 21 10:49:56 2012 +0000
- Revision:
- 44:24d45a770a51
- Child:
- 54:71b101360fb9
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| emilmont | 44:24d45a770a51 | 1 | /* mbed Microcontroller Library |
| emilmont | 44:24d45a770a51 | 2 | * Copyright (c) 2006-2012 ARM Limited |
| emilmont | 44:24d45a770a51 | 3 | * |
| emilmont | 44:24d45a770a51 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| emilmont | 44:24d45a770a51 | 5 | * of this software and associated documentation files (the "Software"), to deal |
| emilmont | 44:24d45a770a51 | 6 | * in the Software without restriction, including without limitation the rights |
| emilmont | 44:24d45a770a51 | 7 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| emilmont | 44:24d45a770a51 | 8 | * copies of the Software, and to permit persons to whom the Software is |
| emilmont | 44:24d45a770a51 | 9 | * furnished to do so, subject to the following conditions: |
| emilmont | 44:24d45a770a51 | 10 | * |
| emilmont | 44:24d45a770a51 | 11 | * The above copyright notice and this permission notice shall be included in |
| emilmont | 44:24d45a770a51 | 12 | * all copies or substantial portions of the Software. |
| emilmont | 44:24d45a770a51 | 13 | * |
| emilmont | 44:24d45a770a51 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| emilmont | 44:24d45a770a51 | 15 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| emilmont | 44:24d45a770a51 | 16 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| emilmont | 44:24d45a770a51 | 17 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| emilmont | 44:24d45a770a51 | 18 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| emilmont | 44:24d45a770a51 | 19 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| emilmont | 44:24d45a770a51 | 20 | * SOFTWARE. |
| emilmont | 44:24d45a770a51 | 21 | */ |
| emilmont | 44:24d45a770a51 | 22 | #ifndef MBED_SLEEP_API_H |
| emilmont | 44:24d45a770a51 | 23 | #define MBED_SLEEP_API_H |
| emilmont | 44:24d45a770a51 | 24 | |
| emilmont | 44:24d45a770a51 | 25 | #include "device.h" |
| emilmont | 44:24d45a770a51 | 26 | |
| emilmont | 44:24d45a770a51 | 27 | #if DEVICE_SLEEP |
| emilmont | 44:24d45a770a51 | 28 | |
| emilmont | 44:24d45a770a51 | 29 | #ifdef __cplusplus |
| emilmont | 44:24d45a770a51 | 30 | extern "C" { |
| emilmont | 44:24d45a770a51 | 31 | #endif |
| emilmont | 44:24d45a770a51 | 32 | |
| emilmont | 44:24d45a770a51 | 33 | /** Send the microcontroller to sleep |
| emilmont | 44:24d45a770a51 | 34 | * |
| emilmont | 44:24d45a770a51 | 35 | * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the |
| emilmont | 44:24d45a770a51 | 36 | * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates |
| emilmont | 44:24d45a770a51 | 37 | * dynamic power used by the processor, memory systems and buses. The processor, peripheral and |
| emilmont | 44:24d45a770a51 | 38 | * memory state are maintained, and the peripherals continue to work and can generate interrupts. |
| emilmont | 44:24d45a770a51 | 39 | * |
| emilmont | 44:24d45a770a51 | 40 | * The processor can be woken up by any internal peripheral interrupt or external pin interrupt. |
| emilmont | 44:24d45a770a51 | 41 | * |
| emilmont | 44:24d45a770a51 | 42 | * @note |
| emilmont | 44:24d45a770a51 | 43 | * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. |
| emilmont | 44:24d45a770a51 | 44 | * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be |
| emilmont | 44:24d45a770a51 | 45 | * able to access the LocalFileSystem |
| emilmont | 44:24d45a770a51 | 46 | */ |
| emilmont | 44:24d45a770a51 | 47 | void sleep(void); |
| emilmont | 44:24d45a770a51 | 48 | |
| emilmont | 44:24d45a770a51 | 49 | /** Send the microcontroller to deep sleep |
| emilmont | 44:24d45a770a51 | 50 | * |
| emilmont | 44:24d45a770a51 | 51 | * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode |
| emilmont | 44:24d45a770a51 | 52 | * has the same sleep features as sleep plus it powers down peripherals and clocks. All state |
| emilmont | 44:24d45a770a51 | 53 | * is still maintained. |
| emilmont | 44:24d45a770a51 | 54 | * |
| emilmont | 44:24d45a770a51 | 55 | * The processor can only be woken up by an external interrupt on a pin or a watchdog timer. |
| emilmont | 44:24d45a770a51 | 56 | * |
| emilmont | 44:24d45a770a51 | 57 | * @note |
| emilmont | 44:24d45a770a51 | 58 | * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. |
| emilmont | 44:24d45a770a51 | 59 | * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be |
| emilmont | 44:24d45a770a51 | 60 | * able to access the LocalFileSystem |
| emilmont | 44:24d45a770a51 | 61 | */ |
| emilmont | 44:24d45a770a51 | 62 | void deepsleep(void); |
| emilmont | 44:24d45a770a51 | 63 | |
| emilmont | 44:24d45a770a51 | 64 | #ifdef __cplusplus |
| emilmont | 44:24d45a770a51 | 65 | } |
| emilmont | 44:24d45a770a51 | 66 | #endif |
| emilmont | 44:24d45a770a51 | 67 | |
| emilmont | 44:24d45a770a51 | 68 | #endif |
| emilmont | 44:24d45a770a51 | 69 | |
| emilmont | 44:24d45a770a51 | 70 | #endif |