tr_hal_uart.h

Go to the documentation of this file.

 
 
#ifndef TR_HAL_UART_H_
#define TR_HAL_UART_H_
 
#include "tr_hal_platform.h"
 
 
// ****************************************************************************
// UART Driver API functions
// ****************************************************************************
 
 
 
 
// ***************************************************************************
// ---- UART init/uninit APIs ----
// ***************************************************************************
 
tr_hal_status_t tr_hal_uart_init(tr_hal_uart_id_t        uart_id, 
                                 tr_hal_uart_settings_t* uart_settings);
 
tr_hal_status_t tr_hal_uart_uninit(tr_hal_uart_id_t uart_id);
 
tr_hal_status_t tr_hal_uart_set_power_mode(tr_hal_uart_id_t    uart_id,
                                           tr_hal_power_mode_t power_mode);
 
 
// ***************************************************************************
// ---- UART receive APIs ----
// ***************************************************************************
 
tr_hal_status_t tr_hal_uart_raw_rx_one_byte(tr_hal_uart_id_t uart_id, 
                                            char*            byte);
                                
tr_hal_status_t tr_hal_uart_raw_rx_available_bytes(tr_hal_uart_id_t uart_id, 
                                                   char*            bytes, 
                                                   uint16_t         buffer_size, 
                                                   uint16_t*        num_returned_bytes);
 
// ***************************************************************************
// ---- UART transmit APIs ----
// ***************************************************************************
 
tr_hal_status_t tr_hal_uart_raw_tx_one_byte(tr_hal_uart_id_t uart_id,
                                            const char       byte_to_send);
 
tr_hal_status_t tr_hal_uart_raw_tx_buffer(tr_hal_uart_id_t uart_id,
                                          const char*      bytes_to_send,
                                          uint16_t         num_bytes_to_send);
 
// returns true if a transmit is in progress
// returns false if all transmits have been completed (no tx in progress)
tr_hal_status_t tr_hal_uart_tx_active(tr_hal_uart_id_t uart_id,
                                      bool*            tx_active);
 
// ***************************************************************************
// ---- UART DMA transmit ----
// ***************************************************************************
 
tr_hal_status_t tr_hal_uart_dma_tx_bytes_in_buffer(tr_hal_uart_id_t uart_id,
                                                   char*            bytes_to_send,
                                                   uint16_t         num_bytes_to_send);
 
// ***************************************************************************
// ---- UART DMA receive ----
// to receive bytes with UART, the app should check the receive buffer passed in
// ***************************************************************************
 
tr_hal_status_t tr_hal_uart_dma_receive_buffer_num_bytes_left(tr_hal_uart_id_t uart_id,
                                                              uint32_t*        bytes_left);
 
tr_hal_status_t tr_hal_uart_dma_change_rx_buffer(tr_hal_uart_id_t uart_id,
                                                 uint8_t*         new_receive_buffer,
                                                 uint16_t         new_buffer_length);
 
 
// ***************************************************************************
// ---- UART functions to convert int value to enum ----
// these can be used by the app to convert user input (like from CLI) to enum values
// ***************************************************************************
 
tr_hal_baud_rate_t tr_hal_get_baud_rate_enum_from_value(uint32_t baud_rate_value);
 
tr_hal_data_bits_t tr_hal_get_data_bits_enum_from_value(uint8_t data_bits_value);
 
tr_hal_stop_bits_t tr_hal_get_stop_bits_enum_from_value(uint8_t stop_bits_value);
 
 
// ***************************************************************************
// ---- UART power on/off - these are called from init and uninit - the app should not need to call these
// ***************************************************************************
 
tr_hal_status_t tr_hal_uart_power_off(tr_hal_uart_id_t uart_id);
 
tr_hal_status_t tr_hal_uart_power_on(tr_hal_uart_id_t uart_id);
 
 
// ***************************************************************************
// ---- setting pin mode and checking valid pin settings ----
// ***************************************************************************
 
tr_hal_status_t tr_hal_uart_set_tx_rx_pins(tr_hal_uart_id_t  uart_id, 
                                           tr_hal_gpio_pin_t tx_pin, 
                                           tr_hal_gpio_pin_t rx_pin);
 
tr_hal_status_t tr_hal_uart_set_rts_cts_pins(tr_hal_uart_id_t  uart_id, 
                                             tr_hal_gpio_pin_t rts_pin, 
                                             tr_hal_gpio_pin_t cts_pin);
 
bool tr_hal_uart_check_pins_valid(tr_hal_uart_id_t  uart_id, 
                                  tr_hal_gpio_pin_t new_tx_pin, 
                                  tr_hal_gpio_pin_t new_rx_pin);
 
 
 
 
#endif //TR_HAL_UART_H_