Renato Grottesi / mbed-dev-bin

Microbit as a BLE gamepad

Dependents:   microbit-dal

Fork of mbed-dev-bin by Lancaster University

sleep_api.h@4:bb4b3734941b, 2017-01-30 (annotated)

Committer:
rengro01
Date:
Mon Jan 30 08:23:23 2017 +0000
Revision:
4:bb4b3734941b
Parent:
0:e1a608bb55e8 
Microbit as a BLE gamepad

Who changed what in which revision?

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