dif_spi_device_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_SPI_DEVICE_AUTOGEN_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_SPI_DEVICE_AUTOGEN_H_
 
// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
// util/autogen_dif.py -i hw/ip/spi_device/data/spi_device.hjson -o
// bazel-out/k8-fastbuild/bin/sw/device/lib/dif/autogen
 
 
/**
 * @file
 * @brief <a href="/book/hw/ip/spi_device/">SPI_DEVICE</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/spi_device.h" // Generated.
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * A handle to spi_device.
 *
 * This type should be treated as opaque by users.
 */
typedef struct dif_spi_device {
  /**
   * The base address for the spi_device hardware registers.
   */
  mmio_region_t base_addr;
  /**
   * The instance, set to `kDtSpiDeviceCount` if not initialized
   * through `dif_spi_device_init_from_dt`.
   */
  dt_spi_device_t dt;
} dif_spi_device_t;
 
/**
 * Creates a new handle for a(n) spi_device peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param base_addr The MMIO base address of the spi_device peripheral.
 * @param[out] spi_device 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_spi_device_init(
  mmio_region_t base_addr,
  dif_spi_device_t *spi_device);
 
/**
 * Creates a new handle for a(n) spi_device peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param dt The devicetable description of the device.
 * @param[out] spi_device Out param for the initialized handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_spi_device_init_from_dt(
  dt_spi_device_t dt,
  dif_spi_device_t *spi_device);
 
/**
 * Get the DT handle from this DIF.
 *
 * If this DIF was initialized by `dif_spi_device_init_from_dt(dt, ..)`
 * then this function will return `dt`. Otherwise it will return an error.
 *
 * @param spi_device A spi_device 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_spi_device_get_dt(
  const dif_spi_device_t *spi_device,
  dt_spi_device_t *dt);
 
  /**
   * A spi_device alert type.
   */
  typedef enum dif_spi_device_alert {
    /**
     * This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
     */
      kDifSpiDeviceAlertFatalFault = 0,
  } dif_spi_device_alert_t;
 
  /**
   * Forces a particular alert, causing it to be escalated as if the hardware
   * had raised it.
   *
   * @param spi_device A spi_device handle.
   * @param alert The alert to force.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_spi_device_alert_force(
    const dif_spi_device_t *spi_device,
    dif_spi_device_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_spi_device_irq_t dif_spi_device_irq_t;
 
  /**
   * A spi_device interrupt request type.
   *
   * DEPRECATED Use `dt_spi_device_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.
   */
    /**
     * Upload Command FIFO is not empty.
     */
#define kDifSpiDeviceIrqUploadCmdfifoNotEmpty kDtSpiDeviceIrqUploadCmdfifoNotEmpty
    /**
     * Upload payload is not empty.  The event occurs after a SPI transaction is completed.
     */
#define kDifSpiDeviceIrqUploadPayloadNotEmpty kDtSpiDeviceIrqUploadPayloadNotEmpty
    /**
     * Upload payload overflow event.  When a SPI Host system issues a command with payload more than 256B, this event is reported. When it happens, SW should read the last written payload index CSR to figure out the starting address of the last 256B.
     */
#define kDifSpiDeviceIrqUploadPayloadOverflow kDtSpiDeviceIrqUploadPayloadOverflow
    /**
     * Read Buffer Threshold event.  The host system accesses greater than or equal to the threshold of a buffer.
     */
#define kDifSpiDeviceIrqReadbufWatermark kDtSpiDeviceIrqReadbufWatermark
    /**
     * Read buffer flipped event.  The host system accesses other side of buffer.
     */
#define kDifSpiDeviceIrqReadbufFlip kDtSpiDeviceIrqReadbufFlip
    /**
     * TPM Header(Command/Address) buffer available
     */
#define kDifSpiDeviceIrqTpmHeaderNotEmpty kDtSpiDeviceIrqTpmHeaderNotEmpty
    /**
     * TPM RdFIFO command ended.  The TPM Read command targeting the RdFIFO ended. Check TPM_STATUS.rdfifo_aborted to see if the transaction completed.
     */
#define kDifSpiDeviceIrqTpmRdfifoCmdEnd kDtSpiDeviceIrqTpmRdfifoCmdEnd
    /**
     * TPM RdFIFO data dropped.  Data was dropped from the RdFIFO. Data was written while a read command was not active, and it was not accepted. This can occur when the host aborts a read command.
     */
#define kDifSpiDeviceIrqTpmRdfifoDrop kDtSpiDeviceIrqTpmRdfifoDrop
 
  /**
   * A snapshot of the state of the interrupts for this IP.
   *
   * This is an opaque type, to be used with the `dif_spi_device_irq_get_state()`
   * and `dif_spi_device_irq_acknowledge_state()` functions.
   */
  typedef uint32_t dif_spi_device_irq_state_snapshot_t;
 
  /**
   * Returns the type of a given interrupt (i.e., event or status) for this IP.
   *
   * @param spi_device A spi_device 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_spi_device_irq_get_type(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_t,
    dif_irq_type_t *type);
 
  /**
   * Returns the state of all interrupts (i.e., pending or not) for this IP.
   *
   * @param spi_device A spi_device handle.
   * @param[out] snapshot Out-param for interrupt state snapshot.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_spi_device_irq_get_state(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_state_snapshot_t *snapshot);
 
  /**
   * Returns whether a particular interrupt is currently pending.
   *
   * @param spi_device A spi_device 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_spi_device_irq_is_pending(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_t,
    bool *is_pending);
 
  /**
   * Acknowledges all interrupts that were pending at the time of the state
   * snapshot.
   *
   * @param spi_device A spi_device handle.
   * @param snapshot Interrupt state snapshot.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_spi_device_irq_acknowledge_state(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_state_snapshot_t snapshot);
 
  /**
   * Acknowledges all interrupts, indicating to the hardware that all
   * interrupts have been successfully serviced.
   *
   * @param spi_device A spi_device handle.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_spi_device_irq_acknowledge_all(
    const dif_spi_device_t *spi_device
    );
 
  /**
   * Acknowledges a particular interrupt, indicating to the hardware that it has
   * been successfully serviced.
   *
   * @param spi_device A spi_device handle.
   * @param irq An interrupt request.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_spi_device_irq_acknowledge(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_t);
 
  /**
   * Forces a particular interrupt, causing it to be serviced as if hardware had
   * asserted it.
   *
   * @param spi_device A spi_device 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_spi_device_irq_force(
    const dif_spi_device_t *spi_device,
    dif_spi_device_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_spi_device_irq_disable_all()` and `dif_spi_device_irq_restore_all()`
   * functions.
   */
  typedef uint32_t dif_spi_device_irq_enable_snapshot_t;
 
  /**
   * Checks whether a particular interrupt is currently enabled or disabled.
   *
   * @param spi_device A spi_device 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_spi_device_irq_get_enabled(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_t,
    dif_toggle_t *state);
 
  /**
   * Sets whether a particular interrupt is currently enabled or disabled.
   *
   * @param spi_device A spi_device 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_spi_device_irq_set_enabled(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_t,
    dif_toggle_t state);
 
  /**
   * Disables all interrupts, optionally snapshotting all enable states for later
   * restoration.
   *
   * @param spi_device A spi_device 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_spi_device_irq_disable_all(
    const dif_spi_device_t *spi_device,
    dif_spi_device_irq_enable_snapshot_t *snapshot);
 
  /**
   * Restores interrupts from the given (enable) snapshot.
   *
   * @param spi_device A spi_device handle.
   * @param snapshot A snapshot to restore from.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_spi_device_irq_restore_all(
    const dif_spi_device_t *spi_device,
    const dif_spi_device_irq_enable_snapshot_t *snapshot);
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_SPI_DEVICE_AUTOGEN_H_