dt_entropy_src.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_ENTROPY_SRC_H_
#define OPENTITAN_DT_ENTROPY_SRC_H_
 
/**
 * @file
 * @brief Device Tables (DT) for IP entropy_src and top earlgrey.
 *
 * This file contains the type definitions and global functions of the entropy_src.
 */
 
#include "dt_api.h"
#include <stdint.h>
 
/**
 * List of instances.
 */
typedef enum dt_entropy_src {
  kDtEntropySrc = 0, /**< entropy_src */
  kDtEntropySrcFirst = 0, /**< \internal First instance */
  kDtEntropySrcCount = 1, /**< \internal Number of instances */
} dt_entropy_src_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_entropy_src_reg_block {
  kDtEntropySrcRegBlockCore = 0, /**<  */
  kDtEntropySrcRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_entropy_src_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_entropy_src_reg_block_t kDtEntropySrcRegBlockPrimary = kDtEntropySrcRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_entropy_src_irq {
  kDtEntropySrcIrqEsEntropyValid = 0, /**< Asserted when entropy source bits are available for firmware for consumption via !!ENTROPY_DATA register. */
  kDtEntropySrcIrqEsHealthTestFailed = 1, /**< Asserted whenever the main state machine is in the alert state, e.g., due to health tests failing and reaching the threshold value configured in !!ALERT_THRESHOLD. */
  kDtEntropySrcIrqEsObserveFifoReady = 2, /**< Asserted when the observe FIFO has filled to the configured threshold level (see !!OBSERVE_FIFO_THRESH). */
  kDtEntropySrcIrqEsFatalErr = 3, /**< Asserted when an fatal error condition is met, e.g., upon FIFO errors, or if an illegal state machine state is reached. */
  kDtEntropySrcIrqCount = 4, /**< \internal Number of IRQs */
} dt_entropy_src_irq_t;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_entropy_src_alert {
  kDtEntropySrcAlertRecovAlert = 0, /**< This alert is triggered upon the alert health test threshold criteria not met. */
  kDtEntropySrcAlertFatalAlert = 1, /**< This alert triggers for any condition detected in the !!ERR_CODE register,
which includes FIFO errors, COUNTER errors, FSM state errors,
and also when integrity failures are detected on the TL-UL bus. */
  kDtEntropySrcAlertCount = 2, /**< \internal Number of Alerts */
} dt_entropy_src_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_entropy_src_clock {
  kDtEntropySrcClockClk = 0, /**< Clock port clk_i */
  kDtEntropySrcClockCount = 1, /**< \internal Number of clock ports */
} dt_entropy_src_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_entropy_src_reset {
  kDtEntropySrcResetRst = 0, /**< Reset port rst_ni */
  kDtEntropySrcResetCount = 1, /**< \internal Number of reset ports */
} dt_entropy_src_reset_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_ENTROPY_SRC_HAS_MODE_BYPASS 1
#define OPENTITAN_ENTROPY_SRC_HAS_MODE_FIPS 1
#define OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS 1
#define OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS_EXT 1
#define OPENTITAN_ENTROPY_SRC_HAS_RNG_BIT_ENABLE 1
#define OPENTITAN_ENTROPY_SRC_HAS_ROUTE_TO_FIRMWARE 1
#define OPENTITAN_ENTROPY_SRC_HAS_FW_OV_OBSERVE 1
#define OPENTITAN_ENTROPY_SRC_HAS_FW_OV_EXTRACT_AND_INSERT 1
 
 
 
/**
 * Get the entropy_src instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A entropy_src instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type entropy_src,
 * otherwise the returned value is unspecified.
 */
dt_entropy_src_t dt_entropy_src_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of entropy_src.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_entropy_src_instance_id(dt_entropy_src_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of entropy_src.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_entropy_src_reg_block(
    dt_entropy_src_t dt,
    dt_entropy_src_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_entropy_src_reg_block(dt, kDtEntropySrcRegBlockCore)`
 *
 * @param dt Instance of entropy_src.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_entropy_src_primary_reg_block(
    dt_entropy_src_t dt) {
  return dt_entropy_src_reg_block(dt, kDtEntropySrcRegBlockCore);
}
 
/**
 * Get the PLIC ID of a entropy_src IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of entropy_src.
 * @param irq A entropy_src IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_entropy_src_irq_to_plic_id(
    dt_entropy_src_t dt,
    dt_entropy_src_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local entropy_src IRQ type.
 *
 * @param dt Instance of entropy_src.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The entropy_src IRQ, or `kDtEntropySrcIrqCount`.
 *
 * **Note:** This function assumes that the PLIC ID belongs to the instance
 * of entropy_src passed in parameter. In other words, it must be the case that
 * `dt_entropy_src_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
 * will return `kDtEntropySrcIrqCount`.
 */
dt_entropy_src_irq_t dt_entropy_src_irq_from_plic_id(
    dt_entropy_src_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * Get the alert ID of a entropy_src 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 entropy_src.
 * @param alert A entropy_src alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_entropy_src_alert_to_alert_id(
    dt_entropy_src_t dt,
    dt_entropy_src_alert_t alert);
 
/**
 * Convert a global alert ID to a local entropy_src alert type.
 *
 * @param dt Instance of entropy_src.
 * @param alert A global alert ID that belongs to this instance.
 * @return The entropy_src alert, or `kDtEntropySrcAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of entropy_src passed in parameter. In other words, it must be the case
 * that `dt_entropy_src_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtEntropySrcAlertCount`.
 */
dt_entropy_src_alert_t dt_entropy_src_alert_from_alert_id(
    dt_entropy_src_t dt,
    dt_alert_id_t alert);
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of entropy_src.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_entropy_src_clock(
    dt_entropy_src_t dt,
    dt_entropy_src_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of entropy_src.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_entropy_src_reset(
    dt_entropy_src_t dt,
    dt_entropy_src_reset_t rst);
 
 
 
#endif  // OPENTITAN_DT_ENTROPY_SRC_H_