HAL_UartDescriptor_t Struct Reference

Uart descriptor. More...

#include <uart.h>

Data Fields
uint8_t	tty
	tty - One of the defines UART_CHANNEL_0 or UART_CHANNEL_1. Defines a number of UART.
UartMode_t	mode
	Sets synchronous or asynchronous routine. Must be chosen from: ASYNC SYNC .
UartBaudRate_t	baudrate
	baudrate - UART baud rate. Must be chosen from: UART_BAUDRATE_1200 UART_BAUDRATE_9600 UART_BAUDRATE_19200 UART_BAUDRATE_38400 UART_SYNC_BAUDRATE_1200 UART_SYNC_BAUDRATE_9600 UART_SYNC_BAUDRATE_38400 UART_SYNC_BAUDRATE_57600 UART_SYNC_BAUDRATE_115200
UartData_t	dataLength
	data - UART data length. Must be chosen from: UART_DATA5 UART_DATA6 UART_DATA7 UART_DATA8
UartParity_t	parity
	parity - UART parity mode. Must be chosen from: UART_PARITY_NONE UART_PARITY_EVEN UART_PARITY_ODD
UartStopBits_t	stopbits
	stopbits - UART stop bits number. Must be chosen from: UART_STOPBIT_1 UART_STOPBIT_2
UartSyncMode_t	edge
	edge - data received edge (only for usart). Must be chosen from: RISING_EDGE FALLING_EDGE
UartClckMode_t	syncMode
	master or slave on usart (only for usart)
uint8_t *	rxBuffer
	Pointer to receive buffer. If rxBuffer is NULL then transactions are discarded. Size of buffer depends on user application.
uint16_t	rxBufferLength
	length of receive buffer
uint8_t *	txBuffer
	Pointer to transmit buffer. If txBuffer is NULL then callback method is used. If txBuffer is not NULL then polling method is used.
uint16_t	txBufferLength
	length of transmit buffer
void(*	rxCallback )(uint8_t)
	Receive uart callback. If rxCallback is NULL then polling method is used. If rxCallback is not NULL then callback method is used.
void(*	txCallback )()
	Transmission complete uart callback. If txBuffer is not NULL then txCallback notify about end of bytes sending.
uint8_t	flowControl
	flow control of uart. One of the defines UART_FLOW_CONTROL_NONE, UART_FLOW_CONTROL_HARDWARE, UART_DTR_CONTROL, probably combined by logical OR.

---

Detailed Description

Uart descriptor.

Definition at line 39 of file uart.h.

---

Field Documentation

uint8_t HAL_UartDescriptor_t::tty

tty - One of the defines UART_CHANNEL_0 or UART_CHANNEL_1. Defines a number of UART.

Definition at line 43 of file uart.h.

UartMode_t HAL_UartDescriptor_t::mode

Sets synchronous or asynchronous routine.
Must be chosen from:
ASYNC
SYNC
.

Definition at line 48 of file uart.h.

UartBaudRate_t HAL_UartDescriptor_t::baudrate

baudrate - UART baud rate. Must be chosen from:
UART_BAUDRATE_1200
UART_BAUDRATE_9600
UART_BAUDRATE_19200
UART_BAUDRATE_38400
UART_SYNC_BAUDRATE_1200
UART_SYNC_BAUDRATE_9600
UART_SYNC_BAUDRATE_38400
UART_SYNC_BAUDRATE_57600
UART_SYNC_BAUDRATE_115200

Definition at line 59 of file uart.h.

UartData_t HAL_UartDescriptor_t::dataLength

data - UART data length. Must be chosen from:
UART_DATA5
UART_DATA6
UART_DATA7
UART_DATA8

Definition at line 65 of file uart.h.

UartParity_t HAL_UartDescriptor_t::parity

parity - UART parity mode. Must be chosen from:
UART_PARITY_NONE
UART_PARITY_EVEN
UART_PARITY_ODD

Definition at line 70 of file uart.h.

UartStopBits_t HAL_UartDescriptor_t::stopbits

stopbits - UART stop bits number. Must be chosen from:
UART_STOPBIT_1
UART_STOPBIT_2

Definition at line 74 of file uart.h.

UartSyncMode_t HAL_UartDescriptor_t::edge

edge - data received edge (only for usart). Must be chosen from:
RISING_EDGE
FALLING_EDGE

Definition at line 78 of file uart.h.

UartClckMode_t HAL_UartDescriptor_t::syncMode

master or slave on usart (only for usart)

Definition at line 80 of file uart.h.

uint8_t* HAL_UartDescriptor_t::rxBuffer

Pointer to receive buffer.
If rxBuffer is NULL then transactions are discarded.
Size of buffer depends on user application.

Definition at line 84 of file uart.h.

uint16_t HAL_UartDescriptor_t::rxBufferLength

length of receive buffer

Definition at line 86 of file uart.h.

uint8_t* HAL_UartDescriptor_t::txBuffer

Pointer to transmit buffer.
If txBuffer is NULL then callback method is used.
If txBuffer is not NULL then polling method is used.

Definition at line 90 of file uart.h.

uint16_t HAL_UartDescriptor_t::txBufferLength

length of transmit buffer

Definition at line 92 of file uart.h.

void(* HAL_UartDescriptor_t::rxCallback)(uint8_t)

Receive uart callback.
If rxCallback is NULL then polling method is used.
If rxCallback is not NULL then callback method is used.

void(* HAL_UartDescriptor_t::txCallback)()

Transmission complete uart callback.
If txBuffer is not NULL then txCallback notify about end of bytes sending.

uint8_t HAL_UartDescriptor_t::flowControl

flow control of uart. One of the defines UART_FLOW_CONTROL_NONE, UART_FLOW_CONTROL_HARDWARE, UART_DTR_CONTROL, probably combined by logical OR.

Definition at line 101 of file uart.h.

---

The documentation for this struct was generated from the following file:

• uart.h

---