Runtime state of the LPUART driver. More...

#include <platform/drivers/inc/lpuart_driver.h>

Data Fields

const uint8_t * txBuff
 
uint8_t * rxBuff
 
volatile uint32_t txSize
 
volatile uint32_t rxSize
 
volatile bool isTxBusy
 
volatile bool isRxBusy
 
volatile bool isTxBlocking
 
volatile bool isRxBlocking
 
lpuart_bit_count_per_char_t bitCountPerChar
 
uart_callback_t rxCallback
 
void * rxCallbackParam
 
uart_callback_t txCallback
 
void * txCallbackParam
 
lpuart_transfer_type_t transferType
 
uint8_t rxDMAChannel
 
uint8_t txDMAChannel
 
semaphore_t rxComplete
 
semaphore_t txComplete
 
volatile status_t transmitStatus
 
volatile status_t receiveStatus
 

Detailed Description

Runtime state of the LPUART driver.

Note that the caller provides memory for the driver state structures during initialization because the driver does not statically allocate memory.

Implements : lpuart_state_t_Class

Definition at line 92 of file lpuart_driver.h.

Field Documentation

lpuart_bit_count_per_char_t bitCountPerChar

number of bits in a char (8/9/10)

Definition at line 102 of file lpuart_driver.h.

volatile bool isRxBlocking

True if receive is blocking transaction.

Definition at line 101 of file lpuart_driver.h.

volatile bool isRxBusy

True if there is an active receive.

Definition at line 99 of file lpuart_driver.h.

volatile bool isTxBlocking

True if transmit is blocking transaction.

Definition at line 100 of file lpuart_driver.h.

volatile bool isTxBusy

True if there is an active transmit.

Definition at line 98 of file lpuart_driver.h.

volatile status_t receiveStatus

Status of last driver receive operation

Definition at line 123 of file lpuart_driver.h.

uint8_t* rxBuff

The buffer of received data.

Definition at line 95 of file lpuart_driver.h.

uart_callback_t rxCallback

Callback to invoke for data receive Note: when the transmission is interrupt based, the callback is being called upon receiving a byte; when DMA transmission is used, the bytes are copied to the rx buffer by the DMA engine and the callback is called when all the bytes have been transferred.

Definition at line 103 of file lpuart_driver.h.

void* rxCallbackParam

Receive callback parameter pointer.

Definition at line 108 of file lpuart_driver.h.

semaphore_t rxComplete

Synchronization object for blocking Rx timeout condition

Definition at line 120 of file lpuart_driver.h.

uint8_t rxDMAChannel

DMA channel number for DMA-based rx.

Definition at line 117 of file lpuart_driver.h.

volatile uint32_t rxSize

The remaining number of bytes to be received.

Definition at line 97 of file lpuart_driver.h.

lpuart_transfer_type_t transferType

Type of LPUART transfer (interrupt/dma based)

Definition at line 115 of file lpuart_driver.h.

volatile status_t transmitStatus

Status of last driver transmit operation

Definition at line 122 of file lpuart_driver.h.

const uint8_t* txBuff

The buffer of data being sent.

Definition at line 94 of file lpuart_driver.h.

uart_callback_t txCallback

Callback to invoke for data send Note: when the transmission is interrupt based, the callback is being called upon sending a byte; when DMA transmission is used, the bytes are copied to the tx buffer by the DMA engine and the callback is called when all the bytes have been transferred.

Definition at line 109 of file lpuart_driver.h.

void* txCallbackParam

Transmit callback parameter pointer.

Definition at line 114 of file lpuart_driver.h.

semaphore_t txComplete

Synchronization object for blocking Tx timeout condition

Definition at line 121 of file lpuart_driver.h.

uint8_t txDMAChannel

DMA channel number for DMA-based tx.

Definition at line 118 of file lpuart_driver.h.

volatile uint32_t txSize

The remaining number of bytes to be transmitted.

Definition at line 96 of file lpuart_driver.h.


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