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

(a649ec5)

ALERT_HANDLER 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_alert_handler
 A handle to alert_handler. More...
 

Typedefs

typedef struct dif_alert_handler dif_alert_handler_t
 A handle to alert_handler. More...
 
typedef enum dif_alert_handler_irq dif_alert_handler_irq_t
 A alert_handler interrupt request type.
 
typedef uint32_t dif_alert_handler_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_alert_handler_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_alert_handler_irq {
  kDifAlertHandlerIrqClassa = 0,
  kDifAlertHandlerIrqClassb = 1,
  kDifAlertHandlerIrqClassc = 2,
  kDifAlertHandlerIrqClassd = 3
}
 A alert_handler interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_init (mmio_region_t base_addr, dif_alert_handler_t *alert_handler)
 Creates a new handle for a(n) alert_handler peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_get_type (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_get_state (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_is_pending (const dif_alert_handler_t *alert_handler, dif_alert_handler_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge_state (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_acknowledge_all (const dif_alert_handler_t *alert_handler)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_force (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_get_enabled (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_set_enabled (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_disable_all (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_restore_all (const dif_alert_handler_t *alert_handler, const dif_alert_handler_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

ALERT_HANDLER Device Interface Functions

Definition in file dif_alert_handler_autogen.h.


Data Structure Documentation

◆ dif_alert_handler

struct dif_alert_handler

A handle to alert_handler.

This type should be treated as opaque by users.

Definition at line 33 of file dif_alert_handler_autogen.h.

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

Typedef Documentation

◆ dif_alert_handler_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_alert_handler_irq_disable_all() and dif_alert_handler_irq_restore_all() functions.

Definition at line 183 of file dif_alert_handler_autogen.h.

◆ dif_alert_handler_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_alert_handler_irq_get_state() and dif_alert_handler_irq_acknowledge_state() functions.

Definition at line 86 of file dif_alert_handler_autogen.h.

◆ dif_alert_handler_t

A handle to alert_handler.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_alert_handler_irq

A alert_handler interrupt request type.

Enumerator
kDifAlertHandlerIrqClassa 

Interrupt state bit of Class A.

Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

kDifAlertHandlerIrqClassb 

Interrupt state bit of Class B.

Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

kDifAlertHandlerIrqClassc 

Interrupt state bit of Class C.

Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

kDifAlertHandlerIrqClassd 

Interrupt state bit of Class D.

Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

Definition at line 56 of file dif_alert_handler_autogen.h.

Function Documentation

◆ dif_alert_handler_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_init ( mmio_region_t  base_addr,
dif_alert_handler_t alert_handler 
)

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

This function does not actuate the hardware.

Parameters
base_addrThe MMIO base address of the alert_handler peripheral.
[out]alert_handlerOut param for the initialized handle.
Returns
The result of the operation.

Definition at line 17 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_t  irq 
)

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

Parameters
alert_handlerA alert_handler handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 139 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge_all ( const dif_alert_handler_t alert_handler)

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

Parameters
alert_handlerA alert_handler handle.
Returns
The result of the operation.

Definition at line 124 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge_state ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_state_snapshot_t  snapshot 
)

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

Parameters
alert_handlerA alert_handler handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 89 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_disable_all ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_enable_snapshot_t snapshot 
)

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

Parameters
alert_handlerA alert_handler handle.
[out]snapshotOut-param for the snapshot; may be NULL.
Returns
The result of the operation.

Definition at line 230 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_force ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_t  irq,
const bool  val 
)

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

Parameters
alert_handlerA alert_handler handle.
irqAn interrupt request.
valValue to be set.
Returns
The result of the operation.

Definition at line 160 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_get_enabled ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

Parameters
alert_handlerA alert_handler handle.
irqAn interrupt request.
[out]stateOut-param toggle state of the interrupt.
Returns
The result of the operation.

Definition at line 181 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_get_state ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_state_snapshot_t snapshot 
)

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

Parameters
alert_handlerA alert_handler handle.
[out]snapshotOut-param for interrupt state snapshot.
Returns
The result of the operation.

Definition at line 75 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_get_type ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_t  irq,
dif_irq_type_t type 
)

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

Parameters
alert_handlerA alert_handler handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 61 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_is_pending ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

Parameters
alert_handlerA alert_handler handle.
irqAn interrupt request.
[out]is_pendingOut-param for whether the interrupt is pending.
Returns
The result of the operation.

Definition at line 103 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_restore_all ( const dif_alert_handler_t alert_handler,
const dif_alert_handler_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
alert_handlerA alert_handler handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 252 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_set_enabled ( const dif_alert_handler_t alert_handler,
dif_alert_handler_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

Parameters
alert_handlerA alert_handler handle.
irqAn interrupt request.
stateThe new toggle state for the interrupt.
Returns
The result of the operation.

Definition at line 204 of file dif_alert_handler_autogen.c.