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

(a649ec5)

KMAC 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_kmac
 A handle to kmac. More...
 

Typedefs

typedef struct dif_kmac dif_kmac_t
 A handle to kmac. More...
 
typedef enum dif_kmac_alert dif_kmac_alert_t
 A kmac alert type.
 
typedef enum dif_kmac_irq dif_kmac_irq_t
 A kmac interrupt request type.
 
typedef uint32_t dif_kmac_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_kmac_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_kmac_alert {
  kDifKmacAlertRecovOperationErr = 0,
  kDifKmacAlertFatalFaultErr = 1
}
 A kmac alert type. More...
 
enum  dif_kmac_irq {
  kDifKmacIrqKmacDone = 0,
  kDifKmacIrqFifoEmpty = 1,
  kDifKmacIrqKmacErr = 2
}
 A kmac interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_init (mmio_region_t base_addr, dif_kmac_t *kmac)
 Creates a new handle for a(n) kmac peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_alert_force (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_get_type (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_get_state (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_is_pending (const dif_kmac_t *kmac, dif_kmac_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_acknowledge_state (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_acknowledge_all (const dif_kmac_t *kmac)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_acknowledge (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_force (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_get_enabled (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_set_enabled (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_disable_all (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_restore_all (const dif_kmac_t *kmac, const dif_kmac_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

KMAC Device Interface Functions

Definition in file dif_kmac_autogen.h.


Data Structure Documentation

◆ dif_kmac

struct dif_kmac

A handle to kmac.

This type should be treated as opaque by users.

Definition at line 32 of file dif_kmac_autogen.h.

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

Typedef Documentation

◆ dif_kmac_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_kmac_irq_disable_all() and dif_kmac_irq_restore_all() functions.

Definition at line 206 of file dif_kmac_autogen.h.

◆ dif_kmac_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_kmac_irq_get_state() and dif_kmac_irq_acknowledge_state() functions.

Definition at line 115 of file dif_kmac_autogen.h.

◆ dif_kmac_t

typedef struct dif_kmac dif_kmac_t

A handle to kmac.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_kmac_alert

A kmac alert type.

Enumerator
kDifKmacAlertRecovOperationErr 

Alert for KMAC operation error.

It occurs when the shadow registers have update errors.

kDifKmacAlertFatalFaultErr 

This fatal alert is triggered when a fatal error is detected inside the KMAC unit.

Examples for such faults include: i) TL-UL bus integrity fault. ii) Storage errors in the shadow registers. iii) Errors in the message, round, or key counter. iv) Any internal FSM entering an invalid state. v) An error in the redundant lfsr. The KMAC unit cannot recover from such an error and needs to be reset.

Definition at line 54 of file dif_kmac_autogen.h.

◆ dif_kmac_irq

A kmac interrupt request type.

Enumerator
kDifKmacIrqKmacDone 

KMAC/SHA3 absorbing has been completed.

kDifKmacIrqFifoEmpty 

The message FIFO is empty.

This interrupt is raised only if the message FIFO is actually writable by software, i.e., if all of the following conditions are met: i) The KMAC block is not exercised by a hardware application interface. ii) The SHA3 block is in the Absorb state. iii) Software has not yet written the Process command to finish the absorption process. For the interrupt to be raised, the message FIFO must also have been full previously. Otherwise, the hardware empties the FIFO faster than software can fill it and there is no point in interrupting the software to inform it about the message FIFO being empty.

kDifKmacIrqKmacErr 

KMAC/SHA3 error occurred.

ERR_CODE register shows the details

Definition at line 86 of file dif_kmac_autogen.h.

Function Documentation

◆ dif_kmac_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_alert_force ( const dif_kmac_t kmac,
dif_kmac_alert_t  alert 
)

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

Parameters
kmacA kmac handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_kmac_autogen.c.

◆ dif_kmac_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_init ( mmio_region_t  base_addr,
dif_kmac_t kmac 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_acknowledge ( const dif_kmac_t kmac,
dif_kmac_irq_t  irq 
)

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

Parameters
kmacA kmac handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 152 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_acknowledge_all ( const dif_kmac_t kmac)

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

Parameters
kmacA kmac handle.
Returns
The result of the operation.

Definition at line 139 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_acknowledge_state ( const dif_kmac_t kmac,
dif_kmac_irq_state_snapshot_t  snapshot 
)

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

Parameters
kmacA kmac handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 106 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_disable_all ( const dif_kmac_t kmac,
dif_kmac_irq_enable_snapshot_t snapshot 
)

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

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

Definition at line 235 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_force ( const dif_kmac_t kmac,
dif_kmac_irq_t  irq,
const bool  val 
)

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

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

Definition at line 172 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_get_enabled ( const dif_kmac_t kmac,
dif_kmac_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

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

Definition at line 191 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_get_state ( const dif_kmac_t kmac,
dif_kmac_irq_state_snapshot_t snapshot 
)

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

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

Definition at line 93 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_get_type ( const dif_kmac_t kmac,
dif_kmac_irq_t  irq,
dif_irq_type_t type 
)

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

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

Definition at line 81 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_is_pending ( const dif_kmac_t kmac,
dif_kmac_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

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

Definition at line 119 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_restore_all ( const dif_kmac_t kmac,
const dif_kmac_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
kmacA kmac handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 255 of file dif_kmac_autogen.c.

◆ dif_kmac_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_irq_set_enabled ( const dif_kmac_t kmac,
dif_kmac_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

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

Definition at line 212 of file dif_kmac_autogen.c.