dif_otp_ctrl_autogen.c

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
 
 
 
 
 
 
 
// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
// util/autogen_dif.py -i
// hw/top_earlgrey/ip_autogen/otp_ctrl/data/otp_ctrl.hjson -o
// bazel-out/k8-fastbuild/bin/sw/device/lib/dif/autogen
 
 
#include <stdint.h>
 
#include "sw/device/lib/dif/dif_base.h"
#include "sw/device/lib/dif/autogen/dif_otp_ctrl_autogen.h"
 
#include "hw/top/otp_ctrl_regs.h"  // Generated.
 
 
OT_WARN_UNUSED_RESULT
dif_result_t dif_otp_ctrl_init(
  mmio_region_t base_addr,
  dif_otp_ctrl_t *otp_ctrl) {
  if (otp_ctrl == NULL) {
    return kDifBadArg;
  }
 
  otp_ctrl->dt = kDtOtpCtrlCount;
  otp_ctrl->base_addr = base_addr;
 
  return kDifOk;
}
 
OT_WARN_UNUSED_RESULT
dif_result_t dif_otp_ctrl_init_from_dt(
  dt_otp_ctrl_t dt,
  dif_otp_ctrl_t *otp_ctrl) {
  if (otp_ctrl == NULL) {
    return kDifBadArg;
  }
 
  otp_ctrl->dt = dt;
  otp_ctrl->base_addr = mmio_region_from_addr(dt_otp_ctrl_primary_reg_block(dt));
 
  return kDifOk;
}
 
dif_result_t dif_otp_ctrl_get_dt(
  const dif_otp_ctrl_t *otp_ctrl,
  dt_otp_ctrl_t *dt) {
  if ((int)otp_ctrl->dt == kDtOtpCtrlCount || dt == NULL) {
    return kDifBadArg;
  }
  *dt = otp_ctrl->dt;
  return kDifOk;
}
 
  dif_result_t dif_otp_ctrl_alert_force(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_alert_t alert) {
  if (otp_ctrl == NULL) {
    return kDifBadArg;
  }
 
  bitfield_bit32_index_t alert_idx;
  switch (alert) {
    case kDifOtpCtrlAlertFatalMacroError:
      alert_idx = OTP_CTRL_ALERT_TEST_FATAL_MACRO_ERROR_BIT;
      break;
    case kDifOtpCtrlAlertFatalCheckError:
      alert_idx = OTP_CTRL_ALERT_TEST_FATAL_CHECK_ERROR_BIT;
      break;
    case kDifOtpCtrlAlertFatalBusIntegError:
      alert_idx = OTP_CTRL_ALERT_TEST_FATAL_BUS_INTEG_ERROR_BIT;
      break;
    case kDifOtpCtrlAlertFatalPrimOtpAlert:
      alert_idx = OTP_CTRL_ALERT_TEST_FATAL_PRIM_OTP_ALERT_BIT;
      break;
    case kDifOtpCtrlAlertRecovPrimOtpAlert:
      alert_idx = OTP_CTRL_ALERT_TEST_RECOV_PRIM_OTP_ALERT_BIT;
      break;
    default:
      return kDifBadArg;
  }
 
  uint32_t alert_test_reg = bitfield_bit32_write(0, alert_idx, true);
  mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_ALERT_TEST_REG_OFFSET,
    alert_test_reg);
 
 
  return kDifOk;
}
 
 
  /**
   * Get the corresponding interrupt register bit offset of the IRQ.
   */
  static bool otp_ctrl_get_irq_bit_index(
    dif_otp_ctrl_irq_t irq,
    bitfield_bit32_index_t *index_out) {
 
    switch (irq) {
      case kDtOtpCtrlIrqOtpOperationDone:
        *index_out = OTP_CTRL_INTR_COMMON_OTP_OPERATION_DONE_BIT;
        break;
      case kDtOtpCtrlIrqOtpError:
        *index_out = OTP_CTRL_INTR_COMMON_OTP_ERROR_BIT;
        break;
      default:
        return false;
    }
 
    return true;
  }
 
  static dif_irq_type_t irq_types[] = {
        kDifIrqTypeEvent,
        kDifIrqTypeEvent,
  };
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_get_type(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_t irq,
    dif_irq_type_t *type) {
 
    
    if (otp_ctrl == NULL ||
        type == NULL ||
        irq < kDifOtpCtrlIrqOtpOperationDone ||
        irq > kDifOtpCtrlIrqOtpError) {
      return kDifBadArg;
    }
 
    *type = irq_types[irq];
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_get_state(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_state_snapshot_t *snapshot) {
 
    if (otp_ctrl == NULL || snapshot == NULL) {
      return kDifBadArg;
    }
 
    *snapshot = mmio_region_read32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_STATE_REG_OFFSET);
 
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_acknowledge_state(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_state_snapshot_t snapshot) {
    if (otp_ctrl == NULL) {
      return kDifBadArg;
    }
 
    mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_STATE_REG_OFFSET,
    snapshot);
 
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_is_pending(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_t irq,
    bool *is_pending) {
 
    if (otp_ctrl == NULL || is_pending == NULL) {
      return kDifBadArg;
    }
 
    bitfield_bit32_index_t index;
    if (!otp_ctrl_get_irq_bit_index(irq, &index)) {
      return kDifBadArg;
    }
 
    uint32_t intr_state_reg = mmio_region_read32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_STATE_REG_OFFSET);
 
 
    *is_pending = bitfield_bit32_read(intr_state_reg, index);
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_acknowledge_all(
    const dif_otp_ctrl_t *otp_ctrl
    ) {
 
    if (otp_ctrl == NULL) {
      return kDifBadArg;
    }
 
    // Writing to the register clears the corresponding bits (Write-one clear).
    mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_STATE_REG_OFFSET,
    UINT32_MAX);
 
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_acknowledge(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_t irq) {
 
    if (otp_ctrl == NULL) {
      return kDifBadArg;
    }
 
    bitfield_bit32_index_t index;
    if (!otp_ctrl_get_irq_bit_index(irq, &index)) {
      return kDifBadArg;
    }
 
    // Writing to the register clears the corresponding bits (Write-one clear).
    uint32_t intr_state_reg = bitfield_bit32_write(0, index, true);
    mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_STATE_REG_OFFSET,
    intr_state_reg);
 
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_force(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_t irq,
    const bool val) {
 
    if (otp_ctrl == NULL) {
      return kDifBadArg;
    }
 
    bitfield_bit32_index_t index;
    if (!otp_ctrl_get_irq_bit_index(irq, &index)) {
      return kDifBadArg;
    }
 
    uint32_t intr_test_reg = bitfield_bit32_write(0, index, val);
    mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_TEST_REG_OFFSET,
    intr_test_reg);
 
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_get_enabled(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_t irq,
    dif_toggle_t *state) {
 
    if (otp_ctrl == NULL || state == NULL) {
      return kDifBadArg;
    }
 
    bitfield_bit32_index_t index;
    if (!otp_ctrl_get_irq_bit_index(irq, &index)) {
      return kDifBadArg;
    }
 
    uint32_t intr_enable_reg = mmio_region_read32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_ENABLE_REG_OFFSET);
 
 
    bool is_enabled = bitfield_bit32_read(intr_enable_reg, index);
    *state = is_enabled ?
      kDifToggleEnabled : kDifToggleDisabled;
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_set_enabled(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_t irq,
    dif_toggle_t state) {
 
    if (otp_ctrl == NULL) {
      return kDifBadArg;
    }
 
    bitfield_bit32_index_t index;
    if (!otp_ctrl_get_irq_bit_index(irq, &index)) {
      return kDifBadArg;
    }
 
    uint32_t intr_enable_reg = mmio_region_read32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_ENABLE_REG_OFFSET);
 
 
    bool enable_bit = (state == kDifToggleEnabled) ? true : false;
    intr_enable_reg = bitfield_bit32_write(intr_enable_reg, index, enable_bit);
    mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_ENABLE_REG_OFFSET,
    intr_enable_reg);
 
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_disable_all(
    const dif_otp_ctrl_t *otp_ctrl,
    dif_otp_ctrl_irq_enable_snapshot_t *snapshot) {
 
    if (otp_ctrl == NULL) {
      return kDifBadArg;
    }
 
    // Pass the current interrupt state to the caller, if requested.
    if (snapshot != NULL) {
      *snapshot = mmio_region_read32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_ENABLE_REG_OFFSET);
 
    }
 
    // Disable all interrupts.
    mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_ENABLE_REG_OFFSET,
    0u);
 
 
    return kDifOk;
  }
 
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_otp_ctrl_irq_restore_all(
    const dif_otp_ctrl_t *otp_ctrl,
    const dif_otp_ctrl_irq_enable_snapshot_t *snapshot) {
 
    if (otp_ctrl == NULL || snapshot == NULL) {
      return kDifBadArg;
    }
 
    mmio_region_write32(
    otp_ctrl->base_addr,
    (ptrdiff_t)OTP_CTRL_INTR_ENABLE_REG_OFFSET,
    *snapshot);
 
 
    return kDifOk;
  }