Loading...
Searching...
No Matches
periph_cpu.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2015-2016 Freie Universität Berlin
3 * 2017 HAW Hamburg
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
22
23#include <stdint.h>
24#include <stdio.h>
25
26#include "vendor/hw_soc_adc.h"
27
28#include "cpu.h"
29#include "vendor/hw_ssi.h"
30#include "vendor/hw_uart.h"
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
39#define CPUID_ADDR (&IEEE_ADDR_MSWORD)
40
44#define CPUID_LEN (8U)
45
50#define HAVE_GPIO_T
51typedef uint32_t gpio_t;
53
58#define PM_NUM_MODES (5)
60
64#define GPIO_UNDEF (0xffffffff)
65
69#define GPIO_MUX_NONE (0xff)
76#define GPIO_PIN(port, pin) (gpio_t)(((uint32_t)GPIO_BASE + \
77 (port << GPIO_PORTNUM_SHIFT)) | pin)
78
86void gpio_init_af(gpio_t pin, uint8_t sel, uint8_t over);
87
96void gpio_init_mux(gpio_t pin, uint8_t over, uint8_t sel, uint8_t func);
97
102#define PERIPH_I2C_NEED_READ_REG
103#define PERIPH_I2C_NEED_READ_REGS
104#define PERIPH_I2C_NEED_WRITE_REG
105#define PERIPH_I2C_NEED_WRITE_REGS
107
108#ifndef DOXYGEN
113#define HAVE_I2C_SPEED_T
114typedef enum {
115 I2C_SPEED_LOW = 0x01,
116 I2C_SPEED_NORMAL = 100000U,
117 I2C_SPEED_FAST = 400000U,
118 I2C_SPEED_FAST_PLUS = 0x02,
119 I2C_SPEED_HIGH = 0x03,
122#endif /* ndef DOXYGEN */
123
127typedef struct {
128 i2c_speed_t speed;
129 gpio_t scl_pin;
130 gpio_t sda_pin;
131} i2c_conf_t;
132
137#define PERIPH_SPI_NEEDS_INIT_CS
138#define PERIPH_SPI_NEEDS_TRANSFER_BYTE
139#define PERIPH_SPI_NEEDS_TRANSFER_REG
140#define PERIPH_SPI_NEEDS_TRANSFER_REGS
142
143#ifndef DOXYGEN
148#define HAVE_GPIO_MODE_T
149typedef enum {
150 GPIO_IN = ((uint8_t)OVERRIDE_DISABLE),
151 GPIO_IN_ANALOG = ((uint8_t)OVERRIDE_ANALOG),
152 GPIO_IN_PD = ((uint8_t)OVERRIDE_PULLDOWN),
153 GPIO_IN_PU = ((uint8_t)OVERRIDE_PULLUP),
154 GPIO_OUT = ((uint8_t)OVERRIDE_ENABLE),
155 GPIO_OD = (0xfe),
156 GPIO_OD_PU = (0xff)
159#endif /* ndef DOXYGEN */
160
165typedef struct {
167 gpio_t rx_pin;
168 gpio_t tx_pin;
169#ifdef MODULE_PERIPH_UART_HW_FC
170 gpio_t cts_pin;
171 gpio_t rts_pin;
172#endif
175
176#ifndef DOXYGEN
181#define HAVE_UART_PARITY_T
182typedef enum {
183 UART_PARITY_NONE = 0,
184 UART_PARITY_EVEN = (UART_LCRH_PEN | UART_LCRH_EPS),
185 UART_PARITY_ODD = UART_LCRH_PEN,
186 UART_PARITY_MARK = (UART_LCRH_PEN | UART_LCRH_SPS),
187 UART_PARITY_SPACE = (UART_LCRH_PEN | UART_LCRH_EPS | UART_LCRH_SPS)
190
195#define HAVE_UART_DATA_BITS_T
196typedef enum {
197 UART_DATA_BITS_5 = (0 << UART_LCRH_WLEN_S),
198 UART_DATA_BITS_6 = (1 << UART_LCRH_WLEN_S),
199 UART_DATA_BITS_7 = (2 << UART_LCRH_WLEN_S),
200 UART_DATA_BITS_8 = (3 << UART_LCRH_WLEN_S),
203
208#define HAVE_UART_STOP_BITS_T
209typedef enum {
210 UART_STOP_BITS_1 = 0,
211 UART_STOP_BITS_2 = UART_LCRH_STP2,
214
218#ifndef UART_TXBUF_SIZE
219#define UART_TXBUF_SIZE (64)
220#endif
221
225#define SPI_CS_UNDEF (GPIO_UNDEF)
226
227#ifndef DOXYGEN
232#define HAVE_SPI_CS_T
233typedef uint32_t spi_cs_t;
235#endif
236
241#define HAVE_SPI_MODE_T
242typedef enum {
243 SPI_MODE_0 = 0,
244 SPI_MODE_1 = (SSI_CR0_SPH),
245 SPI_MODE_2 = (SSI_CR0_SPO),
246 SPI_MODE_3 = (SSI_CR0_SPO | SSI_CR0_SPH)
247} spi_mode_t;
249
254#define HAVE_SPI_CLK_T
255typedef enum {
256 SPI_CLK_100KHZ = 0,
257 SPI_CLK_400KHZ = 1,
258 SPI_CLK_1MHZ = 2,
259 SPI_CLK_5MHZ = 3,
260 SPI_CLK_10MHZ = 4
261} spi_clk_t;
263#endif /* ndef DOXYGEN */
264
268typedef struct {
269 uint8_t cpsr;
270 uint8_t scr;
272
273#ifndef BOARD_HAS_SPI_CLK_CONF
282 { .cpsr = 64, .scr = 4 }, /* 100khz */
283 { .cpsr = 16, .scr = 4 }, /* 400khz */
284 { .cpsr = 32, .scr = 0 }, /* 1.0MHz */
285 { .cpsr = 2, .scr = 2 }, /* 5.3MHz */
286 { .cpsr = 2, .scr = 1 } /* 8.0MHz */
287};
288#endif /* BOARD_HAS_SPI_CLK_CONF */
289
294typedef struct {
295 uint8_t num;
296 gpio_t mosi_pin;
297 gpio_t miso_pin;
298 gpio_t sck_pin;
300} spi_conf_t;
302
309typedef struct {
310 uint_fast8_t chn;
311 uint_fast8_t cfg;
313
314#ifndef DOXYGEN
319#define HAVE_ADC_RES_T
320typedef enum {
321 ADC_RES_6BIT = (0xa00),
322 ADC_RES_7BIT = (0 << 4),
323 ADC_RES_8BIT = (0xb00),
324 ADC_RES_9BIT = (1 << 4),
325 ADC_RES_10BIT = (2 << 4),
326 ADC_RES_12BIT = (3 << 4),
327 ADC_RES_14BIT = (0xc00),
328 ADC_RES_16BIT = (0xd00),
329} adc_res_t;
331#endif /* ndef DOXYGEN */
332
336typedef gpio_t adc_conf_t;
337
342#define SOC_ADC_ADCCON3_EREF_INT (0 << SOC_ADC_ADCCON3_EREF_S)
343#define SOC_ADC_ADCCON3_EREF_EXT (1 << SOC_ADC_ADCCON3_EREF_S)
344#define SOC_ADC_ADCCON3_EREF_AVDD5 (2 << SOC_ADC_ADCCON3_EREF_S)
345#define SOC_ADC_ADCCON3_EREF_DIFF (3 << SOC_ADC_ADCCON3_EREF_S)
347
352#define SOCADC_7_BIT_RSHIFT (9U)
353#define SOCADC_9_BIT_RSHIFT (7U)
354#define SOCADC_10_BIT_RSHIFT (6U)
355#define SOCADC_12_BIT_RSHIFT (4U)
357
362#define RTT_DEV SMWDTHROSC
363#define RTT_IRQ SM_TIMER_ALT_IRQn
364#define RTT_IRQ_PRIO 1
365#define RTT_ISR isr_sleepmode
366#define RTT_MAX_VALUE (0xffffffff)
367#define RTT_FREQUENCY (CLOCK_OSC32K)
368/* When setting a new compare value, the value must be at least 5 more
369 than the current sleep timer value. Otherwise, the timer compare
370 event may be lost. */
371#define RTT_MIN_OFFSET (5U)
373
378/* Limits are in clock cycles according to data sheet.
379 As the WDT is clocked by a 32 kHz clock and supports 4 intervals */
380#define NWDT_TIME_LOWER_LIMIT (2U)
381#define NWDT_TIME_UPPER_LIMIT (1000U)
383
384#ifdef __cplusplus
385}
386#endif
387
@ GPIO_OUT
select GPIO MASK as output
Definition periph_cpu.h:164
@ GPIO_IN
select GPIO MASK as input
Definition periph_cpu.h:163
i2c_speed_t
Definition periph_cpu.h:275
@ I2C_SPEED_NORMAL
normal mode: ~100 kbit/s
Definition periph_cpu.h:277
@ I2C_SPEED_FAST_PLUS
fast plus mode: ~1000 kbit/s
Definition periph_cpu.h:279
@ I2C_SPEED_LOW
low speed mode: ~10 kbit/s
Definition periph_cpu.h:276
@ I2C_SPEED_HIGH
high speed mode: ~3400 kbit/s
Definition periph_cpu.h:281
@ I2C_SPEED_FAST
fast mode: ~400 kbit/s
Definition periph_cpu.h:278
spi_clk_t
Definition periph_cpu.h:351
@ SPI_CLK_10MHZ
drive the SPI bus with 10MHz
Definition periph_cpu.h:356
@ SPI_CLK_5MHZ
drive the SPI bus with 5MHz
Definition periph_cpu.h:355
@ SPI_CLK_400KHZ
drive the SPI bus with 400KHz
Definition periph_cpu.h:353
@ SPI_CLK_1MHZ
drive the SPI bus with 1MHz
Definition periph_cpu.h:354
@ SPI_CLK_100KHZ
drive the SPI bus with 100KHz
Definition periph_cpu.h:352
void gpio_init_af(gpio_t pin, uint8_t sel, uint8_t over)
Configure an alternate function for the given pin.
void gpio_init_mux(gpio_t pin, uint8_t over, uint8_t sel, uint8_t func)
Configure an alternate function for the given pin.
static const spi_clk_conf_t spi_clk_config[]
Pre-calculated clock divider values based on a CLOCK_CORECLOCK (32MHz)
Definition periph_cpu.h:281
gpio_mode_t
Available pin modes.
Definition periph_cpu.h:91
adc_res_t
Possible ADC resolution settings.
Definition adc.h:92
@ ADC_RES_16BIT
ADC resolution: 16 bit.
Definition adc.h:98
@ ADC_RES_8BIT
ADC resolution: 8 bit.
Definition adc.h:94
@ ADC_RES_14BIT
ADC resolution: 14 bit.
Definition adc.h:97
@ ADC_RES_6BIT
ADC resolution: 6 bit.
Definition adc.h:93
@ ADC_RES_10BIT
ADC resolution: 10 bit.
Definition adc.h:95
@ ADC_RES_12BIT
ADC resolution: 12 bit.
Definition adc.h:96
gpio_t spi_cs_t
Chip select pin type overlaps with gpio_t so it can be casted to this.
Definition spi.h:135
spi_mode_t
Support SPI modes.
Definition periph_cpu.h:42
@ SPI_MODE_0
CPOL=0, CPHA=0.
Definition periph_cpu.h:43
@ SPI_MODE_2
CPOL=1, CPHA=0.
Definition periph_cpu.h:45
@ SPI_MODE_1
CPOL=0, CPHA=1.
Definition periph_cpu.h:44
@ SPI_MODE_3
CPOL=1, CPHA=1.
Definition periph_cpu.h:46
uart_parity_t
Definition of possible parity modes.
Definition periph_cpu.h:501
@ UART_PARITY_SPACE
space parity
Definition periph_cpu.h:506
@ UART_PARITY_NONE
no parity
Definition periph_cpu.h:502
@ UART_PARITY_EVEN
even parity
Definition periph_cpu.h:503
@ UART_PARITY_ODD
odd parity
Definition periph_cpu.h:504
@ UART_PARITY_MARK
mark parity
Definition periph_cpu.h:505
uart_stop_bits_t
Definition of possible stop bits lengths.
Definition periph_cpu.h:533
@ UART_STOP_BITS_2
2 stop bits
Definition periph_cpu.h:535
@ UART_STOP_BITS_1
1 stop bit
Definition periph_cpu.h:534
uart_data_bits_t
Definition of possible data bits lengths in a UART frame.
Definition periph_cpu.h:517
@ UART_DATA_BITS_6
6 data bits
Definition periph_cpu.h:519
@ UART_DATA_BITS_5
5 data bits
Definition periph_cpu.h:518
@ UART_DATA_BITS_7
7 data bits
Definition periph_cpu.h:520
@ UART_DATA_BITS_8
8 data bits
Definition periph_cpu.h:521
ADC device configuration.
Definition periph_cpu.h:377
UART component registers.
Definition cc2538_uart.h:31
I2C configuration structure.
Definition periph_cpu.h:298
Datafields for static SPI clock configuration values.
Definition periph_cpu.h:268
uint8_t cpsr
CPSR clock divider.
Definition periph_cpu.h:269
uint8_t scr
SCR clock divider.
Definition periph_cpu.h:270
SPI device configuration.
Definition periph_cpu.h:336
gpio_t miso_pin
pin used for MISO
Definition periph_cpu.h:340
uint8_t num
number of SSI device, i.e.
Definition periph_cpu.h:295
gpio_t mosi_pin
pin used for MOSI
Definition periph_cpu.h:341
spi_cs_t cs_pin
pin used for CS
Definition periph_cpu.h:299
gpio_t sck_pin
pin used for SCK
Definition periph_cpu.h:339
Timer device configuration.
Definition periph_cpu.h:263
uint_fast8_t cfg
timer config word
Definition periph_cpu.h:311
uint_fast8_t chn
number of channels
Definition periph_cpu.h:310
UART device configuration.
Definition periph_cpu.h:217
USART_t * dev
pointer to the used UART device
Definition periph_cpu.h:218
gpio_t tx_pin
pin used for TX
Definition periph_cpu.h:221
gpio_t rx_pin
pin used for RX
Definition periph_cpu.h:220