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