Hilscher netX microcontroller driver  V0.0.5.0
Documentation of the netX driver package
Data Fields
DRV_UART_CONFIGURATION_T Struct Reference
netX90 Application Side Drivers » UART

The configuration of the driver. More...

#include <netx_drv_uart.h>

Collaboration diagram for DRV_UART_CONFIGURATION_T:
Collaboration graph

Data Fields

DRV_UART_DEVICE_ID_E eDeviceID
 
DRV_OPERATION_MODE_E eOperationMode
 
DRV_UART_TX_MODE_MASK_E eTxMode
 
DRV_UART_BAUDRATE_E eBaudrate
 
DRV_UART_BAUDRATEMODE_E Baud_Rate_Mode
 
DRV_UART_WORD_LENGTH_E eWordLength
 
DRV_UART_LINE_CONTROL_MASK_E eLineControl
 
DRV_UART_LOOP_BACK_E eLoopBack
 
DRV_UART_RTS_CONTROL_MASK_E eRTSControl
 
DRV_UART_WATERMARK_E eTxFifoWatermark
 
DRV_UART_WATERMARK_E eRxFifoWatermark
 
DRV_DMAC_DEVICE_ID_E eDMATx
 
DRV_DMAC_DEVICE_ID_E eDMARx
 
DRV_DMAC_HANDLE_T * ptSequencerTx
 
DRV_DMAC_HANDLE_T * ptSequencerRx
 
DRV_CALLBACK_F fnRxTimeoutCallback
 
void * pRxTimeoutCallbackHandle
 
DRV_CALLBACK_F fnRxCompleteCallback
 
void * pRxCompleteCallbackHandle
 
DRV_CALLBACK_F fnTxCompleteCallback
 
void * pTxCompleteCallbackHandle
 
DRV_CALLBACK_F fnRxCallback
 
void * pRxCallbackHandle
 
uint32_t ulDriverTimeout
 

Detailed Description

The configuration of the driver.

The configuration SHALL be changed before initializing the device and shall not be changed afterwards.

Definition at line 192 of file netx_drv_uart.h.

Field Documentation

DRV_UART_BAUDRATEMODE_E DRV_UART_CONFIGURATION_T::Baud_Rate_Mode

Kind of baud div. 0: BAUDDIV = ( 100 MHz / (16 • BaudRate) ) – 1, 1: BAUDDIV = ( (Baud Rate • 16) / 100 MHz ) • 2^16.

Definition at line 198 of file netx_drv_uart.h.

DRV_UART_BAUDRATE_E DRV_UART_CONFIGURATION_T::eBaudrate

The baudrate to be used.

Definition at line 197 of file netx_drv_uart.h.

DRV_UART_DEVICE_ID_E DRV_UART_CONFIGURATION_T::eDeviceID

The device to be used

Definition at line 194 of file netx_drv_uart.h.

DRV_DMAC_DEVICE_ID_E DRV_UART_CONFIGURATION_T::eDMARx

The device id of the dmac to be used for rx.

Definition at line 209 of file netx_drv_uart.h.

DRV_DMAC_DEVICE_ID_E DRV_UART_CONFIGURATION_T::eDMATx

The device id of the dmac to be used for tx.

Definition at line 208 of file netx_drv_uart.h.

DRV_UART_LINE_CONTROL_MASK_E DRV_UART_CONFIGURATION_T::eLineControl

The line control options.

Definition at line 203 of file netx_drv_uart.h.

DRV_UART_LOOP_BACK_E DRV_UART_CONFIGURATION_T::eLoopBack

If a loopback will be performed.

Definition at line 204 of file netx_drv_uart.h.

DRV_OPERATION_MODE_E DRV_UART_CONFIGURATION_T::eOperationMode

Which programming method (DMA/IRQ/POLL) is used.

Definition at line 195 of file netx_drv_uart.h.

DRV_UART_RTS_CONTROL_MASK_E DRV_UART_CONFIGURATION_T::eRTSControl

The rts control options.

Definition at line 205 of file netx_drv_uart.h.

DRV_UART_WATERMARK_E DRV_UART_CONFIGURATION_T::eRxFifoWatermark

The receive fifo Watermark level.

Definition at line 207 of file netx_drv_uart.h.

DRV_UART_WATERMARK_E DRV_UART_CONFIGURATION_T::eTxFifoWatermark

The transmit fifo Watermark level.

Definition at line 206 of file netx_drv_uart.h.

DRV_UART_TX_MODE_MASK_E DRV_UART_CONFIGURATION_T::eTxMode

What mode is chosen.

Definition at line 196 of file netx_drv_uart.h.

DRV_UART_WORD_LENGTH_E DRV_UART_CONFIGURATION_T::eWordLength

The length of the words transmitted.

Definition at line 202 of file netx_drv_uart.h.

DRV_CALLBACK_F DRV_UART_CONFIGURATION_T::fnRxCallback

The callback used if the rx has received data, but no buffer is specified.

Definition at line 218 of file netx_drv_uart.h.

DRV_CALLBACK_F DRV_UART_CONFIGURATION_T::fnRxCompleteCallback

The callback used if transaction is completed.

Definition at line 214 of file netx_drv_uart.h.

DRV_CALLBACK_F DRV_UART_CONFIGURATION_T::fnRxTimeoutCallback

The callback used if the rx timeout event has occurred.

Definition at line 212 of file netx_drv_uart.h.

DRV_CALLBACK_F DRV_UART_CONFIGURATION_T::fnTxCompleteCallback

The callback used if transaction is completed.

Definition at line 216 of file netx_drv_uart.h.

void* DRV_UART_CONFIGURATION_T::pRxCallbackHandle

The handle associated with the rx callback.

Definition at line 219 of file netx_drv_uart.h.

void* DRV_UART_CONFIGURATION_T::pRxCompleteCallbackHandle

The handle associated with the complete callback.

Definition at line 215 of file netx_drv_uart.h.

void* DRV_UART_CONFIGURATION_T::pRxTimeoutCallbackHandle

The handle associated with the rx timeout callback.

Definition at line 213 of file netx_drv_uart.h.

DRV_DMAC_HANDLE_T* DRV_UART_CONFIGURATION_T::ptSequencerRx

The allocated and initialized to 0 handle of the rx dmac.

Definition at line 211 of file netx_drv_uart.h.

DRV_DMAC_HANDLE_T* DRV_UART_CONFIGURATION_T::ptSequencerTx

The allocated and initialized to 0 handle of the tx dmac.

Definition at line 210 of file netx_drv_uart.h.

void* DRV_UART_CONFIGURATION_T::pTxCompleteCallbackHandle

The handle associated with the complete callback.

Definition at line 217 of file netx_drv_uart.h.

uint32_t DRV_UART_CONFIGURATION_T::ulDriverTimeout

Timeout used in the driver for polling contexts.

Definition at line 220 of file netx_drv_uart.h.

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