#include <modm/platform/dma/dma.hpp>

Inheritance diagram for modm::platform::DmaController< ID >::Channel:

Classes
struct	RequestMapping

Public Typedefs
using	IrqHandler = void (*)(void)

Public Types
enum	Channel { Stream0 = 0, Stream1, Stream2, Stream3, Stream4, Stream5, Stream6, Stream7, Channel0 = Stream0, Channel1 = Stream1, Channel2 = Stream2, Channel3 = Stream3, Channel4 = Stream4, Channel5 = Stream5, Channel6 = Stream6, Channel7 = Stream7 }

enum	CircularMode : uint32_t { Disabled = 0, CircularMode::Enabled = DMA_SxCR_CIRC }

enum	DataTransferDirection : uint32_t { DataTransferDirection::PeripheralToMemory = 0, DataTransferDirection::MemoryToPeripheral = DMA_SxCR_DIR_0, DataTransferDirection::MemoryToMemory = DMA_SxCR_DIR_1 }

enum	InterruptEnable : uint32_t { DirectModeError = DMA_SxCR_DMEIE, TransferError = DMA_SxCR_TEIE, HalfTransfer = DMA_SxCR_HTIE, TransferComplete = DMA_SxCR_TCIE }

enum	InterruptFlags : uint8_t { FifoError = 0b00'0001, DirectModeError = 0b00'0100, Error = 0b00'1000, HalfTransferComplete = 0b01'0000, TransferComplete = 0b10'0000, All = 0b11'1101, Global = All }

enum	MemoryDataSize : uint32_t { Byte = 0, Bit8 = Byte, HalfWord = DMA_SxCR_MSIZE_0, Bit16 = HalfWord, Word = DMA_SxCR_MSIZE_1, Bit32 = Word }

enum	MemoryIncrementMode : uint32_t { Fixed = 0, MemoryIncrementMode::Increment = DMA_SxCR_MINC }

enum	PeripheralDataSize : uint32_t { Byte = 0, Bit8 = Byte, HalfWord = DMA_SxCR_PSIZE_0, Bit16 = HalfWord, Word = DMA_SxCR_PSIZE_1, Bit32 = Word }

enum	PeripheralIncrementMode : uint32_t { Fixed = 0, PeripheralIncrementMode::Increment = DMA_SxCR_PINC }

enum	Priority : uint32_t { Low = 0, Medium = DMA_SxCR_PL_0, High = DMA_SxCR_PL_1, VeryHigh = DMA_SxCR_PL_1 \| DMA_SxCR_PL_0 }

enum	Request : uint32_t { Channel0 = (0 << DMA_SxCR_CHSEL_Pos), Channel1 = (1 << DMA_SxCR_CHSEL_Pos), Channel2 = (2 << DMA_SxCR_CHSEL_Pos), Channel3 = (3 << DMA_SxCR_CHSEL_Pos), Channel4 = (4 << DMA_SxCR_CHSEL_Pos), Channel5 = (5 << DMA_SxCR_CHSEL_Pos), Channel6 = (6 << DMA_SxCR_CHSEL_Pos), Channel7 = (7 << DMA_SxCR_CHSEL_Pos) }

enum	Signal : uint8_t { NoSignal, Ch1, Ch2, Ch3, Ch4, Com, Dac1, Dac2, Ext_rx, Ext_tx, Rx, Trig, Tx, Up }

Public Member Functions
	MODM_FLAGS32 (InterruptEnable)

	MODM_FLAGS32 (InterruptFlags)

Static Public Member Functions
static void	configure (DataTransferDirection direction, MemoryDataSize memoryDataSize, PeripheralDataSize peripheralDataSize, MemoryIncrementMode memoryIncrement, PeripheralIncrementMode peripheralIncrement, Priority priority=Priority::Medium, CircularMode circularMode=CircularMode::Disabled)

static void	start ()

static void	stop ()

static DataTransferDirection	getDataTransferDirection ()

static void	setMemoryAddress (uintptr_t address)

static void	setPeripheralAddress (uintptr_t address)

static void	setMemoryIncrementMode (bool increment)

static void	setPeripheralIncrementMode (bool increment)

static void	setDataLength (std::size_t length)

static void	setTransferErrorIrqHandler (IrqHandler irqHandler)

static void	setHalfTransferCompleteIrqHandler (IrqHandler irqHandler)

static void	setTransferCompleteIrqHandler (IrqHandler irqHandler)

template<DmaBase::Request dmaRequest>
static void	setPeripheralRequest ()

static void	interruptHandler ()

static InterruptFlags_t	getInterruptFlags ()

static void	clearInterruptFlags (InterruptFlags_t flags=InterruptFlags::All)

static void	enableInterruptVector (uint32_t priority=1)

static void	disableInterruptVector ()

static void	enableInterrupt (InterruptEnable_t irq)

static void	disableInterrupt (InterruptEnable_t irq)

Static Protected Attributes
static constexpr uint32_t	configmask

static constexpr uint32_t	memoryMask

static constexpr uint32_t	peripheralMask

Detailed Description

template<uint32_t ID>
class modm::platform::DmaController< ID >::Channel

Class representing a DMA channel/stream

Member Enumeration Documentation

enum modm::platform::DmaBase::CircularMode : uint32_t

inheritedstrong

Enum Values	Documentation
Enabled	circular mode

enum modm::platform::DmaBase::DataTransferDirection : uint32_t

inheritedstrong

Enum Values	Documentation
PeripheralToMemory	Source: DMA_SxPAR; Sink: DMA_SxM0AR.
MemoryToPeripheral	Source: DMA_SxM0AR; Sink: DMA_SxPAR.
MemoryToMemory	Source: DMA_SxPAR; Sink: DMA_SxM0AR.

enum modm::platform::DmaBase::MemoryDataSize : uint32_t

inheritedstrong

In direct mode (if the FIFO is not used) MSIZE is forced by hardware to the same value as PSIZE

enum modm::platform::DmaBase::MemoryIncrementMode : uint32_t

inheritedstrong

Enum Values	Documentation
Increment	incremented according to MemoryDataSize

enum modm::platform::DmaBase::PeripheralIncrementMode : uint32_t

inheritedstrong

Enum Values	Documentation
Increment	incremented according to PeripheralDataSize

enum modm::platform::DmaBase::Signal : uint8_t

inheritedstrong

Peripheral signals that can be used in DMA channels

Member Function Documentation

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::clearInterruptFlags ( InterruptFlags_t flags = InterruptFlags::All )

inlinestatic

Clear channel interrupt flags. Use only when the channel interrupt is disabled.

Warning: Flags are automatically cleared in the ISR if the channel interrupt is enabled or when start() is called.

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::configure	(	DataTransferDirection	direction,
		MemoryDataSize	memoryDataSize,
		PeripheralDataSize	peripheralDataSize,
		MemoryIncrementMode	memoryIncrement,
		PeripheralIncrementMode	peripheralIncrement,
		Priority	priority = `Priority::Medium`,
		CircularMode	circularMode = `CircularMode::Disabled`
	)

inlinestatic

Configure the DMA channel

Stops the DMA channel and writes the new values to its control register.

Parameters

[in]	direction	Direction of the DMA channel
[in]	memoryDataSize	Size of data in memory (byte, halfword, word)
[in]	peripheralDataSize	Size of data in peripheral (byte, halfword, word)
[in]	memoryIncrement	Defines whether the memory address is incremented after a transfer completed
[in]	peripheralIncrement	Defines whether the peripheral address is incremented after a transfer completed
[in]	priority	Priority of the DMA channel
[in]	circularMode	Transfer data in circular mode?

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::disableInterrupt ( InterruptEnable_t irq )

inlinestatic

Disable the specified interrupt of the channel

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::disableInterruptVector ( )

inlinestatic

Disable the IRQ vector of the channel

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::enableInterrupt ( InterruptEnable_t irq )

inlinestatic

Enable the specified interrupt of the channel

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::enableInterruptVector ( uint32_t priority = 1 )

inlinestatic

Enable the IRQ vector of the channel

Parameters

[in] priority Priority of the IRQ

template<uint32_t ID>

static DataTransferDirection modm::platform::DmaController< ID >::Channel::getDataTransferDirection ( )

inlinestatic

Get the direction of the data transfer

template<uint32_t ID>

static InterruptFlags_t modm::platform::DmaController< ID >::Channel::getInterruptFlags ( )

inlinestatic

Read channel status flags when channel interrupts are disabled. This function is useful to query the transfer state when the use of the channel interrupt is not required for the application.

Warning: Flags are automatically cleared in the ISR if the channel interrupt is enabled or when start() is called.

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::interruptHandler ( )

inlinestatic

IRQ handler of the DMA channel

Reads the IRQ status and checks for error or transfer complete. In case of error the DMA channel will be disabled.

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setDataLength ( std::size_t length )

inlinestatic

Set the length of data to be transfered

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setHalfTransferCompleteIrqHandler ( IrqHandler irqHandler )

inlinestatic

Set the IRQ handler for half transfer complete

Called by the channels IRQ handler when the transfer is half complete.

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setMemoryAddress ( uintptr_t address )

inlinestatic

Set the memory address of the DMA channel

Note: In Mem2Mem mode use this method to set the memory source address.

Parameters

[in] address Source address

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setMemoryIncrementMode ( bool increment )

inlinestatic

Enable/disable memory increment

When enabled, the memory address is incremented by the size of the data (e.g. 1 for byte transfers, 4 for word transfers) after the transfer completed.

Parameters

[in] increment Enable/disable

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setPeripheralAddress ( uintptr_t address )

inlinestatic

Set the peripheral address of the DMA channel

Note: In Mem2Mem mode use this method to set the memory destination address.

Parameters

[in] address Destination address

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setPeripheralIncrementMode ( bool increment )

inlinestatic

Enable/disable peripheral increment

When enabled, the peripheral address is incremented by the size of the data (e.g. 1 for byte transfers, 4 for word transfers) after the transfer completed.

Parameters

[in] increment Enable/disable

template<uint32_t ID>

template<DmaBase::Request dmaRequest>

static void modm::platform::DmaController< ID >::Channel::setPeripheralRequest ( )

inlinestatic

Set the peripheral that operates the channel

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setTransferCompleteIrqHandler ( IrqHandler irqHandler )

inlinestatic

Set the IRQ handler for transfer complete

Called by the channels IRQ handler when the transfer is complete.

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::setTransferErrorIrqHandler ( IrqHandler irqHandler )

inlinestatic

Set the IRQ handler for transfer errors

The handler will be called from the channels IRQ handler function when the IRQ status indicates an error occured.

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::start ( )

inlinestatic

Start the transfer of the DMA channel and clear all interrupt flags.

template<uint32_t ID>

static void modm::platform::DmaController< ID >::Channel::stop ( )

inlinestatic

Stop a DMA channel transfer

Member Data Documentation

constexpr uint32_t modm::platform::DmaBase::configmask

inheritedstaticprotectedconstexpr

Initial value:

DMA_SxCR_CHSEL_Msk |                    
            DMA_SxCR_PL_Msk |                       
            DMA_SxCR_CIRC_Msk |                     
            DMA_SxCR_PFCTRL_Msk

constexpr uint32_t modm::platform::DmaBase::memoryMask

inheritedstaticprotectedconstexpr

Initial value:

DMA_SxCR_MBURST_Msk |                   
            DMA_SxCR_MSIZE_Msk |                    
            DMA_SxCR_MINC |                         
            DMA_SxCR_DIR_Msk

constexpr uint32_t modm::platform::DmaBase::peripheralMask

inheritedstaticprotectedconstexpr

Initial value:

DMA_SxCR_PBURST_Msk |                   
            DMA_SxCR_PSIZE_Msk |                    
            DMA_SxCR_PINC_Msk |                     
            DMA_SxCR_DIR_Msk

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

dma.hpp

Classes

Public Typedefs

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Detailed Description

template<uint32_t ID> class modm::platform::DmaController< ID >::Channel

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

template<uint32_t ID>
class modm::platform::DmaController< ID >::Channel