PHung Tung / DISCO-F746_WAV_PLAYER

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

SRC_STM32F7/hal/sleep_api.h@0:8ede47d38d10, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:37:21 2019 +0000
Revision:
0:8ede47d38d10
SPKT

Who changed what in which revision?

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