flash_macro_wrapper.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 flash_macro_wrapper and top egret.
 */
 
#include "hw/top/dt/flash_macro_wrapper.h"
 
 
 
/**
 * Description of instances.
 */
typedef struct dt_desc_flash_macro_wrapper {
  dt_instance_id_t inst_id; /**< Instance ID */
  uint32_t reg_addr[kDtFlashMacroWrapperRegBlockCount]; /**< Base address of each register block */
  dt_clock_t clock[kDtFlashMacroWrapperClockCount]; /**< Clock signal connected to each clock port */
  dt_reset_t reset[kDtFlashMacroWrapperResetCount]; /**< Reset signal connected to each reset port */
  dt_periph_io_t periph_io[kDtFlashMacroWrapperPeriphIoCount]; /**< Description of each peripheral I/O */
} dt_desc_flash_macro_wrapper_t;
 
 
 
 
static const dt_desc_flash_macro_wrapper_t flash_macro_wrapper_desc[kDtFlashMacroWrapperCount] = {
  [kDtFlashMacroWrapper] = {
    .inst_id = kDtInstanceIdFlashMacroWrapper,
    .reg_addr = {
      [kDtFlashMacroWrapperRegBlockCore] = 0x41008000,
    },
    .clock = {
      [kDtFlashMacroWrapperClockClk] = kDtClockMain,
    },
    .reset = {
      [kDtFlashMacroWrapperResetRst] = kDtResetLc,
    },
    .periph_io = {
      [kDtFlashMacroWrapperPeriphIoTck] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopEgretPinmuxPeripheralInFlashMacroWrapperTck,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtFlashMacroWrapperPeriphIoTms] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopEgretPinmuxPeripheralInFlashMacroWrapperTms,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtFlashMacroWrapperPeriphIoTdi] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopEgretPinmuxPeripheralInFlashMacroWrapperTdi,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtFlashMacroWrapperPeriphIoTdo] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopEgretPinmuxOutselFlashMacroWrapperTdo,
        },
      },
    },
  },
};
 
/**
 * Return a pointer to the `dt_flash_macro_wrapper_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_flash_macro_wrapper_t)0 || (int)(dt) >= kDtFlashMacroWrapperCount)       return (default);     &flash_macro_wrapper_desc[dt];   })
 
dt_flash_macro_wrapper_t dt_flash_macro_wrapper_from_instance_id(dt_instance_id_t inst_id) {
  if (inst_id >= kDtInstanceIdFlashMacroWrapper && inst_id <= kDtInstanceIdFlashMacroWrapper) {
    return (dt_flash_macro_wrapper_t)(inst_id - kDtInstanceIdFlashMacroWrapper);
  }
  return (dt_flash_macro_wrapper_t)0;
}
 
dt_instance_id_t dt_flash_macro_wrapper_instance_id(
    dt_flash_macro_wrapper_t dt) {
  return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
}
 
uint32_t dt_flash_macro_wrapper_reg_block(
    dt_flash_macro_wrapper_t dt,
    dt_flash_macro_wrapper_reg_block_t reg_block) {
  // Return a recognizable address in case of wrong argument.
  return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
}
 
 
 
dt_periph_io_t dt_flash_macro_wrapper_periph_io(
    dt_flash_macro_wrapper_t dt,
    dt_flash_macro_wrapper_periph_io_t sig) {
  // Return a harmless value in case of wrong argument.
  return TRY_GET_DT(dt, kDtPeriphIoConstantHighZ)->periph_io[sig];
}
 
dt_clock_t dt_flash_macro_wrapper_clock(
    dt_flash_macro_wrapper_t dt,
    dt_flash_macro_wrapper_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_flash_macro_wrapper_reset(
    dt_flash_macro_wrapper_t dt,
    dt_flash_macro_wrapper_reset_t rst) {
  const dt_flash_macro_wrapper_reset_t count = kDtFlashMacroWrapperResetCount;
  if (rst >= count) {
    return kDtResetUnknown;
  }
  return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
}