Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

sleep_api.h@59:0883845fe643, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:12:58 2013 +0000
Revision:
59:0883845fe643
Parent:
55:d722ed6a4237
Child:
65:5798e58a58b1
Add pinmap NC terminators for LPC1768 CAN.

Update the license from MIT to Apache v2.

Make the semihost code target independent using opportune defines for the UID and MAC.

Who changed what in which revision?

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