periph_cpu.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2019 ML!PA Consulting GmbH
3  * SPDX-License-Identifier: LGPL-2.1-only
4  */
5 
6 #pragma once
7 
19 #include <limits.h>
20 
21 #include "macros/units.h"
22 #include "periph_cpu_common.h"
23 
24 #include "candev_samd5x.h"
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
32 #define SAM0_DFLL_FREQ_HZ MHZ(48)
33 
37 #define SAM0_XOSC_FREQ_HZ (XOSC0_FREQUENCY ? XOSC0_FREQUENCY : XOSC1_FREQUENCY)
38 
42 #define SAM0_DPLL_FREQ_MIN_HZ MHZ(96)
43 
47 #define SAM0_DPLL_FREQ_MAX_HZ MHZ(200)
48 
53 #define PM_NUM_MODES (4)
58 enum {
59  SAM0_PM_BACKUP = 0,
60  SAM0_PM_HIBERNATE = 1,
61  SAM0_PM_STANDBY = 2,
62  SAM0_PM_IDLE = 3,
63 };
70 #define SAM0_GCLK_MAIN 0
71 #ifndef SAM0_GCLK_32KHZ
72 # define SAM0_GCLK_32KHZ 1
73 #endif
74 #ifndef SAM0_GCLK_TIMER
75 # define SAM0_GCLK_TIMER 2
76 #endif
77 #ifndef SAM0_GCLK_PERIPH
78 # define SAM0_GCLK_PERIPH 3
79 #endif
80 #ifndef SAM0_GCLK_100MHZ
81 # define SAM0_GCLK_100MHZ 4
82 #endif
89 #define SAM0_GCLK_8MHZ SAM0_GCLK_TIMER
90 #define SAM0_GCLK_48MHZ SAM0_GCLK_PERIPH
98 #define SPI_HWCS(x) (UINT_MAX - 1)
99 
103 static const gpio_t sam0_adc_pins[2][16] = {
104  { /* ADC0 pins */
105  GPIO_PIN(PA, 2), GPIO_PIN(PA, 3), GPIO_PIN(PB, 8), GPIO_PIN(PB, 9),
106  GPIO_PIN(PA, 4), GPIO_PIN(PA, 5), GPIO_PIN(PA, 6), GPIO_PIN(PA, 7),
107  GPIO_PIN(PA, 8), GPIO_PIN(PA, 9), GPIO_PIN(PA, 10), GPIO_PIN(PA, 11),
108  GPIO_PIN(PB, 0), GPIO_PIN(PB, 1), GPIO_PIN(PB, 2), GPIO_PIN(PB, 3)
109  },
110  { /* ADC1 pins */
111  GPIO_PIN(PB, 8), GPIO_PIN(PB, 9), GPIO_PIN(PA, 8), GPIO_PIN(PA, 9),
112  GPIO_PIN(PC, 2), GPIO_PIN(PC, 3), GPIO_PIN(PB, 4), GPIO_PIN(PB, 5),
113  GPIO_PIN(PB, 6), GPIO_PIN(PB, 7), GPIO_PIN(PC, 0), GPIO_PIN(PC, 1),
114  GPIO_PIN(PC, 30), GPIO_PIN(PC, 31), GPIO_PIN(PD, 0), GPIO_PIN(PD, 1)
115  }
116 };
117 
122 #define ADC0_INPUTCTRL_MUXPOS_PA02 ADC_INPUTCTRL_MUXPOS_AIN0
123 #define ADC0_INPUTCTRL_MUXPOS_PA03 ADC_INPUTCTRL_MUXPOS_AIN1
124 #define ADC0_INPUTCTRL_MUXPOS_PB08 ADC_INPUTCTRL_MUXPOS_AIN2
125 #define ADC0_INPUTCTRL_MUXPOS_PB09 ADC_INPUTCTRL_MUXPOS_AIN3
126 #define ADC0_INPUTCTRL_MUXPOS_PA04 ADC_INPUTCTRL_MUXPOS_AIN4
127 #define ADC0_INPUTCTRL_MUXPOS_PA05 ADC_INPUTCTRL_MUXPOS_AIN5
128 #define ADC0_INPUTCTRL_MUXPOS_PA06 ADC_INPUTCTRL_MUXPOS_AIN6
129 #define ADC0_INPUTCTRL_MUXPOS_PA07 ADC_INPUTCTRL_MUXPOS_AIN7
130 #define ADC0_INPUTCTRL_MUXPOS_PA08 ADC_INPUTCTRL_MUXPOS_AIN8
131 #define ADC0_INPUTCTRL_MUXPOS_PA09 ADC_INPUTCTRL_MUXPOS_AIN9
132 #define ADC0_INPUTCTRL_MUXPOS_PA10 ADC_INPUTCTRL_MUXPOS_AIN10
133 #define ADC0_INPUTCTRL_MUXPOS_PA11 ADC_INPUTCTRL_MUXPOS_AIN11
134 #define ADC0_INPUTCTRL_MUXPOS_PB00 ADC_INPUTCTRL_MUXPOS_AIN12
135 #define ADC0_INPUTCTRL_MUXPOS_PB01 ADC_INPUTCTRL_MUXPOS_AIN13
136 #define ADC0_INPUTCTRL_MUXPOS_PB02 ADC_INPUTCTRL_MUXPOS_AIN14
137 #define ADC0_INPUTCTRL_MUXPOS_PB03 ADC_INPUTCTRL_MUXPOS_AIN15
139 #define ADC1_INPUTCTRL_MUXPOS_PB08 ADC_INPUTCTRL_MUXPOS_AIN0
140 #define ADC1_INPUTCTRL_MUXPOS_PB09 ADC_INPUTCTRL_MUXPOS_AIN1
141 #define ADC1_INPUTCTRL_MUXPOS_PA08 ADC_INPUTCTRL_MUXPOS_AIN2
142 #define ADC1_INPUTCTRL_MUXPOS_PA09 ADC_INPUTCTRL_MUXPOS_AIN3
143 #define ADC1_INPUTCTRL_MUXPOS_PC02 ADC_INPUTCTRL_MUXPOS_AIN4
144 #define ADC1_INPUTCTRL_MUXPOS_PC03 ADC_INPUTCTRL_MUXPOS_AIN5
145 #define ADC1_INPUTCTRL_MUXPOS_PB04 ADC_INPUTCTRL_MUXPOS_AIN6
146 #define ADC1_INPUTCTRL_MUXPOS_PB05 ADC_INPUTCTRL_MUXPOS_AIN7
147 #define ADC1_INPUTCTRL_MUXPOS_PB06 ADC_INPUTCTRL_MUXPOS_AIN8
148 #define ADC1_INPUTCTRL_MUXPOS_PB07 ADC_INPUTCTRL_MUXPOS_AIN9
149 #define ADC1_INPUTCTRL_MUXPOS_PC00 ADC_INPUTCTRL_MUXPOS_AIN10
150 #define ADC1_INPUTCTRL_MUXPOS_PC01 ADC_INPUTCTRL_MUXPOS_AIN11
151 #define ADC1_INPUTCTRL_MUXPOS_PC30 ADC_INPUTCTRL_MUXPOS_AIN12
152 #define ADC1_INPUTCTRL_MUXPOS_PC31 ADC_INPUTCTRL_MUXPOS_AIN13
153 #define ADC1_INPUTCTRL_MUXPOS_PD00 ADC_INPUTCTRL_MUXPOS_AIN14
154 #define ADC1_INPUTCTRL_MUXPOS_PD01 ADC_INPUTCTRL_MUXPOS_AIN15
156 #define ADC0_INPUTCTRL_MUXNEG_PA02 ADC_INPUTCTRL_MUXPOS_AIN0
157 #define ADC0_INPUTCTRL_MUXNEG_PA03 ADC_INPUTCTRL_MUXPOS_AIN1
158 #define ADC0_INPUTCTRL_MUXNEG_PB08 ADC_INPUTCTRL_MUXPOS_AIN2
159 #define ADC0_INPUTCTRL_MUXNEG_PB09 ADC_INPUTCTRL_MUXPOS_AIN3
160 #define ADC0_INPUTCTRL_MUXNEG_PA04 ADC_INPUTCTRL_MUXPOS_AIN4
161 #define ADC0_INPUTCTRL_MUXNEG_PA05 ADC_INPUTCTRL_MUXPOS_AIN5
162 #define ADC0_INPUTCTRL_MUXNEG_PA06 ADC_INPUTCTRL_MUXPOS_AIN6
163 #define ADC0_INPUTCTRL_MUXNEG_PA07 ADC_INPUTCTRL_MUXPOS_AIN7
165 #define ADC1_INPUTCTRL_MUXNEG_PB08 ADC_INPUTCTRL_MUXPOS_AIN0
166 #define ADC1_INPUTCTRL_MUXNEG_PB09 ADC_INPUTCTRL_MUXPOS_AIN1
167 #define ADC1_INPUTCTRL_MUXNEG_PA08 ADC_INPUTCTRL_MUXPOS_AIN2
168 #define ADC1_INPUTCTRL_MUXNEG_PA09 ADC_INPUTCTRL_MUXPOS_AIN3
169 #define ADC1_INPUTCTRL_MUXNEG_PC02 ADC_INPUTCTRL_MUXPOS_AIN4
170 #define ADC1_INPUTCTRL_MUXNEG_PC03 ADC_INPUTCTRL_MUXPOS_AIN5
171 #define ADC1_INPUTCTRL_MUXNEG_PB04 ADC_INPUTCTRL_MUXPOS_AIN6
172 #define ADC1_INPUTCTRL_MUXNEG_PB05 ADC_INPUTCTRL_MUXPOS_AIN7
178 #define DAC_RES_BITS (12)
179 
183 #define DAC_NUMOF (2)
184 
189 #define RTT_MAX_VALUE (0xffffffff)
190 #define RTT_CLOCK_FREQUENCY (32768U) /* in Hz */
191 #define RTT_MIN_FREQUENCY (RTT_CLOCK_FREQUENCY / 1024U) /* in Hz */
192 #define RTT_MAX_FREQUENCY (RTT_CLOCK_FREQUENCY) /* in Hz */
199 static const gpio_t rtc_tamper_pins[RTC_NUM_OF_TAMPERS] = {
200  GPIO_PIN(PB, 0), GPIO_PIN(PB, 2), GPIO_PIN(PA, 2),
201  GPIO_PIN(PC, 0), GPIO_PIN(PC, 1)
202 };
203 
207 static const gpio_t gclk_io_pins[] = {
208  GPIO_PIN(PA, 10), GPIO_PIN(PA, 11), GPIO_PIN(PA, 14),
209  GPIO_PIN(PA, 15), GPIO_PIN(PA, 16), GPIO_PIN(PA, 17),
210  GPIO_PIN(PA, 27), GPIO_PIN(PA, 30), GPIO_PIN(PB, 10),
211  GPIO_PIN(PB, 11), GPIO_PIN(PB, 12), GPIO_PIN(PB, 13),
212  GPIO_PIN(PB, 14), GPIO_PIN(PB, 15), GPIO_PIN(PB, 16),
213  GPIO_PIN(PB, 17), GPIO_PIN(PB, 18), GPIO_PIN(PB, 19),
214  GPIO_PIN(PB, 20), GPIO_PIN(PB, 21), GPIO_PIN(PB, 22),
215  GPIO_PIN(PB, 23)
216 };
217 
222 static const uint8_t gclk_io_ids[] = {
223  4, 5, 0, 1, 2, 3, 1, 0, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7, 0, 1
224 };
225 
230 struct sam0_aux_cfg_mapping {
231  /* config word 0 */
232  uint32_t bod33_disable : 1;
233  uint32_t bod33_level : 8;
234  uint32_t bod33_action : 2;
235  uint32_t bod33_hysteresis : 4;
236  const uint32_t bod12_calibration : 11;
237  uint32_t nvm_boot_size : 4;
238  uint32_t reserved_0 : 2;
239  /* config word 1 */
240  uint32_t smart_eeprom_blocks : 4;
241  uint32_t smart_eeprom_page_size : 3;
242  uint32_t ram_eccdis : 1;
243  uint32_t reserved_1 : 8;
244  uint32_t wdt_enable : 1;
245  uint32_t wdt_always_on : 1;
246  uint32_t wdt_period : 4;
247  uint32_t wdt_window : 4;
248  uint32_t wdt_ewoffset : 4;
249  uint32_t wdt_window_enable : 1;
250  uint32_t reserved_2 : 1;
251  /* config word 2 */
252  uint32_t nvm_locks;
253  /* config word 3 */
254  uint32_t user_page;
255  /* config word 4 */
256  uint32_t reserved_3;
257  /* config words 5,6,7 */
258  uint32_t user_pages[3];
259 };
260 
265 #define SAM0_QSPI_PIN_CLK GPIO_PIN(PB, 10)
266 #define SAM0_QSPI_PIN_CS GPIO_PIN(PB, 11)
267 #define SAM0_QSPI_PIN_DATA_0 GPIO_PIN(PA, 8)
268 #define SAM0_QSPI_PIN_DATA_1 GPIO_PIN(PA, 9)
269 #define SAM0_QSPI_PIN_DATA_2 GPIO_PIN(PA, 10)
270 #define SAM0_QSPI_PIN_DATA_3 GPIO_PIN(PA, 11)
271 #define SAM0_QSPI_MUX GPIO_MUX_H
278 #define SAM0_SDHC_MUX GPIO_MUX_I
280 #define SAM0_SDHC0_PIN_SDCMD GPIO_PIN(PA, 8)
281 #define SAM0_SDHC0_PIN_SDDAT0 GPIO_PIN(PA, 9)
282 #define SAM0_SDHC0_PIN_SDDAT1 GPIO_PIN(PA, 10)
283 #define SAM0_SDHC0_PIN_SDDAT2 GPIO_PIN(PA, 11)
284 #define SAM0_SDHC0_PIN_SDDAT3 GPIO_PIN(PB, 10)
285 #define SAM0_SDHC0_PIN_SDCK GPIO_PIN(PB, 11)
287 #define SAM0_SDHC1_PIN_SDCMD GPIO_PIN(PA, 20)
288 #define SAM0_SDHC1_PIN_SDDAT0 GPIO_PIN(PB, 18)
289 #define SAM0_SDHC1_PIN_SDDAT1 GPIO_PIN(PB, 19)
290 #define SAM0_SDHC1_PIN_SDDAT2 GPIO_PIN(PB, 20)
291 #define SAM0_SDHC1_PIN_SDDAT3 GPIO_PIN(PB, 21)
292 #define SAM0_SDHC1_PIN_SDCK GPIO_PIN(PA, 21)
295 #ifdef __cplusplus
296 }
297 #endif
298 
#define GPIO_PIN(x, y)
Define a CPU specific GPIO pin generator macro.
Definition: periph_cpu.h:42
CPU specific definitions for CAN controllers.
@ PB
port B
@ PC
port C
@ PA
port A
@ PD
port D
static const gpio_t sam0_adc_pins[2][16]
Pins that can be used for ADC input.
Definition: periph_cpu.h:103
static const uint8_t gclk_io_ids[]
GCLK IDs of pins that have peripheral function GCLK - This maps directly to gclk_io_pins.
Definition: periph_cpu.h:222
static const gpio_t rtc_tamper_pins[RTC_NUM_OF_TAMPERS]
RTC input pins that can be used for tamper detection and wake from Deep Sleep.
Definition: periph_cpu.h:199
static const gpio_t gclk_io_pins[]
Pins that have peripheral function GCLK.
Definition: periph_cpu.h:207
NVM User Row Mapping - Dedicated Entries Config values will be applied at power-on.
Definition: periph_cpu.h:173
uint32_t reserved_3
Factory settings - do not change.
Definition: periph_cpu.h:256
uint32_t wdt_enable
WDT Enable at power-on.
Definition: periph_cpu.h:244
uint32_t nvm_locks
NVM Region Lock Bits.
Definition: periph_cpu.h:252
uint32_t smart_eeprom_page_size
SmartEEPROM Page Size
Definition: periph_cpu.h:241
uint32_t user_page
User page
Definition: periph_cpu.h:254
uint32_t smart_eeprom_blocks
NVM Blocks per SmartEEPROM sector
Definition: periph_cpu.h:240
uint32_t reserved_0
Factory settings - do not change.
Definition: periph_cpu.h:238
uint32_t bod33_level
BOD33 threshold level at power-on.
Definition: periph_cpu.h:233
uint32_t wdt_window_enable
WDT Window mode enabled on power-on
Definition: periph_cpu.h:249
uint32_t wdt_period
WDT Period at power-on.
Definition: periph_cpu.h:246
uint32_t bod33_disable
BOD33 Disable at power-on.
Definition: periph_cpu.h:232
uint32_t wdt_ewoffset
WDT Early Warning Interrupt Offset
Definition: periph_cpu.h:248
uint32_t ram_eccdis
RAM ECC Disable
Definition: periph_cpu.h:242
uint32_t reserved_1
Factory settings - do not change.
Definition: periph_cpu.h:243
uint32_t user_pages[3]
User pages
Definition: periph_cpu.h:258
uint32_t bod33_hysteresis
BOD33 Hysteresis configuration
Definition: periph_cpu.h:235
uint32_t reserved_2
Factory settings - do not change.
Definition: periph_cpu.h:250
const uint32_t bod12_calibration
Factory settings - do not change.
Definition: periph_cpu.h:236
uint32_t bod33_action
BOD33 Action at power-on.
Definition: periph_cpu.h:234
uint32_t nvm_boot_size
NVM Bootloader Size
Definition: periph_cpu.h:237
uint32_t wdt_always_on
WDT Always-On at power-on.
Definition: periph_cpu.h:245
uint32_t wdt_window
WDT Window at power-on.
Definition: periph_cpu.h:247
Unit helper macros.