George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/sleep_api.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

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