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"
#include "dt/dt_hmac.h"

Data Structures
struct	dif_hmac
	A handle to hmac. More...

Macros
#define	kDifHmacIrqHmacDone kDtHmacIrqHmacDone
	A hmac interrupt request type.

#define	kDifHmacIrqFifoEmpty kDtHmacIrqFifoEmpty
	The message FIFO is empty.

#define	kDifHmacIrqHmacErr kDtHmacIrqHmacErr
	HMAC error has occurred.

Typedefs
typedef struct dif_hmac	dif_hmac_t
	A handle to hmac.

typedef enum dif_hmac_alert	dif_hmac_alert_t
	A hmac alert type.

Enumerations
enum	dif_hmac_alert { kDifHmacAlertFatalFault = 0 }
	A hmac alert 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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_init_from_dt (dt_hmac_t dt, dif_hmac_t *hmac)
	Creates a new handle for a(n) hmac peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_get_dt (const dif_hmac_t hmac, dt_hmac_t dt)
	Get the DT handle from this DIF.

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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_irq_get_type (const dif_hmac_t hmac, dif_hmac_irq_t, dif_irq_type_t type)
	Returns the type of a given interrupt (i.e., event or status) for this IP.

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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_irq_is_pending (const dif_hmac_t hmac, dif_hmac_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

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.

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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_irq_acknowledge (const dif_hmac_t *hmac, dif_hmac_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_irq_force (const dif_hmac_t *hmac, dif_hmac_irq_t, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_irq_get_enabled (const dif_hmac_t hmac, dif_hmac_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_hmac_irq_set_enabled (const dif_hmac_t *hmac, dif_hmac_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

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.

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.

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 37 of file dif_hmac_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the hmac hardware registers.
dt_hmac_t	dt	The instance, set to `kDtHmacCount` if not initialized through `dif_hmac_init_from_dt`.

Macro Definition Documentation

◆ kDifHmacIrqFifoEmpty

#define kDifHmacIrqFifoEmpty kDtHmacIrqFifoEmpty

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.

Definition at line 138 of file dif_hmac_autogen.h.

◆ kDifHmacIrqHmacDone

#define kDifHmacIrqHmacDone kDtHmacIrqHmacDone

A hmac interrupt request type.

DEPRECATED Use dt_hmac_irq_t instead. This enumeration exists solely for the transition to dt-based interrupt numbers and will be removed in the future.

The following are defines to keep the types consistent with DT. HMAC/SHA-2 has completed.

Definition at line 134 of file dif_hmac_autogen.h.

◆ kDifHmacIrqHmacErr

#define kDifHmacIrqHmacErr kDtHmacIrqHmacErr

HMAC error has occurred.

ERR_CODE register shows which error occurred.

Definition at line 142 of file dif_hmac_autogen.h.

Typedef Documentation

◆ 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

enum 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 98 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

hmac	A hmac handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_hmac_autogen.c.

◆ dif_hmac_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_get_dt	(	const dif_hmac_t *	hmac,
		dt_hmac_t *	dt )

Get the DT handle from this DIF.

If this DIF was initialized by dif_hmac_init_from_dt(dt, ..) then this function will return dt. Otherwise it will return an error.

Parameters

	hmac	A hmac handle.
[out]	dt	DT handle.

Returns: kDifBadArg if the DIF has no DT information, kDifOk otherwise.

Definition at line 52 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_addr	The MMIO base address of the hmac peripheral.
[out]	hmac	Out param for the initialized handle.

Returns: The result of the operation.

DEPRECATED This function exists solely for the transition to dt-based DIFs and will be removed in the future.

Definition at line 25 of file dif_hmac_autogen.c.

◆ dif_hmac_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_hmac_init_from_dt	(	dt_hmac_t	dt,
		dif_hmac_t *	hmac )

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

This function does not actuate the hardware.

Parameters

	dt	The devicetable description of the device.
[out]	hmac	Out param for the initialized handle.

Returns: The result of the operation.

Definition at line 39 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

hmac	A hmac handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 217 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

hmac	A hmac handle.

Returns: The result of the operation.

Definition at line 198 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

hmac	A hmac handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 156 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

	hmac	A hmac handle.
[out]	snapshot	Out-param for the snapshot; may be `NULL`.

Returns: The result of the operation.

Definition at line 325 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

hmac	A hmac handle.
irq	An interrupt request.
val	Value to be set.

Returns: The result of the operation.

Definition at line 242 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

	hmac	A hmac handle.
	irq	An interrupt request.
[out]	state	Out-param toggle state of the interrupt.

Returns: The result of the operation.

Definition at line 267 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

	hmac	A hmac handle.
[out]	snapshot	Out-param for interrupt state snapshot.

Returns: The result of the operation.

Definition at line 139 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

	hmac	A hmac handle.
	irq	An interrupt request.
[out]	type	Out-param for the interrupt type.

Returns: The result of the operation.

Definition at line 120 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

	hmac	A hmac handle.
	irq	An interrupt request.
[out]	is_pending	Out-param for whether the interrupt is pending.

Returns: The result of the operation.

Definition at line 173 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

hmac	A hmac handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 352 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

hmac	A hmac handle.
irq	An interrupt request.
state	The new toggle state for the interrupt.

Returns: The result of the operation.

Definition at line 294 of file dif_hmac_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_hmac

Macro Definition Documentation

◆ kDifHmacIrqFifoEmpty

◆ kDifHmacIrqHmacDone

◆ kDifHmacIrqHmacErr

Typedef Documentation

◆ dif_hmac_t

Enumeration Type Documentation

◆ dif_hmac_alert

Function Documentation

◆ dif_hmac_alert_force()

◆ dif_hmac_get_dt()

◆ dif_hmac_init()

◆ dif_hmac_init_from_dt()

◆ dif_hmac_irq_acknowledge()

◆ dif_hmac_irq_acknowledge_all()

◆ dif_hmac_irq_acknowledge_state()

◆ dif_hmac_irq_disable_all()

◆ dif_hmac_irq_force()

◆ dif_hmac_irq_get_enabled()

◆ dif_hmac_irq_get_state()

◆ dif_hmac_irq_get_type()

◆ dif_hmac_irq_is_pending()

◆ dif_hmac_irq_restore_all()

◆ dif_hmac_irq_set_enabled()