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_MAX32630FTHR/TOOLCHAIN_GCC_ARM/lp.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 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 171:3a7713b1edbc 3 *
AnnaBridge 171:3a7713b1edbc 4 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 171:3a7713b1edbc 5 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 171:3a7713b1edbc 6 * to deal in the Software without restriction, including without limitation
AnnaBridge 171:3a7713b1edbc 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 171:3a7713b1edbc 8 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 171:3a7713b1edbc 9 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * The above copyright notice and this permission notice shall be included
AnnaBridge 171:3a7713b1edbc 12 * in all copies or substantial portions of the Software.
AnnaBridge 171:3a7713b1edbc 13 *
AnnaBridge 171:3a7713b1edbc 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 171:3a7713b1edbc 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 171:3a7713b1edbc 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 171:3a7713b1edbc 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 171:3a7713b1edbc 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 171:3a7713b1edbc 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 171:3a7713b1edbc 20 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 171:3a7713b1edbc 21 *
AnnaBridge 171:3a7713b1edbc 22 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 171:3a7713b1edbc 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 171:3a7713b1edbc 24 * Products, Inc. Branding Policy.
AnnaBridge 171:3a7713b1edbc 25 *
AnnaBridge 171:3a7713b1edbc 26 * The mere transfer of this software does not imply any licenses
AnnaBridge 171:3a7713b1edbc 27 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 171:3a7713b1edbc 28 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 171:3a7713b1edbc 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 171:3a7713b1edbc 30 * ownership rights.
AnnaBridge 171:3a7713b1edbc 31 *
AnnaBridge 171:3a7713b1edbc 32 * $Date: 2016-03-21 09:04:59 -0500 (Mon, 21 Mar 2016) $
AnnaBridge 171:3a7713b1edbc 33 * $Revision: 22006 $
AnnaBridge 171:3a7713b1edbc 34 *
AnnaBridge 171:3a7713b1edbc 35 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 /**
AnnaBridge 171:3a7713b1edbc 38 * @file lp.h
AnnaBridge 171:3a7713b1edbc 39 * @brief This is the high level API for the Lower Power
AnnaBridge 171:3a7713b1edbc 40 */
AnnaBridge 171:3a7713b1edbc 41
AnnaBridge 171:3a7713b1edbc 42 #ifndef _LP_H_
AnnaBridge 171:3a7713b1edbc 43 #define _LP_H_
AnnaBridge 171:3a7713b1edbc 44
AnnaBridge 171:3a7713b1edbc 45 #include "gpio.h"
AnnaBridge 171:3a7713b1edbc 46 #include "pwrman_regs.h"
AnnaBridge 171:3a7713b1edbc 47 #include "pwrseq_regs.h"
AnnaBridge 171:3a7713b1edbc 48
AnnaBridge 171:3a7713b1edbc 49 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 50 extern "C" {
AnnaBridge 171:3a7713b1edbc 51 #endif
AnnaBridge 171:3a7713b1edbc 52
AnnaBridge 171:3a7713b1edbc 53 /***** Definitions *****/
AnnaBridge 171:3a7713b1edbc 54 /**
AnnaBridge 171:3a7713b1edbc 55 * @brief Enumerations for pull-up and pull-downs
AnnaBridge 171:3a7713b1edbc 56 *
AnnaBridge 171:3a7713b1edbc 57 */
AnnaBridge 171:3a7713b1edbc 58 typedef enum {
AnnaBridge 171:3a7713b1edbc 59 LP_WEAK_PULL_DOWN = -1,
AnnaBridge 171:3a7713b1edbc 60 LP_NO_PULL = 0,
AnnaBridge 171:3a7713b1edbc 61 LP_WEAK_PULL_UP = 1
AnnaBridge 171:3a7713b1edbc 62 }
AnnaBridge 171:3a7713b1edbc 63 lp_pu_pd_select_t;
AnnaBridge 171:3a7713b1edbc 64
AnnaBridge 171:3a7713b1edbc 65 /***** Function Prototypes *****/
AnnaBridge 171:3a7713b1edbc 66
AnnaBridge 171:3a7713b1edbc 67 /**
AnnaBridge 171:3a7713b1edbc 68 * @brief Gets the first boot flag
AnnaBridge 171:3a7713b1edbc 69 *
AnnaBridge 171:3a7713b1edbc 70 * @returns 0 if FIRST_BOOT was not set, or 1 if FIRST_BOOT was set
AnnaBridge 171:3a7713b1edbc 71 */
AnnaBridge 171:3a7713b1edbc 72 __STATIC_INLINE unsigned int LP_IsFirstBoot()
AnnaBridge 171:3a7713b1edbc 73 {
AnnaBridge 171:3a7713b1edbc 74 return ((MXC_PWRSEQ->reg0 & MXC_F_PWRSEQ_REG0_PWR_FIRST_BOOT) >> MXC_F_PWRSEQ_REG0_PWR_FIRST_BOOT_POS);
AnnaBridge 171:3a7713b1edbc 75 }
AnnaBridge 171:3a7713b1edbc 76
AnnaBridge 171:3a7713b1edbc 77 /**
AnnaBridge 171:3a7713b1edbc 78 * @brief Clears the first boot flag
AnnaBridge 171:3a7713b1edbc 79 *
AnnaBridge 171:3a7713b1edbc 80 */
AnnaBridge 171:3a7713b1edbc 81 __STATIC_INLINE void LP_ClearFirstBoot()
AnnaBridge 171:3a7713b1edbc 82 {
AnnaBridge 171:3a7713b1edbc 83 MXC_PWRSEQ->reg0 &= ~MXC_F_PWRSEQ_REG0_PWR_FIRST_BOOT;
AnnaBridge 171:3a7713b1edbc 84 }
AnnaBridge 171:3a7713b1edbc 85
AnnaBridge 171:3a7713b1edbc 86 /**
AnnaBridge 171:3a7713b1edbc 87 * @brief Determines of program woke up from LP0
AnnaBridge 171:3a7713b1edbc 88 *
AnnaBridge 171:3a7713b1edbc 89 * @returns 0 if not woken up from LP0, or 1 if woken from LP0
AnnaBridge 171:3a7713b1edbc 90 */
AnnaBridge 171:3a7713b1edbc 91 __STATIC_INLINE unsigned int LP_IsLP0WakeUp()
AnnaBridge 171:3a7713b1edbc 92 {
AnnaBridge 171:3a7713b1edbc 93 //POR should be set and first boot clear
AnnaBridge 171:3a7713b1edbc 94 if((MXC_PWRMAN->pwr_rst_ctrl & MXC_F_PWRMAN_PWR_RST_CTRL_POR) &&
AnnaBridge 171:3a7713b1edbc 95 ((MXC_PWRSEQ->reg0 & MXC_F_PWRSEQ_REG0_PWR_FIRST_BOOT) == 0))
AnnaBridge 171:3a7713b1edbc 96 return 1;
AnnaBridge 171:3a7713b1edbc 97 else
AnnaBridge 171:3a7713b1edbc 98 return 0;
AnnaBridge 171:3a7713b1edbc 99
AnnaBridge 171:3a7713b1edbc 100 }
AnnaBridge 171:3a7713b1edbc 101
AnnaBridge 171:3a7713b1edbc 102 __STATIC_INLINE unsigned int LP_GetWakeUpFlags(void)
AnnaBridge 171:3a7713b1edbc 103 {
AnnaBridge 171:3a7713b1edbc 104 return MXC_PWRSEQ->flags;
AnnaBridge 171:3a7713b1edbc 105 }
AnnaBridge 171:3a7713b1edbc 106 /**
AnnaBridge 171:3a7713b1edbc 107 * @brief Clear ALL wake-up configuration on all pins. Disables wake-up entirely.
AnnaBridge 171:3a7713b1edbc 108 */
AnnaBridge 171:3a7713b1edbc 109 void LP_ClearWakeUpConfig(void);
AnnaBridge 171:3a7713b1edbc 110
AnnaBridge 171:3a7713b1edbc 111 /**
AnnaBridge 171:3a7713b1edbc 112 * @brief Read wake-up flags, clear flags, and return to caller.
AnnaBridge 171:3a7713b1edbc 113 * @returns Wake-up flags from Power Sequencer
AnnaBridge 171:3a7713b1edbc 114 */
AnnaBridge 171:3a7713b1edbc 115 unsigned int LP_ClearWakeUpFlags(void);
AnnaBridge 171:3a7713b1edbc 116
AnnaBridge 171:3a7713b1edbc 117 /**
AnnaBridge 171:3a7713b1edbc 118 * @brief This function configures one GPIO pin to wake the processor from LP0 or LP1.
AnnaBridge 171:3a7713b1edbc 119 * It is not used for LP2 wake-up, as normal GPIO interrupt processing is active in that mode.
AnnaBridge 171:3a7713b1edbc 120 * @param gpio GPIO pointer describing the port and pin for selected wake-up source
AnnaBridge 171:3a7713b1edbc 121 * @param act_high If non-zero, the signal is configured for active high wake-up. Otherwise, active low.
AnnaBridge 171:3a7713b1edbc 122 * @param wk_pu_pd Selection for the 1 Meg ohm pull-up or pull-down on this pin, see #lp_pu_pd_select_t
AnnaBridge 171:3a7713b1edbc 123 * @returns #E_NO_ERROR on success, error if unsuccessful.
AnnaBridge 171:3a7713b1edbc 124 */
AnnaBridge 171:3a7713b1edbc 125 int LP_ConfigGPIOWakeUpDetect(const gpio_cfg_t *gpio, unsigned int act_high, lp_pu_pd_select_t wk_pu_pd);
AnnaBridge 171:3a7713b1edbc 126
AnnaBridge 171:3a7713b1edbc 127 /**
AnnaBridge 171:3a7713b1edbc 128 * @brief Clear the wake-up configuration on one specific GPIO pin
AnnaBridge 171:3a7713b1edbc 129 * @param gpio GPIO pointer describing the port and pin for selected wake-up source
AnnaBridge 171:3a7713b1edbc 130 * @returns #E_NO_ERROR on success, error if unsuccessful.
AnnaBridge 171:3a7713b1edbc 131 */
AnnaBridge 171:3a7713b1edbc 132 int LP_ClearGPIOWakeUpDetect(const gpio_cfg_t *gpio);
AnnaBridge 171:3a7713b1edbc 133
AnnaBridge 171:3a7713b1edbc 134 /**
AnnaBridge 171:3a7713b1edbc 135 * @brief Check if a specific gpio triggered the wake up
AnnaBridge 171:3a7713b1edbc 136 * @param gpio GPIO pointer describing the port and pin(s)
AnnaBridge 171:3a7713b1edbc 137 * @returns 0 = gpio passed in did not trigger a wake up
AnnaBridge 171:3a7713b1edbc 138 * nonzero = at least one of the gpio passed in triggered a wake up
AnnaBridge 171:3a7713b1edbc 139 * the bit set represents which pin is the wake up source
AnnaBridge 171:3a7713b1edbc 140 */
AnnaBridge 171:3a7713b1edbc 141 uint8_t LP_IsGPIOWakeUpSource(const gpio_cfg_t *gpio);
AnnaBridge 171:3a7713b1edbc 142
AnnaBridge 171:3a7713b1edbc 143 /**
AnnaBridge 171:3a7713b1edbc 144 * @brief Wake on USB plug or unplug
AnnaBridge 171:3a7713b1edbc 145 * @param plug_en set to 1 to enable wake-up when USB VBUS is detected
AnnaBridge 171:3a7713b1edbc 146 * @param unplug_en set to 1 to enable wake-up when USB VBUS disappears
AnnaBridge 171:3a7713b1edbc 147 * @returns #E_NO_ERROR on success, error if unsuccessful.
AnnaBridge 171:3a7713b1edbc 148 */
AnnaBridge 171:3a7713b1edbc 149 int LP_ConfigUSBWakeUp(unsigned int plug_en, unsigned int unplug_en);
AnnaBridge 171:3a7713b1edbc 150
AnnaBridge 171:3a7713b1edbc 151 /**
AnnaBridge 171:3a7713b1edbc 152 * @brief Wake on any enabled event signal from RTC
AnnaBridge 171:3a7713b1edbc 153 * @param comp0_en set to 1 to enable wake-up when RTC Comparison 0 is set
AnnaBridge 171:3a7713b1edbc 154 * @param comp1_en set to 1 to enable wake-up when RTC Comparison 1 is set
AnnaBridge 171:3a7713b1edbc 155 * @param prescale_cmp_en set to 1 to enable wake-up when RTC Prescaler Compare is set
AnnaBridge 171:3a7713b1edbc 156 * @param rollover_en set to 1 to enable wake-up when RTC Roll-over is set
AnnaBridge 171:3a7713b1edbc 157 * @returns #E_NO_ERROR on success, error if unsuccessful.
AnnaBridge 171:3a7713b1edbc 158 */
AnnaBridge 171:3a7713b1edbc 159 int LP_ConfigRTCWakeUp(unsigned int comp0_en, unsigned int comp1_en, unsigned int prescale_cmp_en, unsigned int rollover_en);
AnnaBridge 171:3a7713b1edbc 160
AnnaBridge 171:3a7713b1edbc 161 /**
AnnaBridge 171:3a7713b1edbc 162 * @brief Enter LP2 power-saving mode
AnnaBridge 171:3a7713b1edbc 163 * @returns #E_NO_ERROR on success, error if unsuccessful.
AnnaBridge 171:3a7713b1edbc 164 */
AnnaBridge 171:3a7713b1edbc 165 int LP_EnterLP2(void);
AnnaBridge 171:3a7713b1edbc 166
AnnaBridge 171:3a7713b1edbc 167 /**
AnnaBridge 171:3a7713b1edbc 168 * @brief Enter LP1 mode, which saves CPU state and SRAM. Execution resumes after this call.
AnnaBridge 171:3a7713b1edbc 169 * @note Interrupts should be globally disabled before calling this function.
AnnaBridge 171:3a7713b1edbc 170 * @returns #E_NO_ERROR on success, error if unsuccessful.
AnnaBridge 171:3a7713b1edbc 171 */
AnnaBridge 171:3a7713b1edbc 172 int LP_EnterLP1(void);
AnnaBridge 171:3a7713b1edbc 173
AnnaBridge 171:3a7713b1edbc 174 /**
AnnaBridge 171:3a7713b1edbc 175 * @brief Enter the lowest-possible power mode, known as LP0. SRAM contents are lost.
AnnaBridge 171:3a7713b1edbc 176 * Waking up from LP0 is like a system reset. This function does not return.
AnnaBridge 171:3a7713b1edbc 177 * @note Interrupts are globally disabled upon entering this function.
AnnaBridge 171:3a7713b1edbc 178 */
AnnaBridge 171:3a7713b1edbc 179 void LP_EnterLP0(void);
AnnaBridge 171:3a7713b1edbc 180
AnnaBridge 171:3a7713b1edbc 181 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 182 }
AnnaBridge 171:3a7713b1edbc 183 #endif
AnnaBridge 171:3a7713b1edbc 184
AnnaBridge 171:3a7713b1edbc 185 #endif /* _LP_H_ */