 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP i3c and top earlgrey. More...
#include "hw/top/dt/api.h"#include <stdint.h>Go to the source code of this file.
Typedefs | |
| typedef enum dt_i3c | dt_i3c_t |
| List of instances. | |
| typedef enum dt_i3c_reg_block | dt_i3c_reg_block_t |
| List of register blocks. | |
| typedef enum dt_i3c_irq | dt_i3c_irq_t |
| List of IRQs. | |
| typedef enum dt_i3c_alert | dt_i3c_alert_t |
| List of Alerts. | |
| typedef enum dt_i3c_clock | dt_i3c_clock_t |
| List of clock ports. | |
| typedef enum dt_i3c_reset | dt_i3c_reset_t |
| List of reset ports. | |
| typedef enum dt_i3c_periph_io | dt_i3c_periph_io_t |
| List of peripheral I/O. | |
| typedef enum dt_i3c_wakeup | dt_i3c_wakeup_t |
| List of wakeups. | |
Enumerations | |
| enum | dt_i3c { kDtI3cFirst = 0 , kDtI3c0 = 0 , kDtI3c1 = 1 } |
| List of instances. More... | |
| enum | { kDtI3cCount = 2 } |
| enum | dt_i3c_reg_block { kDtI3cRegBlockCore = 0 } |
| List of register blocks. More... | |
| enum | { kDtI3cRegBlockCount = 1 } |
| enum | dt_i3c_irq { kDtI3cIrqHci = 0 , kDtI3cIrqTarg = 1 } |
| List of IRQs. More... | |
| enum | { kDtI3cIrqCount = 2 } |
| enum | dt_i3c_alert { kDtI3cAlertFatalFault = 0 } |
| List of Alerts. More... | |
| enum | { kDtI3cAlertCount = 1 } |
| enum | dt_i3c_clock { kDtI3cClockClk = 0 , kDtI3cClockAon = 1 } |
| List of clock ports. More... | |
| enum | { kDtI3cClockCount = 2 } |
| enum | dt_i3c_reset { kDtI3cResetRst = 0 , kDtI3cResetAon = 1 } |
| List of reset ports. More... | |
| enum | { kDtI3cResetCount = 2 } |
| enum | dt_i3c_periph_io { kDtI3cPeriphIoRstdetScl = 0 , kDtI3cPeriphIoRstdetSda = 1 , kDtI3cPeriphIoCtrlSdaPu = 2 , kDtI3cPeriphIoScl = 3 , kDtI3cPeriphIoSda = 4 } |
| List of peripheral I/O. More... | |
| enum | { kDtI3cPeriphIoCount = 5 } |
| enum | dt_i3c_wakeup { kDtI3cWakeupRstdetWkupReq = 0 } |
| List of wakeups. More... | |
| enum | { kDtI3cWakeupCount = 1 } |
Functions | |
| dt_i3c_t | dt_i3c_from_instance_id (dt_instance_id_t inst_id) |
| Get the i3c instance from an instance ID. | |
| dt_instance_id_t | dt_i3c_instance_id (dt_i3c_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_i3c_reg_block (dt_i3c_t dt, dt_i3c_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| dt_plic_irq_id_t | dt_i3c_irq_to_plic_id (dt_i3c_t dt, dt_i3c_irq_t irq) |
| Get the PLIC ID of a i3c IRQ for a given instance. | |
| dt_i3c_irq_t | dt_i3c_irq_from_plic_id (dt_i3c_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local i3c IRQ type. | |
| dt_alert_id_t | dt_i3c_alert_to_alert_id (dt_i3c_t dt, dt_i3c_alert_t alert) |
| Get the alert ID of a i3c alert for a given instance. | |
| dt_i3c_alert_t | dt_i3c_alert_from_alert_id (dt_i3c_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local i3c alert type. | |
| dt_periph_io_t | dt_i3c_periph_io (dt_i3c_t dt, dt_i3c_periph_io_t sig) |
| Get the peripheral I/O description of an instance. | |
| dt_clock_t | dt_i3c_clock (dt_i3c_t dt, dt_i3c_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_i3c_reset (dt_i3c_t dt, dt_i3c_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP i3c and top earlgrey.
This file contains the type definitions and global functions of the i3c.
Definition in file i3c.h.
| typedef enum dt_i3c_alert dt_i3c_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i3c_clock dt_i3c_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i3c_irq dt_i3c_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i3c_periph_io dt_i3c_periph_io_t |
List of peripheral I/O.
Peripheral I/O are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i3c_reg_block dt_i3c_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_i3c_reset dt_i3c_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i3c_wakeup dt_i3c_wakeup_t |
List of wakeups.
Wakeups are guaranteed to be numbered consecutively from 0.
| anonymous enum |
| anonymous enum |
| anonymous enum |
| anonymous enum |
| enum dt_i3c |
| enum dt_i3c_alert |
| enum dt_i3c_clock |
| enum dt_i3c_irq |
| enum dt_i3c_periph_io |
| enum dt_i3c_reg_block |
| enum dt_i3c_reset |
| enum dt_i3c_wakeup |
| dt_i3c_alert_t dt_i3c_alert_from_alert_id | ( | dt_i3c_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local i3c alert type.
| dt | Instance of i3c. |
| alert | A global alert ID that belongs to this instance. |
kDtI3cAlertCount.Note: This function assumes that the global alert ID belongs to the instance of i3c passed in parameter. In other words, it must be the case that dt_i3c_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtI3cAlertCount.
| dt_alert_id_t dt_i3c_alert_to_alert_id | ( | dt_i3c_t | dt, |
| dt_i3c_alert_t | alert ) |
Get the alert ID of a i3c 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 i3c. |
| alert | A i3c alert. |
| dt_clock_t dt_i3c_clock | ( | dt_i3c_t | dt, |
| dt_i3c_clock_t | clk ) |
| dt_i3c_t dt_i3c_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the i3c 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 i3c, otherwise the returned value is unspecified.
| dt_instance_id_t dt_i3c_instance_id | ( | dt_i3c_t | dt | ) |
| dt_i3c_irq_t dt_i3c_irq_from_plic_id | ( | dt_i3c_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local i3c IRQ type.
| dt | Instance of i3c. |
| irq | A PLIC ID that belongs to this instance. |
kDtI3cIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of i3c passed in parameter. In other words, it must be the case that dt_i3c_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtI3cIrqCount.
| dt_plic_irq_id_t dt_i3c_irq_to_plic_id | ( | dt_i3c_t | dt, |
| dt_i3c_irq_t | irq ) |
| dt_periph_io_t dt_i3c_periph_io | ( | dt_i3c_t | dt, |
| dt_i3c_periph_io_t | sig ) |
| uint32_t dt_i3c_reg_block | ( | dt_i3c_t | dt, |
| dt_i3c_reg_block_t | reg_block ) |
| dt_reset_t dt_i3c_reset | ( | dt_i3c_t | dt, |
| dt_i3c_reset_t | rst ) |