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

(a649ec5)

OTBN 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_otbn
 A handle to otbn. More...
 

Typedefs

typedef struct dif_otbn dif_otbn_t
 A handle to otbn. More...
 
typedef enum dif_otbn_alert dif_otbn_alert_t
 A otbn alert type.
 
typedef enum dif_otbn_irq dif_otbn_irq_t
 A otbn interrupt request type.
 
typedef uint32_t dif_otbn_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_otbn_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_otbn_alert {
  kDifOtbnAlertFatal = 0,
  kDifOtbnAlertRecov = 1
}
 A otbn alert type. More...
 
enum  dif_otbn_irq { kDifOtbnIrqDone = 0 }
 A otbn interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_init (mmio_region_t base_addr, dif_otbn_t *otbn)
 Creates a new handle for a(n) otbn peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_alert_force (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_get_type (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_get_state (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_is_pending (const dif_otbn_t *otbn, dif_otbn_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_acknowledge_state (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_acknowledge_all (const dif_otbn_t *otbn)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_acknowledge (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_force (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_get_enabled (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_set_enabled (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_disable_all (const dif_otbn_t *otbn, dif_otbn_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_otbn_irq_restore_all (const dif_otbn_t *otbn, const dif_otbn_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

OTBN Device Interface Functions

Definition in file dif_otbn_autogen.h.


Data Structure Documentation

◆ dif_otbn

struct dif_otbn

A handle to otbn.

This type should be treated as opaque by users.

Definition at line 32 of file dif_otbn_autogen.h.

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

Typedef Documentation

◆ dif_otbn_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_otbn_irq_disable_all() and dif_otbn_irq_restore_all() functions.

Definition at line 185 of file dif_otbn_autogen.h.

◆ dif_otbn_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_otbn_irq_get_state() and dif_otbn_irq_acknowledge_state() functions.

Definition at line 94 of file dif_otbn_autogen.h.

◆ dif_otbn_t

typedef struct dif_otbn dif_otbn_t

A handle to otbn.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_otbn_alert

A otbn alert type.

Enumerator
kDifOtbnAlertFatal 

A fatal error.

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

kDifOtbnAlertRecov 

A recoverable error.

Just sent once (as the processor stops).

Definition at line 54 of file dif_otbn_autogen.h.

◆ dif_otbn_irq

A otbn interrupt request type.

Enumerator
kDifOtbnIrqDone 

OTBN has completed the operation.

Definition at line 81 of file dif_otbn_autogen.h.

Function Documentation

◆ dif_otbn_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_alert_force ( const dif_otbn_t otbn,
dif_otbn_alert_t  alert 
)

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

Parameters
otbnA otbn handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_otbn_autogen.c.

◆ dif_otbn_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_init ( mmio_region_t  base_addr,
dif_otbn_t otbn 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_acknowledge ( const dif_otbn_t otbn,
dif_otbn_irq_t  irq 
)

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

Parameters
otbnA otbn handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 144 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_acknowledge_all ( const dif_otbn_t otbn)

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

Parameters
otbnA otbn handle.
Returns
The result of the operation.

Definition at line 131 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_acknowledge_state ( const dif_otbn_t otbn,
dif_otbn_irq_state_snapshot_t  snapshot 
)

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

Parameters
otbnA otbn handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 98 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_disable_all ( const dif_otbn_t otbn,
dif_otbn_irq_enable_snapshot_t snapshot 
)

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

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

Definition at line 227 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_force ( const dif_otbn_t otbn,
dif_otbn_irq_t  irq,
const bool  val 
)

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

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

Definition at line 164 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_get_enabled ( const dif_otbn_t otbn,
dif_otbn_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

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

Definition at line 183 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_get_state ( const dif_otbn_t otbn,
dif_otbn_irq_state_snapshot_t snapshot 
)

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

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

Definition at line 85 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_get_type ( const dif_otbn_t otbn,
dif_otbn_irq_t  irq,
dif_irq_type_t type 
)

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

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

Definition at line 73 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_is_pending ( const dif_otbn_t otbn,
dif_otbn_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

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

Definition at line 111 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_restore_all ( const dif_otbn_t otbn,
const dif_otbn_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
otbnA otbn handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 247 of file dif_otbn_autogen.c.

◆ dif_otbn_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_otbn_irq_set_enabled ( const dif_otbn_t otbn,
dif_otbn_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

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

Definition at line 204 of file dif_otbn_autogen.c.