mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/system/power/power_sam_d_r/power.h@579:53297373a894, 2015-07-01 (annotated)

Committer:
mbed_official
Date:
Wed Jul 01 09:45:11 2015 +0100
Revision:
579:53297373a894
Child:
592:a274ee790e56
Synchronized with git revision d5b4d2ab9c47edb4dc5776e7177b0c2263459081



Full URL: https://github.com/mbedmicro/mbed/commit/d5b4d2ab9c47edb4dc5776e7177b0c2263459081/



Initial version of drivers for SAMR21

Who changed what in which revision?

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