dt_adc_ctrl.c File Reference

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

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

Go to the source code of this file.

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

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

Typedefs
typedef struct dt_desc_adc_ctrl	dt_desc_adc_ctrl_t
	Description of instances.

Functions
dt_adc_ctrl_t	dt_adc_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the adc_ctrl instance from an instance ID.
dt_instance_id_t	dt_adc_ctrl_instance_id (dt_adc_ctrl_t dt)
	Get the instance ID of an instance.
uint32_t	dt_adc_ctrl_reg_block (dt_adc_ctrl_t dt, dt_adc_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.
uint32_t	dt_adc_ctrl_memory_base (dt_adc_ctrl_t dt, dt_adc_ctrl_memory_t mem)
	Get the base address of a memory.
uint32_t	dt_adc_ctrl_memory_size (dt_adc_ctrl_t dt, dt_adc_ctrl_memory_t mem)
	Get the size of a memory.
dt_plic_irq_id_t	dt_adc_ctrl_irq_to_plic_id (dt_adc_ctrl_t dt, dt_adc_ctrl_irq_t irq)
	Get the PLIC ID of a adc_ctrl IRQ for a given instance.
dt_adc_ctrl_irq_t	dt_adc_ctrl_irq_from_plic_id (dt_adc_ctrl_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local adc_ctrl IRQ type.
dt_alert_id_t	dt_adc_ctrl_alert_to_alert_id (dt_adc_ctrl_t dt, dt_adc_ctrl_alert_t alert)
	Get the alert ID of a adc_ctrl alert for a given instance.
dt_adc_ctrl_alert_t	dt_adc_ctrl_alert_from_alert_id (dt_adc_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local adc_ctrl alert type.
dt_clock_t	dt_adc_ctrl_clock (dt_adc_ctrl_t dt, dt_adc_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_adc_ctrl_reset (dt_adc_ctrl_t dt, dt_adc_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_adc_ctrl.c.

---

Data Structure Documentation

dt_desc_adc_ctrl

struct dt_desc_adc_ctrl

Description of instances.

Definition at line 19 of file dt_adc_ctrl.c.

Data Fields
dt_clock_t	clock[kDtAdcCtrlClockCount]	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.
uint32_t	mem_addr[kDtAdcCtrlMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtAdcCtrlMemoryCount]	Size in bytes of each memory.
uint32_t	reg_addr[kDtAdcCtrlRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtAdcCtrlResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({     if ((dt) < (dt_adc_ctrl_t)0 || (dt) >= kDtAdcCtrlCount)       return (default);     &adc_ctrl_desc[dt];   })

Return a pointer to the dt_adc_ctrl_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_adc_ctrl.c.

Function Documentation

dt_adc_ctrl_alert_from_alert_id()

dt_adc_ctrl_alert_t dt_adc_ctrl_alert_from_alert_id	(	dt_adc_ctrl_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns

The adc_ctrl alert, or kDtAdcCtrlAlertCount.

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

Definition at line 137 of file dt_adc_ctrl.c.

dt_adc_ctrl_alert_to_alert_id()

dt_alert_id_t dt_adc_ctrl_alert_to_alert_id	(	dt_adc_ctrl_t	dt,
		dt_adc_ctrl_alert_t	alert )

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

Returns

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

Definition at line 131 of file dt_adc_ctrl.c.

dt_adc_ctrl_clock()

dt_clock_t dt_adc_ctrl_clock	(	dt_adc_ctrl_t	dt,
		dt_adc_ctrl_clock_t	clk )

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

Parameters

dt	Instance of adc_ctrl.
clk	Clock port.

Returns

Clock signal.

Definition at line 149 of file dt_adc_ctrl.c.

dt_adc_ctrl_from_instance_id()

dt_adc_ctrl_t dt_adc_ctrl_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the adc_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A adc_ctrl instance.

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

Definition at line 73 of file dt_adc_ctrl.c.

dt_adc_ctrl_instance_id()

dt_instance_id_t dt_adc_ctrl_instance_id

(

dt_adc_ctrl_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of adc_ctrl.

Returns

The instance ID of that instance.

Definition at line 80 of file dt_adc_ctrl.c.

dt_adc_ctrl_irq_from_plic_id()

dt_adc_ctrl_irq_t dt_adc_ctrl_irq_from_plic_id	(	dt_adc_ctrl_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns

The adc_ctrl IRQ, or kDtAdcCtrlIrqCount.

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

Definition at line 116 of file dt_adc_ctrl.c.

dt_adc_ctrl_irq_to_plic_id()

dt_plic_irq_id_t dt_adc_ctrl_irq_to_plic_id	(	dt_adc_ctrl_t	dt,
		dt_adc_ctrl_irq_t	irq )

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

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

Parameters

dt	Instance of adc_ctrl.
irq	A adc_ctrl IRQ.

Returns

The PLIC ID of the IRQ of this instance.

Definition at line 106 of file dt_adc_ctrl.c.

dt_adc_ctrl_memory_base()

uint32_t dt_adc_ctrl_memory_base	(	dt_adc_ctrl_t	dt,
		dt_adc_ctrl_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of adc_ctrl.
mem	The memory requested.

Returns

The base address of the requested memory.

Definition at line 92 of file dt_adc_ctrl.c.

dt_adc_ctrl_memory_size()

uint32_t dt_adc_ctrl_memory_size	(	dt_adc_ctrl_t	dt,
		dt_adc_ctrl_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of adc_ctrl.
mem	The memory requested.

Returns

The size of the requested memory.

Definition at line 99 of file dt_adc_ctrl.c.

dt_adc_ctrl_reg_block()

uint32_t dt_adc_ctrl_reg_block	(	dt_adc_ctrl_t	dt,
		dt_adc_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of adc_ctrl.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 85 of file dt_adc_ctrl.c.

dt_adc_ctrl_reset()

dt_reset_t dt_adc_ctrl_reset	(	dt_adc_ctrl_t	dt,
		dt_adc_ctrl_reset_t	rst )

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

Parameters

dt	Instance of adc_ctrl.
rst	Reset port.

Returns

Reset signal.

Definition at line 156 of file dt_adc_ctrl.c.