AON_TIMER 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 "hw/top/dt/aon_timer.h"

Data Structures
struct	dif_aon_timer
	A handle to aon_timer. More...

Macros
#define	kDifAonTimerIrqWkupTimerExpired kDtAonTimerIrqWkupTimerExpired
	A aon_timer interrupt request type.

#define	kDifAonTimerIrqWdogTimerBark kDtAonTimerIrqWdogTimerBark
	Raised if the watchdog timer has hit the bark threshold.

Typedefs
typedef struct dif_aon_timer	dif_aon_timer_t
	A handle to aon_timer.

typedef enum dif_aon_timer_alert	dif_aon_timer_alert_t
	A aon_timer alert type.

typedef dt_aon_timer_irq_t	dif_aon_timer_irq_t

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

Enumerations
enum	dif_aon_timer_alert { kDifAonTimerAlertFatalFault = 0 }
	A aon_timer alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_aon_timer_init (mmio_region_t base_addr, dif_aon_timer_t *aon_timer)
	Creates a new handle for a(n) aon_timer peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_aon_timer_init_from_dt (dt_aon_timer_t dt, dif_aon_timer_t *aon_timer)
	Creates a new handle for a(n) aon_timer peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_aon_timer_get_dt (const dif_aon_timer_t aon_timer, dt_aon_timer_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_aon_timer_alert_force (const dif_aon_timer_t *aon_timer, dif_aon_timer_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_aon_timer_irq_get_type (const dif_aon_timer_t aon_timer, dif_aon_timer_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_aon_timer_irq_get_state (const dif_aon_timer_t aon_timer, dif_aon_timer_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_aon_timer_irq_is_pending (const dif_aon_timer_t aon_timer, dif_aon_timer_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_aon_timer_irq_acknowledge_state (const dif_aon_timer_t *aon_timer, dif_aon_timer_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_aon_timer_irq_acknowledge_all (const dif_aon_timer_t *aon_timer)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_aon_timer_irq_acknowledge (const dif_aon_timer_t *aon_timer, dif_aon_timer_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_aon_timer_irq_force (const dif_aon_timer_t *aon_timer, dif_aon_timer_irq_t, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

Detailed Description

AON_TIMER Device Interface Functions

Definition in file dif_aon_timer_autogen.h.

Data Structure Documentation

◆ dif_aon_timer

struct dif_aon_timer

A handle to aon_timer.

This type should be treated as opaque by users.

Definition at line 37 of file dif_aon_timer_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the aon_timer hardware registers.
dt_aon_timer_t	dt	The instance, set to `kDtAonTimerCount` if not initialized through `dif_aon_timer_init_from_dt`.

Macro Definition Documentation

◆ kDifAonTimerIrqWdogTimerBark

#define kDifAonTimerIrqWdogTimerBark kDtAonTimerIrqWdogTimerBark

Raised if the watchdog timer has hit the bark threshold.

Definition at line 138 of file dif_aon_timer_autogen.h.

◆ kDifAonTimerIrqWkupTimerExpired

#define kDifAonTimerIrqWkupTimerExpired kDtAonTimerIrqWkupTimerExpired

A aon_timer interrupt request type.

DEPRECATED Use dt_aon_timer_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. Raised if the wakeup timer has hit the specified threshold.

Definition at line 134 of file dif_aon_timer_autogen.h.

Typedef Documentation

◆ dif_aon_timer_irq_state_snapshot_t

typedef uint32_t dif_aon_timer_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_aon_timer_irq_get_state() and dif_aon_timer_irq_acknowledge_state() functions.

Definition at line 146 of file dif_aon_timer_autogen.h.

◆ dif_aon_timer_irq_t

typedef dt_aon_timer_irq_t dif_aon_timer_irq_t

Definition at line 120 of file dif_aon_timer_autogen.h.

◆ dif_aon_timer_t

typedef struct dif_aon_timer dif_aon_timer_t

A handle to aon_timer.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_aon_timer_alert

enum dif_aon_timer_alert

A aon_timer alert type.

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

Definition at line 98 of file dif_aon_timer_autogen.h.

Function Documentation

◆ dif_aon_timer_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_alert_force	(	const dif_aon_timer_t *	aon_timer,
		dif_aon_timer_alert_t	alert )

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

Parameters

aon_timer	A aon_timer handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 71 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_get_dt	(	const dif_aon_timer_t *	aon_timer,
		dt_aon_timer_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 61 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_init	(	mmio_region_t	base_addr,
		dif_aon_timer_t *	aon_timer )

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

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the aon_timer peripheral.
[out]	aon_timer	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 34 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_init_from_dt	(	dt_aon_timer_t	dt,
		dif_aon_timer_t *	aon_timer )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 48 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_irq_acknowledge	(	const dif_aon_timer_t *	aon_timer,
		dif_aon_timer_irq_t	irq )

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

Parameters

aon_timer	A aon_timer handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 222 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_irq_acknowledge_all ( const dif_aon_timer_t * aon_timer )

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

Parameters

aon_timer A aon_timer handle.

Returns: The result of the operation.

Definition at line 203 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_irq_acknowledge_state	(	const dif_aon_timer_t *	aon_timer,
		dif_aon_timer_irq_state_snapshot_t	snapshot )

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

Parameters

aon_timer	A aon_timer handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 161 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_irq_force	(	const dif_aon_timer_t *	aon_timer,
		dif_aon_timer_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 247 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_irq_get_state	(	const dif_aon_timer_t *	aon_timer,
		dif_aon_timer_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 144 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_irq_get_type	(	const dif_aon_timer_t *	aon_timer,
		dif_aon_timer_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 125 of file dif_aon_timer_autogen.c.

◆ dif_aon_timer_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_aon_timer_irq_is_pending	(	const dif_aon_timer_t *	aon_timer,
		dif_aon_timer_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	aon_timer	A aon_timer 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 178 of file dif_aon_timer_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_aon_timer

Macro Definition Documentation

◆ kDifAonTimerIrqWdogTimerBark

◆ kDifAonTimerIrqWkupTimerExpired

Typedef Documentation

◆ dif_aon_timer_irq_state_snapshot_t

◆ dif_aon_timer_irq_t

◆ dif_aon_timer_t

Enumeration Type Documentation

◆ dif_aon_timer_alert

Function Documentation

◆ dif_aon_timer_alert_force()

◆ dif_aon_timer_get_dt()

◆ dif_aon_timer_init()

◆ dif_aon_timer_init_from_dt()

◆ dif_aon_timer_irq_acknowledge()

◆ dif_aon_timer_irq_acknowledge_all()

◆ dif_aon_timer_irq_acknowledge_state()

◆ dif_aon_timer_irq_force()

◆ dif_aon_timer_irq_get_state()

◆ dif_aon_timer_irq_get_type()

◆ dif_aon_timer_irq_is_pending()