dif_flash_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_FLASH_CTRL_AUTOGEN_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_FLASH_CTRL_AUTOGEN_H_
 
// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
// util/make_new_dif.py --mode=regen --only=autogen
 
/**
 * @file
 * @brief <a href="/book/hw/ip/flash_ctrl/">FLASH_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"
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * A handle to flash_ctrl.
 *
 * This type should be treated as opaque by users.
 */
typedef struct dif_flash_ctrl {
  /**
   * The base address for the flash_ctrl hardware registers.
   */
  mmio_region_t base_addr;
} dif_flash_ctrl_t;
 
/**
 * Creates a new handle for a(n) flash_ctrl peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param base_addr The MMIO base address of the flash_ctrl peripheral.
 * @param[out] flash_ctrl Out param for the initialized handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_flash_ctrl_init(mmio_region_t base_addr,
                                 dif_flash_ctrl_t *flash_ctrl);
 
/**
 * A flash_ctrl alert type.
 */
typedef enum dif_flash_ctrl_alert {
  /**
   * Flash recoverable errors
   */
  kDifFlashCtrlAlertRecovErr = 0,
  /**
   * Flash standard fatal errors
   */
  kDifFlashCtrlAlertFatalStdErr = 1,
  /**
   * Flash fatal errors including uncorrectable ECC errors.  Note that this
   * alert is not always fatal. The underlying error bits in the !!FAULT_STATUS
   * register remain set until reset, meaning the alert keeps firing. This
   * doesn't hold for !!FAULT_STATUS.PHY_RELBL_ERR and
   * !!FAULT_STATUS.PHY_STORAGE_ERR. To enable firmware dealing with multi-bit
   * ECC and ICV errors during firmware selection and verification, these error
   * bits can be cleared. After passing this stage, it is recommended that
   * firmware classifies the corresponding alert as fatal on the receiver end,
   * i.e, inside the alert handler.
   */
  kDifFlashCtrlAlertFatalErr = 2,
  /**
   * Fatal alert triggered inside the flash primitive, including fatal TL-UL bus
   * integrity faults of the test interface.
   */
  kDifFlashCtrlAlertFatalPrimFlashAlert = 3,
  /**
   * Recoverable alert triggered inside the flash primitive.
   */
  kDifFlashCtrlAlertRecovPrimFlashAlert = 4,
} dif_flash_ctrl_alert_t;
 
/**
 * Forces a particular alert, causing it to be escalated as if the hardware
 * had raised it.
 *
 * @param flash_ctrl A flash_ctrl handle.
 * @param alert The alert to force.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_flash_ctrl_alert_force(const dif_flash_ctrl_t *flash_ctrl,
                                        dif_flash_ctrl_alert_t alert);
 
/**
 * A flash_ctrl interrupt request type.
 */
typedef enum dif_flash_ctrl_irq {
  /**
   * Program FIFO empty
   */
  kDifFlashCtrlIrqProgEmpty = 0,
  /**
   * Program FIFO drained to level
   */
  kDifFlashCtrlIrqProgLvl = 1,
  /**
   * Read FIFO full
   */
  kDifFlashCtrlIrqRdFull = 2,
  /**
   * Read FIFO filled to level
   */
  kDifFlashCtrlIrqRdLvl = 3,
  /**
   * Operation complete
   */
  kDifFlashCtrlIrqOpDone = 4,
  /**
   * Correctable error encountered
   */
  kDifFlashCtrlIrqCorrErr = 5,
} dif_flash_ctrl_irq_t;
 
/**
 * A snapshot of the state of the interrupts for this IP.
 *
 * This is an opaque type, to be used with the `dif_flash_ctrl_irq_get_state()`
 * and `dif_flash_ctrl_irq_acknowledge_state()` functions.
 */
typedef uint32_t dif_flash_ctrl_irq_state_snapshot_t;
 
/**
 * Returns the type of a given interrupt (i.e., event or status) for this IP.
 *
 * @param flash_ctrl A flash_ctrl 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_flash_ctrl_irq_get_type(const dif_flash_ctrl_t *flash_ctrl,
                                         dif_flash_ctrl_irq_t irq,
                                         dif_irq_type_t *type);
 
/**
 * Returns the state of all interrupts (i.e., pending or not) for this IP.
 *
 * @param flash_ctrl A flash_ctrl handle.
 * @param[out] snapshot Out-param for interrupt state snapshot.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_flash_ctrl_irq_get_state(
    const dif_flash_ctrl_t *flash_ctrl,
    dif_flash_ctrl_irq_state_snapshot_t *snapshot);
 
/**
 * Returns whether a particular interrupt is currently pending.
 *
 * @param flash_ctrl A flash_ctrl 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_flash_ctrl_irq_is_pending(const dif_flash_ctrl_t *flash_ctrl,
                                           dif_flash_ctrl_irq_t irq,
                                           bool *is_pending);
 
/**
 * Acknowledges all interrupts that were pending at the time of the state
 * snapshot.
 *
 * @param flash_ctrl A flash_ctrl handle.
 * @param snapshot Interrupt state snapshot.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_flash_ctrl_irq_acknowledge_state(
    const dif_flash_ctrl_t *flash_ctrl,
    dif_flash_ctrl_irq_state_snapshot_t snapshot);
 
/**
 * Acknowledges all interrupts, indicating to the hardware that all
 * interrupts have been successfully serviced.
 *
 * @param flash_ctrl A flash_ctrl handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_flash_ctrl_irq_acknowledge_all(
    const dif_flash_ctrl_t *flash_ctrl);
 
/**
 * Acknowledges a particular interrupt, indicating to the hardware that it has
 * been successfully serviced.
 *
 * @param flash_ctrl A flash_ctrl handle.
 * @param irq An interrupt request.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_flash_ctrl_irq_acknowledge(const dif_flash_ctrl_t *flash_ctrl,
                                            dif_flash_ctrl_irq_t irq);
 
/**
 * Forces a particular interrupt, causing it to be serviced as if hardware had
 * asserted it.
 *
 * @param flash_ctrl A flash_ctrl 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_flash_ctrl_irq_force(const dif_flash_ctrl_t *flash_ctrl,
                                      dif_flash_ctrl_irq_t irq, 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_flash_ctrl_irq_disable_all()` and `dif_flash_ctrl_irq_restore_all()`
 * functions.
 */
typedef uint32_t dif_flash_ctrl_irq_enable_snapshot_t;
 
/**
 * Checks whether a particular interrupt is currently enabled or disabled.
 *
 * @param flash_ctrl A flash_ctrl 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_flash_ctrl_irq_get_enabled(const dif_flash_ctrl_t *flash_ctrl,
                                            dif_flash_ctrl_irq_t irq,
                                            dif_toggle_t *state);
 
/**
 * Sets whether a particular interrupt is currently enabled or disabled.
 *
 * @param flash_ctrl A flash_ctrl 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_flash_ctrl_irq_set_enabled(const dif_flash_ctrl_t *flash_ctrl,
                                            dif_flash_ctrl_irq_t irq,
                                            dif_toggle_t state);
 
/**
 * Disables all interrupts, optionally snapshotting all enable states for later
 * restoration.
 *
 * @param flash_ctrl A flash_ctrl 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_flash_ctrl_irq_disable_all(
    const dif_flash_ctrl_t *flash_ctrl,
    dif_flash_ctrl_irq_enable_snapshot_t *snapshot);
 
/**
 * Restores interrupts from the given (enable) snapshot.
 *
 * @param flash_ctrl A flash_ctrl handle.
 * @param snapshot A snapshot to restore from.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_flash_ctrl_irq_restore_all(
    const dif_flash_ctrl_t *flash_ctrl,
    const dif_flash_ctrl_irq_enable_snapshot_t *snapshot);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_FLASH_CTRL_AUTOGEN_H_