Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

hal/sleep_api.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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