 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP pinmux and top englishbreakfast. More...
#include "hw/top/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_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. | |
Device Tables (DT) for IP pinmux and top englishbreakfast.
Definition in file pinmux.c.
| struct dt_desc_pinmux |
| 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. |
| #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.
Otherwise, this macro will return (i.e. exit the function) with the provided default value.
| dt_clock_t dt_pinmux_clock | ( | dt_pinmux_t | dt, |
| dt_pinmux_clock_t | clk ) |
| 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.
| inst_id | Instance ID. |
Note: This function only makes sense if the instance ID has device type pinmux, otherwise the returned value is unspecified.
| dt_instance_id_t dt_pinmux_instance_id | ( | dt_pinmux_t | dt | ) |
| uint32_t dt_pinmux_memory_base | ( | dt_pinmux_t | dt, |
| dt_pinmux_memory_t | mem ) |
| uint32_t dt_pinmux_memory_size | ( | dt_pinmux_t | dt, |
| dt_pinmux_memory_t | mem ) |
| uint32_t dt_pinmux_reg_block | ( | dt_pinmux_t | dt, |
| dt_pinmux_reg_block_t | reg_block ) |
| dt_reset_t dt_pinmux_reset | ( | dt_pinmux_t | dt, |
| dt_pinmux_reset_t | rst ) |