1.25.26.3 XDMACn_ChannelTransfer Function

C

// n is instance of the peripheral and it is applicable only for devices having multiple instances of the peripheral.
bool XDMACn_ChannelTransfer
(
XDMAC_CHANNEL channel,
const void *srcAddr,
const void *destAddr,
size_t blockSize
)

Summary

Adds a data transfer to a XDMAC channel and enables the channel to start data transfer.

Description

This function adds a single block data transfer characteristics for a specific XDMAC channel id it is not busy already. It also enables the channel to start data transfer.

If the requesting client registered an event callback with the PLIB, the PLIB will issue a XDMAC_TRANSFER_COMPLETE event if the transfer was processed successfully and XDMAC_TRANSFER_ERROR event if the transfer was not processed successfully.

Precondition

XDMAC should have been initialized by calling XDMACn_Initialize.

Parameters

Returns

- True - If transfer request is accepted.

- False - If previous transfer is in progress and the request is rejected.

Example

// Transfer 10 bytes of data to UART TX using XDMAC channel 1
MY_APP_OBJ myAppObj;
uint8_t buf[10] = {0,1,2,3,4,5,6,7,8,9};
    void *srcAddr = (uint8_t *) buf;
    void *destAddr = (uin8_t*) &U1TXREG;
    size_t size = 10;
    
    // User registers an event handler with PLIB. This is done once.
    XDMAC_ChannelCallbackRegister(APP_XDMACTransferEventHandler,
    (uintptr_t)&myAppObj);
    
    if (XDMAC_ChannelTransfer(XDMAC_CHANNEL_1, srcAddr, destAddr, size) == true)
    {
        // do something else
    }
    else
    {
        // try again?
    }

Remarks

When DMA transfer buffers are placed in cacheable memory, cache maintenance operation must be performed by cleaning and invalidating cache for DMA buffers located in cacheable SRAM region using CMSIS APIs. The buffer start address must be aligned to cache line and buffer size must be multiple of cache line. Refer to device documentation to find the cache line size. Invalidate cache lines having received buffer before using it to load the latest data in the actual memory to the cache SCB_InvalidateDCache_by_Addr((uint32_t *)&readBuffer, sizeof(readBuffer)); Clean cache lines having source buffer before submitting a transfer request to XDMAC to load the latest data in the cache to the actual memory SCB_CleanDCache_by_Addr((uint32_t *)&writeBuffer, sizeof(writeBuffer));