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

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

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

struct	dt_desc_ac_range_check.ipgen_ext

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

Typedefs
typedef struct dt_desc_ac_range_check	dt_desc_ac_range_check_t
	Description of instances.

Functions
dt_ac_range_check_t	dt_ac_range_check_from_instance_id (dt_instance_id_t inst_id)
	Get the ac_range_check instance from an instance ID.

dt_instance_id_t	dt_ac_range_check_instance_id (dt_ac_range_check_t dt)
	Get the instance ID of an instance.

uint32_t	dt_ac_range_check_reg_block (dt_ac_range_check_t dt, dt_ac_range_check_reg_block_t reg_block)
	Get the register base address of an instance.

uint32_t	dt_ac_range_check_memory_base (dt_ac_range_check_t dt, dt_ac_range_check_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_ac_range_check_memory_size (dt_ac_range_check_t dt, dt_ac_range_check_memory_t mem)
	Get the size of a memory.

dt_plic_irq_id_t	dt_ac_range_check_irq_to_plic_id (dt_ac_range_check_t dt, dt_ac_range_check_irq_t irq)
	Get the PLIC ID of a ac_range_check IRQ for a given instance.

dt_ac_range_check_irq_t	dt_ac_range_check_irq_from_plic_id (dt_ac_range_check_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local ac_range_check IRQ type.

dt_alert_id_t	dt_ac_range_check_alert_to_alert_id (dt_ac_range_check_t dt, dt_ac_range_check_alert_t alert)
	Get the alert ID of a ac_range_check alert for a given instance.

dt_ac_range_check_alert_t	dt_ac_range_check_alert_from_alert_id (dt_ac_range_check_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local ac_range_check alert type.

dt_clock_t	dt_ac_range_check_clock (dt_ac_range_check_t dt, dt_ac_range_check_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_ac_range_check_reset (dt_ac_range_check_t dt, dt_ac_range_check_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

uint8_t	dt_ac_range_check_num_ranges (dt_ac_range_check_t dt)
	Get the Number of range registers.

Detailed Description

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

Definition in file dt_ac_range_check.c.

Data Structure Documentation

◆ dt_desc_ac_range_check

struct dt_desc_ac_range_check

Description of instances.

Definition at line 21 of file dt_ac_range_check.c.

Data Fields
dt_clock_t	clock[kDtAcRangeCheckClockCount]	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_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.
dt_instance_id_t	inst_id	Instance ID.
struct dt_desc_ac_range_check.ipgen_ext	ipgen_ext	Extension.
uint32_t	mem_addr[kDtAcRangeCheckMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtAcRangeCheckMemoryCount]	Size in bytes of each memory.
uint32_t	reg_addr[kDtAcRangeCheckRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtAcRangeCheckResetCount]	Reset signal connected to each reset port.

◆ dt_desc_ac_range_check.ipgen_ext

struct dt_desc_ac_range_check.ipgen_ext

Definition at line 40 of file dt_ac_range_check.c.

Data Fields
uint8_t	num_ranges	Number of range registers.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_ac_range_check_t)0 || (dt) >= kDtAcRangeCheckCount) return (default); &ac_range_check_desc[dt]; })

Return a pointer to the dt_ac_range_check_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 77 of file dt_ac_range_check.c.

Function Documentation

◆ dt_ac_range_check_alert_from_alert_id()

dt_ac_range_check_alert_t dt_ac_range_check_alert_from_alert_id	(	dt_ac_range_check_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The ac_range_check alert, or kDtAcRangeCheckAlertCount.

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

Definition at line 143 of file dt_ac_range_check.c.

◆ dt_ac_range_check_alert_to_alert_id()

dt_alert_id_t dt_ac_range_check_alert_to_alert_id	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_alert_t	alert )

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

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

Definition at line 137 of file dt_ac_range_check.c.

◆ dt_ac_range_check_clock()

dt_clock_t dt_ac_range_check_clock	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_clock_t	clk )

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

Parameters

dt	Instance of ac_range_check.
clk	Clock port.

Returns: Clock signal.

Definition at line 155 of file dt_ac_range_check.c.

◆ dt_ac_range_check_from_instance_id()

dt_ac_range_check_t dt_ac_range_check_from_instance_id ( dt_instance_id_t inst_id )

Get the ac_range_check instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A ac_range_check instance.

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

Definition at line 79 of file dt_ac_range_check.c.

◆ dt_ac_range_check_instance_id()

dt_instance_id_t dt_ac_range_check_instance_id ( dt_ac_range_check_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of ac_range_check.

Returns: The instance ID of that instance.

Definition at line 86 of file dt_ac_range_check.c.

◆ dt_ac_range_check_irq_from_plic_id()

dt_ac_range_check_irq_t dt_ac_range_check_irq_from_plic_id	(	dt_ac_range_check_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The ac_range_check IRQ, or kDtAcRangeCheckIrqCount.

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

Definition at line 122 of file dt_ac_range_check.c.

◆ dt_ac_range_check_irq_to_plic_id()

dt_plic_irq_id_t dt_ac_range_check_irq_to_plic_id	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_irq_t	irq )

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

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

Parameters

dt	Instance of ac_range_check.
irq	A ac_range_check IRQ.

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

Definition at line 112 of file dt_ac_range_check.c.

◆ dt_ac_range_check_memory_base()

uint32_t dt_ac_range_check_memory_base	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of ac_range_check.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 98 of file dt_ac_range_check.c.

◆ dt_ac_range_check_memory_size()

uint32_t dt_ac_range_check_memory_size	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of ac_range_check.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 105 of file dt_ac_range_check.c.

◆ dt_ac_range_check_num_ranges()

uint8_t dt_ac_range_check_num_ranges ( dt_ac_range_check_t dt )

Get the Number of range registers.

Parameters

dt	Instance of ac_range_check.

Returns: Number of range registers.

Definition at line 174 of file dt_ac_range_check.c.

◆ dt_ac_range_check_reg_block()

uint32_t dt_ac_range_check_reg_block	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of ac_range_check.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 91 of file dt_ac_range_check.c.

◆ dt_ac_range_check_reset()

dt_reset_t dt_ac_range_check_reset	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_reset_t	rst )

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

Parameters

dt	Instance of ac_range_check.
rst	Reset port.

Returns: Reset signal.

Definition at line 162 of file dt_ac_range_check.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_ac_range_check

◆ dt_desc_ac_range_check.ipgen_ext

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_ac_range_check_alert_from_alert_id()

◆ dt_ac_range_check_alert_to_alert_id()

◆ dt_ac_range_check_clock()

◆ dt_ac_range_check_from_instance_id()

◆ dt_ac_range_check_instance_id()

◆ dt_ac_range_check_irq_from_plic_id()

◆ dt_ac_range_check_irq_to_plic_id()

◆ dt_ac_range_check_memory_base()

◆ dt_ac_range_check_memory_size()

◆ dt_ac_range_check_num_ranges()

◆ dt_ac_range_check_reg_block()

◆ dt_ac_range_check_reset()