dt_mbx.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 mbx and top darjeeling.
 */
 
#include "hw/top/dt/dt_mbx.h"
 
 
 
/**
 * Description of instances.
 */
typedef struct dt_desc_mbx {
  dt_instance_id_t inst_id; /**< Instance ID */
  uint32_t reg_addr[kDtMbxRegBlockCount]; /**< Base address of each register block */
  uint32_t mem_addr[kDtMbxMemoryCount]; /**< Base address of each memory */
  uint32_t mem_size[kDtMbxMemoryCount]; /**< Size in bytes of each memory */
  /**
   * PLIC ID of the first IRQ of this instance
   * 
   * This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
   */
  top_darjeeling_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_darjeeling_alert_id_t first_alert;
  dt_clock_t clock[kDtMbxClockCount]; /**< Clock signal connected to each clock port */
  dt_reset_t reset[kDtMbxResetCount]; /**< Reset signal connected to each reset port */
} dt_desc_mbx_t;
 
 
 
 
static const dt_desc_mbx_t mbx_desc[kDtMbxCount] = {
  [kDtMbx0] = {
    .inst_id = kDtInstanceIdMbx0,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000000,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbx0MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbx0FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbx1] = {
    .inst_id = kDtInstanceIdMbx1,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000100,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbx1MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbx1FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbx2] = {
    .inst_id = kDtInstanceIdMbx2,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000200,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbx2MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbx2FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbx3] = {
    .inst_id = kDtInstanceIdMbx3,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000300,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbx3MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbx3FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbx4] = {
    .inst_id = kDtInstanceIdMbx4,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000400,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbx4MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbx4FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbx5] = {
    .inst_id = kDtInstanceIdMbx5,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000500,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbx5MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbx5FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbx6] = {
    .inst_id = kDtInstanceIdMbx6,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000600,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbx6MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbx6FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbxJtag] = {
    .inst_id = kDtInstanceIdMbxJtag,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22000800,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbxJtagMbxReady,
    .first_alert = kTopDarjeelingAlertIdMbxJtagFatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbxPcie0] = {
    .inst_id = kDtInstanceIdMbxPcie0,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22040000,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbxPcie0MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbxPcie0FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
  [kDtMbxPcie1] = {
    .inst_id = kDtInstanceIdMbxPcie1,
    .reg_addr = {
      [kDtMbxRegBlockCore] = 0x22040100,
      [kDtMbxRegBlockSoc] = 0xffffffff,
    },
    .mem_addr = {
    },
    .mem_size = {
    },
    .first_irq = kTopDarjeelingPlicIrqIdMbxPcie1MbxReady,
    .first_alert = kTopDarjeelingAlertIdMbxPcie1FatalFault,
    .clock = {
      [kDtMbxClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtMbxResetRst] = kDtResetLc,
    },
  },
};
 
/**
 * Return a pointer to the `dt_mbx_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_mbx_t)0 || (dt) >= kDtMbxCount)       return (default);     &mbx_desc[dt];   })
 
dt_mbx_t dt_mbx_from_instance_id(dt_instance_id_t inst_id) {
  if (inst_id >= kDtInstanceIdMbx0 && inst_id <= kDtInstanceIdMbxPcie1) {
    return (dt_mbx_t)(inst_id - kDtInstanceIdMbx0);
  }
  return (dt_mbx_t)0;
}
 
dt_instance_id_t dt_mbx_instance_id(
    dt_mbx_t dt) {
  return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
}
 
uint32_t dt_mbx_reg_block(
    dt_mbx_t dt,
    dt_mbx_reg_block_t reg_block) {
  // Return a recognizable address in case of wrong argument.
  return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
}
 
uint32_t dt_mbx_memory_base(
    dt_mbx_t dt,
    dt_mbx_memory_t mem) {
  // Return a recognizable address in case of wrong argument.
  return TRY_GET_DT(dt, 0xdeadbeef)->mem_addr[mem];
}
 
uint32_t dt_mbx_memory_size(
    dt_mbx_t dt,
    dt_mbx_memory_t mem)  {
  // Return an empty size in case of wrong argument.
  return TRY_GET_DT(dt, 0)->mem_size[mem];
}
 
dt_plic_irq_id_t dt_mbx_irq_to_plic_id(
    dt_mbx_t dt,
    dt_mbx_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_mbx_irq_t dt_mbx_irq_from_plic_id(
    dt_mbx_t dt,
    dt_plic_irq_id_t irq) {
  dt_mbx_irq_t count = kDtMbxIrqCount;
  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_mbx_irq_t)(irq - first_irq);
}
 
 
dt_alert_id_t dt_mbx_alert_to_alert_id(
    dt_mbx_t dt,
    dt_mbx_alert_t alert) {
  return (dt_alert_id_t)((uint32_t)mbx_desc[dt].first_alert + (uint32_t)alert);
}
 
dt_mbx_alert_t dt_mbx_alert_from_alert_id(
    dt_mbx_t dt,
    dt_alert_id_t alert) {
  dt_mbx_alert_t count = kDtMbxAlertCount;
  if (alert < mbx_desc[dt].first_alert || alert >= mbx_desc[dt].first_alert + (dt_alert_id_t)count) {
    return count;
  }
  return (dt_mbx_alert_t)(alert - mbx_desc[dt].first_alert);
}
 
 
 
dt_clock_t dt_mbx_clock(
    dt_mbx_t dt,
    dt_mbx_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_mbx_reset(
    dt_mbx_t dt,
    dt_mbx_reset_t rst) {
  const dt_mbx_reset_t count = kDtMbxResetCount;
  if (rst >= count) {
    return kDtResetUnknown;
  }
  return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
}