Greg Steiert / maxim-dev

Maxim mbed development library

Dependents:   MAX34417_demo MAXREFDES1265 MAXREFDES1265

Fork of mbed-dev by mbed official

hal/sleep_api.h@164:2e7515f8c45d, 2017-03-24 (annotated)

Committer:
switches
Date:
Fri Mar 24 15:15:13 2017 +0000
Revision:
164:2e7515f8c45d
Parent:
149:156823d33999 
Added low level init to clear IO registers

Who changed what in which revision?

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