Umar Naeem / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by Umar Naeem

hal/sleep_api.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Child:
144:ef7eb2e8f9f7
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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