Device Tables (DT) for IP uart and top englishbreakfast. More...

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

Data Structures
struct	dt_desc_uart
	Description of instances. More...

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

Typedefs
typedef struct dt_desc_uart	dt_desc_uart_t
	Description of instances.

Functions
dt_uart_t	dt_uart_from_instance_id (dt_instance_id_t inst_id)
	Get the uart instance from an instance ID.

dt_instance_id_t	dt_uart_instance_id (dt_uart_t dt)
	Get the instance ID of an instance.

uint32_t	dt_uart_reg_block (dt_uart_t dt, dt_uart_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_uart_irq_to_plic_id (dt_uart_t dt, dt_uart_irq_t irq)
	Get the PLIC ID of a uart IRQ for a given instance.

dt_uart_irq_t	dt_uart_irq_from_plic_id (dt_uart_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local uart IRQ type.

dt_periph_io_t	dt_uart_periph_io (dt_uart_t dt, dt_uart_periph_io_t sig)
	Get the peripheral I/O description of an instance.

dt_clock_t	dt_uart_clock (dt_uart_t dt, dt_uart_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_uart_reset (dt_uart_t dt, dt_uart_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP uart and top englishbreakfast.

Definition in file dt_uart.c.

Data Structure Documentation

◆ dt_desc_uart

struct dt_desc_uart

Description of instances.

Definition at line 19 of file dt_uart.c.

Data Fields
uint32_t	base_addr[kDtUartRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtUartClockCount]	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.
top_englishbreakfast_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_periph_io_t	periph_io[kDtUartPeriphIoCount]	Description of each peripheral I/O.
dt_reset_t	reset[kDtUartResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_uart_t)0 || (dt) >= kDtUartCount) return (default); &uart_desc[dt]; })

Return a pointer to the dt_uart_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 106 of file dt_uart.c.

Function Documentation

◆ dt_uart_clock()

dt_clock_t dt_uart_clock	(	dt_uart_t	dt,
		dt_uart_clock_t	clk )

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

Parameters

dt	Instance of uart.
clk	Clock port.

Returns: Clock signal.

Definition at line 160 of file dt_uart.c.

◆ dt_uart_from_instance_id()

dt_uart_t dt_uart_from_instance_id ( dt_instance_id_t inst_id )

Get the uart instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A uart instance.

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

Definition at line 108 of file dt_uart.c.

◆ dt_uart_instance_id()

dt_instance_id_t dt_uart_instance_id ( dt_uart_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of uart.

Returns: The instance ID of that instance.

Definition at line 115 of file dt_uart.c.

◆ dt_uart_irq_from_plic_id()

dt_uart_irq_t dt_uart_irq_from_plic_id	(	dt_uart_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

dt	Instance of uart.
irq	A PLIC ID that belongs to this instance.

Returns: The uart IRQ, or kDtUartIrqCount.

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

Definition at line 137 of file dt_uart.c.

◆ dt_uart_irq_to_plic_id()

dt_plic_irq_id_t dt_uart_irq_to_plic_id	(	dt_uart_t	dt,
		dt_uart_irq_t	irq )

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

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

Parameters

dt	Instance of uart.
irq	A uart IRQ.

Returns: The PLIC ID of the IRQ of this instance.

Definition at line 127 of file dt_uart.c.

◆ dt_uart_periph_io()

dt_periph_io_t dt_uart_periph_io	(	dt_uart_t	dt,
		dt_uart_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

dt	Instance of uart.
sig	Requested peripheral I/O.

Returns: Description of the requested peripheral I/O for this instance.

Definition at line 153 of file dt_uart.c.

◆ dt_uart_reg_block()

uint32_t dt_uart_reg_block	(	dt_uart_t	dt,
		dt_uart_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of uart.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 120 of file dt_uart.c.

◆ dt_uart_reset()

dt_reset_t dt_uart_reset	(	dt_uart_t	dt,
		dt_uart_reset_t	rst )

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

Parameters

dt	Instance of uart.
rst	Reset port.

Returns: Reset signal.

Definition at line 167 of file dt_uart.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_uart

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_uart_clock()

◆ dt_uart_from_instance_id()

◆ dt_uart_instance_id()

◆ dt_uart_irq_from_plic_id()

◆ dt_uart_irq_to_plic_id()

◆ dt_uart_periph_io()

◆ dt_uart_reg_block()

◆ dt_uart_reset()