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

(a649ec5)

RV_CORE_IBEX 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_rv_core_ibex
 A handle to rv_core_ibex. More...
 

Typedefs

typedef struct dif_rv_core_ibex dif_rv_core_ibex_t
 A handle to rv_core_ibex. More...
 
typedef enum dif_rv_core_ibex_alert dif_rv_core_ibex_alert_t
 A rv_core_ibex alert type.
 

Enumerations

enum  dif_rv_core_ibex_alert {
  kDifRvCoreIbexAlertFatalSwErr = 0,
  kDifRvCoreIbexAlertRecovSwErr = 1,
  kDifRvCoreIbexAlertFatalHwErr = 2,
  kDifRvCoreIbexAlertRecovHwErr = 3
}
 A rv_core_ibex alert type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_rv_core_ibex_init (mmio_region_t base_addr, dif_rv_core_ibex_t *rv_core_ibex)
 Creates a new handle for a(n) rv_core_ibex peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_rv_core_ibex_alert_force (const dif_rv_core_ibex_t *rv_core_ibex, dif_rv_core_ibex_alert_t alert)
 Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...
 

Detailed Description

RV_CORE_IBEX Device Interface Functions

Definition in file dif_rv_core_ibex_autogen.h.


Data Structure Documentation

◆ dif_rv_core_ibex

struct dif_rv_core_ibex

A handle to rv_core_ibex.

This type should be treated as opaque by users.

Definition at line 33 of file dif_rv_core_ibex_autogen.h.

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

Typedef Documentation

◆ dif_rv_core_ibex_t

A handle to rv_core_ibex.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_rv_core_ibex_alert

A rv_core_ibex alert type.

Enumerator
kDifRvCoreIbexAlertFatalSwErr 

Software triggered alert for fatal faults.

kDifRvCoreIbexAlertRecovSwErr 

Software triggered Alert for recoverable faults.

kDifRvCoreIbexAlertFatalHwErr 

Triggered when - Ibex raises alert_major_internal_o - Ibex raises alert_major_bus_o - A double fault is seen (Ibex raises double_fault_seen_o) - A bus integrity error is seen.

kDifRvCoreIbexAlertRecovHwErr 

Triggered when Ibex raises alert_minor_o

Definition at line 56 of file dif_rv_core_ibex_autogen.h.

Function Documentation

◆ dif_rv_core_ibex_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_rv_core_ibex_alert_force ( const dif_rv_core_ibex_t rv_core_ibex,
dif_rv_core_ibex_alert_t  alert 
)

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

Parameters
rv_core_ibexA rv_core_ibex handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 28 of file dif_rv_core_ibex_autogen.c.

◆ dif_rv_core_ibex_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_rv_core_ibex_init ( mmio_region_t  base_addr,
dif_rv_core_ibex_t rv_core_ibex 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_rv_core_ibex_autogen.c.