Edma

Bandwidth control.

Define callback function for eDMA.

This callback function is called in the EDMA interrupt handle. In normal mode, run into callback function means the transfer users need is done. In scatter gather mode, run into callback function means a transfer control block (tcd) is finished. Not all transfer finished, users can get the finished tcd numbers using interface EDMA_GetUnusedTCDNumber.

Parameters:

handle	EDMA handle pointer, users shall not touch the values inside.
userData	The callback user parameter pointer. Users can use this parameter to involve things users need to change in EDMA callback function.
transferDone	If the current loaded transfer done. In normal mode it means if all transfer done. In scatter gather mode, this parameter shows is the current transfer block in EDMA register is done. As the load of core is different, it will be different if the new tcd loaded into EDMA registers while this callback called. If true, it always means new tcd still not loaded into registers, while false means new tcd already loaded into registers.
tcds	How many tcds are done from the last callback. This parameter only used in scatter gather mode. It tells user how many tcds are finished between the last callback and this.

Definition at line 242 of file fsl_edma.h.

Channel link type.

eDMA channel priority configuration

eDMA global configuration structure.

eDMA transfer handle structure

eDMA interrupt source

eDMA minor offset configuration

eDMA modulo configuration

eDMA TCD.

This structure is same as TCD register which is described in reference manual, and is used to configure the scatter/gather feature as a next hardware TCD.

eDMA transfer configuration

This structure configures the source/destination transfer attribute.

eDMA transfer configuration

eDMA transfer type

Bandwidth control.

Enumerator:

kEDMA_BandwidthStallNone	No eDMA engine stalls.
kEDMA_BandwidthStall4Cycle	eDMA engine stalls for 4 cycles after each read/write.
kEDMA_BandwidthStall8Cycle	eDMA engine stalls for 8 cycles after each read/write.

Definition at line 84 of file fsl_edma.h.

Channel link type.

Enumerator:

kEDMA_LinkNone	No channel link
kEDMA_MinorLink	Channel link after each minor loop
kEDMA_MajorLink	Channel link while major loop count exhausted

Definition at line 92 of file fsl_edma.h.

eDMA channel status flags.

Enumerator:

kEDMA_DoneFlag	DONE flag, set while transfer finished, CITER value exhausted
kEDMA_ErrorFlag	eDMA error flag, an error occurred in a transfer
kEDMA_InterruptFlag	eDMA interrupt flag, set while an interrupt occurred of this channel

Definition at line 100 of file fsl_edma.h.

eDMA channel error status flags.

Enumerator:

kEDMA_DestinationBusErrorFlag	Bus error on destination address
kEDMA_SourceBusErrorFlag	Bus error on the source address
kEDMA_ScatterGatherErrorFlag	Error on the Scatter/Gather address, not 32byte aligned.
kEDMA_NbytesErrorFlag	NBYTES/CITER configuration error
kEDMA_DestinationOffsetErrorFlag	Destination offset not aligned with destination size
kEDMA_DestinationAddressErrorFlag	Destination address not aligned with destination size
kEDMA_SourceOffsetErrorFlag	Source offset not aligned with source size
kEDMA_SourceAddressErrorFlag	Source address not aligned with source size
kEDMA_ErrorChannelFlag	Error channel number of the cancelled channel number
kEDMA_ChannelPriorityErrorFlag	Channel priority is not unique.
kEDMA_TransferCanceledFlag	Transfer cancelled
kEDMA_GroupPriorityErrorFlag	Group priority is not unique.
kEDMA_ValidFlag	No error occurred, this bit is 0. Otherwise, it is 1.

Definition at line 108 of file fsl_edma.h.

eDMA interrupt source

Enumerator:

kEDMA_ErrorInterruptEnable	Enable interrupt while channel error occurs.
kEDMA_MajorInterruptEnable	Enable interrupt while major count exhausted.
kEDMA_HalfInterruptEnable	Enable interrupt while major count to half value.

Definition at line 128 of file fsl_edma.h.

eDMA modulo configuration

Enumerator:

kEDMA_ModuloDisable	Disable modulo
kEDMA_Modulo2bytes	Circular buffer size is 2 bytes.
kEDMA_Modulo4bytes	Circular buffer size is 4 bytes.
kEDMA_Modulo8bytes	Circular buffer size is 8 bytes.
kEDMA_Modulo16bytes	Circular buffer size is 16 bytes.
kEDMA_Modulo32bytes	Circular buffer size is 32 bytes.
kEDMA_Modulo64bytes	Circular buffer size is 64 bytes.
kEDMA_Modulo128bytes	Circular buffer size is 128 bytes.
kEDMA_Modulo256bytes	Circular buffer size is 256 bytes.
kEDMA_Modulo512bytes	Circular buffer size is 512 bytes.
kEDMA_Modulo1Kbytes	Circular buffer size is 1 K bytes.
kEDMA_Modulo2Kbytes	Circular buffer size is 2 K bytes.
kEDMA_Modulo4Kbytes	Circular buffer size is 4 K bytes.
kEDMA_Modulo8Kbytes	Circular buffer size is 8 K bytes.
kEDMA_Modulo16Kbytes	Circular buffer size is 16 K bytes.
kEDMA_Modulo32Kbytes	Circular buffer size is 32 K bytes.
kEDMA_Modulo64Kbytes	Circular buffer size is 64 K bytes.
kEDMA_Modulo128Kbytes	Circular buffer size is 128 K bytes.
kEDMA_Modulo256Kbytes	Circular buffer size is 256 K bytes.
kEDMA_Modulo512Kbytes	Circular buffer size is 512 K bytes.
kEDMA_Modulo1Mbytes	Circular buffer size is 1 M bytes.
kEDMA_Modulo2Mbytes	Circular buffer size is 2 M bytes.
kEDMA_Modulo4Mbytes	Circular buffer size is 4 M bytes.
kEDMA_Modulo8Mbytes	Circular buffer size is 8 M bytes.
kEDMA_Modulo16Mbytes	Circular buffer size is 16 M bytes.
kEDMA_Modulo32Mbytes	Circular buffer size is 32 M bytes.
kEDMA_Modulo64Mbytes	Circular buffer size is 64 M bytes.
kEDMA_Modulo128Mbytes	Circular buffer size is 128 M bytes.
kEDMA_Modulo256Mbytes	Circular buffer size is 256 M bytes.
kEDMA_Modulo512Mbytes	Circular buffer size is 512 M bytes.
kEDMA_Modulo1Gbytes	Circular buffer size is 1 G bytes.
kEDMA_Modulo2Gbytes	Circular buffer size is 2 G bytes.

Definition at line 47 of file fsl_edma.h.

eDMA transfer configuration

Enumerator:

kEDMA_TransferSize1Bytes	Source/Destination data transfer size is 1 byte every time
kEDMA_TransferSize2Bytes	Source/Destination data transfer size is 2 bytes every time
kEDMA_TransferSize4Bytes	Source/Destination data transfer size is 4 bytes every time
kEDMA_TransferSize8Bytes	Source/Destination data transfer size is 8 bytes every time
kEDMA_TransferSize16Bytes	Source/Destination data transfer size is 16 bytes every time
kEDMA_TransferSize32Bytes	Source/Destination data transfer size is 32 bytes every time

Definition at line 36 of file fsl_edma.h.

eDMA transfer status

Enumerator:

kStatus_EDMA_QueueFull	TCD queue is full.
kStatus_EDMA_Busy	Channel is busy and can't handle the transfer request.

Definition at line 144 of file fsl_edma.h.

eDMA transfer type

Enumerator:

kEDMA_MemoryToMemory	Transfer from memory to memory
kEDMA_PeripheralToMemory	Transfer from peripheral to memory
kEDMA_MemoryToPeripheral	Transfer from memory to peripheral

Definition at line 136 of file fsl_edma.h.

eDMA aborts transfer.

This function disables the channel request and clear transfer status bits. Users can submit another transfer after calling this API.

Parameters:

handle

DMA handle pointer.

brief eDMA aborts transfer.

This function disables the channel request and clear transfer status bits. Users can submit another transfer after calling this API.

param handle DMA handle pointer.

Definition at line 1164 of file fsl_edma.c.

Clears the eDMA channel status flags.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
mask	The mask of channel status to be cleared. Users need to use the defined _edma_channel_status_flags type.

brief Clears the eDMA channel status flags.

param base eDMA peripheral base address. param channel eDMA channel number. param mask The mask of channel status to be cleared. Users need to use the defined _edma_channel_status_flags type.

Definition at line 708 of file fsl_edma.c.

Creates the eDMA handle.

This function is called if using the transactional API for eDMA. This function initializes the internal state of the eDMA handle.

Parameters:

handle	eDMA handle pointer. The eDMA handle stores callback function and parameters.
base	eDMA peripheral base address.
channel	eDMA channel number.

brief Creates the eDMA handle.

This function is called if using the transactional API for eDMA. This function initializes the internal state of the eDMA handle.

param handle eDMA handle pointer. The eDMA handle stores callback function and parameters. param base eDMA peripheral base address. param channel eDMA channel number.

Definition at line 757 of file fsl_edma.c.

Deinitializes the eDMA peripheral.

This function gates the eDMA clock.

Parameters:

base	eDMA peripheral base address.

brief Deinitializes the eDMA peripheral.

This function gates the eDMA clock.

param base eDMA peripheral base address.

Definition at line 143 of file fsl_edma.c.

Disables the interrupt source for the eDMA transfer.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
mask	The mask of the interrupt source to be set. Use the defined edma_interrupt_enable_t type.

brief Disables the interrupt source for the eDMA transfer.

param base eDMA peripheral base address. param channel eDMA channel number. param mask The mask of the interrupt source to be set. Use the defined edma_interrupt_enable_t type.

Definition at line 361 of file fsl_edma.c.

Disables the eDMA hardware channel request.

This function disables the hardware channel request.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.

Definition at line 669 of file fsl_edma.h.

Enables an async request for the eDMA transfer.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
enable	The command to enable (true) or disable (false).

Definition at line 456 of file fsl_edma.h.

Enables an auto stop request for the eDMA transfer.

If enabling the auto stop request, the eDMA hardware automatically disables the hardware channel request.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
enable	The command to enable (true) or disable (false).

Definition at line 473 of file fsl_edma.h.

Enables the interrupt source for the eDMA transfer.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
mask	The mask of interrupt source to be set. Users need to use the defined edma_interrupt_enable_t type.

brief Enables the interrupt source for the eDMA transfer.

param base eDMA peripheral base address. param channel eDMA channel number. param mask The mask of interrupt source to be set. Users need to use the defined edma_interrupt_enable_t type.

Definition at line 330 of file fsl_edma.c.

Enables the eDMA hardware channel request.

This function enables the hardware channel request.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.

Definition at line 654 of file fsl_edma.h.

Gets the eDMA channel status flags.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.

Returns:

The mask of channel status flags. Users need to use the _edma_channel_status_flags type to decode the return variables.

brief Gets the eDMA channel status flags.

param base eDMA peripheral base address. param channel eDMA channel number. return The mask of channel status flags. Users need to use the _edma_channel_status_flags type to decode the return variables.

Definition at line 684 of file fsl_edma.c.

Gets the eDMA default configuration structure.

This function sets the configuration structure to default values. The default configuration is set to the following values.

   config.enableContinuousLinkMode = false;
   config.enableHaltOnError = true;
   config.enableRoundRobinArbitration = false;
   config.enableDebugMode = false;

Parameters:

config

A pointer to the eDMA configuration structure.

brief Gets the eDMA default configuration structure.

This function sets the configuration structure to default values. The default configuration is set to the following values. code config.enableContinuousLinkMode = false; config.enableHaltOnError = true; config.enableRoundRobinArbitration = false; config.enableDebugMode = false; endcode

param config A pointer to the eDMA configuration structure.

Definition at line 165 of file fsl_edma.c.

Gets the eDMA channel error status flags.

Parameters:

base	eDMA peripheral base address.

Returns:

The mask of error status flags. Users need to use the _edma_error_status_flags type to decode the return variables.

Definition at line 727 of file fsl_edma.h.

Get the next tcd address.

This function gets the next tcd address. If this is last TCD, return 0.

Parameters:

handle

DMA handle pointer.

Returns:

The next TCD address.

Definition at line 888 of file fsl_edma.h.

Gets the remaining major loop count from the eDMA current channel TCD.

This function checks the TCD (Task Control Descriptor) status for a specified eDMA channel and returns the number of major loop count that has not finished.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.

Returns:

Major loop count which has not been transferred yet for the current TCD.

Note:

1. This function can only be used to get unfinished major loop count of transfer without the next TCD, or it might be inaccuracy. 2. The unfinished/remaining transfer bytes cannot be obtained directly from registers while the channel is running. Because to calculate the remaining bytes, the initial NBYTES configured in DMA_TCDn_NBYTES_MLNO register is needed while the eDMA IP does not support getting it while a channel is active. In another word, the NBYTES value reading is always the actual (decrementing) NBYTES value the dma_engine is working with while a channel is running. Consequently, to get the remaining transfer bytes, a software-saved initial value of NBYTES (for example copied before enabling the channel) is needed. The formula to calculate it is shown below: RemainingBytes = RemainingMajorLoopCount * NBYTES(initially configured)

brief Gets the remaining major loop count from the eDMA current channel TCD.

This function checks the TCD (Task Control Descriptor) status for a specified eDMA channel and returns the number of major loop count that has not finished.

param base eDMA peripheral base address. param channel eDMA channel number. return Major loop count which has not been transferred yet for the current TCD. note 1. This function can only be used to get unfinished major loop count of transfer without the next TCD, or it might be inaccuracy. 2. The unfinished/remaining transfer bytes cannot be obtained directly from registers while the channel is running. Because to calculate the remaining bytes, the initial NBYTES configured in DMA_TCDn_NBYTES_MLNO register is needed while the eDMA IP does not support getting it while a channel is active. In another word, the NBYTES value reading is always the actual (decrementing) NBYTES value the dma_engine is working with while a channel is running. Consequently, to get the remaining transfer bytes, a software-saved initial value of NBYTES (for example copied before enabling the channel) is needed. The formula to calculate it is shown below: RemainingBytes = RemainingMajorLoopCount * NBYTES(initially configured)

Definition at line 648 of file fsl_edma.c.

Get unused TCD slot number.

This function gets current tcd index which is run. If the TCD pool pointer is NULL, it will return 0.

Parameters:

handle

DMA handle pointer.

Returns:

The unused tcd slot number.

Definition at line 875 of file fsl_edma.h.

eDMA IRQ handler for the current major loop transfer completion.

This function clears the channel major interrupt flag and calls the callback function if it is not NULL.

Note: For the case using TCD queue, when the major iteration count is exhausted, additional operations are performed. These include the final address adjustments and reloading of the BITER field into the CITER. Assertion of an optional interrupt request also occurs at this time, as does a possible fetch of a new TCD from memory using the scatter/gather address pointer included in the descriptor (if scatter/gather is enabled).

For instance, when the time interrupt of TCD[0] happens, the TCD[1] has already been loaded into the eDMA engine. As sga and sga_index are calculated based on the DLAST_SGA bitfield lies in the TCD_CSR register, the sga_index in this case should be 2 (DLAST_SGA of TCD[1] stores the address of TCD[2]). Thus, the "tcdUsed" updated should be (tcdUsed - 2U) which indicates the number of TCDs can be loaded in the memory pool (because TCD[0] and TCD[1] have been loaded into the eDMA engine at this point already.).

For the last two continuous ISRs in a scatter/gather process, they both load the last TCD (The last ISR does not load a new TCD) from the memory pool to the eDMA engine when major loop completes. Therefore, ensure that the header and tcdUsed updated are identical for them. tcdUsed are both 0 in this case as no TCD to be loaded.

See the "eDMA basic data flow" in the eDMA Functional description section of the Reference Manual for further details.

Parameters:

handle

eDMA handle pointer.

brief eDMA IRQ handler for the current major loop transfer completion.

This function clears the channel major interrupt flag and calls the callback function if it is not NULL.

Note: For the case using TCD queue, when the major iteration count is exhausted, additional operations are performed. These include the final address adjustments and reloading of the BITER field into the CITER. Assertion of an optional interrupt request also occurs at this time, as does a possible fetch of a new TCD from memory using the scatter/gather address pointer included in the descriptor (if scatter/gather is enabled).

For instance, when the time interrupt of TCD[0] happens, the TCD[1] has already been loaded into the eDMA engine. As sga and sga_index are calculated based on the DLAST_SGA bitfield lies in the TCD_CSR register, the sga_index in this case should be 2 (DLAST_SGA of TCD[1] stores the address of TCD[2]). Thus, the "tcdUsed" updated should be (tcdUsed - 2U) which indicates the number of TCDs can be loaded in the memory pool (because TCD[0] and TCD[1] have been loaded into the eDMA engine at this point already.).

For the last two continuous ISRs in a scatter/gather process, they both load the last TCD (The last ISR does not load a new TCD) from the memory pool to the eDMA engine when major loop completes. Therefore, ensure that the header and tcdUsed updated are identical for them. tcdUsed are both 0 in this case as no TCD to be loaded.

See the "eDMA basic data flow" in the eDMA Functional description section of the Reference Manual for further details.

param handle eDMA handle pointer.

Definition at line 1213 of file fsl_edma.c.

Initializes the eDMA peripheral.

This function ungates the eDMA clock and configures the eDMA peripheral according to the configuration structure.

Parameters:

base	eDMA peripheral base address.
config	A pointer to the configuration structure, see "edma_config_t".

Note:

This function enables the minor loop map feature.

brief Initializes the eDMA peripheral.

This function ungates the eDMA clock and configures the eDMA peripheral according to the configuration structure.

param base eDMA peripheral base address. param config A pointer to the configuration structure, see "edma_config_t". note This function enables the minor loop map feature.

Definition at line 113 of file fsl_edma.c.

Push content of TCD structure into hardware TCD register.

Parameters:

base	EDMA peripheral base address.
channel	EDMA channel number.
tcd	Point to TCD structure.

brief Push content of TCD structure into hardware TCD register.

param base EDMA peripheral base address. param channel EDMA channel number. param tcd Point to TCD structure.

Definition at line 81 of file fsl_edma.c.

Installs the TCDs memory pool into the eDMA handle.

This function is called after the EDMA_CreateHandle to use scatter/gather feature. This function shall only be used while users need to use scatter gather mode. Scatter gather mode enables EDMA to load a new transfer control block (tcd) in hardware, and automatically reconfigure that DMA channel for a new transfer. Users need to prepare tcd memory and also configure tcds using interface EDMA_SubmitTransfer.

Parameters:

handle	eDMA handle pointer.
tcdPool	A memory pool to store TCDs. It must be 32 bytes aligned.
tcdSize	The number of TCD slots.

brief Installs the TCDs memory pool into the eDMA handle.

This function is called after the EDMA_CreateHandle to use scatter/gather feature. This function shall only be used while users need to use scatter gather mode. Scatter gather mode enables EDMA to load a new transfer control block (tcd) in hardware, and automatically reconfigure that DMA channel for a new transfer. Users need to prepare tcd memory and also configure tcds using interface EDMA_SubmitTransfer.

param handle eDMA handle pointer. param tcdPool A memory pool to store TCDs. It must be 32 bytes aligned. param tcdSize The number of TCD slots.

Definition at line 812 of file fsl_edma.c.

Prepares the eDMA transfer structure.

This function prepares the transfer configuration structure according to the user input.

Parameters:

config	The user configuration structure of type edma_transfer_t.
srcAddr	eDMA transfer source address.
srcWidth	eDMA transfer source address width(bytes).
destAddr	eDMA transfer destination address.
destWidth	eDMA transfer destination address width(bytes).
bytesEachRequest	eDMA transfer bytes per channel request.
transferBytes	eDMA transfer bytes to be transferred.
type	eDMA transfer type.

Note:

The data address and the data width must be consistent. For example, if the SRC is 4 bytes, the source address must be 4 bytes aligned, or it results in source address error (SAE).

brief Prepares the eDMA transfer structure.

This function prepares the transfer configuration structure according to the user input.

param config The user configuration structure of type edma_transfer_t. param srcAddr eDMA transfer source address. param srcWidth eDMA transfer source address width(bytes). param destAddr eDMA transfer destination address. param destWidth eDMA transfer destination address width(bytes). param bytesEachRequest eDMA transfer bytes per channel request. param transferBytes eDMA transfer bytes to be transferred. param type eDMA transfer type. note The data address and the data width must be consistent. For example, if the SRC is 4 bytes, the source address must be 4 bytes aligned, or it results in source address error (SAE).

Definition at line 861 of file fsl_edma.c.

Sets all TCD registers to default values.

This function sets TCD registers for this channel to default values.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.

Note:

This function must not be called while the channel transfer is ongoing or it causes unpredictable results.

This function enables the auto stop request feature.

brief Sets all TCD registers to default values.

This function sets TCD registers for this channel to default values.

param base eDMA peripheral base address. param channel eDMA channel number. note This function must not be called while the channel transfer is ongoing or it causes unpredictable results. note This function enables the auto stop request feature.

Definition at line 189 of file fsl_edma.c.

Sets the bandwidth for the eDMA transfer.

Because the eDMA processes the minor loop, it continuously generates read/write sequences until the minor count is exhausted. The bandwidth forces the eDMA to stall after the completion of each read/write access to control the bus request bandwidth seen by the crossbar switch.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
bandWidth	A bandwidth setting, which can be one of the following: kEDMABandwidthStallNone kEDMABandwidthStall4Cycle kEDMABandwidthStall8Cycle brief Sets the bandwidth for the eDMA transfer.

Because the eDMA processes the minor loop, it continuously generates read/write sequences until the minor count is exhausted. The bandwidth forces the eDMA to stall after the completion of each read/write access to control the bus request bandwidth seen by the crossbar switch.

param base eDMA peripheral base address. param channel eDMA channel number. param bandWidth A bandwidth setting, which can be one of the following: arg kEDMABandwidthStallNone arg kEDMABandwidthStall4Cycle arg kEDMABandwidthStall8Cycle

Definition at line 293 of file fsl_edma.c.

Installs a callback function for the eDMA transfer.

This callback is called in the eDMA IRQ handler. Use the callback to do something after the current major loop transfer completes. This function will be called every time one tcd finished transfer.

Parameters:

handle	eDMA handle pointer.
callback	eDMA callback function pointer.
userData	A parameter for the callback function.

brief Installs a callback function for the eDMA transfer.

This callback is called in the eDMA IRQ handler. Use the callback to do something after the current major loop transfer completes. This function will be called every time one tcd finished transfer.

param handle eDMA handle pointer. param callback eDMA callback function pointer. param userData A parameter for the callback function.

Definition at line 836 of file fsl_edma.c.

Sets the channel link for the eDMA transfer.

This function configures either the minor link or the major link mode. The minor link means that the channel link is triggered every time CITER decreases by 1. The major link means that the channel link is triggered when the CITER is exhausted.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
type	A channel link type, which can be one of the following: kEDMA_LinkNone kEDMA_MinorLink kEDMA_MajorLink
linkedChannel	The linked channel number.

Note:

Users should ensure that DONE flag is cleared before calling this interface, or the configuration is invalid.

brief Sets the channel link for the eDMA transfer.

This function configures either the minor link or the major link mode. The minor link means that the channel link is triggered every time CITER decreases by 1. The major link means that the channel link is triggered when the CITER is exhausted.

param base eDMA peripheral base address. param channel eDMA channel number. param type A channel link type, which can be one of the following: arg kEDMA_LinkNone arg kEDMA_MinorLink arg kEDMA_MajorLink param linkedChannel The linked channel number. note Users should ensure that DONE flag is cleared before calling this interface, or the configuration is invalid.

Definition at line 271 of file fsl_edma.c.

Configures the eDMA channel preemption feature.

This function configures the channel preemption attribute and the priority of the channel.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number
config	A pointer to the channel preemption configuration structure.

Definition at line 388 of file fsl_edma.h.

Configures the eDMA minor offset feature.

The minor offset means that the signed-extended value is added to the source address or destination address after each minor loop.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
config	A pointer to the minor offset configuration structure.

brief Configures the eDMA minor offset feature.

The minor offset means that the signed-extended value is added to the source address or destination address after each minor loop.

param base eDMA peripheral base address. param channel eDMA channel number. param config A pointer to the minor offset configuration structure.

Definition at line 240 of file fsl_edma.c.

Sets the source modulo and the destination modulo for the eDMA transfer.

This function defines a specific address range specified to be the value after (SADDR + SOFF)/(DADDR + DOFF) calculation is performed or the original register value. It provides the ability to implement a circular data queue easily.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
srcModulo	A source modulo value.
destModulo	A destination modulo value.

brief Sets the source modulo and the destination modulo for the eDMA transfer.

This function defines a specific address range specified to be the value after (SADDR + SOFF)/(DADDR + DOFF) calculation is performed or the original register value. It provides the ability to implement a circular data queue easily.

param base eDMA peripheral base address. param channel eDMA channel number. param srcModulo A source modulo value. param destModulo A destination modulo value.

Definition at line 312 of file fsl_edma.c.

Configures the eDMA transfer attribute.

This function configures the transfer attribute, including source address, destination address, transfer size, address offset, and so on. It also configures the scatter gather feature if the user supplies the TCD address. Example:

  edma_transfer_t config;
  edma_tcd_t tcd;
  config.srcAddr = ..;
  config.destAddr = ..;
  ...
  EDMA_SetTransferConfig(DMA0, channel, &config, &stcd);

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.
config	Pointer to eDMA transfer configuration structure.
nextTcd	Point to TCD structure. It can be NULL if users do not want to enable scatter/gather feature.

Note:

If nextTcd is not NULL, it means scatter gather feature is enabled and DREQ bit is cleared in the previous transfer configuration, which is set in the eDMA_ResetChannel.

brief Configures the eDMA transfer attribute.

This function configures the transfer attribute, including source address, destination address, transfer size, address offset, and so on. It also configures the scatter gather feature if the user supplies the TCD address. Example: code edma_transfer_t config; edma_tcd_t tcd; config.srcAddr = ..; config.destAddr = ..; ... EDMA_SetTransferConfig(DMA0, channel, &config, &stcd); endcode

param base eDMA peripheral base address. param channel eDMA channel number. param config Pointer to eDMA transfer configuration structure. param nextTcd Point to TCD structure. It can be NULL if users do not want to enable scatter/gather feature. note If nextTcd is not NULL, it means scatter gather feature is enabled and DREQ bit is cleared in the previous transfer configuration, which is set in the eDMA_ResetChannel.

Definition at line 221 of file fsl_edma.c.

eDMA starts transfer.

This function enables the channel request. Users can call this function after submitting the transfer request or before submitting the transfer request.

Parameters:

handle

eDMA handle pointer.

brief eDMA starts transfer.

This function enables the channel request. Users can call this function after submitting the transfer request or before submitting the transfer request.

param handle eDMA handle pointer.

Definition at line 1103 of file fsl_edma.c.

eDMA stops transfer.

This function disables the channel request to pause the transfer. Users can call EDMA_StartTransfer() again to resume the transfer.

Parameters:

handle

eDMA handle pointer.

brief eDMA stops transfer.

This function disables the channel request to pause the transfer. Users can call EDMA_StartTransfer() again to resume the transfer.

param handle eDMA handle pointer.

Definition at line 1148 of file fsl_edma.c.

Submits the eDMA transfer request.

This function submits the eDMA transfer request according to the transfer configuration structure. In scatter gather mode, call this function will add a configured tcd to the circular list of tcd pool. The tcd pools is setup by call function EDMA_InstallTCDMemory before.

Parameters:

handle	eDMA handle pointer.
config	Pointer to eDMA transfer configuration structure.

Return values:

kStatus_EDMA_Success	It means submit transfer request succeed.
kStatus_EDMA_QueueFull	It means TCD queue is full. Submit transfer request is not allowed.
kStatus_EDMA_Busy	It means the given channel is busy, need to submit request later.

brief Submits the eDMA transfer request.

This function submits the eDMA transfer request according to the transfer configuration structure. In scatter gather mode, call this function will add a configured tcd to the circular list of tcd pool. The tcd pools is setup by call function EDMA_InstallTCDMemory before.

param handle eDMA handle pointer. param config Pointer to eDMA transfer configuration structure. retval kStatus_EDMA_Success It means submit transfer request succeed. retval kStatus_EDMA_QueueFull It means TCD queue is full. Submit transfer request is not allowed. retval kStatus_EDMA_Busy It means the given channel is busy, need to submit request later.

Definition at line 956 of file fsl_edma.c.

Disables the interrupt source for the eDMA TCD.

Parameters:

tcd	Point to the TCD structure.
mask	The mask of interrupt source to be set. Users need to use the defined edma_interrupt_enable_t type.

brief Disables the interrupt source for the eDMA TCD.

param tcd Point to the TCD structure. param mask The mask of interrupt source to be set. Users need to use the defined edma_interrupt_enable_t type.

Definition at line 610 of file fsl_edma.c.

Sets the auto stop request for the eDMA TCD.

If enabling the auto stop request, the eDMA hardware automatically disables the hardware channel request.

Parameters:

tcd	A pointer to the TCD structure.
enable	The command to enable (true) or disable (false).

Definition at line 614 of file fsl_edma.h.

Enables the interrupt source for the eDMA TCD.

Parameters:

tcd	Point to the TCD structure.
mask	The mask of interrupt source to be set. Users need to use the defined edma_interrupt_enable_t type.

brief Enables the interrupt source for the eDMA TCD.

param tcd Point to the TCD structure. param mask The mask of interrupt source to be set. Users need to use the defined edma_interrupt_enable_t type.

Definition at line 586 of file fsl_edma.c.

Sets all fields to default values for the TCD structure.

This function sets all fields for this TCD structure to default value.

Parameters:

tcd	Pointer to the TCD structure.

Note:

This function enables the auto stop request feature.

brief Sets all fields to default values for the TCD structure.

This function sets all fields for this TCD structure to default value.

param tcd Pointer to the TCD structure. note This function enables the auto stop request feature.

Definition at line 392 of file fsl_edma.c.

Sets the bandwidth for the eDMA TCD.

Because the eDMA processes the minor loop, it continuously generates read/write sequences until the minor count is exhausted. The bandwidth forces the eDMA to stall after the completion of each read/write access to control the bus request bandwidth seen by the crossbar switch.

Parameters:

tcd	A pointer to the TCD structure.
bandWidth	A bandwidth setting, which can be one of the following: kEDMABandwidthStallNone kEDMABandwidthStall4Cycle kEDMABandwidthStall8Cycle

Definition at line 585 of file fsl_edma.h.

Sets the channel link for the eDMA TCD.

This function configures either a minor link or a major link. The minor link means the channel link is triggered every time CITER decreases by 1. The major link means that the channel link is triggered when the CITER is exhausted.

Note:

Users should ensure that DONE flag is cleared before calling this interface, or the configuration is invalid.

Parameters:

tcd	Point to the TCD structure.
type	Channel link type, it can be one of: kEDMA_LinkNone kEDMA_MinorLink kEDMA_MajorLink
linkedChannel	The linked channel number.

brief Sets the channel link for the eDMA TCD.

This function configures either a minor link or a major link. The minor link means the channel link is triggered every time CITER decreases by 1. The major link means that the channel link is triggered when the CITER is exhausted.

note Users should ensure that DONE flag is cleared before calling this interface, or the configuration is invalid. param tcd Point to the TCD structure. param type Channel link type, it can be one of: arg kEDMA_LinkNone arg kEDMA_MinorLink arg kEDMA_MajorLink param linkedChannel The linked channel number.

Definition at line 518 of file fsl_edma.c.

Configures the eDMA TCD minor offset feature.

A minor offset is a signed-extended value added to the source address or a destination address after each minor loop.

Parameters:

tcd	A point to the TCD structure.
config	A pointer to the minor offset configuration structure.

brief Configures the eDMA TCD minor offset feature.

A minor offset is a signed-extended value added to the source address or a destination address after each minor loop.

param tcd A point to the TCD structure. param config A pointer to the minor offset configuration structure.

Definition at line 488 of file fsl_edma.c.

Sets the source modulo and the destination modulo for the eDMA TCD.

This function defines a specific address range specified to be the value after (SADDR + SOFF)/(DADDR + DOFF) calculation is performed or the original register value. It provides the ability to implement a circular data queue easily.

Parameters:

tcd	A pointer to the TCD structure.
srcModulo	A source modulo value.
destModulo	A destination modulo value.

brief Sets the source modulo and the destination modulo for the eDMA TCD.

This function defines a specific address range specified to be the value after (SADDR + SOFF)/(DADDR + DOFF) calculation is performed or the original register value. It provides the ability to implement a circular data queue easily.

param tcd A pointer to the TCD structure. param srcModulo A source modulo value. param destModulo A destination modulo value.

Definition at line 568 of file fsl_edma.c.

Configures the eDMA TCD transfer attribute.

The TCD is a transfer control descriptor. The content of the TCD is the same as the hardware TCD registers. The STCD is used in the scatter-gather mode. This function configures the TCD transfer attribute, including source address, destination address, transfer size, address offset, and so on. It also configures the scatter gather feature if the user supplies the next TCD address. Example:

   edma_transfer_t config = {
   ...
   }
   edma_tcd_t tcd __aligned(32);
   edma_tcd_t nextTcd __aligned(32);
   EDMA_TcdSetTransferConfig(&tcd, &config, &nextTcd);

Parameters:

tcd	Pointer to the TCD structure.
config	Pointer to eDMA transfer configuration structure.
nextTcd	Pointer to the next TCD structure. It can be NULL if users do not want to enable scatter/gather feature.

Note:

TCD address should be 32 bytes aligned or it causes an eDMA error.

If the nextTcd is not NULL, the scatter gather feature is enabled and DREQ bit is cleared in the previous transfer configuration, which is set in the EDMA_TcdReset.

brief Configures the eDMA TCD transfer attribute.

The TCD is a transfer control descriptor. The content of the TCD is the same as the hardware TCD registers. The STCD is used in the scatter-gather mode. This function configures the TCD transfer attribute, including source address, destination address, transfer size, address offset, and so on. It also configures the scatter gather feature if the user supplies the next TCD address. Example: code edma_transfer_t config = { ... } edma_tcd_t tcd __aligned(32); edma_tcd_t nextTcd __aligned(32); EDMA_TcdSetTransferConfig(&tcd, &config, &nextTcd); endcode

param tcd Pointer to the TCD structure. param config Pointer to eDMA transfer configuration structure. param nextTcd Pointer to the next TCD structure. It can be NULL if users do not want to enable scatter/gather feature. note TCD address should be 32 bytes aligned or it causes an eDMA error. note If the nextTcd is not NULL, the scatter gather feature is enabled and DREQ bit is cleared in the previous transfer configuration, which is set in the EDMA_TcdReset.

Definition at line 439 of file fsl_edma.c.

Starts the eDMA transfer by using the software trigger.

This function starts a minor loop transfer.

Parameters:

base	eDMA peripheral base address.
channel	eDMA channel number.

Definition at line 684 of file fsl_edma.h.