kmac.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_KMAC_H_
#define OPENTITAN_DT_KMAC_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP kmac and top earlgrey.
 *
 * This file contains the type definitions and global functions of the kmac.
 */
 
#include "hw/top/dt/api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_kmac {
  kDtKmacFirst = 0, /**< First instance */
  kDtKmac = 0, /**< kmac */
} dt_kmac_t;
 
enum {
  kDtKmacCount = 1, /**< Number of instances */
};
 
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_kmac_reg_block {
  kDtKmacRegBlockCore = 0, /**<  */
} dt_kmac_reg_block_t;
 
enum {
  kDtKmacRegBlockCount = 1, /**< Number of register blocks */
};
 
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_kmac_reg_block_t kDtKmacRegBlockPrimary = kDtKmacRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_kmac_irq {
  kDtKmacIrqKmacDone = 0, /**< KMAC/SHA3 absorbing has been completed */
  kDtKmacIrqFifoEmpty = 1, /**< The message FIFO is empty.
  This interrupt is raised only if the message FIFO is actually writable by software, i.e., if all of the following conditions are met:
  i) The KMAC block is not exercised by a hardware application interface.
  ii) The SHA3 block is in the Absorb state.
  iii) Software has not yet written the Process command to finish the absorption process.
  For the interrupt to be raised, the message FIFO must also have been full previously.
  Otherwise, the hardware empties the FIFO faster than software can fill it and there is no point in interrupting the software to inform it about the message FIFO being empty. */
  kDtKmacIrqKmacErr = 2, /**< KMAC/SHA3 error occurred. ERR_CODE register shows the details */
} dt_kmac_irq_t;
 
enum {
  kDtKmacIrqCount = 3, /**< Number of IRQs */
};
 
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_kmac_alert {
  kDtKmacAlertRecovOperationErr = 0, /**< Alert for KMAC operation error. It occurs when the shadow registers have update errors. */
  kDtKmacAlertFatalFaultErr = 1, /**< This fatal alert is triggered when a fatal error is detected inside the KMAC unit.
  Examples for such faults include:
  i) TL-UL bus integrity fault.
  ii) Storage errors in the shadow registers.
  iii) Errors in the message, round, or key counter.
  iv) Any internal FSM entering an invalid state.
  v) An error in the redundant lfsr.
  The KMAC unit cannot recover from such an error and needs to be reset. */
} dt_kmac_alert_t;
 
enum {
  kDtKmacAlertCount = 2, /**< Number of Alerts */
};
 
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_kmac_clock {
  kDtKmacClockClk = 0, /**< Clock port clk_i */
  kDtKmacClockEdn = 1, /**< Clock port clk_edn_i */
} dt_kmac_clock_t;
 
enum {
  kDtKmacClockCount = 2, /**< Number of clock ports */
};
 
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_kmac_reset {
  kDtKmacResetRst = 0, /**< Reset port rst_ni */
  kDtKmacResetEdn = 1, /**< Reset port rst_edn_ni */
} dt_kmac_reset_t;
 
enum {
  kDtKmacResetCount = 2, /**< Number of reset ports */
};
 
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_KMAC_HAS_MODE_SHA3 1
#define OPENTITAN_KMAC_HAS_MODE_SHAKE 1
#define OPENTITAN_KMAC_HAS_MODE_CSHAKE 1
#define OPENTITAN_KMAC_HAS_MODE_KMAC 1
#define OPENTITAN_KMAC_HAS_MODE_XOF 1
#define OPENTITAN_KMAC_HAS_ENDIANNESS_MESSAGE 1
#define OPENTITAN_KMAC_HAS_ENDIANNESS_DIGEST 1
#define OPENTITAN_KMAC_HAS_KEY_SIDELOAD 1
#define OPENTITAN_KMAC_HAS_ENTROPY_MODES 1
 
 
 
/**
 * Get the kmac instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A kmac instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type kmac,
 * otherwise the returned value is unspecified.
 */
dt_kmac_t dt_kmac_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of kmac.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_kmac_instance_id(dt_kmac_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of kmac.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_kmac_reg_block(
    dt_kmac_t dt,
    dt_kmac_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_kmac_reg_block(dt, kDtKmacRegBlockCore)`
 *
 * @param dt Instance of kmac.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_kmac_primary_reg_block(
    dt_kmac_t dt) {
  return dt_kmac_reg_block(dt, kDtKmacRegBlockCore);
}
 
/**
 * Get the PLIC ID of a kmac IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of kmac.
 * @param irq A kmac IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_kmac_irq_to_plic_id(
    dt_kmac_t dt,
    dt_kmac_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local kmac IRQ type.
 *
 * @param dt Instance of kmac.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The kmac IRQ, or `kDtKmacIrqCount`.
 *
 * **Note:** This function assumes that the PLIC ID belongs to the instance
 * of kmac passed in parameter. In other words, it must be the case that
 * `dt_kmac_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
 * will return `kDtKmacIrqCount`.
 */
dt_kmac_irq_t dt_kmac_irq_from_plic_id(
    dt_kmac_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * Get the alert ID of a kmac 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 kmac.
 * @param alert A kmac alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_kmac_alert_to_alert_id(
    dt_kmac_t dt,
    dt_kmac_alert_t alert);
 
/**
 * Convert a global alert ID to a local kmac alert type.
 *
 * @param dt Instance of kmac.
 * @param alert A global alert ID that belongs to this instance.
 * @return The kmac alert, or `kDtKmacAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of kmac passed in parameter. In other words, it must be the case
 * that `dt_kmac_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtKmacAlertCount`.
 */
dt_kmac_alert_t dt_kmac_alert_from_alert_id(
    dt_kmac_t dt,
    dt_alert_id_t alert);
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of kmac.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_kmac_clock(
    dt_kmac_t dt,
    dt_kmac_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of kmac.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_kmac_reset(
    dt_kmac_t dt,
    dt_kmac_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_KMAC_H_