cfn_hal_dma.h File Reference

DMA (Direct Memory Access) Hardware Abstraction Layer. More...

#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_types.h"

Go to the source code of this file.

Data Structures
struct	cfn_hal_dma_transfer_t
	DMA transfer configuration. More...
struct	cfn_hal_dma_config_t
	DMA configuration structure. More...
struct	cfn_hal_dma_phy_t
	DMA hardware physical mapping. More...
struct	cfn_hal_dma_api_s
	DMA Virtual Method Table (VMT). More...

Typedefs
typedef struct cfn_hal_dma_s	cfn_hal_dma_t
typedef struct cfn_hal_dma_api_s	cfn_hal_dma_api_t
typedef void(*	cfn_hal_dma_callback_t) (cfn_hal_dma_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)
	DMA callback signature.

Enumerations
enum	cfn_hal_dma_event_t { CFN_HAL_DMA_EVENT_NONE = 0 , CFN_HAL_DMA_EVENT_TRANSFER_HALF = CFN_HAL_BIT(0) , CFN_HAL_DMA_EVENT_TRANSFER_COMPLETE = CFN_HAL_BIT(1) }
	DMA nominal event flags. More...
enum	cfn_hal_dma_error_t { CFN_HAL_DMA_ERROR_NONE = 0 , CFN_HAL_DMA_ERROR_TRANSFER = CFN_HAL_BIT(0) , CFN_HAL_DMA_ERROR_GENERAL = CFN_HAL_BIT(1) }
	DMA exception error flags. More...

Functions
	CFN_HAL_VMT_CHECK (struct cfn_hal_dma_api_s)
	CFN_HAL_CREATE_DRIVER_TYPE (dma, cfn_hal_dma_config_t, cfn_hal_dma_api_t, cfn_hal_dma_phy_t, cfn_hal_dma_callback_t)
CFN_HAL_INLINE void	cfn_hal_dma_populate (cfn_hal_dma_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_dma_api_t *api, const cfn_hal_dma_phy_t *phy, const cfn_hal_dma_config_t *config, cfn_hal_dma_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_config_validate (const cfn_hal_dma_t *driver, const cfn_hal_dma_config_t *config)
	Validates the DMA configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_init (cfn_hal_dma_t *driver)
	Initializes the DMA driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_deinit (cfn_hal_dma_t *driver)
	Deinitializes the DMA driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_config_set (cfn_hal_dma_t *driver, const cfn_hal_dma_config_t *config)
	Sets the DMA configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_config_get (cfn_hal_dma_t *driver, cfn_hal_dma_config_t *config)
	Gets the current DMA configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_callback_register (cfn_hal_dma_t *driver, const cfn_hal_dma_callback_t callback, void *user_arg)
	Registers a callback for DMA events and errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_power_state_set (cfn_hal_dma_t *driver, cfn_hal_power_state_t state)
	Sets the DMA power state.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_event_enable (cfn_hal_dma_t *driver, uint32_t event_mask)
	Enables one or more DMA nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_event_disable (cfn_hal_dma_t *driver, uint32_t event_mask)
	Disables one or more DMA nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_event_get (cfn_hal_dma_t *driver, uint32_t *event_mask)
	Retrieves the current DMA nominal event status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_error_enable (cfn_hal_dma_t *driver, uint32_t error_mask)
	Enables one or more DMA exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_error_disable (cfn_hal_dma_t *driver, uint32_t error_mask)
	Disables one or more DMA exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_error_get (cfn_hal_dma_t *driver, uint32_t *error_mask)
	Retrieves the current DMA exception error status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_start (cfn_hal_dma_t *driver, const cfn_hal_dma_transfer_t *transfer)
	Starts a DMA transfer.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_dma_stop (cfn_hal_dma_t *driver)
	Stops an ongoing DMA transfer.
cfn_hal_error_code_t	cfn_hal_dma_construct (cfn_hal_dma_t *driver, const cfn_hal_dma_config_t *config, const cfn_hal_dma_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_dma_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_hal_dma_destruct (cfn_hal_dma_t *driver)

Detailed Description

DMA (Direct Memory Access) Hardware Abstraction Layer.

Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

cfn_hal_dma_api_t

typedef struct cfn_hal_dma_api_s cfn_hal_dma_api_t

cfn_hal_dma_callback_t

typedef void(* cfn_hal_dma_callback_t) (cfn_hal_dma_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)

DMA callback signature.

Parameters

driver	Pointer to the DMA driver instance.
event_mask	Mask of triggered nominal events.
error_mask	Mask of triggered exception errors.
user_arg	User-defined argument passed during registration.

cfn_hal_dma_t

typedef struct cfn_hal_dma_s cfn_hal_dma_t

Enumeration Type Documentation

cfn_hal_dma_error_t

enum cfn_hal_dma_error_t

DMA exception error flags.

Enumerator
CFN_HAL_DMA_ERROR_NONE
CFN_HAL_DMA_ERROR_TRANSFER	Transfer or bus error
CFN_HAL_DMA_ERROR_GENERAL	General hardware error

cfn_hal_dma_event_t

enum cfn_hal_dma_event_t

DMA nominal event flags.

Enumerator
CFN_HAL_DMA_EVENT_NONE
CFN_HAL_DMA_EVENT_TRANSFER_HALF	Half of data transferred
CFN_HAL_DMA_EVENT_TRANSFER_COMPLETE	All data transferred

Function Documentation

CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE	(	dma	,
		cfn_hal_dma_config_t	,
		cfn_hal_dma_api_t	,
		cfn_hal_dma_phy_t	,
		cfn_hal_dma_callback_t
	)

cfn_hal_dma_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_callback_register	(	cfn_hal_dma_t *	driver,
		const cfn_hal_dma_callback_t	callback,
		void *	user_arg
	)

Registers a callback for DMA events and errors.

Parameters

driver	Pointer to the DMA driver instance.
callback	The callback function to register.
user_arg	User-defined argument passed to the callback.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_config_get	(	cfn_hal_dma_t *	driver,
		cfn_hal_dma_config_t *	config
	)

Gets the current DMA configuration.

Parameters

driver	Pointer to the DMA driver instance.
config	[out] Pointer to store the configuration.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_config_set	(	cfn_hal_dma_t *	driver,
		const cfn_hal_dma_config_t *	config
	)

Sets the DMA configuration.

Parameters

driver	Pointer to the DMA driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_config_validate	(	const cfn_hal_dma_t *	driver,
		const cfn_hal_dma_config_t *	config
	)

Validates the DMA configuration.

Parameters

driver	Pointer to the DMA driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_construct()

cfn_hal_error_code_t cfn_hal_dma_construct	(	cfn_hal_dma_t *	driver,
		const cfn_hal_dma_config_t *	config,
		const cfn_hal_dma_phy_t *	phy,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		cfn_hal_dma_callback_t	callback,
		void *	user_arg
	)

cfn_hal_dma_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_deinit

(

cfn_hal_dma_t *

driver

)

Deinitializes the DMA driver.

Parameters

driver

Pointer to the DMA driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_destruct()

cfn_hal_error_code_t cfn_hal_dma_destruct

(

cfn_hal_dma_t *

driver

)

cfn_hal_dma_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_error_disable	(	cfn_hal_dma_t *	driver,
		uint32_t	error_mask
	)

Disables one or more DMA exception errors.

Parameters

driver	Pointer to the DMA driver instance.
error_mask	Mask of errors to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_error_enable	(	cfn_hal_dma_t *	driver,
		uint32_t	error_mask
	)

Enables one or more DMA exception errors.

Parameters

driver	Pointer to the DMA driver instance.
error_mask	Mask of errors to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_error_get	(	cfn_hal_dma_t *	driver,
		uint32_t *	error_mask
	)

Retrieves the current DMA exception error status.

Parameters

driver	Pointer to the DMA driver instance.
error_mask	[out] Pointer to store the error mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_event_disable	(	cfn_hal_dma_t *	driver,
		uint32_t	event_mask
	)

Disables one or more DMA nominal events.

Parameters

driver	Pointer to the DMA driver instance.
event_mask	Mask of events to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_event_enable	(	cfn_hal_dma_t *	driver,
		uint32_t	event_mask
	)

Enables one or more DMA nominal events.

Parameters

driver	Pointer to the DMA driver instance.
event_mask	Mask of events to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_event_get	(	cfn_hal_dma_t *	driver,
		uint32_t *	event_mask
	)

Retrieves the current DMA nominal event status.

Parameters

driver	Pointer to the DMA driver instance.
event_mask	[out] Pointer to store the event mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_init

(

cfn_hal_dma_t *

driver

)

Initializes the DMA driver.

Parameters

driver

Pointer to the DMA driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_populate()

CFN_HAL_INLINE void cfn_hal_dma_populate	(	cfn_hal_dma_t *	driver,
		uint32_t	peripheral_id,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		const cfn_hal_dma_api_t *	api,
		const cfn_hal_dma_phy_t *	phy,
		const cfn_hal_dma_config_t *	config,
		cfn_hal_dma_callback_t	callback,
		void *	user_arg
	)

cfn_hal_dma_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_power_state_set	(	cfn_hal_dma_t *	driver,
		cfn_hal_power_state_t	state
	)

Sets the DMA power state.

Parameters

driver	Pointer to the DMA driver instance.
state	Target power state.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_start()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_start	(	cfn_hal_dma_t *	driver,
		const cfn_hal_dma_transfer_t *	transfer
	)

Starts a DMA transfer.

Parameters

driver	Pointer to the DMA driver instance.
transfer	Pointer to the transfer configuration.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_dma_stop()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dma_stop

(

cfn_hal_dma_t *

driver

)

Stops an ongoing DMA transfer.

Parameters

driver

Pointer to the DMA driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK

(

struct cfn_hal_dma_api_s

)