Pavona Software APIs
acc.c File Reference

Device Tables (DT) for IP acc and top dragonfly. More...

#include "hw/top/dt/acc.h"

Go to the source code of this file.

Data Structures

struct  dt_desc_acc
 Description of instances. More...
 

Macros

#define TRY_GET_DT(dt, default)
 Return a pointer to the dt_acc_desc_t structure of the requested dt if it's a valid index.
 

Typedefs

typedef struct dt_desc_acc dt_desc_acc_t
 Description of instances.
 

Functions

dt_acc_t dt_acc_from_instance_id (dt_instance_id_t inst_id)
 Get the acc instance from an instance ID.
 
dt_instance_id_t dt_acc_instance_id (dt_acc_t dt)
 Get the instance ID of an instance.
 
uint32_t dt_acc_reg_block (dt_acc_t dt, dt_acc_reg_block_t reg_block)
 Get the register base address of an instance.
 
dt_plic_irq_id_t dt_acc_irq_to_plic_id (dt_acc_t dt, dt_acc_irq_t irq)
 Get the PLIC ID of a acc IRQ for a given instance.
 
dt_acc_irq_t dt_acc_irq_from_plic_id (dt_acc_t dt, dt_plic_irq_id_t irq)
 Convert a global IRQ ID to a local acc IRQ type.
 
dt_alert_id_t dt_acc_alert_to_alert_id (dt_acc_t dt, dt_acc_alert_t alert)
 Get the alert ID of a acc alert for a given instance.
 
dt_acc_alert_t dt_acc_alert_from_alert_id (dt_acc_t dt, dt_alert_id_t alert)
 Convert a global alert ID to a local acc alert type.
 
dt_clock_t dt_acc_clock (dt_acc_t dt, dt_acc_clock_t clk)
 Get the clock signal connected to a clock port of an instance.
 
dt_reset_t dt_acc_reset (dt_acc_t dt, dt_acc_reset_t rst)
 Get the reset signal connected to a reset port of an instance.
 

Detailed Description

Device Tables (DT) for IP acc and top dragonfly.

Definition in file acc.c.


Data Structure Documentation

◆ dt_desc_acc

struct dt_desc_acc

Description of instances.

Definition at line 19 of file acc.c.

Data Fields
dt_clock_t clock[kDtAccClockCount] Clock signal connected to each clock port.
top_dragonfly_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_egret_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_dragonfly_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_egret_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.
uint32_t reg_addr[kDtAccRegBlockCount] Base address of each register block.
dt_reset_t reset[kDtAccResetCount] Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT ( dt,
default )
Value:
({ if ((dt) < (dt_acc_t)0 || (int)(dt) >= kDtAccCount) return (default); &acc_desc[dt]; })

Return a pointer to the dt_acc_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 acc.c.

Function Documentation

◆ dt_acc_alert_from_alert_id()

dt_acc_alert_t dt_acc_alert_from_alert_id ( dt_acc_t dt,
dt_alert_id_t alert )

Convert a global alert ID to a local acc alert type.

Parameters
dtInstance of acc.
alertA global alert ID that belongs to this instance.
Returns
The acc alert, or kDtAccAlertCount.

Note: This function assumes that the global alert ID belongs to the instance of acc passed in parameter. In other words, it must be the case that dt_acc_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtAccAlertCount.

Definition at line 119 of file acc.c.

◆ dt_acc_alert_to_alert_id()

dt_alert_id_t dt_acc_alert_to_alert_id ( dt_acc_t dt,
dt_acc_alert_t alert )

Get the alert ID of a acc 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
dtInstance of acc.
alertA acc alert.
Returns
The Alert Handler alert ID of the alert of this instance.

Definition at line 113 of file acc.c.

◆ dt_acc_clock()

Get the clock signal connected to a clock port of an instance.

Parameters
dtInstance of acc.
clkClock port.
Returns
Clock signal.

Definition at line 131 of file acc.c.

◆ dt_acc_from_instance_id()

dt_acc_t dt_acc_from_instance_id ( dt_instance_id_t inst_id)

Get the acc instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters
inst_idInstance ID.
Returns
A acc instance.

Note: This function only makes sense if the instance ID has device type acc, otherwise the returned value is unspecified.

Definition at line 69 of file acc.c.

◆ dt_acc_instance_id()

dt_instance_id_t dt_acc_instance_id ( dt_acc_t dt)

Get the instance ID of an instance.

Parameters
dtInstance of acc.
Returns
The instance ID of that instance.

Definition at line 76 of file acc.c.

◆ dt_acc_irq_from_plic_id()

dt_acc_irq_t dt_acc_irq_from_plic_id ( dt_acc_t dt,
dt_plic_irq_id_t irq )

Convert a global IRQ ID to a local acc IRQ type.

Parameters
dtInstance of acc.
irqA PLIC ID that belongs to this instance.
Returns
The acc IRQ, or kDtAccIrqCount.

Note: This function assumes that the PLIC ID belongs to the instance of acc passed in parameter. In other words, it must be the case that dt_acc_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtAccIrqCount.

Definition at line 98 of file acc.c.

◆ dt_acc_irq_to_plic_id()

dt_plic_irq_id_t dt_acc_irq_to_plic_id ( dt_acc_t dt,
dt_acc_irq_t irq )

Get the PLIC ID of a acc IRQ for a given instance.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters
dtInstance of acc.
irqA acc IRQ.
Returns
The PLIC ID of the IRQ of this instance.

Definition at line 88 of file acc.c.

◆ dt_acc_reg_block()

uint32_t dt_acc_reg_block ( dt_acc_t dt,
dt_acc_reg_block_t reg_block )

Get the register base address of an instance.

Parameters
dtInstance of acc.
reg_blockThe register block requested.
Returns
The register base address of the requested block.

Definition at line 81 of file acc.c.

◆ dt_acc_reset()

Get the reset signal connected to a reset port of an instance.

Parameters
dtInstance of acc.
rstReset port.
Returns
Reset signal.

Definition at line 138 of file acc.c.