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

Data Structures
struct	dif_kmac
	A handle to kmac. More...

Macros
#define	kDifKmacIrqKmacDone kDtKmacIrqKmacDone
	A kmac interrupt request type.

#define	kDifKmacIrqFifoEmpty kDtKmacIrqFifoEmpty
	The message FIFO is empty.

#define	kDifKmacIrqKmacErr kDtKmacIrqKmacErr
	KMAC/SHA3 error occurred.

Typedefs
typedef struct dif_kmac	dif_kmac_t
	A handle to kmac.

typedef enum dif_kmac_alert	dif_kmac_alert_t
	A kmac alert type.

Enumerations
enum	dif_kmac_alert { kDifKmacAlertRecovOperationErr = 0 , kDifKmacAlertFatalFaultErr = 1 }
	A kmac alert 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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_kmac_init_from_dt (dt_kmac_t dt, dif_kmac_t *kmac)
	Creates a new handle for a(n) kmac peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_kmac_get_dt (const dif_kmac_t kmac, dt_kmac_t dt)
	Get the DT handle from this DIF.

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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_kmac_irq_get_type (const dif_kmac_t kmac, dif_kmac_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_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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_kmac_irq_is_pending (const dif_kmac_t kmac, dif_kmac_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

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.

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.

OT_WARN_UNUSED_RESULT dif_result_t	dif_kmac_irq_acknowledge (const dif_kmac_t *kmac, dif_kmac_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_kmac_irq_force (const dif_kmac_t *kmac, dif_kmac_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_kmac_irq_get_enabled (const dif_kmac_t kmac, dif_kmac_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_kmac_irq_set_enabled (const dif_kmac_t *kmac, dif_kmac_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

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.

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.

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

Data Fields
mmio_region_t	base_addr	The base address for the kmac hardware registers.
dt_kmac_t	dt	The instance, set to `kDtKmacCount` if not initialized through `dif_kmac_init_from_dt`.

Macro Definition Documentation

◆ kDifKmacIrqFifoEmpty

#define kDifKmacIrqFifoEmpty kDtKmacIrqFifoEmpty

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.

Definition at line 142 of file dif_kmac_autogen.h.

◆ kDifKmacIrqKmacDone

#define kDifKmacIrqKmacDone kDtKmacIrqKmacDone

A kmac interrupt request type.

DEPRECATED Use dt_kmac_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. KMAC/SHA3 absorbing has been completed

Definition at line 138 of file dif_kmac_autogen.h.

◆ kDifKmacIrqKmacErr

#define kDifKmacIrqKmacErr kDtKmacIrqKmacErr

KMAC/SHA3 error occurred.

ERR_CODE register shows the details

Definition at line 146 of file dif_kmac_autogen.h.

Typedef Documentation

◆ 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

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

kmac	A kmac handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_kmac_autogen.c.

◆ dif_kmac_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_get_dt	(	const dif_kmac_t *	kmac,
		dt_kmac_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 52 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_addr	The MMIO base address of the kmac peripheral.
[out]	kmac	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_kmac_autogen.c.

◆ dif_kmac_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_kmac_init_from_dt	(	dt_kmac_t	dt,
		dif_kmac_t *	kmac )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

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

kmac	A kmac handle.
irq	An interrupt request.

Returns: The result of the operation.

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

kmac	A kmac handle.

Returns: The result of the operation.

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

kmac	A kmac handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

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

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

Returns: The result of the operation.

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

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

Returns: The result of the operation.

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

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

Returns: The result of the operation.

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

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

Returns: The result of the operation.

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

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

Returns: The result of the operation.

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

	kmac	A kmac 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 176 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

kmac	A kmac handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

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

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

Returns: The result of the operation.

Definition at line 297 of file dif_kmac_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_kmac

Macro Definition Documentation

◆ kDifKmacIrqFifoEmpty

◆ kDifKmacIrqKmacDone

◆ kDifKmacIrqKmacErr

Typedef Documentation

◆ dif_kmac_t

Enumeration Type Documentation

◆ dif_kmac_alert

Function Documentation

◆ dif_kmac_alert_force()

◆ dif_kmac_get_dt()

◆ dif_kmac_init()

◆ dif_kmac_init_from_dt()

◆ dif_kmac_irq_acknowledge()

◆ dif_kmac_irq_acknowledge_all()

◆ dif_kmac_irq_acknowledge_state()

◆ dif_kmac_irq_disable_all()

◆ dif_kmac_irq_force()

◆ dif_kmac_irq_get_enabled()

◆ dif_kmac_irq_get_state()

◆ dif_kmac_irq_get_type()

◆ dif_kmac_irq_is_pending()

◆ dif_kmac_irq_restore_all()

◆ dif_kmac_irq_set_enabled()