Software APIs
dt_ast.c File Reference

Device Tables (DT) for IP ast and top earlgrey. More...

#include "dt/dt_ast.h"

Go to the source code of this file.

Data Structures

struct  dt_desc_ast
 Description of instances. More...
 

Macros

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

Typedefs

typedef struct dt_desc_ast dt_desc_ast_t
 Description of instances.
 

Functions

dt_ast_t dt_ast_from_instance_id (dt_instance_id_t inst_id)
 Get the ast instance from an instance ID.
 
dt_instance_id_t dt_ast_instance_id (dt_ast_t dt)
 Get the instance ID of an instance.
 
uint32_t dt_ast_reg_block (dt_ast_t dt, dt_ast_reg_block_t reg_block)
 Get the register base address of an instance.
 
dt_clock_t dt_ast_clock (dt_ast_t dt, dt_ast_clock_t clk)
 Get the clock signal connected to a clock port of an instance.
 
dt_reset_t dt_ast_reset (dt_ast_t dt, dt_ast_reset_t rst)
 Get the reset signal connected to a reset port of an instance.
 

Detailed Description

Device Tables (DT) for IP ast and top earlgrey.

Definition in file dt_ast.c.


Data Structure Documentation

◆ dt_desc_ast

struct dt_desc_ast

Description of instances.

Definition at line 19 of file dt_ast.c.

Data Fields
uint32_t base_addr[kDtAstRegBlockCount] Base address of each register block.
dt_clock_t clock[kDtAstClockCount] Clock signal connected to each clock port.
dt_instance_id_t inst_id Instance ID.
dt_reset_t reset[kDtAstResetCount] Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT ( dt,
default )
Value:
({ if ((dt) < (dt_ast_t)0 || (dt) >= kDtAstCount) return (default); &ast_desc[dt]; })

Return a pointer to the dt_ast_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 59 of file dt_ast.c.

Function Documentation

◆ dt_ast_clock()

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

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

Definition at line 83 of file dt_ast.c.

◆ dt_ast_from_instance_id()

dt_ast_t dt_ast_from_instance_id ( dt_instance_id_t inst_id)

Get the ast instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters
inst_idInstance ID.
Returns
A ast instance.

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

Definition at line 61 of file dt_ast.c.

◆ dt_ast_instance_id()

dt_instance_id_t dt_ast_instance_id ( dt_ast_t dt)

Get the instance ID of an instance.

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

Definition at line 68 of file dt_ast.c.

◆ dt_ast_reg_block()

uint32_t dt_ast_reg_block ( dt_ast_t dt,
dt_ast_reg_block_t reg_block )

Get the register base address of an instance.

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

Definition at line 73 of file dt_ast.c.

◆ dt_ast_reset()

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

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

Definition at line 90 of file dt_ast.c.