AC_RANGE_CHECK 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"
#include "dt/dt_ac_range_check.h"

Data Structures
struct	dif_ac_range_check
	A handle to ac_range_check. More...

Macros
#define	kDifAcRangeCheckIrqDenyCntReached kDtAcRangeCheckIrqDenyCntReached
	A ac_range_check interrupt request type.

Typedefs
typedef struct dif_ac_range_check	dif_ac_range_check_t
	A handle to ac_range_check.

typedef enum dif_ac_range_check_alert	dif_ac_range_check_alert_t
	A ac_range_check alert type.

typedef dt_ac_range_check_irq_t	dif_ac_range_check_irq_t

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

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

Enumerations
enum	dif_ac_range_check_alert { kDifAcRangeCheckAlertRecovCtrlUpdateErr = 0 , kDifAcRangeCheckAlertFatalFault = 1 }
	A ac_range_check alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_init (mmio_region_t base_addr, dif_ac_range_check_t *ac_range_check)
	Creates a new handle for a(n) ac_range_check peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_init_from_dt (dt_ac_range_check_t dt, dif_ac_range_check_t *ac_range_check)
	Creates a new handle for a(n) ac_range_check peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_get_dt (const dif_ac_range_check_t ac_range_check, dt_ac_range_check_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_alert_force (const dif_ac_range_check_t *ac_range_check, dif_ac_range_check_alert_t alert)
	Forces a particular alert, causing it to be escalated as if the hardware had raised it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_get_type (const dif_ac_range_check_t ac_range_check, dif_ac_range_check_irq_t, dif_irq_type_t type)
	Returns the type of a given interrupt (i.e., event or status) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_get_state (const dif_ac_range_check_t ac_range_check, dif_ac_range_check_irq_state_snapshot_t snapshot)
	Returns the state of all interrupts (i.e., pending or not) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_is_pending (const dif_ac_range_check_t ac_range_check, dif_ac_range_check_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_acknowledge_state (const dif_ac_range_check_t *ac_range_check, dif_ac_range_check_irq_state_snapshot_t snapshot)
	Acknowledges all interrupts that were pending at the time of the state snapshot.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_acknowledge_all (const dif_ac_range_check_t *ac_range_check)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_acknowledge (const dif_ac_range_check_t *ac_range_check, dif_ac_range_check_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_force (const dif_ac_range_check_t *ac_range_check, dif_ac_range_check_irq_t, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_get_enabled (const dif_ac_range_check_t ac_range_check, dif_ac_range_check_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_set_enabled (const dif_ac_range_check_t *ac_range_check, dif_ac_range_check_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_disable_all (const dif_ac_range_check_t ac_range_check, dif_ac_range_check_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_ac_range_check_irq_restore_all (const dif_ac_range_check_t ac_range_check, const dif_ac_range_check_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

AC_RANGE_CHECK Device Interface Functions

Definition in file dif_ac_range_check_autogen.h.

Data Structure Documentation

◆ dif_ac_range_check

struct dif_ac_range_check

A handle to ac_range_check.

This type should be treated as opaque by users.

Definition at line 39 of file dif_ac_range_check_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the ac_range_check hardware registers.
dt_ac_range_check_t	dt	The instance, set to `kDtAcRangeCheckCount` if not initialized through `dif_ac_range_check_init_from_dt`.

Macro Definition Documentation

◆ kDifAcRangeCheckIrqDenyCntReached

#define kDifAcRangeCheckIrqDenyCntReached kDtAcRangeCheckIrqDenyCntReached

A ac_range_check interrupt request type.

DEPRECATED Use dt_ac_range_check_irq_t instead. This enumeration exists solely for the transition to dt-based interrupt numbers and will be removed in the future.

The following are defines to keep the types consistent with DT. Deny counter has reached threshold.

Definition at line 140 of file dif_ac_range_check_autogen.h.

Typedef Documentation

◆ dif_ac_range_check_irq_enable_snapshot_t

typedef uint32_t dif_ac_range_check_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_ac_range_check_irq_disable_all() and dif_ac_range_check_irq_restore_all() functions.

Definition at line 250 of file dif_ac_range_check_autogen.h.

◆ dif_ac_range_check_irq_state_snapshot_t

typedef uint32_t dif_ac_range_check_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_ac_range_check_irq_get_state() and dif_ac_range_check_irq_acknowledge_state() functions.

Definition at line 148 of file dif_ac_range_check_autogen.h.

◆ dif_ac_range_check_irq_t

typedef dt_ac_range_check_irq_t dif_ac_range_check_irq_t

Definition at line 126 of file dif_ac_range_check_autogen.h.

◆ dif_ac_range_check_t

typedef struct dif_ac_range_check dif_ac_range_check_t

A handle to ac_range_check.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_ac_range_check_alert

enum dif_ac_range_check_alert

A ac_range_check alert type.

Enumerator
kDifAcRangeCheckAlertRecovCtrlUpdateErr	This recoverable alert is triggered upon detecting an update error in the shadowed Control Register.
kDifAcRangeCheckAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected or the internal counter has an error.

Definition at line 100 of file dif_ac_range_check_autogen.h.

Function Documentation

◆ dif_ac_range_check_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_alert_force	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_alert_t	alert )

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

Parameters

ac_range_check	A ac_range_check handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 64 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_get_dt	(	const dif_ac_range_check_t *	ac_range_check,
		dt_ac_range_check_t *	dt )

Get the DT handle from this DIF.

If this DIF was initialized by dif_ac_range_check_init_from_dt(dt, ..) then this function will return dt. Otherwise it will return an error.

Parameters

	ac_range_check	A ac_range_check handle.
[out]	dt	DT handle.

Returns: kDifBadArg if the DIF has no DT information, kDifOk otherwise.

Definition at line 54 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_init	(	mmio_region_t	base_addr,
		dif_ac_range_check_t *	ac_range_check )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

DEPRECATED This function exists solely for the transition to dt-based DIFs and will be removed in the future.

Definition at line 27 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_init_from_dt	(	dt_ac_range_check_t	dt,
		dif_ac_range_check_t *	ac_range_check )

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

This function does not actuate the hardware.

Parameters

	dt	The devicetable description of the device.
[out]	ac_range_check	Out param for the initialized handle.

Returns: The result of the operation.

Definition at line 41 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_acknowledge	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_t	irq )

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

Parameters

ac_range_check	A ac_range_check handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 214 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_acknowledge_all ( const dif_ac_range_check_t * ac_range_check )

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

Parameters

ac_range_check A ac_range_check handle.

Returns: The result of the operation.

Definition at line 195 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_acknowledge_state	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_state_snapshot_t	snapshot )

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

Parameters

ac_range_check	A ac_range_check handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 153 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_disable_all	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 322 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_force	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 239 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_get_enabled	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 264 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_get_state	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 136 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_get_type	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 117 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_is_pending	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	ac_range_check	A ac_range_check 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 170 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_restore_all	(	const dif_ac_range_check_t *	ac_range_check,
		const dif_ac_range_check_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

ac_range_check	A ac_range_check handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 349 of file dif_ac_range_check_autogen.c.

◆ dif_ac_range_check_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_ac_range_check_irq_set_enabled	(	const dif_ac_range_check_t *	ac_range_check,
		dif_ac_range_check_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 291 of file dif_ac_range_check_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_ac_range_check

Macro Definition Documentation

◆ kDifAcRangeCheckIrqDenyCntReached

Typedef Documentation

◆ dif_ac_range_check_irq_enable_snapshot_t

◆ dif_ac_range_check_irq_state_snapshot_t

◆ dif_ac_range_check_irq_t

◆ dif_ac_range_check_t

Enumeration Type Documentation

◆ dif_ac_range_check_alert

Function Documentation

◆ dif_ac_range_check_alert_force()

◆ dif_ac_range_check_get_dt()

◆ dif_ac_range_check_init()

◆ dif_ac_range_check_init_from_dt()

◆ dif_ac_range_check_irq_acknowledge()

◆ dif_ac_range_check_irq_acknowledge_all()

◆ dif_ac_range_check_irq_acknowledge_state()

◆ dif_ac_range_check_irq_disable_all()

◆ dif_ac_range_check_irq_force()

◆ dif_ac_range_check_irq_get_enabled()

◆ dif_ac_range_check_irq_get_state()

◆ dif_ac_range_check_irq_get_type()

◆ dif_ac_range_check_irq_is_pending()

◆ dif_ac_range_check_irq_restore_all()

◆ dif_ac_range_check_irq_set_enabled()