IRES_EDMA3CHAN_ProtocolArgs Struct Reference

EDMA3 Linked Transfer Protocol Arguments definition. More...

#include <ires_edma3Chan.h>

Collaboration diagram for IRES_EDMA3CHAN_ProtocolArgs:

Data Fields
int	size
IRES_RequestMode	mode
short	numPaRams
short	paRamIndex
short	numTccs
short	tccIndex
short	qdmaChan
short	edmaChan
short	contiguousAllocation
short	shadowPaRamsAllocation

---

Detailed Description

EDMA3 Linked Transfer Protocol Arguments definition.

Remarks:

When requesting resources on a device on which DCHMAP feature does not exist, please follow these rules:

1. Break up requests into LOGICAL channel requests and requests for PaRams.
2. Logical Qdma/Edma channel => Q/E channel + PaRam + TCC
3. Avoid requesting EDMA3 resources of specific number, for most transfers an "ANY" type request should be sufficient
4. For linked transfers, request a Logical channel in one descriptor, and "N" contiguous Params in another descriptor
5. If a logical channel request is combined with a request for multiple Params or Tccs, this might result in an inefficient allocation of resources, and in some cases, simplifying assumptions about the resource requests may be made by the allocator.

---

Field Documentation

int IRES_EDMA3CHAN_ProtocolArgs::size

Size of this structure.

IRES_RequestMode IRES_EDMA3CHAN_ProtocolArgs::mode

Resource request type.

                                  @sa      IRES_RequestMode

short IRES_EDMA3CHAN_ProtocolArgs::numPaRams

Number of params requested.

                                  @remarks Must be between 0 and
                                           #IRES_EDMA3CHAN_MAXPARAMS - 1
                                           inclusive.

short IRES_EDMA3CHAN_ProtocolArgs::paRamIndex

Describe type of paRams required.

                                  @remarks If @c numParams > 1 and
                                           requesting contiguous Params,
                                           this field indicates the start
                                           index of the PaRam block.
                                           Otherwise, set this field to
                                           #IRES_EDMA3CHAN_PARAM_ANY.

short IRES_EDMA3CHAN_ProtocolArgs::numTccs

Number of Tcc(s) requested.

                                  @remarks Must be between 0 and
                                           #IRES_EDMA3CHAN_MAXTCCS -1
                                           inclusive.

short IRES_EDMA3CHAN_ProtocolArgs::tccIndex

The type of tccs requested.

                                  @remarks If @c numParams > 1 and
                                           requesting contiguous Params,
                                           this field indicates the start
                                           index of the Tcc block.
                                           Otherwise, set this field to
                                           #IRES_EDMA3CHAN_TCC_ANY.

short IRES_EDMA3CHAN_ProtocolArgs::qdmaChan

QDMA channel required, if any.

                                  @remarks If a QDMA channel is not
                                           needed, set this field to
                                           #IRES_EDMA3CHAN_CHAN_NONE.

short IRES_EDMA3CHAN_ProtocolArgs::edmaChan

Edma channel required if any.

                                  @remarks If a QDMA channel is not
                                           needed, set this field to
                                           #IRES_EDMA3CHAN_CHAN_NONE.

                                  @remarks If a single EDMA channel is
                                           requested with a single Tcc in
                                           one resource descriptor, then
                                           resource allocator will attempt
                                           to allocate
                                           EDMA Channel # N = Tcc # N, and
                                           will fail if that is
                                           unavailable.

short IRES_EDMA3CHAN_ProtocolArgs::contiguousAllocation

Flag indicating if contiguous allocation of PaRams and Tccs is required.

short IRES_EDMA3CHAN_ProtocolArgs::shadowPaRamsAllocation

Flag indicating if shadow PaRams need to be allocated.

---

The documentation for this struct was generated from the following file:

• ires_edma3Chan.h