DMA (Direct Memory Access)

General Description

Configures a DMA channel and its descriptor(s).

The functions and other declarations used in this driver are in cy_dma.h. You can include cy_pdl.h to get access to all functions and declarations in the PDL.

The DMA channel can be used in any project to transfer data without CPU intervention basing on a hardware trigger signal from another component.

A device may support more than one DMA hardware block. Each block has a set of registers, a base hardware address, and supports multiple channels. Many API functions for the DMA driver require a base hardware address and channel number. Ensure that you use the correct hardware address for the DMA block in use.

Features:

• Multiple DW blocks (device specific)
• Multiple channels per each DW block (device specific)
• Four priority levels for each channel
• Byte, half-word (2-byte), and word (4-byte) transfers
• Configurable source and destination addresses
• CRC calculation support (only for CPUSS_ver2)

Configuration Considerations

To set up a DMA driver, initialize a descriptor, initialize and enable a channel, and enable the DMA block.

To set up a descriptor, provide the configuration parameters for the descriptor in the cy_stc_dma_descriptor_config_t structure. Then call the Cy_DMA_Descriptor_Init function to initialize the descriptor in SRAM. You can modify the source and destination addresses dynamically by calling Cy_DMA_Descriptor_SetSrcAddress and Cy_DMA_Descriptor_SetDstAddress.

To set up a DMA channel, provide a filled cy_stc_dma_channel_config_t structure. Call the Cy_DMA_Channel_Init function, specifying the channel number. Use Cy_DMA_Channel_Enable to enable the configured DMA channel.

Call Cy_DMA_Channel_Enable for each DMA channel in use.

When configured, another peripheral typically triggers the DMA. The trigger is connected to the DMA using the trigger multiplexer. The trigger multiplexer driver has a software trigger you can use in firmware to trigger the DMA. See the Trigger Multiplexer documentation.

The following is a simplified structure of the DMA driver API interdependencies in a typical user application:

NOTE: DMA Trigger can also be provided through Cy_DMA_Channel_SetSWTrigger API on supported targets.
NOTE: DMA will read descriptors from SRAM memory. To run DMA on devices with Core CM7, D cache needs to be cleaned before DMA transfer and should be invalidated after DMA transfer.
NOTE: Even if a DMA channel is enabled, it is not operational until the DMA block is enabled using function Cy_DMA_Enable.
NOTE: If the DMA descriptor is configured to generate an interrupt, the interrupt must be enabled using the Cy_DMA_Channel_SetInterruptMask function for each DMA channel.

For example:

    
    /* Scenario: Initialize a 1D descriptor */
    #define DATACNT (8UL)
    #define CY_DMA_INTR_MASK (0x01UL)

    cy_stc_dma_descriptor_t descriptor;
    cy_stc_dma_descriptor_t nextDescriptor;
    uint32_t src_data[DATACNT];
    uint32_t dst_data[DATACNT];
    uint8_t currentYIndex;

    /* Enabling the interrupt using the Cy_DMA_Channel_SetInterruptMask function for DMA channel.*/
    Cy_DMA_Channel_SetInterruptMask(DW0, 0UL, CY_DMA_INTR_MASK);
    
    cy_stc_dma_descriptor_config_t descriptor_cfg = 
    {
        .retrigger = CY_DMA_RETRIG_IM,
        .interruptType = CY_DMA_DESCR,
        .triggerOutType = CY_DMA_DESCR,
        .channelState = CY_DMA_CHANNEL_ENABLED,
        .triggerInType = CY_DMA_DESCR,
        .dataSize = CY_DMA_WORD,
        .srcTransferSize = CY_DMA_TRANSFER_SIZE_WORD,
        .dstTransferSize = CY_DMA_TRANSFER_SIZE_WORD,
        .descriptorType = CY_DMA_1D_TRANSFER,
        .srcAddress = &src_data,
        .dstAddress = &dst_data,
        .srcXincrement = 1U,
        .dstXincrement = 1U,
        .xCount = DATACNT,
        .srcYincrement = 0U,
        .dstYincrement = 0U,
        .yCount = 1UL,
        .nextDescriptor = &nextDescriptor,
    };
    
    if (CY_DMA_SUCCESS != Cy_DMA_Descriptor_Init(&descriptor, &descriptor_cfg))
    {
        /* Insert error handling */
    }
    
    /* Scenario: Setup and enable the DMA channel 0 of block DW0 */
    cy_stc_dma_channel_config_t channelConfig;
    channelConfig.preemptable = false;
    channelConfig.enable = false;
    channelConfig.bufferable = false;
    
    if (CY_DMA_SUCCESS != Cy_DMA_Channel_Init(DW0, 0UL, &channelConfig))
    {
        /* Insert error handling */
    }
    
    Cy_DMA_Channel_SetDescriptor(DW0, 0UL, &descriptor);
    Cy_DMA_Channel_SetPriority(DW0, 0UL, 3UL);
    Cy_DMA_Channel_Enable(DW0, 0UL);
    
    Cy_DMA_Enable(DW0);

    if (true != Cy_DMA_Channel_IsEnabled(DW0, 0UL))
    {
        /* Insert error handling */
    }

    currentYIndex = Cy_DMA_Channel_GetCurrentYIndex(DW0, 0UL);
    (void) currentYIndex;

CM7 cores in CAT1C devices support Data Cache. Data Cache line is 32 bytes. User needs to make sure that the source and destination buffer pointers and the config structure pointers passed to the following functions points to 32 bit aligned data. Cy_DMA_Channel_SetDescriptor, Cy_DMA_Descriptor_SetNextDescriptor, Cy_DMA_Descriptor_SetSrcAddress, Cy_DMA_Descriptor_SetDstAddress. User can use CY_ALIGN(32) macro for 32 bit alignment. User needs to clean the following data elements from the cache and invalidate before accessing them. source and destination buffers and descriptor structure.

    int32_t cmpRes;

    (void)Cy_DMA_Descriptor_Init(&dw0_chan0_Descriptor, &dw0_chan0_Descriptor_config);
    Cy_DMA_Descriptor_SetSrcAddress(&dw0_chan0_Descriptor, src_data);
    Cy_DMA_Descriptor_SetDstAddress(&dw0_chan0_Descriptor, dst_data);

    Cy_DMA_Channel_Init(DW0, 0UL, &dw0_chan0_channelConfig);
    Cy_DMA_Channel_Enable(DW0, 0UL);

#if (CY_CPU_CORTEX_M7) && defined (ENABLE_CM7_DATA_CACHE)
    SCB_CleanDCache_by_Addr((uint32_t*)src_data, DATACNT);
    SCB_CleanDCache_by_Addr((uint32_t*)&dw0_chan0_Descriptor, sizeof(dw0_chan0_Descriptor));
#endif
#if (CY_IP_MXPERI_VERSION == 1U)
    Cy_TrigMux_SwTrigger(TRIG0_OUT_CPUSS_DW0_TR_IN0, CY_TRIGGER_TWO_CYCLES);
#else /* CY_IP_MXPERI_VERSION > 1 */
    Cy_TrigMux_SwTrigger(TRIG_OUT_MUX_0_PDMA0_TR_IN0, CY_TRIGGER_TWO_CYCLES);
#endif /* CY_IP_MXPERI_VERSION */

    while(!Cy_DMA_Channel_GetInterruptStatus(DW0,0UL))
    {

    }
#if (CY_CPU_CORTEX_M7) && defined (ENABLE_CM7_DATA_CACHE)
    SCB_InvalidateDCache_by_Addr ((uint32_t*)dst_data, DATACNT);
#endif

    cmpRes = memcmp(src_data, dst_data, DATACNT);
    if (cmpRes !=0)
    {
        /* Insert error handling */
    }
    else
    {
        /* working case */
    }

More Information.

See: the DMA chapter of the device technical reference manual (TRM); the DMA Component datasheet; CE219940 - PSoC 6 MCU Multiple DMA Concatenation.

Changelog

Version	Changes	Reason for Change
2.90	Added new APIs Cy_DMA_Channel_IsEnabled and Cy_DMA_Channel_GetCurrentYIndex.	New devices support.
2.80	Updated Cy_DMA_GetActiveChannel. Added new API Cy_DMA_GetActiveChannelIndex.	Bug fix.
2.70	Updated Cy_DMA_Descriptor_SetNextDescriptor and Cy_DMA_Descriptor_GetNextDescriptor.	Coverity bug fixes.
2.60	Fixed MISRA 2012 violations and minor documentation update.	MISRA 2012 compliance.
2.50	Fixed MISRA 2012 violations.	MISRA 2012 compliance.
2.40.1	Minor documentation updates.	Update to configure DMA on core CM7.
2.40	Minor Bug fixes.	Check for valid parameters.
2.30	Fixed MISRA 2012 violations.	MISRA 2012 compliance.
2.20.1	Minor documentation updates.	Documentation enhancement.
2.20	The channel number validation method is updated.	New devices support.
2.10	Flattened the organization of the driver source code into the single source directory and the single include directory.	Driver library directory-structure simplification.
	Added CRC mode and the CRC descriptor support. Added the Cy_DMA_Crc_Init function.	New devices support.
	Added register access layer. Use register access macros instead of direct register access using dereferenced pointers.	Makes register access device-independent, so that the PDL does not need to be recompiled for each supported part number.
2.0.1	Changed CY_DMA_BWC macro values from Boolean to numeric	Improvements made based on usability feedback
2.0	* All the API is refactored to be consistent within itself and with the rest of the PDL content. The descriptor API is updated as follows: The Cy_DMA_Descriptor_Init function sets a full bunch of descriptor settings, and the rest of the descriptor API is a get/set interface to each of the descriptor settings. There is a group of macros to support the backward compatibility with most of the driver version 1.0 API. But, you should use the new v2.0 interface in new designs (do not just copy-paste from old projects). To enable the backward compatibility support, the CY_DMA_BWC definition should be changed to "1".
1.0	Initial version

API Reference
	Macros
	Functions
	Data Structures
	Enumerated Types