/**************************************************************************//** | |
* @file pdma.h | |
* @version V3.00 | |
* @brief M2351 series PDMA driver header file | |
* | |
* @note | |
* Copyright (C) 2017 Nuvoton Technology Corp. All rights reserved. | |
*****************************************************************************/ | |
#ifndef __PDMA_H__ | |
#define __PDMA_H__ | |
#ifdef __cplusplus | |
extern "C" | |
{ | |
#endif | |
/** @addtogroup Standard_Driver Standard Driver | |
@{ | |
*/ | |
/** @addtogroup PDMA_Driver PDMA Driver | |
@{ | |
*/ | |
/** @addtogroup PDMA_EXPORTED_CONSTANTS PDMA Exported Constants | |
@{ | |
*/ | |
#define PDMA_CH_MAX 8UL /*!< Specify Maximum Channels of PDMA \hideinitializer */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Operation Mode Constant Definitions */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
#define PDMA_OP_STOP 0x00000000UL /*!<DMA Stop Mode \hideinitializer */ | |
#define PDMA_OP_BASIC 0x00000001UL /*!<DMA Basic Mode \hideinitializer */ | |
#define PDMA_OP_SCATTER 0x00000002UL /*!<DMA Scatter-gather Mode \hideinitializer */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Data Width Constant Definitions */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
#define PDMA_WIDTH_8 0x00000000UL /*!<DMA Transfer Width 8-bit \hideinitializer */ | |
#define PDMA_WIDTH_16 0x00001000UL /*!<DMA Transfer Width 16-bit \hideinitializer */ | |
#define PDMA_WIDTH_32 0x00002000UL /*!<DMA Transfer Width 32-bit \hideinitializer */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Address Attribute Constant Definitions */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
#define PDMA_SAR_INC 0x00000000UL /*!<DMA SAR increment \hideinitializer */ | |
#define PDMA_SAR_FIX 0x00000300UL /*!<DMA SAR fix address \hideinitializer */ | |
#define PDMA_DAR_INC 0x00000000UL /*!<DMA DAR increment \hideinitializer */ | |
#define PDMA_DAR_FIX 0x00000C00UL /*!<DMA DAR fix address \hideinitializer */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Burst Mode Constant Definitions */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
#define PDMA_REQ_SINGLE 0x00000004UL /*!<DMA Single Request \hideinitializer */ | |
#define PDMA_REQ_BURST 0x00000000UL /*!<DMA Burst Request \hideinitializer */ | |
#define PDMA_BURST_128 0x00000000UL /*!<DMA Burst 128 Transfers \hideinitializer */ | |
#define PDMA_BURST_64 0x00000010UL /*!<DMA Burst 64 Transfers \hideinitializer */ | |
#define PDMA_BURST_32 0x00000020UL /*!<DMA Burst 32 Transfers \hideinitializer */ | |
#define PDMA_BURST_16 0x00000030UL /*!<DMA Burst 16 Transfers \hideinitializer */ | |
#define PDMA_BURST_8 0x00000040UL /*!<DMA Burst 8 Transfers \hideinitializer */ | |
#define PDMA_BURST_4 0x00000050UL /*!<DMA Burst 4 Transfers \hideinitializer */ | |
#define PDMA_BURST_2 0x00000060UL /*!<DMA Burst 2 Transfers \hideinitializer */ | |
#define PDMA_BURST_1 0x00000070UL /*!<DMA Burst 1 Transfers \hideinitializer */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Table Interrupt Disable Constant Definitions */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
#define PDMA_TBINTDIS_ENABLE (0x0UL<<PDMA_DSCT_CTL_TBINTDIS_Pos) /*!<DMA Table Interrupt Enabled \hideinitializer */ | |
#define PDMA_TBINTDIS_DISABLE (0x1UL<<PDMA_DSCT_CTL_TBINTDIS_Pos) /*!<DMA Table Interrupt Disabled \hideinitializer */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Peripheral Transfer Mode Constant Definitions */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
#define PDMA_MEM 0x00000000UL /*!<DMA Connect to Memory \hideinitializer */ | |
#define PDMA_USB_TX 0x00000002UL /*!<DMA Connect to USB TX \hideinitializer */ | |
#define PDMA_USB_RX 0x00000003UL /*!<DMA Connect to USB RX \hideinitializer */ | |
#define PDMA_UART0_TX 0x00000004UL /*!<DMA Connect to UART0 TX \hideinitializer */ | |
#define PDMA_UART0_RX 0x00000005UL /*!<DMA Connect to UART0 RX \hideinitializer */ | |
#define PDMA_UART1_TX 0x00000006UL /*!<DMA Connect to UART1 TX \hideinitializer */ | |
#define PDMA_UART1_RX 0x00000007UL /*!<DMA Connect to UART1 RX \hideinitializer */ | |
#define PDMA_UART2_TX 0x00000008UL /*!<DMA Connect to UART2 TX \hideinitializer */ | |
#define PDMA_UART2_RX 0x00000009UL /*!<DMA Connect to UART2 RX \hideinitializer */ | |
#define PDMA_UART3_TX 0x0000000AUL /*!<DMA Connect to UART3 TX \hideinitializer */ | |
#define PDMA_UART3_RX 0x0000000BUL /*!<DMA Connect to UART3 RX \hideinitializer */ | |
#define PDMA_UART4_TX 0x0000000CUL /*!<DMA Connect to UART4 TX \hideinitializer */ | |
#define PDMA_UART4_RX 0x0000000DUL /*!<DMA Connect to UART4 RX \hideinitializer */ | |
#define PDMA_UART5_TX 0x0000000EUL /*!<DMA Connect to UART5 TX \hideinitializer */ | |
#define PDMA_UART5_RX 0x0000000FUL /*!<DMA Connect to UART5 RX \hideinitializer */ | |
#define PDMA_USCI0_TX 0x00000010UL /*!<DMA Connect to USCI0 TX \hideinitializer */ | |
#define PDMA_USCI0_RX 0x00000011UL /*!<DMA Connect to USCI0 RX \hideinitializer */ | |
#define PDMA_USCI1_TX 0x00000012UL /*!<DMA Connect to USCI1 TX \hideinitializer */ | |
#define PDMA_USCI1_RX 0x00000013UL /*!<DMA Connect to USCI1 RX \hideinitializer */ | |
#define PDMA_QSPI0_TX 0x00000014UL /*!<DMA Connect to QSPI0 TX \hideinitializer */ | |
#define PDMA_QSPI0_RX 0x00000015UL /*!<DMA Connect to QSPI0 RX \hideinitializer */ | |
#define PDMA_SPI0_TX 0x00000016UL /*!<DMA Connect to SPI0 TX \hideinitializer */ | |
#define PDMA_SPI0_RX 0x00000017UL /*!<DMA Connect to SPI0 RX \hideinitializer */ | |
#define PDMA_SPI1_TX 0x00000018UL /*!<DMA Connect to SPI1 TX \hideinitializer */ | |
#define PDMA_SPI1_RX 0x00000019UL /*!<DMA Connect to SPI1 RX \hideinitializer */ | |
#define PDMA_SPI2_TX 0x0000001AUL /*!<DMA Connect to SPI2 TX \hideinitializer */ | |
#define PDMA_SPI2_RX 0x0000001BUL /*!<DMA Connect to SPI2 RX \hideinitializer */ | |
#define PDMA_SPI3_TX 0x0000001CUL /*!<DMA Connect to SPI3 TX \hideinitializer */ | |
#define PDMA_SPI3_RX 0x0000001DUL /*!<DMA Connect to SPI3 RX \hideinitializer */ | |
#define PDMA_EPWM0_P1_RX 0x00000020UL /*!<DMA Connect to EPWM0 P1 RX \hideinitializer */ | |
#define PDMA_EPWM0_P2_RX 0x00000021UL /*!<DMA Connect to EPWM0 P2 RX \hideinitializer */ | |
#define PDMA_EPWM0_P3_RX 0x00000022UL /*!<DMA Connect to EPWM0 P3 RX \hideinitializer */ | |
#define PDMA_EPWM1_P1_RX 0x00000023UL /*!<DMA Connect to EPWM1 P1 RX \hideinitializer */ | |
#define PDMA_EPWM1_P2_RX 0x00000024UL /*!<DMA Connect to EPWM1 P2 RX \hideinitializer */ | |
#define PDMA_EPWM1_P3_RX 0x00000025UL /*!<DMA Connect to EPWM1 P3 RX \hideinitializer */ | |
#define PDMA_I2C0_TX 0x00000026UL /*!<DMA Connect to I2C0 TX \hideinitializer */ | |
#define PDMA_I2C0_RX 0x00000027UL /*!<DMA Connect to I2C0 RX \hideinitializer */ | |
#define PDMA_I2C1_TX 0x00000028UL /*!<DMA Connect to I2C1 TX \hideinitializer */ | |
#define PDMA_I2C1_RX 0x00000029UL /*!<DMA Connect to I2C1 RX \hideinitializer */ | |
#define PDMA_I2C2_TX 0x0000002AUL /*!<DMA Connect to I2C2 TX \hideinitializer */ | |
#define PDMA_I2C2_RX 0x0000002BUL /*!<DMA Connect to I2C2 RX \hideinitializer */ | |
#define PDMA_I2S0_TX 0x0000002CUL /*!<DMA Connect to I2S0 TX \hideinitializer */ | |
#define PDMA_I2S0_RX 0x0000002DUL /*!<DMA Connect to I2S0 RX \hideinitializer */ | |
#define PDMA_TMR0 0x0000002EUL /*!<DMA Connect to TMR0 \hideinitializer */ | |
#define PDMA_TMR1 0x0000002FUL /*!<DMA Connect to TMR1 \hideinitializer */ | |
#define PDMA_TMR2 0x00000030UL /*!<DMA Connect to TMR2 \hideinitializer */ | |
#define PDMA_TMR3 0x00000031UL /*!<DMA Connect to TMR3 \hideinitializer */ | |
#define PDMA_ADC_RX 0x00000032UL /*!<DMA Connect to ADC RX \hideinitializer */ | |
#define PDMA_DAC0_TX 0x00000033UL /*!<DMA Connect to DAC0 TX \hideinitializer */ | |
#define PDMA_DAC1_TX 0x00000034UL /*!<DMA Connect to DAC1 TX \hideinitializer */ | |
#define PDMA_EPWM0_CH0_TX 0x00000035UL /*!<DMA Connect to EPWM0 CH0 TX \hideinitializer */ | |
#define PDMA_EPWM0_CH1_TX 0x00000036UL /*!<DMA Connect to EPWM0 CH1 TX \hideinitializer */ | |
#define PDMA_EPWM0_CH2_TX 0x00000037UL /*!<DMA Connect to EPWM0 CH2 TX \hideinitializer */ | |
#define PDMA_EPWM0_CH3_TX 0x00000038UL /*!<DMA Connect to EPWM0 CH3 TX \hideinitializer */ | |
#define PDMA_EPWM0_CH4_TX 0x00000039UL /*!<DMA Connect to EPWM0 CH4 TX \hideinitializer */ | |
#define PDMA_EPWM0_CH5_TX 0x0000003AUL /*!<DMA Connect to EPWM0 CH5 TX \hideinitializer */ | |
#define PDMA_EPWM1_CH0_TX 0x0000003BUL /*!<DMA Connect to EPWM1 CH0 TX \hideinitializer */ | |
#define PDMA_EPWM1_CH1_TX 0x0000003CUL /*!<DMA Connect to EPWM1 CH1 TX \hideinitializer */ | |
#define PDMA_EPWM1_CH2_TX 0x0000003DUL /*!<DMA Connect to EPWM1 CH2 TX \hideinitializer */ | |
#define PDMA_EPWM1_CH3_TX 0x0000003EUL /*!<DMA Connect to EPWM1 CH3 TX \hideinitializer */ | |
#define PDMA_EPWM1_CH4_TX 0x0000003FUL /*!<DMA Connect to EPWM1 CH4 TX \hideinitializer */ | |
#define PDMA_EPWM1_CH5_TX 0x00000040UL /*!<DMA Connect to EPWM1 CH5 TX \hideinitializer */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Interrupt Type Constant Definitions */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
#define PDMA_INT_TRANS_DONE 0x00000000UL /*!<Transfer Done Interrupt \hideinitializer */ | |
#define PDMA_INT_TABLE 0x00000001UL /*!<Table Interrupt \hideinitializer */ | |
#define PDMA_INT_TIMEOUT 0x00000002UL /*!<Timeout Interrupt \hideinitializer */ | |
#define PDMA_INT_ALIGN 0x00000003UL /*!<Transfer Alignment Interrupt \hideinitializer */ | |
/*@}*/ /* end of group PDMA_EXPORTED_CONSTANTS */ | |
/** @addtogroup PDMA_EXPORTED_FUNCTIONS PDMA Exported Functions | |
@{ | |
*/ | |
/** | |
* @brief Get PDMA Interrupt Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* | |
* @return None | |
* | |
* @details This macro gets the interrupt status. | |
*/ | |
#define PDMA_GET_INT_STATUS(pdma) ((uint32_t)((pdma)->INTSTS)) | |
/** | |
* @brief Get Transfer Done Interrupt Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* | |
* @return None | |
* | |
* @details Get the transfer done Interrupt status. | |
*/ | |
#define PDMA_GET_TD_STS(pdma) ((uint32_t)((pdma)->TDSTS)) | |
/** | |
* @brief Clear Transfer Done Interrupt Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Mask The channel mask | |
* | |
* @return None | |
* | |
* @details Clear the transfer done Interrupt status. | |
*/ | |
#define PDMA_CLR_TD_FLAG(pdma, u32Mask) ((uint32_t)((pdma)->TDSTS = (u32Mask))) | |
/** | |
* @brief Get Target Abort Interrupt Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* | |
* @return None | |
* | |
* @details Get the target abort Interrupt status. | |
*/ | |
#define PDMA_GET_ABORT_STS(pdma) ((uint32_t)((pdma)->ABTSTS)) | |
/** | |
* @brief Clear Target Abort Interrupt Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Mask The channel mask | |
* | |
* @return None | |
* | |
* @details Clear the target abort Interrupt status. | |
*/ | |
#define PDMA_CLR_ABORT_FLAG(pdma, u32Mask) ((uint32_t)((pdma)->ABTSTS = (u32Mask))) | |
/** | |
* @brief Get PDMA Transfer Alignment Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* | |
* @return None | |
* | |
* @details Get the PDMA transfer alignment status. | |
*/ | |
#define PDMA_GET_ALIGN_STS(pdma) ((uint32_t)((pdma)->ALIGN)) | |
/** | |
* @brief Clear PDMA Transfer Alignment Interrupt Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Mask The channel mask | |
* | |
* @return None | |
* | |
* @details Clear the PDMA transfer alignment Interrupt status. | |
*/ | |
#define PDMA_CLR_ALIGN_FLAG(pdma, u32Mask) ((uint32_t)((pdma)->ALIGN = (u32Mask))) | |
/** | |
* @brief Clear Timeout Interrupt Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* | |
* @return None | |
* | |
* @details Clear the selected channel timeout interrupt status. | |
* @note This function is only supported in channel 0 and channel 1. | |
*/ | |
#define PDMA_CLR_TMOUT_FLAG(pdma, u32Ch) ((uint32_t)((pdma)->INTSTS = (1UL << ((u32Ch) + 8UL)))) | |
/** | |
* @brief Check Channel Status | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* | |
* @retval 0 Idle state | |
* @retval 1 Busy state | |
* | |
* @details Check the selected channel is busy or not. | |
*/ | |
#define PDMA_IS_CH_BUSY(pdma, u32Ch) ((uint32_t)((pdma)->TRGSTS & (1UL << (u32Ch)))? 1 : 0) | |
/** | |
* @brief Set Source Address | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* @param[in] u32Addr The selected address | |
* | |
* @return None | |
* | |
* @details This macro set the selected channel source address. | |
*/ | |
#define PDMA_SET_SRC_ADDR(pdma, u32Ch, u32Addr) ((uint32_t)((pdma)->DSCT[(u32Ch)].SA = (u32Addr))) | |
/** | |
* @brief Set Destination Address | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* @param[in] u32Addr The selected address | |
* | |
* @return None | |
* | |
* @details This macro set the selected channel destination address. | |
*/ | |
#define PDMA_SET_DST_ADDR(pdma, u32Ch, u32Addr) ((uint32_t)((pdma)->DSCT[(u32Ch)].DA = (u32Addr))) | |
/** | |
* @brief Set Transfer Count | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* @param[in] u32TransCount Transfer Count | |
* | |
* @return None | |
* | |
* @details This macro set the selected channel transfer count. | |
*/ | |
#define PDMA_SET_TRANS_CNT(pdma, u32Ch, u32TransCount) ((uint32_t)((pdma)->DSCT[(u32Ch)].CTL=((pdma)->DSCT[(u32Ch)].CTL&~PDMA_DSCT_CTL_TXCNT_Msk)|(((u32TransCount)-1UL) << PDMA_DSCT_CTL_TXCNT_Pos))) | |
/** | |
* @brief Set Scatter-gather descriptor Address | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* @param[in] u32Addr The descriptor address | |
* | |
* @return None | |
* | |
* @details This macro set the selected channel scatter-gather descriptor address. | |
*/ | |
#define PDMA_SET_SCATTER_DESC(pdma, u32Ch, u32Addr) ((uint32_t)((pdma)->DSCT[(u32Ch)].NEXT = (u32Addr) - ((pdma)->SCATBA))) | |
/** | |
* @brief Stop the channel | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* | |
* @return None | |
* | |
* @details This macro stop the selected channel. | |
*/ | |
#define PDMA_STOP(pdma, u32Ch) ((uint32_t)((pdma)->PAUSE = (1UL << (u32Ch)))) | |
/** | |
* @brief Pause the channel | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* | |
* @return None | |
* | |
* @details This macro pause the selected channel. | |
*/ | |
#define PDMA_PAUSE(pdma, u32Ch) ((uint32_t)((pdma)->PAUSE = (1UL << (u32Ch)))) | |
/** | |
* @brief Reset the channel | |
* | |
* @param[in] pdma The pointer of the specified PDMA module | |
* @param[in] u32Ch The selected channel | |
* | |
* @return None | |
* | |
* @details This macro reset the selected channel. | |
*/ | |
#define PDMA_RESET(pdma, u32Ch) ((uint32_t)((pdma)->CHRST = (1UL << (u32Ch)))) | |
/*---------------------------------------------------------------------------------------------------------*/ | |
/* Define PWM functions prototype */ | |
/*---------------------------------------------------------------------------------------------------------*/ | |
void PDMA_Open(PDMA_T *pdma, uint32_t u32Mask); | |
void PDMA_Close(PDMA_T *pdma); | |
void PDMA_SetTransferCnt(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Width, uint32_t u32TransCount); | |
void PDMA_SetStride(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32DestLen, uint32_t u32SrcLen, uint32_t u32TransCount); | |
void PDMA_SetTransferAddr(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32SrcAddr, uint32_t u32SrcCtrl, uint32_t u32DstAddr, uint32_t u32DstCtrl); | |
void PDMA_SetTransferMode(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Peripheral, uint32_t u32ScatterEn, uint32_t u32DescAddr); | |
void PDMA_SetBurstType(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32BurstType, uint32_t u32BurstSize); | |
void PDMA_EnableTimeout(PDMA_T *pdma, uint32_t u32Mask); | |
void PDMA_DisableTimeout(PDMA_T *pdma, uint32_t u32Mask); | |
void PDMA_SetTimeOut(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32OnOff, uint32_t u32TimeOutCnt); | |
void PDMA_Trigger(PDMA_T *pdma, uint32_t u32Ch); | |
void PDMA_EnableInt(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Mask); | |
void PDMA_DisableInt(PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Mask); | |
/*@}*/ /* end of group PDMA_EXPORTED_FUNCTIONS */ | |
/*@}*/ /* end of group PDMA_Driver */ | |
/*@}*/ /* end of group Standard_Driver */ | |
#ifdef __cplusplus | |
} | |
#endif | |
#endif /* __PDMA_H__ */ | |
/*** (C) COPYRIGHT 2017 Nuvoton Technology Corp. ***/ |