Device Tables (DT) for IP soc_proxy and top darjeeling. More...

#include "hw/top/dt/dt_api.h"
#include <stdint.h>

Typedefs
typedef enum dt_soc_proxy	dt_soc_proxy_t
	List of instances.

typedef enum dt_soc_proxy_reg_block	dt_soc_proxy_reg_block_t
	List of register blocks.

typedef enum dt_soc_proxy_memory	dt_soc_proxy_memory_t
	List of memories.

typedef enum dt_soc_proxy_alert	dt_soc_proxy_alert_t
	List of Alerts.

typedef enum dt_soc_proxy_clock	dt_soc_proxy_clock_t
	List of clock ports.

typedef enum dt_soc_proxy_reset_req	dt_soc_proxy_reset_req_t
	List of reset requests.

typedef enum dt_soc_proxy_reset	dt_soc_proxy_reset_t
	List of reset ports.

typedef enum dt_soc_proxy_periph_io	dt_soc_proxy_periph_io_t
	List of peripheral I/O.

typedef enum dt_soc_proxy_wakeup	dt_soc_proxy_wakeup_t
	List of wakeups.

Enumerations
enum	dt_soc_proxy { kDtSocProxy = 0 , kDtSocProxyFirst = 0 , kDtSocProxyCount = 1 }
	List of instances. More...

enum	dt_soc_proxy_reg_block { kDtSocProxyRegBlockCore = 0 , kDtSocProxyRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_soc_proxy_memory { kDtSocProxyMemoryCtn = 0 , kDtSocProxyMemoryCount = 1 }
	List of memories. More...

enum	dt_soc_proxy_alert { kDtSocProxyAlertFatalAlertIntg = 0 , kDtSocProxyAlertCount = 1 }
	List of Alerts. More...

enum	dt_soc_proxy_clock { kDtSocProxyClockClk = 0 , kDtSocProxyClockAon = 1 , kDtSocProxyClockCount = 2 }
	List of clock ports. More...

enum	dt_soc_proxy_reset_req { kDtSocProxyResetReqExternal = 0 , kDtSocProxyResetReqCount = 1 }
	List of reset requests. More...

enum	dt_soc_proxy_reset { kDtSocProxyResetRst = 0 , kDtSocProxyResetPor = 1 , kDtSocProxyResetCount = 2 }
	List of reset ports. More...

enum	dt_soc_proxy_periph_io { kDtSocProxyPeriphIoSocGpi0 = 0 , kDtSocProxyPeriphIoSocGpi1 = 1 , kDtSocProxyPeriphIoSocGpi2 = 2 , kDtSocProxyPeriphIoSocGpi3 = 3 , kDtSocProxyPeriphIoSocGpi4 = 4 , kDtSocProxyPeriphIoSocGpi5 = 5 , kDtSocProxyPeriphIoSocGpi6 = 6 , kDtSocProxyPeriphIoSocGpi7 = 7 , kDtSocProxyPeriphIoSocGpi8 = 8 , kDtSocProxyPeriphIoSocGpi9 = 9 , kDtSocProxyPeriphIoSocGpi10 = 10 , kDtSocProxyPeriphIoSocGpi11 = 11 , kDtSocProxyPeriphIoSocGpi12 = 12 , kDtSocProxyPeriphIoSocGpi13 = 13 , kDtSocProxyPeriphIoSocGpi14 = 14 , kDtSocProxyPeriphIoSocGpi15 = 15 , kDtSocProxyPeriphIoSocGpo0 = 16 , kDtSocProxyPeriphIoSocGpo1 = 17 , kDtSocProxyPeriphIoSocGpo2 = 18 , kDtSocProxyPeriphIoSocGpo3 = 19 , kDtSocProxyPeriphIoSocGpo4 = 20 , kDtSocProxyPeriphIoSocGpo5 = 21 , kDtSocProxyPeriphIoSocGpo6 = 22 , kDtSocProxyPeriphIoSocGpo7 = 23 , kDtSocProxyPeriphIoSocGpo8 = 24 , kDtSocProxyPeriphIoSocGpo9 = 25 , kDtSocProxyPeriphIoSocGpo10 = 26 , kDtSocProxyPeriphIoSocGpo11 = 27 , kDtSocProxyPeriphIoSocGpo12 = 28 , kDtSocProxyPeriphIoSocGpo13 = 29 , kDtSocProxyPeriphIoSocGpo14 = 30 , kDtSocProxyPeriphIoSocGpo15 = 31 , kDtSocProxyPeriphIoCount = 32 }
	List of peripheral I/O. More...

enum	dt_soc_proxy_wakeup { kDtSocProxyWakeupWkupExternalReq = 0 , kDtSocProxyWakeupCount = 1 }
	List of wakeups. More...

Functions
dt_soc_proxy_t	dt_soc_proxy_from_instance_id (dt_instance_id_t inst_id)
	Get the soc_proxy instance from an instance ID.

dt_instance_id_t	dt_soc_proxy_instance_id (dt_soc_proxy_t dt)
	Get the instance ID of an instance.

uint32_t	dt_soc_proxy_reg_block (dt_soc_proxy_t dt, dt_soc_proxy_reg_block_t reg_block)
	Get the register base address of an instance.

uint32_t	dt_soc_proxy_memory_base (dt_soc_proxy_t dt, dt_soc_proxy_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_soc_proxy_memory_size (dt_soc_proxy_t dt, dt_soc_proxy_memory_t mem)
	Get the size of a memory.

dt_alert_id_t	dt_soc_proxy_alert_to_alert_id (dt_soc_proxy_t dt, dt_soc_proxy_alert_t alert)
	Get the alert ID of a soc_proxy alert for a given instance.

dt_soc_proxy_alert_t	dt_soc_proxy_alert_from_alert_id (dt_soc_proxy_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local soc_proxy alert type.

dt_periph_io_t	dt_soc_proxy_periph_io (dt_soc_proxy_t dt, dt_soc_proxy_periph_io_t sig)
	Get the peripheral I/O description of an instance.

dt_clock_t	dt_soc_proxy_clock (dt_soc_proxy_t dt, dt_soc_proxy_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_soc_proxy_reset (dt_soc_proxy_t dt, dt_soc_proxy_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP soc_proxy and top darjeeling.

This file contains the type definitions and global functions of the soc_proxy.

Definition in file dt_soc_proxy.h.

Typedef Documentation

◆ dt_soc_proxy_alert_t

typedef enum dt_soc_proxy_alert dt_soc_proxy_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_soc_proxy_clock_t

typedef enum dt_soc_proxy_clock dt_soc_proxy_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_soc_proxy_memory_t

typedef enum dt_soc_proxy_memory dt_soc_proxy_memory_t

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

◆ dt_soc_proxy_periph_io_t

typedef enum dt_soc_proxy_periph_io dt_soc_proxy_periph_io_t

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

◆ dt_soc_proxy_reg_block_t

typedef enum dt_soc_proxy_reg_block dt_soc_proxy_reg_block_t

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

◆ dt_soc_proxy_reset_req_t

typedef enum dt_soc_proxy_reset_req dt_soc_proxy_reset_req_t

List of reset requests.

Reset requests are guaranteed to be numbered consecutively from 0.

◆ dt_soc_proxy_reset_t

typedef enum dt_soc_proxy_reset dt_soc_proxy_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

◆ dt_soc_proxy_wakeup_t

typedef enum dt_soc_proxy_wakeup dt_soc_proxy_wakeup_t

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_soc_proxy

enum dt_soc_proxy

List of instances.

Enumerator
kDtSocProxy	soc_proxy

Definition at line 29 of file dt_soc_proxy.h.

◆ dt_soc_proxy_alert

enum dt_soc_proxy_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSocProxyAlertFatalAlertIntg	Fatal bus integrity alert.

Definition at line 63 of file dt_soc_proxy.h.

◆ dt_soc_proxy_clock

enum dt_soc_proxy_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSocProxyClockClk	Clock port clk_i.
kDtSocProxyClockAon	Clock port clk_aon_i.

Definition at line 73 of file dt_soc_proxy.h.

◆ dt_soc_proxy_memory

enum dt_soc_proxy_memory

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 53 of file dt_soc_proxy.h.

◆ dt_soc_proxy_periph_io

enum dt_soc_proxy_periph_io

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

Definition at line 105 of file dt_soc_proxy.h.

◆ dt_soc_proxy_reg_block

enum dt_soc_proxy_reg_block

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 40 of file dt_soc_proxy.h.

◆ dt_soc_proxy_reset

enum dt_soc_proxy_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSocProxyResetRst	Reset port rst_ni.
kDtSocProxyResetPor	Reset port rst_por_ni.

Definition at line 94 of file dt_soc_proxy.h.

◆ dt_soc_proxy_reset_req

enum dt_soc_proxy_reset_req

List of reset requests.

Reset requests are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSocProxyResetReqExternal	External reset request.

Definition at line 84 of file dt_soc_proxy.h.

◆ dt_soc_proxy_wakeup

enum dt_soc_proxy_wakeup

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSocProxyWakeupWkupExternalReq	External wakeup request.

Definition at line 146 of file dt_soc_proxy.h.

Function Documentation

◆ dt_soc_proxy_alert_from_alert_id()

dt_soc_proxy_alert_t dt_soc_proxy_alert_from_alert_id	(	dt_soc_proxy_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The soc_proxy alert, or kDtSocProxyAlertCount.

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

Definition at line 367 of file dt_soc_proxy.c.

◆ dt_soc_proxy_alert_to_alert_id()

dt_alert_id_t dt_soc_proxy_alert_to_alert_id	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_alert_t	alert )

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

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

Definition at line 361 of file dt_soc_proxy.c.

◆ dt_soc_proxy_clock()

dt_clock_t dt_soc_proxy_clock	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_clock_t	clk )

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

Parameters

dt	Instance of soc_proxy.
clk	Clock port.

Returns: Clock signal.

Definition at line 385 of file dt_soc_proxy.c.

◆ dt_soc_proxy_from_instance_id()

dt_soc_proxy_t dt_soc_proxy_from_instance_id ( dt_instance_id_t inst_id )

Get the soc_proxy instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A soc_proxy instance.

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

Definition at line 327 of file dt_soc_proxy.c.

◆ dt_soc_proxy_instance_id()

dt_instance_id_t dt_soc_proxy_instance_id ( dt_soc_proxy_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of soc_proxy.

Returns: The instance ID of that instance.

Definition at line 334 of file dt_soc_proxy.c.

◆ dt_soc_proxy_memory_base()

uint32_t dt_soc_proxy_memory_base	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of soc_proxy.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 346 of file dt_soc_proxy.c.

◆ dt_soc_proxy_memory_size()

uint32_t dt_soc_proxy_memory_size	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of soc_proxy.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 353 of file dt_soc_proxy.c.

◆ dt_soc_proxy_periph_io()

dt_periph_io_t dt_soc_proxy_periph_io	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

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

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

Definition at line 378 of file dt_soc_proxy.c.

◆ dt_soc_proxy_reg_block()

uint32_t dt_soc_proxy_reg_block	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of soc_proxy.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 339 of file dt_soc_proxy.c.

◆ dt_soc_proxy_reset()

dt_reset_t dt_soc_proxy_reset	(	dt_soc_proxy_t	dt,
		dt_soc_proxy_reset_t	rst )

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

Parameters

dt	Instance of soc_proxy.
rst	Reset port.

Returns: Reset signal.

Definition at line 392 of file dt_soc_proxy.c.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ dt_soc_proxy_alert_t

◆ dt_soc_proxy_clock_t

◆ dt_soc_proxy_memory_t

◆ dt_soc_proxy_periph_io_t

◆ dt_soc_proxy_reg_block_t

◆ dt_soc_proxy_reset_req_t

◆ dt_soc_proxy_reset_t

◆ dt_soc_proxy_wakeup_t

Enumeration Type Documentation

◆ dt_soc_proxy

◆ dt_soc_proxy_alert

◆ dt_soc_proxy_clock

◆ dt_soc_proxy_memory

◆ dt_soc_proxy_periph_io

◆ dt_soc_proxy_reg_block

◆ dt_soc_proxy_reset

◆ dt_soc_proxy_reset_req

◆ dt_soc_proxy_wakeup

Function Documentation

◆ dt_soc_proxy_alert_from_alert_id()

◆ dt_soc_proxy_alert_to_alert_id()

◆ dt_soc_proxy_clock()

◆ dt_soc_proxy_from_instance_id()

◆ dt_soc_proxy_instance_id()

◆ dt_soc_proxy_memory_base()

◆ dt_soc_proxy_memory_size()

◆ dt_soc_proxy_periph_io()

◆ dt_soc_proxy_reg_block()

◆ dt_soc_proxy_reset()