 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP mbx and top darjeeling. More...
#include "hw/top/dt/dt_api.h"#include <stdint.h>Go to the source code of this file.
Typedefs | |
| typedef enum dt_mbx | dt_mbx_t |
| List of instances. | |
| typedef enum dt_mbx_reg_block | dt_mbx_reg_block_t |
| List of register blocks. | |
| typedef enum dt_mbx_memory | dt_mbx_memory_t |
| List of memories. | |
| typedef enum dt_mbx_irq | dt_mbx_irq_t |
| List of IRQs. | |
| typedef enum dt_mbx_alert | dt_mbx_alert_t |
| List of Alerts. | |
| typedef enum dt_mbx_clock | dt_mbx_clock_t |
| List of clock ports. | |
| typedef enum dt_mbx_reset | dt_mbx_reset_t |
| List of reset ports. | |
Enumerations | |
| enum | dt_mbx { kDtMbx0 = 0 , kDtMbx1 = 1 , kDtMbx2 = 2 , kDtMbx3 = 3 , kDtMbx4 = 4 , kDtMbx5 = 5 , kDtMbx6 = 6 , kDtMbxJtag = 7 , kDtMbxPcie0 = 8 , kDtMbxPcie1 = 9 , kDtMbxFirst = 0 , kDtMbxCount = 10 } |
| List of instances. More... | |
| enum | dt_mbx_reg_block { kDtMbxRegBlockCore = 0 , kDtMbxRegBlockSoc = 1 , kDtMbxRegBlockCount = 2 } |
| List of register blocks. More... | |
| enum | dt_mbx_memory { kDtMbxMemoryCount = 0 } |
| List of memories. More... | |
| enum | dt_mbx_irq { kDtMbxIrqMbxReady = 0 , kDtMbxIrqMbxAbort = 1 , kDtMbxIrqMbxError = 2 , kDtMbxIrqCount = 3 } |
| List of IRQs. More... | |
| enum | dt_mbx_alert { kDtMbxAlertFatalFault = 0 , kDtMbxAlertRecovFault = 1 , kDtMbxAlertCount = 2 } |
| List of Alerts. More... | |
| enum | dt_mbx_clock { kDtMbxClockClk = 0 , kDtMbxClockCount = 1 } |
| List of clock ports. More... | |
| enum | dt_mbx_reset { kDtMbxResetRst = 0 , kDtMbxResetCount = 1 } |
| List of reset ports. More... | |
Functions | |
| dt_mbx_t | dt_mbx_from_instance_id (dt_instance_id_t inst_id) |
| Get the mbx instance from an instance ID. | |
| dt_instance_id_t | dt_mbx_instance_id (dt_mbx_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_mbx_reg_block (dt_mbx_t dt, dt_mbx_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_mbx_memory_base (dt_mbx_t dt, dt_mbx_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_mbx_memory_size (dt_mbx_t dt, dt_mbx_memory_t mem) |
| Get the size of a memory. | |
| dt_plic_irq_id_t | dt_mbx_irq_to_plic_id (dt_mbx_t dt, dt_mbx_irq_t irq) |
| Get the PLIC ID of a mbx IRQ for a given instance. | |
| dt_mbx_irq_t | dt_mbx_irq_from_plic_id (dt_mbx_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local mbx IRQ type. | |
| dt_alert_id_t | dt_mbx_alert_to_alert_id (dt_mbx_t dt, dt_mbx_alert_t alert) |
| Get the alert ID of a mbx alert for a given instance. | |
| dt_mbx_alert_t | dt_mbx_alert_from_alert_id (dt_mbx_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local mbx alert type. | |
| dt_clock_t | dt_mbx_clock (dt_mbx_t dt, dt_mbx_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_mbx_reset (dt_mbx_t dt, dt_mbx_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP mbx and top darjeeling.
This file contains the type definitions and global functions of the mbx.
Definition in file dt_mbx.h.
| typedef enum dt_mbx_alert dt_mbx_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_mbx_clock dt_mbx_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_mbx_irq dt_mbx_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_mbx_memory dt_mbx_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_mbx_reg_block dt_mbx_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_mbx_reset dt_mbx_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_mbx |
| enum dt_mbx_alert |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| enum dt_mbx_clock |
| enum dt_mbx_irq |
| enum dt_mbx_memory |
| enum dt_mbx_reg_block |
| enum dt_mbx_reset |
| dt_mbx_alert_t dt_mbx_alert_from_alert_id | ( | dt_mbx_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local mbx alert type.
| dt | Instance of mbx. |
| alert | A global alert ID that belongs to this instance. |
kDtMbxAlertCount.Note: This function assumes that the global alert ID belongs to the instance of mbx passed in parameter. In other words, it must be the case that dt_mbx_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtMbxAlertCount.
| dt_alert_id_t dt_mbx_alert_to_alert_id | ( | dt_mbx_t | dt, |
| dt_mbx_alert_t | alert ) |
Get the alert ID of a mbx 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 mbx. |
| alert | A mbx alert. |
| dt_clock_t dt_mbx_clock | ( | dt_mbx_t | dt, |
| dt_mbx_clock_t | clk ) |
| dt_mbx_t dt_mbx_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the mbx 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 mbx, otherwise the returned value is unspecified.
| dt_instance_id_t dt_mbx_instance_id | ( | dt_mbx_t | dt | ) |
| dt_mbx_irq_t dt_mbx_irq_from_plic_id | ( | dt_mbx_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local mbx IRQ type.
| dt | Instance of mbx. |
| irq | A PLIC ID that belongs to this instance. |
kDtMbxIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of mbx passed in parameter. In other words, it must be the case that dt_mbx_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtMbxIrqCount.
| dt_plic_irq_id_t dt_mbx_irq_to_plic_id | ( | dt_mbx_t | dt, |
| dt_mbx_irq_t | irq ) |
| uint32_t dt_mbx_memory_base | ( | dt_mbx_t | dt, |
| dt_mbx_memory_t | mem ) |
| uint32_t dt_mbx_memory_size | ( | dt_mbx_t | dt, |
| dt_mbx_memory_t | mem ) |
| uint32_t dt_mbx_reg_block | ( | dt_mbx_t | dt, |
| dt_mbx_reg_block_t | reg_block ) |
| dt_reset_t dt_mbx_reset | ( | dt_mbx_t | dt, |
| dt_mbx_reset_t | rst ) |