dt_pinmux.c File Reference

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

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

Go to the source code of this file.

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

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

Typedefs
typedef struct dt_desc_pinmux	dt_desc_pinmux_t
	Description of instances.

Functions
dt_pinmux_t	dt_pinmux_from_instance_id (dt_instance_id_t inst_id)
	Get the pinmux instance from an instance ID.
dt_instance_id_t	dt_pinmux_instance_id (dt_pinmux_t dt)
	Get the instance ID of an instance.
uint32_t	dt_pinmux_reg_block (dt_pinmux_t dt, dt_pinmux_reg_block_t reg_block)
	Get the register base address of an instance.
uint32_t	dt_pinmux_memory_base (dt_pinmux_t dt, dt_pinmux_memory_t mem)
	Get the base address of a memory.
uint32_t	dt_pinmux_memory_size (dt_pinmux_t dt, dt_pinmux_memory_t mem)
	Get the size of a memory.
dt_alert_id_t	dt_pinmux_alert_to_alert_id (dt_pinmux_t dt, dt_pinmux_alert_t alert)
	Get the alert ID of a pinmux alert for a given instance.
dt_pinmux_alert_t	dt_pinmux_alert_from_alert_id (dt_pinmux_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local pinmux alert type.
dt_clock_t	dt_pinmux_clock (dt_pinmux_t dt, dt_pinmux_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_pinmux_reset (dt_pinmux_t dt, dt_pinmux_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_pinmux.c.

---

Data Structure Documentation

dt_desc_pinmux

struct dt_desc_pinmux

Description of instances.

Definition at line 19 of file dt_pinmux.c.

Data Fields
dt_clock_t	clock[kDtPinmuxClockCount]	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.
dt_instance_id_t	inst_id	Instance ID.
uint32_t	mem_addr[kDtPinmuxMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtPinmuxMemoryCount]	Size in bytes of each memory.
uint32_t	reg_addr[kDtPinmuxRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtPinmuxResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({     if ((dt) < (dt_pinmux_t)0 || (dt) >= kDtPinmuxCount)       return (default);     &pinmux_desc[dt];   })

Return a pointer to the dt_pinmux_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 65 of file dt_pinmux.c.

Function Documentation

dt_pinmux_alert_from_alert_id()

dt_pinmux_alert_t dt_pinmux_alert_from_alert_id	(	dt_pinmux_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns

The pinmux alert, or kDtPinmuxAlertCount.

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

Definition at line 107 of file dt_pinmux.c.

dt_pinmux_alert_to_alert_id()

dt_alert_id_t dt_pinmux_alert_to_alert_id	(	dt_pinmux_t	dt,
		dt_pinmux_alert_t	alert )

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

Returns

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

Definition at line 101 of file dt_pinmux.c.

dt_pinmux_clock()

dt_clock_t dt_pinmux_clock	(	dt_pinmux_t	dt,
		dt_pinmux_clock_t	clk )

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

Parameters

dt	Instance of pinmux.
clk	Clock port.

Returns

Clock signal.

Definition at line 119 of file dt_pinmux.c.

dt_pinmux_from_instance_id()

dt_pinmux_t dt_pinmux_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the pinmux instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A pinmux instance.

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

Definition at line 67 of file dt_pinmux.c.

dt_pinmux_instance_id()

dt_instance_id_t dt_pinmux_instance_id

(

dt_pinmux_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of pinmux.

Returns

The instance ID of that instance.

Definition at line 74 of file dt_pinmux.c.

dt_pinmux_memory_base()

uint32_t dt_pinmux_memory_base	(	dt_pinmux_t	dt,
		dt_pinmux_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of pinmux.
mem	The memory requested.

Returns

The base address of the requested memory.

Definition at line 86 of file dt_pinmux.c.

dt_pinmux_memory_size()

uint32_t dt_pinmux_memory_size	(	dt_pinmux_t	dt,
		dt_pinmux_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of pinmux.
mem	The memory requested.

Returns

The size of the requested memory.

Definition at line 93 of file dt_pinmux.c.

dt_pinmux_reg_block()

uint32_t dt_pinmux_reg_block	(	dt_pinmux_t	dt,
		dt_pinmux_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of pinmux.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 79 of file dt_pinmux.c.

dt_pinmux_reset()

dt_reset_t dt_pinmux_reset	(	dt_pinmux_t	dt,
		dt_pinmux_reset_t	rst )

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

Parameters

dt	Instance of pinmux.
rst	Reset port.

Returns

Reset signal.

Definition at line 126 of file dt_pinmux.c.