Loading...
Searching...
No Matches
periph_conf_common.h File Reference
Boards » Common Board Groups » Arduino MKR Common

Common configuration for clock, timer, pwm, adc, rtc and rtt peripherals for Arduino MKR boards. More...

Detailed Description

Common configuration for clock, timer, pwm, adc, rtc and rtt peripherals for Arduino MKR boards.

Author
Thomas Eichinger thoma.nosp@m.s.ei.nosp@m.ching.nosp@m.er@f.nosp@m.u-ber.nosp@m.lin..nosp@m.de
Hauke Petersen hauke.nosp@m..pet.nosp@m.ersen.nosp@m.@fu-.nosp@m.berli.nosp@m.n.de
Peter Kietzmann peter.nosp@m..kie.nosp@m.tzman.nosp@m.n@ha.nosp@m.w-ham.nosp@m.burg.nosp@m..de
Alexandre Abadie alexa.nosp@m.ndre.nosp@m..abad.nosp@m.ie@i.nosp@m.nria..nosp@m.fr
Bumsik kim kbums.nosp@m.ik@g.nosp@m.mail..nosp@m.com

Definition in file periph_conf_common.h.

#include "periph_cpu.h"
+ Include dependency graph for periph_conf_common.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

External oscillator and clock configuration

For selection of the used CORECLOCK, we have implemented two choices:

  • usage of the PLL fed by the internal 8MHz oscillator divided by 8
  • usage of the internal 8MHz oscillator directly, divided by N if needed

The PLL option allows for the usage of a wider frequency range and a more stable clock with less jitter. This is why we use this option as default.

The target frequency is computed from the PLL multiplier and the PLL divisor. Use the following formula to compute your values:

CORECLOCK = ((PLL_MUL + 1) * 1MHz) / PLL_DIV

NOTE: The PLL circuit does not run with less than 32MHz while the maximum PLL frequency is 96MHz. So PLL_MULL must be between 31 and 95!

The internal Oscillator used directly can lead to a slightly better power efficiency to the cost of a less stable clock. Use this option when you know what you are doing! The actual core frequency is adjusted as follows:

CORECLOCK = 8MHz / DIV

NOTE: A core clock frequency below 1MHz is not recommended

#define CLOCK_USE_PLL   (1)
 
#define CLOCK_DIV   (1U)
 
#define CLOCK_CORECLOCK   (8000000 / CLOCK_DIV)
 

Timer peripheral configuration

#define TIMER_0_MAX_VALUE   0xffff
 
#define TIMER_0_ISR   isr_tc3
 
#define TIMER_1_ISR   isr_tc4
 
#define TIMER_NUMOF   ARRAY_SIZE(timer_config)
 
static const tc32_conf_t timer_config []
 

PWM configuration

#define PWM_0_EN   1
 
#define PWM_NUMOF   ARRAY_SIZE(pwm_config)
 
static const pwm_conf_t pwm_config []
 

ADC configuration

#define ADC_PRESCALER   ADC_CTRLB_PRESCALER_DIV512
 
#define ADC_NEG_INPUT   ADC_INPUTCTRL_MUXNEG_GND
 
#define ADC_GAIN_FACTOR_DEFAULT   ADC_INPUTCTRL_GAIN_1X
 
#define ADC_REF_DEFAULT   ADC_REFCTRL_REFSEL_INT1V
 
#define ADC_NUMOF   ARRAY_SIZE(adc_channels)
 
static const adc_conf_chan_t adc_channels []
 

I2C configuration

#define I2C_NUMOF   ARRAY_SIZE(i2c_config)
 
static const i2c_conf_t i2c_config []
 

RTT configuration

#define RTT_FREQUENCY   (32768U) /* in Hz. For changes see `rtt.c` */
 

USB peripheral configuration

static const sam0_common_usb_config_t sam_usbdev_config []
 

Macro Definition Documentation

◆ ADC_GAIN_FACTOR_DEFAULT

#define ADC_GAIN_FACTOR_DEFAULT   ADC_INPUTCTRL_GAIN_1X

Definition at line 156 of file periph_conf_common.h.

◆ ADC_NEG_INPUT

#define ADC_NEG_INPUT   ADC_INPUTCTRL_MUXNEG_GND

Definition at line 155 of file periph_conf_common.h.

◆ ADC_NUMOF

#define ADC_NUMOF   ARRAY_SIZE(adc_channels)

Definition at line 170 of file periph_conf_common.h.

◆ ADC_PRESCALER

#define ADC_PRESCALER   ADC_CTRLB_PRESCALER_DIV512

Definition at line 153 of file periph_conf_common.h.

◆ ADC_REF_DEFAULT

#define ADC_REF_DEFAULT   ADC_REFCTRL_REFSEL_INT1V

Definition at line 157 of file periph_conf_common.h.

◆ CLOCK_CORECLOCK

#define CLOCK_CORECLOCK   (8000000 / CLOCK_DIV)

Definition at line 77 of file periph_conf_common.h.

◆ CLOCK_DIV

#define CLOCK_DIV   (1U)

Definition at line 75 of file periph_conf_common.h.

◆ CLOCK_USE_PLL

#define CLOCK_USE_PLL   (1)

Definition at line 65 of file periph_conf_common.h.

◆ I2C_NUMOF

#define I2C_NUMOF   ARRAY_SIZE(i2c_config)

Definition at line 188 of file periph_conf_common.h.

◆ PWM_0_EN

#define PWM_0_EN   1

Definition at line 125 of file periph_conf_common.h.

◆ PWM_NUMOF

#define PWM_NUMOF   ARRAY_SIZE(pwm_config)

Definition at line 144 of file periph_conf_common.h.

◆ RTT_FREQUENCY

#define RTT_FREQUENCY   (32768U) /* in Hz. For changes see `rtt.c` */

Definition at line 196 of file periph_conf_common.h.

◆ TIMER_0_ISR

#define TIMER_0_ISR   isr_tc3

Definition at line 115 of file periph_conf_common.h.

◆ TIMER_0_MAX_VALUE

#define TIMER_0_MAX_VALUE   0xffff

Definition at line 112 of file periph_conf_common.h.

◆ TIMER_1_ISR

#define TIMER_1_ISR   isr_tc4

Definition at line 116 of file periph_conf_common.h.

◆ TIMER_NUMOF

#define TIMER_NUMOF   ARRAY_SIZE(timer_config)

Definition at line 118 of file periph_conf_common.h.

Variable Documentation

◆ adc_channels

const adc_conf_chan_t adc_channels[]
static
Initial value:
= {
{ .inputctrl = ADC_INPUTCTRL_MUXPOS_PA02 },
{ .inputctrl = ADC_INPUTCTRL_MUXPOS_PB02 },
{ .inputctrl = ADC_INPUTCTRL_MUXPOS_PB03 },
{ .inputctrl = ADC_INPUTCTRL_MUXPOS_PA04 },
{ .inputctrl = ADC_INPUTCTRL_MUXPOS_PA05 },
{ .inputctrl = ADC_INPUTCTRL_MUXPOS_PA06 },
{ .inputctrl = ADC_INPUTCTRL_MUXPOS_PA07 },
}
ADC_INPUTCTRL_MUXPOS_PA05
#define ADC_INPUTCTRL_MUXPOS_PA05
Alias for PIN5.
Definition periph_cpu.h:124
ADC_INPUTCTRL_MUXPOS_PB02
#define ADC_INPUTCTRL_MUXPOS_PB02
Alias for PIN10.
Definition periph_cpu.h:129
ADC_INPUTCTRL_MUXPOS_PA07
#define ADC_INPUTCTRL_MUXPOS_PA07
Alias for PIN7.
Definition periph_cpu.h:126
ADC_INPUTCTRL_MUXPOS_PA04
#define ADC_INPUTCTRL_MUXPOS_PA04
Alias for PIN4.
Definition periph_cpu.h:123
ADC_INPUTCTRL_MUXPOS_PB03
#define ADC_INPUTCTRL_MUXPOS_PB03
Alias for PIN11.
Definition periph_cpu.h:130
ADC_INPUTCTRL_MUXPOS_PA06
#define ADC_INPUTCTRL_MUXPOS_PA06
Alias for PIN6.
Definition periph_cpu.h:125
ADC_INPUTCTRL_MUXPOS_PA02
#define ADC_INPUTCTRL_MUXPOS_PA02
ADC pin aliases.
Definition periph_cpu.h:119

Definition at line 159 of file periph_conf_common.h.

◆ i2c_config

const i2c_conf_t i2c_config[]
static
Initial value:
= {
{
.dev = &(SERCOM0->I2CM),
.speed = I2C_SPEED_NORMAL,
.scl_pin = GPIO_PIN(PA, 9),
.sda_pin = GPIO_PIN(PA, 8),
.mux = GPIO_MUX_C,
.gclk_src = SAM0_GCLK_MAIN,
.flags = I2C_FLAG_NONE
}
}
GPIO_PIN
#define GPIO_PIN(x, y)
Define a CPU specific GPIO pin generator macro.
Definition periph_cpu.h:46
I2C_SPEED_NORMAL
@ I2C_SPEED_NORMAL
normal mode: ~100 kbit/s
Definition periph_cpu.h:278
PA
@ PA
port A
Definition periph_cpu_common.h:99
I2C_FLAG_NONE
@ I2C_FLAG_NONE
No flags set.
Definition periph_cpu_common.h:520
GPIO_MUX_C
@ GPIO_MUX_C
select peripheral function C
Definition periph_cpu_common.h:246
SAM0_GCLK_MAIN
#define SAM0_GCLK_MAIN
120 MHz main clock
Definition periph_cpu.h:74

Definition at line 177 of file periph_conf_common.h.

◆ pwm_config

const pwm_conf_t pwm_config[]
static
Initial value:
= {
}

Definition at line 137 of file periph_conf_common.h.

◆ sam_usbdev_config

const sam0_common_usb_config_t sam_usbdev_config[]
static
Initial value:
= {
{
.dm = GPIO_PIN(PA, 24),
.dp = GPIO_PIN(PA, 25),
.d_mux = GPIO_MUX_G,
.device = &USB->DEVICE,
.gclk_src = SAM0_GCLK_MAIN,
}
}
GPIO_MUX_G
@ GPIO_MUX_G
select peripheral function G
Definition periph_cpu_common.h:250

Definition at line 204 of file periph_conf_common.h.

◆ timer_config

const tc32_conf_t timer_config[]
static
Initial value:
= {
{
.dev = TC3,
.irq = TC3_IRQn,
.pm_mask = PM_APBCMASK_TC3,
.gclk_ctrl = GCLK_CLKCTRL_ID_TCC2_TC3,
.gclk_src = SAM0_GCLK_MAIN,
.flags = TC_CTRLA_MODE_COUNT16,
},
{
.dev = TC4,
.irq = TC4_IRQn,
.pm_mask = PM_APBCMASK_TC4 | PM_APBCMASK_TC5,
.gclk_ctrl = GCLK_CLKCTRL_ID_TC4_TC5,
.gclk_src = SAM0_GCLK_MAIN,
.flags = TC_CTRLA_MODE_COUNT32,
}
}

Definition at line 85 of file periph_conf_common.h.