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

(a649ec5)

EDN 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_edn
 A handle to edn. More...
 

Typedefs

typedef struct dif_edn dif_edn_t
 A handle to edn. More...
 
typedef enum dif_edn_alert dif_edn_alert_t
 A edn alert type.
 
typedef enum dif_edn_irq dif_edn_irq_t
 A edn interrupt request type.
 
typedef uint32_t dif_edn_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_edn_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_edn_alert {
  kDifEdnAlertRecovAlert = 0,
  kDifEdnAlertFatalAlert = 1
}
 A edn alert type. More...
 
enum  dif_edn_irq {
  kDifEdnIrqEdnCmdReqDone = 0,
  kDifEdnIrqEdnFatalErr = 1
}
 A edn interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_init (mmio_region_t base_addr, dif_edn_t *edn)
 Creates a new handle for a(n) edn peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_edn_alert_force (const dif_edn_t *edn, dif_edn_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_edn_irq_get_type (const dif_edn_t *edn, dif_edn_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_edn_irq_get_state (const dif_edn_t *edn, dif_edn_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_edn_irq_is_pending (const dif_edn_t *edn, dif_edn_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge_state (const dif_edn_t *edn, dif_edn_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_edn_irq_acknowledge_all (const dif_edn_t *edn)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge (const dif_edn_t *edn, dif_edn_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_edn_irq_force (const dif_edn_t *edn, dif_edn_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_edn_irq_get_enabled (const dif_edn_t *edn, dif_edn_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_edn_irq_set_enabled (const dif_edn_t *edn, dif_edn_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_edn_irq_disable_all (const dif_edn_t *edn, dif_edn_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_edn_irq_restore_all (const dif_edn_t *edn, const dif_edn_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

EDN Device Interface Functions

Definition in file dif_edn_autogen.h.


Data Structure Documentation

◆ dif_edn

struct dif_edn

A handle to edn.

This type should be treated as opaque by users.

Definition at line 32 of file dif_edn_autogen.h.

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

Typedef Documentation

◆ dif_edn_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_edn_irq_disable_all() and dif_edn_irq_restore_all() functions.

Definition at line 188 of file dif_edn_autogen.h.

◆ dif_edn_irq_state_snapshot_t

typedef uint32_t dif_edn_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_edn_irq_get_state() and dif_edn_irq_acknowledge_state() functions.

Definition at line 98 of file dif_edn_autogen.h.

◆ dif_edn_t

typedef struct dif_edn dif_edn_t

A handle to edn.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_edn_alert

A edn alert type.

Enumerator
kDifEdnAlertRecovAlert 

This alert is triggered when entropy bus data matches on consecutive clock cycles.

kDifEdnAlertFatalAlert 

This alert triggers (i) if an illegal state machine state is reached, or (ii) if a fatal integrity failure is detected on the TL-UL bus.

Definition at line 54 of file dif_edn_autogen.h.

◆ dif_edn_irq

A edn interrupt request type.

Enumerator
kDifEdnIrqEdnCmdReqDone 

Asserted when a software CSRNG request has completed.

kDifEdnIrqEdnFatalErr 

Asserted when a FIFO error occurs.

Definition at line 81 of file dif_edn_autogen.h.

Function Documentation

◆ dif_edn_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_alert_force ( const dif_edn_t edn,
dif_edn_alert_t  alert 
)

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

Parameters
ednA edn handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_edn_autogen.c.

◆ dif_edn_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_init ( mmio_region_t  base_addr,
dif_edn_t edn 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_edn_autogen.c.

◆ dif_edn_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge ( const dif_edn_t edn,
dif_edn_irq_t  irq 
)

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

Parameters
ednA edn handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 147 of file dif_edn_autogen.c.

◆ dif_edn_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge_all ( const dif_edn_t edn)

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

Parameters
ednA edn handle.
Returns
The result of the operation.

Definition at line 134 of file dif_edn_autogen.c.

◆ dif_edn_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge_state ( const dif_edn_t edn,
dif_edn_irq_state_snapshot_t  snapshot 
)

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

Parameters
ednA edn handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 101 of file dif_edn_autogen.c.

◆ dif_edn_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_disable_all ( const dif_edn_t edn,
dif_edn_irq_enable_snapshot_t snapshot 
)

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

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

Definition at line 229 of file dif_edn_autogen.c.

◆ dif_edn_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_force ( const dif_edn_t edn,
dif_edn_irq_t  irq,
const bool  val 
)

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

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

Definition at line 166 of file dif_edn_autogen.c.

◆ dif_edn_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_get_enabled ( const dif_edn_t edn,
dif_edn_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

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

Definition at line 185 of file dif_edn_autogen.c.

◆ dif_edn_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_get_state ( const dif_edn_t edn,
dif_edn_irq_state_snapshot_t snapshot 
)

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

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

Definition at line 88 of file dif_edn_autogen.c.

◆ dif_edn_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_get_type ( const dif_edn_t edn,
dif_edn_irq_t  irq,
dif_irq_type_t type 
)

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

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

Definition at line 76 of file dif_edn_autogen.c.

◆ dif_edn_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_is_pending ( const dif_edn_t edn,
dif_edn_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

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

Definition at line 114 of file dif_edn_autogen.c.

◆ dif_edn_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_restore_all ( const dif_edn_t edn,
const dif_edn_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
ednA edn handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 249 of file dif_edn_autogen.c.

◆ dif_edn_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_set_enabled ( const dif_edn_t edn,
dif_edn_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

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

Definition at line 206 of file dif_edn_autogen.c.