Jhon Plantikow / mbed

.

Dependents:   RTC

sleep_api.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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