Collaboration diagram for SCUART Exported Functions:

Macros
#define	SCUART_WRITE(sc, u8Data)
	Write Data to Tx data register. More...

#define	SCUART_GET_TX_EMPTY(sc)
	Get TX FIFO empty flag status from register. More...

#define	SCUART_GET_TX_FULL(sc)
	Get TX FIFO full flag status from register. More...

#define	SCUART_WAIT_TX_EMPTY(sc)
	Wait specified smartcard port transmission complete. More...

#define	SCUART_IS_TX_FULL(sc)
	Check specified smartcard port transmit FIFO is full or not. More...

#define	SCUART_IS_TX_EMPTY(sc)
	Check specified smartcard port transmission is over. More...

#define	SCUART_READ(sc)
	Read Rx data register. More...

#define	SCUART_GET_RX_EMPTY(sc)
	Get RX FIFO empty flag status from register. More...

#define	SCUART_GET_RX_FULL(sc)
	Get RX FIFO full flag status from register. More...

#define	SCUART_IS_RX_READY(sc)
	Check if receive data number in FIFO reach FIFO trigger level or not. More...

#define	SCUART_IS_RX_FULL(sc)
	Check specified smartcard port receive FIFO is full or not. More...

#define	SCUART_ENABLE_INT(sc, u32Mask)
	Enable specified interrupts. More...

#define	SCUART_DISABLE_INT(sc, u32Mask)
	Disable specified interrupts. More...

#define	SCUART_GET_INT_FLAG(sc, u32Type)
	Get specified interrupt flag/status. More...

#define	SCUART_CLR_INT_FLAG(sc, u32Type)
	Clear specified interrupt flag/status. More...

#define	SCUART_GET_ERR_FLAG(sc)
	Get receive error flag/status. More...

#define	SCUART_CLR_ERR_FLAG(sc, u32Mask)
	Clear specified receive error flag/status. More...

Functions
void	SCUART_Close (SC_T *sc)
	Disable smartcard uart interface. More...

uint32_t	SCUART_Open (SC_T *sc, uint32_t u32baudrate)
	Enable smartcard uart interface. More...

uint32_t	SCUART_Read (SC_T sc, uint8_t pu8RxBuf, uint32_t u32ReadBytes)
	Read data from smartcard UART interface. More...

uint32_t	SCUART_SetLineConfig (SC_T *sc, uint32_t u32Baudrate, uint32_t u32DataWidth, uint32_t u32Parity, uint32_t u32StopBits)
	This function use to config smartcard UART mode line setting. More...

void	SCUART_SetTimeoutCnt (SC_T *sc, uint32_t u32TOC)
	This function use to set receive timeout count. More...

uint32_t	SCUART_Write (SC_T sc, uint8_t pu8TxBuf, uint32_t u32WriteBytes)
	Write data to smartcard UART interface. More...

Detailed Description

Macro Definition Documentation

◆ SCUART_CLR_ERR_FLAG

#define SCUART_CLR_ERR_FLAG	(	sc,
		u32Mask
	)

Clear specified receive error flag/status.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32Mask	Receive error flag/status to clear, combination following values: SC_STATUS_PEF_Msk SC_STATUS_FEF_Msk SC_STATUS_BEF_Msk

Returns: None

The macro is used to clear receiver parity error flag, receiver frame error flag or receiver break error flag.

Definition at line 261 of file scuart.h.

◆ SCUART_CLR_INT_FLAG

#define SCUART_CLR_INT_FLAG	(	sc,
		u32Type
	)

Clear specified interrupt flag/status.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32Type	Interrupt flag/status to clear, could be the combination of following values: SC_INTSTS_RBTOIF_Msk SC_INTSTS_TERRIF_Msk SC_INTSTS_TBEIF_Msk

Returns: None

The macro is used to clear receiver buffer time-out interrupt flag, transfer error interrupt flag or transmit buffer empty interrupt flag.

Definition at line 234 of file scuart.h.

◆ SCUART_DISABLE_INT

#define SCUART_DISABLE_INT	(	sc,
		u32Mask
	)

Disable specified interrupts.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32Mask	Interrupt masks to disable, a combination of following bits. SC_INTEN_RXTOIF_Msk SC_INTEN_TERRIEN_Msk SC_INTEN_TBEIEN_Msk SC_INTEN_RDAIEN_Msk

Returns: None

The macro is used to disable receiver buffer time-out interrupt, transfer error interrupt, transmit buffer empty interrupt or receive data reach trigger level interrupt.

Definition at line 203 of file scuart.h.

◆ SCUART_ENABLE_INT

#define SCUART_ENABLE_INT	(	sc,
		u32Mask
	)

Enable specified interrupts.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32Mask	Interrupt masks to enable, a combination of following bits. SC_INTEN_RXTOIF_Msk SC_INTEN_TERRIEN_Msk SC_INTEN_TBEIEN_Msk SC_INTEN_RDAIEN_Msk

Returns: None

The macro is used to enable receiver buffer time-out interrupt, transfer error interrupt, transmit buffer empty interrupt or receive data reach trigger level interrupt.

Definition at line 188 of file scuart.h.

◆ SCUART_GET_ERR_FLAG

#define SCUART_GET_ERR_FLAG ( sc )

Get receive error flag/status.

Parameters

[in] sc The pointer of smartcard module.

Returns: Current receive error status, could one of following errors:

Return values

SC_STATUS_PEF_Msk	Parity error.
SC_STATUS_FEF_Msk	Frame error.
SC_STATUS_BEF_Msk	Break error.

The macro is used to get receiver parity error status, receiver frame error status or receiver break error status.

Definition at line 247 of file scuart.h.

◆ SCUART_GET_INT_FLAG

#define SCUART_GET_INT_FLAG	(	sc,
		u32Type
	)

Get specified interrupt flag/status.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32Type	Interrupt flag/status to check, could be one of following value: SC_INTSTS_RBTOIF_Msk SC_INTSTS_TERRIF_Msk SC_INTSTS_TBEIF_Msk SC_INTSTS_RDAIF_Msk

Returns: The status of specified interrupt.

Return values

0	Specified interrupt does not happened.
1	Specified interrupt happened.

The macro is used to get receiver buffer time-out interrupt status, transfer error interrupt status, transmit buffer empty interrupt status or receive data reach interrupt status.

Definition at line 220 of file scuart.h.

◆ SCUART_GET_RX_EMPTY

#define SCUART_GET_RX_EMPTY ( sc )

Get RX FIFO empty flag status from register.

Parameters

[in] sc The pointer of smartcard module.

Return values

0	Receive FIFO is not empty.
SC_STATUS_RXEMPTY_Msk	Receive FIFO is empty.

When the last byte of Rx buffer has been read by CPU, hardware sets RXEMPTY(SC_STATUS[1]) high. It will be cleared when SC receives any new data.

Definition at line 139 of file scuart.h.

◆ SCUART_GET_RX_FULL

#define SCUART_GET_RX_FULL ( sc )

Get RX FIFO full flag status from register.

Parameters

[in] sc The pointer of smartcard module.

Return values

0	Receive FIFO is not full.
SC_STATUS_TXFULL_Msk	Receive FIFO is full.

RXFULLF(SC_STATUS[2]) is set when RX pointer is equal to 4, otherwise it is cleared by hardware.

Definition at line 150 of file scuart.h.

◆ SCUART_GET_TX_EMPTY

#define SCUART_GET_TX_EMPTY ( sc )

Get TX FIFO empty flag status from register.

Parameters

[in] sc The pointer of smartcard module.

Returns: Transmit FIFO empty status.

Return values

0	Transmit FIFO is not empty.
SC_STATUS_TXEMPTY_Msk	Transmit FIFO is empty.

When the last byte of TX buffer has been transferred to Transmitter Shift Register, hardware sets TXEMPTY bit (SC_STATUS[9]) high. It will be cleared when writing data into DAT (SC_DAT[7:0]).

Definition at line 75 of file scuart.h.

◆ SCUART_GET_TX_FULL

#define SCUART_GET_TX_FULL ( sc )

Get TX FIFO full flag status from register.

Parameters

[in] sc The pointer of smartcard module.

Return values

0	Transmit FIFO is not full.
SC_STATUS_TXFULL_Msk	Transmit FIFO is full.

TXFULL(SC_STATUS[10]) is set when TX pointer is equal to 4, otherwise is cleared by hardware.

Definition at line 85 of file scuart.h.

◆ SCUART_IS_RX_FULL

#define SCUART_IS_RX_FULL ( sc )

Check specified smartcard port receive FIFO is full or not.

Parameters

[in] sc The pointer of smartcard module.

Return values

0	Receive FIFO is not full.
1	Receive FIFO is full.

RXFULLF(SC_STATUS[2]) is set when RX pointer is equal to 4, otherwise it is cleared by hardware.

Definition at line 171 of file scuart.h.

◆ SCUART_IS_RX_READY

#define SCUART_IS_RX_READY ( sc )

Check if receive data number in FIFO reach FIFO trigger level or not.

Parameters

[in] sc The pointer of smartcard module.

Return values

0	The number of bytes in receive FIFO is less than trigger level.
1	The number of bytes in receive FIFO equals or larger than trigger level.

RDAIF(SC_INTSTS[0]) is used for received data reaching trigger level RXTRGLV (SC_CTL[7:6]) interrupt status flag.

Note: If receive trigger level is not 1 byte, this macro return 0 does not necessary indicates there is no data in FIFO.

Definition at line 161 of file scuart.h.

◆ SCUART_IS_TX_EMPTY

#define SCUART_IS_TX_EMPTY ( sc )

Check specified smartcard port transmission is over.

Parameters

[in] sc The pointer of smartcard module.

Return values

0	Transmit is not complete.
1	Transmit complete.

TXACT (SC_STATUS[31]) is set by hardware when TX transfer is in active and the STOP bit of the last byte has been transmitted.

Definition at line 116 of file scuart.h.

◆ SCUART_IS_TX_FULL

#define SCUART_IS_TX_FULL ( sc )

Check specified smartcard port transmit FIFO is full or not.

Parameters

[in] sc The pointer of smartcard module.

Return values

0	Transmit FIFO is not full.
1	Transmit FIFO is full.

TXFULL(SC_STATUS[10]) indicates TX buffer full or not. This is set when TX pointer is equal to 4, otherwise is cleared by hardware.

Definition at line 106 of file scuart.h.

◆ SCUART_READ

#define SCUART_READ ( sc )

Read Rx data register.

Parameters

[in] sc The pointer of smartcard module.

Returns: The oldest data byte in RX FIFO.

By reading DAT register, the SC will return an 8-bit received data.

Definition at line 128 of file scuart.h.

◆ SCUART_WAIT_TX_EMPTY

#define SCUART_WAIT_TX_EMPTY ( sc )

Wait specified smartcard port transmission complete.

Parameters

[in] sc The pointer of smartcard module.

Returns: None

TXACT (SC_STATUS[31]) is cleared automatically when TX transfer is finished or the last byte transmission has completed.

Note: This macro blocks until transmit complete.

Definition at line 95 of file scuart.h.

◆ SCUART_WRITE

#define SCUART_WRITE	(	sc,
		u8Data
	)

Write Data to Tx data register.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u8Data	Data byte to transmit.

Returns: None

By writing data to DAT register, the SC will send out an 8-bit data.

Definition at line 63 of file scuart.h.

Function Documentation

◆ SCUART_Close()

void SCUART_Close ( SC_T * sc )

Disable smartcard uart interface.

Parameters

sc	The pointer of smartcard module.

Returns: None

The function is used to disable smartcard interface UART mode.

Definition at line 34 of file scuart.c.

◆ SCUART_Open()

HIDDEN_SYMBOLS uint32_t SCUART_Open	(	SC_T *	sc,
		uint32_t	u32baudrate
	)

Enable smartcard uart interface.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32baudrate	Target baudrate of smartcard module.

Returns: Actual baudrate of smartcard mode.

This function use to enable smartcard module UART mode and set baudrate.

Note: This function configures character width to 8 bits, 1 stop bit, and no parity. And can use SCUART_SetLineConfig function to update these settings.

Definition at line 113 of file scuart.c.

◆ SCUART_Read()

uint32_t SCUART_Read	(	SC_T *	sc,
		uint8_t *	pu8RxBuf,
		uint32_t	u32ReadBytes
	)

Read data from smartcard UART interface.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	pu8RxBuf	The buffer to store receive the data.
[in]	u32ReadBytes	Target number of characters to receive.

Returns: Actual character number reads to buffer.

The function is used to read Rx data from RX FIFO.

Note: This function does not block and return immediately if there's no data available.

Definition at line 136 of file scuart.c.

◆ SCUART_SetLineConfig()

uint32_t SCUART_SetLineConfig	(	SC_T *	sc,
		uint32_t	u32Baudrate,
		uint32_t	u32DataWidth,
		uint32_t	u32Parity,
		uint32_t	u32StopBits
	)

This function use to config smartcard UART mode line setting.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32Baudrate	Target baudrate of smartcard module. If this value is 0, UART baudrate will not change.
[in]	u32DataWidth	The data length, could be: SCUART_CHAR_LEN_5 SCUART_CHAR_LEN_6 SCUART_CHAR_LEN_7 SCUART_CHAR_LEN_8
[in]	u32Parity	The parity setting, could be: SCUART_PARITY_NONE SCUART_PARITY_ODD SCUART_PARITY_EVEN
[in]	u32StopBits	The stop bit length, could be: SCUART_STOP_BIT_1 SCUART_STOP_BIT_2

Returns: Actual baudrate of smartcard.

Smartcard UART mode is operated in LIN data frame.

Definition at line 171 of file scuart.c.

◆ SCUART_SetTimeoutCnt()

void SCUART_SetTimeoutCnt	(	SC_T *	sc,
		uint32_t	u32TOC
	)

This function use to set receive timeout count.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	u32TOC	Rx timeout counter, using baudrate as counter unit. Valid range are 0~0x1FF, set this value to 0 will disable timeout counter.

Returns: None

The time-out counter resets and starts counting whenever the RX buffer received a new data word. Once the counter decrease to 1 and no new data is received or CPU does not read any data from FIFO, a receiver time-out interrupt will be generated.

Definition at line 203 of file scuart.c.

◆ SCUART_Write()

uint32_t SCUART_Write	(	SC_T *	sc,
		uint8_t *	pu8TxBuf,
		uint32_t	u32WriteBytes
	)

Write data to smartcard UART interface.

Parameters

[in]	sc	The pointer of smartcard module.
[in]	pu8TxBuf	The buffer containing data to send to transmit FIFO.
[in]	u32WriteBytes	Number of data to send.

Returns: Actual number of data put into SCUART Tx FIFO

Note: This function sets g_SCUART_i32ErrCode to SCUART_TIMEOUT_ERR if the Tx FIFO blocks longer than expected.

Definition at line 218 of file scuart.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ SCUART_CLR_ERR_FLAG

◆ SCUART_CLR_INT_FLAG

◆ SCUART_DISABLE_INT

◆ SCUART_ENABLE_INT

◆ SCUART_GET_ERR_FLAG

◆ SCUART_GET_INT_FLAG

◆ SCUART_GET_RX_EMPTY

◆ SCUART_GET_RX_FULL

◆ SCUART_GET_TX_EMPTY

◆ SCUART_GET_TX_FULL

◆ SCUART_IS_RX_FULL

◆ SCUART_IS_RX_READY

◆ SCUART_IS_TX_EMPTY

◆ SCUART_IS_TX_FULL

◆ SCUART_READ

◆ SCUART_WAIT_TX_EMPTY

◆ SCUART_WRITE

Function Documentation

◆ SCUART_Close()

◆ SCUART_Open()

◆ SCUART_Read()

◆ SCUART_SetLineConfig()

◆ SCUART_SetTimeoutCnt()

◆ SCUART_Write()