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

#include "dt/dt_pattgen.h"

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

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

Typedefs
typedef struct dt_desc_pattgen	dt_desc_pattgen_t
	Description of instances.

Functions
dt_pattgen_t	dt_pattgen_from_instance_id (dt_instance_id_t inst_id)
	Get the pattgen instance from an instance ID.

dt_instance_id_t	dt_pattgen_instance_id (dt_pattgen_t dt)
	Get the instance ID of an instance.

uint32_t	dt_pattgen_reg_block (dt_pattgen_t dt, dt_pattgen_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_pattgen_irq_to_plic_id (dt_pattgen_t dt, dt_pattgen_irq_t irq)
	Get the PLIC ID of a pattgen IRQ for a given instance.

dt_pattgen_irq_t	dt_pattgen_irq_from_plic_id (dt_pattgen_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local pattgen IRQ type.

dt_alert_id_t	dt_pattgen_alert_to_alert_id (dt_pattgen_t dt, dt_pattgen_alert_t alert)
	Get the alert ID of a pattgen alert for a given instance.

dt_pattgen_alert_t	dt_pattgen_alert_from_alert_id (dt_pattgen_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local pattgen alert type.

dt_periph_io_t	dt_pattgen_periph_io (dt_pattgen_t dt, dt_pattgen_periph_io_t sig)
	Get the peripheral I/O description of an instance.

dt_clock_t	dt_pattgen_clock (dt_pattgen_t dt, dt_pattgen_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_pattgen_reset (dt_pattgen_t dt, dt_pattgen_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_pattgen.c.

Data Structure Documentation

◆ dt_desc_pattgen

struct dt_desc_pattgen

Description of instances.

Definition at line 19 of file dt_pattgen.c.

Data Fields
uint32_t	base_addr[kDtPattgenRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtPattgenClockCount]	Clock signal connected to each clock port.
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_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.
dt_periph_io_t	periph_io[kDtPattgenPeriphIoCount]	Description of each peripheral I/O.
dt_reset_t	reset[kDtPattgenResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_pattgen_t)0 || (dt) >= kDtPattgenCount) return (default); &pattgen_desc[dt]; })

Return a pointer to the dt_pattgen_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 98 of file dt_pattgen.c.

Function Documentation

◆ dt_pattgen_alert_from_alert_id()

dt_pattgen_alert_t dt_pattgen_alert_from_alert_id	(	dt_pattgen_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The pattgen alert, or kDtPattgenAlertCount.

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

Definition at line 150 of file dt_pattgen.c.

◆ dt_pattgen_alert_to_alert_id()

dt_alert_id_t dt_pattgen_alert_to_alert_id	(	dt_pattgen_t	dt,
		dt_pattgen_alert_t	alert )

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

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

Definition at line 144 of file dt_pattgen.c.

◆ dt_pattgen_clock()

dt_clock_t dt_pattgen_clock	(	dt_pattgen_t	dt,
		dt_pattgen_clock_t	clk )

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

Parameters

dt	Instance of pattgen.
clk	Clock port.

Returns: Clock signal.

Definition at line 168 of file dt_pattgen.c.

◆ dt_pattgen_from_instance_id()

dt_pattgen_t dt_pattgen_from_instance_id ( dt_instance_id_t inst_id )

Get the pattgen instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A pattgen instance.

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

Definition at line 100 of file dt_pattgen.c.

◆ dt_pattgen_instance_id()

dt_instance_id_t dt_pattgen_instance_id ( dt_pattgen_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of pattgen.

Returns: The instance ID of that instance.

Definition at line 107 of file dt_pattgen.c.

◆ dt_pattgen_irq_from_plic_id()

dt_pattgen_irq_t dt_pattgen_irq_from_plic_id	(	dt_pattgen_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The pattgen IRQ, or kDtPattgenIrqCount.

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

Definition at line 129 of file dt_pattgen.c.

◆ dt_pattgen_irq_to_plic_id()

dt_plic_irq_id_t dt_pattgen_irq_to_plic_id	(	dt_pattgen_t	dt,
		dt_pattgen_irq_t	irq )

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

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

Parameters

dt	Instance of pattgen.
irq	A pattgen IRQ.

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

Definition at line 119 of file dt_pattgen.c.

◆ dt_pattgen_periph_io()

dt_periph_io_t dt_pattgen_periph_io	(	dt_pattgen_t	dt,
		dt_pattgen_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

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

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

Definition at line 161 of file dt_pattgen.c.

◆ dt_pattgen_reg_block()

uint32_t dt_pattgen_reg_block	(	dt_pattgen_t	dt,
		dt_pattgen_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of pattgen.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 112 of file dt_pattgen.c.

◆ dt_pattgen_reset()

dt_reset_t dt_pattgen_reset	(	dt_pattgen_t	dt,
		dt_pattgen_reset_t	rst )

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

Parameters

dt	Instance of pattgen.
rst	Reset port.

Returns: Reset signal.

Definition at line 175 of file dt_pattgen.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_pattgen

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_pattgen_alert_from_alert_id()

◆ dt_pattgen_alert_to_alert_id()

◆ dt_pattgen_clock()

◆ dt_pattgen_from_instance_id()

◆ dt_pattgen_instance_id()

◆ dt_pattgen_irq_from_plic_id()

◆ dt_pattgen_irq_to_plic_id()

◆ dt_pattgen_periph_io()

◆ dt_pattgen_reg_block()

◆ dt_pattgen_reset()