dt_kmac.c

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
//
// Device table API auto-generated by `dtgen`
 
/**
 * @file
 * @brief Device Tables (DT) for IP kmac and top earlgrey.
 */
 
#include "dt/dt_kmac.h"
 
 
 
/**
 * Description of instances.
 */
typedef struct dt_desc_kmac {
  dt_instance_id_t inst_id; /**< Instance ID */
  uint32_t base_addr[kDtKmacRegBlockCount]; /**< Base address of each register block */
  /**
   * PLIC ID of the first IRQ of this instance
   * 
   * This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
   */
  top_earlgrey_plic_irq_id_t first_irq;
  /**
   * Alert ID of the first Alert of this instance.
   * 
   * This value is undefined if the block is not connected to the Alert Handler.
   */
  top_earlgrey_alert_id_t first_alert;
  dt_clock_t clock[kDtKmacClockCount]; /**< Clock signal connected to each clock port */
  dt_reset_t reset[kDtKmacResetCount]; /**< Reset signal connected to each reset port */
} dt_desc_kmac_t;
 
 
 
 
static const dt_desc_kmac_t kmac_desc[kDtKmacCount] = {
  [kDtKmac] = {
    .inst_id = kDtInstanceIdKmac,
    .base_addr = {
      [kDtKmacRegBlockCore] = 0x41120000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdKmacKmacDone,
    .first_alert = kTopEarlgreyAlertIdKmacRecovOperationErr,
    .clock = {
      [kDtKmacClockClk] = kDtClockMain,
      [kDtKmacClockEdn] = kDtClockMain,
    },
    .reset = {
      [kDtKmacResetRst] = kDtResetLc,
      [kDtKmacResetEdn] = kDtResetLc,
    },
  },
};
 
/**
 * Return a pointer to the `dt_kmac_desc_t` structure of the requested
 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
 * the function) with the provided default value.
 */
#define TRY_GET_DT(dt, default)   ({     if ((dt) < (dt_kmac_t)0 || (dt) >= kDtKmacCount)       return (default);     &kmac_desc[dt];   })
 
dt_kmac_t dt_kmac_from_instance_id(dt_instance_id_t inst_id) {
  if (inst_id >= kDtInstanceIdKmac && inst_id <= kDtInstanceIdKmac) {
    return (dt_kmac_t)(inst_id - kDtInstanceIdKmac);
  }
  return (dt_kmac_t)0;
}
 
dt_instance_id_t dt_kmac_instance_id(
    dt_kmac_t dt) {
  return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
}
 
uint32_t dt_kmac_reg_block(
    dt_kmac_t dt,
    dt_kmac_reg_block_t reg_block) {
  // Return a recognizable address in case of wrong argument.
  return TRY_GET_DT(dt, 0xdeadbeef)->base_addr[reg_block];
}
 
dt_plic_irq_id_t dt_kmac_irq_to_plic_id(
    dt_kmac_t dt,
    dt_kmac_irq_t irq) {
  dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, kDtPlicIrqIdNone)->first_irq;
  if (first_irq == kDtPlicIrqIdNone) {
    return kDtPlicIrqIdNone;
  }
  return (dt_plic_irq_id_t)((uint32_t)first_irq + (uint32_t)irq);
}
 
dt_kmac_irq_t dt_kmac_irq_from_plic_id(
    dt_kmac_t dt,
    dt_plic_irq_id_t irq) {
  dt_kmac_irq_t count = kDtKmacIrqCount;
  dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, count)->first_irq;
  if (first_irq == kDtPlicIrqIdNone) {
    return count;
  }
  if (irq < first_irq || irq >= first_irq + (dt_plic_irq_id_t)count) {
    return count;
  }
  return (dt_kmac_irq_t)(irq - first_irq);
}
 
 
dt_alert_id_t dt_kmac_alert_to_alert_id(
    dt_kmac_t dt,
    dt_kmac_alert_t alert) {
  return (dt_alert_id_t)((uint32_t)kmac_desc[dt].first_alert + (uint32_t)alert);
}
 
dt_kmac_alert_t dt_kmac_alert_from_alert_id(
    dt_kmac_t dt,
    dt_alert_id_t alert) {
  dt_kmac_alert_t count = kDtKmacAlertCount;
  if (alert < kmac_desc[dt].first_alert || alert >= kmac_desc[dt].first_alert + (dt_alert_id_t)count) {
    return count;
  }
  return (dt_kmac_alert_t)(alert - kmac_desc[dt].first_alert);
}
 
 
 
dt_clock_t dt_kmac_clock(
    dt_kmac_t dt,
    dt_kmac_clock_t clk) {
  // Return the first clock in case of invalid argument.
  return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
}
 
dt_reset_t dt_kmac_reset(
    dt_kmac_t dt,
    dt_kmac_reset_t rst) {
  const dt_kmac_reset_t count = kDtKmacResetCount;
  if (rst >= count) {
    return kDtResetUnknown;
  }
  return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
}