Device Tables (DT) for IP i2c and top earlgrey. More...

#include "dt_api.h"
#include <stdint.h>

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_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 , kDtI2c1 = 1 , kDtI2c2 = 2 , kDtI2cFirst = 0 , kDtI2cCount = 3 }
	List of instances. More...

enum	dt_i2c_reg_block { kDtI2cRegBlockCore = 0 , kDtI2cRegBlockCount = 1 }
	List of register blocks. 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.

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.

Detailed Description

Device Tables (DT) for IP i2c and top earlgrey.

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

Definition in file dt_i2c.h.

Macro Definition Documentation

◆ OPENTITAN_I2C_HAS_MODE_ACKCONTROL

#define OPENTITAN_I2C_HAS_MODE_ACKCONTROL 1

Definition at line 118 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_MODE_HOST

#define OPENTITAN_I2C_HAS_MODE_HOST 1

List of supported hardware features.

Definition at line 116 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_MODE_TARGET

#define OPENTITAN_I2C_HAS_MODE_TARGET 1

Definition at line 117 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_OPERATION_READ

#define OPENTITAN_I2C_HAS_OPERATION_READ 1

Definition at line 123 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_OPERATION_WRITE

#define OPENTITAN_I2C_HAS_OPERATION_WRITE 1

Definition at line 124 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_OVERRIDE

#define OPENTITAN_I2C_HAS_OVERRIDE 1

Definition at line 122 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_PROTOCOL_CLOCKSTRETCHING

#define OPENTITAN_I2C_HAS_PROTOCOL_CLOCKSTRETCHING 1

Definition at line 125 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_PROTOCOL_NACK

#define OPENTITAN_I2C_HAS_PROTOCOL_NACK 1

Definition at line 126 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_PROTOCOL_REPEATEDSTART

#define OPENTITAN_I2C_HAS_PROTOCOL_REPEATEDSTART 1

Definition at line 127 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_SPEED_FAST

#define OPENTITAN_I2C_HAS_SPEED_FAST 1

Definition at line 120 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_SPEED_FASTPLUS

#define OPENTITAN_I2C_HAS_SPEED_FASTPLUS 1

Definition at line 121 of file dt_i2c.h.

◆ OPENTITAN_I2C_HAS_SPEED_STANDARD

#define OPENTITAN_I2C_HAS_SPEED_STANDARD 1

Definition at line 119 of file dt_i2c.h.

Typedef Documentation

◆ dt_i2c_alert_t

typedef enum dt_i2c_alert dt_i2c_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_i2c_clock_t

typedef enum dt_i2c_clock dt_i2c_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_i2c_irq_t

typedef enum dt_i2c_irq dt_i2c_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_i2c_periph_io_t

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.

◆ dt_i2c_reg_block_t

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.

◆ dt_i2c_reset_t

typedef enum dt_i2c_reset dt_i2c_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_i2c

enum dt_i2c

List of instances.

Enumerator
kDtI2c0	i2c0
kDtI2c1	i2c1
kDtI2c2	i2c2

Definition at line 23 of file dt_i2c.h.

◆ dt_i2c_alert

enum dt_i2c_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtI2cAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 77 of file dt_i2c.h.

◆ dt_i2c_clock

enum dt_i2c_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtI2cClockClk	Clock port clk_i.

Definition at line 87 of file dt_i2c.h.

◆ dt_i2c_irq

enum dt_i2c_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtI2cIrqFmtThreshold	host mode interrupt: asserted whilst the FMT FIFO level is below the low threshold. This is a level status interrupt.
kDtI2cIrqRxThreshold	host mode interrupt: asserted whilst the RX FIFO level is above the high threshold. This is a level status interrupt.
kDtI2cIrqAcqThreshold	target mode interrupt: asserted whilst the ACQ FIFO level is above the high threshold. This is a level status interrupt.
kDtI2cIrqRxOverflow	host mode interrupt: raised if the RX FIFO has overflowed.
kDtI2cIrqControllerHalt	host mode interrupt: raised if the controller FSM is halted, such as on an unexpected NACK or lost arbitration. Check !!CONTROLLER_EVENTS for the reason. The interrupt will be released when the bits in !!CONTROLLER_EVENTS are cleared.
kDtI2cIrqSclInterference	host mode interrupt: raised if the SCL line drops early (not supported without clock synchronization).
kDtI2cIrqSdaInterference	host mode interrupt: raised if the SDA line goes low when host is trying to assert high
kDtI2cIrqStretchTimeout	host mode interrupt: raised if target stretches the clock beyond the allowed timeout period
kDtI2cIrqSdaUnstable	host mode interrupt: raised if the target does not assert a constant value of SDA during transmission.
kDtI2cIrqCmdComplete	host and target mode interrupt. In host mode, raised if the host issues a repeated START or terminates the transaction by issuing STOP. In target mode, raised if the external host issues a STOP or repeated START.
kDtI2cIrqTxStretch	target mode interrupt: raised if the target is stretching clocks for a read command. This is a level status interrupt.
kDtI2cIrqTxThreshold	target mode interrupt: asserted whilst the TX FIFO level is below the low threshold. This is a level status interrupt.
kDtI2cIrqAcqStretch	target mode interrupt: raised if the target is stretching clocks due to full ACQ FIFO or zero count in ! !TARGET_ACK_CTRL.NBYTES (if enabled). This is a level status interrupt.
kDtI2cIrqUnexpStop	target mode interrupt: raised if STOP is received without a preceding NACK during an external host read.
kDtI2cIrqHostTimeout	target mode interrupt: raised if the host stops sending the clock during an ongoing transaction.

Definition at line 49 of file dt_i2c.h.

◆ dt_i2c_periph_io

enum dt_i2c_periph_io

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

Definition at line 107 of file dt_i2c.h.

◆ dt_i2c_reg_block

enum dt_i2c_reg_block

List of register blocks.

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

Definition at line 36 of file dt_i2c.h.

◆ dt_i2c_reset

enum dt_i2c_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtI2cResetRst	Reset port rst_ni.

Definition at line 97 of file dt_i2c.h.

Function Documentation

◆ dt_i2c_alert_from_alert_id()

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.

Parameters

dt	Instance of i2c.
alert	A global alert ID that belongs to this instance.

Returns: The i2c alert, or 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.

Definition at line 198 of file dt_i2c.c.

◆ dt_i2c_alert_to_alert_id()

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.

Parameters

dt	Instance of i2c.
alert	A i2c alert.

Returns: The Alert Handler alert ID of the alert of this instance.

Definition at line 192 of file dt_i2c.c.

◆ dt_i2c_clock()

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.

Parameters

dt	Instance of i2c.
clk	Clock port.

Returns: Clock signal.

Definition at line 216 of file dt_i2c.c.

◆ dt_i2c_from_instance_id()

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.

Parameters

inst_id Instance ID.

Returns: A i2c instance.

Note: This function only makes sense if the instance ID has device type i2c, otherwise the returned value is unspecified.

Definition at line 148 of file dt_i2c.c.

◆ dt_i2c_instance_id()

dt_instance_id_t dt_i2c_instance_id ( dt_i2c_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of i2c.

Returns: The instance ID of that instance.

Definition at line 155 of file dt_i2c.c.

◆ dt_i2c_irq_from_plic_id()

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.

Parameters

dt	Instance of i2c.
irq	A PLIC ID that belongs to this instance.

Returns: The i2c IRQ, or 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.

Definition at line 177 of file dt_i2c.c.

◆ dt_i2c_irq_to_plic_id()

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.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters

dt	Instance of i2c.
irq	A i2c IRQ.

Returns: The PLIC ID of the IRQ of this instance.

Definition at line 167 of file dt_i2c.c.

◆ dt_i2c_periph_io()

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.

Parameters

dt	Instance of i2c.
sig	Requested peripheral I/O.

Returns: Description of the requested peripheral I/O for this instance.

Definition at line 209 of file dt_i2c.c.

◆ dt_i2c_reg_block()

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.

Parameters

dt	Instance of i2c.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 160 of file dt_i2c.c.

◆ dt_i2c_reset()

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.

Parameters

dt	Instance of i2c.
rst	Reset port.

Returns: Reset signal.

Definition at line 223 of file dt_i2c.c.

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ OPENTITAN_I2C_HAS_MODE_ACKCONTROL

◆ OPENTITAN_I2C_HAS_MODE_HOST

◆ OPENTITAN_I2C_HAS_MODE_TARGET

◆ OPENTITAN_I2C_HAS_OPERATION_READ

◆ OPENTITAN_I2C_HAS_OPERATION_WRITE

◆ OPENTITAN_I2C_HAS_OVERRIDE

◆ OPENTITAN_I2C_HAS_PROTOCOL_CLOCKSTRETCHING

◆ OPENTITAN_I2C_HAS_PROTOCOL_NACK

◆ OPENTITAN_I2C_HAS_PROTOCOL_REPEATEDSTART

◆ OPENTITAN_I2C_HAS_SPEED_FAST

◆ OPENTITAN_I2C_HAS_SPEED_FASTPLUS

◆ OPENTITAN_I2C_HAS_SPEED_STANDARD

Typedef Documentation

◆ dt_i2c_alert_t

◆ dt_i2c_clock_t

◆ dt_i2c_irq_t

◆ dt_i2c_periph_io_t

◆ dt_i2c_reg_block_t

◆ dt_i2c_reset_t

Enumeration Type Documentation

◆ dt_i2c

◆ dt_i2c_alert

◆ dt_i2c_clock

◆ dt_i2c_irq

◆ dt_i2c_periph_io

◆ dt_i2c_reg_block

◆ dt_i2c_reset

Function Documentation

◆ dt_i2c_alert_from_alert_id()

◆ dt_i2c_alert_to_alert_id()

◆ dt_i2c_clock()

◆ dt_i2c_from_instance_id()

◆ dt_i2c_instance_id()

◆ dt_i2c_irq_from_plic_id()

◆ dt_i2c_irq_to_plic_id()

◆ dt_i2c_periph_io()

◆ dt_i2c_reg_block()

◆ dt_i2c_reset()