sleep_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_SLEEP_API_H
00023 #define MBED_SLEEP_API_H
00024 
00025 #include "device.h"
00026 
00027 #if DEVICE_SLEEP
00028 
00029 #ifdef __cplusplus
00030 extern "C" {
00031 #endif
00032 
00033 /** Send the microcontroller to sleep
00034  *
00035  * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the
00036  * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
00037  * dynamic power used by the processor, memory systems and buses. The processor, peripheral and
00038  * memory state are maintained, and the peripherals continue to work and can generate interrupts.
00039  *
00040  * The processor can be woken up by any internal peripheral interrupt or external pin interrupt.
00041  *
00042  * @note
00043  *  The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
00044  * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
00045  * able to access the LocalFileSystem
00046  */
00047 void sleep(void);
00048 
00049 /** Send the microcontroller to deep sleep
00050  *
00051  * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode
00052  * has the same sleep features as sleep plus it powers down peripherals and clocks. All state
00053  * is still maintained.
00054  *
00055  * The processor can only be woken up by an external interrupt on a pin or a watchdog timer.
00056  *
00057  * @note
00058  *  The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
00059  * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
00060  * able to access the LocalFileSystem
00061  */
00062 void deepsleep(void);
00063 
00064 #ifdef __cplusplus
00065 }
00066 #endif
00067 
00068 #endif
00069 
00070 #endif
00071