3.26.1 UART

• struct uart1_status_t

  This is an instance of UART1_STATUS for UART1 module.

• void UART1_Initialize (void)

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

• void UART1_Deinitialize (void)

  Deinitializes and disables the UART1 module.

• void UART1_Enable (void)

  Enables the UART1 module.  

• void UART1_Disable (void)

  Disables the UART1 module.

• void UART1_TransmitEnable (void)

  Enables the UART1 transmitter. This routine also enables UART1 to send bytes over the TX pin.

• void UART1_TransmitDisable (void)

  Disables the UART1 transmitter.

• void UART1_ReceiveEnable (void)

  Enables the UART1 receiver. This routine also enables UART1 to send bytes over the RX pin.

• void UART1_ReceiveDisable (void)

  Disables the UART1 receiver.

• void UART1_SendBreakControlEnable (void)

  Enables the UART1 Send Break Control bit.

• void UART1_SendBreakControlDisable (void)

  Disables the UART1 Send Break Control bit.

• void UART1_TransmitInterruptEnable (void)

  Enables the UART1 transmitter interrupt.

• void UART1_TransmitInterruptDisable (void)

  Disables the UART1 transmitter interrupt.

• void UART1_ReceiveInterruptEnable (void)

  Enables the UART1 receiver interrupt.

• void UART1_ReceiveInterruptDisable (void)

  Disables the UART1 receiver interrupt.

• void UART1_AutoBaudSet (bool enable)

  Enables the UART1 Auto-Baud Detection bit.

• bool UART1_AutoBaudQuery (void)

  Reads the UART1 Auto-Baud Detection Complete bit.

• void UART1_AutoBaudDetectCompleteReset (void)

  Resets the UART1 Auto-Baud Detection Complete bit.

• bool UART1_IsAutoBaudDetectOverflow (void)

  Reads the UART1 Auto-Baud Detection Overflow bit.

• void UART1_AutoBaudDetectOverflowReset (void)

  Resets the UART1 Auto-Baud Detection Overflow bit.

• void UART1_ErrorInterruptEnable (void)

  Enables the UART1 Error Interrupt bit.

• void UART1_ErrorInterruptDisable (void)

  Disables the UART1 Error Interrupt bit.

• void UART1_GeneralInterruptEnable (void)

  Enables the UART1 Interrupt.

• void UART1_GeneralInterruptDisable (void)

  Disables the UART1 Interrupt.

• bool UART1_IsRxReady (void)

  Checks if the UART1 receiver has received data and is ready to be read.

• bool UART1_IsTxReady (void)

  Checks if the UART1 transmitter is ready to accept a data byte.

• bool UART1_IsTxDone (void)

  Returns the status of the Transmit Shift Register (TSR).

• size_t UART1_ErrorGet (void)

  Gets the error status of the last read byte. Call this function before calling UART1_Read().

• uint8_t UART1_Read (void)

  Reads the eight bits from the Receiver FIFO register.

• void UART1_Write (uint8_t txData)

  Writes a byte of data to the Transmitter FIFO register.

• void UART1_FramingErrorCallbackRegister (void(*callbackHandler)(void))

  Calls the function upon UART1 framing error.

• void UART1_OverrunErrorCallbackRegister (void(*callbackHandler)(void))

  Calls the function upon UART1 overrun error.

• void UART1_ParityErrorCallbackRegister (void(*callbackHandler)(void))

  Calls the function upon UART1 parity error.

• void UART1_TxCompleteCallbackRegister (void(*callbackHandler)(void))

  Registers the function to be called when the transmitter interrupt occurs.

• void UART1_TransmitISR (void)

  Implements the Interrupt Service Routine (ISR) for the UART1 transmitter interrupt.

• void UART1_RxCompleteCallbackRegister (void(*callbackHandler)(void))

  Registers the function to be called when the receiver interrupt occurs.

• void UART1_ReceiveISR (void)

  Implements the ISR for the UART1 receiver interrupt.

• void UART1_ErrorCallbackRegister (void(*callbackHandler)(void))

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

• void UART1_ErrorISR (void)

  This function is a ISR function to be called upon Error interrupt.

• void UART1_GeneralInterruptCallbackRegister (void(*callbackHandler)(void))

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

• void UART1_GeneralISR (void)

  This function is a ISR function to be called upon general interrupt.

• const uart_drv_interface_t UART1

  External object for uart_drv_interface.

• void(* UART1_TxInterruptHandler )(void)

  Pointer to the function called when the transmitter interrupt occurs.

• void(* UART1_RxInterruptHandler )(void)

  Pointer to the function called when the receiver interrupt occurs.

• void(* UART1_ErrorInterruptHandler )(void)

  This is a pointer to the function that will be called upon error interrupt.

• void(* UART1_GeneralInterruptHandler )(void)

  This is a pointer to the function that will be called upon general interrupt.

void UART1_AutoBaudDetectCompleteReset (void )[inline]

Resets the UART1 Auto-Baud Detection Complete bit.

void UART1_AutoBaudDetectOverflowReset (void )[inline]

Resets the UART1 Auto-Baud Detection Overflow bit.

bool UART1_AutoBaudQuery (void )[inline]

Reads the UART1 Auto-Baud Detection Complete bit.

void UART1_AutoBaudSet (bool enable)[inline]

Enables the UART1 Auto-Baud Detection bit.

void UART1_Deinitialize (void )

Deinitializes and disables the UART1 module.

void UART1_Disable (void )[inline]

Disables the UART1 module.

void UART1_Enable (void )[inline]

Enables the UART1 module.  

void UART1_ErrorCallbackRegister (void(*)(void) callbackHandler)

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

size_t UART1_ErrorGet (void )

Gets the error status of the last read byte. Call this function before calling UART1_Read().

void UART1_ErrorInterruptDisable (void )[inline]

Disables the UART1 Error Interrupt bit.

void UART1_ErrorInterruptEnable (void )[inline]

Enables the UART1 Error Interrupt bit.

void UART1_ErrorISR (void )

This function is a ISR function to be called upon Error interrupt.

void UART1_FramingErrorCallbackRegister (void(*)(void) callbackHandler)

Calls the function upon UART1 framing error.

void UART1_GeneralInterruptCallbackRegister (void(*)(void) callbackHandler)

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

void UART1_GeneralInterruptDisable (void )[inline]

Disables the UART1 Interrupt.

void UART1_GeneralInterruptEnable (void )[inline]

Enables the UART1 Interrupt.

void UART1_GeneralISR (void )

This function is a ISR function to be called upon general interrupt.

void UART1_Initialize (void )

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

Section: UART1 APIs

bool UART1_IsAutoBaudDetectOverflow (void )[inline]

Reads the UART1 Auto-Baud Detection Overflow bit.

bool UART1_IsRxReady (void )

Checks if the UART1 receiver has received data and is ready to be read.

bool UART1_IsTxDone (void )

Returns the status of the Transmit Shift Register (TSR).

bool UART1_IsTxReady (void )

Checks if the UART1 transmitter is ready to accept a data byte.

void UART1_OverrunErrorCallbackRegister (void(*)(void) callbackHandler)

Calls the function upon UART1 overrun error.

void UART1_ParityErrorCallbackRegister (void(*)(void) callbackHandler)

Calls the function upon UART1 parity error.

uint8_t UART1_Read (void )

Reads the eight bits from the Receiver FIFO register.

void UART1_ReceiveDisable (void )[inline]

Disables the UART1 receiver.

void UART1_ReceiveEnable (void )[inline]

Enables the UART1 receiver. This routine also enables UART1 to send bytes over the RX pin.

void UART1_ReceiveInterruptDisable (void )[inline]

Disables the UART1 receiver interrupt.

void UART1_ReceiveInterruptEnable (void )[inline]

Enables the UART1 receiver interrupt.

void UART1_ReceiveISR (void )

Implements the ISR for the UART1 receiver interrupt.

void UART1_RxCompleteCallbackRegister (void(*)(void) callbackHandler)

Registers the function to be called when the receiver interrupt occurs.

void UART1_SendBreakControlDisable (void )[inline]

Disables the UART1 Send Break Control bit.

void UART1_SendBreakControlEnable (void )[inline]

Enables the UART1 Send Break Control bit.

void UART1_TransmitDisable (void )[inline]

Disables the UART1 transmitter.

void UART1_TransmitEnable (void )[inline]

Enables the UART1 transmitter. This routine also enables UART1 to send bytes over the TX pin.

void UART1_TransmitInterruptDisable (void )[inline]

Disables the UART1 transmitter interrupt.

void UART1_TransmitInterruptEnable (void )[inline]

Enables the UART1 transmitter interrupt.

void UART1_TransmitISR (void )

Implements the Interrupt Service Routine (ISR) for the UART1 transmitter interrupt.

void UART1_TxCompleteCallbackRegister (void(*)(void) callbackHandler)

Registers the function to be called when the transmitter interrupt occurs.

void UART1_Write (uint8_t txData)

Writes a byte of data to the Transmitter FIFO register.

const uart_drv_interface_t UART1

External object for uart_drv_interface.

Section: Driver Interface

void(* UART1_ErrorInterruptHandler) (void)

This is a pointer to the function that will be called upon error interrupt.

void(* UART1_GeneralInterruptHandler) (void)

This is a pointer to the function that will be called upon general interrupt.

void(* UART1_RxInterruptHandler) (void)

Pointer to the function called when the receiver interrupt occurs.

void(* UART1_TxInterruptHandler) (void)

Pointer to the function called when the transmitter interrupt occurs.

• 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)

int getch (void )

void putch (char txData)

static void UART1_DefaultFramingErrorCallback (void )[static]

static void UART1_DefaultOverrunErrorCallback (void )[static]

static void UART1_DefaultParityErrorCallback (void )[static]

#define UART1_RX_BUFFER_MASK (UART1_RX_BUFFER_SIZE - 1)

#define UART1_RX_BUFFER_SIZE (8)

#define UART1_TX_BUFFER_MASK (UART1_TX_BUFFER_SIZE - 1)

#define UART1_TX_BUFFER_SIZE (8)

Section: Included Files Section: Macro Declarations

void(* UART1_CommunicationErrorInterruptHandler) (void)[static]

void(* UART1_ErrorInterruptHandler) (void)

void(* UART1_FramingErrorHandler) (void)

Section: UART1 APIs

void(* UART1_GeneralErrorInterruptHandler) (void)[static]

void(* UART1_GeneralInterruptHandler) (void)

void(* UART1_OverrunErrorHandler) (void)

void(* UART1_ParityErrorHandler) (void)

void(* UART1_RxCompleteInterruptHandler) (void)[static]

void(* UART1_RxInterruptHandler) (void)

void(* UART1_TxCompleteInterruptHandler) (void)[static]

void(* UART1_TxInterruptHandler) (void)

volatile uint8_t uart1RxBuffer[UART1_RX_BUFFER_SIZE][static]

volatile uint8_t uart1RxCount

volatile uint8_t uart1RxHead = 0[static]

volatile uart1_status_t uart1RxLastError

volatile uart1_status_t uart1RxStatusBuffer[UART1_RX_BUFFER_SIZE][static]

volatile uint8_t uart1RxTail = 0[static]

volatile uint8_t uart1TxBuffer[UART1_TX_BUFFER_SIZE][static]

volatile uint8_t uart1TxBufferRemaining

volatile uint8_t uart1TxHead = 0[static]

Section: UART1 variables

volatile uint8_t uart1TxTail = 0[static]

#define UART1__AutoBaudEventEnableGet (NULL)

#define UART1__IsRxReady UART1_IsRxReady

#define UART1_AutoBaudDetectCompleteReset UART1_AutoBaudDetectCompleteReset

#define UART1_AutoBaudDetectOverflowReset UART1_AutoBaudDetectOverflowReset

#define UART1_AutoBaudQuery UART1_AutoBaudQuery

#define UART1_AutoBaudSet UART1_AutoBaudSet

#define UART1_BaudRateGet (NULL)

#define UART1_BaudRateSet (NULL)

#define UART1_BRGCountGet (NULL)

#define UART1_BRGCountSet (NULL)

#define UART1_Deinitialize UART1_Deinitialize

#define UART1_ErrorGet UART1_ErrorGet

#define UART1_EventCallbackRegister (NULL)

#define UART1_FramingErrorCallbackRegister UART1_FramingErrorCallbackRegister

#define UART1_Initialize UART1_Initialize

#define UART1_interface UART1

#define UART1_IsAutoBaudDetectOverflow UART1_IsAutoBaudDetectOverflow

#define UART1_IsTxDone UART1_IsTxDone

#define UART1_IsTxReady UART1_IsTxReady

#define UART1_OverrunErrorCallbackRegister UART1_OverrunErrorCallbackRegister

#define UART1_ParityErrorCallbackRegister UART1_ParityErrorCallbackRegister

#define UART1_Read UART1_Read

#define UART1_RxCompleteCallbackRegister UART1_RxCompleteCallbackRegister

#define UART1_TransmitDisable UART1_TransmitDisable

#define UART1_TransmitEnable UART1_TransmitEnable

#define UART1_TxCollisionCallbackRegister (NULL)

#define UART1_TxCompleteCallbackRegister UART1_TxCompleteCallbackRegister

#define UART1_Write UART1_Write

enum UART_STANDARD_BAUDS

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

Section: Included Files Section: Data Type Definitions