Gan likun / mbed1-dev

001

hal/sleep_api.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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