takashi kadono / Mbed OS Nucleo446_SSD1331

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.

Dependencies:   ssd1331

mbed-os/hal/sleep_api.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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