OTP_CTRL 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_otp_ctrl.h"

Go to the source code of this file.

Data Structures
struct	dif_otp_ctrl
	A handle to otp_ctrl. More...

Macros
#define	kDifOtpCtrlIrqOtpOperationDone kDtOtpCtrlIrqOtpOperationDone
	A otp_ctrl interrupt request type.

#define	kDifOtpCtrlIrqOtpError kDtOtpCtrlIrqOtpError
	An error has occurred in the OTP controller.

Typedefs
typedef struct dif_otp_ctrl	dif_otp_ctrl_t
	A handle to otp_ctrl.

typedef enum dif_otp_ctrl_alert	dif_otp_ctrl_alert_t
	A otp_ctrl alert type.

typedef dt_otp_ctrl_irq_t	dif_otp_ctrl_irq_t

typedef uint32_t	dif_otp_ctrl_irq_state_snapshot_t
	A snapshot of the state of the interrupts for this IP.

typedef uint32_t	dif_otp_ctrl_irq_enable_snapshot_t
	A snapshot of the enablement state of the interrupts for this IP.

Enumerations
enum	dif_otp_ctrl_alert { kDifOtpCtrlAlertFatalMacroError = 0 , kDifOtpCtrlAlertFatalCheckError = 1 , kDifOtpCtrlAlertFatalBusIntegError = 2 , kDifOtpCtrlAlertFatalPrimOtpAlert = 3 , kDifOtpCtrlAlertRecovPrimOtpAlert = 4 }
	A otp_ctrl alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_init (mmio_region_t base_addr, dif_otp_ctrl_t *otp_ctrl)
	Creates a new handle for a(n) otp_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_init_from_dt (dt_otp_ctrl_t dt, dif_otp_ctrl_t *otp_ctrl)
	Creates a new handle for a(n) otp_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_get_dt (const dif_otp_ctrl_t otp_ctrl, dt_otp_ctrl_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_alert_force (const dif_otp_ctrl_t *otp_ctrl, dif_otp_ctrl_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_otp_ctrl_irq_get_type (const dif_otp_ctrl_t otp_ctrl, dif_otp_ctrl_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_otp_ctrl_irq_get_state (const dif_otp_ctrl_t otp_ctrl, dif_otp_ctrl_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_otp_ctrl_irq_is_pending (const dif_otp_ctrl_t otp_ctrl, dif_otp_ctrl_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_irq_acknowledge_state (const dif_otp_ctrl_t *otp_ctrl, dif_otp_ctrl_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_otp_ctrl_irq_acknowledge_all (const dif_otp_ctrl_t *otp_ctrl)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_irq_acknowledge (const dif_otp_ctrl_t *otp_ctrl, dif_otp_ctrl_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_irq_force (const dif_otp_ctrl_t *otp_ctrl, dif_otp_ctrl_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_otp_ctrl_irq_get_enabled (const dif_otp_ctrl_t otp_ctrl, dif_otp_ctrl_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_irq_set_enabled (const dif_otp_ctrl_t *otp_ctrl, dif_otp_ctrl_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_irq_disable_all (const dif_otp_ctrl_t otp_ctrl, dif_otp_ctrl_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_otp_ctrl_irq_restore_all (const dif_otp_ctrl_t otp_ctrl, const dif_otp_ctrl_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

OTP_CTRL Device Interface Functions

Definition in file dif_otp_ctrl_autogen.h.

Data Structure Documentation

◆ dif_otp_ctrl

struct dif_otp_ctrl

A handle to otp_ctrl.

This type should be treated as opaque by users.

Definition at line 38 of file dif_otp_ctrl_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the otp_ctrl hardware registers.
dt_otp_ctrl_t	dt	The instance, set to `kDtOtpCtrlCount` if not initialized through `dif_otp_ctrl_init_from_dt`.

Macro Definition Documentation

◆ kDifOtpCtrlIrqOtpError

#define kDifOtpCtrlIrqOtpError kDtOtpCtrlIrqOtpError

An error has occurred in the OTP controller.

Check the !!ERR_CODE register to get more information.

Definition at line 155 of file dif_otp_ctrl_autogen.h.

◆ kDifOtpCtrlIrqOtpOperationDone

#define kDifOtpCtrlIrqOtpOperationDone kDtOtpCtrlIrqOtpOperationDone

A otp_ctrl interrupt request type.

DEPRECATED Use dt_otp_ctrl_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. A direct access command or digest calculation operation has completed.

Definition at line 151 of file dif_otp_ctrl_autogen.h.

Typedef Documentation

◆ dif_otp_ctrl_irq_enable_snapshot_t

typedef uint32_t dif_otp_ctrl_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_otp_ctrl_irq_disable_all() and dif_otp_ctrl_irq_restore_all() functions.

Definition at line 265 of file dif_otp_ctrl_autogen.h.

◆ dif_otp_ctrl_irq_state_snapshot_t

typedef uint32_t dif_otp_ctrl_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_otp_ctrl_irq_get_state() and dif_otp_ctrl_irq_acknowledge_state() functions.

Definition at line 163 of file dif_otp_ctrl_autogen.h.

◆ dif_otp_ctrl_irq_t

typedef dt_otp_ctrl_irq_t dif_otp_ctrl_irq_t

Definition at line 137 of file dif_otp_ctrl_autogen.h.

◆ dif_otp_ctrl_t

typedef struct dif_otp_ctrl dif_otp_ctrl_t

A handle to otp_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_otp_ctrl_alert

enum dif_otp_ctrl_alert

A otp_ctrl alert type.

Enumerator
kDifOtpCtrlAlertFatalMacroError	This alert triggers if hardware detects an uncorrectable error during an OTP transaction, for example an uncorrectable ECC error in the OTP array.
kDifOtpCtrlAlertFatalCheckError	This alert triggers if any of the background checks fails. This includes the digest checks and concurrent ECC checks in the buffer registers.
kDifOtpCtrlAlertFatalBusIntegError	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
kDifOtpCtrlAlertFatalPrimOtpAlert	Fatal alert triggered inside the OTP primitive, including fatal TL-UL bus integrity faults of the test interface.
kDifOtpCtrlAlertRecovPrimOtpAlert	Recoverable alert triggered inside the OTP primitive.

Definition at line 99 of file dif_otp_ctrl_autogen.h.

Function Documentation

◆ dif_otp_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_alert_force	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_alert_t	alert )

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

Parameters

otp_ctrl	A otp_ctrl handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 63 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_get_dt	(	const dif_otp_ctrl_t *	otp_ctrl,
		dt_otp_ctrl_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 53 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_init	(	mmio_region_t	base_addr,
		dif_otp_ctrl_t *	otp_ctrl )

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

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the otp_ctrl peripheral.
[out]	otp_ctrl	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 26 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_init_from_dt	(	dt_otp_ctrl_t	dt,
		dif_otp_ctrl_t *	otp_ctrl )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 40 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_t	irq )

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

Parameters

otp_ctrl	A otp_ctrl handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 226 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge_all ( const dif_otp_ctrl_t * otp_ctrl )

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

Parameters

otp_ctrl A otp_ctrl handle.

Returns: The result of the operation.

Definition at line 207 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge_state	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_state_snapshot_t	snapshot )

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

Parameters

otp_ctrl	A otp_ctrl handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 165 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_disable_all	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 334 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_force	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 251 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_get_enabled	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 276 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_get_state	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 148 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_get_type	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 129 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_is_pending	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	otp_ctrl	A otp_ctrl 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 182 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_restore_all	(	const dif_otp_ctrl_t *	otp_ctrl,
		const dif_otp_ctrl_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

otp_ctrl	A otp_ctrl handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 361 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_set_enabled	(	const dif_otp_ctrl_t *	otp_ctrl,
		dif_otp_ctrl_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 303 of file dif_otp_ctrl_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_otp_ctrl

Macro Definition Documentation

◆ kDifOtpCtrlIrqOtpError

◆ kDifOtpCtrlIrqOtpOperationDone

Typedef Documentation

◆ dif_otp_ctrl_irq_enable_snapshot_t

◆ dif_otp_ctrl_irq_state_snapshot_t

◆ dif_otp_ctrl_irq_t

◆ dif_otp_ctrl_t

Enumeration Type Documentation

◆ dif_otp_ctrl_alert

Function Documentation

◆ dif_otp_ctrl_alert_force()

◆ dif_otp_ctrl_get_dt()

◆ dif_otp_ctrl_init()

◆ dif_otp_ctrl_init_from_dt()

◆ dif_otp_ctrl_irq_acknowledge()

◆ dif_otp_ctrl_irq_acknowledge_all()

◆ dif_otp_ctrl_irq_acknowledge_state()

◆ dif_otp_ctrl_irq_disable_all()

◆ dif_otp_ctrl_irq_force()

◆ dif_otp_ctrl_irq_get_enabled()

◆ dif_otp_ctrl_irq_get_state()

◆ dif_otp_ctrl_irq_get_type()

◆ dif_otp_ctrl_irq_is_pending()

◆ dif_otp_ctrl_irq_restore_all()

◆ dif_otp_ctrl_irq_set_enabled()