Software APIs
Data Structures | Typedefs | Enumerations | Functions
dif_aon_timer_autogen.h File Reference

(a649ec5)

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"

Go to the source code of this file.

Data Structures

struct  dif_aon_timer
 A handle to aon_timer. More...
 

Typedefs

typedef struct dif_aon_timer dif_aon_timer_t
 A handle to aon_timer. More...
 
typedef enum dif_aon_timer_alert dif_aon_timer_alert_t
 A aon_timer alert type.
 
typedef enum dif_aon_timer_irq dif_aon_timer_irq_t
 A aon_timer interrupt request type.
 
typedef uint32_t dif_aon_timer_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 

Enumerations

enum  dif_aon_timer_alert { kDifAonTimerAlertFatalFault = 0 }
 A aon_timer alert type. More...
 
enum  dif_aon_timer_irq {
  kDifAonTimerIrqWkupTimerExpired = 0,
  kDifAonTimerIrqWdogTimerBark = 1
}
 A aon_timer interrupt request 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

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 33 of file dif_aon_timer_autogen.h.

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

Typedef Documentation

◆ 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 96 of file dif_aon_timer_autogen.h.

◆ 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

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 56 of file dif_aon_timer_autogen.h.

◆ dif_aon_timer_irq

A aon_timer interrupt request type.

Enumerator
kDifAonTimerIrqWkupTimerExpired 

Raised if the wakeup timer has hit the specified threshold.

kDifAonTimerIrqWdogTimerBark 

Raised if the watchdog timer has hit the bark threshold.

Definition at line 79 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_timerA aon_timer handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 36 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_addrThe MMIO base address of the aon_timer peripheral.
[out]aon_timerOut param for the initialized handle.
Returns
The result of the operation.

Definition at line 25 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_timerA aon_timer handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 161 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_timerA aon_timer handle.
Returns
The result of the operation.

Definition at line 147 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_timerA aon_timer handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 112 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_timerA aon_timer handle.
irqAn interrupt request.
valValue to be set.
Returns
The result of the operation.

Definition at line 182 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_timerA aon_timer handle.
[out]snapshotOut-param for interrupt state snapshot.
Returns
The result of the operation.

Definition at line 98 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_timerA aon_timer handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 84 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_timerA aon_timer handle.
irqAn interrupt request.
[out]is_pendingOut-param for whether the interrupt is pending.
Returns
The result of the operation.

Definition at line 126 of file dif_aon_timer_autogen.c.