Daniel Vizcaya / Mbed OS 04_RTOS_Embebidos

Entrega 3er corte - sistemas embebidos

mbed-os/hal/sleep_api.h@1:fcdb45ee95b9, 2018-05-30 (annotated)

Committer:
Bethory
Date:
Wed May 30 04:46:28 2018 +0000
Revision:
1:fcdb45ee95b9
Parent:
0:6ad07c9019fd 
Entrega Final

Who changed what in which revision?

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