DMA Controller (DMAC). More...

Data Structures
struct	dmac_instance_ctrl_t

struct	transfer_on_dmac_cfg_t

Macros
#define	DMAC_REPEAT_BLOCK_MAX_LENGTH (0x400)

#define	DMAC_NORMAL_MAX_LENGTH (0xFFFF)

#define	DUMMY_ADDRESS ((void *) 0x40005500)

Functions
ssp_err_t	R_DMAC_Open (transfer_ctrl_t const p_api_ctrl, transfer_cfg_t const const p_cfg)
	Initialize transfer and enables transfer in ICU. Implements transfer_api_t::open. More...

ssp_err_t	R_DMAC_Reset (transfer_ctrl_t const p_api_ctrl, void const volatile p_src, void *volatile p_dest, uint16_t const num_transfers)
	Reset transfer source, destination, and number of transfers. More...

ssp_err_t	R_DMAC_Start (transfer_ctrl_t *const p_api_ctrl, transfer_start_mode_t mode)
	Start transfer. Implements transfer_api_t::start. More...

ssp_err_t	R_DMAC_Stop (transfer_ctrl_t *const p_api_ctrl)
	Stop transfer. Implements transfer_api_t::stop. More...

ssp_err_t	R_DMAC_Enable (transfer_ctrl_t *const p_api_ctrl)
	Enable transfer. Implements transfer_api_t::enable. More...

ssp_err_t	R_DMAC_Disable (transfer_ctrl_t *const p_api_ctrl)
	Disable transfer. Implements transfer_api_t::disable. More...

ssp_err_t	R_DMAC_InfoGet (transfer_ctrl_t const p_api_ctrl, transfer_properties_t const p_info)
	Set driver specific information in provided pointer. Implements transfer_api_t::infoGet. More...

ssp_err_t	R_DMAC_Close (transfer_ctrl_t *const p_api_ctrl)
	Disable transfer and clean up internal data. Implements transfer_api_t::close. More...

ssp_err_t	R_DMAC_VersionGet (ssp_version_t *const p_version)
	Set driver version based on compile time macros. More...

ssp_err_t	R_DMAC_BlockReset (transfer_ctrl_t const p_api_ctrl, void const volatile p_src, void *volatile p_dest, uint16_t const length, transfer_size_t size, uint16_t const num_transfers)
	Reset transfer source, destination, length and number of transfers for block transfer. More...

ssp_err_t	R_DMAC_Stop_ActivationRequest (transfer_ctrl_t *const p_api_ctrl)
	Clears the DMA activation request with a DMA dummy transfer as per flowchart in the hardware manual. Implements transfer_api_t::Stop_ActivationRequest. This function to be used only in scenario when a DMA activation request source might occur in the next request after a DMA transfer completes. If this happens, the DMA transfer starts and the DMA activation request is held in DMAC. More...

Detailed Description

DMA Controller (DMAC).

Summary

Extends the Transfer Interface.

The Direct Memory Access (DMA) Controller allows data transfers to occur in place of or in addition to any interrupt. It also supports data transfers using software start.

Note: The transfer length is limited to 1024 (10 bits) in TRANSFER_MODE_BLOCK and TRANSFER_MODE_REPEAT.; This driver supports only TRANSFER_IRQ_END from transfer_irq_t.

Macro Definition Documentation

◆ DMAC_NORMAL_MAX_LENGTH

#define DMAC_NORMAL_MAX_LENGTH (0xFFFF)

Length limited to 65535 transfers for normal mode

◆ DMAC_REPEAT_BLOCK_MAX_LENGTH

#define DMAC_REPEAT_BLOCK_MAX_LENGTH (0x400)

Length limited to 1024 transfers for repeat and block mode

◆ DUMMY_ADDRESS

#define DUMMY_ADDRESS ((void *) 0x40005500)

Reserved memory area for dummy write transfer as per Hardware user manual

Function Documentation

◆ R_DMAC_BlockReset()

ssp_err_t R_DMAC_BlockReset	(	transfer_ctrl_t *const	p_api_ctrl,
		void const *volatile	p_src,
		void *volatile	p_dest,
		uint16_t const	length,
		transfer_size_t	size,
		uint16_t const	num_transfers
	)

Reset transfer source, destination, length and number of transfers for block transfer.

Return values

SSP_SUCCESS	Transfer reset successfully.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_IN_USE	Transfer is in progress. Wait for transfer to complete.
SSP_ERR_NOT_ENABLED	DMAC is not enabled. A valid source and destination must be provided in either open() or blockReset().

Enables transfers on this activation source.

◆ R_DMAC_Close()

ssp_err_t R_DMAC_Close ( transfer_ctrl_t *const p_api_ctrl )

Disable transfer and clean up internal data. Implements transfer_api_t::close.

Return values

SSP_SUCCESS	Successful close.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_OPEN	Handle is not initialized. Call R_DMAC_Open to initialize the control block.
SSP_ERR_IN_USE	Transfer is in progress. Wait for transfer to complete.

Disable DMAC transfers, disable DMAC interrupts, and remove DMAC trigger from ICU register.

Clear ID so control block can be reused.

Release BSP hardware lock on this channel

◆ R_DMAC_Disable()

ssp_err_t R_DMAC_Disable ( transfer_ctrl_t *const p_api_ctrl )

Disable transfer. Implements transfer_api_t::disable.

Return values

SSP_SUCCESS	Counter value written successfully.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_OPEN	Handle is not initialized. Call R_DMAC_Open to initialize the control block.

Disable transfer.

◆ R_DMAC_Enable()

ssp_err_t R_DMAC_Enable ( transfer_ctrl_t *const p_api_ctrl )

Enable transfer. Implements transfer_api_t::enable.

Return values

SSP_SUCCESS	Counter value written successfully.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_OPEN	Handle is not initialized. Call R_DMAC_Open to initialize the control block.

Enable transfer.

◆ R_DMAC_InfoGet()

ssp_err_t R_DMAC_InfoGet	(	transfer_ctrl_t *const	p_api_ctrl,
		transfer_properties_t *const	p_info
	)

Set driver specific information in provided pointer. Implements transfer_api_t::infoGet.

Return values

SSP_SUCCESS	Counter value written successfully.
SSP_ERR_NOT_OPEN	Handle is not initialized. Call R_DMAC_Open to initialize the control block.
SSP_ERR_ASSERTION	An input parameter is invalid.

If a transfer is active, store it in p_in_progress.

Store maximum transfer length.

Store remaining transfer length.

◆ R_DMAC_Open()

ssp_err_t R_DMAC_Open	(	transfer_ctrl_t *const	p_api_ctrl,
		transfer_cfg_t const *const	p_cfg
	)

Initialize transfer and enables transfer in ICU. Implements transfer_api_t::open.

Return values

SSP_SUCCESS	Successful open. Transfer is configured and will start when trigger occurs.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_ENABLED	Auto-enable was requested, but enable failed.
SSP_ERR_IRQ_BSP_DISABLED	The IRQ associated with the activation source is not enabled in the BSP.
SSP_ERR_INVALID_SIZE	Invalid offset value.
SSP_ERR_IN_USE	The BSP hardware lock for the DMAC is not available.

Returns

See Common Error Codes for other possible return codes.This function calls

Get the IRQ vectors, event info and set the NVIC priority for dmac.

Acquire BSP hardware lock for channel used.

Configure the DMAC according to the flowchart "Activating the DMAC" in chapter 16.3.7 of hardware manual NoSecurity_r01uh0488ej0040_sc32.pdf.

Set the offset value in offset addressing mode.

Configure DMA transfer and sources

Note: Transfer escape interrupts not supported.

Update internal variables.

Mark driver as open by initializing "DMAC" in its ASCII equivalent.

If auto_enable is true, enable transfer and ELC events if software start is used.

◆ R_DMAC_Reset()

ssp_err_t R_DMAC_Reset	(	transfer_ctrl_t *const	p_api_ctrl,
		void const *volatile	p_src,
		void *volatile	p_dest,
		uint16_t const	num_transfers
	)

Reset transfer source, destination, and number of transfers.

Return values

SSP_SUCCESS	Transfer reset successfully.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_ENABLED	DMAC is not enabled. A valid source and destination must be provided in either open() or reset().
SSP_ERR_IN_USE	Transfer is in progress. Wait for transfer to complete.

Enables transfers on this activation source.

◆ R_DMAC_Start()

ssp_err_t R_DMAC_Start	(	transfer_ctrl_t *const	p_api_ctrl,
		transfer_start_mode_t	mode
	)

Start transfer. Implements transfer_api_t::start.

Return values

SSP_SUCCESS	Transfer started written successfully.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_OPEN	Handle is not initialized. Call R_DMAC_Open to initialize the control block.
SSP_ERR_UNSUPPORTED	Handle was not configured for software activation.

Set autoclear bit and software start bit.

◆ R_DMAC_Stop()

ssp_err_t R_DMAC_Stop ( transfer_ctrl_t *const p_api_ctrl )

Stop transfer. Implements transfer_api_t::stop.

Return values

SSP_SUCCESS	Transfer stopped written successfully.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_OPEN	Handle is not initialized. Call R_DMAC_Open to initialize the control block.

Reset auto clear bit and clear software transfer request.

◆ R_DMAC_Stop_ActivationRequest()

ssp_err_t R_DMAC_Stop_ActivationRequest ( transfer_ctrl_t *const p_api_ctrl )

Clears the DMA activation request with a DMA dummy transfer as per flowchart in the hardware manual. Implements transfer_api_t::Stop_ActivationRequest. This function to be used only in scenario when a DMA activation request source might occur in the next request after a DMA transfer completes. If this happens, the DMA transfer starts and the DMA activation request is held in DMAC.

Return values

SSP_SUCCESS	Successful transfer.
SSP_ERR_ASSERTION	An input parameter is invalid.
SSP_ERR_NOT_OPEN	Handle is not initialized. Call R_DMAC_Open to initialize the control block.

Clear the DMA activation request with a DMA dummy transfer as per flowchart in the hardware manual.

Disable DMAC transfer.

Disable the IRQ pin as a DMACm request source

Set the DMAC transfer size

Set source and destination address to 4000_5500 as per hardware manual.

Set number of transfer operations

Disable DMAC transfer.

Wait for the DMAC transfer end

◆ R_DMAC_VersionGet()

ssp_err_t R_DMAC_VersionGet ( ssp_version_t *const p_version )

Set driver version based on compile time macros.

Return values

SSP_SUCCESS	Successful close.
SSP_ERR_ASSERTION	An input parameter is invalid.

Data Structures

Macros

Functions

Detailed Description

Summary

Macro Definition Documentation

◆ DMAC_NORMAL_MAX_LENGTH

◆ DMAC_REPEAT_BLOCK_MAX_LENGTH

◆ DUMMY_ADDRESS

Function Documentation

◆ R_DMAC_BlockReset()

◆ R_DMAC_Close()

◆ R_DMAC_Disable()

◆ R_DMAC_Enable()

◆ R_DMAC_InfoGet()

◆ R_DMAC_Open()

◆ R_DMAC_Reset()

◆ R_DMAC_Start()

◆ R_DMAC_Stop()

◆ R_DMAC_Stop_ActivationRequest()

◆ R_DMAC_VersionGet()