Zoltan Hudak / MODDMA

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

MODDMA Class Reference
Public Types | Public Member Functions | Data Fields

MODDMA Class Reference

MODDMA GPDMA Controller. More...

#include <MODDMA.h>

Public Types

enum  CHANNELS {
  Channel_0 = 0, Channel_1, Channel_2, Channel_3,
  Channel_4, Channel_5, Channel_6, Channel_7
}
 

Channel definitions.

More...
enum  IrqType_t { TcIrq = 0, ErrIrq }
 

Interrupt callback types.

More...
enum  Status { Ok = 0, Error = -1, ErrChInUse = -2 }
 

Return status codes.

More...
enum  GPDMA_CONNECTION {
  SSP0_Tx = 0UL, SSP0_Rx = 1UL, SSP1_Tx = 2UL, SSP1_Rx = 3UL,
  ADC = 4UL, I2S_Channel_0 = 5UL, I2S_Channel_1 = 6UL, DAC = 7UL,
  UART0_Tx = 8UL, UART0_Rx = 9UL, UART1_Tx = 10UL, UART1_Rx = 11UL,
  UART2_Tx = 12UL, UART2_Rx = 13UL, UART3_Tx = 14UL, UART3_Rx = 15UL,
  MAT0_0 = 16UL, MAT0_1 = 17UL, MAT1_0 = 18UL, MAT1_1 = 19UL,
  MAT2_0 = 20UL, MAT2_1 = 21UL, MAT3_0 = 22UL, MAT3_1 = 23UL
}
 

DMA Connection number definitions.

More...
enum  GPDMA_TRANSFERTYPE {
  m2m = 0UL, m2p = 1UL, p2m = 2UL, p2p = 3UL,
  g2m = 4UL, m2g = 5UL
}
 

GPDMA Transfer type definitions.

More...
enum  GPDMA_BSIZE {
  _1 = 0UL, _4 = 1UL, _8 = 2UL, _16 = 3UL,
  _32 = 4UL, _64 = 5UL, _128 = 6UL, _256 = 7UL
}
 

Burst size in Source and Destination definitions */.

More...
enum  GPDMA_WIDTH { byte = 0UL, halfword = 1UL, word = 2UL }
 

Width in Src transfer width and Dest transfer width definitions */.

More...
enum  GPDMA_REQSEL { uart = 0UL, timer = 1UL }
 

DMA Request Select Mode definitions. */.

More...
enum  Config { _E = 1, _M = 2 }
 

GPDMA Control register bits.

More...
enum  CConfig {
  _CE = (1UL << 0), _IE = (1UL << 14), _ITC = (1UL << 15), _Lck = (1UL << 16),
  _A = (1UL << 17), _H = (1UL << 18)
}
 

GPDMA Channel config register bits.

More...

Public Member Functions

 MODDMA ()
 The MODDMA constructor is used to initialise the DMA controller object.
 ~MODDMA ()
 The MODDMA destructor.
void init (bool isConstructorCalling, int Channels=0xFF, int Tc=0xFF, int Err=0xFF)
 Used to setup the DMA controller to prepare for a data transfer.
uint32_t Prepare (MODDMA_Config *c)
 Used to setup and enable the DMA controller.
uint32_t Setup (MODDMA_Config *c)
 Used to setup the DMA controller to prepare for a data transfer.
void Enable (CHANNELS ChannelNumber)
 Enable and begin data transfer.
void Enable (uint32_t ChannelNumber)
 Enable and begin data transfer (overloaded function)
void Enable (MODDMA_Config *config)
 Enable and begin data transfer (overloaded function)
void Disable (CHANNELS ChannelNumber)
 Disable a channel and end data transfer.
void Disable (uint32_t ChannelNumber)
 Disable a channel and end data transfer (overloaded function)
bool Enabled (CHANNELS ChannelNumber)
 Is the specified channel enabled?
bool Enabled (uint32_t ChannelNumber)
 Is the specified channel enabled? (overloaded function)
MODDMA_Config * getConfig (void)
 Get a pointer to the current configuration the ISR is servicing.
void setIrqProcessingChannel (CHANNELS n)
 Set which channel the ISR is currently servicing.
CHANNELS irqProcessingChannel (void)
 Gets which channel the ISR is currently servicing.
void setIrqType (IrqType_t n)
 Sets which type of IRQ the ISR is making a callback for.
IrqType_t irqType (void)
 Get which type of IRQ the ISR is calling you about, terminal count or error.
void clearTcIrq (CHANNELS n)
 Clear the interrupt after handling.
void clearTcIrq (void)
 Clear the interrupt the ISR is currently handing.
void clearErrIrq (CHANNELS n)
 Clear the error interrupt after handling.
void clearErrIrq (void)
 Clear the error interrupt the ISR is currently handing.
bool isActive (CHANNELS ChannelNumber)
 Is the supplied channel currently active?
void haltChannel (CHANNELS ChannelNumber)
 Halt the supplied channel.
uint32_t getControl (CHANNELS ChannelNumber)
 get a channels control register.
void haltAndWaitChannelComplete (CHANNELS n)
 Wait for channel transfer to complete and then halt.
void attach_tc (void(*fptr)(void))
 Attach a callback to the TC IRQ controller.
template<typename T >
void attach_tc (T *tptr, void(T::*mptr)(void))
 Attach a callback to the TC IRQ controller.
void attach_err (void(*fptr)(void))
 Attach a callback to the ERR IRQ controller.
template<typename T >
void attach_err (T *tptr, void(T::*mptr)(void))
 Attach a callback to the ERR IRQ controller.
uint32_t lli (CHANNELS ChannelNumber, MODDMA_LLI *set=0)
 Get the Linked List index regsiter for the requested channel.

Data Fields

MODDMA_Config * setups [8]
 A store for up to 8 (8 channels) of configurations.
Callback< void()> isrIntTCStat
 The MODDMA controllers terminal count interrupt callback.
Callback< void()> isrIntErrStat
 The MODDMA controllers error interrupt callback.

Detailed Description

MODDMA GPDMA Controller.

Author:
Andy Kirkham
See also:
http://mbed.org/cookbook/MODDMA
example1.cpp
The MODDMA API

MODDMA defines a GPDMA controller and multiple DMA configurations that allow for DMA transfers from memory to memory, memory to peripheral or peripheral to memory.

At the heart of the library is the MODDMA class that defines a single instance controller that manages all the GPDMA hardware registers and interrupts. The controller can accept multiple configurations that define the channel transfers. Each configuration specifies the source and destination information and other associated parts to maintain the transfer process.

Standard example: 

 #include "mbed.h"
 #include "MODDMA.h"

 DigitalOut myled(LED1);
 DigitalOut led2(LED2);
 MODDMA dma;

 int transferState = 0;

 void myCallback(void) {
     if (transferState == 0) {
         led2 = 1;
         transferState = 1;
     }
 }

 int main() {
     printf("Hello World\r\n");

     // Create a source buffer we are going to move.
     char src[] = "TEST TEST TEST";

     // Create a buffer for the destination to copy to.
     char dst[sizeof(src)];

     // Create a MODDMA configuration object.
     MODDMA_Config *config = new MODDMA_Config;

     // Setup that configuration
     config
      ->channelNum    ( MODDMA::Channel_0  )
      ->srcMemAddr    ( (uint32_t) &src )
      ->dstMemAddr    ( (uint32_t) &dst )
      ->transferSize  ( sizeof(src) )
      ->transferType  ( MODDMA::m2m  )
      ->attach_tc     ( &myCallback )
     ; // config end

     // Pass the configuration to the controller
     dma.Setup( config );

     // Tell the controller to perform the DMA operation
     // defined by that configuration.
     dma.Enable ( config );

     while(1) {
         if (transferState == 1) {
             transferState = 2;
             printf("%s\r\n", dst);
         }
         myled = 1;
         ThisThread::sleep_for(250ms);
         myled = 0;
         ThisThread::sleep_for(250ms);
     }
 }

Definition at line 267 of file MODDMA.h.

Member Enumeration Documentation

enum CConfig

GPDMA Channel config register bits.

Enumerator:
_CE 

Channel enable

_IE 

Interrupt error mask

_ITC 

Terminal count interrupt mask

_Lck 

Lock

_A 

Active

_H 

Halt

Definition at line 366 of file MODDMA.h.

enum CHANNELS

Channel definitions.

Enumerator:
Channel_0 

Channel 0

Channel_1 

Channel 1

Channel_2 

Channel 2

Channel_3 

Channel 3

Channel_4 

Channel 4

Channel_5 

Channel 5

Channel_6 

Channel 6

Channel_7 

Channel 7

Definition at line 272 of file MODDMA.h.

enum Config

GPDMA Control register bits.

Enumerator:
_E 

DMA Controller enable

_M 

AHB Master endianness configuration

Definition at line 360 of file MODDMA.h.

enum GPDMA_BSIZE

Burst size in Source and Destination definitions */.

Enumerator:
_1 

Burst size = 1

_4 

Burst size = 4

_8 

Burst size = 8

_16 

Burst size = 16

_32 

Burst size = 32

_64 

Burst size = 64

_128 

Burst size = 128

_256 

Burst size = 256

Definition at line 335 of file MODDMA.h.

enum GPDMA_CONNECTION

DMA Connection number definitions.

Enumerator:
SSP0_Tx 

SSP0 Tx

SSP0_Rx 

SSP0 Rx

SSP1_Tx 

SSP1 Tx

SSP1_Rx 

SSP1 Rx

ADC 

ADC

I2S_Channel_0 

I2S channel 0

I2S_Channel_1 

I2S channel 1

DAC 

DAC

UART0_Tx 

UART0 Tx

UART0_Rx 

UART0 Rx

UART1_Tx 

UART1 Tx

UART1_Rx 

UART1 Rx

UART2_Tx 

UART2 Tx

UART2_Rx 

UART2 Rx

UART3_Tx 

UART3 Tx

UART3_Rx 

UART3 Rx

MAT0_0 

MAT0.0

MAT0_1 

MAT0.1

MAT1_0 

MAT1.0

MAT1_1 

MAT1.1

MAT2_0 

MAT2.0.

MAT2_1 

MAT2.1

MAT3_0 

MAT3.0

MAT3_1 

MAT3.1

Definition at line 297 of file MODDMA.h.

enum GPDMA_REQSEL

DMA Request Select Mode definitions. */.

Enumerator:
uart 

UART TX/RX is selected

timer 

Timer match is selected

Definition at line 354 of file MODDMA.h.

enum GPDMA_TRANSFERTYPE

GPDMA Transfer type definitions.

Enumerator:
m2m 

Memory to memory - DMA control

m2p 

Memory to peripheral - DMA control

p2m 

Peripheral to memory - DMA control

p2p 

Src peripheral to dest peripheral - DMA control

g2m 

Pseudo special case for reading "peripheral GPIO" that's memory mapped.

m2g 

Pseudo special case for writing "peripheral GPIO" that's memory mapped.

Definition at line 325 of file MODDMA.h.

enum GPDMA_WIDTH

Width in Src transfer width and Dest transfer width definitions */.

Enumerator:
byte 

Width = 1 byte

halfword 

Width = 2 bytes

word 

Width = 4 bytes

Definition at line 347 of file MODDMA.h.

enum IrqType_t

Interrupt callback types.

Enumerator:
TcIrq 

Terminal Count interrupt

ErrIrq 

Error interrupt

Definition at line 284 of file MODDMA.h.

enum Status

Return status codes.

Enumerator:
Ok 

Ok, suceeded

Error 

General error

ErrChInUse 

Specific error, channel in use

Definition at line 290 of file MODDMA.h.

Constructor & Destructor Documentation

MODDMA (  )

The MODDMA constructor is used to initialise the DMA controller object.

Definition at line 378 of file MODDMA.h.

~MODDMA (  )

The MODDMA destructor.

Definition at line 383 of file MODDMA.h.

Member Function Documentation

void clearTcIrq ( CHANNELS  n )

Clear the interrupt after handling.

Parameters:
CHANNELSThe channel the IQR occured on.

Definition at line 562 of file MODDMA.h.

void clearTcIrq ( void   )

Clear the interrupt the ISR is currently handing.

Definition at line 567 of file MODDMA.h.

IrqType_t irqType ( void   )

Get which type of IRQ the ISR is calling you about, terminal count or error.

Definition at line 555 of file MODDMA.h.

uint32_t lli ( CHANNELS  ChannelNumber,
MODDMA_LLI *  set = 0 
)

Get the Linked List index regsiter for the requested channel.

Parameters:
channelNumThe channel number.
Returns:
uint32_t The value of the DMACCLLI register

Definition at line 679 of file MODDMA.h.

void setIrqProcessingChannel ( CHANNELS  n )

Set which channel the ISR is currently servicing.

*** USED INTERNALLY. DO NOT CALL FROM USER PROGRAMS ***

Must be public so the extern "C" ISR can use it.

Definition at line 532 of file MODDMA.h.

void setIrqType ( IrqType_t  n )

Sets which type of IRQ the ISR is making a callback for.

*** USED INTERNALLY. DO NOT CALL FROM USER PROGRAMS ***

Must be public so the extern "C" ISR can use it.

Definition at line 549 of file MODDMA.h.

Field Documentation

Callback<void()> isrIntErrStat

The MODDMA controllers error interrupt callback.

Definition at line 688 of file MODDMA.h.

Callback<void()> isrIntTCStat

The MODDMA controllers terminal count interrupt callback.

Definition at line 645 of file MODDMA.h.

MODDMA_Config* setups[8]

A store for up to 8 (8 channels) of configurations.

See also:
MODDMA_Config

Definition at line 515 of file MODDMA.h.

Generated on Mon Dec 12 2022 15:08:43 by  doxygen 1.7.2