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

#include "dt/dt_sensor_ctrl.h"

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

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

Typedefs
typedef struct dt_desc_sensor_ctrl	dt_desc_sensor_ctrl_t
	Description of instances.

Functions
dt_sensor_ctrl_t	dt_sensor_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the sensor_ctrl instance from an instance ID.

dt_instance_id_t	dt_sensor_ctrl_instance_id (dt_sensor_ctrl_t dt)
	Get the instance ID of an instance.

uint32_t	dt_sensor_ctrl_reg_block (dt_sensor_ctrl_t dt, dt_sensor_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_sensor_ctrl_irq_to_plic_id (dt_sensor_ctrl_t dt, dt_sensor_ctrl_irq_t irq)
	Get the PLIC ID of a sensor_ctrl IRQ for a given instance.

dt_sensor_ctrl_irq_t	dt_sensor_ctrl_irq_from_plic_id (dt_sensor_ctrl_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local sensor_ctrl IRQ type.

dt_alert_id_t	dt_sensor_ctrl_alert_to_alert_id (dt_sensor_ctrl_t dt, dt_sensor_ctrl_alert_t alert)
	Get the alert ID of a sensor_ctrl alert for a given instance.

dt_sensor_ctrl_alert_t	dt_sensor_ctrl_alert_from_alert_id (dt_sensor_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local sensor_ctrl alert type.

dt_periph_io_t	dt_sensor_ctrl_periph_io (dt_sensor_ctrl_t dt, dt_sensor_ctrl_periph_io_t sig)
	Get the peripheral I/O description of an instance.

dt_clock_t	dt_sensor_ctrl_clock (dt_sensor_ctrl_t dt, dt_sensor_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_sensor_ctrl_reset (dt_sensor_ctrl_t dt, dt_sensor_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_sensor_ctrl.c.

Data Structure Documentation

◆ dt_desc_sensor_ctrl

struct dt_desc_sensor_ctrl

Description of instances.

Definition at line 19 of file dt_sensor_ctrl.c.

Data Fields
uint32_t	base_addr[kDtSensorCtrlRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtSensorCtrlClockCount]	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[kDtSensorCtrlPeriphIoCount]	Description of each peripheral I/O.
dt_reset_t	reset[kDtSensorCtrlResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_sensor_ctrl_t)0 || (dt) >= kDtSensorCtrlCount) return (default); &sensor_ctrl_desc[dt]; })

Return a pointer to the dt_sensor_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 140 of file dt_sensor_ctrl.c.

Function Documentation

◆ dt_sensor_ctrl_alert_from_alert_id()

dt_sensor_ctrl_alert_t dt_sensor_ctrl_alert_from_alert_id	(	dt_sensor_ctrl_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The sensor_ctrl alert, or kDtSensorCtrlAlertCount.

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

Definition at line 192 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_alert_to_alert_id()

dt_alert_id_t dt_sensor_ctrl_alert_to_alert_id	(	dt_sensor_ctrl_t	dt,
		dt_sensor_ctrl_alert_t	alert )

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

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

Definition at line 186 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_clock()

dt_clock_t dt_sensor_ctrl_clock	(	dt_sensor_ctrl_t	dt,
		dt_sensor_ctrl_clock_t	clk )

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

Parameters

dt	Instance of sensor_ctrl.
clk	Clock port.

Returns: Clock signal.

Definition at line 210 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_from_instance_id()

dt_sensor_ctrl_t dt_sensor_ctrl_from_instance_id ( dt_instance_id_t inst_id )

Get the sensor_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A sensor_ctrl instance.

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

Definition at line 142 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_instance_id()

dt_instance_id_t dt_sensor_ctrl_instance_id ( dt_sensor_ctrl_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of sensor_ctrl.

Returns: The instance ID of that instance.

Definition at line 149 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_irq_from_plic_id()

dt_sensor_ctrl_irq_t dt_sensor_ctrl_irq_from_plic_id	(	dt_sensor_ctrl_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The sensor_ctrl IRQ, or kDtSensorCtrlIrqCount.

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

Definition at line 171 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_irq_to_plic_id()

dt_plic_irq_id_t dt_sensor_ctrl_irq_to_plic_id	(	dt_sensor_ctrl_t	dt,
		dt_sensor_ctrl_irq_t	irq )

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

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

Parameters

dt	Instance of sensor_ctrl.
irq	A sensor_ctrl IRQ.

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

Definition at line 161 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_periph_io()

dt_periph_io_t dt_sensor_ctrl_periph_io	(	dt_sensor_ctrl_t	dt,
		dt_sensor_ctrl_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

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

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

Definition at line 203 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_reg_block()

uint32_t dt_sensor_ctrl_reg_block	(	dt_sensor_ctrl_t	dt,
		dt_sensor_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of sensor_ctrl.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 154 of file dt_sensor_ctrl.c.

◆ dt_sensor_ctrl_reset()

dt_reset_t dt_sensor_ctrl_reset	(	dt_sensor_ctrl_t	dt,
		dt_sensor_ctrl_reset_t	rst )

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

Parameters

dt	Instance of sensor_ctrl.
rst	Reset port.

Returns: Reset signal.

Definition at line 217 of file dt_sensor_ctrl.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_sensor_ctrl

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_sensor_ctrl_alert_from_alert_id()

◆ dt_sensor_ctrl_alert_to_alert_id()

◆ dt_sensor_ctrl_clock()

◆ dt_sensor_ctrl_from_instance_id()

◆ dt_sensor_ctrl_instance_id()

◆ dt_sensor_ctrl_irq_from_plic_id()

◆ dt_sensor_ctrl_irq_to_plic_id()

◆ dt_sensor_ctrl_periph_io()

◆ dt_sensor_ctrl_reg_block()

◆ dt_sensor_ctrl_reset()