sw/device/lib/dif/autogen/dif_tlul_mailbox_autogen.c

// Copyright lowRISC contributors.
// 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/make_new_dif.py --mode=regen --only=autogen

#include <stdint.h>

#include "sw/device/lib/dif/autogen/dif_tlul_mailbox_autogen.h"
#include "sw/device/lib/dif/dif_base.h"

#include "tlul_mailbox_regs.h" // Generated.

OT_WARN_UNUSED_RESULT
dif_result_t dif_tlul_mailbox_init(mmio_region_t base_addr,
                                   dif_tlul_mailbox_t *tlul_mailbox) {
  if (tlul_mailbox == NULL) {
    return kDifBadArg;
  }

  tlul_mailbox->base_addr = base_addr;

  return kDifOk;
}

/**
 * Get the corresponding interrupt register bit offset of the IRQ.
 */
static bool tlul_mailbox_get_irq_bit_index(dif_tlul_mailbox_irq_t irq,
                                           bitfield_bit32_index_t *index_out) {

  switch (irq) {
  case kDifTlulMailboxIrqWtirq:
    *index_out = TLUL_MAILBOX_INTR_COMMON_WTIRQ_BIT;
    break;
  case kDifTlulMailboxIrqRtirq:
    *index_out = TLUL_MAILBOX_INTR_COMMON_RTIRQ_BIT;
    break;
  case kDifTlulMailboxIrqEirq:
    *index_out = TLUL_MAILBOX_INTR_COMMON_EIRQ_BIT;
    break;
  default:
    return false;
  }

  return true;
}

static dif_irq_type_t irq_types[] = {
    kDifIrqTypeEvent,
    kDifIrqTypeEvent,
    kDifIrqTypeEvent,
};

OT_WARN_UNUSED_RESULT
dif_result_t
dif_tlul_mailbox_irq_get_type(const dif_tlul_mailbox_t *tlul_mailbox,
                              dif_tlul_mailbox_irq_t irq,
                              dif_irq_type_t *type) {

  if (tlul_mailbox == NULL || type == NULL ||
      irq == kDifTlulMailboxIrqEirq + 1) {
    return kDifBadArg;
  }

  *type = irq_types[irq];

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t dif_tlul_mailbox_irq_get_state(
    const dif_tlul_mailbox_t *tlul_mailbox,
    dif_tlul_mailbox_irq_state_snapshot_t *snapshot) {

  if (tlul_mailbox == NULL || snapshot == NULL) {
    return kDifBadArg;
  }

  *snapshot = mmio_region_read32(tlul_mailbox->base_addr,
                                 TLUL_MAILBOX_INTR_STATE_REG_OFFSET);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t dif_tlul_mailbox_irq_acknowledge_state(
    const dif_tlul_mailbox_t *tlul_mailbox,
    dif_tlul_mailbox_irq_state_snapshot_t snapshot) {
  if (tlul_mailbox == NULL) {
    return kDifBadArg;
  }

  mmio_region_write32(tlul_mailbox->base_addr,
                      TLUL_MAILBOX_INTR_STATE_REG_OFFSET, snapshot);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t
dif_tlul_mailbox_irq_is_pending(const dif_tlul_mailbox_t *tlul_mailbox,
                                dif_tlul_mailbox_irq_t irq, bool *is_pending) {

  if (tlul_mailbox == NULL || is_pending == NULL) {
    return kDifBadArg;
  }

  bitfield_bit32_index_t index;
  if (!tlul_mailbox_get_irq_bit_index(irq, &index)) {
    return kDifBadArg;
  }

  uint32_t intr_state_reg = mmio_region_read32(
      tlul_mailbox->base_addr, TLUL_MAILBOX_INTR_STATE_REG_OFFSET);

  *is_pending = bitfield_bit32_read(intr_state_reg, index);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t
dif_tlul_mailbox_irq_acknowledge_all(const dif_tlul_mailbox_t *tlul_mailbox) {

  if (tlul_mailbox == NULL) {
    return kDifBadArg;
  }

  // Writing to the register clears the corresponding bits (Write-one clear).
  mmio_region_write32(tlul_mailbox->base_addr,
                      TLUL_MAILBOX_INTR_STATE_REG_OFFSET, UINT32_MAX);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t
dif_tlul_mailbox_irq_acknowledge(const dif_tlul_mailbox_t *tlul_mailbox,
                                 dif_tlul_mailbox_irq_t irq) {

  if (tlul_mailbox == NULL) {
    return kDifBadArg;
  }

  bitfield_bit32_index_t index;
  if (!tlul_mailbox_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(tlul_mailbox->base_addr,
                      TLUL_MAILBOX_INTR_STATE_REG_OFFSET, intr_state_reg);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t dif_tlul_mailbox_irq_force(const dif_tlul_mailbox_t *tlul_mailbox,
                                        dif_tlul_mailbox_irq_t irq,
                                        const bool val) {

  if (tlul_mailbox == NULL) {
    return kDifBadArg;
  }

  bitfield_bit32_index_t index;
  if (!tlul_mailbox_get_irq_bit_index(irq, &index)) {
    return kDifBadArg;
  }

  uint32_t intr_test_reg = bitfield_bit32_write(0, index, val);
  mmio_region_write32(tlul_mailbox->base_addr,
                      TLUL_MAILBOX_INTR_TEST_REG_OFFSET, intr_test_reg);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t
dif_tlul_mailbox_irq_get_enabled(const dif_tlul_mailbox_t *tlul_mailbox,
                                 dif_tlul_mailbox_irq_t irq,
                                 dif_toggle_t *state) {

  if (tlul_mailbox == NULL || state == NULL) {
    return kDifBadArg;
  }

  bitfield_bit32_index_t index;
  if (!tlul_mailbox_get_irq_bit_index(irq, &index)) {
    return kDifBadArg;
  }

  uint32_t intr_enable_reg = mmio_region_read32(
      tlul_mailbox->base_addr, TLUL_MAILBOX_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_tlul_mailbox_irq_set_enabled(const dif_tlul_mailbox_t *tlul_mailbox,
                                 dif_tlul_mailbox_irq_t irq,
                                 dif_toggle_t state) {

  if (tlul_mailbox == NULL) {
    return kDifBadArg;
  }

  bitfield_bit32_index_t index;
  if (!tlul_mailbox_get_irq_bit_index(irq, &index)) {
    return kDifBadArg;
  }

  uint32_t intr_enable_reg = mmio_region_read32(
      tlul_mailbox->base_addr, TLUL_MAILBOX_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(tlul_mailbox->base_addr,
                      TLUL_MAILBOX_INTR_ENABLE_REG_OFFSET, intr_enable_reg);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t dif_tlul_mailbox_irq_disable_all(
    const dif_tlul_mailbox_t *tlul_mailbox,
    dif_tlul_mailbox_irq_enable_snapshot_t *snapshot) {

  if (tlul_mailbox == NULL) {
    return kDifBadArg;
  }

  // Pass the current interrupt state to the caller, if requested.
  if (snapshot != NULL) {
    *snapshot = mmio_region_read32(tlul_mailbox->base_addr,
                                   TLUL_MAILBOX_INTR_ENABLE_REG_OFFSET);
  }

  // Disable all interrupts.
  mmio_region_write32(tlul_mailbox->base_addr,
                      TLUL_MAILBOX_INTR_ENABLE_REG_OFFSET, 0u);

  return kDifOk;
}

OT_WARN_UNUSED_RESULT
dif_result_t dif_tlul_mailbox_irq_restore_all(
    const dif_tlul_mailbox_t *tlul_mailbox,
    const dif_tlul_mailbox_irq_enable_snapshot_t *snapshot) {

  if (tlul_mailbox == NULL || snapshot == NULL) {
    return kDifBadArg;
  }

  mmio_region_write32(tlul_mailbox->base_addr,
                      TLUL_MAILBOX_INTR_ENABLE_REG_OFFSET, *snapshot);

  return kDifOk;
}