sw/device/lib/dif/autogen/dif_i2s_autogen.h

/*
 * Copyright 2023 Google LLC
 * Copyright lowRISC contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_I2S_AUTOGEN_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_I2S_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="/hw/ip/i2s/doc/">I2S</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 i2s.
 *
 * This type should be treated as opaque by users.
 */
typedef struct dif_i2s {
  /**
   * The base address for the i2s hardware registers.
   */
  mmio_region_t base_addr;
} dif_i2s_t;

/**
 * Creates a new handle for a(n) i2s peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param base_addr The MMIO base address of the i2s peripheral.
 * @param[out] i2s Out param for the initialized handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_i2s_init(mmio_region_t base_addr, dif_i2s_t *i2s);

/**
 * A i2s interrupt request type.
 */
typedef enum dif_i2s_irq {
  /**
   * Raised if the transmit FIFO is below the high-water mark. See TXILVL.
   */
  kDifI2sIrqTxWatermark = 0,
  /**
   * Raised if the receive FIFO is above the high-water mark. See RXILVL.
   */
  kDifI2sIrqRxWatermark = 1,
  /**
   * Raised if the transmit FIFO has emptied.
   */
  kDifI2sIrqTxEmpty = 2,
  /**
   * Raised if the receive FIFO has overflowed.
   */
  kDifI2sIrqRxOverflow = 3,
} dif_i2s_irq_t;

/**
 * A snapshot of the state of the interrupts for this IP.
 *
 * This is an opaque type, to be used with the `dif_i2s_irq_get_state()`
 * and `dif_i2s_irq_acknowledge_state()` functions.
 */
typedef uint32_t dif_i2s_irq_state_snapshot_t;

/**
 * Returns the type of a given interrupt (i.e., event or status) for this IP.
 *
 * @param i2s A i2s 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_i2s_irq_get_type(const dif_i2s_t *i2s, dif_i2s_irq_t irq,
                                  dif_irq_type_t *type);

/**
 * Returns the state of all interrupts (i.e., pending or not) for this IP.
 *
 * @param i2s A i2s handle.
 * @param[out] snapshot Out-param for interrupt state snapshot.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_i2s_irq_get_state(const dif_i2s_t *i2s,
                                   dif_i2s_irq_state_snapshot_t *snapshot);

/**
 * Returns whether a particular interrupt is currently pending.
 *
 * @param i2s A i2s 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_i2s_irq_is_pending(const dif_i2s_t *i2s, dif_i2s_irq_t irq,
                                    bool *is_pending);

/**
 * Acknowledges all interrupts that were pending at the time of the state
 * snapshot.
 *
 * @param i2s A i2s handle.
 * @param snapshot Interrupt state snapshot.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t
dif_i2s_irq_acknowledge_state(const dif_i2s_t *i2s,
                              dif_i2s_irq_state_snapshot_t snapshot);

/**
 * Acknowledges all interrupts, indicating to the hardware that all
 * interrupts have been successfully serviced.
 *
 * @param i2s A i2s handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_i2s_irq_acknowledge_all(const dif_i2s_t *i2s);

/**
 * Acknowledges a particular interrupt, indicating to the hardware that it has
 * been successfully serviced.
 *
 * @param i2s A i2s handle.
 * @param irq An interrupt request.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_i2s_irq_acknowledge(const dif_i2s_t *i2s, dif_i2s_irq_t irq);

/**
 * Forces a particular interrupt, causing it to be serviced as if hardware had
 * asserted it.
 *
 * @param i2s A i2s 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_i2s_irq_force(const dif_i2s_t *i2s, dif_i2s_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_i2s_irq_disable_all()` and `dif_i2s_irq_restore_all()`
 * functions.
 */
typedef uint32_t dif_i2s_irq_enable_snapshot_t;

/**
 * Checks whether a particular interrupt is currently enabled or disabled.
 *
 * @param i2s A i2s 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_i2s_irq_get_enabled(const dif_i2s_t *i2s, dif_i2s_irq_t irq,
                                     dif_toggle_t *state);

/**
 * Sets whether a particular interrupt is currently enabled or disabled.
 *
 * @param i2s A i2s 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_i2s_irq_set_enabled(const dif_i2s_t *i2s, dif_i2s_irq_t irq,
                                     dif_toggle_t state);

/**
 * Disables all interrupts, optionally snapshotting all enable states for later
 * restoration.
 *
 * @param i2s A i2s 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_i2s_irq_disable_all(const dif_i2s_t *i2s,
                                     dif_i2s_irq_enable_snapshot_t *snapshot);

/**
 * Restores interrupts from the given (enable) snapshot.
 *
 * @param i2s A i2s handle.
 * @param snapshot A snapshot to restore from.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t
dif_i2s_irq_restore_all(const dif_i2s_t *i2s,
                        const dif_i2s_irq_enable_snapshot_t *snapshot);

#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus

#endif // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_I2S_AUTOGEN_H_