 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP i2c and top darjeeling. More...
#include "hw/top/dt/dt_api.h"#include <stdint.h>Go to the source code of this file.
Macros | |
| #define | OPENTITAN_I2C_HAS_MODE_HOST 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_I2C_HAS_MODE_TARGET 1 |
| #define | OPENTITAN_I2C_HAS_MODE_ACKCONTROL 1 |
| #define | OPENTITAN_I2C_HAS_SPEED_STANDARD 1 |
| #define | OPENTITAN_I2C_HAS_SPEED_FAST 1 |
| #define | OPENTITAN_I2C_HAS_SPEED_FASTPLUS 1 |
| #define | OPENTITAN_I2C_HAS_OVERRIDE 1 |
| #define | OPENTITAN_I2C_HAS_OPERATION_READ 1 |
| #define | OPENTITAN_I2C_HAS_OPERATION_WRITE 1 |
| #define | OPENTITAN_I2C_HAS_PROTOCOL_CLOCKSTRETCHING 1 |
| #define | OPENTITAN_I2C_HAS_PROTOCOL_NACK 1 |
| #define | OPENTITAN_I2C_HAS_PROTOCOL_REPEATEDSTART 1 |
Typedefs | |
| typedef enum dt_i2c | dt_i2c_t |
| List of instances. | |
| typedef enum dt_i2c_reg_block | dt_i2c_reg_block_t |
| List of register blocks. | |
| typedef enum dt_i2c_memory | dt_i2c_memory_t |
| List of memories. | |
| typedef enum dt_i2c_irq | dt_i2c_irq_t |
| List of IRQs. | |
| typedef enum dt_i2c_alert | dt_i2c_alert_t |
| List of Alerts. | |
| typedef enum dt_i2c_clock | dt_i2c_clock_t |
| List of clock ports. | |
| typedef enum dt_i2c_reset | dt_i2c_reset_t |
| List of reset ports. | |
| typedef enum dt_i2c_periph_io | dt_i2c_periph_io_t |
| List of peripheral I/O. | |
Enumerations | |
| enum | dt_i2c { kDtI2c0 = 0 , kDtI2cFirst = 0 , kDtI2cCount = 1 } |
| List of instances. More... | |
| enum | dt_i2c_reg_block { kDtI2cRegBlockCore = 0 , kDtI2cRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_i2c_memory { kDtI2cMemoryCount = 0 } |
| List of memories. More... | |
| enum | dt_i2c_irq { kDtI2cIrqFmtThreshold = 0 , kDtI2cIrqRxThreshold = 1 , kDtI2cIrqAcqThreshold = 2 , kDtI2cIrqRxOverflow = 3 , kDtI2cIrqControllerHalt = 4 , kDtI2cIrqSclInterference = 5 , kDtI2cIrqSdaInterference = 6 , kDtI2cIrqStretchTimeout = 7 , kDtI2cIrqSdaUnstable = 8 , kDtI2cIrqCmdComplete = 9 , kDtI2cIrqTxStretch = 10 , kDtI2cIrqTxThreshold = 11 , kDtI2cIrqAcqStretch = 12 , kDtI2cIrqUnexpStop = 13 , kDtI2cIrqHostTimeout = 14 , kDtI2cIrqCount = 15 } |
| List of IRQs. More... | |
| enum | dt_i2c_alert { kDtI2cAlertFatalFault = 0 , kDtI2cAlertCount = 1 } |
| List of Alerts. More... | |
| enum | dt_i2c_clock { kDtI2cClockClk = 0 , kDtI2cClockCount = 1 } |
| List of clock ports. More... | |
| enum | dt_i2c_reset { kDtI2cResetRst = 0 , kDtI2cResetCount = 1 } |
| List of reset ports. More... | |
| enum | dt_i2c_periph_io { kDtI2cPeriphIoSda = 0 , kDtI2cPeriphIoScl = 1 , kDtI2cPeriphIoCount = 2 } |
| List of peripheral I/O. More... | |
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.
This file contains the type definitions and global functions of the i2c.
Definition in file dt_i2c.h.
| #define OPENTITAN_I2C_HAS_MODE_HOST 1 |
| typedef enum dt_i2c_alert dt_i2c_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i2c_clock dt_i2c_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i2c_irq dt_i2c_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i2c_memory dt_i2c_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_i2c_periph_io dt_i2c_periph_io_t |
List of peripheral I/O.
Peripheral I/O are guaranteed to be numbered consecutively from 0.
| typedef enum dt_i2c_reg_block dt_i2c_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_i2c_reset dt_i2c_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_i2c_alert |
| enum dt_i2c_clock |
| enum dt_i2c_irq |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| enum dt_i2c_memory |
| enum dt_i2c_periph_io |
| enum dt_i2c_reg_block |
| enum dt_i2c_reset |
| 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 ) |