Device Tables (DT) for IP keymgr_dpe and top darjeeling. More...

#include "hw/top/dt/dt_api.h"
#include <stdint.h>

Typedefs
typedef enum dt_keymgr_dpe	dt_keymgr_dpe_t
	List of instances.

typedef enum dt_keymgr_dpe_reg_block	dt_keymgr_dpe_reg_block_t
	List of register blocks.

typedef enum dt_keymgr_dpe_memory	dt_keymgr_dpe_memory_t
	List of memories.

typedef enum dt_keymgr_dpe_irq	dt_keymgr_dpe_irq_t
	List of IRQs.

typedef enum dt_keymgr_dpe_alert	dt_keymgr_dpe_alert_t
	List of Alerts.

typedef enum dt_keymgr_dpe_clock	dt_keymgr_dpe_clock_t
	List of clock ports.

typedef enum dt_keymgr_dpe_reset	dt_keymgr_dpe_reset_t
	List of reset ports.

Enumerations
enum	dt_keymgr_dpe { kDtKeymgrDpe = 0 , kDtKeymgrDpeFirst = 0 , kDtKeymgrDpeCount = 1 }
	List of instances. More...

enum	dt_keymgr_dpe_reg_block { kDtKeymgrDpeRegBlockCore = 0 , kDtKeymgrDpeRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_keymgr_dpe_memory { kDtKeymgrDpeMemoryCount = 0 }
	List of memories. More...

enum	dt_keymgr_dpe_irq { kDtKeymgrDpeIrqOpDone = 0 , kDtKeymgrDpeIrqCount = 1 }
	List of IRQs. More...

enum	dt_keymgr_dpe_alert { kDtKeymgrDpeAlertRecovOperationErr = 0 , kDtKeymgrDpeAlertFatalFaultErr = 1 , kDtKeymgrDpeAlertCount = 2 }
	List of Alerts. More...

enum	dt_keymgr_dpe_clock { kDtKeymgrDpeClockClk = 0 , kDtKeymgrDpeClockEdn = 1 , kDtKeymgrDpeClockCount = 2 }
	List of clock ports. More...

enum	dt_keymgr_dpe_reset { kDtKeymgrDpeResetRst = 0 , kDtKeymgrDpeResetEdn = 1 , kDtKeymgrDpeResetCount = 2 }
	List of reset ports. More...

Functions
dt_keymgr_dpe_t	dt_keymgr_dpe_from_instance_id (dt_instance_id_t inst_id)
	Get the keymgr_dpe instance from an instance ID.

dt_instance_id_t	dt_keymgr_dpe_instance_id (dt_keymgr_dpe_t dt)
	Get the instance ID of an instance.

uint32_t	dt_keymgr_dpe_reg_block (dt_keymgr_dpe_t dt, dt_keymgr_dpe_reg_block_t reg_block)
	Get the register base address of an instance.

uint32_t	dt_keymgr_dpe_memory_base (dt_keymgr_dpe_t dt, dt_keymgr_dpe_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_keymgr_dpe_memory_size (dt_keymgr_dpe_t dt, dt_keymgr_dpe_memory_t mem)
	Get the size of a memory.

dt_plic_irq_id_t	dt_keymgr_dpe_irq_to_plic_id (dt_keymgr_dpe_t dt, dt_keymgr_dpe_irq_t irq)
	Get the PLIC ID of a keymgr_dpe IRQ for a given instance.

dt_keymgr_dpe_irq_t	dt_keymgr_dpe_irq_from_plic_id (dt_keymgr_dpe_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local keymgr_dpe IRQ type.

dt_alert_id_t	dt_keymgr_dpe_alert_to_alert_id (dt_keymgr_dpe_t dt, dt_keymgr_dpe_alert_t alert)
	Get the alert ID of a keymgr_dpe alert for a given instance.

dt_keymgr_dpe_alert_t	dt_keymgr_dpe_alert_from_alert_id (dt_keymgr_dpe_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local keymgr_dpe alert type.

dt_clock_t	dt_keymgr_dpe_clock (dt_keymgr_dpe_t dt, dt_keymgr_dpe_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_keymgr_dpe_reset (dt_keymgr_dpe_t dt, dt_keymgr_dpe_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP keymgr_dpe and top darjeeling.

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

Definition in file dt_keymgr_dpe.h.

Typedef Documentation

◆ dt_keymgr_dpe_alert_t

typedef enum dt_keymgr_dpe_alert dt_keymgr_dpe_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_keymgr_dpe_clock_t

typedef enum dt_keymgr_dpe_clock dt_keymgr_dpe_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_keymgr_dpe_irq_t

typedef enum dt_keymgr_dpe_irq dt_keymgr_dpe_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_keymgr_dpe_memory_t

typedef enum dt_keymgr_dpe_memory dt_keymgr_dpe_memory_t

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

◆ dt_keymgr_dpe_reg_block_t

typedef enum dt_keymgr_dpe_reg_block dt_keymgr_dpe_reg_block_t

List of register blocks.

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

◆ dt_keymgr_dpe_reset_t

typedef enum dt_keymgr_dpe_reset dt_keymgr_dpe_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_keymgr_dpe

enum dt_keymgr_dpe

List of instances.

Enumerator
kDtKeymgrDpe	keymgr_dpe

Definition at line 29 of file dt_keymgr_dpe.h.

◆ dt_keymgr_dpe_alert

enum dt_keymgr_dpe_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator

kDtKeymgrDpeAlertRecovOperationErr

Alert for key manager operation errors.

These errors could have been caused by software

kDtKeymgrDpeAlertFatalFaultErr

Alert for key manager faults.

These errors cannot be caused by software

Definition at line 72 of file dt_keymgr_dpe.h.

◆ dt_keymgr_dpe_clock

enum dt_keymgr_dpe_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtKeymgrDpeClockClk	Clock port clk_i.
kDtKeymgrDpeClockEdn	Clock port clk_edn_i.

Definition at line 84 of file dt_keymgr_dpe.h.

◆ dt_keymgr_dpe_irq

enum dt_keymgr_dpe_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtKeymgrDpeIrqOpDone	Operation complete.

Definition at line 62 of file dt_keymgr_dpe.h.

◆ dt_keymgr_dpe_memory

enum dt_keymgr_dpe_memory

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 53 of file dt_keymgr_dpe.h.

◆ dt_keymgr_dpe_reg_block

enum dt_keymgr_dpe_reg_block

List of register blocks.

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

Definition at line 40 of file dt_keymgr_dpe.h.

◆ dt_keymgr_dpe_reset

enum dt_keymgr_dpe_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtKeymgrDpeResetRst	Reset port rst_ni.
kDtKeymgrDpeResetEdn	Reset port rst_edn_ni.

Definition at line 95 of file dt_keymgr_dpe.h.

Function Documentation

◆ dt_keymgr_dpe_alert_from_alert_id()

dt_keymgr_dpe_alert_t dt_keymgr_dpe_alert_from_alert_id	(	dt_keymgr_dpe_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The keymgr_dpe alert, or kDtKeymgrDpeAlertCount.

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

Definition at line 137 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_alert_to_alert_id()

dt_alert_id_t dt_keymgr_dpe_alert_to_alert_id	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_alert_t	alert )

Get the alert ID of a keymgr_dpe 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 keymgr_dpe.
alert	A keymgr_dpe alert.

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

Definition at line 131 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_clock()

dt_clock_t dt_keymgr_dpe_clock	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_clock_t	clk )

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

Parameters

dt	Instance of keymgr_dpe.
clk	Clock port.

Returns: Clock signal.

Definition at line 149 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_from_instance_id()

dt_keymgr_dpe_t dt_keymgr_dpe_from_instance_id ( dt_instance_id_t inst_id )

Get the keymgr_dpe instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A keymgr_dpe instance.

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

Definition at line 73 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_instance_id()

dt_instance_id_t dt_keymgr_dpe_instance_id ( dt_keymgr_dpe_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of keymgr_dpe.

Returns: The instance ID of that instance.

Definition at line 80 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_irq_from_plic_id()

dt_keymgr_dpe_irq_t dt_keymgr_dpe_irq_from_plic_id	(	dt_keymgr_dpe_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The keymgr_dpe IRQ, or kDtKeymgrDpeIrqCount.

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

Definition at line 116 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_irq_to_plic_id()

dt_plic_irq_id_t dt_keymgr_dpe_irq_to_plic_id	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_irq_t	irq )

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

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

Parameters

dt	Instance of keymgr_dpe.
irq	A keymgr_dpe IRQ.

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

Definition at line 106 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_memory_base()

uint32_t dt_keymgr_dpe_memory_base	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of keymgr_dpe.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 92 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_memory_size()

uint32_t dt_keymgr_dpe_memory_size	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of keymgr_dpe.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 99 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_reg_block()

uint32_t dt_keymgr_dpe_reg_block	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of keymgr_dpe.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 85 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_reset()

dt_reset_t dt_keymgr_dpe_reset	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_reset_t	rst )

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

Parameters

dt	Instance of keymgr_dpe.
rst	Reset port.

Returns: Reset signal.

Definition at line 156 of file dt_keymgr_dpe.c.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ dt_keymgr_dpe_alert_t

◆ dt_keymgr_dpe_clock_t

◆ dt_keymgr_dpe_irq_t

◆ dt_keymgr_dpe_memory_t

◆ dt_keymgr_dpe_reg_block_t

◆ dt_keymgr_dpe_reset_t

Enumeration Type Documentation

◆ dt_keymgr_dpe

◆ dt_keymgr_dpe_alert

◆ dt_keymgr_dpe_clock

◆ dt_keymgr_dpe_irq

◆ dt_keymgr_dpe_memory

◆ dt_keymgr_dpe_reg_block

◆ dt_keymgr_dpe_reset

Function Documentation

◆ dt_keymgr_dpe_alert_from_alert_id()

◆ dt_keymgr_dpe_alert_to_alert_id()

◆ dt_keymgr_dpe_clock()

◆ dt_keymgr_dpe_from_instance_id()

◆ dt_keymgr_dpe_instance_id()

◆ dt_keymgr_dpe_irq_from_plic_id()

◆ dt_keymgr_dpe_irq_to_plic_id()

◆ dt_keymgr_dpe_memory_base()

◆ dt_keymgr_dpe_memory_size()

◆ dt_keymgr_dpe_reg_block()

◆ dt_keymgr_dpe_reset()