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

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

Functions

__STATIC_INLINE int32_t check_param_priority (uint32_t param)
 Check the Priority's parameter. More...
 
__STATIC_INLINE int32_t check_param_burst (uint32_t param)
 Check the Use Burst's parameter. More...
 
__STATIC_INLINE int32_t check_param_dest_inc (uint32_t param)
 Check the Destination Address Increment Type's parameter. More...
 
__STATIC_INLINE int32_t check_param_dest_size (uint32_t param)
 Check the Destination Data Size's parameter. More...
 
__STATIC_INLINE int32_t check_param_src_inc (uint32_t param)
 Check the Source Address Increment Type's parameter. More...
 
__STATIC_INLINE int32_t check_param_src_size (uint32_t param)
 Check the Source Data Size's parameter. More...
 
__STATIC_INLINE int32_t check_param_arbitration_num (uint32_t param)
 Check the Arbitration Timing's parameter. More...
 
__STATIC_INLINE int32_t check_param_transfer_num (uint32_t param)
 Check the Transfer Num Range's parameter. More...
 
__STATIC_INLINE int32_t check_param_primary_base_address (uint32_t num, uint32_t param)
 Check the primary base address. More...
 
TXZ_Result dma_init (dma_t *p_obj)
 Initialize the DMA object. More...
 
TXZ_Result dma_deinit (dma_t *p_obj)
 Release the DMA object. More...
 
void dma_irq_handler (dma_t *p_obj, uint32_t ch)
 IRQ handler. More...
 
void dma_error_irq_handler (dma_t *p_obj)
 Error IRQ handler. More...
 
TXZ_Result dma_get_error (dma_t *p_obj, uint32_t *p_err)
 Get Error. More...
 
TXZ_Result dma_clear_error (dma_t *p_obj)
 Clear Error. More...
 
TXZ_Result dma_ch_init (dma_t *p_obj, uint32_t ch)
 Initialize the DMA channel object. More...
 
TXZ_Result dma_ch_deinit (dma_t *p_obj, uint32_t ch)
 Release the DMA channel object. More...
 
TXZ_Result dma_startIt (dma_t *p_obj, uint32_t ch, dma_cfg_t *p_cfg)
 Start DMA mode. More...
 
TXZ_Result dma_stopIt (dma_t *p_obj, uint32_t ch)
 Stop DMA mode. More...
 

Variables

 C
 

Detailed Description

This file provides API functions for DMA driver.

Version
V1.0.0.6
Date
2017-10-26 11:43:55

DO NOT USE THIS SOFTWARE WITHOUT THE SOFTWARE LICENSE AGREEMENT.

(C)Copyright TOSHIBA MICROELECTRONICS CORPORATION 2017 All rights reserved

Function Documentation

◆ check_param_arbitration_num()

__STATIC_INLINE int32_t check_param_arbitration_num ( uint32_t  param)

Check the Arbitration Timing's parameter.

Parameters
param:Arbitration Timing's parameter
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
Macro definition is Arbitration Timing"DMA_ARBITRATION_xxxx".

◆ check_param_burst()

__STATIC_INLINE int32_t check_param_burst ( uint32_t  param)

Check the Use Burst's parameter.

Parameters
param:Use Burst's parameter
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
Macro definition is Use Burst"DMA_BURST_xxxx".

◆ check_param_dest_inc()

__STATIC_INLINE int32_t check_param_dest_inc ( uint32_t  param)

Check the Destination Address Increment Type's parameter.

Parameters
param:Destination Address Increment Type's parameter
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
Macro definition is Destination Address Increment Type"DMA_DST_INC_xxxx".

◆ check_param_dest_size()

__STATIC_INLINE int32_t check_param_dest_size ( uint32_t  param)

Check the Destination Data Size's parameter.

Parameters
param:Destination Data Size's parameter
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
Macro definition is Destination Data Size"DMA_DST_SIZE_xxxx".

◆ check_param_primary_base_address()

__STATIC_INLINE int32_t check_param_primary_base_address ( uint32_t  num,
uint32_t  param 
)

Check the primary base address.

Parameters
num:Num of total channel.
param:Primary base address.
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
-

◆ check_param_priority()

__STATIC_INLINE int32_t check_param_priority ( uint32_t  param)

Check the Priority's parameter.

Parameters
param:Priority's parameter
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
Macro definition is Priority"DMA_PRIORITY_xxxx".

◆ check_param_src_inc()

__STATIC_INLINE int32_t check_param_src_inc ( uint32_t  param)

Check the Source Address Increment Type's parameter.

Parameters
param:Source Address Increment Type's parameter
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
Macro definition is Source Address Increment Type"DMA_SRC_INC_xxxx".

◆ check_param_src_size()

__STATIC_INLINE int32_t check_param_src_size ( uint32_t  param)

Check the Source Data Size's parameter.

Parameters
param:Source Data Size's parameter
Return values
DMA_PARAM_OK:Valid
DMA_PARAM_NG:Invalid
Note
Macro definition is Source Data Size"DMA_SRC_SIZE_xxxx".

◆ check_param_transfer_num()

__STATIC_INLINE int32_t check_param_transfer_num ( uint32_t  param)

Check the Transfer Num Range's parameter.

Parameters
param:Transfer Num Range's parameter
Return values
ADC_PARAM_OK:Valid
ADC_PARAM_NG:Invalid
Note
Macro definition is Transfer Num Range"DMA_TRANS_NUM_RANGE_xxxx".