dt_csrng.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_CSRNG_H_
#define OPENTITAN_DT_CSRNG_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP csrng and top earlgrey.
 *
 * This file contains the type definitions and global functions of the csrng.
 */
 
#include "hw/top/dt/dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_csrng {
  kDtCsrng = 0, /**< csrng */
  kDtCsrngFirst = 0, /**< \internal First instance */
  kDtCsrngCount = 1, /**< \internal Number of instances */
} dt_csrng_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_csrng_reg_block {
  kDtCsrngRegBlockCore = 0, /**<  */
  kDtCsrngRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_csrng_reg_block_t;
 
/**
 * List of memories.
 *
 * Memories are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_csrng_memory {
  kDtCsrngMemoryCount = 0, /**< \internal Number of memories */
} dt_csrng_memory_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_csrng_reg_block_t kDtCsrngRegBlockPrimary = kDtCsrngRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_csrng_irq {
  kDtCsrngIrqCsCmdReqDone = 0, /**< Asserted when a command request is completed. */
  kDtCsrngIrqCsEntropyReq = 1, /**< Asserted when a request for entropy has been made. */
  kDtCsrngIrqCsHwInstExc = 2, /**< Asserted when a hardware-attached CSRNG instance encounters a command exception */
  kDtCsrngIrqCsFatalErr = 3, /**< Asserted when a FIFO error or a fatal alert occurs. Check the !!ERR_CODE register to get more information. */
  kDtCsrngIrqCount = 4, /**< \internal Number of IRQs */
} dt_csrng_irq_t;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_csrng_alert {
  kDtCsrngAlertRecovAlert = 0, /**< This alert is triggered when a recoverable alert occurs.  Check the !!RECOV_ALERT_STS register to get more information. */
  kDtCsrngAlertFatalAlert = 1, /**< This alert triggers (i) if an illegal state machine state is reached, or
(ii) if an AES fatal alert condition occurs, or (iii) if a fatal integrity
failure is detected on the TL-UL bus. */
  kDtCsrngAlertCount = 2, /**< \internal Number of Alerts */
} dt_csrng_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_csrng_clock {
  kDtCsrngClockClk = 0, /**< Clock port clk_i */
  kDtCsrngClockCount = 1, /**< \internal Number of clock ports */
} dt_csrng_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_csrng_reset {
  kDtCsrngResetRst = 0, /**< Reset port rst_ni */
  kDtCsrngResetCount = 1, /**< \internal Number of reset ports */
} dt_csrng_reset_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_CSRNG_HAS_INTERFACE_SOFTWARE 1
#define OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE0 1
#define OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE1 1
#define OPENTITAN_CSRNG_HAS_MODE_DETERMINISTIC 1
#define OPENTITAN_CSRNG_HAS_MODE_NONDETERMINISTIC 1
#define OPENTITAN_CSRNG_HAS_READ_INT_STATE 1
#define OPENTITAN_CSRNG_HAS_LIFECYCLE_DEBUGENABLE 1
 
 
 
/**
 * Get the csrng instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A csrng instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type csrng,
 * otherwise the returned value is unspecified.
 */
dt_csrng_t dt_csrng_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of csrng.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_csrng_instance_id(dt_csrng_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of csrng.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_csrng_reg_block(
    dt_csrng_t dt,
    dt_csrng_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_csrng_reg_block(dt, kDtCsrngRegBlockCore)`
 *
 * @param dt Instance of csrng.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_csrng_primary_reg_block(
    dt_csrng_t dt) {
  return dt_csrng_reg_block(dt, kDtCsrngRegBlockCore);
}
 
/**
 * Get the base address of a memory.
 *
 * @param dt Instance of csrng.
 * @param mem The memory requested.
 * @return The base address of the requested memory.
 */
uint32_t dt_csrng_memory_base(
    dt_csrng_t dt,
    dt_csrng_memory_t mem);
 
/**
 * Get the size of a memory.
 *
 * @param dt Instance of csrng.
 * @param mem The memory requested.
 * @return The size of the requested memory.
 */
uint32_t dt_csrng_memory_size(
    dt_csrng_t dt,
    dt_csrng_memory_t mem);
 
/**
 * Get the PLIC ID of a csrng IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of csrng.
 * @param irq A csrng IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_csrng_irq_to_plic_id(
    dt_csrng_t dt,
    dt_csrng_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local csrng IRQ type.
 *
 * @param dt Instance of csrng.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The csrng IRQ, or `kDtCsrngIrqCount`.
 *
 * **Note:** This function assumes that the PLIC ID belongs to the instance
 * of csrng passed in parameter. In other words, it must be the case that
 * `dt_csrng_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
 * will return `kDtCsrngIrqCount`.
 */
dt_csrng_irq_t dt_csrng_irq_from_plic_id(
    dt_csrng_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * Get the alert ID of a csrng 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 csrng.
 * @param alert A csrng alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_csrng_alert_to_alert_id(
    dt_csrng_t dt,
    dt_csrng_alert_t alert);
 
/**
 * Convert a global alert ID to a local csrng alert type.
 *
 * @param dt Instance of csrng.
 * @param alert A global alert ID that belongs to this instance.
 * @return The csrng alert, or `kDtCsrngAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of csrng passed in parameter. In other words, it must be the case
 * that `dt_csrng_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtCsrngAlertCount`.
 */
dt_csrng_alert_t dt_csrng_alert_from_alert_id(
    dt_csrng_t dt,
    dt_alert_id_t alert);
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of csrng.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_csrng_clock(
    dt_csrng_t dt,
    dt_csrng_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of csrng.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_csrng_reset(
    dt_csrng_t dt,
    dt_csrng_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_CSRNG_H_