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

#include "hw/top/dt/dt_otp_ctrl.h"
#include "hw/top/otp_ctrl_regs.h"

Data Structures
struct	dt_desc_otp_ctrl
	Description of instances. More...

struct	dt_desc_otp_ctrl.sw_readable_partitions

Macros
#define	TRY_GET_DT(dt, default)
	Return a pointer to the `dt_otp_ctrl_desc_t` structure of the requested `dt` if it's a valid index.

Typedefs
typedef struct dt_desc_otp_ctrl	dt_desc_otp_ctrl_t
	Description of instances.

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.

uint32_t	dt_otp_ctrl_memory_base (dt_otp_ctrl_t dt, dt_otp_ctrl_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_otp_ctrl_memory_size (dt_otp_ctrl_t dt, dt_otp_ctrl_memory_t mem)
	Get the size of a memory.

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.

dt_otp_partition_info_t	dt_otp_ctrl_sw_readable_partition (dt_otp_ctrl_t dt, otp_partition_t partition)
	Get a SW readable OTP partition information.

Detailed Description

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

Definition in file dt_otp_ctrl.c.

Data Structure Documentation

◆ dt_desc_otp_ctrl

struct dt_desc_otp_ctrl

Description of instances.

Definition at line 21 of file dt_otp_ctrl.c.

Data Fields
dt_clock_t	clock[kDtOtpCtrlClockCount]	Clock signal connected to each clock port.
top_darjeeling_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
top_earlgrey_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
top_darjeeling_plic_irq_id_t	first_irq	PLIC ID of the first IRQ of this instance. This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
top_earlgrey_plic_irq_id_t	first_irq	PLIC ID of the first IRQ of this instance. This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
dt_instance_id_t	inst_id	Instance ID.
uint32_t	mem_addr[kDtOtpCtrlMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtOtpCtrlMemoryCount]	Size in bytes of each memory.
uint32_t	reg_addr[kDtOtpCtrlRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtOtpCtrlResetCount]	Reset signal connected to each reset port.
struct dt_desc_otp_ctrl.sw_readable_partitions	sw_readable_partitions	Extension.
struct dt_desc_otp_ctrl	sw_readable_partitions	Extension.

◆ dt_desc_otp_ctrl.sw_readable_partitions

struct dt_desc_otp_ctrl.sw_readable_partitions

Definition at line 40 of file dt_otp_ctrl.c.

Data Fields
dt_otp_partition_info_t	info[15]	List of SW readable OTP partitions.
dt_otp_partition_info_t	info[7]	List of SW readable OTP partitions.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_otp_ctrl_t)0 || (dt) >= kDtOtpCtrlCount) return (default); &otp_ctrl_desc[dt]; })

Return a pointer to the dt_otp_ctrl_desc_t structure of the requested dt if it's a valid index.

Otherwise, this macro will return (i.e. exit the function) with the provided default value.

Definition at line 122 of file dt_otp_ctrl.c.

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 188 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 182 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 200 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 124 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 131 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 167 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 157 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_memory_base()

uint32_t dt_otp_ctrl_memory_base	(	dt_otp_ctrl_t	dt,
		dt_otp_ctrl_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of otp_ctrl.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 143 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_memory_size()

uint32_t dt_otp_ctrl_memory_size	(	dt_otp_ctrl_t	dt,
		dt_otp_ctrl_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of otp_ctrl.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 150 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 136 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 207 of file dt_otp_ctrl.c.

◆ dt_otp_ctrl_sw_readable_partition()

dt_otp_partition_info_t dt_otp_ctrl_sw_readable_partition	(	dt_otp_ctrl_t	dt,
		otp_partition_t	partition )

Get a SW readable OTP partition information.

Parameters

dt	Instance of otp_ctrl.
partition	OTP partition identifier.

Returns: OTP partition information.

Definition at line 221 of file dt_otp_ctrl.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_otp_ctrl

◆ dt_desc_otp_ctrl.sw_readable_partitions

Macro Definition Documentation

◆ TRY_GET_DT

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_memory_base()

◆ dt_otp_ctrl_memory_size()

◆ dt_otp_ctrl_reg_block()

◆ dt_otp_ctrl_reset()

◆ dt_otp_ctrl_sw_readable_partition()