BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/sleep_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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