MCUXpresso SDK API Reference Manual  Rev. 0
NXP Semiconductors
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
DMAMUX: Direct Memory Access Multiplexer Driver

Overview

The MCUXpresso SDK provides a peripheral driver for the Direct Memory Access Multiplexer (DMAMUX) of MCUXpresso SDK devices.

Typical use case

DMAMUX Operation

Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/dmamux

Driver version

#define FSL_DMAMUX_DRIVER_VERSION   (MAKE_VERSION(2, 0, 4))
 DMAMUX driver version 2.0.4. More...
 

DMAMUX Initialization and de-initialization

void DMAMUX_Init (DMAMUX_Type *base)
 Initializes the DMAMUX peripheral. More...
 
void DMAMUX_Deinit (DMAMUX_Type *base)
 Deinitializes the DMAMUX peripheral. More...
 

DMAMUX Channel Operation

static void DMAMUX_EnableChannel (DMAMUX_Type *base, uint32_t channel)
 Enables the DMAMUX channel. More...
 
static void DMAMUX_DisableChannel (DMAMUX_Type *base, uint32_t channel)
 Disables the DMAMUX channel. More...
 
static void DMAMUX_SetSource (DMAMUX_Type *base, uint32_t channel, uint32_t source)
 Configures the DMAMUX channel source. More...
 
static void DMAMUX_EnablePeriodTrigger (DMAMUX_Type *base, uint32_t channel)
 Enables the DMAMUX period trigger. More...
 
static void DMAMUX_DisablePeriodTrigger (DMAMUX_Type *base, uint32_t channel)
 Disables the DMAMUX period trigger. More...
 
static void DMAMUX_EnableAlwaysOn (DMAMUX_Type *base, uint32_t channel, bool enable)
 Enables the DMA channel to be always ON. More...
 

Macro Definition Documentation

#define FSL_DMAMUX_DRIVER_VERSION   (MAKE_VERSION(2, 0, 4))

Function Documentation

void DMAMUX_Init ( DMAMUX_Type *  base)

This function ungates the DMAMUX clock.

Parameters
baseDMAMUX peripheral base address.
void DMAMUX_Deinit ( DMAMUX_Type *  base)

This function gates the DMAMUX clock.

Parameters
baseDMAMUX peripheral base address.
static void DMAMUX_EnableChannel ( DMAMUX_Type *  base,
uint32_t  channel 
)
inlinestatic

This function enables the DMAMUX channel.

Parameters
baseDMAMUX peripheral base address.
channelDMAMUX channel number.
static void DMAMUX_DisableChannel ( DMAMUX_Type *  base,
uint32_t  channel 
)
inlinestatic

This function disables the DMAMUX channel.

Note
The user must disable the DMAMUX channel before configuring it.
Parameters
baseDMAMUX peripheral base address.
channelDMAMUX channel number.
static void DMAMUX_SetSource ( DMAMUX_Type *  base,
uint32_t  channel,
uint32_t  source 
)
inlinestatic
Parameters
baseDMAMUX peripheral base address.
channelDMAMUX channel number.
sourceChannel source, which is used to trigger the DMA transfer.
static void DMAMUX_EnablePeriodTrigger ( DMAMUX_Type *  base,
uint32_t  channel 
)
inlinestatic

This function enables the DMAMUX period trigger feature.

Parameters
baseDMAMUX peripheral base address.
channelDMAMUX channel number.
static void DMAMUX_DisablePeriodTrigger ( DMAMUX_Type *  base,
uint32_t  channel 
)
inlinestatic

This function disables the DMAMUX period trigger.

Parameters
baseDMAMUX peripheral base address.
channelDMAMUX channel number.
static void DMAMUX_EnableAlwaysOn ( DMAMUX_Type *  base,
uint32_t  channel,
bool  enable 
)
inlinestatic

This function enables the DMAMUX channel always ON feature.

Parameters
baseDMAMUX peripheral base address.
channelDMAMUX channel number.
enableSwitcher of the always ON feature. "true" means enabled, "false" means disabled.