Gan likun / mbed-dev11

hal/sleep_api.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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