periph_cpu.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 ML!PA Consulting GmbH
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
9 #pragma once
10 
22 #include <limits.h>
23 
24 #include "macros/units.h"
25 #include "periph_cpu_common.h"
26 
27 #include "candev_samd5x.h"
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
35 #define SAM0_DFLL_FREQ_HZ MHZ(48)
36 
40 #define SAM0_XOSC_FREQ_HZ (XOSC0_FREQUENCY ? XOSC0_FREQUENCY : XOSC1_FREQUENCY)
41 
45 #define SAM0_DPLL_FREQ_MIN_HZ MHZ(96)
46 
50 #define SAM0_DPLL_FREQ_MAX_HZ MHZ(200)
51 
56 #define PM_NUM_MODES (4)
61 enum {
62  SAM0_PM_BACKUP = 0,
63  SAM0_PM_HIBERNATE = 1,
64  SAM0_PM_STANDBY = 2,
65  SAM0_PM_IDLE = 3,
66 };
73 #define SAM0_GCLK_MAIN 0
74 #ifndef SAM0_GCLK_32KHZ
75 # define SAM0_GCLK_32KHZ 1
76 #endif
77 #ifndef SAM0_GCLK_TIMER
78 # define SAM0_GCLK_TIMER 2
79 #endif
80 #ifndef SAM0_GCLK_PERIPH
81 # define SAM0_GCLK_PERIPH 3
82 #endif
83 #ifndef SAM0_GCLK_100MHZ
84 # define SAM0_GCLK_100MHZ 4
85 #endif
92 #define SAM0_GCLK_8MHZ SAM0_GCLK_TIMER
93 #define SAM0_GCLK_48MHZ SAM0_GCLK_PERIPH
101 #define SPI_HWCS(x) (UINT_MAX - 1)
102 
106 static const gpio_t sam0_adc_pins[2][16] = {
107  { /* ADC0 pins */
108  GPIO_PIN(PA, 2), GPIO_PIN(PA, 3), GPIO_PIN(PB, 8), GPIO_PIN(PB, 9),
109  GPIO_PIN(PA, 4), GPIO_PIN(PA, 5), GPIO_PIN(PA, 6), GPIO_PIN(PA, 7),
110  GPIO_PIN(PA, 8), GPIO_PIN(PA, 9), GPIO_PIN(PA, 10), GPIO_PIN(PA, 11),
111  GPIO_PIN(PB, 0), GPIO_PIN(PB, 1), GPIO_PIN(PB, 2), GPIO_PIN(PB, 3)
112  },
113  { /* ADC1 pins */
114  GPIO_PIN(PB, 8), GPIO_PIN(PB, 9), GPIO_PIN(PA, 8), GPIO_PIN(PA, 9),
115  GPIO_PIN(PC, 2), GPIO_PIN(PC, 3), GPIO_PIN(PB, 4), GPIO_PIN(PB, 5),
116  GPIO_PIN(PB, 6), GPIO_PIN(PB, 7), GPIO_PIN(PC, 0), GPIO_PIN(PC, 1),
117  GPIO_PIN(PC, 30), GPIO_PIN(PC, 31), GPIO_PIN(PD, 0), GPIO_PIN(PD, 1)
118  }
119 };
120 
125 #define ADC0_INPUTCTRL_MUXPOS_PA02 ADC_INPUTCTRL_MUXPOS_AIN0
126 #define ADC0_INPUTCTRL_MUXPOS_PA03 ADC_INPUTCTRL_MUXPOS_AIN1
127 #define ADC0_INPUTCTRL_MUXPOS_PB08 ADC_INPUTCTRL_MUXPOS_AIN2
128 #define ADC0_INPUTCTRL_MUXPOS_PB09 ADC_INPUTCTRL_MUXPOS_AIN3
129 #define ADC0_INPUTCTRL_MUXPOS_PA04 ADC_INPUTCTRL_MUXPOS_AIN4
130 #define ADC0_INPUTCTRL_MUXPOS_PA05 ADC_INPUTCTRL_MUXPOS_AIN5
131 #define ADC0_INPUTCTRL_MUXPOS_PA06 ADC_INPUTCTRL_MUXPOS_AIN6
132 #define ADC0_INPUTCTRL_MUXPOS_PA07 ADC_INPUTCTRL_MUXPOS_AIN7
133 #define ADC0_INPUTCTRL_MUXPOS_PA08 ADC_INPUTCTRL_MUXPOS_AIN8
134 #define ADC0_INPUTCTRL_MUXPOS_PA09 ADC_INPUTCTRL_MUXPOS_AIN9
135 #define ADC0_INPUTCTRL_MUXPOS_PA10 ADC_INPUTCTRL_MUXPOS_AIN10
136 #define ADC0_INPUTCTRL_MUXPOS_PA11 ADC_INPUTCTRL_MUXPOS_AIN11
137 #define ADC0_INPUTCTRL_MUXPOS_PB00 ADC_INPUTCTRL_MUXPOS_AIN12
138 #define ADC0_INPUTCTRL_MUXPOS_PB01 ADC_INPUTCTRL_MUXPOS_AIN13
139 #define ADC0_INPUTCTRL_MUXPOS_PB02 ADC_INPUTCTRL_MUXPOS_AIN14
140 #define ADC0_INPUTCTRL_MUXPOS_PB03 ADC_INPUTCTRL_MUXPOS_AIN15
142 #define ADC1_INPUTCTRL_MUXPOS_PB08 ADC_INPUTCTRL_MUXPOS_AIN0
143 #define ADC1_INPUTCTRL_MUXPOS_PB09 ADC_INPUTCTRL_MUXPOS_AIN1
144 #define ADC1_INPUTCTRL_MUXPOS_PA08 ADC_INPUTCTRL_MUXPOS_AIN2
145 #define ADC1_INPUTCTRL_MUXPOS_PA09 ADC_INPUTCTRL_MUXPOS_AIN3
146 #define ADC1_INPUTCTRL_MUXPOS_PC02 ADC_INPUTCTRL_MUXPOS_AIN4
147 #define ADC1_INPUTCTRL_MUXPOS_PC03 ADC_INPUTCTRL_MUXPOS_AIN5
148 #define ADC1_INPUTCTRL_MUXPOS_PB04 ADC_INPUTCTRL_MUXPOS_AIN6
149 #define ADC1_INPUTCTRL_MUXPOS_PB05 ADC_INPUTCTRL_MUXPOS_AIN7
150 #define ADC1_INPUTCTRL_MUXPOS_PB06 ADC_INPUTCTRL_MUXPOS_AIN8
151 #define ADC1_INPUTCTRL_MUXPOS_PB07 ADC_INPUTCTRL_MUXPOS_AIN9
152 #define ADC1_INPUTCTRL_MUXPOS_PC00 ADC_INPUTCTRL_MUXPOS_AIN10
153 #define ADC1_INPUTCTRL_MUXPOS_PC01 ADC_INPUTCTRL_MUXPOS_AIN11
154 #define ADC1_INPUTCTRL_MUXPOS_PC30 ADC_INPUTCTRL_MUXPOS_AIN12
155 #define ADC1_INPUTCTRL_MUXPOS_PC31 ADC_INPUTCTRL_MUXPOS_AIN13
156 #define ADC1_INPUTCTRL_MUXPOS_PD00 ADC_INPUTCTRL_MUXPOS_AIN14
157 #define ADC1_INPUTCTRL_MUXPOS_PD01 ADC_INPUTCTRL_MUXPOS_AIN15
159 #define ADC0_INPUTCTRL_MUXNEG_PA02 ADC_INPUTCTRL_MUXPOS_AIN0
160 #define ADC0_INPUTCTRL_MUXNEG_PA03 ADC_INPUTCTRL_MUXPOS_AIN1
161 #define ADC0_INPUTCTRL_MUXNEG_PB08 ADC_INPUTCTRL_MUXPOS_AIN2
162 #define ADC0_INPUTCTRL_MUXNEG_PB09 ADC_INPUTCTRL_MUXPOS_AIN3
163 #define ADC0_INPUTCTRL_MUXNEG_PA04 ADC_INPUTCTRL_MUXPOS_AIN4
164 #define ADC0_INPUTCTRL_MUXNEG_PA05 ADC_INPUTCTRL_MUXPOS_AIN5
165 #define ADC0_INPUTCTRL_MUXNEG_PA06 ADC_INPUTCTRL_MUXPOS_AIN6
166 #define ADC0_INPUTCTRL_MUXNEG_PA07 ADC_INPUTCTRL_MUXPOS_AIN7
168 #define ADC1_INPUTCTRL_MUXNEG_PB08 ADC_INPUTCTRL_MUXPOS_AIN0
169 #define ADC1_INPUTCTRL_MUXNEG_PB09 ADC_INPUTCTRL_MUXPOS_AIN1
170 #define ADC1_INPUTCTRL_MUXNEG_PA08 ADC_INPUTCTRL_MUXPOS_AIN2
171 #define ADC1_INPUTCTRL_MUXNEG_PA09 ADC_INPUTCTRL_MUXPOS_AIN3
172 #define ADC1_INPUTCTRL_MUXNEG_PC02 ADC_INPUTCTRL_MUXPOS_AIN4
173 #define ADC1_INPUTCTRL_MUXNEG_PC03 ADC_INPUTCTRL_MUXPOS_AIN5
174 #define ADC1_INPUTCTRL_MUXNEG_PB04 ADC_INPUTCTRL_MUXPOS_AIN6
175 #define ADC1_INPUTCTRL_MUXNEG_PB05 ADC_INPUTCTRL_MUXPOS_AIN7
181 #define DAC_RES_BITS (12)
182 
186 #define DAC_NUMOF (2)
187 
192 #define RTT_MAX_VALUE (0xffffffff)
193 #define RTT_CLOCK_FREQUENCY (32768U) /* in Hz */
194 #define RTT_MIN_FREQUENCY (RTT_CLOCK_FREQUENCY / 1024U) /* in Hz */
195 #define RTT_MAX_FREQUENCY (RTT_CLOCK_FREQUENCY) /* in Hz */
202 static const gpio_t rtc_tamper_pins[RTC_NUM_OF_TAMPERS] = {
203  GPIO_PIN(PB, 0), GPIO_PIN(PB, 2), GPIO_PIN(PA, 2),
204  GPIO_PIN(PC, 0), GPIO_PIN(PC, 1)
205 };
206 
210 static const gpio_t gclk_io_pins[] = {
211  GPIO_PIN(PA, 10), GPIO_PIN(PA, 11), GPIO_PIN(PA, 14),
212  GPIO_PIN(PA, 15), GPIO_PIN(PA, 16), GPIO_PIN(PA, 17),
213  GPIO_PIN(PA, 27), GPIO_PIN(PA, 30), GPIO_PIN(PB, 10),
214  GPIO_PIN(PB, 11), GPIO_PIN(PB, 12), GPIO_PIN(PB, 13),
215  GPIO_PIN(PB, 14), GPIO_PIN(PB, 15), GPIO_PIN(PB, 16),
216  GPIO_PIN(PB, 17), GPIO_PIN(PB, 18), GPIO_PIN(PB, 19),
217  GPIO_PIN(PB, 20), GPIO_PIN(PB, 21), GPIO_PIN(PB, 22),
218  GPIO_PIN(PB, 23)
219 };
220 
225 static const uint8_t gclk_io_ids[] = {
226  4, 5, 0, 1, 2, 3, 1, 0, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7, 0, 1
227 };
228 
233 struct sam0_aux_cfg_mapping {
234  /* config word 0 */
235  uint32_t bod33_disable : 1;
236  uint32_t bod33_level : 8;
237  uint32_t bod33_action : 2;
238  uint32_t bod33_hysteresis : 4;
239  const uint32_t bod12_calibration : 11;
240  uint32_t nvm_boot_size : 4;
241  uint32_t reserved_0 : 2;
242  /* config word 1 */
243  uint32_t smart_eeprom_blocks : 4;
244  uint32_t smart_eeprom_page_size : 3;
245  uint32_t ram_eccdis : 1;
246  uint32_t reserved_1 : 8;
247  uint32_t wdt_enable : 1;
248  uint32_t wdt_always_on : 1;
249  uint32_t wdt_period : 4;
250  uint32_t wdt_window : 4;
251  uint32_t wdt_ewoffset : 4;
252  uint32_t wdt_window_enable : 1;
253  uint32_t reserved_2 : 1;
254  /* config word 2 */
255  uint32_t nvm_locks;
256  /* config word 3 */
257  uint32_t user_page;
258  /* config word 4 */
259  uint32_t reserved_3;
260  /* config words 5,6,7 */
261  uint32_t user_pages[3];
262 };
263 
268 #define SAM0_QSPI_PIN_CLK GPIO_PIN(PB, 10)
269 #define SAM0_QSPI_PIN_CS GPIO_PIN(PB, 11)
270 #define SAM0_QSPI_PIN_DATA_0 GPIO_PIN(PA, 8)
271 #define SAM0_QSPI_PIN_DATA_1 GPIO_PIN(PA, 9)
272 #define SAM0_QSPI_PIN_DATA_2 GPIO_PIN(PA, 10)
273 #define SAM0_QSPI_PIN_DATA_3 GPIO_PIN(PA, 11)
274 #define SAM0_QSPI_MUX GPIO_MUX_H
281 #define SAM0_SDHC_MUX GPIO_MUX_I
283 #define SAM0_SDHC0_PIN_SDCMD GPIO_PIN(PA, 8)
284 #define SAM0_SDHC0_PIN_SDDAT0 GPIO_PIN(PA, 9)
285 #define SAM0_SDHC0_PIN_SDDAT1 GPIO_PIN(PA, 10)
286 #define SAM0_SDHC0_PIN_SDDAT2 GPIO_PIN(PA, 11)
287 #define SAM0_SDHC0_PIN_SDDAT3 GPIO_PIN(PB, 10)
288 #define SAM0_SDHC0_PIN_SDCK GPIO_PIN(PB, 11)
290 #define SAM0_SDHC1_PIN_SDCMD GPIO_PIN(PA, 20)
291 #define SAM0_SDHC1_PIN_SDDAT0 GPIO_PIN(PB, 18)
292 #define SAM0_SDHC1_PIN_SDDAT1 GPIO_PIN(PB, 19)
293 #define SAM0_SDHC1_PIN_SDDAT2 GPIO_PIN(PB, 20)
294 #define SAM0_SDHC1_PIN_SDDAT3 GPIO_PIN(PB, 21)
295 #define SAM0_SDHC1_PIN_SDCK GPIO_PIN(PA, 21)
298 #ifdef __cplusplus
299 }
300 #endif
301 
#define GPIO_PIN(x, y)
Define a CPU specific GPIO pin generator macro.
Definition: periph_cpu.h:45
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:106
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:225
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:202
static const gpio_t gclk_io_pins[]
Pins that have peripheral function GCLK.
Definition: periph_cpu.h:210
NVM User Row Mapping - Dedicated Entries Config values will be applied at power-on.
Definition: periph_cpu.h:176
uint32_t reserved_3
Factory settings - do not change.
Definition: periph_cpu.h:259
uint32_t wdt_enable
WDT Enable at power-on.
Definition: periph_cpu.h:247
uint32_t nvm_locks
NVM Region Lock Bits.
Definition: periph_cpu.h:255
uint32_t smart_eeprom_page_size
SmartEEPROM Page Size
Definition: periph_cpu.h:244
uint32_t user_page
User page
Definition: periph_cpu.h:257
uint32_t smart_eeprom_blocks
NVM Blocks per SmartEEPROM sector
Definition: periph_cpu.h:243
uint32_t reserved_0
Factory settings - do not change.
Definition: periph_cpu.h:241
uint32_t bod33_level
BOD33 threshold level at power-on.
Definition: periph_cpu.h:236
uint32_t wdt_window_enable
WDT Window mode enabled on power-on
Definition: periph_cpu.h:252
uint32_t wdt_period
WDT Period at power-on.
Definition: periph_cpu.h:249
uint32_t bod33_disable
BOD33 Disable at power-on.
Definition: periph_cpu.h:235
uint32_t wdt_ewoffset
WDT Early Warning Interrupt Offset
Definition: periph_cpu.h:251
uint32_t ram_eccdis
RAM ECC Disable
Definition: periph_cpu.h:245
uint32_t reserved_1
Factory settings - do not change.
Definition: periph_cpu.h:246
uint32_t user_pages[3]
User pages
Definition: periph_cpu.h:261
uint32_t bod33_hysteresis
BOD33 Hysteresis configuration
Definition: periph_cpu.h:238
uint32_t reserved_2
Factory settings - do not change.
Definition: periph_cpu.h:253
const uint32_t bod12_calibration
Factory settings - do not change.
Definition: periph_cpu.h:239
uint32_t bod33_action
BOD33 Action at power-on.
Definition: periph_cpu.h:237
uint32_t nvm_boot_size
NVM Bootloader Size
Definition: periph_cpu.h:240
uint32_t wdt_always_on
WDT Always-On at power-on.
Definition: periph_cpu.h:248
uint32_t wdt_window
WDT Window at power-on.
Definition: periph_cpu.h:250
Unit helper macros.