Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

hal/sleep_api.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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