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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup hal */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 156:ff21514d8981 4 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 5 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 172:65be27845400 6 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 9 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 10 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 11 *
AnnaBridge 156:ff21514d8981 12 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 13 *
AnnaBridge 156:ff21514d8981 14 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 15 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 17 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 18 * limitations under the License.
AnnaBridge 156:ff21514d8981 19 */
AnnaBridge 156:ff21514d8981 20 #ifndef MBED_SLEEP_API_H
AnnaBridge 156:ff21514d8981 21 #define MBED_SLEEP_API_H
AnnaBridge 156:ff21514d8981 22
AnnaBridge 156:ff21514d8981 23 #include "device.h"
AnnaBridge 156:ff21514d8981 24
AnnaBridge 156:ff21514d8981 25 #if DEVICE_SLEEP
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 28 extern "C" {
AnnaBridge 156:ff21514d8981 29 #endif
AnnaBridge 156:ff21514d8981 30
Anna Bridge 169:a7c7b631e539 31 /**
Anna Bridge 169:a7c7b631e539 32 * \defgroup hal_sleep sleep hal requirements
Anna Bridge 169:a7c7b631e539 33 * Low level interface to the sleep mode of a target.
Anna Bridge 169:a7c7b631e539 34 *
Anna Bridge 169:a7c7b631e539 35 * # Defined behaviour
Anna Bridge 169:a7c7b631e539 36 *
Anna Bridge 169:a7c7b631e539 37 * * Sleep mode
Anna Bridge 169:a7c7b631e539 38 * * wake-up time should be less than 10 us - Verified by sleep_usticker_test().
Anna Bridge 169:a7c7b631e539 39 * * the processor can be woken up by any internal peripheral interrupt - Verified by sleep_usticker_test().
Anna Bridge 169:a7c7b631e539 40 * * all peripherals operate as in run mode - not verified.
Anna Bridge 169:a7c7b631e539 41 * * the processor can be woken up by external pin interrupt - not verified.
Anna Bridge 169:a7c7b631e539 42 * * Deep sleep
Anna Bridge 169:a7c7b631e539 43 * * the wake-up time should be less than 10 ms - Verified by deepsleep_lpticker_test().
Anna Bridge 169:a7c7b631e539 44 * * lp ticker should wake up a target from this mode - Verified by deepsleep_lpticker_test().
Anna Bridge 169:a7c7b631e539 45 * * RTC should wake up a target from this mode - not verified.
Anna Bridge 169:a7c7b631e539 46 * * an external interrupt on a pin should wake up a target from this mode - not verified.
Anna Bridge 169:a7c7b631e539 47 * * a watchdog timer should wake up a target from this mode - not verified.
Anna Bridge 169:a7c7b631e539 48 * * High-speed clocks are turned off - Verified by deepsleep_high_speed_clocks_turned_off_test().
Anna Bridge 169:a7c7b631e539 49 * * RTC keeps time - Verified by rtc_sleep_test().
Anna Bridge 169:a7c7b631e539 50 *
Anna Bridge 169:a7c7b631e539 51 * # Undefined behaviour
Anna Bridge 169:a7c7b631e539 52 *
Anna Bridge 169:a7c7b631e539 53 * * peripherals aside from RTC, GPIO and lp ticker result in undefined behaviour in deep sleep.
Anna Bridge 169:a7c7b631e539 54 * @{
Anna Bridge 169:a7c7b631e539 55 */
Anna Bridge 169:a7c7b631e539 56
Anna Bridge 169:a7c7b631e539 57 /**
Anna Bridge 169:a7c7b631e539 58 * \defgroup hal_sleep_tests sleep hal tests
Anna Bridge 169:a7c7b631e539 59 * The sleep HAL tests ensure driver conformance to defined behaviour.
Anna Bridge 169:a7c7b631e539 60 *
Anna Bridge 169:a7c7b631e539 61 * To run the sleep hal tests use the command:
Anna Bridge 169:a7c7b631e539 62 *
Anna Bridge 169:a7c7b631e539 63 * mbed test -t <toolchain> -m <target> -n tests-mbed_hal-sleep*
Anna Bridge 169:a7c7b631e539 64 *
Anna Bridge 169:a7c7b631e539 65 */
Anna Bridge 169:a7c7b631e539 66
AnnaBridge 156:ff21514d8981 67 /** Send the microcontroller to sleep
AnnaBridge 156:ff21514d8981 68 *
Anna Bridge 169:a7c7b631e539 69 * The processor is setup ready for sleep, and sent to sleep. In this mode, the
AnnaBridge 156:ff21514d8981 70 * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
AnnaBridge 156:ff21514d8981 71 * dynamic power used by the processor, memory systems and buses. The processor, peripheral and
AnnaBridge 156:ff21514d8981 72 * memory state are maintained, and the peripherals continue to work and can generate interrupts.
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * The processor can be woken up by any internal peripheral interrupt or external pin interrupt.
AnnaBridge 156:ff21514d8981 75 *
Anna Bridge 169:a7c7b631e539 76 * The wake-up time shall be less than 10 us.
AnnaBridge 170:e95d10626187 77 *
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 156:ff21514d8981 79 void hal_sleep(void);
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /** Send the microcontroller to deep sleep
AnnaBridge 156:ff21514d8981 82 *
AnnaBridge 156:ff21514d8981 83 * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode
Anna Bridge 169:a7c7b631e539 84 * has the same sleep features as sleep plus it powers down peripherals and high frequency clocks.
Anna Bridge 169:a7c7b631e539 85 * All state is still maintained.
AnnaBridge 156:ff21514d8981 86 *
Anna Bridge 169:a7c7b631e539 87 * The processor can only be woken up by low power ticker, RTC, an external interrupt on a pin or a watchdog timer.
Anna Bridge 169:a7c7b631e539 88 *
Anna Bridge 169:a7c7b631e539 89 * The wake-up time shall be less than 10 ms.
AnnaBridge 156:ff21514d8981 90 */
AnnaBridge 156:ff21514d8981 91 void hal_deepsleep(void);
AnnaBridge 156:ff21514d8981 92
Anna Bridge 169:a7c7b631e539 93 /**@}*/
Anna Bridge 169:a7c7b631e539 94
AnnaBridge 156:ff21514d8981 95 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 96 }
AnnaBridge 156:ff21514d8981 97 #endif
AnnaBridge 156:ff21514d8981 98
AnnaBridge 156:ff21514d8981 99 #endif
AnnaBridge 156:ff21514d8981 100
AnnaBridge 156:ff21514d8981 101 #endif
AnnaBridge 156:ff21514d8981 102
Anna Bridge 169:a7c7b631e539 103 /**@}*/