Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/sleep_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
NYX 0:85b3fd62ea1a 1
NYX 0:85b3fd62ea1a 2 /** \addtogroup hal */
NYX 0:85b3fd62ea1a 3 /** @{*/
NYX 0:85b3fd62ea1a 4 /* mbed Microcontroller Library
NYX 0:85b3fd62ea1a 5 * Copyright (c) 2006-2013 ARM Limited
NYX 0:85b3fd62ea1a 6 *
NYX 0:85b3fd62ea1a 7 * Licensed under the Apache License, Version 2.0 (the "License");
NYX 0:85b3fd62ea1a 8 * you may not use this file except in compliance with the License.
NYX 0:85b3fd62ea1a 9 * You may obtain a copy of the License at
NYX 0:85b3fd62ea1a 10 *
NYX 0:85b3fd62ea1a 11 * http://www.apache.org/licenses/LICENSE-2.0
NYX 0:85b3fd62ea1a 12 *
NYX 0:85b3fd62ea1a 13 * Unless required by applicable law or agreed to in writing, software
NYX 0:85b3fd62ea1a 14 * distributed under the License is distributed on an "AS IS" BASIS,
NYX 0:85b3fd62ea1a 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
NYX 0:85b3fd62ea1a 16 * See the License for the specific language governing permissions and
NYX 0:85b3fd62ea1a 17 * limitations under the License.
NYX 0:85b3fd62ea1a 18 */
NYX 0:85b3fd62ea1a 19 #ifndef MBED_SLEEP_API_H
NYX 0:85b3fd62ea1a 20 #define MBED_SLEEP_API_H
NYX 0:85b3fd62ea1a 21
NYX 0:85b3fd62ea1a 22 #include "device.h"
NYX 0:85b3fd62ea1a 23
NYX 0:85b3fd62ea1a 24 #if DEVICE_SLEEP
NYX 0:85b3fd62ea1a 25
NYX 0:85b3fd62ea1a 26 #ifdef __cplusplus
NYX 0:85b3fd62ea1a 27 extern "C" {
NYX 0:85b3fd62ea1a 28 #endif
NYX 0:85b3fd62ea1a 29
NYX 0:85b3fd62ea1a 30 /** Send the microcontroller to sleep
NYX 0:85b3fd62ea1a 31 *
NYX 0:85b3fd62ea1a 32 * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the
NYX 0:85b3fd62ea1a 33 * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
NYX 0:85b3fd62ea1a 34 * dynamic power used by the processor, memory systems and buses. The processor, peripheral and
NYX 0:85b3fd62ea1a 35 * memory state are maintained, and the peripherals continue to work and can generate interrupts.
NYX 0:85b3fd62ea1a 36 *
NYX 0:85b3fd62ea1a 37 * The processor can be woken up by any internal peripheral interrupt or external pin interrupt.
NYX 0:85b3fd62ea1a 38 *
NYX 0:85b3fd62ea1a 39 * @note
NYX 0:85b3fd62ea1a 40 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
NYX 0:85b3fd62ea1a 41 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
NYX 0:85b3fd62ea1a 42 * able to access the LocalFileSystem
NYX 0:85b3fd62ea1a 43 */
NYX 0:85b3fd62ea1a 44 void hal_sleep(void);
NYX 0:85b3fd62ea1a 45
NYX 0:85b3fd62ea1a 46 /** Send the microcontroller to deep sleep
NYX 0:85b3fd62ea1a 47 *
NYX 0:85b3fd62ea1a 48 * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode
NYX 0:85b3fd62ea1a 49 * has the same sleep features as sleep plus it powers down peripherals and clocks. All state
NYX 0:85b3fd62ea1a 50 * is still maintained.
NYX 0:85b3fd62ea1a 51 *
NYX 0:85b3fd62ea1a 52 * The processor can only be woken up by an external interrupt on a pin or a watchdog timer.
NYX 0:85b3fd62ea1a 53 *
NYX 0:85b3fd62ea1a 54 * @note
NYX 0:85b3fd62ea1a 55 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
NYX 0:85b3fd62ea1a 56 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
NYX 0:85b3fd62ea1a 57 * able to access the LocalFileSystem
NYX 0:85b3fd62ea1a 58 */
NYX 0:85b3fd62ea1a 59 void hal_deepsleep(void);
NYX 0:85b3fd62ea1a 60
NYX 0:85b3fd62ea1a 61 #ifdef __cplusplus
NYX 0:85b3fd62ea1a 62 }
NYX 0:85b3fd62ea1a 63 #endif
NYX 0:85b3fd62ea1a 64
NYX 0:85b3fd62ea1a 65 #endif
NYX 0:85b3fd62ea1a 66
NYX 0:85b3fd62ea1a 67 #endif
NYX 0:85b3fd62ea1a 68
NYX 0:85b3fd62ea1a 69 /** @}*/