mbed library sources. Supersedes mbed-src.
Fork of mbed-dev by
targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/system/power/TARGET_SAMR21/power.h@18:da299f395b9e, 2015-11-09 (annotated)
- Committer:
- mbed_official
- Date:
- Mon Nov 09 13:30:11 2015 +0000
- Revision:
- 18:da299f395b9e
- Parent:
- targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/system/power/power_sam_d_r/power.h@15:a81a8d6c1dfe
Synchronized with git revision f605825f66bb2e462ff7dbc5fb4ed2dbe979d1c3
Full URL: https://github.com/mbedmicro/mbed/commit/f605825f66bb2e462ff7dbc5fb4ed2dbe979d1c3/
Added support for SAML21
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
mbed_official | 15:a81a8d6c1dfe | 1 | /** |
mbed_official | 15:a81a8d6c1dfe | 2 | * \file |
mbed_official | 15:a81a8d6c1dfe | 3 | * |
mbed_official | 15:a81a8d6c1dfe | 4 | * \brief SAM Power related functionality |
mbed_official | 15:a81a8d6c1dfe | 5 | * |
mbed_official | 15:a81a8d6c1dfe | 6 | * Copyright (C) 2014-2015 Atmel Corporation. All rights reserved. |
mbed_official | 15:a81a8d6c1dfe | 7 | * |
mbed_official | 15:a81a8d6c1dfe | 8 | * \asf_license_start |
mbed_official | 15:a81a8d6c1dfe | 9 | * |
mbed_official | 15:a81a8d6c1dfe | 10 | * \page License |
mbed_official | 15:a81a8d6c1dfe | 11 | * |
mbed_official | 15:a81a8d6c1dfe | 12 | * Redistribution and use in source and binary forms, with or without |
mbed_official | 15:a81a8d6c1dfe | 13 | * modification, are permitted provided that the following conditions are met: |
mbed_official | 15:a81a8d6c1dfe | 14 | * |
mbed_official | 15:a81a8d6c1dfe | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
mbed_official | 15:a81a8d6c1dfe | 16 | * this list of conditions and the following disclaimer. |
mbed_official | 15:a81a8d6c1dfe | 17 | * |
mbed_official | 15:a81a8d6c1dfe | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
mbed_official | 15:a81a8d6c1dfe | 19 | * this list of conditions and the following disclaimer in the documentation |
mbed_official | 15:a81a8d6c1dfe | 20 | * and/or other materials provided with the distribution. |
mbed_official | 15:a81a8d6c1dfe | 21 | * |
mbed_official | 15:a81a8d6c1dfe | 22 | * 3. The name of Atmel may not be used to endorse or promote products derived |
mbed_official | 15:a81a8d6c1dfe | 23 | * from this software without specific prior written permission. |
mbed_official | 15:a81a8d6c1dfe | 24 | * |
mbed_official | 15:a81a8d6c1dfe | 25 | * 4. This software may only be redistributed and used in connection with an |
mbed_official | 15:a81a8d6c1dfe | 26 | * Atmel microcontroller product. |
mbed_official | 15:a81a8d6c1dfe | 27 | * |
mbed_official | 15:a81a8d6c1dfe | 28 | * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED |
mbed_official | 15:a81a8d6c1dfe | 29 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
mbed_official | 15:a81a8d6c1dfe | 30 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE |
mbed_official | 15:a81a8d6c1dfe | 31 | * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR |
mbed_official | 15:a81a8d6c1dfe | 32 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
mbed_official | 15:a81a8d6c1dfe | 33 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
mbed_official | 15:a81a8d6c1dfe | 34 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
mbed_official | 15:a81a8d6c1dfe | 35 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
mbed_official | 15:a81a8d6c1dfe | 36 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
mbed_official | 15:a81a8d6c1dfe | 37 | * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
mbed_official | 15:a81a8d6c1dfe | 38 | * POSSIBILITY OF SUCH DAMAGE. |
mbed_official | 15:a81a8d6c1dfe | 39 | * |
mbed_official | 15:a81a8d6c1dfe | 40 | * \asf_license_stop |
mbed_official | 15:a81a8d6c1dfe | 41 | * |
mbed_official | 15:a81a8d6c1dfe | 42 | */ |
mbed_official | 15:a81a8d6c1dfe | 43 | /* |
mbed_official | 15:a81a8d6c1dfe | 44 | * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> |
mbed_official | 15:a81a8d6c1dfe | 45 | */ |
mbed_official | 15:a81a8d6c1dfe | 46 | #ifndef POWER_H_INCLUDED |
mbed_official | 15:a81a8d6c1dfe | 47 | #define POWER_H_INCLUDED |
mbed_official | 15:a81a8d6c1dfe | 48 | |
mbed_official | 15:a81a8d6c1dfe | 49 | #include <compiler.h> |
mbed_official | 15:a81a8d6c1dfe | 50 | |
mbed_official | 15:a81a8d6c1dfe | 51 | #ifdef __cplusplus |
mbed_official | 15:a81a8d6c1dfe | 52 | extern "C" { |
mbed_official | 15:a81a8d6c1dfe | 53 | #endif |
mbed_official | 15:a81a8d6c1dfe | 54 | |
mbed_official | 15:a81a8d6c1dfe | 55 | /** |
mbed_official | 15:a81a8d6c1dfe | 56 | * \addtogroup asfdoc_sam0_system_group |
mbed_official | 15:a81a8d6c1dfe | 57 | * @{ |
mbed_official | 15:a81a8d6c1dfe | 58 | */ |
mbed_official | 15:a81a8d6c1dfe | 59 | |
mbed_official | 15:a81a8d6c1dfe | 60 | /** |
mbed_official | 15:a81a8d6c1dfe | 61 | * \brief Voltage references within the device. |
mbed_official | 15:a81a8d6c1dfe | 62 | * |
mbed_official | 15:a81a8d6c1dfe | 63 | * List of available voltage references (VREF) that may be used within the |
mbed_official | 15:a81a8d6c1dfe | 64 | * device. |
mbed_official | 15:a81a8d6c1dfe | 65 | */ |
mbed_official | 15:a81a8d6c1dfe | 66 | enum system_voltage_reference { |
mbed_official | 15:a81a8d6c1dfe | 67 | /** Temperature sensor voltage reference. */ |
mbed_official | 15:a81a8d6c1dfe | 68 | SYSTEM_VOLTAGE_REFERENCE_TEMPSENSE, |
mbed_official | 15:a81a8d6c1dfe | 69 | /** Bandgap voltage reference. */ |
mbed_official | 15:a81a8d6c1dfe | 70 | SYSTEM_VOLTAGE_REFERENCE_BANDGAP, |
mbed_official | 15:a81a8d6c1dfe | 71 | }; |
mbed_official | 15:a81a8d6c1dfe | 72 | |
mbed_official | 15:a81a8d6c1dfe | 73 | /** |
mbed_official | 15:a81a8d6c1dfe | 74 | * \brief Device sleep modes. |
mbed_official | 15:a81a8d6c1dfe | 75 | * |
mbed_official | 15:a81a8d6c1dfe | 76 | * List of available sleep modes in the device. A table of clocks available in |
mbed_official | 15:a81a8d6c1dfe | 77 | * different sleep modes can be found in \ref asfdoc_sam0_system_module_overview_sleep_mode. |
mbed_official | 15:a81a8d6c1dfe | 78 | */ |
mbed_official | 15:a81a8d6c1dfe | 79 | enum system_sleepmode { |
mbed_official | 15:a81a8d6c1dfe | 80 | /** IDLE 0 sleep mode. */ |
mbed_official | 15:a81a8d6c1dfe | 81 | SYSTEM_SLEEPMODE_IDLE_0, |
mbed_official | 15:a81a8d6c1dfe | 82 | /** IDLE 1 sleep mode. */ |
mbed_official | 15:a81a8d6c1dfe | 83 | SYSTEM_SLEEPMODE_IDLE_1, |
mbed_official | 15:a81a8d6c1dfe | 84 | /** IDLE 2 sleep mode. */ |
mbed_official | 15:a81a8d6c1dfe | 85 | SYSTEM_SLEEPMODE_IDLE_2, |
mbed_official | 15:a81a8d6c1dfe | 86 | /** Standby sleep mode. */ |
mbed_official | 15:a81a8d6c1dfe | 87 | SYSTEM_SLEEPMODE_STANDBY, |
mbed_official | 15:a81a8d6c1dfe | 88 | }; |
mbed_official | 15:a81a8d6c1dfe | 89 | |
mbed_official | 15:a81a8d6c1dfe | 90 | |
mbed_official | 15:a81a8d6c1dfe | 91 | |
mbed_official | 15:a81a8d6c1dfe | 92 | /** |
mbed_official | 15:a81a8d6c1dfe | 93 | * \name Voltage References |
mbed_official | 15:a81a8d6c1dfe | 94 | * @{ |
mbed_official | 15:a81a8d6c1dfe | 95 | */ |
mbed_official | 15:a81a8d6c1dfe | 96 | |
mbed_official | 15:a81a8d6c1dfe | 97 | /** |
mbed_official | 15:a81a8d6c1dfe | 98 | * \brief Enable the selected voltage reference |
mbed_official | 15:a81a8d6c1dfe | 99 | * |
mbed_official | 15:a81a8d6c1dfe | 100 | * Enables the selected voltage reference source, making the voltage reference |
mbed_official | 15:a81a8d6c1dfe | 101 | * available on a pin as well as an input source to the analog peripherals. |
mbed_official | 15:a81a8d6c1dfe | 102 | * |
mbed_official | 15:a81a8d6c1dfe | 103 | * \param[in] vref Voltage reference to enable |
mbed_official | 15:a81a8d6c1dfe | 104 | */ |
mbed_official | 15:a81a8d6c1dfe | 105 | static inline void system_voltage_reference_enable( |
mbed_official | 15:a81a8d6c1dfe | 106 | const enum system_voltage_reference vref) |
mbed_official | 15:a81a8d6c1dfe | 107 | { |
mbed_official | 15:a81a8d6c1dfe | 108 | switch (vref) { |
mbed_official | 15:a81a8d6c1dfe | 109 | case SYSTEM_VOLTAGE_REFERENCE_TEMPSENSE: |
mbed_official | 15:a81a8d6c1dfe | 110 | SYSCTRL->VREF.reg |= SYSCTRL_VREF_TSEN; |
mbed_official | 15:a81a8d6c1dfe | 111 | break; |
mbed_official | 15:a81a8d6c1dfe | 112 | |
mbed_official | 15:a81a8d6c1dfe | 113 | case SYSTEM_VOLTAGE_REFERENCE_BANDGAP: |
mbed_official | 15:a81a8d6c1dfe | 114 | SYSCTRL->VREF.reg |= SYSCTRL_VREF_BGOUTEN; |
mbed_official | 15:a81a8d6c1dfe | 115 | break; |
mbed_official | 15:a81a8d6c1dfe | 116 | |
mbed_official | 15:a81a8d6c1dfe | 117 | default: |
mbed_official | 15:a81a8d6c1dfe | 118 | Assert(false); |
mbed_official | 15:a81a8d6c1dfe | 119 | return; |
mbed_official | 15:a81a8d6c1dfe | 120 | } |
mbed_official | 15:a81a8d6c1dfe | 121 | } |
mbed_official | 15:a81a8d6c1dfe | 122 | |
mbed_official | 15:a81a8d6c1dfe | 123 | /** |
mbed_official | 15:a81a8d6c1dfe | 124 | * \brief Disable the selected voltage reference |
mbed_official | 15:a81a8d6c1dfe | 125 | * |
mbed_official | 15:a81a8d6c1dfe | 126 | * Disables the selected voltage reference source. |
mbed_official | 15:a81a8d6c1dfe | 127 | * |
mbed_official | 15:a81a8d6c1dfe | 128 | * \param[in] vref Voltage reference to disable |
mbed_official | 15:a81a8d6c1dfe | 129 | */ |
mbed_official | 15:a81a8d6c1dfe | 130 | static inline void system_voltage_reference_disable( |
mbed_official | 15:a81a8d6c1dfe | 131 | const enum system_voltage_reference vref) |
mbed_official | 15:a81a8d6c1dfe | 132 | { |
mbed_official | 15:a81a8d6c1dfe | 133 | switch (vref) { |
mbed_official | 15:a81a8d6c1dfe | 134 | case SYSTEM_VOLTAGE_REFERENCE_TEMPSENSE: |
mbed_official | 15:a81a8d6c1dfe | 135 | SYSCTRL->VREF.reg &= ~SYSCTRL_VREF_TSEN; |
mbed_official | 15:a81a8d6c1dfe | 136 | break; |
mbed_official | 15:a81a8d6c1dfe | 137 | |
mbed_official | 15:a81a8d6c1dfe | 138 | case SYSTEM_VOLTAGE_REFERENCE_BANDGAP: |
mbed_official | 15:a81a8d6c1dfe | 139 | SYSCTRL->VREF.reg &= ~SYSCTRL_VREF_BGOUTEN; |
mbed_official | 15:a81a8d6c1dfe | 140 | break; |
mbed_official | 15:a81a8d6c1dfe | 141 | |
mbed_official | 15:a81a8d6c1dfe | 142 | default: |
mbed_official | 15:a81a8d6c1dfe | 143 | Assert(false); |
mbed_official | 15:a81a8d6c1dfe | 144 | return; |
mbed_official | 15:a81a8d6c1dfe | 145 | } |
mbed_official | 15:a81a8d6c1dfe | 146 | } |
mbed_official | 15:a81a8d6c1dfe | 147 | |
mbed_official | 15:a81a8d6c1dfe | 148 | /** |
mbed_official | 15:a81a8d6c1dfe | 149 | * @} |
mbed_official | 15:a81a8d6c1dfe | 150 | */ |
mbed_official | 15:a81a8d6c1dfe | 151 | |
mbed_official | 15:a81a8d6c1dfe | 152 | |
mbed_official | 15:a81a8d6c1dfe | 153 | /** |
mbed_official | 15:a81a8d6c1dfe | 154 | * \name Device Sleep Control |
mbed_official | 15:a81a8d6c1dfe | 155 | * @{ |
mbed_official | 15:a81a8d6c1dfe | 156 | */ |
mbed_official | 15:a81a8d6c1dfe | 157 | |
mbed_official | 15:a81a8d6c1dfe | 158 | /** |
mbed_official | 15:a81a8d6c1dfe | 159 | * \brief Set the sleep mode of the device |
mbed_official | 15:a81a8d6c1dfe | 160 | * |
mbed_official | 15:a81a8d6c1dfe | 161 | * Sets the sleep mode of the device; the configured sleep mode will be entered |
mbed_official | 15:a81a8d6c1dfe | 162 | * upon the next call of the \ref system_sleep() function. |
mbed_official | 15:a81a8d6c1dfe | 163 | * |
mbed_official | 15:a81a8d6c1dfe | 164 | * For an overview of which systems are disabled in sleep for the different |
mbed_official | 15:a81a8d6c1dfe | 165 | * sleep modes, see \ref asfdoc_sam0_system_module_overview_sleep_mode. |
mbed_official | 15:a81a8d6c1dfe | 166 | * |
mbed_official | 15:a81a8d6c1dfe | 167 | * \param[in] sleep_mode Sleep mode to configure for the next sleep operation |
mbed_official | 15:a81a8d6c1dfe | 168 | * |
mbed_official | 15:a81a8d6c1dfe | 169 | * \retval STATUS_OK Operation completed successfully |
mbed_official | 15:a81a8d6c1dfe | 170 | * \retval STATUS_ERR_INVALID_ARG The requested sleep mode was invalid or not |
mbed_official | 15:a81a8d6c1dfe | 171 | * available |
mbed_official | 15:a81a8d6c1dfe | 172 | */ |
mbed_official | 15:a81a8d6c1dfe | 173 | static inline enum status_code system_set_sleepmode( |
mbed_official | 15:a81a8d6c1dfe | 174 | const enum system_sleepmode sleep_mode) |
mbed_official | 15:a81a8d6c1dfe | 175 | { |
mbed_official | 15:a81a8d6c1dfe | 176 | #if (SAMD20 || SAMD21) |
mbed_official | 15:a81a8d6c1dfe | 177 | /* Errata: Make sure that the Flash does not power all the way down |
mbed_official | 15:a81a8d6c1dfe | 178 | * when in sleep mode. */ |
mbed_official | 15:a81a8d6c1dfe | 179 | NVMCTRL->CTRLB.bit.SLEEPPRM = NVMCTRL_CTRLB_SLEEPPRM_DISABLED_Val; |
mbed_official | 15:a81a8d6c1dfe | 180 | #endif |
mbed_official | 15:a81a8d6c1dfe | 181 | |
mbed_official | 15:a81a8d6c1dfe | 182 | switch (sleep_mode) { |
mbed_official | 15:a81a8d6c1dfe | 183 | case SYSTEM_SLEEPMODE_IDLE_0: |
mbed_official | 15:a81a8d6c1dfe | 184 | case SYSTEM_SLEEPMODE_IDLE_1: |
mbed_official | 15:a81a8d6c1dfe | 185 | case SYSTEM_SLEEPMODE_IDLE_2: |
mbed_official | 15:a81a8d6c1dfe | 186 | SCB->SCR &= ~SCB_SCR_SLEEPDEEP_Msk; |
mbed_official | 15:a81a8d6c1dfe | 187 | PM->SLEEP.reg = sleep_mode; |
mbed_official | 15:a81a8d6c1dfe | 188 | break; |
mbed_official | 15:a81a8d6c1dfe | 189 | |
mbed_official | 15:a81a8d6c1dfe | 190 | case SYSTEM_SLEEPMODE_STANDBY: |
mbed_official | 15:a81a8d6c1dfe | 191 | SCB->SCR |= SCB_SCR_SLEEPDEEP_Msk; |
mbed_official | 15:a81a8d6c1dfe | 192 | break; |
mbed_official | 15:a81a8d6c1dfe | 193 | |
mbed_official | 15:a81a8d6c1dfe | 194 | default: |
mbed_official | 15:a81a8d6c1dfe | 195 | return STATUS_ERR_INVALID_ARG; |
mbed_official | 15:a81a8d6c1dfe | 196 | } |
mbed_official | 15:a81a8d6c1dfe | 197 | |
mbed_official | 15:a81a8d6c1dfe | 198 | return STATUS_OK; |
mbed_official | 15:a81a8d6c1dfe | 199 | } |
mbed_official | 15:a81a8d6c1dfe | 200 | |
mbed_official | 15:a81a8d6c1dfe | 201 | /** |
mbed_official | 15:a81a8d6c1dfe | 202 | * \brief Put the system to sleep waiting for interrupt |
mbed_official | 15:a81a8d6c1dfe | 203 | * |
mbed_official | 15:a81a8d6c1dfe | 204 | * Executes a device DSB (Data Synchronization Barrier) instruction to ensure |
mbed_official | 15:a81a8d6c1dfe | 205 | * all ongoing memory accesses have completed, then a WFI (Wait For Interrupt) |
mbed_official | 15:a81a8d6c1dfe | 206 | * instruction to place the device into the sleep mode specified by |
mbed_official | 15:a81a8d6c1dfe | 207 | * \ref system_set_sleepmode until woken by an interrupt. |
mbed_official | 15:a81a8d6c1dfe | 208 | */ |
mbed_official | 15:a81a8d6c1dfe | 209 | static inline void system_sleep(void) |
mbed_official | 15:a81a8d6c1dfe | 210 | { |
mbed_official | 15:a81a8d6c1dfe | 211 | __DSB(); |
mbed_official | 15:a81a8d6c1dfe | 212 | __WFI(); |
mbed_official | 15:a81a8d6c1dfe | 213 | } |
mbed_official | 15:a81a8d6c1dfe | 214 | |
mbed_official | 15:a81a8d6c1dfe | 215 | /** |
mbed_official | 15:a81a8d6c1dfe | 216 | * @} |
mbed_official | 15:a81a8d6c1dfe | 217 | */ |
mbed_official | 15:a81a8d6c1dfe | 218 | |
mbed_official | 15:a81a8d6c1dfe | 219 | /** @} */ |
mbed_official | 15:a81a8d6c1dfe | 220 | #ifdef __cplusplus |
mbed_official | 15:a81a8d6c1dfe | 221 | } |
mbed_official | 15:a81a8d6c1dfe | 222 | #endif |
mbed_official | 15:a81a8d6c1dfe | 223 | |
mbed_official | 15:a81a8d6c1dfe | 224 | #endif /* POWER_H_INCLUDED */ |