From c8fb3a18461f604bc065f6f7c8123036fcf702bf Mon Sep 17 00:00:00 2001
From: Istvan Csomortani <istvan.csomortani@analog.com>
Date: Sun, 16 Aug 2020 11:27:59 +0300
Subject: [PATCH] spi_engine_execution: Update IPXACT GUI layout

---
 .../spi_engine_execution_ip.tcl               | 131 ++++++++++++++++++
 1 file changed, 131 insertions(+)

diff --git a/library/spi_engine/spi_engine_execution/spi_engine_execution_ip.tcl b/library/spi_engine/spi_engine_execution/spi_engine_execution_ip.tcl
index b2a1b1a34..7cd4868b4 100644
--- a/library/spi_engine/spi_engine_execution/spi_engine_execution_ip.tcl
+++ b/library/spi_engine/spi_engine_execution/spi_engine_execution_ip.tcl
@@ -11,6 +11,8 @@ adi_ip_properties_lite spi_engine_execution
 # Remove all inferred interfaces
 ipx::remove_all_bus_interface [ipx::current_core]
 
+## Interface definitions
+
 adi_add_bus "ctrl" "slave" \
 	"analog.com:interface:spi_engine_ctrl_rtl:1.0" \
 	"analog.com:interface:spi_engine_ctrl:1.0" \
@@ -43,4 +45,133 @@ adi_add_bus "spi" "master" \
 	}
 adi_add_bus_clock "clk" "spi" "resetn"
 
+## Parameter validations
+
+set cc [ipx::current_core]
+
+## DATA_WIDTH
+set_property -dict [list \
+  "value_validation_type" "range_long" \
+  "value_validation_range_minimum" "8" \
+  "value_validation_range_maximum" "256" \
+ ] \
+ [ipx::get_user_parameters DATA_WIDTH -of_objects $cc]
+
+## NUM_OF_CS
+set_property -dict [list \
+  "value_validation_type" "range_long" \
+  "value_validation_range_minimum" "1" \
+  "value_validation_range_maximum" "32" \
+ ] \
+ [ipx::get_user_parameters NUM_OF_CS -of_objects $cc]
+
+## NUM_OF_SDI
+set_property -dict [list \
+  "value_validation_type" "range_long" \
+  "value_validation_range_minimum" "1" \
+  "value_validation_range_maximum" "8" \
+ ] \
+ [ipx::get_user_parameters NUM_OF_SDI -of_objects $cc]
+
+## DEFAULT_SPI_CFG
+set_property -dict [list \
+  "value_validation_type" "list" \
+  "value_validation_list" "0 1 2 3" \
+ ] \
+ [ipx::get_user_parameters DEFAULT_SPI_CFG -of_objects $cc]
+
+## DEFAULT_CLK_DIV
+set_property -dict [list \
+  "value_validation_type" "list" \
+  "value_validation_range_minimum" "0" \
+  "value_validation_range_maximum" "255" \
+ ] \
+ [ipx::get_user_parameters DEFAULT_CLK_DIV -of_objects $cc]
+
+## SDO_DEFAULT
+set_property -dict [list \
+  "value_validation_type" "list" \
+  "value_validation_list" "0 1" \
+ ] \
+ [ipx::get_user_parameters SDO_DEFAULT -of_objects $cc]
+
+## SDI_DELAY
+set_property -dict [list \
+  "value_format" "bool" \
+  "value" "false" \
+ ] \
+ [ipx::get_user_parameters SDI_DELAY -of_objects $cc]
+
+## Customize IP Layout
+
+## Remove the automatically generated GUI page
+ipgui::remove_page -component $cc [ipgui::get_pagespec -name "Page 0" -component $cc]
+ipx::save_core [ipx::current_core]
+
+## Create general configuration page
+ipgui::add_page -name {SPI Engine execution} -component [ipx::current_core] -display_name {AXI SPI Engine execution}
+set page0 [ipgui::get_pagespec -name "SPI Engine execution" -component $cc]
+
+set general_group [ipgui::add_group -name "General Configuration" -component $cc \
+    -parent $page0 -display_name "General Configuration" ]
+
+ipgui::add_param -name "DATA_WIDTH" -component $cc -parent $general_group
+set_property -dict [list \
+  "display_name" "Parallel data width" \
+  "tooltip" "\[DATA_WIDTH\] Define the data interface width"
+] [ipgui::get_guiparamspec -name "DATA_WIDTH" -component $cc]
+
+ipgui::add_param -name "NUM_OF_CS" -component $cc -parent $general_group
+set_property -dict [list \
+  "display_name" "Number of CSN lines" \
+  "tooltip" "\[NUM_OF_CS\] Define the number of chip select lines" \
+] [ipgui::get_guiparamspec -name "NUM_OF_CS" -component $cc]
+
+ipgui::add_param -name "NUM_OF_SDI" -component $cc -parent $general_group
+set_property -dict [list \
+  "display_name" "Number of MISO lines" \
+  "tooltip" "\[NUM_OF_SDI\] Define the number of MISO lines" \
+] [ipgui::get_guiparamspec -name "NUM_OF_SDI" -component $cc]
+
+set spi_config_group [ipgui::add_group -name "SPI Configuration" -component $cc \
+    -parent $page0 -display_name "SPI Configuration" ]
+
+ipgui::add_param -name "DEFAULT_SPI_CFG" -component $cc -parent $spi_config_group
+set_property -dict [list \
+  "widget" "comboBox" \
+  "display_name" "Default SPI mode" \
+  "tooltip" "\[DEFAULT_SPI_CFG\] Define the default SPI configuration, bit 1 defines CPOL, bit 0 defines CPHA"
+] [ipgui::get_guiparamspec -name "DEFAULT_SPI_CFG" -component $cc]
+
+ipgui::add_param -name "DEFAULT_CLK_DIV" -component $cc -parent $spi_config_group
+set_property -dict [list \
+  "display_name" "Default SCLK divider" \
+  "tooltip" "\[DEFAULT_CLK_DIV\] Define the default SCLK divider, fSCLK = fCoreClk / DEFAULT_CLK_DIV + 1"
+] [ipgui::get_guiparamspec -name "DEFAULT_CLK_DIV" -component $cc]
+
+set mosi_miso_config_group [ipgui::add_group -name "MOSI/MISO Configuration" -component $cc \
+    -parent $page0 -display_name "MOSI/MISO Configuration" ]
+
+ipgui::add_param -name "NUM_OF_SDI" -component $cc -parent $mosi_miso_config_group
+set_property -dict [list \
+  "display_name" "Number of MISO" \
+  "tooltip" "\[NUM_OF_SDI\] Define the number of MISO lines"
+] [ipgui::get_guiparamspec -name "NUM_OF_SDI" -component $cc]
+
+ipgui::add_param -name "SDI_DELAY" -component $cc -parent $mosi_miso_config_group
+set_property -dict [list \
+  "display_name" "Delay MISO latching" \
+  "tooltip" "\[SDI_DELAY\] Delay the MISO latching to the next consecutive SCLK edge"
+] [ipgui::get_guiparamspec -name "SDI_DELAY" -component $cc]
+
+ipgui::add_param -name "SDO_DEFAULT" -component $cc -parent $mosi_miso_config_group
+set_property -dict [list \
+  "widget" "comboBox" \
+  "display_name" "MOSI default level" \
+  "tooltip" "\[SDO_DEFAULT\] Define the default voltage level on MOSI"
+] [ipgui::get_guiparamspec -name "SDO_DEFAULT" -component $cc]
+
+## Create and save the XGUI file
+ipx::create_xgui_files $cc
+
 ipx::save_core [ipx::current_core]