Sergey Solodunov
mbed library sources. Supersedes mbed-src.
Fork of
mbed-dev
by 
mbed official
targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/system/system.h@15:a81a8d6c1dfe, 2015-11-04 (annotated)
- Committer:
- mbed_official
- Date:
- Wed Nov 04 16:30:11 2015 +0000
- Revision:
- 15:a81a8d6c1dfe
Synchronized with git revision 46af745ef4405614c3fa49abbd9a706a362ea514
Full URL: https://github.com/mbedmicro/mbed/commit/46af745ef4405614c3fa49abbd9a706a362ea514/
Renamed TARGET_SAM_CortexM0+ to TARGET_SAM_CortexM0P for compatiblity with online compiler
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 System related functionality |
| mbed_official | 15:a81a8d6c1dfe | 5 | * |
| mbed_official | 15:a81a8d6c1dfe | 6 | * Copyright (C) 2012-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 SYSTEM_H_INCLUDED |
| mbed_official | 15:a81a8d6c1dfe | 47 | #define SYSTEM_H_INCLUDED |
| mbed_official | 15:a81a8d6c1dfe | 48 | |
| mbed_official | 15:a81a8d6c1dfe | 49 | #include <compiler.h> |
| mbed_official | 15:a81a8d6c1dfe | 50 | #include <clock.h> |
| mbed_official | 15:a81a8d6c1dfe | 51 | #include <gclk.h> |
| mbed_official | 15:a81a8d6c1dfe | 52 | #include <pinmux.h> |
| mbed_official | 15:a81a8d6c1dfe | 53 | #include <power.h> |
| mbed_official | 15:a81a8d6c1dfe | 54 | #include <reset.h> |
| mbed_official | 15:a81a8d6c1dfe | 55 | |
| mbed_official | 15:a81a8d6c1dfe | 56 | #ifdef __cplusplus |
| mbed_official | 15:a81a8d6c1dfe | 57 | extern "C" { |
| mbed_official | 15:a81a8d6c1dfe | 58 | #endif |
| mbed_official | 15:a81a8d6c1dfe | 59 | |
| mbed_official | 15:a81a8d6c1dfe | 60 | /** |
| mbed_official | 15:a81a8d6c1dfe | 61 | * \defgroup asfdoc_sam0_system_group SAM System (SYSTEM) Driver |
| mbed_official | 15:a81a8d6c1dfe | 62 | * |
| mbed_official | 15:a81a8d6c1dfe | 63 | * This driver for Atmel® | SMART ARM®-based microcontrollers provides an interface for the configuration |
| mbed_official | 15:a81a8d6c1dfe | 64 | * and management of the device's system relation functionality, necessary for |
| mbed_official | 15:a81a8d6c1dfe | 65 | * the basic device operation. This is not limited to a single peripheral, but |
| mbed_official | 15:a81a8d6c1dfe | 66 | * extends across multiple hardware peripherals. |
| mbed_official | 15:a81a8d6c1dfe | 67 | * |
| mbed_official | 15:a81a8d6c1dfe | 68 | * The following peripherals are used by this module: |
| mbed_official | 15:a81a8d6c1dfe | 69 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 70 | * - PM (Power Manager) |
| mbed_official | 15:a81a8d6c1dfe | 71 | * - RSTC(Reset Controller) |
| mbed_official | 15:a81a8d6c1dfe | 72 | * - SUPC(Supply Controller) |
| mbed_official | 15:a81a8d6c1dfe | 73 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 74 | * \if DEVICE_SAMC21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 75 | * - PM (Power Manager) |
| mbed_official | 15:a81a8d6c1dfe | 76 | * - RSTC(Reset Controller) |
| mbed_official | 15:a81a8d6c1dfe | 77 | * - SUPC(Supply Controller) |
| mbed_official | 15:a81a8d6c1dfe | 78 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 79 | * \if DEVICE_SAMD21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 80 | * - SYSCTRL (System Control) |
| mbed_official | 15:a81a8d6c1dfe | 81 | * - PM (Power Manager) |
| mbed_official | 15:a81a8d6c1dfe | 82 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 83 | * |
| mbed_official | 15:a81a8d6c1dfe | 84 | * The following devices can use this module: |
| mbed_official | 15:a81a8d6c1dfe | 85 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 86 | * - Atmel | SMART SAM L21 |
| mbed_official | 15:a81a8d6c1dfe | 87 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 88 | * \if DEVICE_SAMC21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 89 | * - Atmel | SMART SAM C20/C21 |
| mbed_official | 15:a81a8d6c1dfe | 90 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 91 | * \if DEVICE_SAMD21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 92 | * - Atmel | SMART SAM D20/D21 |
| mbed_official | 15:a81a8d6c1dfe | 93 | * - Atmel | SMART SAM R21 |
| mbed_official | 15:a81a8d6c1dfe | 94 | * - Atmel | SMART SAM D10/D11 |
| mbed_official | 15:a81a8d6c1dfe | 95 | * - Atmel | SMART SAM DAx |
| mbed_official | 15:a81a8d6c1dfe | 96 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 97 | * |
| mbed_official | 15:a81a8d6c1dfe | 98 | * The outline of this documentation is as follows: |
| mbed_official | 15:a81a8d6c1dfe | 99 | * - \ref asfdoc_sam0_system_prerequisites |
| mbed_official | 15:a81a8d6c1dfe | 100 | * - \ref asfdoc_sam0_system_module_overview |
| mbed_official | 15:a81a8d6c1dfe | 101 | * - \ref asfdoc_sam0_system_special_considerations |
| mbed_official | 15:a81a8d6c1dfe | 102 | * - \ref asfdoc_sam0_system_extra_info |
| mbed_official | 15:a81a8d6c1dfe | 103 | * - \ref asfdoc_sam0_system_examples |
| mbed_official | 15:a81a8d6c1dfe | 104 | * - \ref asfdoc_sam0_system_api_overview |
| mbed_official | 15:a81a8d6c1dfe | 105 | * |
| mbed_official | 15:a81a8d6c1dfe | 106 | * |
| mbed_official | 15:a81a8d6c1dfe | 107 | * \section asfdoc_sam0_system_prerequisites Prerequisites |
| mbed_official | 15:a81a8d6c1dfe | 108 | * |
| mbed_official | 15:a81a8d6c1dfe | 109 | * There are no prerequisites for this module. |
| mbed_official | 15:a81a8d6c1dfe | 110 | * |
| mbed_official | 15:a81a8d6c1dfe | 111 | * |
| mbed_official | 15:a81a8d6c1dfe | 112 | * \section asfdoc_sam0_system_module_overview Module Overview |
| mbed_official | 15:a81a8d6c1dfe | 113 | * |
| mbed_official | 15:a81a8d6c1dfe | 114 | * The System driver provides a collection of interfaces between the user |
| mbed_official | 15:a81a8d6c1dfe | 115 | * application logic, and the core device functionality (such as clocks, reset |
| mbed_official | 15:a81a8d6c1dfe | 116 | * cause determination, etc.) that is required for all applications. It contains |
| mbed_official | 15:a81a8d6c1dfe | 117 | * a number of sub-modules that control one specific aspect of the device: |
| mbed_official | 15:a81a8d6c1dfe | 118 | * |
| mbed_official | 15:a81a8d6c1dfe | 119 | * - System Core (this module) |
| mbed_official | 15:a81a8d6c1dfe | 120 | * - \ref asfdoc_sam0_system_clock_group "System Clock Control" (sub-module) |
| mbed_official | 15:a81a8d6c1dfe | 121 | * - \ref asfdoc_sam0_system_interrupt_group "System Interrupt Control" (sub-module) |
| mbed_official | 15:a81a8d6c1dfe | 122 | * - \ref asfdoc_sam0_system_pinmux_group "System Pin Multiplexer Control" (sub-module) |
| mbed_official | 15:a81a8d6c1dfe | 123 | * |
| mbed_official | 15:a81a8d6c1dfe | 124 | * |
| mbed_official | 15:a81a8d6c1dfe | 125 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 126 | * \subsection asfdoc_sam0_system_module_overview_vreg_l21 Voltage Regulator |
| mbed_official | 15:a81a8d6c1dfe | 127 | * The SAM device controls the voltage regulators for the core (VDDCORE) and |
| mbed_official | 15:a81a8d6c1dfe | 128 | * backup (VDDBU) domains. It sets the voltage regulators according to the sleep |
| mbed_official | 15:a81a8d6c1dfe | 129 | * modes, the performance level, or the user configuration. |
| mbed_official | 15:a81a8d6c1dfe | 130 | * |
| mbed_official | 15:a81a8d6c1dfe | 131 | * In active mode, the voltage regulator can be chosen on the fly between a LDO |
| mbed_official | 15:a81a8d6c1dfe | 132 | * or a Buck converter. In standby mode, the low power voltage regulator is used |
| mbed_official | 15:a81a8d6c1dfe | 133 | * to supply VDDCORE. |
| mbed_official | 15:a81a8d6c1dfe | 134 | * |
| mbed_official | 15:a81a8d6c1dfe | 135 | * \subsection asfdoc_sam0_system_module_overview_bbps Battery Backup Power Switch |
| mbed_official | 15:a81a8d6c1dfe | 136 | * The SAM device supports connection of a battery backup to the VBAT power pin. |
| mbed_official | 15:a81a8d6c1dfe | 137 | * It includes functionality that enables automatic power switching between main |
| mbed_official | 15:a81a8d6c1dfe | 138 | * power and battery backup power. This will ensure power to the backup domain, |
| mbed_official | 15:a81a8d6c1dfe | 139 | * when the main battery or power source is unavailable. |
| mbed_official | 15:a81a8d6c1dfe | 140 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 141 | * |
| mbed_official | 15:a81a8d6c1dfe | 142 | * \if DEVICE_SAMC21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 143 | * \subsection asfdoc_sam0_system_module_overview_vreg_c21 Voltage Regulator |
| mbed_official | 15:a81a8d6c1dfe | 144 | * The SAM device controls the voltage regulators for the core (VDDCORE). It sets |
| mbed_official | 15:a81a8d6c1dfe | 145 | * the voltage regulators according to the sleep modes. |
| mbed_official | 15:a81a8d6c1dfe | 146 | * |
| mbed_official | 15:a81a8d6c1dfe | 147 | * There are a selectable reference voltage and voltage dependent on the temperature |
| mbed_official | 15:a81a8d6c1dfe | 148 | * which can be used by analog modules like the ADC. |
| mbed_official | 15:a81a8d6c1dfe | 149 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 150 | * |
| mbed_official | 15:a81a8d6c1dfe | 151 | * \subsection asfdoc_sam0_system_module_overview_vref Voltage References |
| mbed_official | 15:a81a8d6c1dfe | 152 | * The various analog modules within the SAM devices (such as AC, ADC, and |
| mbed_official | 15:a81a8d6c1dfe | 153 | * DAC) require a voltage reference to be configured to act as a reference point |
| mbed_official | 15:a81a8d6c1dfe | 154 | * for comparisons and conversions. |
| mbed_official | 15:a81a8d6c1dfe | 155 | * |
| mbed_official | 15:a81a8d6c1dfe | 156 | * The SAM devices contain multiple references, including an internal |
| mbed_official | 15:a81a8d6c1dfe | 157 | * temperature sensor and a fixed band-gap voltage source. When enabled, the |
| mbed_official | 15:a81a8d6c1dfe | 158 | * associated voltage reference can be selected within the desired peripheral |
| mbed_official | 15:a81a8d6c1dfe | 159 | * where applicable. |
| mbed_official | 15:a81a8d6c1dfe | 160 | * |
| mbed_official | 15:a81a8d6c1dfe | 161 | * \subsection asfdoc_sam0_system_module_overview_reset_cause System Reset Cause |
| mbed_official | 15:a81a8d6c1dfe | 162 | * In some applications there may be a need to execute a different program |
| mbed_official | 15:a81a8d6c1dfe | 163 | * flow based on how the device was reset. For example, if the cause of reset |
| mbed_official | 15:a81a8d6c1dfe | 164 | * was the Watchdog timer (WDT), this might indicate an error in the application, |
| mbed_official | 15:a81a8d6c1dfe | 165 | * and a form of error handling or error logging might be needed. |
| mbed_official | 15:a81a8d6c1dfe | 166 | * |
| mbed_official | 15:a81a8d6c1dfe | 167 | * For this reason, an API is provided to retrieve the cause of the last system |
| mbed_official | 15:a81a8d6c1dfe | 168 | * reset, so that appropriate action can be taken. |
| mbed_official | 15:a81a8d6c1dfe | 169 | * |
| mbed_official | 15:a81a8d6c1dfe | 170 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 171 | * There are three groups of reset sources: |
| mbed_official | 15:a81a8d6c1dfe | 172 | * - Power supply reset: Resets caused by an electrical issue. It covers POR and BOD reset. |
| mbed_official | 15:a81a8d6c1dfe | 173 | * - User reset: Resets caused by the application. It covers external reset, |
| mbed_official | 15:a81a8d6c1dfe | 174 | * system reset, and watchdog reset. |
| mbed_official | 15:a81a8d6c1dfe | 175 | * - Backup reset: Resets caused by a backup mode exit condition. |
| mbed_official | 15:a81a8d6c1dfe | 176 | * |
| mbed_official | 15:a81a8d6c1dfe | 177 | * \subsection asfdoc_sam0_system_module_overview_performance_level Performance Level |
| mbed_official | 15:a81a8d6c1dfe | 178 | * Performance level allows the user to adjust the regulator output voltage to reduce |
| mbed_official | 15:a81a8d6c1dfe | 179 | * power consumption. The user can on the fly select the most suitable performance |
| mbed_official | 15:a81a8d6c1dfe | 180 | * level, depending on the application demands. |
| mbed_official | 15:a81a8d6c1dfe | 181 | * |
| mbed_official | 15:a81a8d6c1dfe | 182 | * The SAM device can operate at two different performance levels (PL0 and PL2). |
| mbed_official | 15:a81a8d6c1dfe | 183 | * When operating at PL0, the voltage applied on the full logic area is reduced |
| mbed_official | 15:a81a8d6c1dfe | 184 | * by voltage scaling. This voltage scaling technique allows to reduce the active |
| mbed_official | 15:a81a8d6c1dfe | 185 | * power consumption while decreasing the maximum frequency of the device. When |
| mbed_official | 15:a81a8d6c1dfe | 186 | * operating at PL2, the voltage regulator supplies the highest voltage, allowing |
| mbed_official | 15:a81a8d6c1dfe | 187 | * the device to run at higher clock speeds. |
| mbed_official | 15:a81a8d6c1dfe | 188 | * |
| mbed_official | 15:a81a8d6c1dfe | 189 | * Performance level transition is possible only when the device is in active |
| mbed_official | 15:a81a8d6c1dfe | 190 | * mode. After a reset, the device starts at the lowest performance level |
| mbed_official | 15:a81a8d6c1dfe | 191 | * (lowest power consumption and lowest max. frequency). The application can then |
| mbed_official | 15:a81a8d6c1dfe | 192 | * switch to another performance level at any time without any stop in the code |
| mbed_official | 15:a81a8d6c1dfe | 193 | * execution. As shown in \ref asfdoc_sam0_system_performance_level_transition_figure. |
| mbed_official | 15:a81a8d6c1dfe | 194 | * |
| mbed_official | 15:a81a8d6c1dfe | 195 | * \note When scaling down the performance level, the bus frequency should first be |
| mbed_official | 15:a81a8d6c1dfe | 196 | * scaled down in order to not exceed the maximum frequency allowed for the |
| mbed_official | 15:a81a8d6c1dfe | 197 | * low performance level. |
| mbed_official | 15:a81a8d6c1dfe | 198 | * When scaling up the performance level (e.g. from PL0 to PL2), check the performance |
| mbed_official | 15:a81a8d6c1dfe | 199 | * level status before increasing the bus frequency. It can be increased only |
| mbed_official | 15:a81a8d6c1dfe | 200 | * when the performance level transition is completed. |
| mbed_official | 15:a81a8d6c1dfe | 201 | * |
| mbed_official | 15:a81a8d6c1dfe | 202 | * \anchor asfdoc_sam0_system_performance_level_transition_figure |
| mbed_official | 15:a81a8d6c1dfe | 203 | * \image html performance_level_transition.svg "Performance Level Transition" |
| mbed_official | 15:a81a8d6c1dfe | 204 | * |
| mbed_official | 15:a81a8d6c1dfe | 205 | * \subsection asfdoc_sam0_system_module_overview_power_domain Power Domain Gating |
| mbed_official | 15:a81a8d6c1dfe | 206 | * Power domain gating allows power saving by reducing the voltage in logic |
| mbed_official | 15:a81a8d6c1dfe | 207 | * areas in the device to a low-power supply. The feature is available in |
| mbed_official | 15:a81a8d6c1dfe | 208 | * Standby sleep mode and will reduce the voltage in domains where all peripherals |
| mbed_official | 15:a81a8d6c1dfe | 209 | * are idle. Internal logic will maintain its content, meaning the corresponding |
| mbed_official | 15:a81a8d6c1dfe | 210 | * peripherals will not need to be reconfigured when normal operating voltage |
| mbed_official | 15:a81a8d6c1dfe | 211 | * is returned. Most power domains can be in the following three states: |
| mbed_official | 15:a81a8d6c1dfe | 212 | * |
| mbed_official | 15:a81a8d6c1dfe | 213 | * - Active state: The power domain is powered on. |
| mbed_official | 15:a81a8d6c1dfe | 214 | * - Retention state: The main voltage supply for the power domain is switched off, |
| mbed_official | 15:a81a8d6c1dfe | 215 | * while maintaining a secondary low-power supply for the sequential cells. The |
| mbed_official | 15:a81a8d6c1dfe | 216 | * logic context is restored when waking up. |
| mbed_official | 15:a81a8d6c1dfe | 217 | * - Off state: The power domain is entirely powered off. The logic context is lost. |
| mbed_official | 15:a81a8d6c1dfe | 218 | * |
| mbed_official | 15:a81a8d6c1dfe | 219 | * The SAM L21 device contains three power domains which can be controlled using |
| mbed_official | 15:a81a8d6c1dfe | 220 | * power domain gating, namely PD0, PD1, and PD2. These power domains can be |
| mbed_official | 15:a81a8d6c1dfe | 221 | * configured to the following cases: |
| mbed_official | 15:a81a8d6c1dfe | 222 | * - Default with no sleepwalking peripherals: A power domain is automatically set |
| mbed_official | 15:a81a8d6c1dfe | 223 | * to retention state in standby sleep mode if no activity require it. The application |
| mbed_official | 15:a81a8d6c1dfe | 224 | * can force all power domains to remain in active state during standby sleep mode |
| mbed_official | 15:a81a8d6c1dfe | 225 | * in order to accelerate wakeup time. |
| mbed_official | 15:a81a8d6c1dfe | 226 | * - Default with sleepwalking peripherals: If one or more peripherals are enabled |
| mbed_official | 15:a81a8d6c1dfe | 227 | * to perform sleepwalking tasks in standby sleep mode, the corresponding power |
| mbed_official | 15:a81a8d6c1dfe | 228 | * domain (PDn) remains in active state as well as all inferior power domains (<PDn). |
| mbed_official | 15:a81a8d6c1dfe | 229 | * - Sleepwalking with dynamic power domain gating: During standby sleep mode, a |
| mbed_official | 15:a81a8d6c1dfe | 230 | * power domain (PDn) in active can wake up a superior power domain (>PDn) in order |
| mbed_official | 15:a81a8d6c1dfe | 231 | * to perform a sleepwalking task. The superior power domain is then automatically |
| mbed_official | 15:a81a8d6c1dfe | 232 | * set to active state. At the end of the sleepwalking task, the device can either |
| mbed_official | 15:a81a8d6c1dfe | 233 | * be woken up or the superior power domain can return to retention state. |
| mbed_official | 15:a81a8d6c1dfe | 234 | * |
| mbed_official | 15:a81a8d6c1dfe | 235 | * Power domains can be linked to each other, it allows a power domain (PDn) to be kept |
| mbed_official | 15:a81a8d6c1dfe | 236 | * in active state if the inferior power domain (PDn-1) is in active state too. |
| mbed_official | 15:a81a8d6c1dfe | 237 | * |
| mbed_official | 15:a81a8d6c1dfe | 238 | * \ref asfdoc_sam0_system_power_domain_overview_table illustrates the |
| mbed_official | 15:a81a8d6c1dfe | 239 | * four cases to consider in standby mode. |
| mbed_official | 15:a81a8d6c1dfe | 240 | * |
| mbed_official | 15:a81a8d6c1dfe | 241 | * \anchor asfdoc_sam0_system_power_domain_overview_table |
| mbed_official | 15:a81a8d6c1dfe | 242 | * <table> |
| mbed_official | 15:a81a8d6c1dfe | 243 | * <caption>Sleep Mode versus Power Domain State Overview</caption> |
| mbed_official | 15:a81a8d6c1dfe | 244 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 245 | * <th>Sleep mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 246 | * <th>PD0</th> |
| mbed_official | 15:a81a8d6c1dfe | 247 | * <th>PD1</th> |
| mbed_official | 15:a81a8d6c1dfe | 248 | * <th>PD2</th> |
| mbed_official | 15:a81a8d6c1dfe | 249 | * <th>PDTOP</th> |
| mbed_official | 15:a81a8d6c1dfe | 250 | * <th>PDBACKUP</th> |
| mbed_official | 15:a81a8d6c1dfe | 251 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 252 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 253 | * <td>Idle</td> |
| mbed_official | 15:a81a8d6c1dfe | 254 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 255 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 256 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 257 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 258 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 259 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 260 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 261 | * <td>Standby - Case 1</td> |
| mbed_official | 15:a81a8d6c1dfe | 262 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 263 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 264 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 265 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 266 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 267 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 268 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 269 | * <td>Standby - Case 2</td> |
| mbed_official | 15:a81a8d6c1dfe | 270 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 271 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 272 | * <td>retention</td> |
| mbed_official | 15:a81a8d6c1dfe | 273 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 274 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 275 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 276 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 277 | * <td>Standby - Case 3</td> |
| mbed_official | 15:a81a8d6c1dfe | 278 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 279 | * <td>retention</td> |
| mbed_official | 15:a81a8d6c1dfe | 280 | * <td>retention</td> |
| mbed_official | 15:a81a8d6c1dfe | 281 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 282 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 283 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 284 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 285 | * <td>Standby - Case 4</td> |
| mbed_official | 15:a81a8d6c1dfe | 286 | * <td>retention</td> |
| mbed_official | 15:a81a8d6c1dfe | 287 | * <td>retention</td> |
| mbed_official | 15:a81a8d6c1dfe | 288 | * <td>retention</td> |
| mbed_official | 15:a81a8d6c1dfe | 289 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 290 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 291 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 292 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 293 | * <td>Backup</td> |
| mbed_official | 15:a81a8d6c1dfe | 294 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 295 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 296 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 297 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 298 | * <td>active</td> |
| mbed_official | 15:a81a8d6c1dfe | 299 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 300 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 301 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 302 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 303 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 304 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 305 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 306 | * <td>off</td> |
| mbed_official | 15:a81a8d6c1dfe | 307 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 308 | * </table> |
| mbed_official | 15:a81a8d6c1dfe | 309 | * |
| mbed_official | 15:a81a8d6c1dfe | 310 | * \subsection asfdoc_sam0_system_module_overview_ram_state RAMs Low Power Mode |
| mbed_official | 15:a81a8d6c1dfe | 311 | * By default, in standby sleep mode, RAM is in low power mode (back biased) |
| mbed_official | 15:a81a8d6c1dfe | 312 | * if its power domain is in retention state. |
| mbed_official | 15:a81a8d6c1dfe | 313 | * \ref asfdoc_sam0_system_power_ram_state_table lists RAMs low power mode. |
| mbed_official | 15:a81a8d6c1dfe | 314 | * |
| mbed_official | 15:a81a8d6c1dfe | 315 | * \anchor asfdoc_sam0_system_power_ram_state_table |
| mbed_official | 15:a81a8d6c1dfe | 316 | * <table> |
| mbed_official | 15:a81a8d6c1dfe | 317 | * <caption>RAM Back-biasing Mode</caption> |
| mbed_official | 15:a81a8d6c1dfe | 318 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 319 | * <th>RAM mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 320 | * <th>Description</th> |
| mbed_official | 15:a81a8d6c1dfe | 321 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 322 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 323 | * <td>Retention Back-biasing mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 324 | * <td>RAM is back-biased if its power domain is in retention mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 325 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 326 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 327 | * <td>Standby Back-biasing mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 328 | * <td>RAM is back-biased if the device is in standby mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 329 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 330 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 331 | * <td>Standby OFF mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 332 | * <td>RAM is OFF if the device is in standby mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 333 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 334 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 335 | * <td>Always OFF mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 336 | * <td>RAM is OFF if the device is in RET mode</td> |
| mbed_official | 15:a81a8d6c1dfe | 337 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 338 | * </table> |
| mbed_official | 15:a81a8d6c1dfe | 339 | * |
| mbed_official | 15:a81a8d6c1dfe | 340 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 341 | * |
| mbed_official | 15:a81a8d6c1dfe | 342 | * \subsection asfdoc_sam0_system_module_overview_sleep_mode Sleep Modes |
| mbed_official | 15:a81a8d6c1dfe | 343 | * The SAM devices have several sleep modes. The sleep mode controls |
| mbed_official | 15:a81a8d6c1dfe | 344 | * which clock systems on the device will remain enabled or disabled when the |
| mbed_official | 15:a81a8d6c1dfe | 345 | * device enters a low power sleep mode. |
| mbed_official | 15:a81a8d6c1dfe | 346 | * \ref asfdoc_sam0_system_module_sleep_mode_table "The table below" lists the |
| mbed_official | 15:a81a8d6c1dfe | 347 | * clock settings of the different sleep modes. |
| mbed_official | 15:a81a8d6c1dfe | 348 | * |
| mbed_official | 15:a81a8d6c1dfe | 349 | * \anchor asfdoc_sam0_system_module_sleep_mode_table |
| mbed_official | 15:a81a8d6c1dfe | 350 | * <table> |
| mbed_official | 15:a81a8d6c1dfe | 351 | * <caption>SAM Device Sleep Modes</caption> |
| mbed_official | 15:a81a8d6c1dfe | 352 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 353 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 354 | * <th>Sleep mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 355 | * <th>System clock</th> |
| mbed_official | 15:a81a8d6c1dfe | 356 | * <th>CPU clock</th> |
| mbed_official | 15:a81a8d6c1dfe | 357 | * <th>AHB/AHB clock</th> |
| mbed_official | 15:a81a8d6c1dfe | 358 | * <th>GCLK clocks</th> |
| mbed_official | 15:a81a8d6c1dfe | 359 | * <th>Oscillators (ONDEMAND = 0)</th> |
| mbed_official | 15:a81a8d6c1dfe | 360 | * <th>Oscillators (ONDEMAND = 1)</th> |
| mbed_official | 15:a81a8d6c1dfe | 361 | * <th>Regulator mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 362 | * <th>RAM mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 363 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 364 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 365 | * <td>Idle</td> |
| mbed_official | 15:a81a8d6c1dfe | 366 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 367 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 368 | * <td>Run if requested</td> |
| mbed_official | 15:a81a8d6c1dfe | 369 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 370 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 371 | * <td>Run if requested</td> |
| mbed_official | 15:a81a8d6c1dfe | 372 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 373 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 374 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 375 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 376 | * <td>Standby</td> |
| mbed_official | 15:a81a8d6c1dfe | 377 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 378 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 379 | * <td>Run if requested</td> |
| mbed_official | 15:a81a8d6c1dfe | 380 | * <td>Run if requested</td> |
| mbed_official | 15:a81a8d6c1dfe | 381 | * <td>Run if requested or RUNSTDBY = 1</td> |
| mbed_official | 15:a81a8d6c1dfe | 382 | * <td>Run if requested</td> |
| mbed_official | 15:a81a8d6c1dfe | 383 | * <td>Low pwer</td> |
| mbed_official | 15:a81a8d6c1dfe | 384 | * <td>Low pwer</td> |
| mbed_official | 15:a81a8d6c1dfe | 385 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 386 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 387 | * <td>Backup</td> |
| mbed_official | 15:a81a8d6c1dfe | 388 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 389 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 390 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 391 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 392 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 393 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 394 | * <td>Backup</td> |
| mbed_official | 15:a81a8d6c1dfe | 395 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 396 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 397 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 398 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 399 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 400 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 401 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 402 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 403 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 404 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 405 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 406 | * <td>Off</td> |
| mbed_official | 15:a81a8d6c1dfe | 407 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 408 | * \else |
| mbed_official | 15:a81a8d6c1dfe | 409 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 410 | * <th>Sleep mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 411 | * <th>CPU clock</th> |
| mbed_official | 15:a81a8d6c1dfe | 412 | * <th>AHB clock</th> |
| mbed_official | 15:a81a8d6c1dfe | 413 | * <th>APB clocks</th> |
| mbed_official | 15:a81a8d6c1dfe | 414 | * <th>Clock sources</th> |
| mbed_official | 15:a81a8d6c1dfe | 415 | * <th>System clock</th> |
| mbed_official | 15:a81a8d6c1dfe | 416 | * <th>32KHz</th> |
| mbed_official | 15:a81a8d6c1dfe | 417 | * <th>Reg mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 418 | * <th>RAM mode</th> |
| mbed_official | 15:a81a8d6c1dfe | 419 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 420 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 421 | * <td>Idle 0</td> |
| mbed_official | 15:a81a8d6c1dfe | 422 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 423 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 424 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 425 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 426 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 427 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 428 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 429 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 430 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 431 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 432 | * <td>Idle 1</td> |
| mbed_official | 15:a81a8d6c1dfe | 433 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 434 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 435 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 436 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 437 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 438 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 439 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 440 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 441 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 442 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 443 | * <td>Idle 2</td> |
| mbed_official | 15:a81a8d6c1dfe | 444 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 445 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 446 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 447 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 448 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 449 | * <td>Run</td> |
| mbed_official | 15:a81a8d6c1dfe | 450 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 451 | * <td>Normal</td> |
| mbed_official | 15:a81a8d6c1dfe | 452 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 453 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 454 | * <td>Standby</td> |
| mbed_official | 15:a81a8d6c1dfe | 455 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 456 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 457 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 458 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 459 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 460 | * <td>Stop</td> |
| mbed_official | 15:a81a8d6c1dfe | 461 | * <td>Low Power</td> |
| mbed_official | 15:a81a8d6c1dfe | 462 | * <td>Source/Drain biasing</td> |
| mbed_official | 15:a81a8d6c1dfe | 463 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 464 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 465 | * </table> |
| mbed_official | 15:a81a8d6c1dfe | 466 | * |
| mbed_official | 15:a81a8d6c1dfe | 467 | * Before entering device sleep, one of the available sleep modes must be set. |
| mbed_official | 15:a81a8d6c1dfe | 468 | * The device will automatically wake up in response to an interrupt being |
| mbed_official | 15:a81a8d6c1dfe | 469 | * generated or upon any other sleep mode exit condition. |
| mbed_official | 15:a81a8d6c1dfe | 470 | * |
| mbed_official | 15:a81a8d6c1dfe | 471 | * Some peripheral clocks will remain enabled during sleep, depending on their |
| mbed_official | 15:a81a8d6c1dfe | 472 | * configuration. If desired, the modules can remain clocked during sleep to allow |
| mbed_official | 15:a81a8d6c1dfe | 473 | * them continue to operate while other parts of the system are powered down |
| mbed_official | 15:a81a8d6c1dfe | 474 | * to save power. |
| mbed_official | 15:a81a8d6c1dfe | 475 | * |
| mbed_official | 15:a81a8d6c1dfe | 476 | * |
| mbed_official | 15:a81a8d6c1dfe | 477 | * \section asfdoc_sam0_system_special_considerations Special Considerations |
| mbed_official | 15:a81a8d6c1dfe | 478 | * |
| mbed_official | 15:a81a8d6c1dfe | 479 | * Most of the functions in this driver have device specific restrictions and |
| mbed_official | 15:a81a8d6c1dfe | 480 | * caveats; refer to your device datasheet. |
| mbed_official | 15:a81a8d6c1dfe | 481 | * |
| mbed_official | 15:a81a8d6c1dfe | 482 | * |
| mbed_official | 15:a81a8d6c1dfe | 483 | * \section asfdoc_sam0_system_extra_info Extra Information |
| mbed_official | 15:a81a8d6c1dfe | 484 | * |
| mbed_official | 15:a81a8d6c1dfe | 485 | * For extra information, see \ref asfdoc_sam0_system_extra. This includes: |
| mbed_official | 15:a81a8d6c1dfe | 486 | * - \ref asfdoc_sam0_system_extra_acronyms |
| mbed_official | 15:a81a8d6c1dfe | 487 | * - \ref asfdoc_sam0_system_extra_dependencies |
| mbed_official | 15:a81a8d6c1dfe | 488 | * - \ref asfdoc_sam0_system_extra_errata |
| mbed_official | 15:a81a8d6c1dfe | 489 | * - \ref asfdoc_sam0_system_extra_history |
| mbed_official | 15:a81a8d6c1dfe | 490 | * |
| mbed_official | 15:a81a8d6c1dfe | 491 | * |
| mbed_official | 15:a81a8d6c1dfe | 492 | * \section asfdoc_sam0_system_examples Examples |
| mbed_official | 15:a81a8d6c1dfe | 493 | * |
| mbed_official | 15:a81a8d6c1dfe | 494 | * For SYSTEM module related examples, refer to the sub-modules listed in |
| mbed_official | 15:a81a8d6c1dfe | 495 | * the \ref asfdoc_sam0_system_module_overview "system module overview". |
| mbed_official | 15:a81a8d6c1dfe | 496 | * |
| mbed_official | 15:a81a8d6c1dfe | 497 | * For a list of examples related to this driver, see |
| mbed_official | 15:a81a8d6c1dfe | 498 | * \ref asfdoc_sam0_drivers_power_exqsg. |
| mbed_official | 15:a81a8d6c1dfe | 499 | * |
| mbed_official | 15:a81a8d6c1dfe | 500 | * |
| mbed_official | 15:a81a8d6c1dfe | 501 | * \section asfdoc_sam0_system_api_overview API Overview |
| mbed_official | 15:a81a8d6c1dfe | 502 | * @{ |
| mbed_official | 15:a81a8d6c1dfe | 503 | */ |
| mbed_official | 15:a81a8d6c1dfe | 504 | |
| mbed_official | 15:a81a8d6c1dfe | 505 | /** |
| mbed_official | 15:a81a8d6c1dfe | 506 | * \name System Debugger |
| mbed_official | 15:a81a8d6c1dfe | 507 | * @{ |
| mbed_official | 15:a81a8d6c1dfe | 508 | */ |
| mbed_official | 15:a81a8d6c1dfe | 509 | |
| mbed_official | 15:a81a8d6c1dfe | 510 | /** |
| mbed_official | 15:a81a8d6c1dfe | 511 | * \brief Check if debugger is present. |
| mbed_official | 15:a81a8d6c1dfe | 512 | * |
| mbed_official | 15:a81a8d6c1dfe | 513 | * Check if debugger is connected to the onboard debug system (DAP). |
| mbed_official | 15:a81a8d6c1dfe | 514 | * |
| mbed_official | 15:a81a8d6c1dfe | 515 | * \return A bool identifying if a debugger is present. |
| mbed_official | 15:a81a8d6c1dfe | 516 | * |
| mbed_official | 15:a81a8d6c1dfe | 517 | * \retval true Debugger is connected to the system |
| mbed_official | 15:a81a8d6c1dfe | 518 | * \retval false Debugger is not connected to the system |
| mbed_official | 15:a81a8d6c1dfe | 519 | * |
| mbed_official | 15:a81a8d6c1dfe | 520 | */ |
| mbed_official | 15:a81a8d6c1dfe | 521 | static inline bool system_is_debugger_present(void) |
| mbed_official | 15:a81a8d6c1dfe | 522 | { |
| mbed_official | 15:a81a8d6c1dfe | 523 | return DSU->STATUSB.reg & DSU_STATUSB_DBGPRES; |
| mbed_official | 15:a81a8d6c1dfe | 524 | } |
| mbed_official | 15:a81a8d6c1dfe | 525 | |
| mbed_official | 15:a81a8d6c1dfe | 526 | /** |
| mbed_official | 15:a81a8d6c1dfe | 527 | * @} |
| mbed_official | 15:a81a8d6c1dfe | 528 | */ |
| mbed_official | 15:a81a8d6c1dfe | 529 | |
| mbed_official | 15:a81a8d6c1dfe | 530 | /** |
| mbed_official | 15:a81a8d6c1dfe | 531 | * \name System Identification |
| mbed_official | 15:a81a8d6c1dfe | 532 | * @{ |
| mbed_official | 15:a81a8d6c1dfe | 533 | */ |
| mbed_official | 15:a81a8d6c1dfe | 534 | |
| mbed_official | 15:a81a8d6c1dfe | 535 | /** |
| mbed_official | 15:a81a8d6c1dfe | 536 | * \brief Retrieve the device identification signature. |
| mbed_official | 15:a81a8d6c1dfe | 537 | * |
| mbed_official | 15:a81a8d6c1dfe | 538 | * Retrieves the signature of the current device. |
| mbed_official | 15:a81a8d6c1dfe | 539 | * |
| mbed_official | 15:a81a8d6c1dfe | 540 | * \return Device ID signature as a 32-bit integer. |
| mbed_official | 15:a81a8d6c1dfe | 541 | */ |
| mbed_official | 15:a81a8d6c1dfe | 542 | static inline uint32_t system_get_device_id(void) |
| mbed_official | 15:a81a8d6c1dfe | 543 | { |
| mbed_official | 15:a81a8d6c1dfe | 544 | return DSU->DID.reg; |
| mbed_official | 15:a81a8d6c1dfe | 545 | } |
| mbed_official | 15:a81a8d6c1dfe | 546 | |
| mbed_official | 15:a81a8d6c1dfe | 547 | /** |
| mbed_official | 15:a81a8d6c1dfe | 548 | * @} |
| mbed_official | 15:a81a8d6c1dfe | 549 | */ |
| mbed_official | 15:a81a8d6c1dfe | 550 | |
| mbed_official | 15:a81a8d6c1dfe | 551 | /** |
| mbed_official | 15:a81a8d6c1dfe | 552 | * \name System Initialization |
| mbed_official | 15:a81a8d6c1dfe | 553 | * @{ |
| mbed_official | 15:a81a8d6c1dfe | 554 | */ |
| mbed_official | 15:a81a8d6c1dfe | 555 | |
| mbed_official | 15:a81a8d6c1dfe | 556 | void system_init(void); |
| mbed_official | 15:a81a8d6c1dfe | 557 | |
| mbed_official | 15:a81a8d6c1dfe | 558 | /** |
| mbed_official | 15:a81a8d6c1dfe | 559 | * @} |
| mbed_official | 15:a81a8d6c1dfe | 560 | */ |
| mbed_official | 15:a81a8d6c1dfe | 561 | |
| mbed_official | 15:a81a8d6c1dfe | 562 | |
| mbed_official | 15:a81a8d6c1dfe | 563 | /** |
| mbed_official | 15:a81a8d6c1dfe | 564 | * @} |
| mbed_official | 15:a81a8d6c1dfe | 565 | */ |
| mbed_official | 15:a81a8d6c1dfe | 566 | |
| mbed_official | 15:a81a8d6c1dfe | 567 | /** |
| mbed_official | 15:a81a8d6c1dfe | 568 | |
| mbed_official | 15:a81a8d6c1dfe | 569 | * \page asfdoc_sam0_drivers_power_exqsg Examples for Power Driver |
| mbed_official | 15:a81a8d6c1dfe | 570 | * |
| mbed_official | 15:a81a8d6c1dfe | 571 | * This is a list of the available Quick Start Guides (QSGs) and example |
| mbed_official | 15:a81a8d6c1dfe | 572 | * applications. QSGs are simple examples with step-by-step instructions to |
| mbed_official | 15:a81a8d6c1dfe | 573 | * configure and use this driver in a selection of |
| mbed_official | 15:a81a8d6c1dfe | 574 | * use cases. Note that a QSG can be compiled as a standalone application or be |
| mbed_official | 15:a81a8d6c1dfe | 575 | * added to the user application. |
| mbed_official | 15:a81a8d6c1dfe | 576 | * |
| mbed_official | 15:a81a8d6c1dfe | 577 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 578 | * - \subpage asfdoc_sam0_power_basic_use_case |
| mbed_official | 15:a81a8d6c1dfe | 579 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 580 | * |
| mbed_official | 15:a81a8d6c1dfe | 581 | * \page asfdoc_sam0_system_extra Extra Information for SYSTEM Driver |
| mbed_official | 15:a81a8d6c1dfe | 582 | * |
| mbed_official | 15:a81a8d6c1dfe | 583 | * \section asfdoc_sam0_system_extra_acronyms Acronyms |
| mbed_official | 15:a81a8d6c1dfe | 584 | * Below is a table listing the acronyms used in this module, along with their |
| mbed_official | 15:a81a8d6c1dfe | 585 | * intended meanings. |
| mbed_official | 15:a81a8d6c1dfe | 586 | * |
| mbed_official | 15:a81a8d6c1dfe | 587 | * <table> |
| mbed_official | 15:a81a8d6c1dfe | 588 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 589 | * <th>Acronym</th> |
| mbed_official | 15:a81a8d6c1dfe | 590 | * <th>Definition</th> |
| mbed_official | 15:a81a8d6c1dfe | 591 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 592 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 593 | * <td>PM</td> |
| mbed_official | 15:a81a8d6c1dfe | 594 | * <td>Power Manager</td> |
| mbed_official | 15:a81a8d6c1dfe | 595 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 596 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 597 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 598 | * <td>SUPC</td> |
| mbed_official | 15:a81a8d6c1dfe | 599 | * <td>Supply Controller</td> |
| mbed_official | 15:a81a8d6c1dfe | 600 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 601 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 602 | * <td>RSTC</td> |
| mbed_official | 15:a81a8d6c1dfe | 603 | * <td>Reset Controller</td> |
| mbed_official | 15:a81a8d6c1dfe | 604 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 605 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 606 | * \if DEVICE_SAMC21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 607 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 608 | * <td>SUPC</td> |
| mbed_official | 15:a81a8d6c1dfe | 609 | * <td>Supply Controller</td> |
| mbed_official | 15:a81a8d6c1dfe | 610 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 611 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 612 | * <td>RSTC</td> |
| mbed_official | 15:a81a8d6c1dfe | 613 | * <td>Reset Controller</td> |
| mbed_official | 15:a81a8d6c1dfe | 614 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 615 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 616 | * \if DEVICE_SAMD21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 617 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 618 | * <td>SYSCTRL</td> |
| mbed_official | 15:a81a8d6c1dfe | 619 | * <td>System control interface</td> |
| mbed_official | 15:a81a8d6c1dfe | 620 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 621 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 622 | * </table> |
| mbed_official | 15:a81a8d6c1dfe | 623 | * |
| mbed_official | 15:a81a8d6c1dfe | 624 | * |
| mbed_official | 15:a81a8d6c1dfe | 625 | * \section asfdoc_sam0_system_extra_dependencies Dependencies |
| mbed_official | 15:a81a8d6c1dfe | 626 | * This driver has the following dependencies: |
| mbed_official | 15:a81a8d6c1dfe | 627 | * |
| mbed_official | 15:a81a8d6c1dfe | 628 | * - None |
| mbed_official | 15:a81a8d6c1dfe | 629 | * |
| mbed_official | 15:a81a8d6c1dfe | 630 | * |
| mbed_official | 15:a81a8d6c1dfe | 631 | * \section asfdoc_sam0_system_extra_errata Errata |
| mbed_official | 15:a81a8d6c1dfe | 632 | * There are no errata related to this driver. |
| mbed_official | 15:a81a8d6c1dfe | 633 | * |
| mbed_official | 15:a81a8d6c1dfe | 634 | * |
| mbed_official | 15:a81a8d6c1dfe | 635 | * \section asfdoc_sam0_system_extra_history Module History |
| mbed_official | 15:a81a8d6c1dfe | 636 | * An overview of the module history is presented in the table below, with |
| mbed_official | 15:a81a8d6c1dfe | 637 | * details on the enhancements and fixes made to the module since its first |
| mbed_official | 15:a81a8d6c1dfe | 638 | * release. The current version of this corresponds to the newest version in |
| mbed_official | 15:a81a8d6c1dfe | 639 | * the table. |
| mbed_official | 15:a81a8d6c1dfe | 640 | * |
| mbed_official | 15:a81a8d6c1dfe | 641 | * <table> |
| mbed_official | 15:a81a8d6c1dfe | 642 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 643 | * <th>Changelog</th> |
| mbed_official | 15:a81a8d6c1dfe | 644 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 645 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 646 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 647 | * <td>Initial Release</td> |
| mbed_official | 15:a81a8d6c1dfe | 648 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 649 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 650 | * \if DEVICE_SAMC21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 651 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 652 | * <td>Initial Release</td> |
| mbed_official | 15:a81a8d6c1dfe | 653 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 654 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 655 | * \if DEVICE_SAMD21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 656 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 657 | * <td>Added new \c system_reset() to reset the complete MCU with some exceptions</td> |
| mbed_official | 15:a81a8d6c1dfe | 658 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 659 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 660 | * <td>Added new \c system_get_device_id() function to retrieved the device |
| mbed_official | 15:a81a8d6c1dfe | 661 | * ID.</td> |
| mbed_official | 15:a81a8d6c1dfe | 662 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 663 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 664 | * <td>Initial Release</td> |
| mbed_official | 15:a81a8d6c1dfe | 665 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 666 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 667 | * </table> |
| mbed_official | 15:a81a8d6c1dfe | 668 | * |
| mbed_official | 15:a81a8d6c1dfe | 669 | * \page asfdoc_sam0_system_document_revision_history Document Revision History |
| mbed_official | 15:a81a8d6c1dfe | 670 | * |
| mbed_official | 15:a81a8d6c1dfe | 671 | * <table> |
| mbed_official | 15:a81a8d6c1dfe | 672 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 673 | * <th>Doc. Rev.</td> |
| mbed_official | 15:a81a8d6c1dfe | 674 | * <th>Date</td> |
| mbed_official | 15:a81a8d6c1dfe | 675 | * <th>Comments</td> |
| mbed_official | 15:a81a8d6c1dfe | 676 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 677 | * \if DEVICE_SAML21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 678 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 679 | * <td>42449A</td> |
| mbed_official | 15:a81a8d6c1dfe | 680 | * <td>07/2015</td> |
| mbed_official | 15:a81a8d6c1dfe | 681 | * <td>Initial document release</td> |
| mbed_official | 15:a81a8d6c1dfe | 682 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 683 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 684 | * \if DEVICE_SAMC21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 685 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 686 | * <td>42484A</td> |
| mbed_official | 15:a81a8d6c1dfe | 687 | * <td>08/2015</td> |
| mbed_official | 15:a81a8d6c1dfe | 688 | * <td>Initial document release.</td> |
| mbed_official | 15:a81a8d6c1dfe | 689 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 690 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 691 | * \if DEVICE_SAMD21_SYSTEM_SUPPORT |
| mbed_official | 15:a81a8d6c1dfe | 692 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 693 | * <td>42120E</td> |
| mbed_official | 15:a81a8d6c1dfe | 694 | * <td>04/2015</td> |
| mbed_official | 15:a81a8d6c1dfe | 695 | * <td>Added support for SAMDAx</td> |
| mbed_official | 15:a81a8d6c1dfe | 696 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 697 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 698 | * <td>42120D</td> |
| mbed_official | 15:a81a8d6c1dfe | 699 | * <td>12/2014</td> |
| mbed_official | 15:a81a8d6c1dfe | 700 | * <td>Added support for SAMR21 and SAMD10/D11</td> |
| mbed_official | 15:a81a8d6c1dfe | 701 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 702 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 703 | * <td>42120C</td> |
| mbed_official | 15:a81a8d6c1dfe | 704 | * <td>01/2014</td> |
| mbed_official | 15:a81a8d6c1dfe | 705 | * <td>Added support for SAMD21</td> |
| mbed_official | 15:a81a8d6c1dfe | 706 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 707 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 708 | * <td>42120B</td> |
| mbed_official | 15:a81a8d6c1dfe | 709 | * <td>06/2013</td> |
| mbed_official | 15:a81a8d6c1dfe | 710 | * <td>Corrected documentation typos</td> |
| mbed_official | 15:a81a8d6c1dfe | 711 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 712 | * <tr> |
| mbed_official | 15:a81a8d6c1dfe | 713 | * <td>42120A</td> |
| mbed_official | 15:a81a8d6c1dfe | 714 | * <td>06/2013</td> |
| mbed_official | 15:a81a8d6c1dfe | 715 | * <td>Initial document release</td> |
| mbed_official | 15:a81a8d6c1dfe | 716 | * </tr> |
| mbed_official | 15:a81a8d6c1dfe | 717 | * \endif |
| mbed_official | 15:a81a8d6c1dfe | 718 | * </table> |
| mbed_official | 15:a81a8d6c1dfe | 719 | */ |
| mbed_official | 15:a81a8d6c1dfe | 720 | |
| mbed_official | 15:a81a8d6c1dfe | 721 | #ifdef __cplusplus |
| mbed_official | 15:a81a8d6c1dfe | 722 | } |
| mbed_official | 15:a81a8d6c1dfe | 723 | #endif |
| mbed_official | 15:a81a8d6c1dfe | 724 | |
| mbed_official | 15:a81a8d6c1dfe | 725 | #endif /* SYSTEM_H_INCLUDED */ |
| mbed_official | 15:a81a8d6c1dfe | 726 |