periph_conf.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2017 Travis Griggs <travisgriggs@gmail.com>
3  * SPDX-FileCopyrightText: 2017 Dan Evans <photonthunder@gmail.com>
4  * SPDX-License-Identifier: LGPL-2.1-only
5  */
6 
7 #pragma once
8 
21 #include <stdint.h>
22 
23 #include "cpu.h"
24 #include "periph_cpu.h"
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
62 #define CLOCK_USE_PLL (1)
63 #define CLOCK_USE_XOSC32_DFLL (0)
64 /*
65  * 0: use XOSC32K (always 32.768kHz) to clock GCLK2
66  * 1: use OSCULP32K factory calibrated (~32.768kHz) to clock GCLK2
67  *
68  * OSCULP32K is factory calibrated to be around 32.768kHz but this values can
69  * be of by a couple off % points, so prefer XOSC32K as default configuration.
70  */
71 #define GEN2_ULP32K (0)
72 
73 #if CLOCK_USE_PLL
74 /* edit these values to adjust the PLL output frequency */
75 #define CLOCK_PLL_MUL (47U) /* must be >= 31 & <= 95 */
76 #define CLOCK_PLL_DIV (1U) /* adjust to your needs */
77 /* generate the actual used core clock frequency */
78 #define CLOCK_CORECLOCK (((CLOCK_PLL_MUL + 1) * 1000000U) / CLOCK_PLL_DIV)
79 #elif CLOCK_USE_XOSC32_DFLL
80 /* Settings for 32 kHz external oscillator and 48 MHz DFLL */
81 #define CLOCK_CORECLOCK (48000000U)
82 #define CLOCK_XOSC32K (32768UL)
83 #define CLOCK_8MHZ (1)
84 #else
85 /* edit this value to your needs */
86 #define CLOCK_DIV (1U)
87 /* generate the actual core clock frequency */
88 #define CLOCK_CORECLOCK (8000000 / CLOCK_DIV)
89 #endif
96 static const tc32_conf_t timer_config[] = {
97  { /* Timer 0 - System Clock */
98  .dev = TC3,
99  .irq = TC3_IRQn,
100  .pm_mask = PM_APBCMASK_TC3,
101  .gclk_ctrl = GCLK_CLKCTRL_ID_TCC2_TC3,
102 #if CLOCK_USE_PLL || CLOCK_USE_XOSC32_DFLL
103  .gclk_src = SAM0_GCLK_1MHZ,
104 #else
105  .gclk_src = SAM0_GCLK_MAIN,
106 #endif
107  .flags = TC_CTRLA_MODE_COUNT16,
108  },
109  { /* Timer 1 */
110  .dev = TC4,
111  .irq = TC4_IRQn,
112  .pm_mask = PM_APBCMASK_TC4 | PM_APBCMASK_TC5,
113  .gclk_ctrl = GCLK_CLKCTRL_ID_TC4_TC5,
114 #if CLOCK_USE_PLL || CLOCK_USE_XOSC32_DFLL
115  .gclk_src = SAM0_GCLK_1MHZ,
116 #else
117  .gclk_src = SAM0_GCLK_MAIN,
118 #endif
119  .flags = TC_CTRLA_MODE_COUNT32,
120  }
121 };
122 
123 #define TIMER_0_MAX_VALUE 0xffff
124 
125 /* interrupt function name mapping */
126 #define TIMER_0_ISR isr_tc3
127 #define TIMER_1_ISR isr_tc4
128 
129 #define TIMER_NUMOF ARRAY_SIZE(timer_config)
136 static const uart_conf_t uart_config[] = {
137  { /* Virtual COM Port */
138  .dev = &SERCOM3->USART,
139  .rx_pin = GPIO_PIN(PA,23),
140  .tx_pin = GPIO_PIN(PA,22),
141 #ifdef MODULE_PERIPH_UART_HW_FC
142  .rts_pin = GPIO_UNDEF,
143  .cts_pin = GPIO_UNDEF,
144 #endif
145  .mux = GPIO_MUX_C,
146  .rx_pad = UART_PAD_RX_1,
147  .tx_pad = UART_PAD_TX_0,
148  .flags = UART_FLAG_NONE,
149  .gclk_src = SAM0_GCLK_MAIN,
150  },
151  { /* EXT1 */
152  .dev = &SERCOM4->USART,
153  .rx_pin = GPIO_PIN(PB,9),
154  .tx_pin = GPIO_PIN(PB,8),
155 #ifdef MODULE_PERIPH_UART_HW_FC
156  .rts_pin = GPIO_UNDEF,
157  .cts_pin = GPIO_UNDEF,
158 #endif
159  .mux = GPIO_MUX_D,
160  .rx_pad = UART_PAD_RX_1,
161  .tx_pad = UART_PAD_TX_0,
162  .flags = UART_FLAG_NONE,
163  .gclk_src = SAM0_GCLK_MAIN,
164  },
165  { /* EXT2/3 */
166  .dev = &SERCOM4->USART,
167  .rx_pin = GPIO_PIN(PB,11),
168  .tx_pin = GPIO_PIN(PB,10),
169 #ifdef MODULE_PERIPH_UART_HW_FC
170  .rts_pin = GPIO_UNDEF,
171  .cts_pin = GPIO_UNDEF,
172 #endif
173  .mux = GPIO_MUX_D,
174  .rx_pad = UART_PAD_RX_3,
175  .tx_pad = UART_PAD_TX_2,
176  .flags = UART_FLAG_NONE,
177  .gclk_src = SAM0_GCLK_MAIN,
178  }
179 };
180 
181 /* interrupt function name mapping */
182 #define UART_0_ISR isr_sercom3
183 #define UART_1_ISR isr_sercom4
184 #define UART_2_ISR isr_sercom5
185 
186 #define UART_NUMOF ARRAY_SIZE(uart_config)
193 #define PWM_0_EN 1
194 #define PWM_1_EN 0
195 #define PWM_2_EN 0
196 
197 #if PWM_0_EN
198 /* PWM0 channels */
199 static const pwm_conf_chan_t pwm_chan0_config[] = {
200  /* GPIO pin, MUX value, TCC channel */
201  { .pin = GPIO_PIN(PA, 12), .mux = GPIO_MUX_E, .chan = 0 },
202  { .pin = GPIO_PIN(PA, 13), .mux = GPIO_MUX_E, .chan = 1 },
203 };
204 #endif
205 #if PWM_1_EN
206 /* PWM1 channels */
207 static const pwm_conf_chan_t pwm_chan1_config[] = {
208  /* GPIO pin, MUX value, TCC channel */
209  { .pin = GPIO_PIN(PB, 12), .mux = GPIO_MUX_E, .chan = 0 },
210  { .pin = GPIO_PIN(PB, 13), .mux = GPIO_MUX_E, .chan = 1 },
211 };
212 #endif
213 #if PWM_2_EN
214 /* PWM2 channels */
215 static const pwm_conf_chan_t pwm_chan2_config[] = {
216  /* GPIO pin, MUX value, TCC channel */
217  { .pin = GPIO_PIN(PB, 02), .mux = GPIO_MUX_E, .chan = 0 },
218  { .pin = GPIO_PIN(PB, 03), .mux = GPIO_MUX_E, .chan = 1 },
219 };
220 #endif
221 
222 /* PWM device configuration */
223 static const pwm_conf_t pwm_config[] = {
224 #if PWM_0_EN
225  {
226  .tim = TCC_CONFIG(TCC2),
227  .chan = pwm_chan0_config,
228  .chan_numof = ARRAY_SIZE(pwm_chan0_config),
229  .gclk_src = SAM0_GCLK_MAIN,
230  },
231 #endif
232 #if PWM_1_EN
233  {
234  .tim = TC_CONFIG(TC4),
235  .chan = pwm_chan1_config,
236  .chan_numof = ARRAY_SIZE(pwm_chan1_config),
237  .gclk_src = SAM0_GCLK_MAIN,
238  },
239 #endif
240 #if PWM_2_EN
241  {
242  .tim = TC_CONFIG(TC6),
243  .chan = pwm_chan2_config,
244  .chan_numof = ARRAY_SIZE(pwm_chan2_config),
245  .gclk_src = SAM0_GCLK_MAIN,
246  },
247 #endif
248 };
249 
250 /* number of devices that are actually defined */
251 #define PWM_NUMOF ARRAY_SIZE(pwm_config)
258 static const spi_conf_t spi_config[] = {
259  { /* EXT1 */
260  .dev = &SERCOM0->SPI,
261  .miso_pin = GPIO_PIN(PA, 4),
262  .mosi_pin = GPIO_PIN(PA, 6),
263  .clk_pin = GPIO_PIN(PA, 7),
264  .miso_mux = GPIO_MUX_D,
265  .mosi_mux = GPIO_MUX_D,
266  .clk_mux = GPIO_MUX_D,
267  .miso_pad = SPI_PAD_MISO_0,
268  .mosi_pad = SPI_PAD_MOSI_2_SCK_3,
269  .gclk_src = SAM0_GCLK_MAIN,
270 #ifdef MODULE_PERIPH_DMA
271  .tx_trigger = SERCOM0_DMAC_ID_TX,
272  .rx_trigger = SERCOM0_DMAC_ID_RX,
273 #endif
274  },
275  { /* EXT2 */
276  .dev = &SERCOM1->SPI,
277  .miso_pin = GPIO_PIN(PA, 16),
278  .mosi_pin = GPIO_PIN(PA, 18),
279  .clk_pin = GPIO_PIN(PA, 19),
280  .miso_mux = GPIO_MUX_C,
281  .mosi_mux = GPIO_MUX_C,
282  .clk_mux = GPIO_MUX_C,
283  .miso_pad = SPI_PAD_MISO_0,
284  .mosi_pad = SPI_PAD_MOSI_2_SCK_3,
285  .gclk_src = SAM0_GCLK_MAIN,
286 #ifdef MODULE_PERIPH_DMA
287  .tx_trigger = SERCOM1_DMAC_ID_TX,
288  .rx_trigger = SERCOM1_DMAC_ID_RX,
289 #endif
290  },
291  { /* EXT3 */
292  .dev = &SERCOM5->SPI,
293  .miso_pin = GPIO_PIN(PB, 16),
294  .mosi_pin = GPIO_PIN(PB, 22),
295  .clk_pin = GPIO_PIN(PB, 23),
296  .miso_mux = GPIO_MUX_C,
297  .mosi_mux = GPIO_MUX_D,
298  .clk_mux = GPIO_MUX_D,
299  .miso_pad = SPI_PAD_MISO_0,
300  .mosi_pad = SPI_PAD_MOSI_2_SCK_3,
301  .gclk_src = SAM0_GCLK_MAIN,
302 #ifdef MODULE_PERIPH_DMA
303  .tx_trigger = SERCOM5_DMAC_ID_TX,
304  .rx_trigger = SERCOM5_DMAC_ID_RX,
305 #endif
306  }
307 };
308 
309 #define SPI_NUMOF ARRAY_SIZE(spi_config)
316 static const i2c_conf_t i2c_config[] = {
317  {
318  .dev = &(SERCOM2->I2CM),
319  .speed = I2C_SPEED_NORMAL,
320  .scl_pin = GPIO_PIN(PA, 9),
321  .sda_pin = GPIO_PIN(PA, 8),
322  .mux = GPIO_MUX_D,
323  .gclk_src = SAM0_GCLK_MAIN,
324  .flags = I2C_FLAG_NONE
325  }
326 };
327 #define I2C_NUMOF ARRAY_SIZE(i2c_config)
334 #ifndef RTT_FREQUENCY
335 #define RTT_FREQUENCY (32768U) /* in Hz. For changes see `rtt.c` */
336 #endif
344 /* ADC Default values */
345 #define ADC_PRESCALER ADC_CTRLB_PRESCALER_DIV512
346 
347 #define ADC_NEG_INPUT ADC_INPUTCTRL_MUXNEG_GND
348 #define ADC_GAIN_FACTOR_DEFAULT ADC_INPUTCTRL_GAIN_1X
349 #define ADC_REF_DEFAULT ADC_REFCTRL_REFSEL_INT1V
350 
351 static const adc_conf_chan_t adc_channels[] = {
352  /* port, pin, muxpos */
353  { .inputctrl = ADC_INPUTCTRL_MUXPOS_PB00 }, /* EXT1, pin 3 */
354  { .inputctrl = ADC_INPUTCTRL_MUXPOS_PB01 }, /* EXT1, pin 4 */
355  { .inputctrl = ADC_INPUTCTRL_MUXPOS_PA10 }, /* EXT2, pin 3 */
356  { .inputctrl = ADC_INPUTCTRL_MUXPOS_PA11 }, /* EXT2, pin 4 */
357  { .inputctrl = ADC_INPUTCTRL_MUXPOS_PA02 }, /* EXT3, pin 3 */
358  { .inputctrl = ADC_INPUTCTRL_MUXPOS_PA03 } /* EXT3, pin 4. This is
359  disconnected by default. PA3 is connected to USB_ID.
360  Move PA03 SELECT jumper to EXT3 to connect. */
361 };
362 
363 #define ADC_NUMOF ARRAY_SIZE(adc_channels)
370 #define DAC_CLOCK SAM0_GCLK_1MHZ
371  /* use Vcc as reference voltage */
372 #define DAC_VREF DAC_CTRLB_REFSEL_AVCC
379 static const sam0_common_usb_config_t sam_usbdev_config[] = {
380  {
381  .dm = GPIO_PIN(PA, 24),
382  .dp = GPIO_PIN(PA, 25),
383  .d_mux = GPIO_MUX_G,
384  .device = &USB->DEVICE,
385  .gclk_src = SAM0_GCLK_MAIN,
386  }
387 };
389 #ifdef __cplusplus
390 }
391 #endif
392 
#define GPIO_PIN(x, y)
Define a CPU specific GPIO pin generator macro.
Definition: periph_cpu.h:42
#define GPIO_UNDEF
Definition of a fitting UNDEF value.
static const uart_conf_t uart_config[]
UART configuration.
Definition: periph_conf.h:35
static const spi_conf_t spi_config[]
SPI configuration.
Definition: periph_conf.h:93
static const i2c_conf_t i2c_config[]
I2C configuration.
Definition: periph_conf.h:65
static const timer_conf_t timer_config[]
All timers on board.
Definition: periph_conf.h:36
static const pwm_conf_t pwm_config[]
Actual PWM configuration.
Definition: periph_conf.h:218
#define ARRAY_SIZE(a)
Calculate the number of elements in a static array.
Definition: container.h:82
static const gpio_t adc_channels[]
Static array with declared ADC channels.
@ I2C_SPEED_NORMAL
normal mode: ~100 kbit/s
Definition: periph_cpu.h:274
@ UART_PAD_RX_1
select pad 1
@ UART_PAD_RX_3
select pad 3
@ PB
port B
@ PA
port A
@ I2C_FLAG_NONE
No flags set.
#define TC_CONFIG(tim)
Static initializer for TC timer configuration.
@ SPI_PAD_MISO_0
use pad 0 for MISO line
@ UART_FLAG_NONE
No flags set.
@ UART_PAD_TX_0
select pad 0
@ UART_PAD_TX_2
select pad 2
#define TCC_CONFIG(tim)
Static initializer for TCC timer configuration.
@ GPIO_MUX_E
select peripheral function E
@ GPIO_MUX_D
select peripheral function D
@ GPIO_MUX_G
select peripheral function G
@ GPIO_MUX_C
select peripheral function C
@ SPI_PAD_MOSI_2_SCK_3
use pad 2 for MOSI, pad 3 for SCK
@ SAM0_GCLK_1MHZ
1 MHz clock for xTimer
Definition: periph_cpu.h:75
#define ADC_INPUTCTRL_MUXPOS_PA10
Alias for PIN18.
Definition: periph_cpu.h:136
#define ADC_INPUTCTRL_MUXPOS_PA11
Alias for PIN19.
Definition: periph_cpu.h:137
#define ADC_INPUTCTRL_MUXPOS_PB01
Alias for PIN9.
Definition: periph_cpu.h:127
#define ADC_INPUTCTRL_MUXPOS_PA02
ADC pin aliases.
Definition: periph_cpu.h:118
#define ADC_INPUTCTRL_MUXPOS_PA03
Alias for PIN1.
Definition: periph_cpu.h:119
#define ADC_INPUTCTRL_MUXPOS_PB00
Alias for PIN8.
Definition: periph_cpu.h:126
#define SAM0_GCLK_MAIN
120 MHz main clock
Definition: periph_cpu.h:73
ADC Channel Configuration.
I2C configuration structure.
Definition: periph_cpu.h:295
TWI_t * dev
Pointer to hardware module registers.
Definition: periph_cpu.h:296
PWM channel configuration data structure.
gpio_t pin
GPIO pin.
PWM device configuration.
tc_tcc_cfg_t tim
timer configuration
USB peripheral parameters.
SPI device configuration.
Definition: periph_cpu.h:333
SPI_t * dev
pointer to the used SPI device
Definition: periph_cpu.h:334
Timer device configuration.
TC0_t * dev
Pointer to the used as Timer device.
Definition: periph_cpu.h:261
UART device configuration.
Definition: periph_cpu.h:214
USART_t * dev
pointer to the used UART device
Definition: periph_cpu.h:215