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

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

#include "txz_driver_def.h"

Go to the source code of this file.

Data Structures

struct  fuart_receive_t
 Receive event information structure definition. More...
 
struct  fuart_transmit_t
 Transmit data information structure definition. More...
 
struct  fuart_boudrate_t
 Boudrate setting structure definition. More...
 
struct  fuart_tx_int_t
 Transmit FIFO setting. More...
 
struct  fuart_rx_int_t
 Receive FIFO setting. More...
 
struct  fuart_initial_setting_t
 Initial setting structure definition. More...
 
struct  fuart_t
 FUART handle structure definition. More...
 

Macros

#define FUART_TX_FIFO_MAX   ((uint32_t)0x00000020)
 
#define FUART_RX_FIFO_MAX   ((uint32_t)0x00000020)
 
#define FUART_CTS_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_CTS_ENABLE   ((uint32_t)0x00008000)
 
#define FUART_RTS_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_RTS_ENABLE   ((uint32_t)0x00004000)
 
#define FUART_FIFO_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_FIFO_ENABLE   ((uint32_t)0x00000010)
 
#define FUART_STOP_BIT_1   ((uint32_t)0x00000000)
 
#define FUART_STOP_BIT_2   ((uint32_t)0x00000008)
 
#define FUART_PARITY_BIT_ODD   ((uint32_t)0x00000000)
 
#define FUART_PARITY_BIT_EVEN   ((uint32_t)0x00000004)
 
#define FUART_PARITY_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_PARITY_ENABLE   ((uint32_t)0x00000002)
 
#define FUART_STATIC_PARITY_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_STATIC_PARITY_ENABLE   ((uint32_t)0x00000080)
 
#define FUART_DATA_LENGTH_5   ((uint32_t)0x00000000)
 
#define FUART_DATA_LENGTH_6   ((uint32_t)0x00000020)
 
#define FUART_DATA_LENGTH_7   ((uint32_t)0x00000040)
 
#define FUART_DATA_LENGTH_8   ((uint32_t)0x00000060)
 
#define FUART_FIFO_LEVEL_4   ((uint32_t)0x00000000)
 
#define FUART_FIFO_LEVEL_8   ((uint32_t)0x00000001)
 
#define FUART_FIFO_LEVEL_16   ((uint32_t)0x00000002)
 
#define FUART_FIFO_LEVEL_24   ((uint32_t)0x00000003)
 
#define FUART_FIFO_LEVEL_28   ((uint32_t)0x00000004)
 
#define FUART_TX_INT_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_TX_INT_ENABLE   ((uint32_t)0x00000020)
 
#define FUART_RX_INT_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_RX_INT_ENABLE   ((uint32_t)0x00000010)
 
#define FUART_OV_ERR_INT_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_OV_ERR_INT_ENABLE   ((uint32_t)0x00000400)
 
#define FUART_BK_ERR_INT_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_BK_ERR_INT_ENABLE   ((uint32_t)0x00000200)
 
#define FUART_PA_ERR_INT_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_PA_ERR_INT_ENABLE   ((uint32_t)0x00000100)
 
#define FUART_FR_ERR_INT_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_FR_ERR_INT_ENABLE   ((uint32_t)0x00000080)
 
#define FUART_TO_ERR_INT_DISABLE   ((uint32_t)0x00000000)
 
#define FUART_TO_ERR_INT_ENABLE   ((uint32_t)0x00000040)
 
#define FUART_RANGE_K_MIN   ((uint32_t)0x00000000)
 
#define FUART_RANGE_K_MAX   ((uint32_t)0x0000003F)
 
#define FUART_RANGE_N_MIN   ((uint32_t)0x00000002)
 
#define FUART_RANGE_N_MAX   ((uint32_t)0x0000FFFF)
 
#define FUART_OVERRUN_NO_ERR   ((uint32_t)0x00000000)
 
#define FUART_OVERRUN_ERR   ((uint32_t)0x00000008)
 
#define FUART_BREAK_NO_ERR   ((uint32_t)0x00000000)
 
#define FUART_BREAK_ERR   ((uint32_t)0x00000004)
 
#define FUART_PARITY_NO_ERR   ((uint32_t)0x00000000)
 
#define FUART_PARITY_ERR   ((uint32_t)0x00000002)
 
#define FUART_FRAMING_NO_ERR   ((uint32_t)0x00000000)
 
#define FUART_FRAMING_ERR   ((uint32_t)0x00000001)
 
#define FUARTxFR_TXFE_MASK   ((uint32_t)0x00000080)
 
#define FUARTxFR_RXFF_MASK   ((uint32_t)0x00000040)
 
#define FUARTxFR_TXFF_MASK   ((uint32_t)0x00000020)
 
#define FUARTxFR_RXFE_MASK   ((uint32_t)0x00000010)
 
#define FUARTxFR_BUSY_MASK   ((uint32_t)0x00000008)
 
#define FUARTxFR_CTS_MASK   ((uint32_t)0x00000001)
 
#define FUARTxFR_TXFE_FLAG_SET   ((uint32_t)0x00000080)
 
#define FUARTxFR_RXFF_FLAG_SET   ((uint32_t)0x00000040)
 
#define FUARTxFR_TXFF_FLAG_SET   ((uint32_t)0x00000020)
 
#define FUARTxFR_RXFE_FLAG_SET   ((uint32_t)0x00000010)
 
#define FUARTxFR_BUSY_FLAG_SET   ((uint32_t)0x00000008)
 
#define FUARTxFR_CTS_FLAG_SET   ((uint32_t)0x00000001)
 
#define FUARTxFR_TXFE_FLAG_CLR   ((uint32_t)0x00000000)
 
#define FUARTxFR_RXFF_FLAG_CLR   ((uint32_t)0x00000000)
 
#define FUARTxFR_TXFF_FLAG_CLR   ((uint32_t)0x00000000)
 
#define FUARTxFR_RXFE_FLAG_CLR   ((uint32_t)0x00000000)
 
#define FUARTxFR_BUSY_FLAG_CLR   ((uint32_t)0x00000000)
 
#define FUARTxFR_CTS_FLAG_CLR   ((uint32_t)0x00000000)
 

Functions

TXZ_Result fuart_init (fuart_t *p_obj)
 
TXZ_Result fuart_deinit (fuart_t *p_obj)
 
TXZ_Result fuart_discard_transmit (fuart_t *p_obj)
 
TXZ_Result fuart_discard_receive (fuart_t *p_obj)
 
TXZ_Result fuart_transmitIt (fuart_t *p_obj, fuart_transmit_t *p_info)
 
TXZ_Result fuart_receiveIt (fuart_t *p_obj, fuart_receive_t *p_info)
 
void fuart_transmit_irq_handler (fuart_t *p_obj)
 
void fuart_receive_irq_handler (fuart_t *p_obj)
 
void fuart_error_irq_handler (fuart_t *p_obj)
 
void fuart_irq_handler (fuart_t *p_obj)
 
TXZ_Result fuart_get_status (fuart_t *p_obj, uint32_t *p_status)
 
TXZ_Result fuart_get_error (fuart_t *p_obj, uint32_t *p_error)
 
TXZ_Result fuart_get_boudrate_setting (uint32_t clock, uint32_t boudrate, fuart_boudrate_t *p_setting)
 

Detailed Description

This file provides all the functions prototypes for FUART driver.

Version
V1.0.0.0
Date
2017-08-06 10:43:01

DO NOT USE THIS SOFTWARE WITHOUT THE SOFTWARE LICENSE AGREEMENT.

Copyright(C) Toshiba Electronic Device Solutions Corporation 2019