Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

sleep_api.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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