Maxim nexpaq / nexpaq_dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

hal/hal/sleep_api.h@1:d96dbedaebdb, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:54:50 2016 +0000
Revision:
1:d96dbedaebdb
Parent:
0:6c56fb4bc5f0 
Removed extra directories for other platforms

Who changed what in which revision?

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