3.26.2 EUSART - Enhanced USART

• struct eusart1_status_t

  This is a structure defined for errors in reception of data.

• void EUSART1_Initialize (void)

  Initializes the EUSART1 module. This routine is called only once during system initialization, before calling other APIs.

• void EUSART1_Deinitialize (void)

  Deinitializes and disables the EUSART1 module.

• void EUSART1_Enable (void)

  This API enables the EUSART1 module.  

• void EUSART1_Disable (void)

  This API disables the EUSART1 module.

• void EUSART1_TransmitEnable (void)

  This API enables the EUSART1 transmitter. The EUSART1 must be enabled to send the bytes over to the TX pin.

• void EUSART1_TransmitDisable (void)

  This API disables the EUSART1 transmitter.

• void EUSART1_ReceiveEnable (void)

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

• void EUSART1_ReceiveDisable (void)

  This API disables the EUSART1 receiver.

• void EUSART1_TransmitInterruptEnable (void)

  This API enables the EUSART1 transmitter interrupt.

• void EUSART1_TransmitInterruptDisable (void)

  This API disables the EUSART1 transmitter interrupt.

• void EUSART1_ReceiveInterruptEnable (void)

  This API enables the EUSART1 receiver interrupt.

• void EUSART1_ReceiveInterruptDisable (void)

  This API disables the EUSART1 receiver interrupt.

• void EUSART1_SendBreakControlEnable (void)

  This API enables the EUSART1 to send a break control.

• void EUSART1_SendBreakControlDisable (void)

  This API disables the EUSART1 send break control.

• void EUSART1_AutoBaudSet (bool enable)

  This API enables the EUSART1 AutoBaud Detection (ABR).

• bool EUSART1_AutoBaudQuery (void)

  This API reads the EUSART1 ABR Complete bit.

• bool EUSART1_IsAutoBaudDetectOverflow (void)

  This API reads the EUSART1 ABR Overflow bit.

• void EUSART1_AutoBaudDetectOverflowReset (void)

  This API resets the EUSART1 ABR Overflow bit.

• bool EUSART1_IsRxReady (void)

  This API checks if the EUSART1 has received available data.

• bool EUSART1_IsTxReady (void)

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

• bool EUSART1_IsTxDone (void)

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

• size_t EUSART1_ErrorGet (void)

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

• uint8_t EUSART1_Read (void)

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

• void EUSART1_Write (uint8_t txData)

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

• void EUSART1_FramingErrorCallbackRegister (void(*callbackHandler)(void))

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

• void EUSART1_OverrunErrorCallbackRegister (void(*callbackHandler)(void))

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

• void EUSART1_TxCompleteCallbackRegister (void(*callbackHandler)(void))

  This API registers the function to be called upon after data has been successfully transmitted.

• void EUSART1_TransmitISR (void)

  This ISR function is called upon transmitter interrupt.

• void EUSART1_RxCompleteCallbackRegister (void(*callbackHandler)(void))

  This API registers the function to be called upon after data has been successfully received.

• void EUSART1_ReceiveISR (void)

  This ISR function is called upon receiver interrupt.

• int getch (void)

  This function used to printf support for reads the 8 bits from the FIFO register receiver.

• void putch (char txData)

  This function used to printf support for writes a byte of data to the transmitter FIFO register.

• const uart_drv_interface_t UART1

  External object for eusart1_interface.

• void(* EUSART1_TxInterruptHandler )(void)

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

• void(* EUSART1_RxInterruptHandler )(void)

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

void EUSART1_AutoBaudDetectOverflowReset (void )

This API resets the EUSART1 ABR Overflow bit.

bool EUSART1_AutoBaudQuery (void )

This API reads the EUSART1 ABR Complete bit.

void EUSART1_AutoBaudSet (bool enable)

This API enables the EUSART1 AutoBaud Detection (ABR).

void EUSART1_Deinitialize (void )

Deinitializes and disables the EUSART1 module.

void EUSART1_Disable (void )

This API disables the EUSART1 module.

void EUSART1_Enable (void )

This API enables the EUSART1 module.  

size_t EUSART1_ErrorGet (void )

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

void EUSART1_FramingErrorCallbackRegister (void(*)(void) callbackHandler)

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

void EUSART1_Initialize (void )

Initializes the EUSART1 module. This routine is called only once during system initialization, before calling other APIs.

Section: EUSART1 APIs

bool EUSART1_IsAutoBaudDetectOverflow (void )

This API reads the EUSART1 ABR Overflow bit.

bool EUSART1_IsRxReady (void )

This API checks if the EUSART1 has received available data.

bool EUSART1_IsTxDone (void )

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

bool EUSART1_IsTxReady (void )

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

void EUSART1_OverrunErrorCallbackRegister (void(*)(void) callbackHandler)

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

uint8_t EUSART1_Read (void )

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

void EUSART1_ReceiveDisable (void )

This API disables the EUSART1 receiver.

void EUSART1_ReceiveEnable (void )

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

void EUSART1_ReceiveInterruptDisable (void )

This API disables the EUSART1 receiver interrupt.

void EUSART1_ReceiveInterruptEnable (void )

This API enables the EUSART1 receiver interrupt.

void EUSART1_ReceiveISR (void )

This ISR function is called upon receiver interrupt.

void EUSART1_RxCompleteCallbackRegister (void(*)(void) callbackHandler)

This API registers the function to be called upon after data has been successfully received.

void EUSART1_SendBreakControlDisable (void )

This API disables the EUSART1 send break control.

void EUSART1_SendBreakControlEnable (void )

This API enables the EUSART1 to send a break control.

void EUSART1_TransmitDisable (void )

This API disables the EUSART1 transmitter.

void EUSART1_TransmitEnable (void )

This API enables the EUSART1 transmitter. The EUSART1 must be enabled to send the bytes over to the TX pin.

void EUSART1_TransmitInterruptDisable (void )

This API disables the EUSART1 transmitter interrupt.

void EUSART1_TransmitInterruptEnable (void )

This API enables the EUSART1 transmitter interrupt.

void EUSART1_TransmitISR (void )

This ISR function is called upon transmitter interrupt.

void EUSART1_TxCompleteCallbackRegister (void(*)(void) callbackHandler)

This API registers the function to be called upon after data has been successfully transmitted.

void EUSART1_Write (uint8_t txData)

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

int getch (void )

This function used to printf support for reads the 8 bits from the FIFO register receiver.

void putch (char txData)

This function used to printf support for writes a byte of data to the transmitter FIFO register.

void(* EUSART1_RxInterruptHandler) (void)

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

void(* EUSART1_TxInterruptHandler) (void)

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

Section: EUSART1 APIs

const uart_drv_interface_t UART1

External object for eusart1_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 EUSART1_DefaultFramingErrorCallback (void )[static]

static void EUSART1_DefaultOverrunErrorCallback (void )[static]

#define EUSART1_RX_BUFFER_MASK (EUSART1_RX_BUFFER_SIZE - 1U)

#define EUSART1_RX_BUFFER_SIZE (8U)

#define EUSART1_TX_BUFFER_MASK (EUSART1_TX_BUFFER_SIZE - 1U)

#define EUSART1_TX_BUFFER_SIZE (8U)

Section: Included Files Section: Macro Declarations

void(* EUSART1_FramingErrorHandler) (void) = NULL[static]

void(* EUSART1_OverrunErrorHandler) (void) = NULL[static]

void(* EUSART1_RxCompleteInterruptHandler) (void) = NULL[static]

void(* EUSART1_TxCompleteInterruptHandler) (void) = NULL[static]

volatile uint8_t eusart1RxBuffer[EUSART1_RX_BUFFER_SIZE][static]

volatile uint8_t eusart1RxCount[static]

volatile uint8_t eusart1RxHead = 0[static]

volatile eusart1_status_t eusart1RxLastError[static]

volatile eusart1_status_t eusart1RxStatusBuffer[EUSART1_RX_BUFFER_SIZE][static]

volatile uint8_t eusart1RxTail = 0[static]

volatile uint8_t eusart1TxBuffer[EUSART1_TX_BUFFER_SIZE][static]

volatile uint8_t eusart1TxBufferRemaining[static]

volatile uint8_t eusart1TxHead = 0[static]

Section: EUSART1 variables

volatile uint8_t eusart1TxTail = 0[static]

#define UART1__AutoBaudEventEnableGet (NULL)

#define UART1__IsRxReady EUSART1_IsRxReady

#define UART1_AutoBaudQuery EUSART1_AutoBaudQuery

#define UART1_AutoBaudSet EUSART1_AutoBaudSet

#define UART1_BaudRateGet (NULL)

#define UART1_BaudRateSet (NULL)

#define UART1_BRGCountGet (NULL)

#define UART1_BRGCountSet (NULL)

#define UART1_Deinitialize EUSART1_Deinitialize

#define UART1_ErrorGet EUSART1_ErrorGet

#define UART1_EventCallbackRegister (NULL)

#define UART1_FramingErrorCallbackRegister EUSART1_FramingErrorCallbackRegister

#define UART1_Initialize EUSART1_Initialize

#define UART1_interface UART1

#define UART1_IsTxDone EUSART1_IsTxDone

#define UART1_IsTxReady EUSART1_IsTxReady

#define UART1_OverrunErrorCallbackRegister EUSART1_OverrunErrorCallbackRegister

#define UART1_ParityErrorCallbackRegister (NULL)

#define UART1_Read EUSART1_Read

#define UART1_RxCompleteCallbackRegister EUSART1_RxCompleteCallbackRegister

#define UART1_TransmitDisable EUSART1_TransmitDisable

#define UART1_TransmitEnable EUSART1_TransmitEnable

#define UART1_TxCollisionCallbackRegister (NULL)

#define UART1_TxCompleteCallbackRegister EUSART1_TxCompleteCallbackRegister

#define UART1_Write EUSART1_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