mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

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

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

Who changed what in which revision?

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