EFR32 Blue Gecko 13 Software Documentation  efr32bg13-doc-5.1.2
DMADRV

Detailed Description

DMADRV Direct Memory Access Driver.


Introduction

The DMADRV driver makes it possible to write code using DMA which will work regardless of the type of DMA controller on the underlying microcontroller. It will also make it possible to use DMA in several modules, without the modules knowing of each others existence. The driver does not preclude use of the native emlib API of the underlying DMA controller, on the contrary, this will often result in more efficient code and is a necessity when doing complex DMA operations. The housekeeping functions of this driver will be valuable even in this use-case.

The source files for the DMA driver library resides in the emdrv/dmadrv folder, and are named dmadrv.c and dmadrv.h.

Note
DMA transfer completion callback functions are called from within the DMA interrupt handler.


Configuration Options

Some properties of the DMADRV driver are compile-time configurable. These properties are stored in a file named dmadrv_config.h. A template for this file, containing default values, resides in the emdrv/config folder. Currently the configuration options are:

Both configuration options will help reduce the drivers ram memory footprint.

To configure DMADRV, provide your own configuration file. Here is a sample dmadrv_config.h file:

#ifndef __SILICON_LABS_DMADRV_CONFIG_H__
#define __SILICON_LABS_DMADRV_CONFIG_H__

// DMADRV DMA interrupt priority configuration option.
// Set DMA interrupt priority. Range is 0..7, 0 is highest priority.
#define EMDRV_DMADRV_DMA_IRQ_PRIORITY 4

// DMADRV channel count configuration option.
// Number of DMA channels to support. A lower DMA channel count will reduce
// ram memory footprint.
#define EMDRV_DMADRV_DMA_CH_COUNT 4

// DMADRV native API configuration option.
// Use the native emlib api of the DMA controller, but still use DMADRV
// housekeeping functions as AllocateChannel/FreeChannel etc.
#define EMDRV_DMADRV_USE_NATIVE_API

#endif


The API

This section contain brief descriptions of the functions in the API. You will find detailed information on input and output parameters and return values by clicking on the hyperlinked function names. Most functions return an error code, ECODE_EMDRV_DMADRV_OK is returned on success, see ecode.h and dmadrv.h for other error codes.

Your application code must include one header file: dmadrv.h.

DMADRV_Init(), DMADRV_DeInit()
These functions initializes or deinitializes the DMADRV driver. Typically DMADRV_Init() is called once in your startup code.

DMADRV_AllocateChannel(), DMADRV_FreeChannel()
DMA channel reserve and release functions. It is recommended that application code check that DMADRV_AllocateChannel() returns ECODE_EMDRV_DMADRV_OK before starting a DMA transfer.

DMADRV_MemoryPeripheral()
Start a DMA transfer from memory to a peripheral.

DMADRV_PeripheralMemory()
Start a DMA transfer from a peripheral to memory.

DMADRV_MemoryPeripheralPingPong()
Start a DMA ping-pong transfer from memory to a peripheral.

DMADRV_PeripheralMemoryPingPong()
Start a DMA ping-pong transfer from a peripheral to memory.

DMADRV_LdmaStartTransfer()
Start a DMA transfer on a LDMA controller. This function can only be used when configuration option EMDRV_DMADRV_USE_NATIVE_API is defined. It is a wrapper around similar emlib ldma function, but adds support for completion callback and user defined callback function parameter.

DMADRV_StopTransfer()
Stop an ongoing DMA transfer.

DMADRV_TransferActive()
Check if a transfer is ongoing.

DMADRV_TransferCompletePending()
Check if a transfer completion is pending.

DMADRV_TransferDone()
Check if a transfer has completed.

DMADRV_TransferRemainingCount()
Get number of items remaining in a transfer.


Example

Transfer a text string to USART1.

#include "dmadrv.h"

char str[] = "Hello DMA !";
unsigned int channel;

int main( void )
{
  // Initialize DMA.
  DMADRV_Init();

  // Request a DMA channel.
  DMADRV_AllocateChannel( &channel, NULL );

  // Start the DMA transfer.
  DMADRV_MemoryPeripheral( channel,
                           dmadrvPeripheralSignal_USART1_TXBL,
                           (void*)&(USART1->TXDATA),
                           str,
                           true,
                           sizeof( str ),
                           dmadrvDataSize1,
                           NULL,
                           NULL );

  return 0;
}

Macros

#define DMADRV_MAX_XFER_COUNT   ((int)((_LDMA_CH_CTRL_XFERCNT_MASK >> _LDMA_CH_CTRL_XFERCNT_SHIFT) + 1))
 Maximum length of one DMA transfer.
 
#define ECODE_EMDRV_DMADRV_ALREADY_FREED   ( ECODE_EMDRV_DMADRV_BASE | 0x00000006 )
 DMA channel was free.
 
#define ECODE_EMDRV_DMADRV_ALREADY_INITIALIZED   ( ECODE_EMDRV_DMADRV_BASE | 0x00000003 )
 DMA has already been initialized.
 
#define ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED   ( ECODE_EMDRV_DMADRV_BASE | 0x00000007 )
 The channel is not reserved.
 
#define ECODE_EMDRV_DMADRV_CHANNELS_EXHAUSTED   ( ECODE_EMDRV_DMADRV_BASE | 0x00000004 )
 No DMA channels available.
 
#define ECODE_EMDRV_DMADRV_IN_USE   ( ECODE_EMDRV_DMADRV_BASE | 0x00000005 )
 DMA is in use.
 
#define ECODE_EMDRV_DMADRV_NOT_INITIALIZED   ( ECODE_EMDRV_DMADRV_BASE | 0x00000002 )
 DMA is not initialized.
 
#define ECODE_EMDRV_DMADRV_OK   ( ECODE_OK )
 Success return value.
 
#define ECODE_EMDRV_DMADRV_PARAM_ERROR   ( ECODE_EMDRV_DMADRV_BASE | 0x00000001 )
 Illegal input parameter.
 

Typedefs

typedef bool(* DMADRV_Callback_t) (unsigned int channel, unsigned int sequenceNo, void *userParam)
 DMADRV transfer completion callback function. More...
 

Enumerations

enum  DMADRV_DataSize_t {
  dmadrvDataSize1 = ldmaCtrlSizeByte,
  dmadrvDataSize2 = ldmaCtrlSizeHalf,
  dmadrvDataSize4 = ldmaCtrlSizeWord
}
 Data size of one LDMA transfer item. More...
 
enum  DMADRV_PeripheralSignal_t {
  dmadrvPeripheralSignal_NONE = LDMA_CH_REQSEL_SOURCESEL_NONE,
  dmadrvPeripheralSignal_ADC0_SCAN = LDMA_CH_REQSEL_SIGSEL_ADC0SCAN | LDMA_CH_REQSEL_SOURCESEL_ADC0,
  dmadrvPeripheralSignal_ADC0_SINGLE = LDMA_CH_REQSEL_SIGSEL_ADC0SINGLE | LDMA_CH_REQSEL_SOURCESEL_ADC0,
  dmadrvPeripheralSignal_CRYPTO0_DATA0RD = LDMA_CH_REQSEL_SIGSEL_CRYPTO0DATA0RD | LDMA_CH_REQSEL_SOURCESEL_CRYPTO0,
  dmadrvPeripheralSignal_CRYPTO0_DATA0WR = LDMA_CH_REQSEL_SIGSEL_CRYPTO0DATA0WR | LDMA_CH_REQSEL_SOURCESEL_CRYPTO0,
  dmadrvPeripheralSignal_CRYPTO0_DATA0XWR = LDMA_CH_REQSEL_SIGSEL_CRYPTO0DATA0XWR | LDMA_CH_REQSEL_SOURCESEL_CRYPTO0,
  dmadrvPeripheralSignal_CRYPTO0_DATA1RD = LDMA_CH_REQSEL_SIGSEL_CRYPTO0DATA1RD | LDMA_CH_REQSEL_SOURCESEL_CRYPTO0,
  dmadrvPeripheralSignal_CRYPTO0_DATA1WR = LDMA_CH_REQSEL_SIGSEL_CRYPTO0DATA1WR | LDMA_CH_REQSEL_SOURCESEL_CRYPTO0,
  dmadrvPeripheralSignal_CRYPTO1_DATA0RD = LDMA_CH_REQSEL_SIGSEL_CRYPTO1DATA0RD | LDMA_CH_REQSEL_SOURCESEL_CRYPTO1,
  dmadrvPeripheralSignal_CRYPTO1_DATA0WR = LDMA_CH_REQSEL_SIGSEL_CRYPTO1DATA0WR | LDMA_CH_REQSEL_SOURCESEL_CRYPTO1,
  dmadrvPeripheralSignal_CRYPTO1_DATA0XWR = LDMA_CH_REQSEL_SIGSEL_CRYPTO1DATA0XWR | LDMA_CH_REQSEL_SOURCESEL_CRYPTO1,
  dmadrvPeripheralSignal_CRYPTO1_DATA1RD = LDMA_CH_REQSEL_SIGSEL_CRYPTO1DATA1RD | LDMA_CH_REQSEL_SOURCESEL_CRYPTO1,
  dmadrvPeripheralSignal_CRYPTO1_DATA1WR = LDMA_CH_REQSEL_SIGSEL_CRYPTO1DATA1WR | LDMA_CH_REQSEL_SOURCESEL_CRYPTO1,
  dmadrvPeripheralSignal_I2C0_RXDATAV = LDMA_CH_REQSEL_SIGSEL_I2C0RXDATAV | LDMA_CH_REQSEL_SOURCESEL_I2C0,
  dmadrvPeripheralSignal_I2C0_TXBL = LDMA_CH_REQSEL_SIGSEL_I2C0TXBL | LDMA_CH_REQSEL_SOURCESEL_I2C0,
  dmadrvPeripheralSignal_LEUART0_RXDATAV = LDMA_CH_REQSEL_SIGSEL_LEUART0RXDATAV | LDMA_CH_REQSEL_SOURCESEL_LEUART0,
  dmadrvPeripheralSignal_LEUART0_TXBL = LDMA_CH_REQSEL_SIGSEL_LEUART0TXBL | LDMA_CH_REQSEL_SOURCESEL_LEUART0,
  dmadrvPeripheralSignal_LEUART0_TXEMPTY = LDMA_CH_REQSEL_SIGSEL_LEUART0TXEMPTY | LDMA_CH_REQSEL_SOURCESEL_LEUART0,
  dmadrvPeripheralSignal_MSC_WDATA = LDMA_CH_REQSEL_SIGSEL_MSCWDATA | LDMA_CH_REQSEL_SOURCESEL_MSC,
  dmadrvPeripheralSignal_PRS_REQ0 = LDMA_CH_REQSEL_SIGSEL_PRSREQ0 | LDMA_CH_REQSEL_SOURCESEL_PRS,
  dmadrvPeripheralSignal_PRS_REQ1 = LDMA_CH_REQSEL_SIGSEL_PRSREQ1 | LDMA_CH_REQSEL_SOURCESEL_PRS,
  dmadrvPeripheralSignal_TIMER0_CC0 = LDMA_CH_REQSEL_SIGSEL_TIMER0CC0 | LDMA_CH_REQSEL_SOURCESEL_TIMER0,
  dmadrvPeripheralSignal_TIMER0_CC1 = LDMA_CH_REQSEL_SIGSEL_TIMER0CC1 | LDMA_CH_REQSEL_SOURCESEL_TIMER0,
  dmadrvPeripheralSignal_TIMER0_CC2 = LDMA_CH_REQSEL_SIGSEL_TIMER0CC2 | LDMA_CH_REQSEL_SOURCESEL_TIMER0,
  dmadrvPeripheralSignal_TIMER0_UFOF = LDMA_CH_REQSEL_SIGSEL_TIMER0UFOF | LDMA_CH_REQSEL_SOURCESEL_TIMER0,
  dmadrvPeripheralSignal_TIMER1_CC0 = LDMA_CH_REQSEL_SIGSEL_TIMER1CC0 | LDMA_CH_REQSEL_SOURCESEL_TIMER1,
  dmadrvPeripheralSignal_TIMER1_CC1 = LDMA_CH_REQSEL_SIGSEL_TIMER1CC1 | LDMA_CH_REQSEL_SOURCESEL_TIMER1,
  dmadrvPeripheralSignal_TIMER1_CC2 = LDMA_CH_REQSEL_SIGSEL_TIMER1CC2 | LDMA_CH_REQSEL_SOURCESEL_TIMER1,
  dmadrvPeripheralSignal_TIMER1_CC3 = LDMA_CH_REQSEL_SIGSEL_TIMER1CC3 | LDMA_CH_REQSEL_SOURCESEL_TIMER1,
  dmadrvPeripheralSignal_TIMER1_UFOF = LDMA_CH_REQSEL_SIGSEL_TIMER1UFOF | LDMA_CH_REQSEL_SOURCESEL_TIMER1,
  dmadrvPeripheralSignal_USART0_RXDATAV = LDMA_CH_REQSEL_SIGSEL_USART0RXDATAV | LDMA_CH_REQSEL_SOURCESEL_USART0,
  dmadrvPeripheralSignal_USART0_TXBL = LDMA_CH_REQSEL_SIGSEL_USART0TXBL | LDMA_CH_REQSEL_SOURCESEL_USART0,
  dmadrvPeripheralSignal_USART0_TXEMPTY = LDMA_CH_REQSEL_SIGSEL_USART0TXEMPTY | LDMA_CH_REQSEL_SOURCESEL_USART0,
  dmadrvPeripheralSignal_USART1_RXDATAV = LDMA_CH_REQSEL_SIGSEL_USART1RXDATAV | LDMA_CH_REQSEL_SOURCESEL_USART1,
  dmadrvPeripheralSignal_USART1_RXDATAVRIGHT = LDMA_CH_REQSEL_SIGSEL_USART1RXDATAVRIGHT | LDMA_CH_REQSEL_SOURCESEL_USART1,
  dmadrvPeripheralSignal_USART1_TXBL = LDMA_CH_REQSEL_SIGSEL_USART1TXBL | LDMA_CH_REQSEL_SOURCESEL_USART1,
  dmadrvPeripheralSignal_USART1_TXBLRIGHT = LDMA_CH_REQSEL_SIGSEL_USART1TXBLRIGHT | LDMA_CH_REQSEL_SOURCESEL_USART1,
  dmadrvPeripheralSignal_USART1_TXEMPTY = LDMA_CH_REQSEL_SIGSEL_USART1TXEMPTY | LDMA_CH_REQSEL_SOURCESEL_USART1,
  dmadrvPeripheralSignal_USART2_RXDATAV = LDMA_CH_REQSEL_SIGSEL_USART2RXDATAV | LDMA_CH_REQSEL_SOURCESEL_USART2,
  dmadrvPeripheralSignal_USART2_TXBL = LDMA_CH_REQSEL_SIGSEL_USART2TXBL | LDMA_CH_REQSEL_SOURCESEL_USART2,
  dmadrvPeripheralSignal_USART2_TXEMPTY = LDMA_CH_REQSEL_SIGSEL_USART2TXEMPTY | LDMA_CH_REQSEL_SOURCESEL_USART2
}
 Peripherals that can trigger LDMA transfers. More...
 

Functions

Ecode_t DMADRV_AllocateChannel (unsigned int *channelId, void *capabilities)
 Allocate (reserve) a DMA channel. More...
 
Ecode_t DMADRV_DeInit (void)
 Deinitialize DMADRV. More...
 
Ecode_t DMADRV_FreeChannel (unsigned int channelId)
 Free an allocate (reserved) DMA channel. More...
 
Ecode_t DMADRV_Init (void)
 Initialize DMADRV. More...
 
Ecode_t DMADRV_LdmaStartTransfer (int channelId, LDMA_TransferCfg_t *transfer, LDMA_Descriptor_t *descriptor, DMADRV_Callback_t callback, void *cbUserParam)
 Start a LDMA transfer. More...
 
Ecode_t DMADRV_MemoryPeripheral (unsigned int channelId, DMADRV_PeripheralSignal_t peripheralSignal, void *dst, void *src, bool srcInc, int len, DMADRV_DataSize_t size, DMADRV_Callback_t callback, void *cbUserParam)
 Start a memory to peripheral DMA transfer. More...
 
Ecode_t DMADRV_MemoryPeripheralPingPong (unsigned int channelId, DMADRV_PeripheralSignal_t peripheralSignal, void *dst, void *src0, void *src1, bool srcInc, int len, DMADRV_DataSize_t size, DMADRV_Callback_t callback, void *cbUserParam)
 Start a memory to peripheral ping-pong DMA transfer. More...
 
Ecode_t DMADRV_PauseTransfer (unsigned int channelId)
 Pause an ongoing DMA transfer. More...
 
Ecode_t DMADRV_PeripheralMemory (unsigned int channelId, DMADRV_PeripheralSignal_t peripheralSignal, void *dst, void *src, bool dstInc, int len, DMADRV_DataSize_t size, DMADRV_Callback_t callback, void *cbUserParam)
 Start a peripheral to memory DMA transfer. More...
 
Ecode_t DMADRV_PeripheralMemoryPingPong (unsigned int channelId, DMADRV_PeripheralSignal_t peripheralSignal, void *dst0, void *dst1, void *src, bool dstInc, int len, DMADRV_DataSize_t size, DMADRV_Callback_t callback, void *cbUserParam)
 Start a peripheral to memory ping-pong DMA transfer. More...
 
Ecode_t DMADRV_ResumeTransfer (unsigned int channelId)
 Resume an ongoing DMA transfer. More...
 
Ecode_t DMADRV_StopTransfer (unsigned int channelId)
 Stop an ongoing DMA transfer. More...
 
Ecode_t DMADRV_TransferActive (unsigned int channelId, bool *active)
 Check if a transfer is running. More...
 
Ecode_t DMADRV_TransferCompletePending (unsigned int channelId, bool *pending)
 Check if a transfer complete is pending. More...
 
Ecode_t DMADRV_TransferDone (unsigned int channelId, bool *done)
 Check if a transfer has completed. More...
 
Ecode_t DMADRV_TransferRemainingCount (unsigned int channelId, int *remaining)
 Get number of items remaining in a transfer. More...
 

Typedef Documentation

typedef bool(* DMADRV_Callback_t) (unsigned int channel, unsigned int sequenceNo, void *userParam)

DMADRV transfer completion callback function.

The callback function is called when a transfer has completed.

Parameters
[in]channelThe DMA channel number.
[in]sequenceNoThe number of times the callback had been called. Useful on long chains of linked transfers or on endless ping-pong type transfers.
[in]userParamOptional user parameter supplied on DMA invocation.
Returns
When doing ping-pong transfers, return true to continue or false to stop transfers.

Definition at line 80 of file dmadrv.h.

Enumeration Type Documentation

Data size of one LDMA transfer item.

Enumerator
dmadrvDataSize1 

Byte.

dmadrvDataSize2 

Halfword.

dmadrvDataSize4 

Word.

Definition at line 508 of file dmadrv.h.

Peripherals that can trigger LDMA transfers.

Enumerator
dmadrvPeripheralSignal_NONE 

No peripheral selected for DMA triggering.

dmadrvPeripheralSignal_ADC0_SCAN 

Trig on ADC0_SCAN.

dmadrvPeripheralSignal_ADC0_SINGLE 

Trig on ADC0_SINGLE.

dmadrvPeripheralSignal_CRYPTO0_DATA0RD 

Trig on CRYPTO0_DATA0RD.

dmadrvPeripheralSignal_CRYPTO0_DATA0WR 

Trig on CRYPTO0_DATA0WR.

dmadrvPeripheralSignal_CRYPTO0_DATA0XWR 

Trig on CRYPTO0_DATA0XWR.

dmadrvPeripheralSignal_CRYPTO0_DATA1RD 

Trig on CRYPTO0_DATA1RD.

dmadrvPeripheralSignal_CRYPTO0_DATA1WR 

Trig on CRYPTO0_DATA1WR.

dmadrvPeripheralSignal_CRYPTO1_DATA0RD 

Trig on CRYPTO1_DATA0RD.

dmadrvPeripheralSignal_CRYPTO1_DATA0WR 

Trig on CRYPTO1_DATA0WR.

dmadrvPeripheralSignal_CRYPTO1_DATA0XWR 

Trig on CRYPTO1_DATA0XWR.

dmadrvPeripheralSignal_CRYPTO1_DATA1RD 

Trig on CRYPTO1_DATA1RD.

dmadrvPeripheralSignal_CRYPTO1_DATA1WR 

Trig on CRYPTO1_DATA1WR.

dmadrvPeripheralSignal_I2C0_RXDATAV 

Trig on I2C0_RXDATAV.

dmadrvPeripheralSignal_I2C0_TXBL 

Trig on I2C0_TXBL.

dmadrvPeripheralSignal_LEUART0_RXDATAV 

Trig on LEUART0_RXDATAV.

dmadrvPeripheralSignal_LEUART0_TXBL 

Trig on LEUART0_TXBL.

dmadrvPeripheralSignal_LEUART0_TXEMPTY 

Trig on LEUART0_TXEMPTY.

dmadrvPeripheralSignal_MSC_WDATA 

Trig on MSC_WDATA.

dmadrvPeripheralSignal_PRS_REQ0 

Trig on PRS_REQ0.

dmadrvPeripheralSignal_PRS_REQ1 

Trig on PRS_REQ1.

dmadrvPeripheralSignal_TIMER0_CC0 

Trig on TIMER0_CC0.

dmadrvPeripheralSignal_TIMER0_CC1 

Trig on TIMER0_CC1.

dmadrvPeripheralSignal_TIMER0_CC2 

Trig on TIMER0_CC2.

dmadrvPeripheralSignal_TIMER0_UFOF 

Trig on TIMER0_UFOF.

dmadrvPeripheralSignal_TIMER1_CC0 

Trig on TIMER1_CC0.

dmadrvPeripheralSignal_TIMER1_CC1 

Trig on TIMER1_CC1.

dmadrvPeripheralSignal_TIMER1_CC2 

Trig on TIMER1_CC2.

dmadrvPeripheralSignal_TIMER1_CC3 

Trig on TIMER1_CC3.

dmadrvPeripheralSignal_TIMER1_UFOF 

Trig on TIMER1_UFOF.

dmadrvPeripheralSignal_USART0_RXDATAV 

Trig on USART0_RXDATAV.

dmadrvPeripheralSignal_USART0_TXBL 

Trig on USART0_TXBL.

dmadrvPeripheralSignal_USART0_TXEMPTY 

Trig on USART0_TXEMPTY.

dmadrvPeripheralSignal_USART1_RXDATAV 

Trig on USART1_RXDATAV.

dmadrvPeripheralSignal_USART1_RXDATAVRIGHT 

Trig on USART1_RXDATAVRIGHT.

dmadrvPeripheralSignal_USART1_TXBL 

Trig on USART1_TXBL.

dmadrvPeripheralSignal_USART1_TXBLRIGHT 

Trig on USART1_TXBLRIGHT.

dmadrvPeripheralSignal_USART1_TXEMPTY 

Trig on USART1_TXEMPTY.

dmadrvPeripheralSignal_USART2_RXDATAV 

Trig on USART2_RXDATAV.

dmadrvPeripheralSignal_USART2_TXBL 

Trig on USART2_TXBL.

dmadrvPeripheralSignal_USART2_TXEMPTY 

Trig on USART2_TXEMPTY.

Definition at line 314 of file dmadrv.h.

Function Documentation

Ecode_t DMADRV_AllocateChannel ( unsigned int *  channelId,
void *  capabilities 
)

Allocate (reserve) a DMA channel.

Parameters
[out]channelIdThe channel Id assigned by DMADRV.
[in]capabilitiesNot used.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 131 of file dmadrv.c.

References CORE_DECLARE_IRQ_STATE, CORE_ENTER_ATOMIC, CORE_EXIT_ATOMIC, ECODE_EMDRV_DMADRV_CHANNELS_EXHAUSTED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, and initialized.

Referenced by MIC_init(), and SPIDRV_Init().

Ecode_t DMADRV_DeInit ( void  )

Deinitialize DMADRV.

If no DMA channels are currently allocated, it will disable DMA hardware and mask associated interrupts.

Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 177 of file dmadrv.c.

References CMU_ClockEnable(), CORE_DECLARE_IRQ_STATE, CORE_ENTER_ATOMIC, CORE_EXIT_ATOMIC, ECODE_EMDRV_DMADRV_IN_USE, ECODE_EMDRV_DMADRV_OK, initialized, and LDMA_DeInit().

Referenced by SPIDRV_DeInit(), and UARTDRV_DeInit().

Ecode_t DMADRV_FreeChannel ( unsigned int  channelId)

Free an allocate (reserved) DMA channel.

Parameters
[in]channelIdThe channel Id to free.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 225 of file dmadrv.c.

References CORE_DECLARE_IRQ_STATE, CORE_ENTER_ATOMIC, CORE_EXIT_ATOMIC, ECODE_EMDRV_DMADRV_ALREADY_FREED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, and initialized.

Referenced by MIC_deInit(), SPIDRV_DeInit(), and UARTDRV_DeInit().

Ecode_t DMADRV_LdmaStartTransfer ( int  channelId,
LDMA_TransferCfg_t transfer,
LDMA_Descriptor_t descriptor,
DMADRV_Callback_t  callback,
void *  cbUserParam 
)

Start a LDMA transfer.

This function can only be used on LDMA when EMDRV_DMADRV_USE_NATIVE_API is defined. It is a wrapper around similar emlib ldma function.

Parameters
[in]channelIdThe channel Id to use.
[in]transferDMA transfer configuration data structure.
[in]descriptorDMA transfer descriptor, can be an array of descriptors linked together.
[in]callbackOptional callback function for signalling completion. May be NULL if not needed.
[in]cbUserParamOptional user parameter to feed to the callback function. May be NULL if not needed.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 335 of file dmadrv.c.

References ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA_StartTransfer().

Ecode_t DMADRV_MemoryPeripheral ( unsigned int  channelId,
DMADRV_PeripheralSignal_t  peripheralSignal,
void *  dst,
void *  src,
bool  srcInc,
int  len,
DMADRV_DataSize_t  size,
DMADRV_Callback_t  callback,
void *  cbUserParam 
)

Start a memory to peripheral DMA transfer.

Parameters
[in]channelIdNot used
[in]peripheralSignalSelects which peripheral/peripheralsignal to use.
[in]dstDestination (peripheral register) memory address.
[in]srcSource memory address.
[in]srcIncSet to true to enable source address increment (increment is according to size parameter).
[in]lenNumber if items (of size size) to transfer.
[in]sizeItem size, byte, halfword or word.
[in]callbackFunction to call on dma completion, use NULL if not needed.
[in]cbUserParamOptional user parameter to feed to the callback function. Use NULL if not needed.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 406 of file dmadrv.c.

Ecode_t DMADRV_MemoryPeripheralPingPong ( unsigned int  channelId,
DMADRV_PeripheralSignal_t  peripheralSignal,
void *  dst,
void *  src0,
void *  src1,
bool  srcInc,
int  len,
DMADRV_DataSize_t  size,
DMADRV_Callback_t  callback,
void *  cbUserParam 
)

Start a memory to peripheral ping-pong DMA transfer.

Parameters
[in]channelIdNot used
[in]peripheralSignalSelects which peripheral/peripheralsignal to use.
[in]dstDestination (peripheral register) memory address.
[in]src0Source memory address of first (ping) buffer.
[in]src1Source memory address of second (pong) buffer.
[in]srcIncSet to true to enable source address increment (increment is according to size parameter).
[in]lenNumber if items (of size size) to transfer.
[in]sizeItem size, byte, halfword or word.
[in]callbackFunction to call on dma completion, use NULL if not needed.
[in]cbUserParamOptional user parameter to feed to the callback function. Use NULL if not needed.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 473 of file dmadrv.c.

Ecode_t DMADRV_PauseTransfer ( unsigned int  channelId)

Pause an ongoing DMA transfer.

Parameters
[in]channelIdThe channel Id of the transfer to pause.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 645 of file dmadrv.c.

References ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA_EnableChannelRequest().

Referenced by UARTDRV_PauseTransmit().

Ecode_t DMADRV_PeripheralMemory ( unsigned int  channelId,
DMADRV_PeripheralSignal_t  peripheralSignal,
void *  dst,
void *  src,
bool  dstInc,
int  len,
DMADRV_DataSize_t  size,
DMADRV_Callback_t  callback,
void *  cbUserParam 
)

Start a peripheral to memory DMA transfer.

Parameters
[in]channelIdNot used
[in]peripheralSignalSelects which peripheral/peripheralsignal to use.
[in]dstDestination memory address.
[in]srcSource memory (peripheral register) address.
[in]dstIncSet to true to enable destination address increment (increment is according to size parameter).
[in]lenNumber if items (of size size) to transfer.
[in]sizeItem size, byte, halfword or word.
[in]callbackFunction to call on dma completion, use NULL if not needed.
[in]cbUserParamOptional user parameter to feed to the callback function. Use NULL if not needed.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 539 of file dmadrv.c.

Referenced by MIC_start().

Ecode_t DMADRV_PeripheralMemoryPingPong ( unsigned int  channelId,
DMADRV_PeripheralSignal_t  peripheralSignal,
void *  dst0,
void *  dst1,
void *  src,
bool  dstInc,
int  len,
DMADRV_DataSize_t  size,
DMADRV_Callback_t  callback,
void *  cbUserParam 
)

Start a peripheral to memory ping-pong DMA transfer.

Parameters
[in]channelIdNot used
[in]peripheralSignalSelects which peripheral/peripheralsignal to use.
[in]dst0Destination memory address of first (ping) buffer.
[in]dst1Destination memory address of second (pong) buffer.
[in]srcSource memory (peripheral register) address.
[in]dstIncSet to true to enable destination address increment (increment is according to size parameter).
[in]lenNumber if items (of size size) to transfer.
[in]sizeItem size, byte, halfword or word.
[in]callbackFunction to call on dma completion, use NULL if not needed.
[in]cbUserParamOptional user parameter to feed to the callback function. Use NULL if not needed.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 606 of file dmadrv.c.

Ecode_t DMADRV_ResumeTransfer ( unsigned int  channelId)

Resume an ongoing DMA transfer.

Parameters
[in]channelIdThe channel Id of the transfer to resume.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 682 of file dmadrv.c.

References ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA_EnableChannelRequest().

Referenced by UARTDRV_ResumeTransmit().

Ecode_t DMADRV_StopTransfer ( unsigned int  channelId)

Stop an ongoing DMA transfer.

Parameters
[in]channelIdThe channel Id of the transfer to stop.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 719 of file dmadrv.c.

References ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA_StopTransfer().

Referenced by SPIDRV_AbortTransfer(), SPIDRV_DeInit(), and UARTDRV_Abort().

Ecode_t DMADRV_TransferActive ( unsigned int  channelId,
bool *  active 
)

Check if a transfer is running.

Parameters
[in]channelIdThe channel Id of the transfer to check.
[out]activeTrue if transfer is running, false otherwise.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 759 of file dmadrv.c.

References ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA.

Referenced by UARTDRV_PauseTransmit(), and UARTDRV_ResumeTransmit().

Ecode_t DMADRV_TransferCompletePending ( unsigned int  channelId,
bool *  pending 
)

Check if a transfer complete is pending.

Will check channel interrupt flag. This assumes that the DMA is configured to giva a completion interrupt.

Parameters
[in]channelIdThe channel Id of the transfer to check.
[out]pendingTrue if a transfer complete is pending, false otherwise.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 811 of file dmadrv.c.

References ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA.

Ecode_t DMADRV_TransferDone ( unsigned int  channelId,
bool *  done 
)

Check if a transfer has completed.

Note
This function is meant to be used in a polled environment. Will only work reliable for transfers NOT using completion interrupt. On UDMA it will only work on basic transfers on primary channel.
Parameters
[in]channelIdThe channel Id of the transfer to check.
[out]doneTrue if a transfer has completed, false otherwise.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 864 of file dmadrv.c.

References CORE_ATOMIC_SECTION, ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA_TransferDone().

Ecode_t DMADRV_TransferRemainingCount ( unsigned int  channelId,
int *  remaining 
)

Get number of items remaining in a transfer.

Note
This function is does not take into account that a DMA transfers with a chain of linked transfers might be ongoing. It will only check the count for the current transfer. On UDMA it will only work on the primary channel.
Parameters
[in]channelIdThe channel Id of the transfer to check.
[out]remainingNumber of items remaining in the transfer.
Returns
ECODE_EMDRV_DMADRV_OK on success. On failure an appropriate DMADRV Ecode_t is returned.

Definition at line 930 of file dmadrv.c.

References CORE_ATOMIC_SECTION, ECODE_EMDRV_DMADRV_CH_NOT_ALLOCATED, ECODE_EMDRV_DMADRV_NOT_INITIALIZED, ECODE_EMDRV_DMADRV_OK, ECODE_EMDRV_DMADRV_PARAM_ERROR, initialized, and LDMA_TransferRemainingCount().

Referenced by SPIDRV_AbortTransfer(), UARTDRV_Abort(), UARTDRV_GetReceiveStatus(), and UARTDRV_GetTransmitStatus().