Device Tables (DT) for IP otp_ctrl and top earlgrey. More...

#include "dt_api.h"
#include <stdint.h>

Macros
#define	OPENTITAN_OTP_CTRL_HAS_PARTITION_VENDOR_TEST 1
	List of supported hardware features.

#define	OPENTITAN_OTP_CTRL_HAS_PARTITION_CREATOR_SW_CFG 1

#define	OPENTITAN_OTP_CTRL_HAS_PARTITION_OWNER_SW_CFG 1

#define	OPENTITAN_OTP_CTRL_HAS_INIT 1

#define	OPENTITAN_OTP_CTRL_HAS_ENTROPY_READ 1

#define	OPENTITAN_OTP_CTRL_HAS_KEY_DERIVATION 1

#define	OPENTITAN_OTP_CTRL_HAS_PROGRAM 1

#define	OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET0 1

#define	OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET1 1

#define	OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET2 1

#define	OPENTITAN_OTP_CTRL_HAS_PARTITION_LIFE_CYCLE 1

#define	OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_READ_LOCK 1

#define	OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_WRITE_LOCK 1

#define	OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_RECOVERABLE 1

#define	OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_FATAL 1

#define	OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CHECK_TIMEOUT 1

#define	OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_INTEGRITY_CHECK_PERIOD 1

#define	OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CONSISTENCY_CHECK_PERIOD 1

Typedefs
typedef enum dt_otp_ctrl	dt_otp_ctrl_t
	List of instances.

typedef enum dt_otp_ctrl_reg_block	dt_otp_ctrl_reg_block_t
	List of register blocks.

typedef enum dt_otp_ctrl_irq	dt_otp_ctrl_irq_t
	List of IRQs.

typedef enum dt_otp_ctrl_alert	dt_otp_ctrl_alert_t
	List of Alerts.

typedef enum dt_otp_ctrl_clock	dt_otp_ctrl_clock_t
	List of clock ports.

typedef enum dt_otp_ctrl_reset	dt_otp_ctrl_reset_t
	List of reset ports.

Enumerations
enum	dt_otp_ctrl { kDtOtpCtrl = 0 , kDtOtpCtrlFirst = 0 , kDtOtpCtrlCount = 1 }
	List of instances. More...

enum	dt_otp_ctrl_reg_block { kDtOtpCtrlRegBlockCore = 0 , kDtOtpCtrlRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_otp_ctrl_irq { kDtOtpCtrlIrqOtpOperationDone = 0 , kDtOtpCtrlIrqOtpError = 1 , kDtOtpCtrlIrqCount = 2 }
	List of IRQs. More...

enum	dt_otp_ctrl_alert { kDtOtpCtrlAlertFatalMacroError = 0 , kDtOtpCtrlAlertFatalCheckError = 1 , kDtOtpCtrlAlertFatalBusIntegError = 2 , kDtOtpCtrlAlertFatalPrimOtpAlert = 3 , kDtOtpCtrlAlertRecovPrimOtpAlert = 4 , kDtOtpCtrlAlertCount = 5 }
	List of Alerts. More...

enum	dt_otp_ctrl_clock { kDtOtpCtrlClockClk = 0 , kDtOtpCtrlClockEdn = 1 , kDtOtpCtrlClockCount = 2 }
	List of clock ports. More...

enum	dt_otp_ctrl_reset { kDtOtpCtrlResetRst = 0 , kDtOtpCtrlResetEdn = 1 , kDtOtpCtrlResetCount = 2 }
	List of reset ports. More...

Functions
dt_otp_ctrl_t	dt_otp_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the otp_ctrl instance from an instance ID.

dt_instance_id_t	dt_otp_ctrl_instance_id (dt_otp_ctrl_t dt)
	Get the instance ID of an instance.

uint32_t	dt_otp_ctrl_reg_block (dt_otp_ctrl_t dt, dt_otp_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_otp_ctrl_irq_to_plic_id (dt_otp_ctrl_t dt, dt_otp_ctrl_irq_t irq)
	Get the PLIC ID of a otp_ctrl IRQ for a given instance.

dt_otp_ctrl_irq_t	dt_otp_ctrl_irq_from_plic_id (dt_otp_ctrl_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local otp_ctrl IRQ type.

dt_alert_id_t	dt_otp_ctrl_alert_to_alert_id (dt_otp_ctrl_t dt, dt_otp_ctrl_alert_t alert)
	Get the alert ID of a otp_ctrl alert for a given instance.

dt_otp_ctrl_alert_t	dt_otp_ctrl_alert_from_alert_id (dt_otp_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local otp_ctrl alert type.

dt_clock_t	dt_otp_ctrl_clock (dt_otp_ctrl_t dt, dt_otp_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_otp_ctrl_reset (dt_otp_ctrl_t dt, dt_otp_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP otp_ctrl and top earlgrey.

This file contains the type definitions and global functions of the otp_ctrl.

Definition in file dt_otp_ctrl.h.

Macro Definition Documentation

◆ OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CHECK_TIMEOUT

#define OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CHECK_TIMEOUT 1

Definition at line 107 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CONSISTENCY_CHECK_PERIOD

#define OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CONSISTENCY_CHECK_PERIOD 1

Definition at line 109 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_INTEGRITY_CHECK_PERIOD

#define OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_INTEGRITY_CHECK_PERIOD 1

Definition at line 108 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_ENTROPY_READ

#define OPENTITAN_OTP_CTRL_HAS_ENTROPY_READ 1

Definition at line 96 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_FATAL

#define OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_FATAL 1

Definition at line 106 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_RECOVERABLE

#define OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_RECOVERABLE 1

Definition at line 105 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_INIT

#define OPENTITAN_OTP_CTRL_HAS_INIT 1

Definition at line 95 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_KEY_DERIVATION

#define OPENTITAN_OTP_CTRL_HAS_KEY_DERIVATION 1

Definition at line 97 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_CREATOR_SW_CFG

#define OPENTITAN_OTP_CTRL_HAS_PARTITION_CREATOR_SW_CFG 1

Definition at line 93 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_LIFE_CYCLE

#define OPENTITAN_OTP_CTRL_HAS_PARTITION_LIFE_CYCLE 1

Definition at line 102 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_OWNER_SW_CFG

#define OPENTITAN_OTP_CTRL_HAS_PARTITION_OWNER_SW_CFG 1

Definition at line 94 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET0

#define OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET0 1

Definition at line 99 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET1

#define OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET1 1

Definition at line 100 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET2

#define OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET2 1

Definition at line 101 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_VENDOR_TEST

#define OPENTITAN_OTP_CTRL_HAS_PARTITION_VENDOR_TEST 1

List of supported hardware features.

Definition at line 92 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_READ_LOCK

#define OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_READ_LOCK 1

Definition at line 103 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_WRITE_LOCK

#define OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_WRITE_LOCK 1

Definition at line 104 of file dt_otp_ctrl.h.

◆ OPENTITAN_OTP_CTRL_HAS_PROGRAM

#define OPENTITAN_OTP_CTRL_HAS_PROGRAM 1

Definition at line 98 of file dt_otp_ctrl.h.

Typedef Documentation

◆ dt_otp_ctrl_alert_t

typedef enum dt_otp_ctrl_alert dt_otp_ctrl_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_otp_ctrl_clock_t

typedef enum dt_otp_ctrl_clock dt_otp_ctrl_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_otp_ctrl_irq_t

typedef enum dt_otp_ctrl_irq dt_otp_ctrl_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_otp_ctrl_reg_block_t

typedef enum dt_otp_ctrl_reg_block dt_otp_ctrl_reg_block_t

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

◆ dt_otp_ctrl_reset_t

typedef enum dt_otp_ctrl_reset dt_otp_ctrl_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_otp_ctrl

enum dt_otp_ctrl

List of instances.

Enumerator
kDtOtpCtrl	otp_ctrl

Definition at line 23 of file dt_otp_ctrl.h.

◆ dt_otp_ctrl_alert

enum dt_otp_ctrl_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

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

Definition at line 58 of file dt_otp_ctrl.h.

◆ dt_otp_ctrl_clock

enum dt_otp_ctrl_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtOtpCtrlClockClk	Clock port clk_i.
kDtOtpCtrlClockEdn	Clock port clk_edn_i.

Definition at line 72 of file dt_otp_ctrl.h.

◆ dt_otp_ctrl_irq

enum dt_otp_ctrl_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator

kDtOtpCtrlIrqOtpOperationDone

A direct access command or digest calculation operation has completed.

kDtOtpCtrlIrqOtpError

An error has occurred in the OTP controller.

Check the !!ERR_CODE register to get more information.

Definition at line 47 of file dt_otp_ctrl.h.

◆ dt_otp_ctrl_reg_block

enum dt_otp_ctrl_reg_block

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 34 of file dt_otp_ctrl.h.

◆ dt_otp_ctrl_reset

enum dt_otp_ctrl_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtOtpCtrlResetRst	Reset port rst_ni.
kDtOtpCtrlResetEdn	Reset port rst_edn_ni.

Definition at line 83 of file dt_otp_ctrl.h.

Function Documentation

◆ dt_otp_ctrl_alert_from_alert_id()

dt_otp_ctrl_alert_t dt_otp_ctrl_alert_from_alert_id	(	dt_otp_ctrl_t	dt,
		dt_alert_id_t	alert )

Convert a global alert ID to a local otp_ctrl alert type.

Parameters

dt	Instance of otp_ctrl.
alert	A global alert ID that belongs to this instance.

Returns: The otp_ctrl alert, or kDtOtpCtrlAlertCount.

Note: This function assumes that the global alert ID belongs to the instance of otp_ctrl passed in parameter. In other words, it must be the case that dt_otp_ctrl_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtOtpCtrlAlertCount.

Definition at line 117 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_alert_to_alert_id()

dt_alert_id_t dt_otp_ctrl_alert_to_alert_id	(	dt_otp_ctrl_t	dt,
		dt_otp_ctrl_alert_t	alert )

Get the alert ID of a otp_ctrl alert for a given instance.

Note: This function only makes sense if the instance is connected to the Alert Handler. For any instances where the instance is not connected, the return value is unspecified.

Parameters

dt	Instance of otp_ctrl.
alert	A otp_ctrl alert.

Returns: The Alert Handler alert ID of the alert of this instance.

Definition at line 111 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_clock()

dt_clock_t dt_otp_ctrl_clock	(	dt_otp_ctrl_t	dt,
		dt_otp_ctrl_clock_t	clk )

Get the clock signal connected to a clock port of an instance.

Parameters

dt	Instance of otp_ctrl.
clk	Clock port.

Returns: Clock signal.

Definition at line 129 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_from_instance_id()

dt_otp_ctrl_t dt_otp_ctrl_from_instance_id ( dt_instance_id_t inst_id )

Get the otp_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A otp_ctrl instance.

Note: This function only makes sense if the instance ID has device type otp_ctrl, otherwise the returned value is unspecified.

Definition at line 67 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_instance_id()

dt_instance_id_t dt_otp_ctrl_instance_id ( dt_otp_ctrl_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of otp_ctrl.

Returns: The instance ID of that instance.

Definition at line 74 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_irq_from_plic_id()

dt_otp_ctrl_irq_t dt_otp_ctrl_irq_from_plic_id	(	dt_otp_ctrl_t	dt,
		dt_plic_irq_id_t	irq )

Convert a global IRQ ID to a local otp_ctrl IRQ type.

Parameters

dt	Instance of otp_ctrl.
irq	A PLIC ID that belongs to this instance.

Returns: The otp_ctrl IRQ, or kDtOtpCtrlIrqCount.

Note: This function assumes that the PLIC ID belongs to the instance of otp_ctrl passed in parameter. In other words, it must be the case that dt_otp_ctrl_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtOtpCtrlIrqCount.

Definition at line 96 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_irq_to_plic_id()

dt_plic_irq_id_t dt_otp_ctrl_irq_to_plic_id	(	dt_otp_ctrl_t	dt,
		dt_otp_ctrl_irq_t	irq )

Get the PLIC ID of a otp_ctrl IRQ for a given instance.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters

dt	Instance of otp_ctrl.
irq	A otp_ctrl IRQ.

Returns: The PLIC ID of the IRQ of this instance.

Definition at line 86 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_reg_block()

uint32_t dt_otp_ctrl_reg_block	(	dt_otp_ctrl_t	dt,
		dt_otp_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of otp_ctrl.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 79 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_reset()

dt_reset_t dt_otp_ctrl_reset	(	dt_otp_ctrl_t	dt,
		dt_otp_ctrl_reset_t	rst )

Get the reset signal connected to a reset port of an instance.

Parameters

dt	Instance of otp_ctrl.
rst	Reset port.

Returns: Reset signal.

Definition at line 136 of file dt_otp_ctrl.c.

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CHECK_TIMEOUT

◆ OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_CONSISTENCY_CHECK_PERIOD

◆ OPENTITAN_OTP_CTRL_HAS_BACKGROUND_CHECK_INTEGRITY_CHECK_PERIOD

◆ OPENTITAN_OTP_CTRL_HAS_ENTROPY_READ

◆ OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_FATAL

◆ OPENTITAN_OTP_CTRL_HAS_ERROR_HANDLING_RECOVERABLE

◆ OPENTITAN_OTP_CTRL_HAS_INIT

◆ OPENTITAN_OTP_CTRL_HAS_KEY_DERIVATION

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_CREATOR_SW_CFG

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_LIFE_CYCLE

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_OWNER_SW_CFG

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET0

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET1

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_SECRET2

◆ OPENTITAN_OTP_CTRL_HAS_PARTITION_VENDOR_TEST

◆ OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_READ_LOCK

◆ OPENTITAN_OTP_CTRL_HAS_PARTITIONS_FEATURE_WRITE_LOCK

◆ OPENTITAN_OTP_CTRL_HAS_PROGRAM

Typedef Documentation

◆ dt_otp_ctrl_alert_t

◆ dt_otp_ctrl_clock_t

◆ dt_otp_ctrl_irq_t

◆ dt_otp_ctrl_reg_block_t

◆ dt_otp_ctrl_reset_t

Enumeration Type Documentation

◆ dt_otp_ctrl

◆ dt_otp_ctrl_alert

◆ dt_otp_ctrl_clock

◆ dt_otp_ctrl_irq

◆ dt_otp_ctrl_reg_block

◆ dt_otp_ctrl_reset

Function Documentation

◆ dt_otp_ctrl_alert_from_alert_id()

◆ dt_otp_ctrl_alert_to_alert_id()

◆ dt_otp_ctrl_clock()

◆ dt_otp_ctrl_from_instance_id()

◆ dt_otp_ctrl_instance_id()

◆ dt_otp_ctrl_irq_from_plic_id()

◆ dt_otp_ctrl_irq_to_plic_id()

◆ dt_otp_ctrl_reg_block()

◆ dt_otp_ctrl_reset()