Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/hal/sleep_api.h@11:b3f2a8bdac4d, 2017-12-16 (annotated)

Committer:
Zaitsev
Date:
Sat Dec 16 10:26:48 2017 +0000
Revision:
11:b3f2a8bdac4d
Parent:
10:41552d038a69 
A copy for D.S;

Who changed what in which revision?

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