dif_hmac_autogen.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
 
 
 
#ifndef OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_HMAC_AUTOGEN_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_HMAC_AUTOGEN_H_
 
// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
// util/autogen_dif.py -i hw/ip/hmac/data/hmac.hjson -o
// bazel-out/k8-fastbuild/bin/sw/device/lib/dif/autogen
 
 
/**
 * @file
 * @brief <a href="/book/hw/ip/hmac/">HMAC</a> Device Interface Functions
 */
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"
#include "hw/top/dt/hmac.h" // Generated.
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * A handle to hmac.
 *
 * This type should be treated as opaque by users.
 */
typedef struct dif_hmac {
  /**
   * The base address for the hmac hardware registers.
   */
  mmio_region_t base_addr;
  /**
   * The instance, set to `kDtHmacCount` if not initialized
   * through `dif_hmac_init_from_dt`.
   */
  dt_hmac_t dt;
} dif_hmac_t;
 
/**
 * Creates a new handle for a(n) hmac peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param base_addr The MMIO base address of the hmac peripheral.
 * @param[out] hmac Out param for the initialized handle.
 * @return The result of the operation.
 *
 * DEPRECATED This function exists solely for the transition to
 * dt-based DIFs and will be removed in the future.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_hmac_init(
  mmio_region_t base_addr,
  dif_hmac_t *hmac);
 
/**
 * Creates a new handle for a(n) hmac peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param dt The devicetable description of the device.
 * @param[out] hmac Out param for the initialized handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_hmac_init_from_dt(
  dt_hmac_t dt,
  dif_hmac_t *hmac);
 
/**
 * Get the DT handle from this DIF.
 *
 * If this DIF was initialized by `dif_hmac_init_from_dt(dt, ..)`
 * then this function will return `dt`. Otherwise it will return an error.
 *
 * @param hmac A hmac handle.
 * @param[out] dt DT handle.
 * @return `kDifBadArg` if the DIF has no DT information, `kDifOk` otherwise.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_hmac_get_dt(
  const dif_hmac_t *hmac,
  dt_hmac_t *dt);
 
  /**
   * A hmac alert type.
   */
  typedef enum dif_hmac_alert {
    /**
     * This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
     */
      kDifHmacAlertFatalFault = 0,
  } dif_hmac_alert_t;
 
  /**
   * Forces a particular alert, causing it to be escalated as if the hardware
   * had raised it.
   *
   * @param hmac A hmac handle.
   * @param alert The alert to force.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_alert_force(
    const dif_hmac_t *hmac,
    dif_hmac_alert_t alert);
 
  // DEPRECATED This typedef exists solely for the transition to
  // dt-based interrupt numbers and will be removed in the future.
  typedef dt_hmac_irq_t dif_hmac_irq_t;
 
  /**
   * A hmac interrupt request type.
   *
   * DEPRECATED Use `dt_hmac_irq_t` instead.
   * This enumeration exists solely for the transition to
   * dt-based interrupt numbers and will be removed in the future.
   *
   * The following are defines to keep the types consistent with DT.
   */
    /**
     * HMAC/SHA-2 has completed.
     */
#define kDifHmacIrqHmacDone kDtHmacIrqHmacDone
    /**
     * 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.
     */
#define kDifHmacIrqFifoEmpty kDtHmacIrqFifoEmpty
    /**
     * HMAC error has occurred. ERR_CODE register shows which error occurred.
     */
#define kDifHmacIrqHmacErr kDtHmacIrqHmacErr
 
  /**
   * A snapshot of the state of the interrupts for this IP.
   *
   * This is an opaque type, to be used with the `dif_hmac_irq_get_state()`
   * and `dif_hmac_irq_acknowledge_state()` functions.
   */
  typedef uint32_t dif_hmac_irq_state_snapshot_t;
 
  /**
   * Returns the type of a given interrupt (i.e., event or status) for this IP.
   *
   * @param hmac A hmac handle.
   * @param irq An interrupt request.
   * @param[out] type Out-param for the interrupt type.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_get_type(
    const dif_hmac_t *hmac,
    dif_hmac_irq_t,
    dif_irq_type_t *type);
 
  /**
   * Returns the state of all interrupts (i.e., pending or not) for this IP.
   *
   * @param hmac A hmac handle.
   * @param[out] snapshot Out-param for interrupt state snapshot.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_get_state(
    const dif_hmac_t *hmac,
    dif_hmac_irq_state_snapshot_t *snapshot);
 
  /**
   * Returns whether a particular interrupt is currently pending.
   *
   * @param hmac A hmac handle.
   * @param irq An interrupt request.
   * @param[out] is_pending Out-param for whether the interrupt is pending.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_is_pending(
    const dif_hmac_t *hmac,
    dif_hmac_irq_t,
    bool *is_pending);
 
  /**
   * Acknowledges all interrupts that were pending at the time of the state
   * snapshot.
   *
   * @param hmac A hmac handle.
   * @param snapshot Interrupt state snapshot.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_acknowledge_state(
    const dif_hmac_t *hmac,
    dif_hmac_irq_state_snapshot_t snapshot);
 
  /**
   * Acknowledges all interrupts, indicating to the hardware that all
   * interrupts have been successfully serviced.
   *
   * @param hmac A hmac handle.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_acknowledge_all(
    const dif_hmac_t *hmac
    );
 
  /**
   * Acknowledges a particular interrupt, indicating to the hardware that it has
   * been successfully serviced.
   *
   * @param hmac A hmac handle.
   * @param irq An interrupt request.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_acknowledge(
    const dif_hmac_t *hmac,
    dif_hmac_irq_t);
 
  /**
   * Forces a particular interrupt, causing it to be serviced as if hardware had
   * asserted it.
   *
   * @param hmac A hmac handle.
   * @param irq An interrupt request.
   * @param val Value to be set.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_force(
    const dif_hmac_t *hmac,
    dif_hmac_irq_t,
    const bool val);
 
  /**
   * A snapshot of the enablement state of the interrupts for this IP.
   *
   * This is an opaque type, to be used with the
   * `dif_hmac_irq_disable_all()` and `dif_hmac_irq_restore_all()`
   * functions.
   */
  typedef uint32_t dif_hmac_irq_enable_snapshot_t;
 
  /**
   * Checks whether a particular interrupt is currently enabled or disabled.
   *
   * @param hmac A hmac handle.
   * @param irq An interrupt request.
   * @param[out] state Out-param toggle state of the interrupt.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_get_enabled(
    const dif_hmac_t *hmac,
    dif_hmac_irq_t,
    dif_toggle_t *state);
 
  /**
   * Sets whether a particular interrupt is currently enabled or disabled.
   *
   * @param hmac A hmac handle.
   * @param irq An interrupt request.
   * @param state The new toggle state for the interrupt.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_set_enabled(
    const dif_hmac_t *hmac,
    dif_hmac_irq_t,
    dif_toggle_t state);
 
  /**
   * Disables all interrupts, optionally snapshotting all enable states for later
   * restoration.
   *
   * @param hmac A hmac handle.
   * @param[out] snapshot Out-param for the snapshot; may be `NULL`.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_disable_all(
    const dif_hmac_t *hmac,
    dif_hmac_irq_enable_snapshot_t *snapshot);
 
  /**
   * Restores interrupts from the given (enable) snapshot.
   *
   * @param hmac A hmac handle.
   * @param snapshot A snapshot to restore from.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_hmac_irq_restore_all(
    const dif_hmac_t *hmac,
    const dif_hmac_irq_enable_snapshot_t *snapshot);
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_HMAC_AUTOGEN_H_