Loading...
Searching...
No Matches
uart.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2014-2015 Freie Universit├Ąt Berlin
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
58#ifndef PERIPH_UART_H
59#define PERIPH_UART_H
60
61#include <errno.h>
62#include <limits.h>
63#include <stddef.h>
64#include <stdint.h>
65
66#include "periph_cpu.h"
67#include "periph_conf.h"
68
69#ifdef __cplusplus
70extern "C" {
71#endif
72
77#ifndef CONFIG_UART_DMA_THRESHOLD_BYTES
78#define CONFIG_UART_DMA_THRESHOLD_BYTES 8
79#endif
80
84#ifndef HAVE_UART_T
85typedef uint_fast8_t uart_t;
86#endif
87
91#ifndef UART_UNDEF
92#define UART_UNDEF (UINT_FAST8_MAX)
93#endif
94
98#ifndef UART_DEV
99#define UART_DEV(x) (x)
100#endif
101
108typedef void(*uart_rx_cb_t)(void *arg, uint8_t data);
109
115typedef void(*uart_rxstart_cb_t)(void *arg);
116
120#ifndef HAVE_UART_ISR_CTX_T
121typedef struct {
123 void *arg;
124#ifdef MODULE_PERIPH_UART_RXSTART_IRQ
125 uart_rxstart_cb_t rxs_cb;
126 void *rxs_arg;
127#endif
129#endif
130
136enum {
142};
143
147#ifndef HAVE_UART_PARITY_T
155#endif
156
160#ifndef HAVE_UART_DATA_BITS_T
167#endif
168
172#ifndef HAVE_UART_STOP_BITS_T
177#endif
178
203int uart_init(uart_t uart, uint32_t baud, uart_rx_cb_t rx_cb, void *arg);
204
205#if defined(MODULE_PERIPH_UART_RECONFIGURE) || DOXYGEN
222
239
240#if DOXYGEN
251gpio_t uart_pin_rx(uart_t uart);
252
263gpio_t uart_pin_tx(uart_t uart);
264
265#endif /* DOXYGEN */
266
277gpio_t uart_pin_cts(uart_t uart);
278
289gpio_t uart_pin_rts(uart_t uart);
290
291#endif /* MODULE_PERIPH_UART_RECONFIGURE */
292
293#if defined(MODULE_PERIPH_UART_RXSTART_IRQ) || DOXYGEN
294
310
320
330#endif /* MODULE_PERIPH_UART_RXSTART_IRQ */
331
332#if defined(MODULE_PERIPH_UART_COLLISION) || DOXYGEN
358
372#endif /* MODULE_PERIPH_UART_COLLISION */
373
386int uart_mode(uart_t uart, uart_data_bits_t data_bits, uart_parity_t parity,
387 uart_stop_bits_t stop_bits);
388
401void uart_write(uart_t uart, const uint8_t *data, size_t len);
402
409
416
425
434
435#ifdef __cplusplus
436}
437#endif
438
439#endif /* PERIPH_UART_H */
#define EIO
I/O error.
Definition errno.h:98
#define ENOTSUP
Not supported (may be the same value as [EOPNOTSUPP]).
Definition errno.h:130
#define ENODEV
No such device.
Definition errno.h:113
void uart_enable_tx(uart_t uart)
Enable the TX line one the given UART.
void uart_poweroff(uart_t uart)
Power off the given UART device.
void uart_rxstart_irq_configure(uart_t uart, uart_rxstart_cb_t cb, void *arg)
Configure the function that will be called when a start condition is detected.
void uart_deinit_pins(uart_t uart)
Change the pins of the given UART back to plain GPIO functionality.
void(* uart_rxstart_cb_t)(void *arg)
Signature for receive start condition interrupt callback.
Definition uart.h:115
void uart_collision_detect_enable(uart_t uart)
Enables collision detection check of the UART.
int uart_init(uart_t uart, uint32_t baud, uart_rx_cb_t rx_cb, void *arg)
Initialize a given UART device.
void uart_disable_tx(uart_t uart)
Disable the TX line one the given UART.
void uart_rxstart_irq_disable(uart_t uart)
Disable the RX start interrupt.
uart_parity_t
Definition of possible parity modes.
Definition uart.h:148
uart_stop_bits_t
Definition of possible stop bits lengths in a UART frame.
Definition uart.h:173
uint_fast8_t uart_t
Define default UART type identifier.
Definition uart.h:85
void uart_poweron(uart_t uart)
Power on the given UART device.
bool uart_collision_detected(uart_t uart)
Disables collision detection check of the UART.
gpio_t uart_pin_tx(uart_t uart)
Get the TX pin of the given UART.
gpio_t uart_pin_cts(uart_t uart)
Get the CTS pin of the given UART.
void uart_init_pins(uart_t uart)
Initialize the used UART pins, i.e.
void(* uart_rx_cb_t)(void *arg, uint8_t data)
Signature for receive interrupt callback.
Definition uart.h:108
void uart_rxstart_irq_enable(uart_t uart)
Enable the RX start interrupt.
gpio_t uart_pin_rts(uart_t uart)
Get the RTS pin of the given UART.
gpio_t uart_pin_rx(uart_t uart)
Get the RX pin of the given UART.
uart_data_bits_t
Definition of possible data bits lengths in a UART frame.
Definition uart.h:161
void uart_write(uart_t uart, const uint8_t *data, size_t len)
Write data from the given buffer to the specified UART device.
int uart_mode(uart_t uart, uart_data_bits_t data_bits, uart_parity_t parity, uart_stop_bits_t stop_bits)
Setup parity, data and stop bits for a given UART device.
void uart_collision_detect_disable(uart_t uart)
Disables collision detection check of the UART.
@ UART_PARITY_SPACE
space parity
Definition uart.h:153
@ UART_PARITY_NONE
no parity
Definition uart.h:149
@ UART_PARITY_EVEN
even parity
Definition uart.h:150
@ UART_PARITY_ODD
odd parity
Definition uart.h:151
@ UART_PARITY_MARK
mark parity
Definition uart.h:152
@ UART_STOP_BITS_2
2 stop bits
Definition uart.h:175
@ UART_STOP_BITS_1
1 stop bit
Definition uart.h:174
@ UART_NOBAUD
given symbol rate is not applicable
Definition uart.h:139
@ UART_OK
everything in order
Definition uart.h:137
@ UART_NODEV
invalid UART device given
Definition uart.h:138
@ UART_INTERR
all other internal errors
Definition uart.h:141
@ UART_NOMODE
given mode is not applicable
Definition uart.h:140
@ UART_DATA_BITS_6
6 data bits
Definition uart.h:163
@ UART_DATA_BITS_5
5 data bits
Definition uart.h:162
@ UART_DATA_BITS_7
7 data bits
Definition uart.h:164
@ UART_DATA_BITS_8
8 data bits
Definition uart.h:165
uart_parity_t
Definition of possible parity modes.
Definition periph_cpu.h:502
uart_stop_bits_t
Definition of possible stop bits lengths.
Definition periph_cpu.h:534
uart_data_bits_t
Definition of possible data bits lengths in a UART frame.
Definition periph_cpu.h:518
Interrupt context for a UART device.
Definition uart.h:121
uart_rx_cb_t rx_cb
data received interrupt callback
Definition uart.h:122
void * arg
argument to data received callback
Definition uart.h:123