i3c.h

Go to the documentation of this file.

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
//
// Device table API auto-generated by `dtgen`
 
#ifndef OPENTITAN_DT_I3C_H_
#define OPENTITAN_DT_I3C_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP i3c and top earlgrey.
 *
 * This file contains the type definitions and global functions of the i3c.
 */
 
#include "hw/top/dt/api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_i3c {
  kDtI3cFirst = 0, /**< First instance */
  kDtI3c0 = 0, /**< i3c0 */
  kDtI3c1 = 1, /**< i3c1 */
} dt_i3c_t;
 
enum {
  kDtI3cCount = 2, /**< Number of instances */
};
 
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_i3c_reg_block {
  kDtI3cRegBlockCore = 0, /**<  */
} dt_i3c_reg_block_t;
 
enum {
  kDtI3cRegBlockCount = 1, /**< Number of register blocks */
};
 
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_i3c_reg_block_t kDtI3cRegBlockPrimary = kDtI3cRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_i3c_irq {
  kDtI3cIrqHci = 0, /**< HCI interrupt. */
  kDtI3cIrqTarg = 1, /**< Target interrupt. */
} dt_i3c_irq_t;
 
enum {
  kDtI3cIrqCount = 2, /**< Number of IRQs */
};
 
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_i3c_alert {
  kDtI3cAlertFatalFault = 0, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
} dt_i3c_alert_t;
 
enum {
  kDtI3cAlertCount = 1, /**< Number of Alerts */
};
 
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_i3c_clock {
  kDtI3cClockClk = 0, /**< Clock port clk_i */
  kDtI3cClockAon = 1, /**< Clock port clk_aon_i */
} dt_i3c_clock_t;
 
enum {
  kDtI3cClockCount = 2, /**< Number of clock ports */
};
 
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_i3c_reset {
  kDtI3cResetRst = 0, /**< Reset port rst_ni */
  kDtI3cResetAon = 1, /**< Reset port rst_aon_ni */
} dt_i3c_reset_t;
 
enum {
  kDtI3cResetCount = 2, /**< Number of reset ports */
};
 
 
/**
 * List of peripheral I/O.
 *
 * Peripheral I/O are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_i3c_periph_io {
  kDtI3cPeriphIoRstdetScl = 0, /**<  */
  kDtI3cPeriphIoRstdetSda = 1, /**<  */
  kDtI3cPeriphIoCtrlSdaPu = 2, /**<  */
  kDtI3cPeriphIoScl = 3, /**<  */
  kDtI3cPeriphIoSda = 4, /**<  */
} dt_i3c_periph_io_t;
 
enum {
  kDtI3cPeriphIoCount = 5, /**< Number of peripheral I/O */
};
 
 
/**
 * List of wakeups.
 *
 * Wakeups are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_i3c_wakeup {
  kDtI3cWakeupRstdetWkupReq = 0, /**< Wake-up request on detection of the Target Reset Pattern (running on AON clock). */
} dt_i3c_wakeup_t;
 
enum {
  kDtI3cWakeupCount = 1, /**< Number of wakeups */
};
 
 
 
/**
 * Get the i3c instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A i3c instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type i3c,
 * otherwise the returned value is unspecified.
 */
dt_i3c_t dt_i3c_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of i3c.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_i3c_instance_id(dt_i3c_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of i3c.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_i3c_reg_block(
    dt_i3c_t dt,
    dt_i3c_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_i3c_reg_block(dt, kDtI3cRegBlockCore)`
 *
 * @param dt Instance of i3c.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_i3c_primary_reg_block(
    dt_i3c_t dt) {
  return dt_i3c_reg_block(dt, kDtI3cRegBlockCore);
}
 
/**
 * Get the PLIC ID of a i3c IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of i3c.
 * @param irq A i3c IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_i3c_irq_to_plic_id(
    dt_i3c_t dt,
    dt_i3c_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local i3c IRQ type.
 *
 * @param dt Instance of i3c.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The i3c IRQ, or `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_i3c_irq_t dt_i3c_irq_from_plic_id(
    dt_i3c_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * 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.
 *
 * @param dt Instance of i3c.
 * @param alert A i3c alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_i3c_alert_to_alert_id(
    dt_i3c_t dt,
    dt_i3c_alert_t alert);
 
/**
 * Convert a global alert ID to a local i3c alert type.
 *
 * @param dt Instance of i3c.
 * @param alert A global alert ID that belongs to this instance.
 * @return The i3c alert, or `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_i3c_alert_t dt_i3c_alert_from_alert_id(
    dt_i3c_t dt,
    dt_alert_id_t alert);
 
 
/**
 * Get the peripheral I/O description of an instance.
 *
 * @param dt Instance of i3c.
 * @param sig Requested peripheral I/O.
 * @return Description of the requested peripheral I/O for this instance.
 */
dt_periph_io_t dt_i3c_periph_io(
    dt_i3c_t dt,
    dt_i3c_periph_io_t sig);
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of i3c.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_i3c_clock(
    dt_i3c_t dt,
    dt_i3c_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of i3c.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_i3c_reset(
    dt_i3c_t dt,
    dt_i3c_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_I3C_H_