RZ/A1H CMSIS-RTOS RTX BSP for GR-PEACH.
Dependents: GR-PEACH_Azure_Speech ImageZoomInout_Sample ImageRotaion_Sample ImageScroll_Sample ... more
Fork of R_BSP by
dma_if.h File Reference
DMA Driver interface headers. More...
Go to the source code of this file.
Functions | |
int_t | R_DMA_Init (const dma_drv_init_t *const p_dma_init_param, int32_t *const p_errno) |
Function Name: R_DMA_Init Init DMA driver. | |
int_t | R_DMA_UnInit (int32_t *const p_errno) |
Function Name: R_DMA_UnInit UnInit DMA driver. | |
int_t | R_DMA_Alloc (const int_t channel, int32_t *const p_errno) |
Function Name: R_DMA_Alloc Open DMA channel. | |
int_t | R_DMA_Free (const int_t channel, int32_t *const p_errno) |
Function Name: R_DMA_Free Close DMA channel. | |
int_t | R_DMA_Setup (const int_t channel, const dma_ch_setup_t *const p_ch_setup, int32_t *const p_errno) |
Function Name: R_DMA_Setup Setup DMA transfer parameter. | |
int_t | R_DMA_Start (const int_t channel, const dma_trans_data_t *const p_dma_data, int32_t *const p_errno) |
Function Name: R_DMA_Start Start DMA transfer. | |
int_t | R_DMA_NextData (const int_t channel, const dma_trans_data_t *const p_dma_data, int32_t *const p_errno) |
Function Name: R_DMA_NextData Set continous DMA mode. | |
int_t | R_DMA_Cancel (const int_t channel, uint32_t *const p_remain, int32_t *const p_errno) |
Function Name: R_DMA_Cancel Cancel DMA transfer. | |
uint16_t | R_DMA_GetVersion (void) |
Function Name: R_DMA_GetVersion. |
Detailed Description
DMA Driver interface headers.
- Rev:
- 1318
- Date:
- 2014-12-04 10:45:12 +0900#
Definition in file dma_if.h.
Function Documentation
int_t R_DMA_Alloc | ( | const int_t | channel, |
int32_t *const | p_errno | ||
) |
Function Name: R_DMA_Alloc Open DMA channel.
Check parameter in this function mainly.
Description:
- Parameters:
-
[in] channel :Open channel number. If channel is (-1), it looking for free chanel and allocate. [in,out] p_errno :Pointer of error code When pointer is NULL, it isn't set error code. error code - EINVAL : Value of the ch is outside the range of DMA_ALLOC_CH(-1) <= ch < DMA_CH_NUM. EACCES : Driver status isn't DMA_DRV_INIT. EBUSY : It has been allocated already in channel. EMFILE : When looking for a free channel, but a free channel didn't exist. ENOTSUP : Channel status is DMA_CH_UNINIT. EFAULT: Channel status is besides the status definded in dma_stat_ch_t.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
int_t R_DMA_Cancel | ( | const int_t | channel, |
uint32_t *const | p_remain, | ||
int32_t *const | p_errno | ||
) |
Function Name: R_DMA_Cancel Cancel DMA transfer.
Check parameter in this function mainly.
Description:
- Parameters:
-
[in] channel :Cancel DMA channel number. [in] p_remain :Remain data size of DMA transfer when it stopping. [in,out] p_errno :Pointer of error code When pointer is NULL, it isn't set error code. error code - EBADF : Channel status is DMA_CH_INIT or DMA_CH_OPEN. (DMA stopped) EINVAL : Value of the ch is outside the range of (-1) < ch < (DMA_CH_NUM + 1). ENOTSUP : Channel status is DMA_CH_UNINIT. EFAULT: Channel status is besides the status definded in dma_stat_ch_t. p_remain is NULL.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
int_t R_DMA_Free | ( | const int_t | channel, |
int32_t *const | p_errno | ||
) |
Function Name: R_DMA_Free Close DMA channel.
Check parameter in this function mainly.
Description:
- Parameters:
-
[in] channel :Close channel number. [in,out] p_errno :Pointer of error code When pointer is NULL, it isn't set error code. error code - EBADF : Channel status is DMA_CH_INIT. EINVAL : Value of the ch is outside the range of (-1) < ch < (DMA_CH_NUM + 1). EACCES : Driver status isn't DMA_DRV_INIT. EBUSY : It has been start DMA transfer in channel. ENOTSUP : Channel status is DMA_CH_UNINIT. EFAULT: Channel status is besides the status definded in dma_stat_ch_t.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
uint16_t R_DMA_GetVersion | ( | void | ) |
int_t R_DMA_Init | ( | const dma_drv_init_t *const | p_dma_init_param, |
int32_t *const | p_errno | ||
) |
Function Name: R_DMA_Init Init DMA driver.
Check parameter in this function.
Description:
- Parameters:
-
[in] p_dma_init_param :Point of driver init parameter. [in,out] p_errno :Pointer of error code. When pointer is NULL, it isn't set error code. error code - OS error num : Registering handler failed. EPERM : Pointer of callback function which called in DMA error interrupt handler is NULL. EFAULT : dma_init_param is NULL.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
int_t R_DMA_NextData | ( | const int_t | channel, |
const dma_trans_data_t *const | p_dma_data, | ||
int32_t *const | p_errno | ||
) |
Function Name: R_DMA_NextData Set continous DMA mode.
Check parameter in this function mainly.
Description:
- Parameters:
-
[in] channel :Continuous DMA channel number. [in,out] p_dma_data:DMA address parameters. [in,out] p_errno :Pointer of error code When pointer is NULL, it isn't set error code. error code - EBADF : Channel status is DMA_CH_INIT. EINVAL : Value of the ch is outside the range of (-1) < ch < (DMA_CH_NUM + 1). EBUSY : It has been set continous DMA transfer. ENOTSUP : Channel status is DMA_CH_UNINIT. EPERM : The value in p_ch_setup isn't in the right range. EFAULT: Channel status is besides the status definded in dma_stat_ch_t. p_dma_data is NULL.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
int_t R_DMA_Setup | ( | const int_t | channel, |
const dma_ch_setup_t *const | p_ch_setup, | ||
int32_t *const | p_errno | ||
) |
Function Name: R_DMA_Setup Setup DMA transfer parameter.
Check parameter in this function mainly.
Description:
- Parameters:
-
[in] channel :Setup channel number. [in] p_ch_setup:Set up parameters. [in,out] p_errno :Pointer of error code When pointer is NULL, it isn't set error code. error code - EBADF : Channel status is DMA_CH_INIT. EINVAL : Value of the ch is outside the range of (-1) < ch < (DMA_CH_NUM + 1). EBUSY : It has been start DMA transfer in channel. ENOTSUP : Channel status is DMA_CH_UNINIT. EPERM : The value in p_ch_setup isn't in the right range. EFAULT: Channel status is besides the status definded in dma_stat_ch_t. p_ch_setup is NULL.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
int_t R_DMA_Start | ( | const int_t | channel, |
const dma_trans_data_t *const | p_dma_data, | ||
int32_t *const | p_errno | ||
) |
Function Name: R_DMA_Start Start DMA transfer.
Check parameter in this function mainly.
Description:
- Parameters:
-
[in] channel :DMA start channel number. [in] p_dma_data:DMA address parameters. [in,out] p_errno :Pointer of error code When pointer is NULL, it isn't set error code. error code - EBADF : Channel status is DMA_CH_INIT. EINVAL : Value of the ch is outside the range of (-1) < ch < (DMA_CH_NUM + 1). EBUSY : It has been start DMA transfer in channel. ENOTSUP : Channel status is DMA_CH_UNINIT. EPERM : The value in p_ch_setup isn't in the right range. EFAULT: Channel status is besides the status definded in dma_stat_ch_t. p_dma_data is NULL.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
int_t R_DMA_UnInit | ( | int32_t *const | p_errno ) |
Function Name: R_DMA_UnInit UnInit DMA driver.
Check parameter in this function.
Description:
- Parameters:
-
[in,out] p_errno :Pointer of error code When pointer is NULL, it isn't set error code. error code - OS error num : Unegistering handler failed. EACCES : Driver status isn't DMA_DRV_INIT. EBUSY : It has been allocated already in channel. EFAULT : Channel status is besides the status definded in dma_stat_ch_t.
- Return values:
-
ESUCCESS - Operation successful. EERROR - Error occured.
Generated on Tue Jul 12 2022 20:43:58 by 1.7.2