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

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

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

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

Typedefs
typedef struct dt_desc_usbdev	dt_desc_usbdev_t
	Description of instances.

Functions
dt_usbdev_t	dt_usbdev_from_instance_id (dt_instance_id_t inst_id)
	Get the usbdev instance from an instance ID.

dt_instance_id_t	dt_usbdev_instance_id (dt_usbdev_t dt)
	Get the instance ID of an instance.

uint32_t	dt_usbdev_reg_block (dt_usbdev_t dt, dt_usbdev_reg_block_t reg_block)
	Get the register base address of an instance.

uint32_t	dt_usbdev_memory_base (dt_usbdev_t dt, dt_usbdev_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_usbdev_memory_size (dt_usbdev_t dt, dt_usbdev_memory_t mem)
	Get the size of a memory.

dt_plic_irq_id_t	dt_usbdev_irq_to_plic_id (dt_usbdev_t dt, dt_usbdev_irq_t irq)
	Get the PLIC ID of a usbdev IRQ for a given instance.

dt_usbdev_irq_t	dt_usbdev_irq_from_plic_id (dt_usbdev_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local usbdev IRQ type.

dt_alert_id_t	dt_usbdev_alert_to_alert_id (dt_usbdev_t dt, dt_usbdev_alert_t alert)
	Get the alert ID of a usbdev alert for a given instance.

dt_usbdev_alert_t	dt_usbdev_alert_from_alert_id (dt_usbdev_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local usbdev alert type.

dt_periph_io_t	dt_usbdev_periph_io (dt_usbdev_t dt, dt_usbdev_periph_io_t sig)
	Get the peripheral I/O description of an instance.

dt_clock_t	dt_usbdev_clock (dt_usbdev_t dt, dt_usbdev_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_usbdev_reset (dt_usbdev_t dt, dt_usbdev_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file usbdev.c.

Data Structure Documentation

◆ dt_desc_usbdev

struct dt_desc_usbdev

Description of instances.

Definition at line 19 of file usbdev.c.

Data Fields
dt_clock_t	clock[kDtUsbdevClockCount]	Clock signal connected to each clock port.
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_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.
uint32_t	mem_addr[kDtUsbdevMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtUsbdevMemoryCount]	Size in bytes of each memory.
dt_periph_io_t	periph_io[kDtUsbdevPeriphIoCount]	Description of each peripheral I/O.
uint32_t	reg_addr[kDtUsbdevRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtUsbdevResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_usbdev_t)0 || (dt) >= kDtUsbdevCount) return (default); &usbdev_desc[dt]; })

Return a pointer to the dt_usbdev_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 98 of file usbdev.c.

Function Documentation

◆ dt_usbdev_alert_from_alert_id()

dt_usbdev_alert_t dt_usbdev_alert_from_alert_id	(	dt_usbdev_t	dt,
		dt_alert_id_t	alert )

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

Parameters

dt	Instance of usbdev.
alert	A global alert ID that belongs to this instance.

Returns: The usbdev alert, or kDtUsbdevAlertCount.

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

Definition at line 164 of file usbdev.c.

◆ dt_usbdev_alert_to_alert_id()

dt_alert_id_t dt_usbdev_alert_to_alert_id	(	dt_usbdev_t	dt,
		dt_usbdev_alert_t	alert )

Get the alert ID of a usbdev 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 usbdev.
alert	A usbdev alert.

Returns: The Alert Handler alert ID of the alert of this instance.

Definition at line 158 of file usbdev.c.

◆ dt_usbdev_clock()

dt_clock_t dt_usbdev_clock	(	dt_usbdev_t	dt,
		dt_usbdev_clock_t	clk )

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

Parameters

dt	Instance of usbdev.
clk	Clock port.

Returns: Clock signal.

Definition at line 182 of file usbdev.c.

◆ dt_usbdev_from_instance_id()

dt_usbdev_t dt_usbdev_from_instance_id ( dt_instance_id_t inst_id )

Get the usbdev instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A usbdev instance.

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

Definition at line 100 of file usbdev.c.

◆ dt_usbdev_instance_id()

dt_instance_id_t dt_usbdev_instance_id ( dt_usbdev_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of usbdev.

Returns: The instance ID of that instance.

Definition at line 107 of file usbdev.c.

◆ dt_usbdev_irq_from_plic_id()

dt_usbdev_irq_t dt_usbdev_irq_from_plic_id	(	dt_usbdev_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The usbdev IRQ, or kDtUsbdevIrqCount.

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

Definition at line 143 of file usbdev.c.

◆ dt_usbdev_irq_to_plic_id()

dt_plic_irq_id_t dt_usbdev_irq_to_plic_id	(	dt_usbdev_t	dt,
		dt_usbdev_irq_t	irq )

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

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

Parameters

dt	Instance of usbdev.
irq	A usbdev IRQ.

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

Definition at line 133 of file usbdev.c.

◆ dt_usbdev_memory_base()

uint32_t dt_usbdev_memory_base	(	dt_usbdev_t	dt,
		dt_usbdev_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of usbdev.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 119 of file usbdev.c.

◆ dt_usbdev_memory_size()

uint32_t dt_usbdev_memory_size	(	dt_usbdev_t	dt,
		dt_usbdev_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of usbdev.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 126 of file usbdev.c.

◆ dt_usbdev_periph_io()

dt_periph_io_t dt_usbdev_periph_io	(	dt_usbdev_t	dt,
		dt_usbdev_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

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

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

Definition at line 175 of file usbdev.c.

◆ dt_usbdev_reg_block()

uint32_t dt_usbdev_reg_block	(	dt_usbdev_t	dt,
		dt_usbdev_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of usbdev.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 112 of file usbdev.c.

◆ dt_usbdev_reset()

dt_reset_t dt_usbdev_reset	(	dt_usbdev_t	dt,
		dt_usbdev_reset_t	rst )

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

Parameters

dt	Instance of usbdev.
rst	Reset port.

Returns: Reset signal.

Definition at line 189 of file usbdev.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_usbdev

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_usbdev_alert_from_alert_id()

◆ dt_usbdev_alert_to_alert_id()

◆ dt_usbdev_clock()

◆ dt_usbdev_from_instance_id()

◆ dt_usbdev_instance_id()

◆ dt_usbdev_irq_from_plic_id()

◆ dt_usbdev_irq_to_plic_id()

◆ dt_usbdev_memory_base()

◆ dt_usbdev_memory_size()

◆ dt_usbdev_periph_io()

◆ dt_usbdev_reg_block()

◆ dt_usbdev_reset()