 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP i2c and top darjeeling. More...
#include "hw/top/dt/i2c.h"Go to the source code of this file.
Data Structures | |
| struct | dt_desc_i2c |
| Description of instances. More... | |
Macros | |
| #define | TRY_GET_DT(dt, default) |
Return a pointer to the dt_i2c_desc_t structure of the requested dt if it's a valid index. | |
Typedefs | |
| typedef struct dt_desc_i2c | dt_desc_i2c_t |
| Description of instances. | |
Functions | |
| dt_i2c_t | dt_i2c_from_instance_id (dt_instance_id_t inst_id) |
| Get the i2c instance from an instance ID. | |
| dt_instance_id_t | dt_i2c_instance_id (dt_i2c_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_i2c_reg_block (dt_i2c_t dt, dt_i2c_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_i2c_memory_base (dt_i2c_t dt, dt_i2c_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_i2c_memory_size (dt_i2c_t dt, dt_i2c_memory_t mem) |
| Get the size of a memory. | |
| dt_plic_irq_id_t | dt_i2c_irq_to_plic_id (dt_i2c_t dt, dt_i2c_irq_t irq) |
| Get the PLIC ID of a i2c IRQ for a given instance. | |
| dt_i2c_irq_t | dt_i2c_irq_from_plic_id (dt_i2c_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local i2c IRQ type. | |
| dt_alert_id_t | dt_i2c_alert_to_alert_id (dt_i2c_t dt, dt_i2c_alert_t alert) |
| Get the alert ID of a i2c alert for a given instance. | |
| dt_i2c_alert_t | dt_i2c_alert_from_alert_id (dt_i2c_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local i2c alert type. | |
| dt_periph_io_t | dt_i2c_periph_io (dt_i2c_t dt, dt_i2c_periph_io_t sig) |
| Get the peripheral I/O description of an instance. | |
| dt_clock_t | dt_i2c_clock (dt_i2c_t dt, dt_i2c_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_i2c_reset (dt_i2c_t dt, dt_i2c_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP i2c and top darjeeling.
Definition in file i2c.c.
| struct dt_desc_i2c |
| Data Fields | ||
|---|---|---|
| dt_clock_t | clock[kDtI2cClockCount] | 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. |
| top_darjeeling_plic_irq_id_t | first_irq |
PLIC ID of the first IRQ of this instance. This can be |
| top_earlgrey_plic_irq_id_t | first_irq |
PLIC ID of the first IRQ of this instance. This can be |
| dt_instance_id_t | inst_id | Instance ID. |
| uint32_t | mem_addr[kDtI2cMemoryCount] | Base address of each memory. |
| uint32_t | mem_size[kDtI2cMemoryCount] | Size in bytes of each memory. |
| dt_periph_io_t | periph_io[kDtI2cPeriphIoCount] | Description of each peripheral I/O. |
| uint32_t | reg_addr[kDtI2cRegBlockCount] | Base address of each register block. |
| dt_reset_t | reset[kDtI2cResetCount] | Reset signal connected to each reset port. |
| #define TRY_GET_DT | ( | dt, | |
| default ) |
Return a pointer to the dt_i2c_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_i2c_alert_t dt_i2c_alert_from_alert_id | ( | dt_i2c_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local i2c alert type.
| dt | Instance of i2c. |
| alert | A global alert ID that belongs to this instance. |
kDtI2cAlertCount.Note: This function assumes that the global alert ID belongs to the instance of i2c passed in parameter. In other words, it must be the case that dt_i2c_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtI2cAlertCount.
| dt_alert_id_t dt_i2c_alert_to_alert_id | ( | dt_i2c_t | dt, |
| dt_i2c_alert_t | alert ) |
Get the alert ID of a i2c 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.
| dt | Instance of i2c. |
| alert | A i2c alert. |
| dt_clock_t dt_i2c_clock | ( | dt_i2c_t | dt, |
| dt_i2c_clock_t | clk ) |
| dt_i2c_t dt_i2c_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the i2c 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 i2c, otherwise the returned value is unspecified.
| dt_instance_id_t dt_i2c_instance_id | ( | dt_i2c_t | dt | ) |
| dt_i2c_irq_t dt_i2c_irq_from_plic_id | ( | dt_i2c_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local i2c IRQ type.
| dt | Instance of i2c. |
| irq | A PLIC ID that belongs to this instance. |
kDtI2cIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of i2c passed in parameter. In other words, it must be the case that dt_i2c_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtI2cIrqCount.
| dt_plic_irq_id_t dt_i2c_irq_to_plic_id | ( | dt_i2c_t | dt, |
| dt_i2c_irq_t | irq ) |
| uint32_t dt_i2c_memory_base | ( | dt_i2c_t | dt, |
| dt_i2c_memory_t | mem ) |
| uint32_t dt_i2c_memory_size | ( | dt_i2c_t | dt, |
| dt_i2c_memory_t | mem ) |
| dt_periph_io_t dt_i2c_periph_io | ( | dt_i2c_t | dt, |
| dt_i2c_periph_io_t | sig ) |
| uint32_t dt_i2c_reg_block | ( | dt_i2c_t | dt, |
| dt_i2c_reg_block_t | reg_block ) |
| dt_reset_t dt_i2c_reset | ( | dt_i2c_t | dt, |
| dt_i2c_reset_t | rst ) |