Device Tables (DT) for IP otbn and top earlgrey.
More...
#include "hw/top/dt/dt_otbn.h"
Go to the source code of this file.
|
#define | TRY_GET_DT(dt, default) |
| Return a pointer to the dt_otbn_desc_t structure of the requested dt if it's a valid index.
|
|
|
typedef struct dt_desc_otbn | dt_desc_otbn_t |
| Description of instances.
|
|
Device Tables (DT) for IP otbn and top earlgrey.
Definition in file dt_otbn.c.
◆ dt_desc_otbn
Description of instances.
Definition at line 19 of file dt_otbn.c.
Data Fields |
uint32_t |
base_addr[kDtOtbnRegBlockCount] |
Base address of each register block. |
dt_clock_t |
clock[kDtOtbnClockCount] |
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.
|
top_darjeeling_plic_irq_id_t |
first_irq |
PLIC ID of the first IRQ of this instance. This can be kDtPlicIrqIdNone if the block is not connected to the PLIC.
|
top_earlgrey_plic_irq_id_t |
first_irq |
PLIC ID of the first IRQ of this instance. This can be kDtPlicIrqIdNone if the block is not connected to the PLIC.
|
dt_instance_id_t |
inst_id |
Instance ID. |
dt_reset_t |
reset[kDtOtbnResetCount] |
Reset signal connected to each reset port. |
◆ TRY_GET_DT
#define TRY_GET_DT |
( |
| dt, |
|
|
| default ) |
Value:({
if ((dt) < (
dt_otbn_t)0 || (dt) >= kDtOtbnCount)
return (
default); &otbn_desc[dt]; })
Return a pointer to the dt_otbn_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 67 of file dt_otbn.c.
◆ dt_otbn_alert_from_alert_id()
Convert a global alert ID to a local otbn alert type.
- Parameters
-
dt | Instance of otbn. |
alert | A global alert ID that belongs to this instance. |
- Returns
- The otbn alert, or
kDtOtbnAlertCount
.
Note: This function assumes that the global alert ID belongs to the instance of otbn passed in parameter. In other words, it must be the case that dt_otbn_instance_id(dt) == dt_alert_id_to_instance_id(alert)
. Otherwise, this function will return kDtOtbnAlertCount
.
Definition at line 119 of file dt_otbn.c.
◆ dt_otbn_alert_to_alert_id()
Get the alert ID of a otbn 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.
- Parameters
-
dt | Instance of otbn. |
alert | A otbn alert. |
- Returns
- The Alert Handler alert ID of the alert of this instance.
Definition at line 113 of file dt_otbn.c.
◆ dt_otbn_clock()
Get the clock signal connected to a clock port of an instance.
- Parameters
-
dt | Instance of otbn. |
clk | Clock port. |
- Returns
- Clock signal.
Definition at line 131 of file dt_otbn.c.
◆ dt_otbn_from_instance_id()
Get the otbn instance from an instance ID.
For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3
.
- Parameters
-
- Returns
- A otbn instance.
Note: This function only makes sense if the instance ID has device type otbn, otherwise the returned value is unspecified.
Definition at line 69 of file dt_otbn.c.
◆ dt_otbn_instance_id()
Get the instance ID of an instance.
- Parameters
-
- Returns
- The instance ID of that instance.
Definition at line 76 of file dt_otbn.c.
◆ dt_otbn_irq_from_plic_id()
Convert a global IRQ ID to a local otbn IRQ type.
- Parameters
-
dt | Instance of otbn. |
irq | A PLIC ID that belongs to this instance. |
- Returns
- The otbn IRQ, or
kDtOtbnIrqCount
.
Note: This function assumes that the PLIC ID belongs to the instance of otbn passed in parameter. In other words, it must be the case that dt_otbn_instance_id(dt) == dt_plic_id_to_instance_id(irq)
. Otherwise, this function will return kDtOtbnIrqCount
.
Definition at line 98 of file dt_otbn.c.
◆ dt_otbn_irq_to_plic_id()
Get the PLIC ID of a otbn IRQ for a given instance.
If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone
.
- Parameters
-
dt | Instance of otbn. |
irq | A otbn IRQ. |
- Returns
- The PLIC ID of the IRQ of this instance.
Definition at line 88 of file dt_otbn.c.
◆ dt_otbn_reg_block()
Get the register base address of an instance.
- Parameters
-
dt | Instance of otbn. |
reg_block | The register block requested. |
- Returns
- The register base address of the requested block.
Definition at line 81 of file dt_otbn.c.
◆ dt_otbn_reset()
Get the reset signal connected to a reset port of an instance.
- Parameters
-
dt | Instance of otbn. |
rst | Reset port. |
- Returns
- Reset signal.
Definition at line 138 of file dt_otbn.c.