 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP sensor_ctrl and top earlgrey. More...
#include "hw/top/dt/dt_sensor_ctrl.h"Go to the source code of this file.
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. | |
Device Tables (DT) for IP sensor_ctrl and top earlgrey.
Definition in file dt_sensor_ctrl.c.
| struct dt_desc_sensor_ctrl |
Description of instances.
Definition at line 19 of file dt_sensor_ctrl.c.
| Data Fields | ||
|---|---|---|
| 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 |
| dt_instance_id_t | inst_id | Instance ID. |
| uint32_t | mem_addr[kDtSensorCtrlMemoryCount] | Base address of each memory. |
| uint32_t | mem_size[kDtSensorCtrlMemoryCount] | Size in bytes of each memory. |
| dt_periph_io_t | periph_io[kDtSensorCtrlPeriphIoCount] | Description of each peripheral I/O. |
| uint32_t | reg_addr[kDtSensorCtrlRegBlockCount] | Base address of each register block. |
| dt_reset_t | reset[kDtSensorCtrlResetCount] | Reset signal connected to each reset port. |
| #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.
Otherwise, this macro will return (i.e. exit the function) with the provided default value.
Definition at line 146 of file dt_sensor_ctrl.c.
| 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 | Instance of sensor_ctrl. |
| alert | A global alert ID that belongs to this instance. |
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 212 of file dt_sensor_ctrl.c.
| 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.
| dt | Instance of sensor_ctrl. |
| alert | A sensor_ctrl alert. |
Definition at line 206 of file dt_sensor_ctrl.c.
Get the clock signal connected to a clock port of an instance.
| dt | Instance of sensor_ctrl. |
| clk | Clock port. |
Definition at line 230 of file dt_sensor_ctrl.c.
| 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.
| inst_id | Instance ID. |
Note: This function only makes sense if the instance ID has device type sensor_ctrl, otherwise the returned value is unspecified.
Definition at line 148 of file dt_sensor_ctrl.c.
| dt_instance_id_t dt_sensor_ctrl_instance_id | ( | dt_sensor_ctrl_t | dt | ) |
Get the instance ID of an instance.
| dt | Instance of sensor_ctrl. |
Definition at line 155 of file dt_sensor_ctrl.c.
| 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 | Instance of sensor_ctrl. |
| irq | A PLIC ID that belongs to this instance. |
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 191 of file dt_sensor_ctrl.c.
| 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.
| dt | Instance of sensor_ctrl. |
| irq | A sensor_ctrl IRQ. |
Definition at line 181 of file dt_sensor_ctrl.c.
| uint32_t dt_sensor_ctrl_memory_base | ( | dt_sensor_ctrl_t | dt, |
| dt_sensor_ctrl_memory_t | mem ) |
Get the base address of a memory.
| dt | Instance of sensor_ctrl. |
| mem | The memory requested. |
Definition at line 167 of file dt_sensor_ctrl.c.
| uint32_t dt_sensor_ctrl_memory_size | ( | dt_sensor_ctrl_t | dt, |
| dt_sensor_ctrl_memory_t | mem ) |
Get the size of a memory.
| dt | Instance of sensor_ctrl. |
| mem | The memory requested. |
Definition at line 174 of file dt_sensor_ctrl.c.
Get the peripheral I/O description of an instance.
| dt | Instance of sensor_ctrl. |
| sig | Requested peripheral I/O. |
Definition at line 223 of file dt_sensor_ctrl.c.
| 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 | Instance of sensor_ctrl. |
| reg_block | The register block requested. |
Definition at line 160 of file dt_sensor_ctrl.c.
Get the reset signal connected to a reset port of an instance.
| dt | Instance of sensor_ctrl. |
| rst | Reset port. |
Definition at line 237 of file dt_sensor_ctrl.c.