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

(a649ec5)

ROM_CTRL 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_rom_ctrl
 A handle to rom_ctrl. More...
 

Typedefs

typedef struct dif_rom_ctrl dif_rom_ctrl_t
 A handle to rom_ctrl. More...
 
typedef enum dif_rom_ctrl_alert dif_rom_ctrl_alert_t
 A rom_ctrl alert type.
 

Enumerations

enum  dif_rom_ctrl_alert { kDifRomCtrlAlertFatal = 0 }
 A rom_ctrl alert type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_rom_ctrl_init (mmio_region_t base_addr, dif_rom_ctrl_t *rom_ctrl)
 Creates a new handle for a(n) rom_ctrl peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_rom_ctrl_alert_force (const dif_rom_ctrl_t *rom_ctrl, dif_rom_ctrl_alert_t alert)
 Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...
 

Detailed Description

ROM_CTRL Device Interface Functions

Definition in file dif_rom_ctrl_autogen.h.


Data Structure Documentation

◆ dif_rom_ctrl

struct dif_rom_ctrl

A handle to rom_ctrl.

This type should be treated as opaque by users.

Definition at line 33 of file dif_rom_ctrl_autogen.h.

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

Typedef Documentation

◆ dif_rom_ctrl_t

typedef struct dif_rom_ctrl dif_rom_ctrl_t

A handle to rom_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_rom_ctrl_alert

A rom_ctrl alert type.

Enumerator
kDifRomCtrlAlertFatal 

A fatal error.

Fatal alerts are non-recoverable and will be asserted until a hard reset.

Definition at line 56 of file dif_rom_ctrl_autogen.h.

Function Documentation

◆ dif_rom_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_rom_ctrl_alert_force ( const dif_rom_ctrl_t rom_ctrl,
dif_rom_ctrl_alert_t  alert 
)

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

Parameters
rom_ctrlA rom_ctrl handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 28 of file dif_rom_ctrl_autogen.c.

◆ dif_rom_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_rom_ctrl_init ( mmio_region_t  base_addr,
dif_rom_ctrl_t rom_ctrl 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_rom_ctrl_autogen.c.