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

#include "dt/dt_soc_proxy.h"

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

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

Typedefs
typedef struct dt_desc_soc_proxy	dt_desc_soc_proxy_t
	Description of instances.

Functions
dt_soc_proxy_t	dt_soc_proxy_from_instance_id (dt_instance_id_t inst_id)
	Get the soc_proxy instance from an instance ID.

dt_instance_id_t	dt_soc_proxy_instance_id (dt_soc_proxy_t dt)
	Get the instance ID of an instance.

uint32_t	dt_soc_proxy_reg_block (dt_soc_proxy_t dt, dt_soc_proxy_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_soc_proxy_irq_to_plic_id (dt_soc_proxy_t dt, dt_soc_proxy_irq_t irq)
	Get the PLIC ID of a soc_proxy IRQ for a given instance.

dt_soc_proxy_irq_t	dt_soc_proxy_irq_from_plic_id (dt_soc_proxy_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local soc_proxy IRQ type.

dt_alert_id_t	dt_soc_proxy_alert_to_alert_id (dt_soc_proxy_t dt, dt_soc_proxy_alert_t alert)
	Get the alert ID of a soc_proxy alert for a given instance.

dt_soc_proxy_alert_t	dt_soc_proxy_alert_from_alert_id (dt_soc_proxy_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local soc_proxy alert type.

dt_periph_io_t	dt_soc_proxy_periph_io (dt_soc_proxy_t dt, dt_soc_proxy_periph_io_t sig)
	Get the peripheral I/O description of an instance.

dt_clock_t	dt_soc_proxy_clock (dt_soc_proxy_t dt, dt_soc_proxy_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_soc_proxy_reset (dt_soc_proxy_t dt, dt_soc_proxy_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_soc_proxy.c.

Data Structure Documentation

◆ dt_desc_soc_proxy

struct dt_desc_soc_proxy

Description of instances.

Definition at line 19 of file dt_soc_proxy.c.

Data Fields
uint32_t	base_addr[kDtSocProxyRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtSocProxyClockCount]	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.
dt_periph_io_t	periph_io[kDtSocProxyPeriphIoCount]	Description of each peripheral I/O.
dt_reset_t	reset[kDtSocProxyResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_soc_proxy_t)0 || (dt) >= kDtSocProxyCount) return (default); &soc_proxy_desc[dt]; })

Return a pointer to the dt_soc_proxy_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 325 of file dt_soc_proxy.c.

Function Documentation

◆ dt_soc_proxy_alert_from_alert_id()

dt_soc_proxy_alert_t dt_soc_proxy_alert_from_alert_id	(	dt_soc_proxy_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The soc_proxy alert, or kDtSocProxyAlertCount.

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

Definition at line 377 of file dt_soc_proxy.c.

◆ dt_soc_proxy_alert_to_alert_id()

dt_alert_id_t dt_soc_proxy_alert_to_alert_id	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_alert_t	alert )

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

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

Definition at line 371 of file dt_soc_proxy.c.

◆ dt_soc_proxy_clock()

dt_clock_t dt_soc_proxy_clock	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_clock_t	clk )

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

Parameters

dt	Instance of soc_proxy.
clk	Clock port.

Returns: Clock signal.

Definition at line 395 of file dt_soc_proxy.c.

◆ dt_soc_proxy_from_instance_id()

dt_soc_proxy_t dt_soc_proxy_from_instance_id ( dt_instance_id_t inst_id )

Get the soc_proxy instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A soc_proxy instance.

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

Definition at line 327 of file dt_soc_proxy.c.

◆ dt_soc_proxy_instance_id()

dt_instance_id_t dt_soc_proxy_instance_id ( dt_soc_proxy_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of soc_proxy.

Returns: The instance ID of that instance.

Definition at line 334 of file dt_soc_proxy.c.

◆ dt_soc_proxy_irq_from_plic_id()

dt_soc_proxy_irq_t dt_soc_proxy_irq_from_plic_id	(	dt_soc_proxy_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The soc_proxy IRQ, or kDtSocProxyIrqCount.

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

Definition at line 356 of file dt_soc_proxy.c.

◆ dt_soc_proxy_irq_to_plic_id()

dt_plic_irq_id_t dt_soc_proxy_irq_to_plic_id	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_irq_t	irq )

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

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

Parameters

dt	Instance of soc_proxy.
irq	A soc_proxy IRQ.

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

Definition at line 346 of file dt_soc_proxy.c.

◆ dt_soc_proxy_periph_io()

dt_periph_io_t dt_soc_proxy_periph_io	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

dt	Instance of soc_proxy.
sig	Requested peripheral I/O.

Returns: Description of the requested peripheral I/O for this instance.

Definition at line 388 of file dt_soc_proxy.c.

◆ dt_soc_proxy_reg_block()

uint32_t dt_soc_proxy_reg_block	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of soc_proxy.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 339 of file dt_soc_proxy.c.

◆ dt_soc_proxy_reset()

dt_reset_t dt_soc_proxy_reset	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_reset_t	rst )

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

Parameters

dt	Instance of soc_proxy.
rst	Reset port.

Returns: Reset signal.

Definition at line 402 of file dt_soc_proxy.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_soc_proxy

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_soc_proxy_alert_from_alert_id()

◆ dt_soc_proxy_alert_to_alert_id()

◆ dt_soc_proxy_clock()

◆ dt_soc_proxy_from_instance_id()

◆ dt_soc_proxy_instance_id()

◆ dt_soc_proxy_irq_from_plic_id()

◆ dt_soc_proxy_irq_to_plic_id()

◆ dt_soc_proxy_periph_io()

◆ dt_soc_proxy_reg_block()

◆ dt_soc_proxy_reset()