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