uart.h File Reference

arch independent UART (Universal Asynchronous Receiver/Transmitter) API More...

#include "mcu_periph/uart_arch.h"
#include "pprzlink/pprzlink_device.h"
#include "std.h"

Include dependency graph for uart.h:

Go to the source code of this file.

Data Structures
struct	uart_periph
	UART peripheral. More...

Macros
#define	UART_RX_BUFFER_SIZE   128
#define	UART_TX_BUFFER_SIZE   128
#define	UART_DEV_NAME_SIZE   16
#define	UBITS_7   7
#define	UBITS_8   8
#define	USTOP_1   1
#define	USTOP_2   2
#define	UPARITY_NO   0
#define	UPARITY_ODD   1
#define	UPARITY_EVEN   2

Functions
void	uart_periph_init (struct uart_periph *p)
void	uart_periph_set_baudrate (struct uart_periph *p, uint32_t baud)
	Set baudrate. More...
void	uart_periph_set_bits_stop_parity (struct uart_periph *p, uint8_t bits, uint8_t stop, uint8_t parity)
	Set parity and stop bits. More...
void	uart_periph_set_mode (struct uart_periph *p, bool tx_enabled, bool rx_enabled, bool hw_flow_control)
	Set mode (not necessary, or can be set by SerialConfig) More...
void	uart_put_byte (struct uart_periph *p, long fd, uint8_t data)
	Uart transmit implementation. More...
void	uart_put_buffer (struct uart_periph *p, long fd, const uint8_t *data, uint16_t len)
	Uart transmit buffer implementation. More...
bool	uart_check_free_space (struct uart_periph *p, long *fd, uint16_t len)
void	uart_send_message (struct uart_periph *p, long fd)
uint8_t	uart_getch (struct uart_periph *p)
uint16_t	uart_char_available (struct uart_periph *p)
	Check UART for available chars in receive buffer. More...
void	uart_arch_init (void)

Detailed Description

arch independent UART (Universal Asynchronous Receiver/Transmitter) API

Definition in file uart.h.

---

Data Structure Documentation

struct uart_periph

UART peripheral.

Definition at line 70 of file uart.h.

Collaboration diagram for uart_periph:

Data Fields
int	baudrate	UART Baudrate.
char	dev[UART_DEV_NAME_SIZE]	UART Dev (linux)
struct link_device	device	Generic device interface.
volatile uint16_t	fe_err	framing error counter
void *	init_struct	User init struct.
volatile uint16_t	ne_err	noise error counter
volatile uint16_t	ore	overrun error counter
void *	reg_addr	UART Register.
uint8_t	rx_buf[UART_RX_BUFFER_SIZE]	Receive buffer.
uint16_t	rx_extract_idx
uint16_t	rx_insert_idx
uint8_t	tx_buf[UART_TX_BUFFER_SIZE]	Transmit buffer.
uint16_t	tx_extract_idx
uint16_t	tx_insert_idx
volatile uint8_t	tx_running

Macro Definition Documentation

#define UART_DEV_NAME_SIZE   16

Definition at line 51 of file uart.h.

#define UART_RX_BUFFER_SIZE   128

Definition at line 39 of file uart.h.

#define UART_TX_BUFFER_SIZE   128

Definition at line 47 of file uart.h.

#define UBITS_7   7

Definition at line 57 of file uart.h.

Referenced by uart_periph_set_bits_stop_parity().

#define UBITS_8   8

Definition at line 58 of file uart.h.

Referenced by sbus_common_init().

#define UPARITY_EVEN   2

Definition at line 65 of file uart.h.

Referenced by sbus_common_init(), and uart_periph_set_bits_stop_parity().

#define UPARITY_NO   0

Definition at line 63 of file uart.h.

#define UPARITY_ODD   1

Definition at line 64 of file uart.h.

Referenced by uart_periph_set_bits_stop_parity().

#define USTOP_1   1

Definition at line 60 of file uart.h.

#define USTOP_2   2

Definition at line 61 of file uart.h.

Referenced by sbus_common_init(), and uart_periph_set_bits_stop_parity().

Function Documentation

void uart_arch_init

(

void

)

Definition at line 54 of file uart_arch.c.

References uart_thread().

Referenced by mcu_init().

Here is the call graph for this function:

Here is the caller graph for this function:

uint16_t uart_char_available

(

struct uart_periph *

p

)

Check UART for available chars in receive buffer.

Returns

number of chars in the buffer

Definition at line 296 of file uart_arch.c.

References uart_periph::rx_extract_idx, uart_periph::rx_insert_idx, and UART_RX_BUFFER_SIZE.

Referenced by airspeed_uADC_event(), esc32_event(), gps_piksi_event(), gps_piksi_read(), high_speed_logger_direct_memory_periodic(), hott_check_serial_data(), hott_send_telemetry_data(), imu_gx3_event(), imu_um6_event(), ReadGX3Buffer(), sbus_common_decode_event(), tunnel_event(), uart_periph_init(), vn200_event(), and vn200_read_buffer().

Here is the caller graph for this function:

bool uart_check_free_space	(	struct uart_periph *	p,
		long *	fd,
		uint16_t	len
	)

Definition at line 899 of file uart_arch.c.

References uart_periph::init_struct, uart_periph::tx_extract_idx, uart_periph::tx_insert_idx, SerialInit::tx_mtx, and UART_TX_BUFFER_SIZE.

Referenced by sdlogger_spi_direct_periodic(), send_buffer_to_uart(), tunnel_event(), and uart_periph_init().

Here is the caller graph for this function:

uint8_t uart_getch

(

struct uart_periph *

p

)

Definition at line 822 of file uart_arch.c.

References uart_periph::init_struct, uart_periph::rx_buf, uart_periph::rx_extract_idx, SerialInit::rx_mtx, and UART_RX_BUFFER_SIZE.

Referenced by airspeed_uADC_event(), esc32_event(), gps_piksi_read(), high_speed_logger_direct_memory_periodic(), hott_check_serial_data(), hott_send_telemetry_data(), imu_um6_event(), ReadGX3Buffer(), sbus_common_decode_event(), tunnel_event(), uart_periph_init(), and vn200_read_buffer().

Here is the caller graph for this function:

void uart_periph_init

(

struct uart_periph *

p

)

Definition at line 231 of file uart.c.

References DefaultPeriodic, uart_periph::device, uart_periph::fe_err, uart_periph::ne_err, uart_periph::ore, register_periodic_telemetry(), uart_periph::rx_extract_idx, uart_periph::rx_insert_idx, send_uart_err(), uart_periph::tx_extract_idx, uart_periph::tx_insert_idx, uart_periph::tx_running, uart_char_available(), uart_check_free_space(), uart_getch(), uart_periph_set_baudrate(), uart_put_buffer(), uart_put_byte(), and uart_send_message().

Referenced by high_speed_logger_direct_memory_init().

Here is the call graph for this function:

Here is the caller graph for this function:

void uart_periph_set_baudrate	(	struct uart_periph *	p,
		uint32_t	baud
	)

Set baudrate.

Definition at line 838 of file uart_arch.c.

References uart_periph::baudrate, SerialInit::conf, uart_periph::dev, uart_periph::init_struct, uart_periph::reg_addr, serial_port_close(), serial_port_free(), serial_port_new(), serial_port_open_raw(), TRACE, uart_disable_interrupts(), uart_enable_interrupts(), and uart_set_baudrate().

Referenced by gps_ubx_ucenter_autobaud(), gps_ubx_ucenter_configure(), px4flash_event(), sbus_common_init(), and uart_periph_init().

Here is the call graph for this function:

Here is the caller graph for this function:

void uart_periph_set_bits_stop_parity	(	struct uart_periph *	p,
		uint8_t	bits,
		uint8_t	stop,
		uint8_t	parity
	)

Set parity and stop bits.

Definition at line 858 of file uart_arch.c.

References SerialInit::conf, uart_periph::init_struct, uart_periph::reg_addr, UBITS_7, UPARITY_EVEN, UPARITY_ODD, and USTOP_2.

Referenced by high_speed_logger_direct_memory_init(), and sbus_common_init().

Here is the caller graph for this function:

void uart_periph_set_mode	(	struct uart_periph *	p,
		bool	tx_enabled,
		bool	rx_enabled,
		bool	hw_flow_control
	)

Set mode (not necessary, or can be set by SerialConfig)

Definition at line 852 of file uart_arch.c.

References uart_periph::reg_addr.

Referenced by hott_enable_receiver(), and hott_enable_transmitter().

Here is the caller graph for this function:

void uart_put_buffer	(	struct uart_periph *	p,
		long	fd,
		const uint8_t *	data,
		uint16_t	len
	)

Uart transmit buffer implementation.

Definition at line 945 of file uart_arch.c.

References uart_periph::init_struct, uart_periph::tx_buf, uart_periph::tx_extract_idx, uart_periph::tx_insert_idx, SerialInit::tx_mtx, SerialInit::tx_sem, uart_put_byte(), and UART_TX_BUFFER_SIZE.

Referenced by uart_periph_init().

Here is the call graph for this function:

Here is the caller graph for this function:

void uart_put_byte	(	struct uart_periph *	p,
		long	fd,
		uint8_t	data
	)

Uart transmit implementation.

Definition at line 917 of file uart_arch.c.

References disableIRQ(), SerialPort::fd, uart_periph::init_struct, uart_periph::reg_addr, restoreIRQ(), TRACE, uart_periph::tx_buf, uart_periph::tx_extract_idx, uart_periph::tx_insert_idx, SerialInit::tx_mtx, uart_periph::tx_running, SerialInit::tx_sem, UART_TX_BUFFER_SIZE, and UIER_ETBEI.

Referenced by ahrs_gx3_align(), direct_memory_logger_periodic(), drop_ball(), esc32_periodic(), esc32_send(), gps_piksi_write(), hott_send_telemetry_data(), imu_gx3_init(), sdlogger_spi_direct_periodic(), send_buffer_to_uart(), tunnel_event(), uart_periph_init(), uart_put_buffer(), and UM6_send_packet().

Here is the call graph for this function:

Here is the caller graph for this function:

void uart_send_message	(	struct uart_periph *	p,
		long	fd
	)

Definition at line 975 of file uart_arch.c.

References uart_periph::init_struct, SerialInit::tx_mtx, and SerialInit::tx_sem.

Referenced by uart_periph_init().

Here is the caller graph for this function: