mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_MTS_DRAGONFLY_L471QG/TOOLCHAIN_IAR/mtqn_low_power.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /* mbed Microcontroller Library
AnnaBridge 171:3a7713b1edbc 2 *******************************************************************************
AnnaBridge 171:3a7713b1edbc 3 * Copyright (c) 2016, MultiTech Systems
AnnaBridge 171:3a7713b1edbc 4 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 5 *
AnnaBridge 171:3a7713b1edbc 6 * Redistribution and use in source and binary forms, with or without
AnnaBridge 171:3a7713b1edbc 7 * modification, are permitted provided that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 8 *
AnnaBridge 171:3a7713b1edbc 9 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 171:3a7713b1edbc 10 * this list of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 171:3a7713b1edbc 12 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 171:3a7713b1edbc 13 * and/or other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 14 * 3. Neither the name of MultiTech nor the names of its contributors
AnnaBridge 171:3a7713b1edbc 15 * may be used to endorse or promote products derived from this software
AnnaBridge 171:3a7713b1edbc 16 * without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 171:3a7713b1edbc 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 171:3a7713b1edbc 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 171:3a7713b1edbc 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 171:3a7713b1edbc 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 171:3a7713b1edbc 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 171:3a7713b1edbc 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 171:3a7713b1edbc 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 171:3a7713b1edbc 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 28 *******************************************************************************
AnnaBridge 171:3a7713b1edbc 29 */
AnnaBridge 171:3a7713b1edbc 30
AnnaBridge 171:3a7713b1edbc 31 #ifndef __MTQN_LOW_POWER_H__
AnnaBridge 171:3a7713b1edbc 32 #define __MTQN_LOW_POWER_H__
AnnaBridge 171:3a7713b1edbc 33
AnnaBridge 171:3a7713b1edbc 34 #include "cmsis.h"
AnnaBridge 171:3a7713b1edbc 35
AnnaBridge 171:3a7713b1edbc 36 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 37 extern "C" {
AnnaBridge 171:3a7713b1edbc 38 #endif
AnnaBridge 171:3a7713b1edbc 39
AnnaBridge 171:3a7713b1edbc 40 /* mtqn_disable_systick_int
AnnaBridge 171:3a7713b1edbc 41 * disable the systick interrupt
AnnaBridge 171:3a7713b1edbc 42 * call this before mtqn_enter_stop_mode so systick interrupt doesn't wake up the processor
AnnaBridge 171:3a7713b1edbc 43 * only necessary if RTOS is used
AnnaBridge 171:3a7713b1edbc 44 */
AnnaBridge 171:3a7713b1edbc 45 void mtqn_disable_systick_int();
AnnaBridge 171:3a7713b1edbc 46
AnnaBridge 171:3a7713b1edbc 47 /* mtqn_enable_systick_int
AnnaBridge 171:3a7713b1edbc 48 * enable the systick interrupt
AnnaBridge 171:3a7713b1edbc 49 * call this after mtqn_enter_stop_mode so RTOS can function again
AnnaBridge 171:3a7713b1edbc 50 * only necessary if RTOS is used
AnnaBridge 171:3a7713b1edbc 51 */
AnnaBridge 171:3a7713b1edbc 52 void mtqn_enable_systick_int();
AnnaBridge 171:3a7713b1edbc 53
AnnaBridge 171:3a7713b1edbc 54 /* mtqn_save_gpio_state
AnnaBridge 171:3a7713b1edbc 55 * save current state of all GPIOs
AnnaBridge 171:3a7713b1edbc 56 * call this before mtqn_enter_stop_mode
AnnaBridge 171:3a7713b1edbc 57 * to achieve the lowest possible power consumption possible all GPIO pins must be configured for
AnnaBridge 171:3a7713b1edbc 58 * analog mode with no pull resistors enabled before entering STOP mode
AnnaBridge 171:3a7713b1edbc 59 * the mtqn_enter_stop_mode function does this for USBTX/RX and all internal pins
AnnaBridge 171:3a7713b1edbc 60 * after calling mtqn_save_gpio_state, the user application must do the same for WAKE, GPIO*,
AnnaBridge 171:3a7713b1edbc 61 * UART1_*, I2C_*, and SPI_* pins
AnnaBridge 171:3a7713b1edbc 62 * the user application should make a call to mtqn_restore_gpio_state after waking from STOP mode
AnnaBridge 171:3a7713b1edbc 63 * in order to restore GPIO functionality
AnnaBridge 171:3a7713b1edbc 64 */
AnnaBridge 171:3a7713b1edbc 65 void mtqn_save_gpio_state();
AnnaBridge 171:3a7713b1edbc 66
AnnaBridge 171:3a7713b1edbc 67 /* mtqn_restore_gpio_state
AnnaBridge 171:3a7713b1edbc 68 * restore all GPIOs to the state they were in when mtqn_save_gpio_state was called
AnnaBridge 171:3a7713b1edbc 69 * call this after exiting from STOP mode
AnnaBridge 171:3a7713b1edbc 70 */
AnnaBridge 171:3a7713b1edbc 71 void mtqn_restore_gpio_state();
AnnaBridge 171:3a7713b1edbc 72
AnnaBridge 171:3a7713b1edbc 73 /* mtqn_enter_stop_mode
AnnaBridge 171:3a7713b1edbc 74 * put the processor into STOP mode
AnnaBridge 171:3a7713b1edbc 75 * RAM and peripheral state is retained
AnnaBridge 171:3a7713b1edbc 76 * can be woken up by a number of interrupt sources including GPIOs and internal interrupts
AnnaBridge 171:3a7713b1edbc 77 * program execution resumes after this function when the device wakes up
AnnaBridge 171:3a7713b1edbc 78 */
AnnaBridge 171:3a7713b1edbc 79 void mtqn_enter_stop_mode();
AnnaBridge 171:3a7713b1edbc 80
AnnaBridge 171:3a7713b1edbc 81 /* mtqn_enter_standby_mode
AnnaBridge 171:3a7713b1edbc 82 * put the processor into STANDBY mode
AnnaBridge 171:3a7713b1edbc 83 * RAM and peripheral state is lost
AnnaBridge 171:3a7713b1edbc 84 * can be woken up by the RTC alarm and rising edge on WAKE pin (WAKE pin must be configured first)
AnnaBridge 171:3a7713b1edbc 85 * program execution starts from the beginning of the application when the device wakes up
AnnaBridge 171:3a7713b1edbc 86 */
AnnaBridge 171:3a7713b1edbc 87 void mtqn_enter_standby_mode();
AnnaBridge 171:3a7713b1edbc 88
AnnaBridge 171:3a7713b1edbc 89 /* mtqn_enable_standby_wake_pin
AnnaBridge 171:3a7713b1edbc 90 * configure the WAKE pin as a wakeup source from standby mode
AnnaBridge 171:3a7713b1edbc 91 * after this call, a rising edge on the WAKE pin will wake the processor up from standby mode
AnnaBridge 171:3a7713b1edbc 92 * this function should be called immediately before mtqn_enter_standby_mode
AnnaBridge 171:3a7713b1edbc 93 */
AnnaBridge 171:3a7713b1edbc 94 void mtqn_enable_standby_wake_pin();
AnnaBridge 171:3a7713b1edbc 95
AnnaBridge 171:3a7713b1edbc 96 /* mtqn_disnable_standby_wake_pin
AnnaBridge 171:3a7713b1edbc 97 * should be called after waking up from standby mode
AnnaBridge 171:3a7713b1edbc 98 */
AnnaBridge 171:3a7713b1edbc 99 void mtqn_disable_standby_wake_pin();
AnnaBridge 171:3a7713b1edbc 100
AnnaBridge 171:3a7713b1edbc 101 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 102 }
AnnaBridge 171:3a7713b1edbc 103 #endif
AnnaBridge 171:3a7713b1edbc 104
AnnaBridge 171:3a7713b1edbc 105 #endif /* __DRAGONFLY_LOW_POWER_H__ */