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

(a649ec5)

CLKMGR 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_clkmgr
 A handle to clkmgr. More...
 

Typedefs

typedef struct dif_clkmgr dif_clkmgr_t
 A handle to clkmgr. More...
 
typedef enum dif_clkmgr_alert dif_clkmgr_alert_t
 A clkmgr alert type.
 

Enumerations

enum  dif_clkmgr_alert {
  kDifClkmgrAlertRecovFault = 0,
  kDifClkmgrAlertFatalFault = 1
}
 A clkmgr alert type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_init (mmio_region_t base_addr, dif_clkmgr_t *clkmgr)
 Creates a new handle for a(n) clkmgr peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_alert_force (const dif_clkmgr_t *clkmgr, dif_clkmgr_alert_t alert)
 Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...
 

Detailed Description

CLKMGR Device Interface Functions

Definition in file dif_clkmgr_autogen.h.


Data Structure Documentation

◆ dif_clkmgr

struct dif_clkmgr

A handle to clkmgr.

This type should be treated as opaque by users.

Definition at line 32 of file dif_clkmgr_autogen.h.

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

Typedef Documentation

◆ dif_clkmgr_t

typedef struct dif_clkmgr dif_clkmgr_t

A handle to clkmgr.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_clkmgr_alert

A clkmgr alert type.

Enumerator
kDifClkmgrAlertRecovFault 

This recoverable alert is triggered when there are measurement errors.

kDifClkmgrAlertFatalFault 

This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 54 of file dif_clkmgr_autogen.h.

Function Documentation

◆ dif_clkmgr_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_alert_force ( const dif_clkmgr_t clkmgr,
dif_clkmgr_alert_t  alert 
)

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

Parameters
clkmgrA clkmgr handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_clkmgr_autogen.c.

◆ dif_clkmgr_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_init ( mmio_region_t  base_addr,
dif_clkmgr_t clkmgr 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_clkmgr_autogen.c.