Micah B / mbed

mbed

Dependents:   DHTSensor_Test K64F_eCompass_OneNET_JW

sleep_api.h@0:2cc6bb4d7fea, 2015-02-25 (annotated)

Committer:
mbotkinl
Date:
Wed Feb 25 20:22:22 2015 +0000
Revision:
0:2cc6bb4d7fea
Working code to read Temperature and Humidity readings

Who changed what in which revision?

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