Umar Naeem / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by Umar Naeem

hal/sleep_api.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff
Child:
149:156823d33999
This updates the lib to the mbed lib v125

Who changed what in which revision?

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