Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

hal/sleep_api.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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