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

(a649ec5)

KEYMGR 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_keymgr
 A handle to keymgr. More...
 

Typedefs

typedef struct dif_keymgr dif_keymgr_t
 A handle to keymgr. More...
 
typedef enum dif_keymgr_alert dif_keymgr_alert_t
 A keymgr alert type.
 
typedef enum dif_keymgr_irq dif_keymgr_irq_t
 A keymgr interrupt request type.
 
typedef uint32_t dif_keymgr_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_keymgr_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_keymgr_alert {
  kDifKeymgrAlertRecovOperationErr = 0,
  kDifKeymgrAlertFatalFaultErr = 1
}
 A keymgr alert type. More...
 
enum  dif_keymgr_irq { kDifKeymgrIrqOpDone = 0 }
 A keymgr interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_init (mmio_region_t base_addr, dif_keymgr_t *keymgr)
 Creates a new handle for a(n) keymgr peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_alert_force (const dif_keymgr_t *keymgr, dif_keymgr_alert_t alert)
 Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_get_type (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_get_state (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_is_pending (const dif_keymgr_t *keymgr, dif_keymgr_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_acknowledge_state (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_acknowledge_all (const dif_keymgr_t *keymgr)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_acknowledge (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_force (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_get_enabled (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_set_enabled (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_disable_all (const dif_keymgr_t *keymgr, dif_keymgr_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_keymgr_irq_restore_all (const dif_keymgr_t *keymgr, const dif_keymgr_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

KEYMGR Device Interface Functions

Definition in file dif_keymgr_autogen.h.


Data Structure Documentation

◆ dif_keymgr

struct dif_keymgr

A handle to keymgr.

This type should be treated as opaque by users.

Definition at line 32 of file dif_keymgr_autogen.h.

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

Typedef Documentation

◆ dif_keymgr_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_keymgr_irq_disable_all() and dif_keymgr_irq_restore_all() functions.

Definition at line 186 of file dif_keymgr_autogen.h.

◆ dif_keymgr_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_keymgr_irq_get_state() and dif_keymgr_irq_acknowledge_state() functions.

Definition at line 94 of file dif_keymgr_autogen.h.

◆ dif_keymgr_t

typedef struct dif_keymgr dif_keymgr_t

A handle to keymgr.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_keymgr_alert

A keymgr alert type.

Enumerator
kDifKeymgrAlertRecovOperationErr 

Alert for key manager operation errors.

These errors could have been caused by software

kDifKeymgrAlertFatalFaultErr 

Alert for key manager faults.

These errors cannot be caused by software

Definition at line 54 of file dif_keymgr_autogen.h.

◆ dif_keymgr_irq

A keymgr interrupt request type.

Enumerator
kDifKeymgrIrqOpDone 

Operation complete.

Definition at line 81 of file dif_keymgr_autogen.h.

Function Documentation

◆ dif_keymgr_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_alert_force ( const dif_keymgr_t keymgr,
dif_keymgr_alert_t  alert 
)

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

Parameters
keymgrA keymgr handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_keymgr_autogen.c.

◆ dif_keymgr_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_init ( mmio_region_t  base_addr,
dif_keymgr_t keymgr 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_acknowledge ( const dif_keymgr_t keymgr,
dif_keymgr_irq_t  irq 
)

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

Parameters
keymgrA keymgr handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 145 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_acknowledge_all ( const dif_keymgr_t keymgr)

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

Parameters
keymgrA keymgr handle.
Returns
The result of the operation.

Definition at line 132 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_acknowledge_state ( const dif_keymgr_t keymgr,
dif_keymgr_irq_state_snapshot_t  snapshot 
)

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

Parameters
keymgrA keymgr handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 99 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_disable_all ( const dif_keymgr_t keymgr,
dif_keymgr_irq_enable_snapshot_t snapshot 
)

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

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

Definition at line 231 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_force ( const dif_keymgr_t keymgr,
dif_keymgr_irq_t  irq,
const bool  val 
)

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

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

Definition at line 165 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_get_enabled ( const dif_keymgr_t keymgr,
dif_keymgr_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

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

Definition at line 184 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_get_state ( const dif_keymgr_t keymgr,
dif_keymgr_irq_state_snapshot_t snapshot 
)

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

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

Definition at line 86 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_get_type ( const dif_keymgr_t keymgr,
dif_keymgr_irq_t  irq,
dif_irq_type_t type 
)

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

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

Definition at line 73 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_is_pending ( const dif_keymgr_t keymgr,
dif_keymgr_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

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

Definition at line 112 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_restore_all ( const dif_keymgr_t keymgr,
const dif_keymgr_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
keymgrA keymgr handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 251 of file dif_keymgr_autogen.c.

◆ dif_keymgr_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_keymgr_irq_set_enabled ( const dif_keymgr_t keymgr,
dif_keymgr_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

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

Definition at line 206 of file dif_keymgr_autogen.c.