dt_soc_proxy.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 soc_proxy and top darjeeling.
 */
 
#include "hw/top/dt/dt_soc_proxy.h"
 
 
 
/**
 * Description of instances.
 */
typedef struct dt_desc_soc_proxy {
  dt_instance_id_t inst_id; /**< Instance ID */
  uint32_t reg_addr[kDtSocProxyRegBlockCount]; /**< Base address of each register block */
  uint32_t mem_addr[kDtSocProxyMemoryCount]; /**< Base address of each memory */
  uint32_t mem_size[kDtSocProxyMemoryCount]; /**< 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[kDtSocProxyClockCount]; /**< Clock signal connected to each clock port */
  dt_reset_t reset[kDtSocProxyResetCount]; /**< Reset signal connected to each reset port */
  dt_periph_io_t periph_io[kDtSocProxyPeriphIoCount]; /**< Description of each peripheral I/O */
} dt_desc_soc_proxy_t;
 
 
 
 
static const dt_desc_soc_proxy_t soc_proxy_desc[kDtSocProxyCount] = {
  [kDtSocProxy] = {
    .inst_id = kDtInstanceIdSocProxy,
    .reg_addr = {
      [kDtSocProxyRegBlockCore] = 0x22030000,
    },
    .mem_addr = {
      [kDtSocProxyMemoryCtn] = 0x40000000,
    },
    .mem_size = {
      [kDtSocProxyMemoryCtn] = 0x80000000,
    },
    .first_irq = kTopDarjeelingPlicIrqIdSocProxyExternal0,
    .first_alert = kTopDarjeelingAlertIdSocProxyFatalAlertIntg,
    .clock = {
      [kDtSocProxyClockClk] = kDtClockMain,
      [kDtSocProxyClockAon] = kDtClockAon,
    },
    .reset = {
      [kDtSocProxyResetRst] = kDtResetLc,
      [kDtSocProxyResetPor] = kDtResetPorIoDiv4,
    },
    .periph_io = {
      [kDtSocProxyPeriphIoSocGpi0] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi0,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi0,
        },
      },
      [kDtSocProxyPeriphIoSocGpi1] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi1,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi1,
        },
      },
      [kDtSocProxyPeriphIoSocGpi2] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi2,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi2,
        },
      },
      [kDtSocProxyPeriphIoSocGpi3] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi3,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi3,
        },
      },
      [kDtSocProxyPeriphIoSocGpi4] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi4,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi4,
        },
      },
      [kDtSocProxyPeriphIoSocGpi5] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi5,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi5,
        },
      },
      [kDtSocProxyPeriphIoSocGpi6] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi6,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi6,
        },
      },
      [kDtSocProxyPeriphIoSocGpi7] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi7,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi7,
        },
      },
      [kDtSocProxyPeriphIoSocGpi8] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi8,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi8,
        },
      },
      [kDtSocProxyPeriphIoSocGpi9] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi9,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi9,
        },
      },
      [kDtSocProxyPeriphIoSocGpi10] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi10,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi10,
        },
      },
      [kDtSocProxyPeriphIoSocGpi11] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpi11,
          .outsel_or_dt_pad = kDtPadSocProxySocGpi11,
        },
      },
      [kDtSocProxyPeriphIoSocGpi12] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingPinmuxPeripheralInSocProxySocGpi12,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtSocProxyPeriphIoSocGpi13] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingPinmuxPeripheralInSocProxySocGpi13,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtSocProxyPeriphIoSocGpi14] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingPinmuxPeripheralInSocProxySocGpi14,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtSocProxyPeriphIoSocGpi15] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopDarjeelingPinmuxPeripheralInSocProxySocGpi15,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtSocProxyPeriphIoSocGpo0] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo0,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo0,
        },
      },
      [kDtSocProxyPeriphIoSocGpo1] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo1,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo1,
        },
      },
      [kDtSocProxyPeriphIoSocGpo2] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo2,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo2,
        },
      },
      [kDtSocProxyPeriphIoSocGpo3] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo3,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo3,
        },
      },
      [kDtSocProxyPeriphIoSocGpo4] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo4,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo4,
        },
      },
      [kDtSocProxyPeriphIoSocGpo5] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo5,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo5,
        },
      },
      [kDtSocProxyPeriphIoSocGpo6] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo6,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo6,
        },
      },
      [kDtSocProxyPeriphIoSocGpo7] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo7,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo7,
        },
      },
      [kDtSocProxyPeriphIoSocGpo8] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo8,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo8,
        },
      },
      [kDtSocProxyPeriphIoSocGpo9] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo9,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo9,
        },
      },
      [kDtSocProxyPeriphIoSocGpo10] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo10,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo10,
        },
      },
      [kDtSocProxyPeriphIoSocGpo11] = {
        .__internal = {
          .type = kDtPeriphIoTypeDio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = kTopDarjeelingDirectPadsSocProxySocGpo11,
          .outsel_or_dt_pad = kDtPadSocProxySocGpo11,
        },
      },
      [kDtSocProxyPeriphIoSocGpo12] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopDarjeelingPinmuxOutselSocProxySocGpo12,
        },
      },
      [kDtSocProxyPeriphIoSocGpo13] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopDarjeelingPinmuxOutselSocProxySocGpo13,
        },
      },
      [kDtSocProxyPeriphIoSocGpo14] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopDarjeelingPinmuxOutselSocProxySocGpo14,
        },
      },
      [kDtSocProxyPeriphIoSocGpo15] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopDarjeelingPinmuxOutselSocProxySocGpo15,
        },
      },
    },
  },
};
 
/**
 * Return a pointer to the `dt_soc_proxy_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_soc_proxy_t)0 || (dt) >= kDtSocProxyCount)       return (default);     &soc_proxy_desc[dt];   })
 
dt_soc_proxy_t dt_soc_proxy_from_instance_id(dt_instance_id_t inst_id) {
  if (inst_id >= kDtInstanceIdSocProxy && inst_id <= kDtInstanceIdSocProxy) {
    return (dt_soc_proxy_t)(inst_id - kDtInstanceIdSocProxy);
  }
  return (dt_soc_proxy_t)0;
}
 
dt_instance_id_t dt_soc_proxy_instance_id(
    dt_soc_proxy_t dt) {
  return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
}
 
uint32_t dt_soc_proxy_reg_block(
    dt_soc_proxy_t dt,
    dt_soc_proxy_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_soc_proxy_memory_base(
    dt_soc_proxy_t dt,
    dt_soc_proxy_memory_t mem) {
  // Return a recognizable address in case of wrong argument.
  return TRY_GET_DT(dt, 0xdeadbeef)->mem_addr[mem];
}
 
uint32_t dt_soc_proxy_memory_size(
    dt_soc_proxy_t dt,
    dt_soc_proxy_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_soc_proxy_irq_to_plic_id(
    dt_soc_proxy_t dt,
    dt_soc_proxy_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_soc_proxy_irq_t dt_soc_proxy_irq_from_plic_id(
    dt_soc_proxy_t dt,
    dt_plic_irq_id_t irq) {
  dt_soc_proxy_irq_t count = kDtSocProxyIrqCount;
  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_soc_proxy_irq_t)(irq - first_irq);
}
 
 
dt_alert_id_t dt_soc_proxy_alert_to_alert_id(
    dt_soc_proxy_t dt,
    dt_soc_proxy_alert_t alert) {
  return (dt_alert_id_t)((uint32_t)soc_proxy_desc[dt].first_alert + (uint32_t)alert);
}
 
dt_soc_proxy_alert_t dt_soc_proxy_alert_from_alert_id(
    dt_soc_proxy_t dt,
    dt_alert_id_t alert) {
  dt_soc_proxy_alert_t count = kDtSocProxyAlertCount;
  if (alert < soc_proxy_desc[dt].first_alert || alert >= soc_proxy_desc[dt].first_alert + (dt_alert_id_t)count) {
    return count;
  }
  return (dt_soc_proxy_alert_t)(alert - soc_proxy_desc[dt].first_alert);
}
 
 
dt_periph_io_t dt_soc_proxy_periph_io(
    dt_soc_proxy_t dt,
    dt_soc_proxy_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_soc_proxy_clock(
    dt_soc_proxy_t dt,
    dt_soc_proxy_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_soc_proxy_reset(
    dt_soc_proxy_t dt,
    dt_soc_proxy_reset_t rst) {
  const dt_soc_proxy_reset_t count = kDtSocProxyResetCount;
  if (rst >= count) {
    return kDtResetUnknown;
  }
  return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
}