Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

sleep_api.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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