LDMA - Linked DMA
Description
Linked Direct Memory Access (LDMA) Peripheral API.
LDMA API functions provide full support for the LDMA peripheral.
LDMA supports these DMA transfer types:
- Memory to memory.
- Memory to peripheral.
- Peripheral to memory.
- Peripheral to peripheral.
- Constant value to memory.
LDMA supports linked lists of DMA descriptors allowing:
- Circular and ping-pong buffer transfers.
- Scatter-gather transfers.
- Looped transfers.
LDMA has some advanced features:
- Intra-channel synchronization (SYNC), allowing hardware events to pause and restart a DMA sequence.
- Immediate-write (WRI), allowing DMA to write a constant anywhere in the memory map.
- Complex flow control allowing if-else constructs.
Basic understanding of LDMA controller is assumed. Please refer to the reference manual for further details. The LDMA examples described in the reference manual are particularly helpful in understanding LDMA operations.
In order to use the DMA controller, the initialization function LDMA_Init() must have been executed once (normally during system initialization).
DMA transfers are initiated by a call to LDMA_StartTransfer() , transfer properties are controlled by the contents of LDMA_TransferCfg_t and LDMA_Descriptor_t structure parameters. The LDMA_Descriptor_t structure parameter may be a pointer to an array of descriptors, descriptors in array should be linked together as needed.
Transfer and descriptor initialization macros are provided for the most common transfer types. Due to the flexibility of LDMA peripheral, only a small subset of all possible initializer macros are provided, users should create new ones when needed.
Examples of LDMA usage:
A simple memory to memory transfer:
A linked list of three memory to memory transfers:
DMA from serial port peripheral to memory:
Ping-pong DMA from serial port peripheral to memory:
- Note
- LDMA module does not implement LDMA interrupt handler. A template for an LDMA IRQ handler is included here as an example.
Data Structures |
|
union | LDMA_Descriptor_t |
DMA descriptor.
|
|
struct | LDMA_Init_t |
LDMA initialization configuration structure.
|
|
struct | LDMA_TransferCfg_t |
DMA transfer configuration structure.
|
|
Functions |
|
void | LDMA_DeInit (void) |
De-initialize the LDMA controller.
|
|
void | LDMA_EnableChannelRequest (int ch, bool enable) |
Enable or disable an LDMA channel request.
|
|
void | LDMA_Init (const LDMA_Init_t *init) |
Initialize the LDMA controller.
|
|
void | LDMA_StartTransfer (int ch, const LDMA_TransferCfg_t *transfer, const LDMA_Descriptor_t *descriptor) |
Start a DMA transfer.
|
|
void | LDMA_StopTransfer (int ch) |
Stop a DMA transfer.
|
|
bool | LDMA_TransferDone (int ch) |
Check if a DMA transfer has completed.
|
|
uint32_t | LDMA_TransferRemainingCount (int ch) |
Get the number of items remaining in a transfer.
|
|
bool | LDMA_ChannelEnabled (int ch) |
Check if a certain channel is enabled.
|
|
void | LDMA_IntClear (uint32_t flags) |
Clear one or more pending LDMA interrupts.
|
|
void | LDMA_IntDisable (uint32_t flags) |
Disable one or more LDMA interrupts.
|
|
void | LDMA_IntEnable (uint32_t flags) |
Enable one or more LDMA interrupts.
|
|
uint32_t | LDMA_IntGet (void) |
Get pending LDMA interrupt flags.
|
|
uint32_t | LDMA_IntGetEnabled (void) |
Get enabled and pending LDMA interrupt flags.
|
|
void | LDMA_IntSet (uint32_t flags) |
Set one or more pending LDMA interrupts.
|
|
Macros |
|
#define | LDMA_DESCRIPTOR_NON_EXTEND_SIZE_WORD 4 |
Size in words of a non-extended DMA descriptor.
|
|
#define | LDMA_DESCRIPTOR_EXTEND_SIZE_WORD 7 |
Size in words of an extended DMA descriptor.
|
|
#define | LDMA_INIT_DEFAULT |
Default DMA initialization structure.
|
|
#define | LDMA_TRANSFER_CFG_MEMORY () |
Generic DMA transfer configuration for memory to memory transfers.
|
|
#define | LDMA_TRANSFER_CFG_MEMORY_LOOP (loopCnt) |
Generic DMA transfer configuration for looped memory to memory transfers.
|
|
#define | LDMA_TRANSFER_CFG_PERIPHERAL (signal) |
Generic DMA transfer configuration for memory to/from peripheral transfers.
|
|
#define | LDMA_TRANSFER_CFG_PERIPHERAL_LOOP (signal, loopCnt) |
Generic DMA transfer configuration for looped memory to/from peripheral transfers.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_M2M_WORD (src, dest, count) |
DMA descriptor initializer for single memory to memory word transfer.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_M2M_HALF (src, dest, count) |
DMA descriptor initializer for single memory to memory half-word transfer.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_M2M_BYTE (src, dest, count) |
DMA descriptor initializer for single memory to memory byte transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKABS_M2M_WORD (src, dest, count) |
DMA descriptor initializer for linked memory to memory word transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKABS_M2M_HALF (src, dest, count) |
DMA descriptor initializer for linked memory to memory half-word transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKABS_M2M_BYTE (src, dest, count) |
DMA descriptor initializer for linked memory to memory byte transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_M2M_WORD (src, dest, count, linkjmp) |
DMA descriptor initializer for linked memory to memory word transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_M2M_HALF (src, dest, count, linkjmp) |
DMA descriptor initializer for linked memory to memory half-word transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_M2M_BYTE (src, dest, count, linkjmp) |
DMA descriptor initializer for linked memory to memory byte transfer.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_P2M_BYTE (src, dest, count) |
DMA descriptor initializer for byte transfers from a peripheral to memory.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_P2P_BYTE (src, dest, count) |
DMA descriptor initializer for byte transfers from a peripheral to a peripheral.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_M2P_BYTE (src, dest, count) |
DMA descriptor initializer for byte transfers from memory to a peripheral.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_P2M_BYTE (src, dest, count, linkjmp) |
DMA descriptor initializer for byte transfers from a peripheral to memory.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_P2M_WORD (src, dest, count, linkjmp) |
DMA descriptor initializer for word transfers from a peripheral to memory.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_M2P_BYTE (src, dest, count, linkjmp) |
DMA descriptor initializer for byte transfers from memory to a peripheral.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_WRITE (value, address) |
DMA descriptor initializer for Immediate WRITE transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKABS_WRITE (value, address) |
DMA descriptor initializer for Immediate WRITE transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_WRITE (value, address, linkjmp) |
DMA descriptor initializer for Immediate WRITE transfer.
|
|
#define | LDMA_DESCRIPTOR_SINGLE_SYNC (set, clr, matchValue, matchEnable) |
DMA descriptor initializer for SYNC transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKABS_SYNC (set, clr, matchValue, matchEnable) |
DMA descriptor initializer for SYNC transfer.
|
|
#define | LDMA_DESCRIPTOR_LINKREL_SYNC (set, clr, matchValue, matchEnable, linkjmp) |
DMA descriptor initializer for SYNC transfer.
|
|
Enumerations |
|
enum |
LDMA_CtrlBlockSize_t
{
ldmaCtrlBlockSizeUnit1 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT1, ldmaCtrlBlockSizeUnit2 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT2, ldmaCtrlBlockSizeUnit3 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT3, ldmaCtrlBlockSizeUnit4 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT4, ldmaCtrlBlockSizeUnit6 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT6, ldmaCtrlBlockSizeUnit8 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT8, ldmaCtrlBlockSizeUnit16 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT16, ldmaCtrlBlockSizeUnit32 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT32, ldmaCtrlBlockSizeUnit64 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT64, ldmaCtrlBlockSizeUnit128 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT128, ldmaCtrlBlockSizeUnit256 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT256, ldmaCtrlBlockSizeUnit512 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT512, ldmaCtrlBlockSizeUnit1024 = _LDMA_CH_CTRL_BLOCKSIZE_UNIT1024, ldmaCtrlBlockSizeAll = _LDMA_CH_CTRL_BLOCKSIZE_ALL } |
Controls the number of unit data transfers per arbitration cycle, providing a means to balance DMA channels' load on the controller.
|
|
enum |
LDMA_CtrlStructType_t
{
ldmaCtrlStructTypeXfer = _LDMA_CH_CTRL_STRUCTTYPE_TRANSFER, ldmaCtrlStructTypeSync = _LDMA_CH_CTRL_STRUCTTYPE_SYNCHRONIZE, ldmaCtrlStructTypeWrite = _LDMA_CH_CTRL_STRUCTTYPE_WRITE } |
DMA structure type.
|
|
enum |
LDMA_CtrlReqMode_t
{
ldmaCtrlReqModeBlock = _LDMA_CH_CTRL_REQMODE_BLOCK, ldmaCtrlReqModeAll = _LDMA_CH_CTRL_REQMODE_ALL } |
DMA transfer block or cycle selector.
|
|
enum |
LDMA_CtrlSrcInc_t
{
ldmaCtrlSrcIncOne = _LDMA_CH_CTRL_SRCINC_ONE, ldmaCtrlSrcIncTwo = _LDMA_CH_CTRL_SRCINC_TWO, ldmaCtrlSrcIncFour = _LDMA_CH_CTRL_SRCINC_FOUR, ldmaCtrlSrcIncNone = _LDMA_CH_CTRL_SRCINC_NONE } |
Source address increment unit size.
|
|
enum |
LDMA_CtrlSize_t
{
ldmaCtrlSizeByte = _LDMA_CH_CTRL_SIZE_BYTE, ldmaCtrlSizeHalf = _LDMA_CH_CTRL_SIZE_HALFWORD, ldmaCtrlSizeWord = _LDMA_CH_CTRL_SIZE_WORD } |
DMA transfer unit size.
|
|
enum |
LDMA_CtrlDstInc_t
{
ldmaCtrlDstIncOne = _LDMA_CH_CTRL_DSTINC_ONE, ldmaCtrlDstIncTwo = _LDMA_CH_CTRL_DSTINC_TWO, ldmaCtrlDstIncFour = _LDMA_CH_CTRL_DSTINC_FOUR, ldmaCtrlDstIncNone = _LDMA_CH_CTRL_DSTINC_NONE } |
Destination address increment unit size.
|
|
enum |
LDMA_CtrlSrcAddrMode_t
{
ldmaCtrlSrcAddrModeAbs = _LDMA_CH_CTRL_SRCMODE_ABSOLUTE, ldmaCtrlSrcAddrModeRel = _LDMA_CH_CTRL_SRCMODE_RELATIVE } |
Source addressing mode.
|
|
enum |
LDMA_CtrlDstAddrMode_t
{
ldmaCtrlDstAddrModeAbs = _LDMA_CH_CTRL_DSTMODE_ABSOLUTE, ldmaCtrlDstAddrModeRel = _LDMA_CH_CTRL_DSTMODE_RELATIVE } |
Destination addressing mode.
|
|
enum |
LDMA_LinkMode_t
{
ldmaLinkModeAbs = _LDMA_CH_LINK_LINKMODE_ABSOLUTE, ldmaLinkModeRel = _LDMA_CH_LINK_LINKMODE_RELATIVE } |
DMA link load address mode.
|
|
enum |
LDMA_CfgArbSlots_t
{
ldmaCfgArbSlotsAs1 = _LDMA_CH_CFG_ARBSLOTS_ONE, ldmaCfgArbSlotsAs2 = _LDMA_CH_CFG_ARBSLOTS_TWO, ldmaCfgArbSlotsAs4 = _LDMA_CH_CFG_ARBSLOTS_FOUR, ldmaCfgArbSlotsAs8 = _LDMA_CH_CFG_ARBSLOTS_EIGHT } |
Insert extra arbitration slots to increase channel arbitration priority.
|
|
enum |
LDMA_CfgSrcIncSign_t
{
ldmaCfgSrcIncSignPos = _LDMA_CH_CFG_SRCINCSIGN_POSITIVE, ldmaCfgSrcIncSignNeg = _LDMA_CH_CFG_SRCINCSIGN_NEGATIVE } |
Source address increment sign.
|
|
enum |
LDMA_CfgDstIncSign_t
{
ldmaCfgDstIncSignPos = _LDMA_CH_CFG_DSTINCSIGN_POSITIVE, ldmaCfgDstIncSignNeg = _LDMA_CH_CFG_DSTINCSIGN_NEGATIVE } |
Destination address increment sign.
|
|
enum |
LDMA_PeripheralSignal_t
{
ldmaPeripheralSignal_NONE = LDMAXBAR_CH_REQSEL_SOURCESEL_NONE, ldmaPeripheralSignal_LDMAXBAR_PRSREQ0 = LDMAXBAR_CH_REQSEL_SIGSEL_LDMAXBARPRSREQ0 | LDMAXBAR_CH_REQSEL_SOURCESEL_LDMAXBAR, ldmaPeripheralSignal_LDMAXBAR_PRSREQ1 = LDMAXBAR_CH_REQSEL_SIGSEL_LDMAXBARPRSREQ1 | LDMAXBAR_CH_REQSEL_SOURCESEL_LDMAXBAR, ldmaPeripheralSignal_TIMER0_CC0 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER0CC0 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER0, ldmaPeripheralSignal_TIMER0_CC1 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER0CC1 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER0, ldmaPeripheralSignal_TIMER0_CC2 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER0CC2 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER0, ldmaPeripheralSignal_TIMER0_UFOF = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER0UFOF | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER0, ldmaPeripheralSignal_TIMER1_CC0 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER1CC0 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER1, ldmaPeripheralSignal_TIMER1_CC1 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER1CC1 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER1, ldmaPeripheralSignal_TIMER1_CC2 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER1CC2 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER1, ldmaPeripheralSignal_TIMER1_UFOF = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER1UFOF | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER1, ldmaPeripheralSignal_USART0_RXDATAV = LDMAXBAR_CH_REQSEL_SIGSEL_USART0RXDATAV | LDMAXBAR_CH_REQSEL_SOURCESEL_USART0, ldmaPeripheralSignal_USART0_RXDATAVRIGHT = LDMAXBAR_CH_REQSEL_SIGSEL_USART0RXDATAVRIGHT | LDMAXBAR_CH_REQSEL_SOURCESEL_USART0, ldmaPeripheralSignal_USART0_TXBL = LDMAXBAR_CH_REQSEL_SIGSEL_USART0TXBL | LDMAXBAR_CH_REQSEL_SOURCESEL_USART0, ldmaPeripheralSignal_USART0_TXBLRIGHT = LDMAXBAR_CH_REQSEL_SIGSEL_USART0TXBLRIGHT | LDMAXBAR_CH_REQSEL_SOURCESEL_USART0, ldmaPeripheralSignal_USART0_TXEMPTY = LDMAXBAR_CH_REQSEL_SIGSEL_USART0TXEMPTY | LDMAXBAR_CH_REQSEL_SOURCESEL_USART0, ldmaPeripheralSignal_USART1_RXDATAV = LDMAXBAR_CH_REQSEL_SIGSEL_USART1RXDATAV | LDMAXBAR_CH_REQSEL_SOURCESEL_USART1, ldmaPeripheralSignal_USART1_RXDATAVRIGHT = LDMAXBAR_CH_REQSEL_SIGSEL_USART1RXDATAVRIGHT | LDMAXBAR_CH_REQSEL_SOURCESEL_USART1, ldmaPeripheralSignal_USART1_TXBL = LDMAXBAR_CH_REQSEL_SIGSEL_USART1TXBL | LDMAXBAR_CH_REQSEL_SOURCESEL_USART1, ldmaPeripheralSignal_USART1_TXBLRIGHT = LDMAXBAR_CH_REQSEL_SIGSEL_USART1TXBLRIGHT | LDMAXBAR_CH_REQSEL_SOURCESEL_USART1, ldmaPeripheralSignal_USART1_TXEMPTY = LDMAXBAR_CH_REQSEL_SIGSEL_USART1TXEMPTY | LDMAXBAR_CH_REQSEL_SOURCESEL_USART1, ldmaPeripheralSignal_USART2_RXDATAV = LDMAXBAR_CH_REQSEL_SIGSEL_USART2RXDATAV | LDMAXBAR_CH_REQSEL_SOURCESEL_USART2, ldmaPeripheralSignal_USART2_RXDATAVRIGHT = LDMAXBAR_CH_REQSEL_SIGSEL_USART2RXDATAVRIGHT | LDMAXBAR_CH_REQSEL_SOURCESEL_USART2, ldmaPeripheralSignal_USART2_TXBL = LDMAXBAR_CH_REQSEL_SIGSEL_USART2TXBL | LDMAXBAR_CH_REQSEL_SOURCESEL_USART2, ldmaPeripheralSignal_USART2_TXBLRIGHT = LDMAXBAR_CH_REQSEL_SIGSEL_USART2TXBLRIGHT | LDMAXBAR_CH_REQSEL_SOURCESEL_USART2, ldmaPeripheralSignal_USART2_TXEMPTY = LDMAXBAR_CH_REQSEL_SIGSEL_USART2TXEMPTY | LDMAXBAR_CH_REQSEL_SOURCESEL_USART2, ldmaPeripheralSignal_I2C0_RXDATAV = LDMAXBAR_CH_REQSEL_SIGSEL_I2C0RXDATAV | LDMAXBAR_CH_REQSEL_SOURCESEL_I2C0, ldmaPeripheralSignal_I2C0_TXBL = LDMAXBAR_CH_REQSEL_SIGSEL_I2C0TXBL | LDMAXBAR_CH_REQSEL_SOURCESEL_I2C0, ldmaPeripheralSignal_I2C1_RXDATAV = LDMAXBAR_CH_REQSEL_SIGSEL_I2C1RXDATAV | LDMAXBAR_CH_REQSEL_SOURCESEL_I2C1, ldmaPeripheralSignal_I2C1_TXBL = LDMAXBAR_CH_REQSEL_SIGSEL_I2C1TXBL | LDMAXBAR_CH_REQSEL_SOURCESEL_I2C1, ldmaPeripheralSignal_IADC0_IADC_SCAN = LDMAXBAR_CH_REQSEL_SIGSEL_IADC0IADC_SCAN | LDMAXBAR_CH_REQSEL_SOURCESEL_IADC0, ldmaPeripheralSignal_IADC0_IADC_SINGLE = LDMAXBAR_CH_REQSEL_SIGSEL_IADC0IADC_SINGLE | LDMAXBAR_CH_REQSEL_SOURCESEL_IADC0, ldmaPeripheralSignal_MSC_WDATA = LDMAXBAR_CH_REQSEL_SIGSEL_MSCWDATA | LDMAXBAR_CH_REQSEL_SOURCESEL_MSC, ldmaPeripheralSignal_TIMER2_CC0 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER2CC0 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER2, ldmaPeripheralSignal_TIMER2_CC1 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER2CC1 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER2, ldmaPeripheralSignal_TIMER2_CC2 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER2CC2 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER2, ldmaPeripheralSignal_TIMER2_UFOF = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER2UFOF | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER2, ldmaPeripheralSignal_TIMER3_CC0 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER3CC0 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER3, ldmaPeripheralSignal_TIMER3_CC1 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER3CC1 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER3, ldmaPeripheralSignal_TIMER3_CC2 = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER3CC2 | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER3, ldmaPeripheralSignal_TIMER3_UFOF = LDMAXBAR_CH_REQSEL_SIGSEL_TIMER3UFOF | LDMAXBAR_CH_REQSEL_SOURCESEL_TIMER3 } |
Peripherals that can trigger LDMA transfers.
|
|
Function Documentation
◆ LDMA_DeInit()
void LDMA_DeInit | ( | void |
|
) |
De-initialize the LDMA controller.
LDMA interrupts are disabled and the LDMA clock is stopped.
◆ LDMA_EnableChannelRequest()
void LDMA_EnableChannelRequest | ( | int |
ch,
|
bool |
enable
|
||
) |
Enable or disable an LDMA channel request.
Use this function to enable or disable an LDMA channel request. This will prevent the LDMA from proceeding after its current transaction if disabled.
- Parameters
-
[in] ch
LDMA channel to enable or disable requests. [in] enable
If 'true', the request will be enabled. If 'false', the request will be disabled.
◆ LDMA_Init()
void LDMA_Init | ( | const LDMA_Init_t * |
init
|
) |
Initialize the LDMA controller.
This function will disable all the LDMA channels and enable the LDMA bus clock in the CMU. This function will also enable the LDMA IRQ in the NVIC and set the LDMA IRQ priority to a user-configurable priority. The LDMA interrupt priority is configured using the LDMA_Init_t structure.
- Note
- Since this function enables the LDMA IRQ, always add a custom LDMA_IRQHandler to the application to handle any interrupts from LDMA.
- Parameters
-
[in] init
A pointer to the initialization structure used to configure the LDMA.
◆ LDMA_StartTransfer()
void LDMA_StartTransfer | ( | int |
ch,
|
const LDMA_TransferCfg_t * |
transfer,
|
||
const LDMA_Descriptor_t * |
descriptor
|
||
) |
Start a DMA transfer.
- Parameters
-
[in] ch
A DMA channel. [in] transfer
The initialization structure used to configure the transfer. [in] descriptor
The transfer descriptor, which can be an array of descriptors linked together. Each descriptor's fields stored in RAM will be loaded into the certain hardware registers at the proper time to perform the DMA transfer.
◆ LDMA_StopTransfer()
void LDMA_StopTransfer | ( | int |
ch
|
) |
Stop a DMA transfer.
- Note
- The DMA will complete the current AHB burst transfer before stopping.
- Parameters
-
[in] ch
A DMA channel to stop.
◆ LDMA_TransferDone()
bool LDMA_TransferDone | ( | int |
ch
|
) |
Check if a DMA transfer has completed.
- Parameters
-
[in] ch
A DMA channel to check.
- Returns
- True if transfer has completed, false if not.
◆ LDMA_TransferRemainingCount()
uint32_t LDMA_TransferRemainingCount | ( | int |
ch
|
) |
Get the number of items remaining in a transfer.
- Note
- This function does not take into account that a DMA transfer with a chain of linked transfers might be ongoing. It will only check the count for the current transfer.
- Parameters
-
[in] ch
The channel number of the transfer to check.
- Returns
- A number of items remaining in the transfer.
◆ LDMA_ChannelEnabled()
|
inline |
Check if a certain channel is enabled.
- Parameters
-
[in] ch
LDMA channel to check.
- Returns
- return true if the LDMA channel is enabled and false if the channel is not enabled.
◆ LDMA_IntClear()
|
inline |
Clear one or more pending LDMA interrupts.
- Parameters
-
[in] flags
Pending LDMA interrupt sources to clear. Use one or more valid interrupt flags for the LDMA module. The flags are LDMA_IFC_ERROR and one done flag for each channel.
◆ LDMA_IntDisable()
|
inline |
Disable one or more LDMA interrupts.
- Parameters
-
[in] flags
LDMA interrupt sources to disable. Use one or more valid interrupt flags for LDMA module. The flags are LDMA_IEN_ERROR and one done flag for each channel.
◆ LDMA_IntEnable()
|
inline |
Enable one or more LDMA interrupts.
- Note
- Depending on the use, a pending interrupt may already be set prior to enabling the interrupt. To ignore a pending interrupt, consider using LDMA_IntClear() prior to enabling the interrupt.
- Parameters
-
[in] flags
LDMA interrupt sources to enable. Use one or more valid interrupt flags for LDMA module. The flags are LDMA_IEN_ERROR and one done flag for each channel.
◆ LDMA_IntGet()
|
inline |
Get pending LDMA interrupt flags.
- Note
- Event bits are not cleared by the use of this function.
- Returns
- LDMA interrupt sources pending. Returns one or more valid interrupt flags for LDMA module. The flags are LDMA_IF_ERROR and one flag for each LDMA channel.
◆ LDMA_IntGetEnabled()
|
inline |
Get enabled and pending LDMA interrupt flags.
Useful for handling more interrupt sources in the same interrupt handler.
- Note
- Interrupt flags are not cleared by the use of this function.
- Returns
-
Pending and enabled LDMA interrupt sources Return value is the bitwise AND of
- the enabled interrupt sources in LDMA_IEN and
- the pending interrupt flags LDMA_IF
◆ LDMA_IntSet()
|
inline |
Set one or more pending LDMA interrupts.
- Parameters
-
[in] flags
LDMA interrupt sources to set to pending. Use one or more valid interrupt flags for LDMA module. The flags are LDMA_IFS_ERROR and one done flag for each LDMA channel.
Macro Definition Documentation
◆ LDMA_DESCRIPTOR_NON_EXTEND_SIZE_WORD
#define LDMA_DESCRIPTOR_NON_EXTEND_SIZE_WORD 4 |
Size in words of a non-extended DMA descriptor.
◆ LDMA_DESCRIPTOR_EXTEND_SIZE_WORD
#define LDMA_DESCRIPTOR_EXTEND_SIZE_WORD 7 |
Size in words of an extended DMA descriptor.
◆ LDMA_INIT_DEFAULT
#define LDMA_INIT_DEFAULT |
Default DMA initialization structure.
◆ LDMA_TRANSFER_CFG_MEMORY
#define LDMA_TRANSFER_CFG_MEMORY | ( |
|
) |
Generic DMA transfer configuration for memory to memory transfers.
◆ LDMA_TRANSFER_CFG_MEMORY_LOOP
#define LDMA_TRANSFER_CFG_MEMORY_LOOP | ( |
loopCnt
|
) |
Generic DMA transfer configuration for looped memory to memory transfers.
◆ LDMA_TRANSFER_CFG_PERIPHERAL
#define LDMA_TRANSFER_CFG_PERIPHERAL | ( |
signal
|
) |
Generic DMA transfer configuration for memory to/from peripheral transfers.
◆ LDMA_TRANSFER_CFG_PERIPHERAL_LOOP
#define LDMA_TRANSFER_CFG_PERIPHERAL_LOOP | ( |
signal,
|
|
loopCnt
|
|||
) |
Generic DMA transfer configuration for looped memory to/from peripheral transfers.
◆ LDMA_DESCRIPTOR_SINGLE_M2M_WORD
#define LDMA_DESCRIPTOR_SINGLE_M2M_WORD | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for single memory to memory word transfer.
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of words to transfer.
◆ LDMA_DESCRIPTOR_SINGLE_M2M_HALF
#define LDMA_DESCRIPTOR_SINGLE_M2M_HALF | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for single memory to memory half-word transfer.
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of half-words to transfer.
◆ LDMA_DESCRIPTOR_SINGLE_M2M_BYTE
#define LDMA_DESCRIPTOR_SINGLE_M2M_BYTE | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for single memory to memory byte transfer.
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of bytes to transfer.
◆ LDMA_DESCRIPTOR_LINKABS_M2M_WORD
#define LDMA_DESCRIPTOR_LINKABS_M2M_WORD | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for linked memory to memory word transfer.
Link address must be an absolute address.
- Note
-
The linkAddr member of the transfer descriptor is not initialized. linkAddr must be initialized by using the proper bits right-shift to get the correct bits from the absolute address. _LDMA_CH_LINK_LINKADDR_SHIFT should be used for that operation:
desc.linkAddr = ((int32_t)&next_desc) >> _LDMA_CH_LINK_LINKADDR_SHIFT;
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of words to transfer.
◆ LDMA_DESCRIPTOR_LINKABS_M2M_HALF
#define LDMA_DESCRIPTOR_LINKABS_M2M_HALF | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for linked memory to memory half-word transfer.
Link address must be an absolute address.
- Note
-
The linkAddr member of the transfer descriptor is not initialized. linkAddr must be initialized by using the proper bits right-shift to get the correct bits from the absolute address. _LDMA_CH_LINK_LINKADDR_SHIFT should be used for that operation:
desc.linkAddr = ((int32_t)&next_desc) >> _LDMA_CH_LINK_LINKADDR_SHIFT;
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of half-words to transfer.
◆ LDMA_DESCRIPTOR_LINKABS_M2M_BYTE
#define LDMA_DESCRIPTOR_LINKABS_M2M_BYTE | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for linked memory to memory byte transfer.
Link address must be an absolute address.
- Note
-
The linkAddr member of the transfer descriptor is not initialized. linkAddr must be initialized by using the proper bits right-shift to get the correct bits from the absolute address. _LDMA_CH_LINK_LINKADDR_SHIFT should be used for that operation:
desc.linkAddr = ((int32_t)&next_desc) >> _LDMA_CH_LINK_LINKADDR_SHIFT;
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of bytes to transfer.
◆ LDMA_DESCRIPTOR_LINKREL_M2M_WORD
#define LDMA_DESCRIPTOR_LINKREL_M2M_WORD | ( |
src,
|
|
dest,
|
|||
count,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for linked memory to memory word transfer.
Link address is a relative address.
- Note
- The linkAddr member of the transfer descriptor is initialized to 4 (regular descriptor) or 7 (extended descriptor), assuming that the next descriptor immediately follows this descriptor (in memory).
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of words to transfer. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
◆ LDMA_DESCRIPTOR_LINKREL_M2M_HALF
#define LDMA_DESCRIPTOR_LINKREL_M2M_HALF | ( |
src,
|
|
dest,
|
|||
count,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for linked memory to memory half-word transfer.
Link address is a relative address.
- Note
- The linkAddr member of the transfer descriptor is initialized to 4 (regular descriptor) or 7 (extended descriptor), assuming that the next descriptor immediately follows this descriptor (in memory).
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of half-words to transfer. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
◆ LDMA_DESCRIPTOR_LINKREL_M2M_BYTE
#define LDMA_DESCRIPTOR_LINKREL_M2M_BYTE | ( |
src,
|
|
dest,
|
|||
count,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for linked memory to memory byte transfer.
Link address is a relative address.
- Note
- The linkAddr member of the transfer descriptor is initialized to 4 (regular descriptor) or 7 (extended descriptor), assuming that the next descriptor immediately follows this descriptor (in memory).
- Parameters
-
[in] src
Source data address. [in] dest
Destination data address. [in] count
Number of bytes to transfer. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
◆ LDMA_DESCRIPTOR_SINGLE_P2M_BYTE
#define LDMA_DESCRIPTOR_SINGLE_P2M_BYTE | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for byte transfers from a peripheral to memory.
- Parameters
-
[in] src
Peripheral data source register address. [in] dest
Destination data address. [in] count
Number of bytes to transfer.
◆ LDMA_DESCRIPTOR_SINGLE_P2P_BYTE
#define LDMA_DESCRIPTOR_SINGLE_P2P_BYTE | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for byte transfers from a peripheral to a peripheral.
- Parameters
-
[in] src
Peripheral data source register address. [in] dest
Peripheral data destination register address. [in] count
Number of bytes to transfer.
◆ LDMA_DESCRIPTOR_SINGLE_M2P_BYTE
#define LDMA_DESCRIPTOR_SINGLE_M2P_BYTE | ( |
src,
|
|
dest,
|
|||
count
|
|||
) |
DMA descriptor initializer for byte transfers from memory to a peripheral.
- Parameters
-
[in] src
Source data address. [in] dest
Peripheral data register destination address. [in] count
Number of bytes to transfer.
◆ LDMA_DESCRIPTOR_LINKREL_P2M_BYTE
#define LDMA_DESCRIPTOR_LINKREL_P2M_BYTE | ( |
src,
|
|
dest,
|
|||
count,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for byte transfers from a peripheral to memory.
- Parameters
-
[in] src
Peripheral data source register address. [in] dest
Destination data address. [in] count
Number of bytes to transfer. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
◆ LDMA_DESCRIPTOR_LINKREL_P2M_WORD
#define LDMA_DESCRIPTOR_LINKREL_P2M_WORD | ( |
src,
|
|
dest,
|
|||
count,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for word transfers from a peripheral to memory.
- Parameters
-
[in] src
Peripheral data source register address. [in] dest
Destination data address. [in] count
Number of words to transfer. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
◆ LDMA_DESCRIPTOR_LINKREL_M2P_BYTE
#define LDMA_DESCRIPTOR_LINKREL_M2P_BYTE | ( |
src,
|
|
dest,
|
|||
count,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for byte transfers from memory to a peripheral.
- Parameters
-
[in] src
Source data address. [in] dest
Peripheral data register destination address. [in] count
Number of bytes to transfer. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
◆ LDMA_DESCRIPTOR_SINGLE_WRITE
#define LDMA_DESCRIPTOR_SINGLE_WRITE | ( |
value,
|
|
address
|
|||
) |
DMA descriptor initializer for Immediate WRITE transfer.
- Parameters
-
[in] value
Immediate value to write. [in] address
Write address.
◆ LDMA_DESCRIPTOR_LINKABS_WRITE
#define LDMA_DESCRIPTOR_LINKABS_WRITE | ( |
value,
|
|
address
|
|||
) |
DMA descriptor initializer for Immediate WRITE transfer.
Link address must be an absolute address.
- Note
-
The linkAddr member of the transfer descriptor is not initialized. linkAddr must be initialized by using the proper bits right-shift to get the correct bits from the absolute address. _LDMA_CH_LINK_LINKADDR_SHIFT should be used for that operation:
desc.linkAddr = ((int32_t)&next_desc) >> _LDMA_CH_LINK_LINKADDR_SHIFT;
- Parameters
-
[in] value
Immediate value to write. [in] address
Write address.
◆ LDMA_DESCRIPTOR_LINKREL_WRITE
#define LDMA_DESCRIPTOR_LINKREL_WRITE | ( |
value,
|
|
address,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for Immediate WRITE transfer.
- Parameters
-
[in] value
Immediate value to write. [in] address
Write address. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
◆ LDMA_DESCRIPTOR_SINGLE_SYNC
#define LDMA_DESCRIPTOR_SINGLE_SYNC | ( |
set,
|
|
clr,
|
|||
matchValue,
|
|||
matchEnable
|
|||
) |
DMA descriptor initializer for SYNC transfer.
- Parameters
-
[in] set
Sync pattern bits to set. [in] clr
Sync pattern bits to clear. [in] matchValue
Sync pattern to match. [in] matchEnable
Sync pattern bits to enable for match.
◆ LDMA_DESCRIPTOR_LINKABS_SYNC
#define LDMA_DESCRIPTOR_LINKABS_SYNC | ( |
set,
|
|
clr,
|
|||
matchValue,
|
|||
matchEnable
|
|||
) |
DMA descriptor initializer for SYNC transfer.
Link address must be an absolute address.
- Note
-
The linkAddr member of the transfer descriptor is not initialized. linkAddr must be initialized by using the proper bits right-shift to get the correct bits from the absolute address. _LDMA_CH_LINK_LINKADDR_SHIFT should be used for that operation:
desc.linkAddr = ((int32_t)&next_desc) >> _LDMA_CH_LINK_LINKADDR_SHIFT;
- Parameters
-
[in] set
Sync pattern bits to set. [in] clr
Sync pattern bits to clear. [in] matchValue
Sync pattern to match. [in] matchEnable
Sync pattern bits to enable for match.
◆ LDMA_DESCRIPTOR_LINKREL_SYNC
#define LDMA_DESCRIPTOR_LINKREL_SYNC | ( |
set,
|
|
clr,
|
|||
matchValue,
|
|||
matchEnable,
|
|||
linkjmp
|
|||
) |
DMA descriptor initializer for SYNC transfer.
- Parameters
-
[in] set
Sync pattern bits to set. [in] clr
Sync pattern bits to clear. [in] matchValue
Sync pattern to match. [in] matchEnable
Sync pattern bits to enable for match. [in] linkjmp
Address of descriptor to link to, expressed as a signed number of descriptors from "here". 1=one descriptor forward in memory, 0=this descriptor, -1=one descriptor back in memory.
Enumeration Type Documentation
◆ LDMA_CtrlBlockSize_t
enum LDMA_CtrlBlockSize_t |
Controls the number of unit data transfers per arbitration cycle, providing a means to balance DMA channels' load on the controller.
◆ LDMA_CtrlStructType_t
◆ LDMA_CtrlReqMode_t
enum LDMA_CtrlReqMode_t |
◆ LDMA_CtrlSrcInc_t
enum LDMA_CtrlSrcInc_t |
Source address increment unit size.
◆ LDMA_CtrlSize_t
enum LDMA_CtrlSize_t |
◆ LDMA_CtrlDstInc_t
enum LDMA_CtrlDstInc_t |
Destination address increment unit size.
◆ LDMA_CtrlSrcAddrMode_t
◆ LDMA_CtrlDstAddrMode_t
◆ LDMA_LinkMode_t
enum LDMA_LinkMode_t |
◆ LDMA_CfgArbSlots_t
enum LDMA_CfgArbSlots_t |
◆ LDMA_CfgSrcIncSign_t
enum LDMA_CfgSrcIncSign_t |
◆ LDMA_CfgDstIncSign_t
enum LDMA_CfgDstIncSign_t |
◆ LDMA_PeripheralSignal_t
Peripherals that can trigger LDMA transfers.