dt_pinmux.h File Reference

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

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

Go to the source code of this file.

Typedefs
typedef enum dt_pinmux	dt_pinmux_t
	List of instances.
typedef enum dt_pinmux_reg_block	dt_pinmux_reg_block_t
	List of register blocks.
typedef enum dt_pinmux_memory	dt_pinmux_memory_t
	List of memories.
typedef enum dt_pinmux_clock	dt_pinmux_clock_t
	List of clock ports.
typedef enum dt_pinmux_reset	dt_pinmux_reset_t
	List of reset ports.
typedef enum dt_pinmux_wakeup	dt_pinmux_wakeup_t
	List of wakeups.

Enumerations
enum	dt_pinmux {   kDtPinmuxAon = 0 ,   kDtPinmuxFirst = 0 ,   kDtPinmuxCount = 1 }
	List of instances. More...
enum	dt_pinmux_reg_block {   kDtPinmuxRegBlockCore = 0 ,   kDtPinmuxRegBlockCount = 1 }
	List of register blocks. More...
enum	dt_pinmux_memory { kDtPinmuxMemoryCount = 0 }
	List of memories. More...
enum	dt_pinmux_clock {   kDtPinmuxClockClk = 0 ,   kDtPinmuxClockAon = 1 ,   kDtPinmuxClockCount = 2 }
	List of clock ports. More...
enum	dt_pinmux_reset {   kDtPinmuxResetRst = 0 ,   kDtPinmuxResetAon = 1 ,   kDtPinmuxResetSys = 2 ,   kDtPinmuxResetCount = 3 }
	List of reset ports. More...
enum	dt_pinmux_wakeup {   kDtPinmuxWakeupPinWkupReq = 0 ,   kDtPinmuxWakeupUsbWkupReq = 1 ,   kDtPinmuxWakeupCount = 2 }
	List of wakeups. More...

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_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 englishbreakfast.

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

Definition in file dt_pinmux.h.

Typedef Documentation

dt_pinmux_clock_t

typedef enum dt_pinmux_clock dt_pinmux_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_pinmux_memory_t

typedef enum dt_pinmux_memory dt_pinmux_memory_t

List of memories.

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

dt_pinmux_reg_block_t

typedef enum dt_pinmux_reg_block dt_pinmux_reg_block_t

List of register blocks.

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

dt_pinmux_reset_t

typedef enum dt_pinmux_reset dt_pinmux_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

dt_pinmux_wakeup_t

typedef enum dt_pinmux_wakeup dt_pinmux_wakeup_t

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

dt_pinmux

enum dt_pinmux

List of instances.

Enumerator
kDtPinmuxAon	pinmux_aon

Definition at line 29 of file dt_pinmux.h.

dt_pinmux_clock

enum dt_pinmux_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtPinmuxClockClk	Clock port clk_i.
kDtPinmuxClockAon	Clock port clk_aon_i.

Definition at line 62 of file dt_pinmux.h.

dt_pinmux_memory

enum dt_pinmux_memory

List of memories.

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

Definition at line 53 of file dt_pinmux.h.

dt_pinmux_reg_block

enum dt_pinmux_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_pinmux.h.

dt_pinmux_reset

enum dt_pinmux_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtPinmuxResetRst	Reset port rst_ni.
kDtPinmuxResetAon	Reset port rst_aon_ni.
kDtPinmuxResetSys	Reset port rst_sys_ni.

Definition at line 73 of file dt_pinmux.h.

dt_pinmux_wakeup

enum dt_pinmux_wakeup

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumerator
kDtPinmuxWakeupPinWkupReq	pin wake request
kDtPinmuxWakeupUsbWkupReq	usb wake request

Definition at line 85 of file dt_pinmux.h.

Function Documentation

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.