Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

hal/sleep_api.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
mbed-os5 only for TYBLE16

Who changed what in which revision?

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