PSOC E8XXGP Device Support Library

| PSOC E8XXGP Device Support Library

Enumerations
Enumerated Types
PDL API Reference » DMA (Direct Memory Access)

## General Description

## Enumerations
enum | cy_en_dma_intr_cause_t { CY_DMA_INTR_CAUSE_NO_INTR = 0U , CY_DMA_INTR_CAUSE_COMPLETION = 1U , CY_DMA_INTR_CAUSE_SRC_BUS_ERROR = 2U , CY_DMA_INTR_CAUSE_DST_BUS_ERROR = 3U , CY_DMA_INTR_CAUSE_SRC_MISAL = 4U , CY_DMA_INTR_CAUSE_DST_MISAL = 5U , CY_DMA_INTR_CAUSE_CURR_PTR_NULL = 6U , CY_DMA_INTR_CAUSE_ACTIVE_CH_DISABLED = 7U , CY_DMA_INTR_CAUSE_DESCR_BUS_ERROR = 8U }
| Contains the possible interrupt cause values. More...
enum | cy_en_dma_descriptor_type_t { CY_DMA_SINGLE_TRANSFER = 0UL , CY_DMA_1D_TRANSFER = 1UL , CY_DMA_2D_TRANSFER = 2UL , CY_DMA_CRC_TRANSFER = 3UL }
| Contains the options for the descriptor type. More...
enum | cy_en_dma_trigger_type_t { CY_DMA_1ELEMENT = 0UL , CY_DMA_X_LOOP = 1UL , CY_DMA_DESCR = 2UL , CY_DMA_DESCR_CHAIN = 3UL }
| Contains the options for the interrupt, trig-in and trig-out type parameters of the descriptor. More...
enum | cy_en_dma_data_size_t { CY_DMA_BYTE = 0UL , CY_DMA_HALFWORD = 1UL , CY_DMA_WORD = 2UL }
| Contains the options for the data size. More...
enum | cy_en_dma_retrigger_t { CY_DMA_RETRIG_IM = 0UL , CY_DMA_RETRIG_4CYC = 1UL , CY_DMA_RETRIG_16CYC = 2UL , CY_DMA_WAIT_FOR_REACT = 3UL }
| Contains the options for descriptor retriggering. More...
enum | cy_en_dma_transfer_size_t { CY_DMA_TRANSFER_SIZE_DATA = 0UL , CY_DMA_TRANSFER_SIZE_WORD = 1UL }
| Contains the options for the transfer size. More...
enum | cy_en_dma_channel_state_t { CY_DMA_CHANNEL_ENABLED = 0UL , CY_DMA_CHANNEL_DISABLED = 1UL }
| Contains the options for the state of the channel when the descriptor is completed More...
enum | cy_en_dma_status_t { CY_DMA_SUCCESS = 0x00UL , CY_DMA_BAD_PARAM = CY_DMA_ID | CY_PDL_STATUS_ERROR | 0x01UL }
| Contains the return values of the DMA driver. More...

## Enumeration Type Documentation

## ◆ cy_en_dma_intr_cause_t

enum cy_en_dma_intr_cause_t

Contains the possible interrupt cause values.

Enumerator
CY_DMA_INTR_CAUSE_NO_INTR | No interrupt.
CY_DMA_INTR_CAUSE_COMPLETION | Completion.
CY_DMA_INTR_CAUSE_SRC_BUS_ERROR | Source bus error.
CY_DMA_INTR_CAUSE_DST_BUS_ERROR | Destination bus error.
CY_DMA_INTR_CAUSE_SRC_MISAL | Source address is not aligned.
CY_DMA_INTR_CAUSE_DST_MISAL | Destination address is not aligned.
CY_DMA_INTR_CAUSE_CURR_PTR_NULL | Current descriptor pointer is NULL.
CY_DMA_INTR_CAUSE_ACTIVE_CH_DISABLED | Active channel is disabled.
CY_DMA_INTR_CAUSE_DESCR_BUS_ERROR | Descriptor bus error.

## ◆ cy_en_dma_descriptor_type_t

enum cy_en_dma_descriptor_type_t

Contains the options for the descriptor type.

Enumerator
CY_DMA_SINGLE_TRANSFER | Single transfer.
CY_DMA_1D_TRANSFER | 1D transfer.
CY_DMA_2D_TRANSFER | 2D transfer.
CY_DMA_CRC_TRANSFER | CRC transfer. Supported by the CPUSS_ver2 only.

## ◆ cy_en_dma_trigger_type_t

enum cy_en_dma_trigger_type_t

Contains the options for the interrupt, trig-in and trig-out type parameters of the descriptor.

Enumerator
CY_DMA_1ELEMENT | One element transfer.
CY_DMA_X_LOOP | One X loop transfer.
CY_DMA_DESCR | One descriptor transfer.
CY_DMA_DESCR_CHAIN | Entire descriptor chain transfer.

## ◆ cy_en_dma_data_size_t

enum cy_en_dma_data_size_t

Contains the options for the data size.

Enumerator
CY_DMA_BYTE | One byte.
CY_DMA_HALFWORD | Half word (two bytes).
CY_DMA_WORD | Full word (four bytes).

## ◆ cy_en_dma_retrigger_t

enum cy_en_dma_retrigger_t

Contains the options for descriptor retriggering.

Enumerator
CY_DMA_RETRIG_IM | Retrigger immediately.
CY_DMA_RETRIG_4CYC | Retrigger after 4 Clk_Slow cycles.
CY_DMA_RETRIG_16CYC | Retrigger after 16 Clk_Slow cycles.
CY_DMA_WAIT_FOR_REACT | Wait for trigger reactivation.

## ◆ cy_en_dma_transfer_size_t

enum cy_en_dma_transfer_size_t

Contains the options for the transfer size.

Enumerator
CY_DMA_TRANSFER_SIZE_DATA | As specified by dataSize.
CY_DMA_TRANSFER_SIZE_WORD | A full word (four bytes).

## ◆ cy_en_dma_channel_state_t

enum cy_en_dma_channel_state_t

Contains the options for the state of the channel when the descriptor is completed

Enumerator
CY_DMA_CHANNEL_ENABLED | Channel stays enabled.
CY_DMA_CHANNEL_DISABLED | Channel is disabled.

## ◆ cy_en_dma_status_t

enum cy_en_dma_status_t

Contains the return values of the DMA driver.

Enumerator
CY_DMA_SUCCESS | Success.
CY_DMA_BAD_PARAM | The input parameters passed to the DMA API are not valid.