uart_pal.h File Reference
#include "uart_pal_cfg.h"
#include "uart_pal_mapping.h"
#include "status.h"
#include "callbacks.h"

Go to the source code of this file.

Data Structures

struct  uart_user_config_t
 Defines the UART configuration structure. More...
 

Enumerations

enum  uart_bit_count_per_char_t {
  UART_7_BITS_PER_CHAR = 0x0U, UART_8_BITS_PER_CHAR = 0x1U, UART_9_BITS_PER_CHAR = 0x2U, UART_10_BITS_PER_CHAR = 0x3U,
  UART_15_BITS_PER_CHAR = 0x4U, UART_16_BITS_PER_CHAR = 0x5U
}
 Defines the number of bits in a character. More...
 
enum  uart_transfer_type_t { UART_USING_DMA = 0U, UART_USING_INTERRUPTS = 1U }
 Defines the transfer type. More...
 
enum  uart_parity_mode_t { UART_PARITY_DISABLED = 0x0U, UART_PARITY_EVEN = 0x2U, UART_PARITY_ODD = 0x3U }
 Defines the parity mode. More...
 
enum  uart_stop_bit_count_t { UART_ONE_STOP_BIT = 0x0U, UART_TWO_STOP_BIT = 0x1U }
 Defines the number of stop bits. More...
 

Functions

status_t UART_Init (const uart_instance_t *const instance, const uart_user_config_t *config)
 Initializes the UART module. More...
 
status_t UART_Deinit (const uart_instance_t *const instance)
 De-initializes the UART module. More...
 
status_t UART_SetBaudRate (const uart_instance_t *const instance, uint32_t desiredBaudRate)
 Configures the UART baud rate. More...
 
status_t UART_GetBaudRate (const uart_instance_t *const instance, uint32_t *configuredBaudRate)
 Returns the UART baud rate. More...
 
status_t UART_SendDataBlocking (const uart_instance_t *const instance, const uint8_t *txBuff, uint32_t txSize, uint32_t timeout)
 Perform a blocking UART transmission. More...
 
status_t UART_SendData (const uart_instance_t *const instance, const uint8_t *txBuff, uint32_t txSize)
 Perform a non-blocking UART transmission. More...
 
status_t UART_AbortSendingData (const uart_instance_t *const instance)
 Terminates a non-blocking transmission early. More...
 
status_t UART_GetTransmitStatus (const uart_instance_t *const instance, uint32_t *bytesRemaining)
 Get the status of the current non-blocking UART transmission. More...
 
status_t UART_ReceiveDataBlocking (const uart_instance_t *const instance, uint8_t *rxBuff, uint32_t rxSize, uint32_t timeout)
 Perform a blocking UART reception. More...
 
status_t UART_ReceiveData (const uart_instance_t *const instance, uint8_t *rxBuff, uint32_t rxSize)
 Perform a non-blocking UART reception. More...
 
status_t UART_AbortReceivingData (const uart_instance_t *const instance)
 Terminates a non-blocking receive early. More...
 
status_t UART_GetReceiveStatus (const uart_instance_t *const instance, uint32_t *bytesRemaining)
 Get the status of the current non-blocking UART reception. More...
 
status_t UART_SetRxBuffer (const uart_instance_t *const instance, uint8_t *rxBuff, uint32_t rxSize)
 Provide a buffer for receiving data. More...
 
status_t UART_SetTxBuffer (const uart_instance_t *const instance, const uint8_t *txBuff, uint32_t txSize)
 Provide a buffer for transmitting data. More...