dt_hmac.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_HMAC_H_
#define OPENTITAN_DT_HMAC_H_
 
/**
 * @file
 * @brief Device Tables (DT) for IP hmac and top darjeeling.
 *
 * This file contains the type definitions and global functions of the hmac.
 */
 
#include "dt_api.h"
#include <stdint.h>
 
/**
 * List of instances.
 */
typedef enum dt_hmac {
  kDtHmac = 0, /**< hmac */
  kDtHmacFirst = 0, /**< \internal First instance */
  kDtHmacCount = 1, /**< \internal Number of instances */
} dt_hmac_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_hmac_reg_block {
  kDtHmacRegBlockCore = 0, /**<  */
  kDtHmacRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_hmac_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_hmac_reg_block_t kDtHmacRegBlockPrimary = kDtHmacRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_hmac_irq {
  kDtHmacIrqHmacDone = 0, /**< HMAC/SHA-2 has completed. */
  kDtHmacIrqFifoEmpty = 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 HMAC block is not running in HMAC mode and performing the second round of computing the final hash of the outer key as well as the result of the first round using the inner key.
ii) Software has not yet written the Process or Stop command to finish the hashing operation.
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. */
  kDtHmacIrqHmacErr = 2, /**< HMAC error has occurred. ERR_CODE register shows which error occurred. */
  kDtHmacIrqCount = 3, /**< \internal Number of IRQs */
} dt_hmac_irq_t;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_hmac_alert {
  kDtHmacAlertFatalFault = 0, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
  kDtHmacAlertCount = 1, /**< \internal Number of Alerts */
} dt_hmac_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_hmac_clock {
  kDtHmacClockClk = 0, /**< Clock port clk_i */
  kDtHmacClockCount = 1, /**< \internal Number of clock ports */
} dt_hmac_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_hmac_reset {
  kDtHmacResetRst = 0, /**< Reset port rst_ni */
  kDtHmacResetCount = 1, /**< \internal Number of reset ports */
} dt_hmac_reset_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_HMAC_HAS_MODE_SHA2 1
#define OPENTITAN_HMAC_HAS_MODE_HMAC 1
#define OPENTITAN_HMAC_HAS_DIGEST_SIZE_SHA2_256 1
#define OPENTITAN_HMAC_HAS_DIGEST_SIZE_SHA2_384 1
#define OPENTITAN_HMAC_HAS_DIGEST_SIZE_SHA2_512 1
#define OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_128 1
#define OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_256 1
#define OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_384 1
#define OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_512 1
#define OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_1024 1
#define OPENTITAN_HMAC_HAS_ENDIANNESS_MESSAGE 1
#define OPENTITAN_HMAC_HAS_ENDIANNESS_DIGEST 1
#define OPENTITAN_HMAC_HAS_SECURE_WIPE 1
 
 
 
/**
 * Get the hmac instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A hmac instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type hmac,
 * otherwise the returned value is unspecified.
 */
dt_hmac_t dt_hmac_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of hmac.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_hmac_instance_id(dt_hmac_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of hmac.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_hmac_reg_block(
    dt_hmac_t dt,
    dt_hmac_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_hmac_reg_block(dt, kDtHmacRegBlockCore)`
 *
 * @param dt Instance of hmac.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_hmac_primary_reg_block(
    dt_hmac_t dt) {
  return dt_hmac_reg_block(dt, kDtHmacRegBlockCore);
}
 
/**
 * Get the PLIC ID of a hmac IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of hmac.
 * @param irq A hmac IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_hmac_irq_to_plic_id(
    dt_hmac_t dt,
    dt_hmac_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local hmac IRQ type.
 *
 * @param dt Instance of hmac.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The hmac IRQ, or `kDtHmacIrqCount`.
 *
 * **Note:** This function assumes that the PLIC ID belongs to the instance
 * of hmac passed in parameter. In other words, it must be the case that
 * `dt_hmac_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
 * will return `kDtHmacIrqCount`.
 */
dt_hmac_irq_t dt_hmac_irq_from_plic_id(
    dt_hmac_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * Get the alert ID of a hmac 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 hmac.
 * @param alert A hmac alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_hmac_alert_to_alert_id(
    dt_hmac_t dt,
    dt_hmac_alert_t alert);
 
/**
 * Convert a global alert ID to a local hmac alert type.
 *
 * @param dt Instance of hmac.
 * @param alert A global alert ID that belongs to this instance.
 * @return The hmac alert, or `kDtHmacAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of hmac passed in parameter. In other words, it must be the case
 * that `dt_hmac_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtHmacAlertCount`.
 */
dt_hmac_alert_t dt_hmac_alert_from_alert_id(
    dt_hmac_t dt,
    dt_alert_id_t alert);
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of hmac.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_hmac_clock(
    dt_hmac_t dt,
    dt_hmac_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of hmac.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_hmac_reset(
    dt_hmac_t dt,
    dt_hmac_reset_t rst);
 
 
 
#endif  // OPENTITAN_DT_HMAC_H_