TMPM4KxA Group Peripheral Driver User Manual  V1.0.4.0
Functions
TSPI Exported Functions

Functions

TXZ_Result tspi_init (tspi_t *p_obj)
 Initialize the TSPI object. More...
 
TXZ_Result tspi_deinit (tspi_t *p_obj)
 Release the TSPI object. More...
 
TXZ_Result tspi_format (tspi_t *p_obj)
 Data Format setting. More...
 
TXZ_Result tspi_master_write (tspi_t *p_obj, tspi_transmit_t *p_info, uint32_t timeout)
 Transmit data.. More...
 
TXZ_Result tspi_master_read (tspi_t *p_obj, tspi_receive_t *p_info, uint32_t timeout)
 Receive data. Blocking Communication. More...
 
TXZ_Result tspi_master_transfer (tspi_t *p_obj, tspi_transmit_t *p_info)
 Transmit data. Non-Blocking Communication. More...
 
TXZ_Result tspi_master_receive (tspi_t *p_obj, tspi_receive_t *p_info)
 Receive data. Non-Blocking Communication. More...
 
void tspi_irq_handler_transmit (tspi_t *p_obj)
 IRQ Handler for transmit. More...
 
void tspi_irq_handler_receive (tspi_t *p_obj)
 IRQ Handler for receive. More...
 
void tspi_error_irq_handler (tspi_t *p_obj)
 IRQ Handler for error. More...
 
TXZ_Result tspi_get_status (tspi_t *p_obj, uint32_t *p_status)
 Get status. More...
 
TXZ_Result tspi_get_error (tspi_t *p_obj, uint32_t *p_error)
 Get error information. More...
 
TXZ_Result tspi_error_clear (tspi_t *p_obj)
 Error information clear. More...
 
TXZ_Result tspi_discard_transmit (tspi_t *p_obj)
 Discard transmit. More...
 
TXZ_Result tspi_discard_receive (tspi_t *p_obj)
 Discard receive. More...
 
TXZ_Result tspi_dma_init (tspi_dma_t *p_obj)
 Initialize the TSPI DMA object. More...
 
TXZ_Result tspi_dma_deinit (tspi_dma_t *p_obj)
 Release the TSPI DMA object. More...
 
TXZ_Result tspi_dma_discard_transmit (tspi_dma_t *p_obj)
 Discard transmit. More...
 
TXZ_Result tspi_dma_discard_receive (tspi_dma_t *p_obj)
 Discard receive. More...
 
TXZ_Result tspi_dma_transmitIt (tspi_dma_t *p_obj, tspi_transmit_t *p_info)
 Transmit data. Non-Blocking Communication. More...
 
TXZ_Result tspi_dma_receiveIt (tspi_dma_t *p_obj, tspi_receive_t *p_info)
 Receive data. Non-Blocking Communication. More...
 

Detailed Description

Function Documentation

◆ tspi_deinit()

TXZ_Result tspi_deinit ( tspi_t p_obj)

Release the TSPI object.

Parameters
p_obj:TSPI object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, "Failure" is returned.
Attention
This function is not available in interrupt.

◆ tspi_discard_receive()

TXZ_Result tspi_discard_receive ( tspi_t p_obj)

Discard receive.

Parameters
p_obj:TSPI object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
This function clears receive's fifo, end flag and error info.
Attention
This function is not available in interrupt.
Use after interrupt is disabled.

◆ tspi_discard_transmit()

TXZ_Result tspi_discard_transmit ( tspi_t p_obj)

Discard transmit.

Parameters
p_obj:TSPI object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
This function clears transmit's fifo, end flag and error info.
Attention
This function is not available in interrupt.
Use after interrupt is disabled.

◆ tspi_dma_deinit()

TXZ_Result tspi_dma_deinit ( tspi_dma_t p_obj)

Release the TSPI DMA object.

Parameters
p_obj:TSPI DMA object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ tspi_dma_discard_receive()

TXZ_Result tspi_dma_discard_receive ( tspi_dma_t p_obj)

Discard receive.

Parameters
p_obj:TSPI DMA object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
This function clears receive's fifo, end flag and error info.
Attention
This function is not available in interrupt.
Use after interrupt is disabled.

◆ tspi_dma_discard_transmit()

TXZ_Result tspi_dma_discard_transmit ( tspi_dma_t p_obj)

Discard transmit.

Parameters
p_obj:TSPI DMA object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
This function clears transmit's fifo, end flag and error info.
Attention
This function is not available in interrupt.
Use after interrupt is disabled.

◆ tspi_dma_init()

TXZ_Result tspi_dma_init ( tspi_dma_t p_obj)

Initialize the TSPI DMA object.

Parameters
p_obj:TSPI DMA object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ tspi_dma_receiveIt()

TXZ_Result tspi_dma_receiveIt ( tspi_dma_t p_obj,
tspi_receive_t p_info 
)

Receive data. Non-Blocking Communication.

Parameters
p_obj:TSPI DMA object.
p_info:The information of receive buffer.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
Asynchronous Processing.
Attention
"p_info->rx8(or rx16).num" must be over FIFO max(Refer FIFO MAX) num.
This function is not available in interrupt.

◆ tspi_dma_transmitIt()

TXZ_Result tspi_dma_transmitIt ( tspi_dma_t p_obj,
tspi_transmit_t p_info 
)

Transmit data. Non-Blocking Communication.

Parameters
p_obj:TSPI DMA object.
p_info:The information of transmit data.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
Asynchronous Processing.
Attention
This function is not available in interrupt.

◆ tspi_error_clear()

TXZ_Result tspi_error_clear ( tspi_t p_obj)

Error information clear.

Error bits.

Bit Bit Symbol Function
31-3 - -
3 TRGERR Trigger Error. Use Triger Error.
2 UDRERR Overrun Error. Use Underrun Error.
1 OVRERR Overrun Error. Use Overrun Error.
0 PERR Parity Error. Use Parity Error.
Parameters
p_obj:TSPI object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, "Failure" is returned.
When p_error is NULL, "Failure" is returned.

◆ tspi_error_irq_handler()

void tspi_error_irq_handler ( tspi_t p_obj)

IRQ Handler for error.

Parameters
p_obj:TSPI object.
Return values
-
Note
-

◆ tspi_format()

TXZ_Result tspi_format ( tspi_t p_obj)

Data Format setting.

Parameters
p_obj:TSPI object.
Return values
-
Note
When p_obj is NULL, no processing.

◆ tspi_get_error()

TXZ_Result tspi_get_error ( tspi_t p_obj,
uint32_t *  p_error 
)

Get error information.

Error bits.

Bit Bit Symbol Function
31-3 - -
2 UDRERR Overrun Error. Use Underrun Error.
1 OVRERR Overrun Error. Use Overrun Error.
0 PERR Parity Error. Use Parity Error.
Parameters
p_obj:TSPI object.
p_error:Save area for error.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, "Failure" is returned.
When p_error is NULL, "Failure" is returned.

◆ tspi_get_status()

TXZ_Result tspi_get_status ( tspi_t p_obj,
uint32_t *  p_status 
)

Get status.

Status bits.

Bit Bit Symbol Function
31 SUE Setting Enable Flag. Use Status Setting Flag.
30-24 - -
23 TXRUN Transmitting State Flag. Use Transmitting State Flag.
22 TXEND Transmitting Done Flag. Use Transmitting Complete Flag.
21 INTTXWF Transmitting FIFO Interrpt Flag. Use Transmitting FIFO Interrpt Flag.
20 TFEMP Transmitting FIFO Empty Flag. Use Transmitting FIFO Empty Flag.
19-16 TLVL Current Transmitting FIFO Level. Current Transmitting FIFO Level.
15-8 - -
7 RXRUN Receive State Flag. Use Receive State Flag.
6 RXEND Receive Done Flag. Use Receive Complete Flag.
5 INTRXFF Receiving FIFO Interrpt Flag. Use Receiving FIFO Interrpt Flag.
4 RXFLL Receiving FIFO Full Flag. Use Receiving FIFO Full Flag
3-0 RLVL Current Receive FIFO Level. Use Receiving FIFO Full Flag
Parameters
p_obj:TSPI object.
p_status:Save area for status.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, "Failure" is returned.
When p_status is NULL, "Failure" is returned.

◆ tspi_init()

TXZ_Result tspi_init ( tspi_t p_obj)

Initialize the TSPI object.

Parameters
p_obj:TSPI object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, "Failure" is returned.
Attention
This function is not available in interrupt.

◆ tspi_irq_handler_receive()

void tspi_irq_handler_receive ( tspi_t p_obj)

IRQ Handler for receive.

Parameters
p_obj:TSPI object.
Return values
-
Note
-

◆ tspi_irq_handler_transmit()

void tspi_irq_handler_transmit ( tspi_t p_obj)

IRQ Handler for transmit.

Parameters
p_obj:TSPI object.
Return values
-
Note
-

◆ tspi_master_read()

TXZ_Result tspi_master_read ( tspi_t p_obj,
tspi_receive_t p_info,
uint32_t  timeout 
)

Receive data. Blocking Communication.

Parameters
p_obj:TSPI object.
p_info:The information of receive buffer.
timeout:Timeout duration.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, "Failure" is returned.
When p_info is NULL, "Failure" is returned.

◆ tspi_master_receive()

TXZ_Result tspi_master_receive ( tspi_t p_obj,
tspi_receive_t p_info 
)

Receive data. Non-Blocking Communication.

Parameters
p_obj:TSPI object.
p_info:The information of receive buffer.
Return values
SUCCESS:Success.
FAILURE:Failure.
Note
Asynchronous Processing.
Attention
"p_info->rx8(or rx16).num" must be over FIFO max(Refer Current Transmitting FIFO Level) num.
This function is not available in interrupt.

◆ tspi_master_transfer()

TXZ_Result tspi_master_transfer ( tspi_t p_obj,
tspi_transmit_t p_info 
)

Transmit data. Non-Blocking Communication.

Parameters
p_obj:TSPI object.
p_info:The information of transmit data.
Return values
SUCCESS:Success.
FAILURE:Failure.
Note
Asynchronous Processing.
Attention
This function is not available in interrupt.

◆ tspi_master_write()

TXZ_Result tspi_master_write ( tspi_t p_obj,
tspi_transmit_t p_info,
uint32_t  timeout 
)

Transmit data..

Parameters
p_obj:TSPI object.
p_info:The information of transmit data.
timeout:Timeout duration.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, "Failure" is returned.
When p_info is NULL, "Failure" is returned.