Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/hal/sleep_api.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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