Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

capi/sleep_api.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

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