 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP cheriot_mem_sys and top earlgrey. More...
#include "hw/top/dt/cheriot_mem_sys.h"Go to the source code of this file.
Data Structures | |
| struct | dt_desc_cheriot_mem_sys |
| Description of instances. More... | |
Macros | |
| #define | TRY_GET_DT(dt, default) |
Return a pointer to the dt_cheriot_mem_sys_desc_t structure of the requested dt if it's a valid index. | |
Typedefs | |
| typedef struct dt_desc_cheriot_mem_sys | dt_desc_cheriot_mem_sys_t |
| Description of instances. | |
Device Tables (DT) for IP cheriot_mem_sys and top earlgrey.
Definition in file cheriot_mem_sys.c.
| struct dt_desc_cheriot_mem_sys |
Description of instances.
Definition at line 19 of file cheriot_mem_sys.c.
| Data Fields | ||
|---|---|---|
| dt_clock_t | clock[kDtCheriotMemSysClockCount] | 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[kDtCheriotMemSysMemoryCount] | Base address of each memory. |
| uint32_t | mem_size[kDtCheriotMemSysMemoryCount] | Size in bytes of each memory. |
| uint32_t | reg_addr[kDtCheriotMemSysRegBlockCount] | Base address of each register block. |
| dt_reset_t | reset[kDtCheriotMemSysResetCount] | Reset signal connected to each reset port. |
| #define TRY_GET_DT | ( | dt, | |
| default ) |
Return a pointer to the dt_cheriot_mem_sys_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 cheriot_mem_sys.c.
| dt_cheriot_mem_sys_alert_t dt_cheriot_mem_sys_alert_from_alert_id | ( | dt_cheriot_mem_sys_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local cheriot_mem_sys alert type.
| dt | Instance of cheriot_mem_sys. |
| alert | A global alert ID that belongs to this instance. |
kDtCheriotMemSysAlertCount.Note: This function assumes that the global alert ID belongs to the instance of cheriot_mem_sys passed in parameter. In other words, it must be the case that dt_cheriot_mem_sys_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtCheriotMemSysAlertCount.
Definition at line 137 of file cheriot_mem_sys.c.
| dt_alert_id_t dt_cheriot_mem_sys_alert_to_alert_id | ( | dt_cheriot_mem_sys_t | dt, |
| dt_cheriot_mem_sys_alert_t | alert ) |
Get the alert ID of a cheriot_mem_sys 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 cheriot_mem_sys. |
| alert | A cheriot_mem_sys alert. |
Definition at line 131 of file cheriot_mem_sys.c.
Get the clock signal connected to a clock port of an instance.
| dt | Instance of cheriot_mem_sys. |
| clk | Clock port. |
Definition at line 149 of file cheriot_mem_sys.c.
| dt_cheriot_mem_sys_t dt_cheriot_mem_sys_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the cheriot_mem_sys 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 cheriot_mem_sys, otherwise the returned value is unspecified.
Definition at line 73 of file cheriot_mem_sys.c.
| dt_instance_id_t dt_cheriot_mem_sys_instance_id | ( | dt_cheriot_mem_sys_t | dt | ) |
Get the instance ID of an instance.
| dt | Instance of cheriot_mem_sys. |
Definition at line 80 of file cheriot_mem_sys.c.
| dt_cheriot_mem_sys_irq_t dt_cheriot_mem_sys_irq_from_plic_id | ( | dt_cheriot_mem_sys_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local cheriot_mem_sys IRQ type.
| dt | Instance of cheriot_mem_sys. |
| irq | A PLIC ID that belongs to this instance. |
kDtCheriotMemSysIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of cheriot_mem_sys passed in parameter. In other words, it must be the case that dt_cheriot_mem_sys_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtCheriotMemSysIrqCount.
Definition at line 116 of file cheriot_mem_sys.c.
| dt_plic_irq_id_t dt_cheriot_mem_sys_irq_to_plic_id | ( | dt_cheriot_mem_sys_t | dt, |
| dt_cheriot_mem_sys_irq_t | irq ) |
Get the PLIC ID of a cheriot_mem_sys IRQ for a given instance.
If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.
| dt | Instance of cheriot_mem_sys. |
| irq | A cheriot_mem_sys IRQ. |
Definition at line 106 of file cheriot_mem_sys.c.
| uint32_t dt_cheriot_mem_sys_memory_base | ( | dt_cheriot_mem_sys_t | dt, |
| dt_cheriot_mem_sys_memory_t | mem ) |
Get the base address of a memory.
| dt | Instance of cheriot_mem_sys. |
| mem | The memory requested. |
Definition at line 92 of file cheriot_mem_sys.c.
| uint32_t dt_cheriot_mem_sys_memory_size | ( | dt_cheriot_mem_sys_t | dt, |
| dt_cheriot_mem_sys_memory_t | mem ) |
Get the size of a memory.
| dt | Instance of cheriot_mem_sys. |
| mem | The memory requested. |
Definition at line 99 of file cheriot_mem_sys.c.
| uint32_t dt_cheriot_mem_sys_reg_block | ( | dt_cheriot_mem_sys_t | dt, |
| dt_cheriot_mem_sys_reg_block_t | reg_block ) |
Get the register base address of an instance.
| dt | Instance of cheriot_mem_sys. |
| reg_block | The register block requested. |
Definition at line 85 of file cheriot_mem_sys.c.
Get the reset signal connected to a reset port of an instance.
| dt | Instance of cheriot_mem_sys. |
| rst | Reset port. |
Definition at line 156 of file cheriot_mem_sys.c.