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

(a649ec5)

HMAC 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_hmac
 A handle to hmac. More...
 

Typedefs

typedef struct dif_hmac dif_hmac_t
 A handle to hmac. More...
 
typedef enum dif_hmac_alert dif_hmac_alert_t
 A hmac alert type.
 
typedef enum dif_hmac_irq dif_hmac_irq_t
 A hmac interrupt request type.
 
typedef uint32_t dif_hmac_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_hmac_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_hmac_alert { kDifHmacAlertFatalFault = 0 }
 A hmac alert type. More...
 
enum  dif_hmac_irq {
  kDifHmacIrqHmacDone = 0,
  kDifHmacIrqFifoEmpty = 1,
  kDifHmacIrqHmacErr = 2
}
 A hmac interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_init (mmio_region_t base_addr, dif_hmac_t *hmac)
 Creates a new handle for a(n) hmac peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_alert_force (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_get_type (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_get_state (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_is_pending (const dif_hmac_t *hmac, dif_hmac_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_acknowledge_state (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_acknowledge_all (const dif_hmac_t *hmac)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_acknowledge (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_force (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_get_enabled (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_set_enabled (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_disable_all (const dif_hmac_t *hmac, dif_hmac_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_hmac_irq_restore_all (const dif_hmac_t *hmac, const dif_hmac_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

HMAC Device Interface Functions

Definition in file dif_hmac_autogen.h.


Data Structure Documentation

◆ dif_hmac

struct dif_hmac

A handle to hmac.

This type should be treated as opaque by users.

Definition at line 32 of file dif_hmac_autogen.h.

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

Typedef Documentation

◆ dif_hmac_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_hmac_irq_disable_all() and dif_hmac_irq_restore_all() functions.

Definition at line 198 of file dif_hmac_autogen.h.

◆ dif_hmac_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_hmac_irq_get_state() and dif_hmac_irq_acknowledge_state() functions.

Definition at line 107 of file dif_hmac_autogen.h.

◆ dif_hmac_t

typedef struct dif_hmac dif_hmac_t

A handle to hmac.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_hmac_alert

A hmac alert type.

Enumerator
kDifHmacAlertFatalFault 

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

Definition at line 54 of file dif_hmac_autogen.h.

◆ dif_hmac_irq

A hmac interrupt request type.

Enumerator
kDifHmacIrqHmacDone 

HMAC/SHA-2 has completed.

kDifHmacIrqFifoEmpty 

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 HMAC block is not running in HMAC mode and performing the second round of computing the final hash of the outer key as well as the result of the first round using the inner key. ii) Software has not yet written the Process or Stop command to finish the hashing operation. 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.

kDifHmacIrqHmacErr 

HMAC error has occurred.

ERR_CODE register shows which error occurred.

Definition at line 77 of file dif_hmac_autogen.h.

Function Documentation

◆ dif_hmac_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_alert_force ( const dif_hmac_t hmac,
dif_hmac_alert_t  alert 
)

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

Parameters
hmacA hmac handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_hmac_autogen.c.

◆ dif_hmac_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_init ( mmio_region_t  base_addr,
dif_hmac_t hmac 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_acknowledge ( const dif_hmac_t hmac,
dif_hmac_irq_t  irq 
)

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

Parameters
hmacA hmac handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 149 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_acknowledge_all ( const dif_hmac_t hmac)

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

Parameters
hmacA hmac handle.
Returns
The result of the operation.

Definition at line 136 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_acknowledge_state ( const dif_hmac_t hmac,
dif_hmac_irq_state_snapshot_t  snapshot 
)

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

Parameters
hmacA hmac handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 103 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_disable_all ( const dif_hmac_t hmac,
dif_hmac_irq_enable_snapshot_t snapshot 
)

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

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

Definition at line 232 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_force ( const dif_hmac_t hmac,
dif_hmac_irq_t  irq,
const bool  val 
)

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

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

Definition at line 169 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_get_enabled ( const dif_hmac_t hmac,
dif_hmac_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

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

Definition at line 188 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_get_state ( const dif_hmac_t hmac,
dif_hmac_irq_state_snapshot_t snapshot 
)

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

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

Definition at line 90 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_get_type ( const dif_hmac_t hmac,
dif_hmac_irq_t  irq,
dif_irq_type_t type 
)

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

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

Definition at line 78 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_is_pending ( const dif_hmac_t hmac,
dif_hmac_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

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

Definition at line 116 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_restore_all ( const dif_hmac_t hmac,
const dif_hmac_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
hmacA hmac handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 252 of file dif_hmac_autogen.c.

◆ dif_hmac_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_irq_set_enabled ( const dif_hmac_t hmac,
dif_hmac_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

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

Definition at line 209 of file dif_hmac_autogen.c.