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