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

#include "dt_api.h"
#include <stdint.h>

Typedefs
typedef enum dt_sensor_ctrl	dt_sensor_ctrl_t
	List of instances.

typedef enum dt_sensor_ctrl_reg_block	dt_sensor_ctrl_reg_block_t
	List of register blocks.

typedef enum dt_sensor_ctrl_irq	dt_sensor_ctrl_irq_t
	List of IRQs.

typedef enum dt_sensor_ctrl_alert	dt_sensor_ctrl_alert_t
	List of Alerts.

typedef enum dt_sensor_ctrl_clock	dt_sensor_ctrl_clock_t
	List of clock ports.

typedef enum dt_sensor_ctrl_reset	dt_sensor_ctrl_reset_t
	List of reset ports.

typedef enum dt_sensor_ctrl_periph_io	dt_sensor_ctrl_periph_io_t
	List of peripheral I/O.

typedef enum dt_sensor_ctrl_wakeup	dt_sensor_ctrl_wakeup_t
	List of wakeups.

Enumerations
enum	dt_sensor_ctrl { kDtSensorCtrlAon = 0 , kDtSensorCtrlFirst = 0 , kDtSensorCtrlCount = 1 }
	List of instances. More...

enum	dt_sensor_ctrl_reg_block { kDtSensorCtrlRegBlockCore = 0 , kDtSensorCtrlRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_sensor_ctrl_irq { kDtSensorCtrlIrqIoStatusChange = 0 , kDtSensorCtrlIrqInitStatusChange = 1 , kDtSensorCtrlIrqCount = 2 }
	List of IRQs. More...

enum	dt_sensor_ctrl_alert { kDtSensorCtrlAlertRecovAlert = 0 , kDtSensorCtrlAlertFatalAlert = 1 , kDtSensorCtrlAlertCount = 2 }
	List of Alerts. More...

enum	dt_sensor_ctrl_clock { kDtSensorCtrlClockClk = 0 , kDtSensorCtrlClockAon = 1 , kDtSensorCtrlClockCount = 2 }
	List of clock ports. More...

enum	dt_sensor_ctrl_reset { kDtSensorCtrlResetRst = 0 , kDtSensorCtrlResetAon = 1 , kDtSensorCtrlResetCount = 2 }
	List of reset ports. More...

enum	dt_sensor_ctrl_periph_io { kDtSensorCtrlPeriphIoAstDebugOut0 = 0 , kDtSensorCtrlPeriphIoAstDebugOut1 = 1 , kDtSensorCtrlPeriphIoAstDebugOut2 = 2 , kDtSensorCtrlPeriphIoAstDebugOut3 = 3 , kDtSensorCtrlPeriphIoAstDebugOut4 = 4 , kDtSensorCtrlPeriphIoAstDebugOut5 = 5 , kDtSensorCtrlPeriphIoAstDebugOut6 = 6 , kDtSensorCtrlPeriphIoAstDebugOut7 = 7 , kDtSensorCtrlPeriphIoAstDebugOut8 = 8 , kDtSensorCtrlPeriphIoCount = 9 }
	List of peripheral I/O. More...

enum	dt_sensor_ctrl_wakeup { kDtSensorCtrlWakeupWkupReq = 0 , kDtSensorCtrlWakeupCount = 1 }
	List of wakeups. More...

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.

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

Definition in file dt_sensor_ctrl.h.

Typedef Documentation

◆ dt_sensor_ctrl_alert_t

typedef enum dt_sensor_ctrl_alert dt_sensor_ctrl_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_sensor_ctrl_clock_t

typedef enum dt_sensor_ctrl_clock dt_sensor_ctrl_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_sensor_ctrl_irq_t

typedef enum dt_sensor_ctrl_irq dt_sensor_ctrl_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_sensor_ctrl_periph_io_t

typedef enum dt_sensor_ctrl_periph_io dt_sensor_ctrl_periph_io_t

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

◆ dt_sensor_ctrl_reg_block_t

typedef enum dt_sensor_ctrl_reg_block dt_sensor_ctrl_reg_block_t

List of register blocks.

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

◆ dt_sensor_ctrl_reset_t

typedef enum dt_sensor_ctrl_reset dt_sensor_ctrl_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

◆ dt_sensor_ctrl_wakeup_t

typedef enum dt_sensor_ctrl_wakeup dt_sensor_ctrl_wakeup_t

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_sensor_ctrl

enum dt_sensor_ctrl

List of instances.

Enumerator
kDtSensorCtrlAon	sensor_ctrl_aon

Definition at line 23 of file dt_sensor_ctrl.h.

◆ dt_sensor_ctrl_alert

enum dt_sensor_ctrl_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSensorCtrlAlertRecovAlert	recoverable sensor_ctrl alerts
kDtSensorCtrlAlertFatalAlert	fatal sensor_ctrl alerts

Definition at line 58 of file dt_sensor_ctrl.h.

◆ dt_sensor_ctrl_clock

enum dt_sensor_ctrl_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSensorCtrlClockClk	Clock port clk_i.
kDtSensorCtrlClockAon	Clock port clk_aon_i.

Definition at line 69 of file dt_sensor_ctrl.h.

◆ dt_sensor_ctrl_irq

enum dt_sensor_ctrl_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSensorCtrlIrqIoStatusChange	io power status has changed
kDtSensorCtrlIrqInitStatusChange	ast init status has changed

Definition at line 47 of file dt_sensor_ctrl.h.

◆ dt_sensor_ctrl_periph_io

enum dt_sensor_ctrl_periph_io

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

Definition at line 91 of file dt_sensor_ctrl.h.

◆ dt_sensor_ctrl_reg_block

enum dt_sensor_ctrl_reg_block

List of register blocks.

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

Definition at line 34 of file dt_sensor_ctrl.h.

◆ dt_sensor_ctrl_reset

enum dt_sensor_ctrl_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSensorCtrlResetRst	Reset port rst_ni.
kDtSensorCtrlResetAon	Reset port rst_aon_ni.

Definition at line 80 of file dt_sensor_ctrl.h.

◆ dt_sensor_ctrl_wakeup

enum dt_sensor_ctrl_wakeup

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSensorCtrlWakeupWkupReq	Raised if an alert event is seen during low power.

Definition at line 109 of file dt_sensor_ctrl.h.

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.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ dt_sensor_ctrl_alert_t

◆ dt_sensor_ctrl_clock_t

◆ dt_sensor_ctrl_irq_t

◆ dt_sensor_ctrl_periph_io_t

◆ dt_sensor_ctrl_reg_block_t

◆ dt_sensor_ctrl_reset_t

◆ dt_sensor_ctrl_wakeup_t

Enumeration Type Documentation

◆ dt_sensor_ctrl

◆ dt_sensor_ctrl_alert

◆ dt_sensor_ctrl_clock

◆ dt_sensor_ctrl_irq

◆ dt_sensor_ctrl_periph_io

◆ dt_sensor_ctrl_reg_block

◆ dt_sensor_ctrl_reset

◆ dt_sensor_ctrl_wakeup

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()