 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP lc_ctrl and top darjeeling. More...
#include "hw/top/dt/dt_lc_ctrl.h"Go to the source code of this file.
Data Structures | |
| struct | dt_desc_lc_ctrl |
| Description of instances. More... | |
Macros | |
| #define | TRY_GET_DT(dt, default) |
Return a pointer to the dt_lc_ctrl_desc_t structure of the requested dt if it's a valid index. | |
Typedefs | |
| typedef struct dt_desc_lc_ctrl | dt_desc_lc_ctrl_t |
| Description of instances. | |
Functions | |
| dt_lc_ctrl_t | dt_lc_ctrl_from_instance_id (dt_instance_id_t inst_id) |
| Get the lc_ctrl instance from an instance ID. | |
| dt_instance_id_t | dt_lc_ctrl_instance_id (dt_lc_ctrl_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_lc_ctrl_reg_block (dt_lc_ctrl_t dt, dt_lc_ctrl_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_lc_ctrl_memory_base (dt_lc_ctrl_t dt, dt_lc_ctrl_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_lc_ctrl_memory_size (dt_lc_ctrl_t dt, dt_lc_ctrl_memory_t mem) |
| Get the size of a memory. | |
| dt_alert_id_t | dt_lc_ctrl_alert_to_alert_id (dt_lc_ctrl_t dt, dt_lc_ctrl_alert_t alert) |
| Get the alert ID of a lc_ctrl alert for a given instance. | |
| dt_lc_ctrl_alert_t | dt_lc_ctrl_alert_from_alert_id (dt_lc_ctrl_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local lc_ctrl alert type. | |
| dt_clock_t | dt_lc_ctrl_clock (dt_lc_ctrl_t dt, dt_lc_ctrl_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_lc_ctrl_reset (dt_lc_ctrl_t dt, dt_lc_ctrl_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP lc_ctrl and top darjeeling.
Definition in file dt_lc_ctrl.c.
| struct dt_desc_lc_ctrl |
Description of instances.
Definition at line 19 of file dt_lc_ctrl.c.
| Data Fields | ||
|---|---|---|
| dt_clock_t | clock[kDtLcCtrlClockCount] | Clock signal connected to each clock port. |
| top_darjeeling_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_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. |
| dt_instance_id_t | inst_id | Instance ID. |
| uint32_t | mem_addr[kDtLcCtrlMemoryCount] | Base address of each memory. |
| uint32_t | mem_size[kDtLcCtrlMemoryCount] | Size in bytes of each memory. |
| uint32_t | reg_addr[kDtLcCtrlRegBlockCount] | Base address of each register block. |
| dt_reset_t | reset[kDtLcCtrlResetCount] | Reset signal connected to each reset port. |
| #define TRY_GET_DT | ( | dt, | |
| default ) |
Return a pointer to the dt_lc_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 65 of file dt_lc_ctrl.c.
| dt_lc_ctrl_alert_t dt_lc_ctrl_alert_from_alert_id | ( | dt_lc_ctrl_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local lc_ctrl alert type.
| dt | Instance of lc_ctrl. |
| alert | A global alert ID that belongs to this instance. |
kDtLcCtrlAlertCount.Note: This function assumes that the global alert ID belongs to the instance of lc_ctrl passed in parameter. In other words, it must be the case that dt_lc_ctrl_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtLcCtrlAlertCount.
Definition at line 107 of file dt_lc_ctrl.c.
| dt_alert_id_t dt_lc_ctrl_alert_to_alert_id | ( | dt_lc_ctrl_t | dt, |
| dt_lc_ctrl_alert_t | alert ) |
Get the alert ID of a lc_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 lc_ctrl. |
| alert | A lc_ctrl alert. |
Definition at line 101 of file dt_lc_ctrl.c.
| dt_clock_t dt_lc_ctrl_clock | ( | dt_lc_ctrl_t | dt, |
| dt_lc_ctrl_clock_t | clk ) |
Get the clock signal connected to a clock port of an instance.
| dt | Instance of lc_ctrl. |
| clk | Clock port. |
Definition at line 119 of file dt_lc_ctrl.c.
| dt_lc_ctrl_t dt_lc_ctrl_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the lc_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 lc_ctrl, otherwise the returned value is unspecified.
Definition at line 67 of file dt_lc_ctrl.c.
| dt_instance_id_t dt_lc_ctrl_instance_id | ( | dt_lc_ctrl_t | dt | ) |
Get the instance ID of an instance.
| dt | Instance of lc_ctrl. |
Definition at line 74 of file dt_lc_ctrl.c.
| uint32_t dt_lc_ctrl_memory_base | ( | dt_lc_ctrl_t | dt, |
| dt_lc_ctrl_memory_t | mem ) |
Get the base address of a memory.
| dt | Instance of lc_ctrl. |
| mem | The memory requested. |
Definition at line 86 of file dt_lc_ctrl.c.
| uint32_t dt_lc_ctrl_memory_size | ( | dt_lc_ctrl_t | dt, |
| dt_lc_ctrl_memory_t | mem ) |
Get the size of a memory.
| dt | Instance of lc_ctrl. |
| mem | The memory requested. |
Definition at line 93 of file dt_lc_ctrl.c.
| uint32_t dt_lc_ctrl_reg_block | ( | dt_lc_ctrl_t | dt, |
| dt_lc_ctrl_reg_block_t | reg_block ) |
Get the register base address of an instance.
| dt | Instance of lc_ctrl. |
| reg_block | The register block requested. |
Definition at line 79 of file dt_lc_ctrl.c.
| dt_reset_t dt_lc_ctrl_reset | ( | dt_lc_ctrl_t | dt, |
| dt_lc_ctrl_reset_t | rst ) |
Get the reset signal connected to a reset port of an instance.
| dt | Instance of lc_ctrl. |
| rst | Reset port. |
Definition at line 126 of file dt_lc_ctrl.c.