Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

hal/sleep_api.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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