4.26.2 EUSART - Enhanced USART

• struct eusart_status_t

• void EUSART_Initialize (void)

  This API initializes the EUSART driver. This routine initializes the EUSART module. This is the first called EUSART routine, and it must only be called during the system initialization.

• void EUSART_Deinitialize (void)

  This API disables the EUSART driver. This routine disables the EUSART module.

• void EUSART_Enable (void)

  This API enables the EUSART module.  

• void EUSART_Disable (void)

  This API disables the EUSART module.

• void EUSART_TransmitEnable (void)

  This API enables the EUSART transmitter. The EUSART must be enabled to sent the bytes over to the TX pin.

• void EUSART_TransmitDisable (void)

  This API disables the EUSART transmitter.

• void EUSART_ReceiveEnable (void)

  This API enables the EUSART receiver. The EUSART must be enabled to receive the bytes sent by the RX pin.

• void EUSART_ReceiveDisable (void)

  This API disables the EUSART receiver.

• void EUSART_TransmitInterruptEnable (void)

  This API enables the EUSART transmitter interrupt.

• void EUSART_TransmitInterruptDisable (void)

  This API disables the EUSART transmitter interrupt.

• void EUSART_ReceiveInterruptEnable (void)

  This API enables the EUSART receiver interrupt.

• void EUSART_ReceiveInterruptDisable (void)

  This API disables the EUSART receiver interrupt.

• void EUSART_SendBreakControlEnable (void)

  This API enables the EUSART to send a break control.

• void EUSART_SendBreakControlDisable (void)

  This API disables the EUSART send break control.

• void EUSART_AutoBaudSet (bool enable)

  This API enables the EUSART AutoBaud Detection (ABR).

• bool EUSART_AutoBaudQuery (void)

  This API reads the EUSART ABR Complete bit.

• bool EUSART_IsAutoBaudDetectOverflow (void)

  This API reads the EUSART ABR Overflow bit.

• void EUSART_AutoBaudDetectOverflowReset (void)

  This API resets the EUSART ABR Overflow bit.

• bool EUSART_IsRxReady (void)

  This API checks if the EUSART has received available data.

• bool EUSART_IsTxReady (void)

  This function checks if the EUSART transmitter is ready to accept a data byte.

• bool EUSART_IsTxDone (void)

  This function returns the status of Transmit Shift Register (TSR).

• size_t EUSART_ErrorGet (void)

  This function receives the error status of the last read byte.

• uint8_t EUSART_Read (void)

  This function reads the 8 bits from the FIFO register receiver.

• void EUSART_Write (uint8_t txData)

  This function writes a byte of data to the transmitter FIFO register.

• void EUSART_FramingErrorCallbackRegister (void(*callbackHandler)(void))

  This API registers the function to be called upon framing error.

• void EUSART_OverrunErrorCallbackRegister (void(*callbackHandler)(void))

  This API registers the function to be called upon overrun error.

• void EUSART_TxCompleteCallbackRegister (void(*callbackHandler)(void))

  This API registers the function to be called upon Transmitter interrupt.

• void EUSART_TransmitISR (void)

  This ISR function is called upon transmitter interrupt.

• void EUSART_RxCompleteCallbackRegister (void(*callbackHandler)(void))

  This API registers the function to be called upon receiver interrupt.

• void EUSART_ReceiveISR (void)

  This ISR function is called upon receiver interrupt.

• const uart_drv_interface_t UART1

  External object for eusart_interface.

• void(* EUSART_TxInterruptHandler )(void)

  This indicates the function that will be called upon transmit interrupt.

• void(* EUSART_RxInterruptHandler )(void)

  This indicates the function that will be called upon receive interrupt.

void EUSART_AutoBaudDetectOverflowReset (void )[inline]

This API resets the EUSART ABR Overflow bit.

bool EUSART_AutoBaudQuery (void )[inline]

This API reads the EUSART ABR Complete bit.

void EUSART_AutoBaudSet (bool enable)[inline]

This API enables the EUSART AutoBaud Detection (ABR).

void EUSART_Deinitialize (void )

This API disables the EUSART driver. This routine disables the EUSART module.

void EUSART_Disable (void )[inline]

This API disables the EUSART module.

void EUSART_Enable (void )[inline]

This API enables the EUSART module.  

size_t EUSART_ErrorGet (void )

This function receives the error status of the last read byte.

void EUSART_FramingErrorCallbackRegister (void(*)(void) callbackHandler)

This API registers the function to be called upon framing error.

void EUSART_Initialize (void )

This API initializes the EUSART driver. This routine initializes the EUSART module. This is the first called EUSART routine, and it must only be called during the system initialization.

Section: EUSART APIs

bool EUSART_IsAutoBaudDetectOverflow (void )[inline]

This API reads the EUSART ABR Overflow bit.

bool EUSART_IsRxReady (void )

This API checks if the EUSART has received available data.

bool EUSART_IsTxDone (void )

This function returns the status of Transmit Shift Register (TSR).

bool EUSART_IsTxReady (void )

This function checks if the EUSART transmitter is ready to accept a data byte.

void EUSART_OverrunErrorCallbackRegister (void(*)(void) callbackHandler)

This API registers the function to be called upon overrun error.

uint8_t EUSART_Read (void )

This function reads the 8 bits from the FIFO register receiver.

void EUSART_ReceiveDisable (void )[inline]

This API disables the EUSART receiver.

void EUSART_ReceiveEnable (void )[inline]

This API enables the EUSART receiver. The EUSART must be enabled to receive the bytes sent by the RX pin.

void EUSART_ReceiveInterruptDisable (void )[inline]

This API disables the EUSART receiver interrupt.

void EUSART_ReceiveInterruptEnable (void )[inline]

This API enables the EUSART receiver interrupt.

void EUSART_ReceiveISR (void )

This ISR function is called upon receiver interrupt.

void EUSART_RxCompleteCallbackRegister (void(*)(void) callbackHandler)

This API registers the function to be called upon receiver interrupt.

void EUSART_SendBreakControlDisable (void )[inline]

This API disables the EUSART send break control.

void EUSART_SendBreakControlEnable (void )[inline]

This API enables the EUSART to send a break control.

void EUSART_TransmitDisable (void )[inline]

This API disables the EUSART transmitter.

void EUSART_TransmitEnable (void )[inline]

This API enables the EUSART transmitter. The EUSART must be enabled to sent the bytes over to the TX pin.

void EUSART_TransmitInterruptDisable (void )[inline]

This API disables the EUSART transmitter interrupt.

void EUSART_TransmitInterruptEnable (void )[inline]

This API enables the EUSART transmitter interrupt.

void EUSART_TransmitISR (void )

This ISR function is called upon transmitter interrupt.

void EUSART_TxCompleteCallbackRegister (void(*)(void) callbackHandler)

This API registers the function to be called upon Transmitter interrupt.

void EUSART_Write (uint8_t txData)

This function writes a byte of data to the transmitter FIFO register.

void(* EUSART_RxInterruptHandler) (void)

This indicates the function that will be called upon receive interrupt.

void(* EUSART_TxInterruptHandler) (void)

This indicates the function that will be called upon transmit interrupt.

const uart_drv_interface_t UART1

External object for eusart_interface.

Section: Driver Interface

• struct {

  • uint8_t perr: 1

  • uint8_t ferr: 1

  • uint8_t oerr: 1

  • uint8_t reserved: 5

• };

• size_t status

struct { ... }

uint8_t ferr

This is a bit field for Framing Error status

uint8_t oerr

This is a bit field for Overfrun Error status

uint8_t perr

This is a bit field for Parity Error status

uint8_t reserved

Reserved

size_t status

Group byte for status errors

• void(* Initialize )(void)

• void(* Deinitialize )(void)

• uint8_t(* Read )(void)

• void(* Write )(uint8_t)

• bool(* IsRxReady )(void)

• bool(* IsTxReady )(void)

• bool(* IsTxDone )(void)

• void(* TransmitEnable )(void)

• void(* TransmitDisable )(void)

• void(* AutoBaudSet )(bool enable)

• bool(* AutoBaudQuery )(void)

• bool(* AutoBaudEventEnableGet )(void)

• void(* BRGCountSet )(uint32_t brgValue)

• uint32_t(* BRGCountGet )(void)

• void(* BaudRateSet )(uint32_t baudRate)

• uint32_t(* BaudRateGet )(void)

• size_t(* ErrorGet )(void)

• void(* TxCompleteCallbackRegister )(void(*CallbackHandler)(void))

• void(* RxCompleteCallbackRegister )(void(*CallbackHandler)(void))

• void(* TxCollisionCallbackRegister )(void(*CallbackHandler)(void))

• void(* FramingErrorCallbackRegister )(void(*CallbackHandler)(void))

• void(* OverrunErrorCallbackRegister )(void(*CallbackHandler)(void))

• void(* ParityErrorCallbackRegister )(void(*CallbackHandler)(void))

• void(* EventCallbackRegister )(void(*CallbackHandler)(void))

bool(* AutoBaudEventEnableGet) (void)

bool(* AutoBaudQuery) (void)

void(* AutoBaudSet) (bool enable)

uint32_t(* BaudRateGet) (void)

void(* BaudRateSet) (uint32_t baudRate)

uint32_t(* BRGCountGet) (void)

void(* BRGCountSet) (uint32_t brgValue)

void(* Deinitialize) (void)

size_t(* ErrorGet) (void)

void(* EventCallbackRegister) (void(*CallbackHandler)(void))

void(* FramingErrorCallbackRegister) (void(*CallbackHandler)(void))

void(* Initialize) (void)

bool(* IsRxReady) (void)

bool(* IsTxDone) (void)

bool(* IsTxReady) (void)

void(* OverrunErrorCallbackRegister) (void(*CallbackHandler)(void))

void(* ParityErrorCallbackRegister) (void(*CallbackHandler)(void))

uint8_t(* Read) (void)

void(* RxCompleteCallbackRegister) (void(*CallbackHandler)(void))

void(* TransmitDisable) (void)

void(* TransmitEnable) (void)

void(* TxCollisionCallbackRegister) (void(*CallbackHandler)(void))

void(* TxCompleteCallbackRegister) (void(*CallbackHandler)(void))

void(* Write) (uint8_t)

static void EUSART_DefaultFramingErrorCallback (void )[static]

static void EUSART_DefaultOverrunErrorCallback (void )[static]

#define EUSART_RX_BUFFER_MASK (EUSART_RX_BUFFER_SIZE - 1)

#define EUSART_RX_BUFFER_SIZE (8)

#define EUSART_TX_BUFFER_MASK (EUSART_TX_BUFFER_SIZE - 1)

#define EUSART_TX_BUFFER_SIZE (8)

Section: Included Files Section: Macro Declarations

void(* EUSART_FramingErrorHandler) (void)

void(* EUSART_OverrunErrorHandler) (void)

void(* EUSART_RxInterruptHandler) (void)

void(* EUSART_TxInterruptHandler) (void)

Section: EUSART APIs

volatile uint8_t eusartRxBuffer[EUSART_RX_BUFFER_SIZE][static]

volatile uint8_t eusartRxCount

volatile uint8_t eusartRxHead = 0[static]

volatile eusart_status_t eusartRxLastError

volatile eusart_status_t eusartRxStatusBuffer[EUSART_RX_BUFFER_SIZE][static]

volatile uint8_t eusartRxTail = 0[static]

volatile uint8_t eusartTxBuffer[EUSART_TX_BUFFER_SIZE][static]

volatile uint8_t eusartTxBufferRemaining

volatile uint8_t eusartTxHead = 0[static]

Section: EUSART variables

volatile uint8_t eusartTxTail = 0[static]

#define UART1__AutoBaudEventEnableGet (NULL)

#define UART1__IsRxReady EUSART_IsRxReady

#define UART1_AutoBaudQuery EUSART_AutoBaudQuery

#define UART1_AutoBaudSet EUSART_AutoBaudSet

#define UART1_BaudRateGet (NULL)

#define UART1_BaudRateSet (NULL)

#define UART1_BRGCountGet (NULL)

#define UART1_BRGCountSet (NULL)

#define UART1_Deinitialize EUSART_Deinitialize

#define UART1_ErrorGet EUSART_ErrorGet

#define UART1_EventCallbackRegister (NULL)

#define UART1_FramingErrorCallbackRegister EUSART_FramingErrorCallbackRegister

#define UART1_Initialize EUSART_Initialize

#define UART1_interface UART1

#define UART1_IsTxDone EUSART_IsTxDone

#define UART1_IsTxReady EUSART_IsTxReady

#define UART1_OverrunErrorCallbackRegister EUSART_OverrunErrorCallbackRegister

#define UART1_ParityErrorCallbackRegister (NULL)

#define UART1_Read EUSART_Read

#define UART1_RxCompleteCallbackRegister EUSART_RxCompleteCallbackRegister

#define UART1_TransmitDisable EUSART_TransmitDisable

#define UART1_TransmitEnable EUSART_TransmitEnable

#define UART1_TxCollisionCallbackRegister (NULL)

#define UART1_TxCompleteCallbackRegister EUSART_TxCompleteCallbackRegister

#define UART1_Write EUSART_Write

enum UART_STANDARD_BAUDS

This Enum can be used to set the UART standard baud rates using UARTx_BRGSet function e.g. UART1_BRGSet.

Section: Included Files Section: Data Type Definitions