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

#include "dt/dt_aon_timer.h"

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

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

Typedefs
typedef struct dt_desc_aon_timer	dt_desc_aon_timer_t
	Description of instances.

Functions
dt_aon_timer_t	dt_aon_timer_from_instance_id (dt_instance_id_t inst_id)
	Get the aon_timer instance from an instance ID.

dt_instance_id_t	dt_aon_timer_instance_id (dt_aon_timer_t dt)
	Get the instance ID of an instance.

uint32_t	dt_aon_timer_reg_block (dt_aon_timer_t dt, dt_aon_timer_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_aon_timer_irq_to_plic_id (dt_aon_timer_t dt, dt_aon_timer_irq_t irq)
	Get the PLIC ID of a aon_timer IRQ for a given instance.

dt_aon_timer_irq_t	dt_aon_timer_irq_from_plic_id (dt_aon_timer_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local aon_timer IRQ type.

dt_alert_id_t	dt_aon_timer_alert_to_alert_id (dt_aon_timer_t dt, dt_aon_timer_alert_t alert)
	Get the alert ID of a aon_timer alert for a given instance.

dt_aon_timer_alert_t	dt_aon_timer_alert_from_alert_id (dt_aon_timer_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local aon_timer alert type.

dt_clock_t	dt_aon_timer_clock (dt_aon_timer_t dt, dt_aon_timer_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_aon_timer_reset (dt_aon_timer_t dt, dt_aon_timer_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_aon_timer.c.

Data Structure Documentation

◆ dt_desc_aon_timer

struct dt_desc_aon_timer

Description of instances.

Definition at line 19 of file dt_aon_timer.c.

Data Fields
uint32_t	base_addr[kDtAonTimerRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtAonTimerClockCount]	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.
top_englishbreakfast_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_reset_t	reset[kDtAonTimerResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_aon_timer_t)0 || (dt) >= kDtAonTimerCount) return (default); &aon_timer_desc[dt]; })

Return a pointer to the dt_aon_timer_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 65 of file dt_aon_timer.c.

Function Documentation

◆ dt_aon_timer_alert_from_alert_id()

dt_aon_timer_alert_t dt_aon_timer_alert_from_alert_id	(	dt_aon_timer_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The aon_timer alert, or kDtAonTimerAlertCount.

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

Definition at line 117 of file dt_aon_timer.c.

◆ dt_aon_timer_alert_to_alert_id()

dt_alert_id_t dt_aon_timer_alert_to_alert_id	(	dt_aon_timer_t	dt,
		dt_aon_timer_alert_t	alert )

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

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

Definition at line 111 of file dt_aon_timer.c.

◆ dt_aon_timer_clock()

dt_clock_t dt_aon_timer_clock	(	dt_aon_timer_t	dt,
		dt_aon_timer_clock_t	clk )

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

Parameters

dt	Instance of aon_timer.
clk	Clock port.

Returns: Clock signal.

Definition at line 129 of file dt_aon_timer.c.

◆ dt_aon_timer_from_instance_id()

dt_aon_timer_t dt_aon_timer_from_instance_id ( dt_instance_id_t inst_id )

Get the aon_timer instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A aon_timer instance.

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

Definition at line 67 of file dt_aon_timer.c.

◆ dt_aon_timer_instance_id()

dt_instance_id_t dt_aon_timer_instance_id ( dt_aon_timer_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of aon_timer.

Returns: The instance ID of that instance.

Definition at line 74 of file dt_aon_timer.c.

◆ dt_aon_timer_irq_from_plic_id()

dt_aon_timer_irq_t dt_aon_timer_irq_from_plic_id	(	dt_aon_timer_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The aon_timer IRQ, or kDtAonTimerIrqCount.

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

Definition at line 96 of file dt_aon_timer.c.

◆ dt_aon_timer_irq_to_plic_id()

dt_plic_irq_id_t dt_aon_timer_irq_to_plic_id	(	dt_aon_timer_t	dt,
		dt_aon_timer_irq_t	irq )

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

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

Parameters

dt	Instance of aon_timer.
irq	A aon_timer IRQ.

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

Definition at line 86 of file dt_aon_timer.c.

◆ dt_aon_timer_reg_block()

uint32_t dt_aon_timer_reg_block	(	dt_aon_timer_t	dt,
		dt_aon_timer_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of aon_timer.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 79 of file dt_aon_timer.c.

◆ dt_aon_timer_reset()

dt_reset_t dt_aon_timer_reset	(	dt_aon_timer_t	dt,
		dt_aon_timer_reset_t	rst )

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

Parameters

dt	Instance of aon_timer.
rst	Reset port.

Returns: Reset signal.

Definition at line 136 of file dt_aon_timer.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_aon_timer

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_aon_timer_alert_from_alert_id()

◆ dt_aon_timer_alert_to_alert_id()

◆ dt_aon_timer_clock()

◆ dt_aon_timer_from_instance_id()

◆ dt_aon_timer_instance_id()

◆ dt_aon_timer_irq_from_plic_id()

◆ dt_aon_timer_irq_to_plic_id()

◆ dt_aon_timer_reg_block()

◆ dt_aon_timer_reset()