mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/sleep_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

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