dt_rv_dm.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_RV_DM_H_
#define OPENTITAN_DT_RV_DM_H_
 
/**
 * @file
 * @brief Device Tables (DT) for IP rv_dm and top earlgrey.
 *
 * This file contains the type definitions and global functions of the rv_dm.
 */
 
#include "dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_rv_dm {
  kDtRvDm = 0, /**< rv_dm */
  kDtRvDmFirst = 0, /**< \internal First instance */
  kDtRvDmCount = 1, /**< \internal Number of instances */
} dt_rv_dm_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_rv_dm_reg_block {
  kDtRvDmRegBlockRegs = 0, /**<  */
  kDtRvDmRegBlockMem = 1, /**<  */
  kDtRvDmRegBlockDbg = 2, /**<  */
  kDtRvDmRegBlockCount = 3, /**< \internal Number of register blocks */
} dt_rv_dm_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_rv_dm_reg_block_t kDtRvDmRegBlockPrimary = kDtRvDmRegBlockRegs;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_rv_dm_alert {
  kDtRvDmAlertFatalFault = 0, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
  kDtRvDmAlertCount = 1, /**< \internal Number of Alerts */
} dt_rv_dm_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_rv_dm_clock {
  kDtRvDmClockClk = 0, /**< Clock port clk_i */
  kDtRvDmClockLc = 1, /**< Clock port clk_lc_i */
  kDtRvDmClockCount = 2, /**< \internal Number of clock ports */
} dt_rv_dm_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_rv_dm_reset {
  kDtRvDmResetRst = 0, /**< Reset port rst_ni */
  kDtRvDmResetLc = 1, /**< Reset port rst_lc_ni */
  kDtRvDmResetCount = 2, /**< \internal Number of reset ports */
} dt_rv_dm_reset_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_RV_DM_HAS_JTAG_FSM 1
#define OPENTITAN_RV_DM_HAS_JTAG_DTM 1
#define OPENTITAN_RV_DM_HAS_DBG_DATA_REGS 1
#define OPENTITAN_RV_DM_HAS_DBG_DMCONTROL_REG 1
#define OPENTITAN_RV_DM_HAS_DBG_DMSTATUS_REG 1
#define OPENTITAN_RV_DM_HAS_DBG_HARTINFO_REG 1
#define OPENTITAN_RV_DM_HAS_DBG_HALTSUM0_REG 1
#define OPENTITAN_RV_DM_HAS_DBG_ABSTRACT_COMMAND 1
#define OPENTITAN_RV_DM_HAS_DBG_PROGBUF 1
#define OPENTITAN_RV_DM_HAS_DBG_SBA 1
#define OPENTITAN_RV_DM_HAS_DBG_NDM_RESET 1
#define OPENTITAN_RV_DM_HAS_DBG_GDB 1
 
 
 
/**
 * Get the rv_dm instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A rv_dm instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type rv_dm,
 * otherwise the returned value is unspecified.
 */
dt_rv_dm_t dt_rv_dm_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of rv_dm.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_rv_dm_instance_id(dt_rv_dm_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of rv_dm.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_rv_dm_reg_block(
    dt_rv_dm_t dt,
    dt_rv_dm_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_rv_dm_reg_block(dt, kDtRvDmRegBlockRegs)`
 *
 * @param dt Instance of rv_dm.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_rv_dm_primary_reg_block(
    dt_rv_dm_t dt) {
  return dt_rv_dm_reg_block(dt, kDtRvDmRegBlockRegs);
}
 
 
/**
 * Get the alert ID of a rv_dm 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 rv_dm.
 * @param alert A rv_dm alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_rv_dm_alert_to_alert_id(
    dt_rv_dm_t dt,
    dt_rv_dm_alert_t alert);
 
/**
 * Convert a global alert ID to a local rv_dm alert type.
 *
 * @param dt Instance of rv_dm.
 * @param alert A global alert ID that belongs to this instance.
 * @return The rv_dm alert, or `kDtRvDmAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of rv_dm passed in parameter. In other words, it must be the case
 * that `dt_rv_dm_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtRvDmAlertCount`.
 */
dt_rv_dm_alert_t dt_rv_dm_alert_from_alert_id(
    dt_rv_dm_t dt,
    dt_alert_id_t alert);
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of rv_dm.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_rv_dm_clock(
    dt_rv_dm_t dt,
    dt_rv_dm_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of rv_dm.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_rv_dm_reset(
    dt_rv_dm_t dt,
    dt_rv_dm_reset_t rst);
 
 
 
#endif  // OPENTITAN_DT_RV_DM_H_