TMPM4KxA Group Peripheral Driver User Manual  V1.0.4.0
Functions | Variables
txz_tspi_dma.c File Reference

This file provides API functions for TSPI driver. More...

Functions

__STATIC_INLINE int32_t check_param_rx_type (uint32_t param)
 Check the Rx DMA transfer type's parameter. More...
 
__STATIC_INLINE int32_t check_param_tx_type (uint32_t param)
 Check the Tx DMA transfer type's parameter. 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...
 

Variables

 C
 

Detailed Description

This file provides API functions for TSPI driver.

If DMA transfer is used, it is necessary.

Version
V1.0.0.5
Date
2017-11-08 15:02:28

DO NOT USE THIS SOFTWARE WITHOUT THE SOFTWARE LICENSE AGREEMENT.

(C)Copyright TOSHIBA MICROELECTRONICS CORPORATION 2017 All rights reserved

Function Documentation

◆ check_param_rx_type()

__STATIC_INLINE int32_t check_param_rx_type ( uint32_t  param)

Check the Rx DMA transfer type's parameter.

Parameters
param:Rx DMA transfer type's parameter
Return values
TSPI_PARAM_OK:Valid
TSPI_PARAM_NG:Invalid
Note
Macro definition is Transfer Type"TSPI_DMA_TYPE_xxxx".
Parameters
param:Rx DMA transfer type's parameter
Return values
UART_PARAM_OK:Valid
UART_PARAM_NG:Invalid
Note
Macro definition is Transfer Type"UART_DMA_TYPE_xxxx".

◆ check_param_tx_type()

__STATIC_INLINE int32_t check_param_tx_type ( uint32_t  param)

Check the Tx DMA transfer type's parameter.

Parameters
param:Tx DMA transfer type's parameter
Return values
TSPI_PARAM_OK:Valid
TSPI_PARAM_NG:Invalid
Note
Macro definition is Transfer Type"TSPI_DMA_TYPE_xxxx".