dif_i2c_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_I2C_AUTOGEN_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_I2C_AUTOGEN_H_
 
// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
// util/autogen_dif.py -i hw/ip/i2c/data/i2c.hjson -o
// bazel-out/k8-fastbuild/bin/sw/device/lib/dif/autogen
 
 
/**
 * @file
 * @brief <a href="/book/hw/ip/i2c/">I2C</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/i2c.h" // Generated.
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * A handle to i2c.
 *
 * This type should be treated as opaque by users.
 */
typedef struct dif_i2c {
  /**
   * The base address for the i2c hardware registers.
   */
  mmio_region_t base_addr;
  /**
   * The instance, set to `kDtI2cCount` if not initialized
   * through `dif_i2c_init_from_dt`.
   */
  dt_i2c_t dt;
} dif_i2c_t;
 
/**
 * Creates a new handle for a(n) i2c peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param base_addr The MMIO base address of the i2c peripheral.
 * @param[out] i2c 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_i2c_init(
  mmio_region_t base_addr,
  dif_i2c_t *i2c);
 
/**
 * Creates a new handle for a(n) i2c peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param dt The devicetable description of the device.
 * @param[out] i2c Out param for the initialized handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_i2c_init_from_dt(
  dt_i2c_t dt,
  dif_i2c_t *i2c);
 
/**
 * Get the DT handle from this DIF.
 *
 * If this DIF was initialized by `dif_i2c_init_from_dt(dt, ..)`
 * then this function will return `dt`. Otherwise it will return an error.
 *
 * @param i2c A i2c 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_i2c_get_dt(
  const dif_i2c_t *i2c,
  dt_i2c_t *dt);
 
  /**
   * A i2c alert type.
   */
  typedef enum dif_i2c_alert {
    /**
     * This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
     */
      kDifI2cAlertFatalFault = 0,
  } dif_i2c_alert_t;
 
  /**
   * Forces a particular alert, causing it to be escalated as if the hardware
   * had raised it.
   *
   * @param i2c A i2c handle.
   * @param alert The alert to force.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_i2c_alert_force(
    const dif_i2c_t *i2c,
    dif_i2c_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_i2c_irq_t dif_i2c_irq_t;
 
  /**
   * A i2c interrupt request type.
   *
   * DEPRECATED Use `dt_i2c_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.
   */
    /**
     * Host mode interrupt: asserted whilst the FMT FIFO level is below the low threshold. This is a level status interrupt.
     */
#define kDifI2cIrqFmtThreshold kDtI2cIrqFmtThreshold
    /**
     * Host mode interrupt: asserted whilst the RX FIFO level is above the high threshold. This is a level status interrupt.
     */
#define kDifI2cIrqRxThreshold kDtI2cIrqRxThreshold
    /**
     * Target mode interrupt: asserted whilst the ACQ FIFO level is above the high threshold. This is a level status interrupt.
     */
#define kDifI2cIrqAcqThreshold kDtI2cIrqAcqThreshold
    /**
     * Host mode interrupt: raised if the RX FIFO has overflowed.
     */
#define kDifI2cIrqRxOverflow kDtI2cIrqRxOverflow
    /**
     * Host mode interrupt: raised if the controller FSM is halted, such as on an unexpected NACK or lost arbitration. Check !!CONTROLLER_EVENTS for the reason. The interrupt will be released when the bits in !!CONTROLLER_EVENTS are cleared.
     */
#define kDifI2cIrqControllerHalt kDtI2cIrqControllerHalt
    /**
     * Host mode interrupt: raised if the SCL line drops early (not supported without clock synchronization).
     */
#define kDifI2cIrqSclInterference kDtI2cIrqSclInterference
    /**
     * Host mode interrupt: raised if the SDA line goes low when host is trying to assert high
     */
#define kDifI2cIrqSdaInterference kDtI2cIrqSdaInterference
    /**
     * Host mode interrupt: raised if target stretches the clock beyond the allowed timeout period
     */
#define kDifI2cIrqStretchTimeout kDtI2cIrqStretchTimeout
    /**
     * Host mode interrupt: raised if the target does not assert a constant value of SDA during transmission.
     */
#define kDifI2cIrqSdaUnstable kDtI2cIrqSdaUnstable
    /**
     * Host and target mode interrupt. In host mode, raised if the host issues a repeated START or terminates the transaction by issuing STOP. In target mode, raised if the external host issues a STOP or repeated START.
     */
#define kDifI2cIrqCmdComplete kDtI2cIrqCmdComplete
    /**
     * Target mode interrupt: raised if the target is stretching clocks for a read command. This is a level status interrupt.
     */
#define kDifI2cIrqTxStretch kDtI2cIrqTxStretch
    /**
     * Target mode interrupt: asserted whilst the TX FIFO level is below the low threshold. This is a level status interrupt.
     */
#define kDifI2cIrqTxThreshold kDtI2cIrqTxThreshold
    /**
     * Target mode interrupt: raised if the target is stretching clocks due to full ACQ FIFO or zero count in !!TARGET_ACK_CTRL.NBYTES (if enabled). This is a level status interrupt.
     */
#define kDifI2cIrqAcqStretch kDtI2cIrqAcqStretch
    /**
     * Target mode interrupt: raised if STOP is received without a preceding NACK during an external host read.
     */
#define kDifI2cIrqUnexpStop kDtI2cIrqUnexpStop
    /**
     * Target mode interrupt: raised if the host stops sending the clock during an ongoing transaction.
     */
#define kDifI2cIrqHostTimeout kDtI2cIrqHostTimeout
 
  /**
   * A snapshot of the state of the interrupts for this IP.
   *
   * This is an opaque type, to be used with the `dif_i2c_irq_get_state()`
   * and `dif_i2c_irq_acknowledge_state()` functions.
   */
  typedef uint32_t dif_i2c_irq_state_snapshot_t;
 
  /**
   * Returns the type of a given interrupt (i.e., event or status) for this IP.
   *
   * @param i2c A i2c 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_i2c_irq_get_type(
    const dif_i2c_t *i2c,
    dif_i2c_irq_t,
    dif_irq_type_t *type);
 
  /**
   * Returns the state of all interrupts (i.e., pending or not) for this IP.
   *
   * @param i2c A i2c handle.
   * @param[out] snapshot Out-param for interrupt state snapshot.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_i2c_irq_get_state(
    const dif_i2c_t *i2c,
    dif_i2c_irq_state_snapshot_t *snapshot);
 
  /**
   * Returns whether a particular interrupt is currently pending.
   *
   * @param i2c A i2c 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_i2c_irq_is_pending(
    const dif_i2c_t *i2c,
    dif_i2c_irq_t,
    bool *is_pending);
 
  /**
   * Acknowledges all interrupts that were pending at the time of the state
   * snapshot.
   *
   * @param i2c A i2c handle.
   * @param snapshot Interrupt state snapshot.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_i2c_irq_acknowledge_state(
    const dif_i2c_t *i2c,
    dif_i2c_irq_state_snapshot_t snapshot);
 
  /**
   * Acknowledges all interrupts, indicating to the hardware that all
   * interrupts have been successfully serviced.
   *
   * @param i2c A i2c handle.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_i2c_irq_acknowledge_all(
    const dif_i2c_t *i2c
    );
 
  /**
   * Acknowledges a particular interrupt, indicating to the hardware that it has
   * been successfully serviced.
   *
   * @param i2c A i2c handle.
   * @param irq An interrupt request.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_i2c_irq_acknowledge(
    const dif_i2c_t *i2c,
    dif_i2c_irq_t);
 
  /**
   * Forces a particular interrupt, causing it to be serviced as if hardware had
   * asserted it.
   *
   * @param i2c A i2c 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_i2c_irq_force(
    const dif_i2c_t *i2c,
    dif_i2c_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_i2c_irq_disable_all()` and `dif_i2c_irq_restore_all()`
   * functions.
   */
  typedef uint32_t dif_i2c_irq_enable_snapshot_t;
 
  /**
   * Checks whether a particular interrupt is currently enabled or disabled.
   *
   * @param i2c A i2c 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_i2c_irq_get_enabled(
    const dif_i2c_t *i2c,
    dif_i2c_irq_t,
    dif_toggle_t *state);
 
  /**
   * Sets whether a particular interrupt is currently enabled or disabled.
   *
   * @param i2c A i2c 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_i2c_irq_set_enabled(
    const dif_i2c_t *i2c,
    dif_i2c_irq_t,
    dif_toggle_t state);
 
  /**
   * Disables all interrupts, optionally snapshotting all enable states for later
   * restoration.
   *
   * @param i2c A i2c 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_i2c_irq_disable_all(
    const dif_i2c_t *i2c,
    dif_i2c_irq_enable_snapshot_t *snapshot);
 
  /**
   * Restores interrupts from the given (enable) snapshot.
   *
   * @param i2c A i2c handle.
   * @param snapshot A snapshot to restore from.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_i2c_irq_restore_all(
    const dif_i2c_t *i2c,
    const dif_i2c_irq_enable_snapshot_t *snapshot);
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_I2C_AUTOGEN_H_