Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

hal/sleep_api.h@9:0ce32e54c9a7, 2013-06-10 (annotated)

Committer:
emilmont
Date:
Mon Jun 10 16:03:00 2013 +0100
Revision:
9:0ce32e54c9a7
Parent:
capi/sleep_api.h@2:143cac498751
Child:
10:3bc89ef62ce7
Refactoring of the mbed SDK:

- Provide a well defined HAL and API

- Keep separated the HAL implementations for the different targets

Who changed what in which revision?

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