mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/sleep_api.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
138:093f2bd7b9eb 
Release 147 of the mbed library.

Who changed what in which revision?

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