TMPM4G(1) Group Peripheral Driver User Manual  V1.0.0.0
txz_uart.h File Reference

This file provides all the functions prototypes for UART driver. More...

#include "txz_driver_def.h"

Go to the source code of this file.

Data Structures

struct  uart_receive8_t
 Receive event information structure definition. More...
 
struct  uart_receive16_t
 Receive event information structure definition. More...
 
union  uart_receive_t
 Receive event information structure definition. More...
 
struct  uart_transmit8_t
 Transmit data information structure definition. More...
 
struct  uart_transmit16_t
 Transmit data information structure definition. More...
 
union  uart_transmit_t
 Transmit data information structure definition. More...
 
struct  uart_clock_t
 Clock setting structure definition. More...
 
struct  uart_boudrate_t
 Boudrate setting structure definition. More...
 
struct  uart_tx_fifo_t
 Transmit FIFO setting. More...
 
struct  uart_rx_fifo_t
 Receive FIFO setting. More...
 
struct  uart_initial_setting_t
 Initial setting structure definition. More...
 
struct  uart_t
 UART handle structure definition. More...
 

Macros

#define UART_TX_FIFO_MAX   ((uint32_t)0x00000008)
 
#define UART_RX_FIFO_MAX   ((uint32_t)0x00000008)
 
#define UART_HALF_CLOCK_UTxTXDA   ((uint32_t)0x00000000)
 
#define UART_HALF_CLOCK_UTxTXDB   ((uint32_t)0x00040000)
 
#define UART_HALF_CLOCK_MODE_1   ((uint32_t)0x00000000)
 
#define UART_HALF_CLOCK_MODE_2   ((uint32_t)0x00020000)
 
#define UART_HALF_CLOCK_DISABLE   ((uint32_t)0x00000000)
 
#define UART_HALF_CLOCK_ENABLE   ((uint32_t)0x00010000)
 
#define UART_LOOPBACK_DISABLE   ((uint32_t)0x00000000)
 
#define UART_LOOPBACK_ENABLE   ((uint32_t)0x00008000)
 
#define UART_NOISE_FILTER_NON   ((uint32_t)0x00000000)
 
#define UART_NOISE_FILTER_2_T0   ((uint32_t)0x00001000)
 
#define UART_NOISE_FILTER_4_T0   ((uint32_t)0x00002000)
 
#define UART_NOISE_FILTER_8_T0   ((uint32_t)0x00003000)
 
#define UART_NOISE_FILTER_2_CLOCK   ((uint32_t)0x00004000)
 
#define UART_NOISE_FILTER_3_CLOCK   ((uint32_t)0x00005000)
 
#define UART_NOISE_FILTER_4_CLOCK   ((uint32_t)0x00006000)
 
#define UART_NOISE_FILTER_5_CLOCK   ((uint32_t)0x00007000)
 
#define UART_CTS_DISABLE   ((uint32_t)0x00000000)
 
#define UART_CTS_ENABLE   ((uint32_t)0x00000400)
 
#define UART_RTS_DISABLE   ((uint32_t)0x00000000)
 
#define UART_RTS_ENABLE   ((uint32_t)0x00000200)
 
#define UART_DATA_COMPLEMENTION_DISABLE   ((uint32_t)0x00000000)
 
#define UART_DATA_COMPLEMENTION_ENABLE   ((uint32_t)0x00000040)
 
#define UART_DATA_DIRECTION_LSB   ((uint32_t)0x00000000)
 
#define UART_DATA_DIRECTION_MSB   ((uint32_t)0x00000020)
 
#define UART_STOP_BIT_1   ((uint32_t)0x00000000)
 
#define UART_STOP_BIT_2   ((uint32_t)0x00000010)
 
#define UART_PARITY_BIT_ODD   ((uint32_t)0x00000000)
 
#define UART_PARITY_BIT_EVEN   ((uint32_t)0x00000008)
 
#define UART_PARITY_DISABLE   ((uint32_t)0x00000000)
 
#define UART_PARITY_ENABLE   ((uint32_t)0x00000004)
 
#define UART_DATA_LENGTH_7   ((uint32_t)0x00000000)
 
#define UART_DATA_LENGTH_8   ((uint32_t)0x00000001)
 
#define UART_DATA_LENGTH_9   ((uint32_t)0x00000002)
 
#define UART_TX_FILL_RANGE_MIN   ((uint32_t)0x00000000)
 
#define UART_TX_FILL_RANGE_MAX   ((uint32_t)0x00000007)
 
#define UART_RX_FILL_RANGE_MIN   ((uint32_t)0x00000001)
 
#define UART_RX_FILL_RANGE_MAX   ((uint32_t)0x00000008)
 
#define UART_TX_FIFO_INT_DISABLE   ((uint32_t)0x00000000)
 
#define UART_TX_FIFO_INT_ENABLE   ((uint32_t)0x00000080)
 
#define UART_TX_INT_DISABLE   ((uint32_t)0x00000000)
 
#define UART_TX_INT_ENABLE   ((uint32_t)0x00000040)
 
#define UART_RX_FIFO_INT_DISABLE   ((uint32_t)0x00000000)
 
#define UART_RX_FIFO_INT_ENABLE   ((uint32_t)0x00000020)
 
#define UART_RX_INT_DISABLE   ((uint32_t)0x00000000)
 
#define UART_RX_INT_ENABLE   ((uint32_t)0x00000010)
 
#define UART_ERR_INT_DISABLE   ((uint32_t)0x00000000)
 
#define UART_ERR_INT_ENABLE   ((uint32_t)0x00000004)
 
#define UART_PLESCALER_1   ((uint32_t)0x00000000)
 
#define UART_PLESCALER_2   ((uint32_t)0x00000010)
 
#define UART_PLESCALER_4   ((uint32_t)0x00000020)
 
#define UART_PLESCALER_8   ((uint32_t)0x00000030)
 
#define UART_PLESCALER_16   ((uint32_t)0x00000040)
 
#define UART_PLESCALER_32   ((uint32_t)0x00000050)
 
#define UART_PLESCALER_64   ((uint32_t)0x00000060)
 
#define UART_PLESCALER_128   ((uint32_t)0x00000070)
 
#define UART_PLESCALER_256   ((uint32_t)0x00000080)
 
#define UART_PLESCALER_512   ((uint32_t)0x00000090)
 
#define UART_UARTxCLK_MASK   ((uint32_t)0x00000000)
 
#define UART_DIVISION_DISABLE   ((uint32_t)0x00000000)
 
#define UART_DIVISION_ENABLE   ((uint32_t)0x00800000)
 
#define UART_RANGE_K_MIN   ((uint32_t)0x00000000)
 
#define UART_RANGE_K_MAX   ((uint32_t)0x0000003F)
 
#define UART_RANGE_N_MIN   ((uint32_t)0x00000001)
 
#define UART_RANGE_N_MAX   ((uint32_t)0x0000FFFF)
 
#define UART_SETTING_MASK   ((uint32_t)0x80000000)
 
#define UART_SETTING_ENABLE   ((uint32_t)0x00000000)
 
#define UART_SETTING_DISABLE   ((uint32_t)0x80000000)
 
#define UART_TX_STATE_MASK   ((uint32_t)0x00008000)
 
#define UART_TX_STATE_SLEEP   ((uint32_t)0x00000000)
 
#define UART_TX_STATE_RUN   ((uint32_t)0x00008000)
 
#define UART_TX_MASK   ((uint32_t)0x00004000)
 
#define UART_TX_DONE   ((uint32_t)0x00004000)
 
#define UART_TX_REACH_FILL_MASK   ((uint32_t)0x00002000)
 
#define UART_TX_REACH_FILL_LEVEL   ((uint32_t)0x00002000)
 
#define UART_TX_FIFO_LEVEL_MASK   ((uint32_t)0x00000F00)
 
#define UART_RX_STATE_MASK   ((uint32_t)0x00000080)
 
#define UART_RX_STATE_SLEEP   ((uint32_t)0x00000000)
 
#define UART_RX_STATE_RUN   ((uint32_t)0x00000080)
 
#define UART_RX_MASK   ((uint32_t)0x00000040)
 
#define UART_RX_DONE   ((uint32_t)0x00000040)
 
#define UART_RX_REACH_FILL_MASK   ((uint32_t)0x00000020)
 
#define UART_RX_REACH_FILL_LEVEL   ((uint32_t)0x00000020)
 
#define UART_RX_FIFO_LEVEL_MASK   ((uint32_t)0x0000000F)
 
#define UART_TRIGGER_NO_ERR   ((uint32_t)0x00000000)
 
#define UART_TRIGGER_ERR   ((uint32_t)0x00000010)
 
#define UART_OVERRUN_NO_ERR   ((uint32_t)0x00000000)
 
#define UART_OVERRUN_ERR   ((uint32_t)0x00000008)
 
#define UART_PARITY_NO_ERR   ((uint32_t)0x00000000)
 
#define UART_PARITY_ERR   ((uint32_t)0x00000004)
 
#define UART_FRAMING_NO_ERR   ((uint32_t)0x00000000)
 
#define UART_FRAMING_ERR   ((uint32_t)0x00000002)
 
#define UART_BREAK_NO_ERR   ((uint32_t)0x00000000)
 
#define UART_BREAK_ERR   ((uint32_t)0x00000001)
 

Functions

TXZ_Result uart_init (uart_t *p_obj)
 
TXZ_Result uart_deinit (uart_t *p_obj)
 
TXZ_Result uart_discard_transmit (uart_t *p_obj)
 
TXZ_Result uart_discard_receive (uart_t *p_obj)
 
TXZ_Result uart_transmitIt (uart_t *p_obj, uart_transmit_t *p_info)
 
TXZ_Result uart_receiveIt (uart_t *p_obj, uart_receive_t *p_info)
 
void uart_transmit_irq_handler (uart_t *p_obj)
 
void uart_receive_irq_handler (uart_t *p_obj)
 
void uart_error_irq_handler (uart_t *p_obj)
 
TXZ_Result uart_get_status (uart_t *p_obj, uint32_t *p_status)
 
TXZ_Result uart_get_error (uart_t *p_obj, uint32_t *p_error)
 
TXZ_Result uart_get_boudrate_setting (uint32_t clock, uart_clock_t *p_clk, uint32_t boudrate, uart_boudrate_t *p_setting)
 

Detailed Description

This file provides all the functions prototypes for UART driver.

Version
V1.0.0.0
Date
2017-07-21 15:39:36

DO NOT USE THIS SOFTWARE WITHOUT THE SOFTWARE LICENSE AGREEMENT.

Copyright(C) Toshiba Electronic Device Solutions Corporation 2019