Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

hal/sleep_api.h@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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