 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP cheriot and top earlgrey. More...
#include "hw/top/dt/api.h"#include <stdint.h>Go to the source code of this file.
Macros | |
| #define | OPENTITAN_CHERIOT_HAS_TAG_SPLIT 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_CHERIOT_HAS_TAG_READ 1 |
| #define | OPENTITAN_CHERIOT_HAS_TAG_WRITE_RMW 1 |
| #define | OPENTITAN_CHERIOT_HAS_TAG_CLEAR_ON_DATA_WRITE 1 |
| #define | OPENTITAN_CHERIOT_HAS_REVOCATION_BITMAP 1 |
| #define | OPENTITAN_CHERIOT_HAS_ACCESS_CHECK 1 |
| #define | OPENTITAN_CHERIOT_HAS_MODE_GATING 1 |
Typedefs | |
| typedef enum dt_cheriot | dt_cheriot_t |
| List of instances. | |
| typedef enum dt_cheriot_reg_block | dt_cheriot_reg_block_t |
| List of register blocks. | |
| typedef enum dt_cheriot_memory | dt_cheriot_memory_t |
| List of memories. | |
| typedef enum dt_cheriot_alert | dt_cheriot_alert_t |
| List of Alerts. | |
| typedef enum dt_cheriot_clock | dt_cheriot_clock_t |
| List of clock ports. | |
| typedef enum dt_cheriot_reset | dt_cheriot_reset_t |
| List of reset ports. | |
Enumerations | |
| enum | dt_cheriot { kDtCheriotFirst = 0 , kDtCheriot = 0 } |
| List of instances. More... | |
| enum | { kDtCheriotCount = 1 } |
| enum | dt_cheriot_reg_block { kDtCheriotRegBlockRegs = 0 } |
| List of register blocks. More... | |
| enum | { kDtCheriotRegBlockCount = 1 } |
| enum | dt_cheriot_memory { kDtCheriotMemoryRevbm = 0 } |
| List of memories. More... | |
| enum | { kDtCheriotMemoryCount = 1 } |
| enum | dt_cheriot_alert { kDtCheriotAlertFatalFault = 0 } |
| List of Alerts. More... | |
| enum | { kDtCheriotAlertCount = 1 } |
| enum | dt_cheriot_clock { kDtCheriotClockClk = 0 } |
| List of clock ports. More... | |
| enum | { kDtCheriotClockCount = 1 } |
| enum | dt_cheriot_reset { kDtCheriotResetRst = 0 } |
| List of reset ports. More... | |
| enum | { kDtCheriotResetCount = 1 } |
Functions | |
| dt_cheriot_t | dt_cheriot_from_instance_id (dt_instance_id_t inst_id) |
| Get the cheriot instance from an instance ID. | |
| dt_instance_id_t | dt_cheriot_instance_id (dt_cheriot_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_cheriot_reg_block (dt_cheriot_t dt, dt_cheriot_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_cheriot_memory_base (dt_cheriot_t dt, dt_cheriot_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_cheriot_memory_size (dt_cheriot_t dt, dt_cheriot_memory_t mem) |
| Get the size of a memory. | |
| dt_alert_id_t | dt_cheriot_alert_to_alert_id (dt_cheriot_t dt, dt_cheriot_alert_t alert) |
| Get the alert ID of a cheriot alert for a given instance. | |
| dt_cheriot_alert_t | dt_cheriot_alert_from_alert_id (dt_cheriot_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local cheriot alert type. | |
| dt_clock_t | dt_cheriot_clock (dt_cheriot_t dt, dt_cheriot_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_cheriot_reset (dt_cheriot_t dt, dt_cheriot_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP cheriot and top earlgrey.
This file contains the type definitions and global functions of the cheriot.
Definition in file cheriot.h.
| #define OPENTITAN_CHERIOT_HAS_TAG_SPLIT 1 |
| typedef enum dt_cheriot_alert dt_cheriot_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_cheriot_clock dt_cheriot_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_cheriot_memory dt_cheriot_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_cheriot_reg_block dt_cheriot_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_cheriot_reset dt_cheriot_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| anonymous enum |
| anonymous enum |
| anonymous enum |
| anonymous enum |
| anonymous enum |
| anonymous enum |
| enum dt_cheriot |
| enum dt_cheriot_alert |
| enum dt_cheriot_clock |
| enum dt_cheriot_memory |
| enum dt_cheriot_reg_block |
| enum dt_cheriot_reset |
| dt_cheriot_alert_t dt_cheriot_alert_from_alert_id | ( | dt_cheriot_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local cheriot alert type.
| dt | Instance of cheriot. |
| alert | A global alert ID that belongs to this instance. |
kDtCheriotAlertCount.Note: This function assumes that the global alert ID belongs to the instance of cheriot passed in parameter. In other words, it must be the case that dt_cheriot_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtCheriotAlertCount.
| dt_alert_id_t dt_cheriot_alert_to_alert_id | ( | dt_cheriot_t | dt, |
| dt_cheriot_alert_t | alert ) |
Get the alert ID of a cheriot 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. |
| alert | A cheriot alert. |
| dt_clock_t dt_cheriot_clock | ( | dt_cheriot_t | dt, |
| dt_cheriot_clock_t | clk ) |
| dt_cheriot_t dt_cheriot_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the cheriot 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, otherwise the returned value is unspecified.
| dt_instance_id_t dt_cheriot_instance_id | ( | dt_cheriot_t | dt | ) |
| uint32_t dt_cheriot_memory_base | ( | dt_cheriot_t | dt, |
| dt_cheriot_memory_t | mem ) |
| uint32_t dt_cheriot_memory_size | ( | dt_cheriot_t | dt, |
| dt_cheriot_memory_t | mem ) |
| uint32_t dt_cheriot_reg_block | ( | dt_cheriot_t | dt, |
| dt_cheriot_reg_block_t | reg_block ) |
| dt_reset_t dt_cheriot_reset | ( | dt_cheriot_t | dt, |
| dt_cheriot_reset_t | rst ) |