M480 BSP V3.05.005
The Board Support Package for M480 Series
Macros | Functions

Macros

#define PDMA_GET_INT_STATUS(pdma)
 Get PDMA Interrupt Status. More...
 
#define PDMA_GET_TD_STS(pdma)
 Get Transfer Done Interrupt Status. More...
 
#define PDMA_CLR_TD_FLAG(pdma, u32Mask)
 Clear Transfer Done Interrupt Status. More...
 
#define PDMA_GET_ABORT_STS(pdma)
 Get Target Abort Interrupt Status. More...
 
#define PDMA_CLR_ABORT_FLAG(pdma, u32Mask)
 Clear Target Abort Interrupt Status. More...
 
#define PDMA_GET_ALIGN_STS(pdma)
 Get Alignment Interrupt Status. More...
 
#define PDMA_CLR_ALIGN_FLAG(pdma, u32Mask)
 Clear Alignment Interrupt Status. More...
 
#define PDMA_CLR_TMOUT_FLAG(pdma, u32Ch)
 Clear Timeout Interrupt Status. More...
 
#define PDMA_IS_CH_BUSY(pdma, u32Ch)
 Check Channel Status. More...
 
#define PDMA_SET_SRC_ADDR(pdma, u32Ch, u32Addr)
 Set Source Address. More...
 
#define PDMA_SET_DST_ADDR(pdma, u32Ch, u32Addr)
 Set Destination Address. More...
 
#define PDMA_SET_TRANS_CNT(pdma, u32Ch, u32TransCount)
 Set Transfer Count. More...
 
#define PDMA_SET_SCATTER_DESC(pdma, u32Ch, u32Addr)
 Set Scatter-gather descriptor Address. More...
 
#define PDMA_STOP(pdma, u32Ch)
 Stop the channel. More...
 
#define PDMA_PAUSE(pdma, u32Ch)
 Pause the channel. More...
 

Functions

void PDMA_Open (PDMA_T *pdma, uint32_t u32Mask)
 PDMA Open. More...
 
void PDMA_Close (PDMA_T *pdma)
 PDMA Close. More...
 
void PDMA_SetTransferCnt (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Width, uint32_t u32TransCount)
 Set PDMA Transfer Count. More...
 
void PDMA_SetTransferAddr (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32SrcAddr, uint32_t u32SrcCtrl, uint32_t u32DstAddr, uint32_t u32DstCtrl)
 Set PDMA Transfer Address. More...
 
void PDMA_SetTransferMode (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Peripheral, uint32_t u32ScatterEn, uint32_t u32DescAddr)
 Set PDMA Transfer Mode. More...
 
void PDMA_SetBurstType (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32BurstType, uint32_t u32BurstSize)
 Set PDMA Burst Type and Size. More...
 
void PDMA_EnableTimeout (PDMA_T *pdma, uint32_t u32Mask)
 Enable timeout function. More...
 
void PDMA_DisableTimeout (PDMA_T *pdma, uint32_t u32Mask)
 Disable timeout function. More...
 
void PDMA_SetTimeOut (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32OnOff, uint32_t u32TimeOutCnt)
 Set PDMA Timeout Count. More...
 
void PDMA_Trigger (PDMA_T *pdma, uint32_t u32Ch)
 Trigger PDMA. More...
 
void PDMA_EnableInt (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Mask)
 Enable Interrupt. More...
 
void PDMA_DisableInt (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32Mask)
 Disable Interrupt. More...
 
void PDMA_SetStride (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32DestLen, uint32_t u32SrcLen, uint32_t u32TransCount)
 Set PDMA Stride Mode. More...
 
void PDMA_SetRepeat (PDMA_T *pdma, uint32_t u32Ch, uint32_t u32DestInterval, uint32_t u32SrcInterval, uint32_t u32RepeatCount)
 Set PDMA Repeat. More...
 

Detailed Description

Macro Definition Documentation

◆ PDMA_CLR_ABORT_FLAG

#define PDMA_CLR_ABORT_FLAG (   pdma,
  u32Mask 
)

Clear Target Abort Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32MaskThe channel mask
Returns
None

Clear the target abort Interrupt status.

Definition at line 222 of file pdma.h.

◆ PDMA_CLR_ALIGN_FLAG

#define PDMA_CLR_ALIGN_FLAG (   pdma,
  u32Mask 
)

Clear Alignment Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32MaskThe channel mask
Returns
None

Clear the Alignment Interrupt status.

Definition at line 247 of file pdma.h.

◆ PDMA_CLR_TD_FLAG

#define PDMA_CLR_TD_FLAG (   pdma,
  u32Mask 
)

Clear Transfer Done Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32MaskThe channel mask
Returns
None

Clear the transfer done Interrupt status.

Definition at line 196 of file pdma.h.

◆ PDMA_CLR_TMOUT_FLAG

#define PDMA_CLR_TMOUT_FLAG (   pdma,
  u32Ch 
)

Clear Timeout Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
Returns
None

Clear the selected channel timeout interrupt status.

Definition at line 260 of file pdma.h.

◆ PDMA_GET_ABORT_STS

#define PDMA_GET_ABORT_STS (   pdma)

Get Target Abort Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
Returns
None

Get the target abort Interrupt status.

Definition at line 208 of file pdma.h.

◆ PDMA_GET_ALIGN_STS

#define PDMA_GET_ALIGN_STS (   pdma)

Get Alignment Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
Returns
None

Get Alignment Interrupt status.

Definition at line 234 of file pdma.h.

◆ PDMA_GET_INT_STATUS

#define PDMA_GET_INT_STATUS (   pdma)

Get PDMA Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
Returns
None

This macro gets the interrupt status.

Definition at line 170 of file pdma.h.

◆ PDMA_GET_TD_STS

#define PDMA_GET_TD_STS (   pdma)

Get Transfer Done Interrupt Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
Returns
None

Get the transfer done Interrupt status.

Definition at line 182 of file pdma.h.

◆ PDMA_IS_CH_BUSY

#define PDMA_IS_CH_BUSY (   pdma,
  u32Ch 
)

Check Channel Status.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
Return values
0Idle state
1Busy state

Check the selected channel is busy or not.

Definition at line 274 of file pdma.h.

◆ PDMA_PAUSE

#define PDMA_PAUSE (   pdma,
  u32Ch 
)

Pause the channel.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
Returns
None

This macro pause the selected channel.

Definition at line 358 of file pdma.h.

◆ PDMA_SET_DST_ADDR

#define PDMA_SET_DST_ADDR (   pdma,
  u32Ch,
  u32Addr 
)

Set Destination Address.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32AddrThe selected address
Returns
None

This macro set the selected channel destination address.

Definition at line 302 of file pdma.h.

◆ PDMA_SET_SCATTER_DESC

#define PDMA_SET_SCATTER_DESC (   pdma,
  u32Ch,
  u32Addr 
)

Set Scatter-gather descriptor Address.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32AddrThe descriptor address
Returns
None

This macro set the selected channel scatter-gather descriptor address.

Definition at line 330 of file pdma.h.

◆ PDMA_SET_SRC_ADDR

#define PDMA_SET_SRC_ADDR (   pdma,
  u32Ch,
  u32Addr 
)

Set Source Address.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32AddrThe selected address
Returns
None

This macro set the selected channel source address.

Definition at line 288 of file pdma.h.

◆ PDMA_SET_TRANS_CNT

#define PDMA_SET_TRANS_CNT (   pdma,
  u32Ch,
  u32TransCount 
)

Set Transfer Count.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32TransCountTransfer Count
Returns
None

This macro set the selected channel transfer count.

Definition at line 316 of file pdma.h.

◆ PDMA_STOP

#define PDMA_STOP (   pdma,
  u32Ch 
)

Stop the channel.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
Returns
None

This macro stop the selected channel.

Definition at line 344 of file pdma.h.

Function Documentation

◆ PDMA_Close()

void PDMA_Close ( PDMA_T pdma)

PDMA Close.

Parameters
[in]pdmaThe pointer of the specified PDMA module
Returns
None

This function disable all PDMA channels.

Definition at line 63 of file pdma.c.

◆ PDMA_DisableInt()

void PDMA_DisableInt ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32Mask 
)

Disable Interrupt.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32MaskThe Interrupt Type. Valid values are
Returns
None

This function disable the selected channel interrupt.

Definition at line 462 of file pdma.c.

◆ PDMA_DisableTimeout()

void PDMA_DisableTimeout ( PDMA_T pdma,
uint32_t  u32Mask 
)

Disable timeout function.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32MaskChannel enable bits.
Returns
None

This function disable timeout function of the selected channel(s).

Definition at line 358 of file pdma.c.

◆ PDMA_EnableInt()

void PDMA_EnableInt ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32Mask 
)

Enable Interrupt.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32MaskThe Interrupt Type. Valid values are
Returns
None

This function enable the selected channel interrupt.

Definition at line 429 of file pdma.c.

◆ PDMA_EnableTimeout()

void PDMA_EnableTimeout ( PDMA_T pdma,
uint32_t  u32Mask 
)

Enable timeout function.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32MaskChannel enable bits.
Returns
None

This function enable timeout function of the selected channel(s).

Definition at line 342 of file pdma.c.

◆ PDMA_Open()

void PDMA_Open ( PDMA_T pdma,
uint32_t  u32Mask 
)

PDMA Open.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32MaskChannel enable bits.
Returns
None

This function enable the PDMA channels.

Definition at line 38 of file pdma.c.

◆ PDMA_SetBurstType()

void PDMA_SetBurstType ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32BurstType,
uint32_t  u32BurstSize 
)

Set PDMA Burst Type and Size.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32BurstTypeBurst mode or single mode. Valid values are
[in]u32BurstSizeSet the size of burst mode. Valid values are
Returns
None

This function set the selected channel burst type and size.

Definition at line 325 of file pdma.c.

◆ PDMA_SetRepeat()

void PDMA_SetRepeat ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32DestInterval,
uint32_t  u32SrcInterval,
uint32_t  u32RepeatCount 
)

Set PDMA Repeat.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32DestIntervalDestination address interval count
[in]u32SrcIntervalSource address interval count
[in]u32RepeatCountRepeat count
Returns
None

This function set the selected repeat.

Definition at line 122 of file pdma.c.

◆ PDMA_SetStride()

void PDMA_SetStride ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32DestLen,
uint32_t  u32SrcLen,
uint32_t  u32TransCount 
)

Set PDMA Stride Mode.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32DestLenDestination stride count
[in]u32SrcLenSource stride count
[in]u32TransCountTransfer count
Returns
None

This function set the selected stride mode.

Definition at line 102 of file pdma.c.

◆ PDMA_SetTimeOut()

void PDMA_SetTimeOut ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32OnOff,
uint32_t  u32TimeOutCnt 
)

Set PDMA Timeout Count.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel,
[in]u32OnOffEnable/disable time out function
[in]u32TimeOutCntTimeout count
Returns
None

This function set the timeout count.

Note
M480 only supported channel 0/1.

Definition at line 376 of file pdma.c.

◆ PDMA_SetTransferAddr()

void PDMA_SetTransferAddr ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32SrcAddr,
uint32_t  u32SrcCtrl,
uint32_t  u32DstAddr,
uint32_t  u32DstCtrl 
)

Set PDMA Transfer Address.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32SrcAddrSource address
[in]u32SrcCtrlSource control attribute. Valid values are
[in]u32DstAddrdestination address
[in]u32DstCtrldestination control attribute. Valid values are
Returns
None

This function set the selected channel source/destination address and attribute.

Definition at line 147 of file pdma.c.

◆ PDMA_SetTransferCnt()

void PDMA_SetTransferCnt ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32Width,
uint32_t  u32TransCount 
)

Set PDMA Transfer Count.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
[in]u32WidthData width. Valid values are
[in]u32TransCountTransfer count
Returns
None

This function set the selected channel data width and transfer count.

Definition at line 83 of file pdma.c.

◆ PDMA_SetTransferMode()

void PDMA_SetTransferMode ( PDMA_T pdma,
uint32_t  u32Ch,
uint32_t  u32Peripheral,
uint32_t  u32ScatterEn,
uint32_t  u32DescAddr 
)

◆ PDMA_Trigger()

void PDMA_Trigger ( PDMA_T pdma,
uint32_t  u32Ch 
)

Trigger PDMA.

Parameters
[in]pdmaThe pointer of the specified PDMA module
[in]u32ChThe selected channel
Returns
None

This function trigger the selected channel.

Definition at line 406 of file pdma.c.