dt_mbx.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_MBX_H_
#define OPENTITAN_DT_MBX_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP mbx and top darjeeling.
 *
 * This file contains the type definitions and global functions of the mbx.
 */
 
#include "hw/top/dt/dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_mbx {
  kDtMbx0 = 0, /**< mbx0 */
  kDtMbx1 = 1, /**< mbx1 */
  kDtMbx2 = 2, /**< mbx2 */
  kDtMbx3 = 3, /**< mbx3 */
  kDtMbx4 = 4, /**< mbx4 */
  kDtMbx5 = 5, /**< mbx5 */
  kDtMbx6 = 6, /**< mbx6 */
  kDtMbxJtag = 7, /**< mbx_jtag */
  kDtMbxPcie0 = 8, /**< mbx_pcie0 */
  kDtMbxPcie1 = 9, /**< mbx_pcie1 */
  kDtMbxFirst = 0, /**< \internal First instance */
  kDtMbxCount = 10, /**< \internal Number of instances */
} dt_mbx_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_mbx_reg_block {
  kDtMbxRegBlockCore = 0, /**<  */
  kDtMbxRegBlockSoc = 1, /**<  */
  kDtMbxRegBlockCount = 2, /**< \internal Number of register blocks */
} dt_mbx_reg_block_t;
 
/**
 * List of memories.
 *
 * Memories are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_mbx_memory {
  kDtMbxMemoryCount = 0, /**< \internal Number of memories */
} dt_mbx_memory_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_mbx_reg_block_t kDtMbxRegBlockPrimary = kDtMbxRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_mbx_irq {
  kDtMbxIrqMbxReady = 0, /**< A new object was received in the inbound mailbox. */
  kDtMbxIrqMbxAbort = 1, /**< An abort request was received from the requester. */
  kDtMbxIrqMbxError = 2, /**< The mailbox instance generated an error. */
  kDtMbxIrqCount = 3, /**< \internal Number of IRQs */
} dt_mbx_irq_t;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_mbx_alert {
  kDtMbxAlertFatalFault = 0, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
  kDtMbxAlertRecovFault = 1, /**< This recoverable alert is triggered when memory with invalid ECC (e.g., uninitialized memory) or at an invalid address is accessed. */
  kDtMbxAlertCount = 2, /**< \internal Number of Alerts */
} dt_mbx_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_mbx_clock {
  kDtMbxClockClk = 0, /**< Clock port clk_i */
  kDtMbxClockCount = 1, /**< \internal Number of clock ports */
} dt_mbx_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_mbx_reset {
  kDtMbxResetRst = 0, /**< Reset port rst_ni */
  kDtMbxResetCount = 1, /**< \internal Number of reset ports */
} dt_mbx_reset_t;
 
 
/**
 * Get the mbx instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A mbx instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type mbx,
 * otherwise the returned value is unspecified.
 */
dt_mbx_t dt_mbx_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of mbx.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_mbx_instance_id(dt_mbx_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of mbx.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_mbx_reg_block(
    dt_mbx_t dt,
    dt_mbx_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_mbx_reg_block(dt, kDtMbxRegBlockCore)`
 *
 * @param dt Instance of mbx.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_mbx_primary_reg_block(
    dt_mbx_t dt) {
  return dt_mbx_reg_block(dt, kDtMbxRegBlockCore);
}
 
/**
 * Get the base address of a memory.
 *
 * @param dt Instance of mbx.
 * @param mem The memory requested.
 * @return The base address of the requested memory.
 */
uint32_t dt_mbx_memory_base(
    dt_mbx_t dt,
    dt_mbx_memory_t mem);
 
/**
 * Get the size of a memory.
 *
 * @param dt Instance of mbx.
 * @param mem The memory requested.
 * @return The size of the requested memory.
 */
uint32_t dt_mbx_memory_size(
    dt_mbx_t dt,
    dt_mbx_memory_t mem);
 
/**
 * Get the PLIC ID of a mbx IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of mbx.
 * @param irq A mbx IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_mbx_irq_to_plic_id(
    dt_mbx_t dt,
    dt_mbx_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local mbx IRQ type.
 *
 * @param dt Instance of mbx.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The mbx IRQ, or `kDtMbxIrqCount`.
 *
 * **Note:** This function assumes that the PLIC ID belongs to the instance
 * of mbx passed in parameter. In other words, it must be the case that
 * `dt_mbx_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
 * will return `kDtMbxIrqCount`.
 */
dt_mbx_irq_t dt_mbx_irq_from_plic_id(
    dt_mbx_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * Get the alert ID of a mbx 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 mbx.
 * @param alert A mbx alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_mbx_alert_to_alert_id(
    dt_mbx_t dt,
    dt_mbx_alert_t alert);
 
/**
 * Convert a global alert ID to a local mbx alert type.
 *
 * @param dt Instance of mbx.
 * @param alert A global alert ID that belongs to this instance.
 * @return The mbx alert, or `kDtMbxAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of mbx passed in parameter. In other words, it must be the case
 * that `dt_mbx_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtMbxAlertCount`.
 */
dt_mbx_alert_t dt_mbx_alert_from_alert_id(
    dt_mbx_t dt,
    dt_alert_id_t alert);
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of mbx.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_mbx_clock(
    dt_mbx_t dt,
    dt_mbx_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of mbx.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_mbx_reset(
    dt_mbx_t dt,
    dt_mbx_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_MBX_H_