dif_soc_dbg_ctrl_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_SOC_DBG_CTRL_AUTOGEN_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_SOC_DBG_CTRL_AUTOGEN_H_
 
// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
// util/autogen_dif.py -i hw/ip/soc_dbg_ctrl/data/soc_dbg_ctrl.hjson -o
// bazel-out/k8-fastbuild-ST-ae23cdef058d/bin/sw/device/lib/dif/autogen
 
 
/**
 * @file
 * @brief <a href="/book/hw/ip/soc_dbg_ctrl/">SOC_DBG_CTRL</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 "dt/dt_soc_dbg_ctrl.h" // Generated.
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * A handle to soc_dbg_ctrl.
 *
 * This type should be treated as opaque by users.
 */
typedef struct dif_soc_dbg_ctrl {
  /**
   * The base address for the soc_dbg_ctrl hardware registers.
   */
  mmio_region_t base_addr;
  /**
   * The instance, set to `kDtSocDbgCtrlCount` if not initialized
   * through `dif_soc_dbg_ctrl_init_from_dt`.
   */
  dt_soc_dbg_ctrl_t dt;
} dif_soc_dbg_ctrl_t;
 
/**
 * Creates a new handle for a(n) soc_dbg_ctrl peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param base_addr The MMIO base address of the soc_dbg_ctrl peripheral.
 * @param[out] soc_dbg_ctrl 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_soc_dbg_ctrl_init(
  mmio_region_t base_addr,
  dif_soc_dbg_ctrl_t *soc_dbg_ctrl);
 
/**
 * Creates a new handle for a(n) soc_dbg_ctrl peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param dt The devicetable description of the device.
 * @param[out] soc_dbg_ctrl Out param for the initialized handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_soc_dbg_ctrl_init_from_dt(
  dt_soc_dbg_ctrl_t dt,
  dif_soc_dbg_ctrl_t *soc_dbg_ctrl);
 
/**
 * Get the DT handle from this DIF.
 *
 * If this DIF was initialized by `dif_soc_dbg_ctrl_init_from_dt(dt, ..)`
 * then this function will return `dt`. Otherwise it will return an error.
 *
 * @param soc_dbg_ctrl A soc_dbg_ctrl 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_soc_dbg_ctrl_get_dt(
  const dif_soc_dbg_ctrl_t *soc_dbg_ctrl,
  dt_soc_dbg_ctrl_t *dt);
 
  /**
   * A soc_dbg_ctrl alert type.
   */
  typedef enum dif_soc_dbg_ctrl_alert {
    /**
     * This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
     */
      kDifSocDbgCtrlAlertFatalFault = 0,
    /**
     * This recoverable alert is triggered upon detecting an update error in the shadowed Control Register.
     */
      kDifSocDbgCtrlAlertRecovCtrlUpdateErr = 1,
  } dif_soc_dbg_ctrl_alert_t;
 
  /**
   * Forces a particular alert, causing it to be escalated as if the hardware
   * had raised it.
   *
   * @param soc_dbg_ctrl A soc_dbg_ctrl handle.
   * @param alert The alert to force.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_soc_dbg_ctrl_alert_force(
    const dif_soc_dbg_ctrl_t *soc_dbg_ctrl,
    dif_soc_dbg_ctrl_alert_t alert);
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_SOC_DBG_CTRL_AUTOGEN_H_