# -- ================================================================================ --
# -- NEORV32 - Vivado IP Packaging & Customization GUI Setup                          --
# -- -------------------------------------------------------------------------------- --
# -- This scripts packages the entire processor as Vivado IP module including a fancy --
# -- customization GUI. See the NEORV32 Datasheet & User Guide for more information.  --
# -- -------------------------------------------------------------------------------- --
# -- The NEORV32 RISC-V Processor - https://github.com/stnolting/neorv32              --
# -- Copyright (c) NEORV32 contributors.                                              --
# -- Copyright (c) 2020 - 2026 Stephan Nolting. All rights reserved.                  --
# -- Licensed under the BSD-3-Clause license, see LICENSE for details.                --
# -- SPDX-License-Identifier: BSD-3-Clause                                            --
# -- ================================================================================ --


# **************************************************************
# Global configuration
# **************************************************************
set script_path [file normalize [info script]]
set script_dir [file dirname $script_path]
set neorv32_home $script_dir/../..
set ip_logo $neorv32_home/docs/figures/neorv32_logo_riscv_small.png
set outputdir $script_dir/neorv32_vivado_ip_work
set ip_top neorv32_vivado_ip


# **************************************************************
# Create empty (!) output/working directory
# **************************************************************
file mkdir $outputdir
set files [glob -nocomplain "$outputdir/*"]
if {[llength $files] != 0} {
  puts "DELETING ALL FILES in $outputdir"
  file delete -force {*}[glob -directory $outputdir *];
}


# **************************************************************
# Create Vivado project
# **************************************************************
create_project "neorv32-ip" $outputdir
set_property INCREMENTAL false [get_filesets sim_1]


# **************************************************************
# Import HDL source files
# **************************************************************

# read and process NEORV32 SoC file list
set file_list_file [read [open "$neorv32_home/rtl/file_list_core.f" r]]
set file_list [string map [list {$NEORV32_HOME} $neorv32_home] $file_list_file]
puts "NEORV32 source files:"
puts $file_list
add_files $file_list
set_property library neorv32 [get_files $file_list]

# IP top module and AXI4 bridge
add_file $neorv32_home/rtl/system_integration/xbus2axi4_bridge.vhd
add_file $neorv32_home/rtl/system_integration/$ip_top.vhd
set_property top $ip_top [current_fileset]

update_compile_order -fileset sources_1


# **************************************************************
# Package as IP block
# **************************************************************
ipx::package_project -root_dir $outputdir/packaged_ip -vendor NEORV32 -library user -taxonomy /UserIP -import_files -set_current true -force
set_property display_name "NEORV32" [ipx::current_core]
set_property vendor_display_name "neorv32" [ipx::current_core]
set_property company_url https://github.com/stnolting/neorv32 [ipx::current_core]
set_property description "The NEORV32 RISC-V Processor" [ipx::current_core]


# **************************************************************
# Setup configuration GUI
# **************************************************************
proc setup_ip_gui {} {
  proc set_param_properties {name {display_name ""} {tooltip ""} {enablement_expr ""} {value_expr ""}} {
    set param_spec [ipgui::get_guiparamspec -name $name -component [ipx::current_core]]
    set user_param [ipx::get_user_parameters $name -of_objects [ipx::current_core]]
    if {$display_name ne ""} {
      set_property display_name $display_name $param_spec
    }
    if {$tooltip ne ""} {
      set_property tooltip $tooltip $param_spec
    }
    if {$enablement_expr ne ""} {
      set_property enablement_tcl_expr $enablement_expr $user_param
    }
    if {$value_expr ne ""} {
      set_property value_tcl_expr $value_expr $user_param
    }
  }

  proc add_page { name {tooltip ""} } {
    set page [ipgui::add_page -name $name -component [ipx::current_core] -display_name $name]
    if {$tooltip eq ""} {
      set_property tooltip $tooltip $page
    }
    return $page
  }

  proc add_group { parent name {display_name ""} } {
    if {$display_name eq ""} {
      set display_name $name
    }
    ipgui::add_group -name $name -component [ipx::current_core] -parent $parent -display_name $display_name
  }

  proc add_params { parent params } {
    foreach param $params {
      set name [lindex $param 0]
      ipgui::add_param -name $name -component [ipx::current_core] -parent $parent
      set_param_properties {*}$param
    }
  }


  # **************************************************************
  # Interfaces: Configuration Dependencies
  # **************************************************************
  set_property enablement_dependency {$OCD_EN}         [ipx::get_ports jtag_*           -of_objects [ipx::current_core]]
  set_property enablement_dependency {$OCD_EN}         [ipx::get_ports ocd_resetn       -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_WDT_EN}      [ipx::get_ports wdt_resetn       -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_SLINK_EN}    [ipx::get_bus_interfaces s0_axis -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_SLINK_EN}    [ipx::get_bus_interfaces s1_axis -of_objects [ipx::current_core]]
  set_property enablement_dependency {$XBUS_EN}        [ipx::get_bus_interfaces m_axi   -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_GPIO_EN}     [ipx::get_ports gpio_i           -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_GPIO_EN}     [ipx::get_ports gpio_o           -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_GPIO_DIR_EN} [ipx::get_ports gpio_dir_o       -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_UART0_EN}    [ipx::get_ports uart0_*          -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_UART1_EN}    [ipx::get_ports uart1_*          -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_SPI_EN}      [ipx::get_ports spi_*            -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_SDI_EN}      [ipx::get_ports sdi_*            -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_TWI_EN}      [ipx::get_ports twi_*            -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_TWD_EN}      [ipx::get_ports twd_*            -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_ONEWIRE_EN}  [ipx::get_ports onewire_*        -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_PWM_EN}      [ipx::get_ports pwm_o            -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_CFS_EN}      [ipx::get_ports cfs_*            -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_NEOLED_EN}   [ipx::get_ports neoled_o         -of_objects [ipx::current_core]]
  set_property enablement_dependency {$IO_CLINT_EN}    [ipx::get_ports mtime_time_o     -of_objects [ipx::current_core]]
  set_property enablement_dependency {!$IO_CLINT_EN}   [ipx::get_ports irq_mti_i        -of_objects [ipx::current_core]]
  set_property enablement_dependency {!$IO_CLINT_EN}   [ipx::get_ports irq_msi_i        -of_objects [ipx::current_core]]
  set_property enablement_dependency {$SMC_EN}         [ipx::get_ports smc_*            -of_objects [ipx::current_core]]


  # **************************************************************
  # Configuration pages
  # **************************************************************
  # Remove default page
  set page [ipgui::get_pagespec -name "Page 0" -component [ipx::current_core]]
  if {$page ne ""} {
    ipgui::remove_page -component [ipx::current_core] $page
  }


  # **************************************************************
  # GUI Page: General
  # **************************************************************
  set page [add_page {General}]
  set about_text "NEORV32 is a small, customizable and extensible MCU-class 32-bit RISC-V soft-core CPU and microcontroller-like SoC."
  ipgui::add_static_text -name {About} -component [ipx::current_core] -parent [ipgui::get_pagespec -name "General" -component [ipx::current_core] ] -text $about_text
  set documentation_text "Find more information online at github.com/stnolting/neorv32"
  ipgui::add_static_text -name {Documentation} -component [ipx::current_core] -parent [ipgui::get_pagespec -name "General" -component [ipx::current_core] ] -text $documentation_text


  # { param_name {display_name} {tooltip} {enablement_expr} {value_expr} }

  set group [add_group $page {Clock Input}]
  add_params $group {
    { CLOCK_FREQUENCY {Clock frequency [Hz]} {Frequency of the clk input signal in Hz} }
  }

  set group [add_group $page {Core Complex}]
  add_params $group {
    { DUAL_CORE_EN {CPU core(s)} {} }
  }
  set_property widget {comboBox} [ipgui::get_guiparamspec -name "DUAL_CORE_EN" -component [ipx::current_core] ]
  set_property value_validation_type pairs [ipx::get_user_parameters DUAL_CORE_EN -of_objects [ipx::current_core]]
  set_property value_validation_pairs {{Single-core} false {Dual-core (SMP)} true} [ipx::get_user_parameters DUAL_CORE_EN -of_objects [ipx::current_core]]

  set group [add_group $page {Boot Configuration}]
  add_params $group {
    { BOOT_MODE_SELECT {Boot mode select}    {Processor boot configuration} }
    { BOOT_ADDR_CUSTOM {Custom boot address} {Available if boot mode = Custom address; has to be 4-byte aligned} {$BOOT_MODE_SELECT == 1} }
  }
  set_property widget {comboBox} [ipgui::get_guiparamspec -name "BOOT_MODE_SELECT" -component [ipx::current_core] ]
  set_property value_validation_type pairs [ipx::get_user_parameters BOOT_MODE_SELECT -of_objects [ipx::current_core]]
  set_property value_validation_pairs {{NEORV32 bootloader} 0 {Custom address} 1 {Internal IMEM image} 2} [ipx::get_user_parameters BOOT_MODE_SELECT -of_objects [ipx::current_core]]

  set group [add_group $page {On-Chip Debugger (OCD)}]
  add_params $group {
    { OCD_EN              {Enable OCD}         {Implement JTAG-based on-chip debugger} }
    { OCD_AUTHENTICATION  {OCD authentication} {Implement debug authentication module} {$OCD_EN} {$OCD_EN ? $OCD_AUTHENTICATION : false} }
    { OCD_NUM_HW_TRIGGERS {Hardware triggers}  {Number of hardware break-/watchpoints} {$OCD_EN} {$OCD_EN ? $OCD_NUM_HW_TRIGGERS : 0} }
    { OCD_JEDEC_ID        {JEDEC ID}           {JTAG tap identification}               {$OCD_EN}}
  }

  set group [add_group $page {Execution Trace Buffer (TRACER)}]
  add_params $group {
    { IO_TRACER_EN        {Enable tracer}      {Implement execution tracer module} }
    { IO_TRACER_BUFFER    {Trace buffer depth} {Maximum number of logged execution deltas}    {$IO_TRACER_EN} {$IO_TRACER_EN ? $IO_TRACER_BUFFER : 1} }
    { IO_TRACER_SIMLOG_EN {Simulation logging} {Generate full trace log; only for simulation} {$IO_TRACER_EN} }
  }


  # **************************************************************
  # GUI Page: AXI Connectivity
  # **************************************************************
  set page [add_page {AXI}]

  set group [add_group $page {External Bus Interface (XBUS / AXI4-MM Host)}]
  add_params $group {
    { XBUS_EN          {Enable XBUS} }
    { XBUS_REGSTAGE_EN {Add register stages}   {In/out register stages; relaxes timing, but will increase latency} {$XBUS_EN} }
    { CACHE_BURSTS_EN  {Enable AXI bursts}     {For I-/D-cache accesses only}                                      {$XBUS_EN} }
    { XBUS_TIMEOUT     {Access timeout window} {Should be a power of two; timeout disabled when zero}              {$XBUS_EN} }
  }

  set group [add_group $page {Stream Link Interface (SLINK / AXI4-Stream Source & Sink)}]
  add_params $group {
    { IO_SLINK_EN      {Enable SLINK} }
    { IO_SLINK_RX_FIFO {RX FIFO depth} {Number of entries (use a power of two)} {$IO_SLINK_EN} }
    { IO_SLINK_TX_FIFO {TX FIFO depth} {Number of entries (use a power of two)} {$IO_SLINK_EN} }
  }


  # **************************************************************
  # GUI Page: CPU ISA
  # **************************************************************
  set page [add_page {ISA}]

  set group [add_group $page {Embedded-Class ISA}]
  add_params $group {
    { RISCV_ISA_E {E - Reduced register file size (16 registers only)} {} }
  }

  set group [add_group $page {Additional Privilege Mode}]
  add_params $group {
    { RISCV_ISA_U {U - Less-privileged user-mode} {} }
  }

  set group [add_group $page {Hardware Multiplication and Division}]
  add_params $group {
    { RISCV_ISA_M     {M - Integer multiplication and division hardware} {} }
    { RISCV_ISA_Zmmul {Zmmul - Integer multiplication-only hardware}     {} {!$RISCV_ISA_M} {$RISCV_ISA_M ? false : $RISCV_ISA_Zmmul} }
  }

  set group [add_group $page {Compressed Instructions}]
  add_params $group {
    { RISCV_ISA_C   {C - 16-bit compressed base instructions}           {} }
    { RISCV_ISA_Zcb {Zcb - Additional code size reduction instructions} {} {$RISCV_ISA_C} {$RISCV_ISA_C ? $RISCV_ISA_Zcb : false} }
  }

  set group [add_group $page {Counters and Timers}]
  add_params $group {
    { RISCV_ISA_Zicntr    {Zicntr - Base counters (cycles and instructions)} {} }
    { RISCV_ISA_Smcntrpmf {Smcntrpmf - Counter privilege-mode filtering}     {} }
    { RISCV_ISA_Zihpm     {Zihpm - Hardware performance monitors (HPMs)}     {} }
    { HPM_CNT_WIDTH       {HPM width}                                        {Counter width in bits}  {$RISCV_ISA_Zihpm} }
    { HPM_NUM_CNTS        {HPM counters}                                     {Number of HPM counters} {$RISCV_ISA_Zihpm} }
  }

  set group [add_group $page {Bit-Manipulation (B)}]
  add_params $group {
    { RISCV_ISA_Zba {Zba - Shifted-add bit-manipulation instructions} {} }
    { RISCV_ISA_Zbb {Zbb - Basic bit-manipulation instructions}       {} }
    { RISCV_ISA_Zbc {Zbc - Carry-less multiplication instructions}    {} }
    { RISCV_ISA_Zbs {Zbs - Single-bit bit-manipulation instructions}  {} }
  }

  set group [add_group $page {Atomic Memory Access}]
  add_params $group {
    { RISCV_ISA_Zaamo  {Zaamo - Atomic read-modify-write memory operations} {} }
    { RISCV_ISA_Zalrsc {Zalrsc - Atomic reservation-set operations}         {} }
  }

  set group [add_group $page {Cryptography}]
  add_params $group {
    { RISCV_ISA_Zbkb  {Zbkb - Bit manipulation instructions for cryptography}    {} }
    { RISCV_ISA_Zbkc  {Zbkc - Carry-less multiply instructions for cryptography} {} }
    { RISCV_ISA_Zbkx  {Zbkx - Crossbar permutations for cryptography}            {} }
    { RISCV_ISA_Zknd  {Zknd - Scalar cryptographic - NIST AES decryption}        {} }
    { RISCV_ISA_Zkne  {Zkne - Scalar cryptographic - NIST AES encryption}        {} }
    { RISCV_ISA_Zknh  {Zknh - Scalar cryptographic - NIST hash functions}        {} }
    { RISCV_ISA_Zksed {Zksed - Scalar cryptographic - ShangMi block cyphers}     {} }
    { RISCV_ISA_Zksh  {Zksh - Scalar cryptographic - ShangMi hash functions}     {} }
  }

  set group [add_group $page {Miscelanous}]
  add_params $group {
    { RISCV_ISA_Zfinx  {Zfinx - Embedded FPU (using integer register file)} {} }
    { RISCV_ISA_Zibi   {Zibi - Branch with immediate-comparison}            {} }
    { RISCV_ISA_Zicond {Zicond - Conditional-move instructions}             {} }
    { RISCV_ISA_Zimop  {Zimop - May-be-operation}                           {} }
    { RISCV_ISA_Zcmop  {Zcmop - Compressed may-be-operation}                {} {$RISCV_ISA_C && $RISCV_ISA_Zimop} {$RISCV_ISA_C && $RISCV_ISA_Zimop ? $RISCV_ISA_Zcmop : false}}
    { RISCV_ISA_Xcfu   {Xcfu - Custom-instructions unit (user-defined)}     {} }
  }

  set group [add_group $page {Physical Memory Protection (PMP)}]
  add_params $group {
    { PMP_NUM_REGIONS     {PMP regions}                    {Number of physical memory protection regions} }
    { PMP_MIN_GRANULARITY {PMP minimal granularity}        {Minimal region granularity in bytes. Has to be a power of two}            {$PMP_NUM_REGIONS > 0} }
    { PMP_TOR_MODE_EN     {Enable PMP TOR mode}            {Implement support for top-of-region (TOR) mode}                           {$PMP_NUM_REGIONS > 0} }
    { PMP_NAP_MODE_EN     {Enable PMP NAPOT and NA4 modes} {Implement support for naturally-aligned power-of-two (NAPOT & NA4) modes} {$PMP_NUM_REGIONS > 0} }
  }
  set_property value_validation_range_minimum 4 [ipx::get_user_parameters PMP_MIN_GRANULARITY -of_objects [ipx::current_core]]

  set group [add_group $page {Tuning Options}]
  add_params $group {
    { CPU_CONSTT_BR_EN  {Constant-time branches} {Identical execution times for taken and not-taken branches} }
    { CPU_FAST_MUL_EN   {DSP-based multiplier}   {Use DSP block instead of bit-serial multipliers} }
    { CPU_FAST_MUL_REG  {Multiplier register}    {Add a pipeline register to the DSP-based multiplier to improve timing closure} }
    { CPU_FAST_SHIFT_EN {Barrel shifter}         {Use full-parallel shifters instead of of bit-serial shifters} }
    { CPU_RF_ARCH_SEL   {Register file style}    {Select implementation style of CPU register file} }
  }
  set_property widget {comboBox} [ipgui::get_guiparamspec -name "CPU_RF_ARCH_SEL" -component [ipx::current_core] ]
  set_property value_validation_type pairs [ipx::get_user_parameters CPU_RF_ARCH_SEL -of_objects [ipx::current_core]]
  set_property value_validation_pairs {{Block RAM} 0 {Distributed RAM} 1 {FFs with reset} 2 {Latches} 3} [ipx::get_user_parameters CPU_RF_ARCH_SEL -of_objects [ipx::current_core]]


  # **************************************************************
  # GUI Page: Memory
  # **************************************************************
  set page [add_page {Memory}]
  set mem_note "The memory sizes & base addresses need to be exported to the linker via dedicated symbols. Example:"
  set imem_note "IMEM 32kB @ 0x00000000: -Wl,--defsym,__neorv32_rom_size=32k -Wl,--defsym,__neorv32_rom_base=0x00000000"
  set dmem_note "DMEM 16kB @ 0x80000000: -Wl,--defsym,__neorv32_ram_size=16k -Wl,--defsym,__neorv32_ram_base=0x80000000"
  ipgui::add_static_text -name {MEM note}  -component [ipx::current_core] -parent [ipgui::get_pagespec -name "Memory" -component [ipx::current_core] ] -text $mem_note
  ipgui::add_static_text -name {IMEM note} -component [ipx::current_core] -parent [ipgui::get_pagespec -name "Memory" -component [ipx::current_core] ] -text $imem_note
  ipgui::add_static_text -name {DMEM note} -component [ipx::current_core] -parent [ipgui::get_pagespec -name "Memory" -component [ipx::current_core] ] -text $dmem_note

  set group [add_group $page {Internal Instruction Memory (IMEM)}]
  add_params $group {
    { IMEM_EN        {Enable internal IMEM} }
    { IMEM_BASE      {IMEM base address}     {Naturally-aligned to its size}                     {$IMEM_EN} }
    { IMEM_SIZE      {IMEM size (bytes)}     {Use a power of two}                                {$IMEM_EN} }
    { IMEM_OUTREG_EN {Output register stage} {Improves mapping/timing at the expense of latency} {$IMEM_EN} }
  }

  set group [add_group $page {Internal Data Memory (DMEM)}]
  add_params $group {
    { DMEM_EN        {Enable internal DMEM} }
    { DMEM_BASE      {DMEM base address}     {Naturally-aligned to its size}                     {$DMEM_EN} }
    { DMEM_SIZE      {DMEM size (bytes)}     {Use a power of two}                                {$DMEM_EN} }
    { DMEM_OUTREG_EN {Output register stage} {Improves mapping/timing at the expense of latency} {$DMEM_EN} }
  }

  set group [add_group $page {Serial Memory Controller (SMC)}]
  add_params $group {
    { SMC_EN   {Enable serial memeory controller} }
    { SMC_BASE {Serial memory base address} {top 4 MSBs only / 256MB aligned} {$SMC_EN} }
  }


  # **************************************************************
  # GUI Page: Caches
  # **************************************************************
  set page [add_page {Caches}]

  set group [add_group $page {General}]
  add_params $group {
    { CACHE_BLOCK_SIZE {Cache line size (bytes)} {Has to be a power a power of two} }
    { CACHE_UC_BASE    {Uncached base address}   {Has to be 256MB-aligned} }
  }

  set group [add_group $page {Instruction Cache (I-Cache)}]
  add_params $group {
    { ICACHE_EN         {Enable I-Cache} }
    { ICACHE_NUM_BLOCKS {Number of lines} {Use a power of two} {$ICACHE_EN} }
  }

  set group [add_group $page {Data Cache (D-Cache)}]
  add_params $group {
    { DCACHE_EN         {Enable D-Cache} }
    { DCACHE_NUM_BLOCKS {Number of lines} {Use a power of two} {$DCACHE_EN} }
  }


  # **************************************************************
  # GUI Page: Peripherals
  # **************************************************************
  set page [add_page {Peripherals}]

  set group [add_group $page {General-Purpose Inputs/Outputs (GPIO)}]
  add_params $group {
    { IO_GPIO_EN      {Enable GPIO} }
    { IO_GPIO_IN_NUM  {Inputs (IRQ-capable)}      {} {$IO_GPIO_EN} }
    { IO_GPIO_OUT_NUM {Outputs}                   {} {$IO_GPIO_EN} }
    { IO_GPIO_DIR_EN  {Enable direction control}  {} {$IO_GPIO_EN} {$IO_GPIO_EN ? $IO_GPIO_DIR_EN : false} }
    { IO_GPIO_DIR_NUM {Direction control outputs} {} {$IO_GPIO_DIR_EN} }
  }

  set group [add_group $page {Core Local Interruptor (CLINT)}]
  add_params $group {
    { IO_CLINT_EN {Enable RISC-V core-local interruptor} }
  }

  set group [add_group $page {Primary UART (UART0)}]
  add_params $group {
    { IO_UART0_EN      {Enable UART0} }
    { IO_UART0_RX_FIFO {RX FIFO depth} {Number of entries (use a power of two)} {$IO_UART0_EN} }
    { IO_UART0_TX_FIFO {TX FIFO depth} {Number of entries (use a power of two)} {$IO_UART0_EN} }
  }

  set group [add_group $page {Secondary UART (UART1)}]
  add_params $group {
    { IO_UART1_EN      {Enable UART1} }
    { IO_UART1_RX_FIFO {RX FIFO depth} {Number of entries (use a power of two)} {$IO_UART1_EN} }
    { IO_UART1_TX_FIFO {TX FIFO depth} {Number of entries (use a power of two)} {$IO_UART1_EN} }
  }

  set group [add_group $page {SPI Host Controller (SPI)}]
  add_params $group {
    { IO_SPI_EN   {Enable SPI} }
    { IO_SPI_FIFO {FIFO depth} {Number of entries (use a power of two)} {$IO_SPI_EN} }
  }

  set group [add_group $page {SPI Device Controller (SDI)}]
  add_params $group {
    { IO_SDI_EN   {Enable SDI} }
    { IO_SDI_FIFO {FIFO depth} {Number of entries (use a power of two)} {$IO_SDI_EN} }
  }

  set group [add_group $page {Two-Wire/I2C Host (TWI)}]
  add_params $group {
    { IO_TWI_EN   {Enable TWI} }
    { IO_TWI_FIFO {FIFO depth} {Number of entries (use a power of two)} {$IO_TWI_EN} }
  }

  set group [add_group $page {Two-Wire/I2C Device (TWD)}]
  add_params $group {
    { IO_TWD_EN      {Enable TWD} }
    { IO_TWD_RX_FIFO {RX FIFO depth} {Number of entries (use a power of two)} {$IO_TWD_EN} }
    { IO_TWD_TX_FIFO {TX FIFO depth} {Number of entries (use a power of two)} {$IO_TWD_EN} }
  }

  set group [add_group $page {Pulse-Width Modulation Controller (PWM)}]
  add_params $group {
    { IO_PWM_EN  {Enable PWM} }
    { IO_PWM_NUM {Number of PWM channels} {} {$IO_PWM_EN} }
  }

  set group [add_group $page {Watchdog Timer (WDT)}]
  add_params $group {
    { IO_WDT_EN {Enable WDT} }
  }

  set group [add_group $page {True Random-Number Generator (TRNG)}]
  add_params $group {
    { IO_TRNG_EN        {Enable TRNG} }
    { IO_TRNG_FIFO      {FIFO depth}    {Number of entries (use a power of two)}                          {$IO_TRNG_EN} }
    { IO_TRNG_NUM_RO    {Number of ROs} {Number of ring-oscillators}                                      {$IO_TRNG_EN} }
    { IO_TRNG_NUM_INV   {1st RO length} {Length of first ring-oscillator (has to be odd)}                 {$IO_TRNG_EN} }
    { IO_TRNG_NUM_RBIT  {Sample length} {Number of raw random bits per output bytes (use a power of two)} {$IO_TRNG_EN} }
  }

  set group [add_group $page {Custom Functions Subsystem (CFS)}]
  add_params $group {
    { IO_CFS_EN {Enable CFS} }
  }

  set group [add_group $page {Smart LED Interface (NEOLED)}]
  add_params $group {
    { IO_NEOLED_EN      {Enable NEOLED} }
    { IO_NEOLED_TX_FIFO {FIFO depth} {Number of entries (use a power of two)} {$IO_NEOLED_EN} }
  }

  set group [add_group $page {General Purpose Timer (GPTMR)}]
  add_params $group {
    { IO_GPTMR_EN  {Enable GPTMR} }
    { IO_GPTMR_NUM {Number of independent timer slices} }
  }

  set group [add_group $page {One-Wire Interface Controller (ONEWIRE)}]
  add_params $group {
    { IO_ONEWIRE_EN {Enable ONEWIRE} }
  }

  set group [add_group $page {Direct Memory Access Controller (DMA)}]
  add_params $group {
    { IO_DMA_EN       {Enable DMA} }
    { IO_DMA_DSC_FIFO {Descriptor FIFO depth} {Number of entries (use a power of two)} {$IO_DMA_EN} }
  }
}

setup_ip_gui


# **************************************************************
# Helper function to compute the relative path from one
# absolute location to another.
# **************************************************************
proc relativePath {from to} {
  set from [file normalize $from]
  set to [file normalize $to]

  set fromList [file split $from]
  set toList [file split $to]

  set i 0
  set minlen [expr { [llength $fromList] < [llength $toList] ? [llength $fromList] : [llength $toList] }]
  while { $i < $minlen && [lindex $fromList $i] eq [lindex $toList $i] } {
    incr i
  }

  set relList [lrepeat [expr {[llength $fromList] - $i}] ".."]
  set relList [concat $relList [lrange $toList $i end]]
  return [eval file join $relList]
}


# **************************************************************
# Configuration GUI: IP logo
# **************************************************************
set logo_relative_path [relativePath $outputdir/packaged_ip $ip_logo]

ipx::add_file_group -type utility {} [ipx::current_core]
ipx::add_file $logo_relative_path [ipx::get_file_groups xilinx_utilityxitfiles -of_objects [ipx::current_core]]
set_property type image [ipx::get_files $logo_relative_path -of_objects [ipx::get_file_groups xilinx_utilityxitfiles -of_objects [ipx::current_core]]]
set_property type LOGO  [ipx::get_files $logo_relative_path -of_objects [ipx::get_file_groups xilinx_utilityxitfiles -of_objects [ipx::current_core]]]

ipx::add_file_group -type gui_icon {} [ipx::current_core]
ipx::add_file $logo_relative_path [ipx::get_file_groups xilinx_coreguiicon -of_objects [ipx::current_core]]
set_property type image [ipx::get_files $logo_relative_path -of_objects [ipx::get_file_groups xilinx_coreguiicon -of_objects [ipx::current_core]]]
set_property type LOGO  [ipx::get_files $logo_relative_path -of_objects [ipx::get_file_groups xilinx_coreguiicon -of_objects [ipx::current_core]]]

ipx::add_file_group -type product_guide {} [ipx::current_core]
ipx::add_file {https://stnolting.github.io/neorv32/} [ipx::get_file_groups xilinx_productguide -of_objects [ipx::current_core]]


# **************************************************************
# Finalize and add to IP repository
# **************************************************************
ipx::create_xgui_files [ipx::current_core]
ipx::update_checksums [ipx::current_core]
ipx::save_core [ipx::current_core]

set_property ip_repo_paths $outputdir/packaged_ip [current_project]
update_ip_catalog

close_project
