(def97ec)

DMA Device Interface Functions More...

#include <stdbool.h>
#include <stdint.h>
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"

Go to the source code of this file.

Data Structures
struct	dif_dma
	A handle to dma. More...

Typedefs
typedef struct dif_dma	dif_dma_t
	A handle to dma. More...

typedef enum dif_dma_alert	dif_dma_alert_t
	A dma alert type.

typedef enum dif_dma_irq	dif_dma_irq_t
	A dma interrupt request type.

typedef uint32_t	dif_dma_irq_state_snapshot_t
	A snapshot of the state of the interrupts for this IP. More...

typedef uint32_t	dif_dma_irq_enable_snapshot_t
	A snapshot of the enablement state of the interrupts for this IP. More...

Enumerations
enum	dif_dma_alert { kDifDmaAlertFatalFault = 0 }
	A dma alert type. More...

enum	dif_dma_irq { kDifDmaIrqDmaDone = 0, kDifDmaIrqDmaError = 1 }
	A dma interrupt request type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_init (mmio_region_t base_addr, dif_dma_t *dma)
	Creates a new handle for a(n) dma peripheral. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_alert_force (const dif_dma_t *dma, dif_dma_alert_t alert)
	Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_get_type (const dif_dma_t dma, dif_dma_irq_t irq, dif_irq_type_t type)
	Returns the type of a given interrupt (i.e., event or status) for this IP. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_get_state (const dif_dma_t dma, dif_dma_irq_state_snapshot_t snapshot)
	Returns the state of all interrupts (i.e., pending or not) for this IP. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_is_pending (const dif_dma_t dma, dif_dma_irq_t irq, bool is_pending)
	Returns whether a particular interrupt is currently pending. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_acknowledge_state (const dif_dma_t *dma, dif_dma_irq_state_snapshot_t snapshot)
	Acknowledges all interrupts that were pending at the time of the state snapshot. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_acknowledge_all (const dif_dma_t *dma)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_acknowledge (const dif_dma_t *dma, dif_dma_irq_t irq)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_force (const dif_dma_t *dma, dif_dma_irq_t irq, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_get_enabled (const dif_dma_t dma, dif_dma_irq_t irq, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_set_enabled (const dif_dma_t *dma, dif_dma_irq_t irq, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_disable_all (const dif_dma_t dma, dif_dma_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_dma_irq_restore_all (const dif_dma_t dma, const dif_dma_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot. More...

Detailed Description

DMA Device Interface Functions

Definition in file dif_dma_autogen.h.

Data Structure Documentation

◆ dif_dma

struct dif_dma

A handle to dma.

This type should be treated as opaque by users.

Definition at line 32 of file dif_dma_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the dma hardware registers.

Typedef Documentation

◆ dif_dma_irq_enable_snapshot_t

typedef uint32_t dif_dma_irq_enable_snapshot_t

A snapshot of the enablement state of the interrupts for this IP.

This is an opaque type, to be used with the dif_dma_irq_disable_all() and dif_dma_irq_restore_all() functions.

Definition at line 183 of file dif_dma_autogen.h.

◆ dif_dma_irq_state_snapshot_t

typedef uint32_t dif_dma_irq_state_snapshot_t

A snapshot of the state of the interrupts for this IP.

This is an opaque type, to be used with the dif_dma_irq_get_state() and dif_dma_irq_acknowledge_state() functions.

Definition at line 93 of file dif_dma_autogen.h.

◆ dif_dma_t

typedef struct dif_dma dif_dma_t

A handle to dma.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_dma_alert

enum dif_dma_alert

A dma alert type.

Enumerator
kDifDmaAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 54 of file dif_dma_autogen.h.

◆ dif_dma_irq

enum dif_dma_irq

A dma interrupt request type.

Enumerator

kDifDmaIrqDmaDone

DMA operation has been completed.

kDifDmaIrqDmaError

DMA error has occurred.

DMA_STATUS.error_code register shows the details.

Definition at line 76 of file dif_dma_autogen.h.

Function Documentation

◆ dif_dma_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_alert_force	(	const dif_dma_t *	dma,
		dif_dma_alert_t	alert
	)

Forces a particular alert, causing it to be escalated as if the hardware had raised it.

Parameters

dma	A dma handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 27 of file dif_dma_autogen.c.

◆ dif_dma_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_init	(	mmio_region_t	base_addr,
		dif_dma_t *	dma
	)

Creates a new handle for a(n) dma peripheral.

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the dma peripheral.
[out]	dma	Out param for the initialized handle.

Returns: The result of the operation.

Definition at line 17 of file dif_dma_autogen.c.

◆ dif_dma_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_acknowledge	(	const dif_dma_t *	dma,
		dif_dma_irq_t	irq
	)

Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

Parameters

dma	A dma handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 144 of file dif_dma_autogen.c.

◆ dif_dma_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_acknowledge_all ( const dif_dma_t * dma )

Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

Parameters

dma	A dma handle.

Returns: The result of the operation.

Definition at line 131 of file dif_dma_autogen.c.

◆ dif_dma_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_acknowledge_state	(	const dif_dma_t *	dma,
		dif_dma_irq_state_snapshot_t	snapshot
	)

Acknowledges all interrupts that were pending at the time of the state snapshot.

Parameters

dma	A dma handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 98 of file dif_dma_autogen.c.

◆ dif_dma_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_disable_all	(	const dif_dma_t *	dma,
		dif_dma_irq_enable_snapshot_t *	snapshot
	)

Disables all interrupts, optionally snapshotting all enable states for later restoration.

Parameters

	dma	A dma handle.
[out]	snapshot	Out-param for the snapshot; may be `NULL`.

Returns: The result of the operation.

Definition at line 226 of file dif_dma_autogen.c.

◆ dif_dma_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_force	(	const dif_dma_t *	dma,
		dif_dma_irq_t	irq,
		const bool	val
	)

Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

Parameters

dma	A dma handle.
irq	An interrupt request.
val	Value to be set.

Returns: The result of the operation.

Definition at line 163 of file dif_dma_autogen.c.

◆ dif_dma_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_get_enabled	(	const dif_dma_t *	dma,
		dif_dma_irq_t	irq,
		dif_toggle_t *	state
	)

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

	dma	A dma handle.
	irq	An interrupt request.
[out]	state	Out-param toggle state of the interrupt.

Returns: The result of the operation.

Definition at line 182 of file dif_dma_autogen.c.

◆ dif_dma_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_get_state	(	const dif_dma_t *	dma,
		dif_dma_irq_state_snapshot_t *	snapshot
	)

Returns the state of all interrupts (i.e., pending or not) for this IP.

Parameters

	dma	A dma handle.
[out]	snapshot	Out-param for interrupt state snapshot.

Returns: The result of the operation.

Definition at line 85 of file dif_dma_autogen.c.

◆ dif_dma_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_get_type	(	const dif_dma_t *	dma,
		dif_dma_irq_t	irq,
		dif_irq_type_t *	type
	)

Returns the type of a given interrupt (i.e., event or status) for this IP.

Parameters

	dma	A dma handle.
	irq	An interrupt request.
[out]	type	Out-param for the interrupt type.

Returns: The result of the operation.

Definition at line 73 of file dif_dma_autogen.c.

◆ dif_dma_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_is_pending	(	const dif_dma_t *	dma,
		dif_dma_irq_t	irq,
		bool *	is_pending
	)

Returns whether a particular interrupt is currently pending.

Parameters

	dma	A dma handle.
	irq	An interrupt request.
[out]	is_pending	Out-param for whether the interrupt is pending.

Returns: The result of the operation.

Definition at line 111 of file dif_dma_autogen.c.

◆ dif_dma_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_restore_all	(	const dif_dma_t *	dma,
		const dif_dma_irq_enable_snapshot_t *	snapshot
	)

Restores interrupts from the given (enable) snapshot.

Parameters

dma	A dma handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 246 of file dif_dma_autogen.c.

◆ dif_dma_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_dma_irq_set_enabled	(	const dif_dma_t *	dma,
		dif_dma_irq_t	irq,
		dif_toggle_t	state
	)

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

dma	A dma handle.
irq	An interrupt request.
state	The new toggle state for the interrupt.

Returns: The result of the operation.

Definition at line 203 of file dif_dma_autogen.c.

(def97ec)

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_dma

Typedef Documentation

◆ dif_dma_irq_enable_snapshot_t

◆ dif_dma_irq_state_snapshot_t

◆ dif_dma_t

Enumeration Type Documentation

◆ dif_dma_alert

◆ dif_dma_irq

Function Documentation

◆ dif_dma_alert_force()

◆ dif_dma_init()

◆ dif_dma_irq_acknowledge()

◆ dif_dma_irq_acknowledge_all()

◆ dif_dma_irq_acknowledge_state()

◆ dif_dma_irq_disable_all()

◆ dif_dma_irq_force()

◆ dif_dma_irq_get_enabled()

◆ dif_dma_irq_get_state()

◆ dif_dma_irq_get_type()

◆ dif_dma_irq_is_pending()

◆ dif_dma_irq_restore_all()

◆ dif_dma_irq_set_enabled()