dt_adc_ctrl.h File Reference

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

#include "hw/top/dt/dt_api.h"
#include <stdint.h>

Go to the source code of this file.

Macros
#define	OPENTITAN_ADC_CTRL_HAS_MODE_NORMAL   1
	List of supported hardware features.
#define	OPENTITAN_ADC_CTRL_HAS_MODE_LOW_POWER   1
#define	OPENTITAN_ADC_CTRL_HAS_ONESHOT   1

Typedefs
typedef enum dt_adc_ctrl	dt_adc_ctrl_t
	List of instances.
typedef enum dt_adc_ctrl_reg_block	dt_adc_ctrl_reg_block_t
	List of register blocks.
typedef enum dt_adc_ctrl_memory	dt_adc_ctrl_memory_t
	List of memories.
typedef enum dt_adc_ctrl_irq	dt_adc_ctrl_irq_t
	List of IRQs.
typedef enum dt_adc_ctrl_alert	dt_adc_ctrl_alert_t
	List of Alerts.
typedef enum dt_adc_ctrl_clock	dt_adc_ctrl_clock_t
	List of clock ports.
typedef enum dt_adc_ctrl_reset	dt_adc_ctrl_reset_t
	List of reset ports.
typedef enum dt_adc_ctrl_wakeup	dt_adc_ctrl_wakeup_t
	List of wakeups.

Enumerations
enum	dt_adc_ctrl {   kDtAdcCtrlAon = 0 ,   kDtAdcCtrlFirst = 0 ,   kDtAdcCtrlCount = 1 }
	List of instances. More...
enum	dt_adc_ctrl_reg_block {   kDtAdcCtrlRegBlockCore = 0 ,   kDtAdcCtrlRegBlockCount = 1 }
	List of register blocks. More...
enum	dt_adc_ctrl_memory { kDtAdcCtrlMemoryCount = 0 }
	List of memories. More...
enum	dt_adc_ctrl_irq {   kDtAdcCtrlIrqMatchPending = 0 ,   kDtAdcCtrlIrqCount = 1 }
	List of IRQs. More...
enum	dt_adc_ctrl_alert {   kDtAdcCtrlAlertFatalFault = 0 ,   kDtAdcCtrlAlertCount = 1 }
	List of Alerts. More...
enum	dt_adc_ctrl_clock {   kDtAdcCtrlClockClk = 0 ,   kDtAdcCtrlClockAon = 1 ,   kDtAdcCtrlClockCount = 2 }
	List of clock ports. More...
enum	dt_adc_ctrl_reset {   kDtAdcCtrlResetRst = 0 ,   kDtAdcCtrlResetAon = 1 ,   kDtAdcCtrlResetCount = 2 }
	List of reset ports. More...
enum	dt_adc_ctrl_wakeup {   kDtAdcCtrlWakeupWkupReq = 0 ,   kDtAdcCtrlWakeupCount = 1 }
	List of wakeups. More...

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.

This file contains the type definitions and global functions of the adc_ctrl.

Definition in file dt_adc_ctrl.h.

Macro Definition Documentation

OPENTITAN_ADC_CTRL_HAS_MODE_LOW_POWER

#define OPENTITAN_ADC_CTRL_HAS_MODE_LOW_POWER   1

Definition at line 113 of file dt_adc_ctrl.h.

OPENTITAN_ADC_CTRL_HAS_MODE_NORMAL

#define OPENTITAN_ADC_CTRL_HAS_MODE_NORMAL   1

List of supported hardware features.

Definition at line 112 of file dt_adc_ctrl.h.

OPENTITAN_ADC_CTRL_HAS_ONESHOT

#define OPENTITAN_ADC_CTRL_HAS_ONESHOT   1

Definition at line 114 of file dt_adc_ctrl.h.

Typedef Documentation

dt_adc_ctrl_alert_t

typedef enum dt_adc_ctrl_alert dt_adc_ctrl_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

dt_adc_ctrl_clock_t

typedef enum dt_adc_ctrl_clock dt_adc_ctrl_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_adc_ctrl_irq_t

typedef enum dt_adc_ctrl_irq dt_adc_ctrl_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

dt_adc_ctrl_memory_t

typedef enum dt_adc_ctrl_memory dt_adc_ctrl_memory_t

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

dt_adc_ctrl_reg_block_t

typedef enum dt_adc_ctrl_reg_block dt_adc_ctrl_reg_block_t

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

dt_adc_ctrl_reset_t

typedef enum dt_adc_ctrl_reset dt_adc_ctrl_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

dt_adc_ctrl_wakeup_t

typedef enum dt_adc_ctrl_wakeup dt_adc_ctrl_wakeup_t

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

dt_adc_ctrl

enum dt_adc_ctrl

List of instances.

Enumerator
kDtAdcCtrlAon	adc_ctrl_aon

Definition at line 29 of file dt_adc_ctrl.h.

dt_adc_ctrl_alert

enum dt_adc_ctrl_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAdcCtrlAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 72 of file dt_adc_ctrl.h.

dt_adc_ctrl_clock

enum dt_adc_ctrl_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAdcCtrlClockClk	Clock port clk_i.
kDtAdcCtrlClockAon	Clock port clk_aon_i.

Definition at line 82 of file dt_adc_ctrl.h.

dt_adc_ctrl_irq

enum dt_adc_ctrl_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAdcCtrlIrqMatchPending	ADC match or measurement event has occurred.

Definition at line 62 of file dt_adc_ctrl.h.

dt_adc_ctrl_memory

enum dt_adc_ctrl_memory

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 53 of file dt_adc_ctrl.h.

dt_adc_ctrl_reg_block

enum dt_adc_ctrl_reg_block

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 40 of file dt_adc_ctrl.h.

dt_adc_ctrl_reset

enum dt_adc_ctrl_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAdcCtrlResetRst	Reset port rst_ni.
kDtAdcCtrlResetAon	Reset port rst_aon_ni.

Definition at line 93 of file dt_adc_ctrl.h.

dt_adc_ctrl_wakeup

enum dt_adc_ctrl_wakeup

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAdcCtrlWakeupWkupReq	ADC wakeup request.

Definition at line 104 of file dt_adc_ctrl.h.

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.