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

(a649ec5)

RSTMGR 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_rstmgr
 A handle to rstmgr. More...
 

Typedefs

typedef struct dif_rstmgr dif_rstmgr_t
 A handle to rstmgr. More...
 
typedef enum dif_rstmgr_alert dif_rstmgr_alert_t
 A rstmgr alert type.
 

Enumerations

enum  dif_rstmgr_alert {
  kDifRstmgrAlertFatalFault = 0,
  kDifRstmgrAlertFatalCnstyFault = 1
}
 A rstmgr alert type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_rstmgr_init (mmio_region_t base_addr, dif_rstmgr_t *rstmgr)
 Creates a new handle for a(n) rstmgr peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_rstmgr_alert_force (const dif_rstmgr_t *rstmgr, dif_rstmgr_alert_t alert)
 Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...
 

Detailed Description

RSTMGR Device Interface Functions

Definition in file dif_rstmgr_autogen.h.


Data Structure Documentation

◆ dif_rstmgr

struct dif_rstmgr

A handle to rstmgr.

This type should be treated as opaque by users.

Definition at line 32 of file dif_rstmgr_autogen.h.

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

Typedef Documentation

◆ dif_rstmgr_t

typedef struct dif_rstmgr dif_rstmgr_t

A handle to rstmgr.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_rstmgr_alert

A rstmgr alert type.

Enumerator
kDifRstmgrAlertFatalFault 

This fatal alert is triggered when a fatal structural fault is detected.

Structural faults include errors such as sparse fsm errors and tlul integrity errors.

kDifRstmgrAlertFatalCnstyFault 

This fatal alert is triggered when a reset consistency fault is detected.

It is separated from the category above for clearer error collection and debug.

Definition at line 54 of file dif_rstmgr_autogen.h.

Function Documentation

◆ dif_rstmgr_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_rstmgr_alert_force ( const dif_rstmgr_t rstmgr,
dif_rstmgr_alert_t  alert 
)

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

Parameters
rstmgrA rstmgr handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_rstmgr_autogen.c.

◆ dif_rstmgr_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_rstmgr_init ( mmio_region_t  base_addr,
dif_rstmgr_t rstmgr 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_rstmgr_autogen.c.