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

#include "hw/top/dt/dt_kmac.h"

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

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

Typedefs
typedef struct dt_desc_kmac	dt_desc_kmac_t
	Description of instances.

Functions
dt_kmac_t	dt_kmac_from_instance_id (dt_instance_id_t inst_id)
	Get the kmac instance from an instance ID.

dt_instance_id_t	dt_kmac_instance_id (dt_kmac_t dt)
	Get the instance ID of an instance.

uint32_t	dt_kmac_reg_block (dt_kmac_t dt, dt_kmac_reg_block_t reg_block)
	Get the register base address of an instance.

uint32_t	dt_kmac_memory_base (dt_kmac_t dt, dt_kmac_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_kmac_memory_size (dt_kmac_t dt, dt_kmac_memory_t mem)
	Get the size of a memory.

dt_plic_irq_id_t	dt_kmac_irq_to_plic_id (dt_kmac_t dt, dt_kmac_irq_t irq)
	Get the PLIC ID of a kmac IRQ for a given instance.

dt_kmac_irq_t	dt_kmac_irq_from_plic_id (dt_kmac_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local kmac IRQ type.

dt_alert_id_t	dt_kmac_alert_to_alert_id (dt_kmac_t dt, dt_kmac_alert_t alert)
	Get the alert ID of a kmac alert for a given instance.

dt_kmac_alert_t	dt_kmac_alert_from_alert_id (dt_kmac_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local kmac alert type.

dt_clock_t	dt_kmac_clock (dt_kmac_t dt, dt_kmac_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_kmac_reset (dt_kmac_t dt, dt_kmac_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_kmac.c.

Data Structure Documentation

◆ dt_desc_kmac

struct dt_desc_kmac

Description of instances.

Definition at line 19 of file dt_kmac.c.

Data Fields
dt_clock_t	clock[kDtKmacClockCount]	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[kDtKmacMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtKmacMemoryCount]	Size in bytes of each memory.
uint32_t	reg_addr[kDtKmacRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtKmacResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_kmac_t)0 || (dt) >= kDtKmacCount) return (default); &kmac_desc[dt]; })

Return a pointer to the dt_kmac_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 71 of file dt_kmac.c.

Function Documentation

◆ dt_kmac_alert_from_alert_id()

dt_kmac_alert_t dt_kmac_alert_from_alert_id	(	dt_kmac_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The kmac alert, or kDtKmacAlertCount.

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

Definition at line 137 of file dt_kmac.c.

◆ dt_kmac_alert_to_alert_id()

dt_alert_id_t dt_kmac_alert_to_alert_id	(	dt_kmac_t	dt,
		dt_kmac_alert_t	alert )

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

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

Definition at line 131 of file dt_kmac.c.

◆ dt_kmac_clock()

dt_clock_t dt_kmac_clock	(	dt_kmac_t	dt,
		dt_kmac_clock_t	clk )

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

Parameters

dt	Instance of kmac.
clk	Clock port.

Returns: Clock signal.

Definition at line 149 of file dt_kmac.c.

◆ dt_kmac_from_instance_id()

dt_kmac_t dt_kmac_from_instance_id ( dt_instance_id_t inst_id )

Get the kmac instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A kmac instance.

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

Definition at line 73 of file dt_kmac.c.

◆ dt_kmac_instance_id()

dt_instance_id_t dt_kmac_instance_id ( dt_kmac_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of kmac.

Returns: The instance ID of that instance.

Definition at line 80 of file dt_kmac.c.

◆ dt_kmac_irq_from_plic_id()

dt_kmac_irq_t dt_kmac_irq_from_plic_id	(	dt_kmac_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The kmac IRQ, or kDtKmacIrqCount.

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

Definition at line 116 of file dt_kmac.c.

◆ dt_kmac_irq_to_plic_id()

dt_plic_irq_id_t dt_kmac_irq_to_plic_id	(	dt_kmac_t	dt,
		dt_kmac_irq_t	irq )

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

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

Parameters

dt	Instance of kmac.
irq	A kmac IRQ.

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

Definition at line 106 of file dt_kmac.c.

◆ dt_kmac_memory_base()

uint32_t dt_kmac_memory_base	(	dt_kmac_t	dt,
		dt_kmac_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of kmac.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 92 of file dt_kmac.c.

◆ dt_kmac_memory_size()

uint32_t dt_kmac_memory_size	(	dt_kmac_t	dt,
		dt_kmac_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of kmac.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 99 of file dt_kmac.c.

◆ dt_kmac_reg_block()

uint32_t dt_kmac_reg_block	(	dt_kmac_t	dt,
		dt_kmac_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of kmac.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 85 of file dt_kmac.c.

◆ dt_kmac_reset()

dt_reset_t dt_kmac_reset	(	dt_kmac_t	dt,
		dt_kmac_reset_t	rst )

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

Parameters

dt	Instance of kmac.
rst	Reset port.

Returns: Reset signal.

Definition at line 156 of file dt_kmac.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_kmac

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_kmac_alert_from_alert_id()

◆ dt_kmac_alert_to_alert_id()

◆ dt_kmac_clock()

◆ dt_kmac_from_instance_id()

◆ dt_kmac_instance_id()

◆ dt_kmac_irq_from_plic_id()

◆ dt_kmac_irq_to_plic_id()

◆ dt_kmac_memory_base()

◆ dt_kmac_memory_size()

◆ dt_kmac_reg_block()

◆ dt_kmac_reset()