library/corundum/ethernet: Changed IP creation to be in subfolders

Signed-off-by: Istvan-Zsolt Szekely <istvan.szekely@analog.com>

Author: IstvanZsSzekely

docs/library/corundum/corundum_core/index.rst

@@ -74,4 +74,4 @@ repository, which needs to be cloned alongside the HDL repository.
 References
 --------------------------------------------------------------------------------
 
-* HDL IP core at :git-hdl:`library/corundum`
+* HDL IP core at :git-hdl:`library/corundum/corundum_core`

docs/library/corundum/ethernet/index.rst

@@ -3,7 +3,10 @@
 Corundum Ethernet Core
 ================================================================================
 
-.. hdl-component-diagram::
+.. toctree::
+   :hidden:
+
+   VCU118 <vcu118/index>
 
 The :git-hdl:`Corundum Ethernet Core <library/corundum/ethernet_core>` is used
 by the Corundum Network Stack. The Ethernet Core is specific to each FPGA board
@@ -12,6 +15,11 @@ as SPI and I2C that are required by the Corundum system. The configurations are
 based on `Corundum NIC <https://github.com/ucsdsysnet/corundum>`__ reference
 designs that were adapted to suit the ADI workflow.
 
+Depending on the board for which the IP is built, different HDL component
+diagrams will be available.
+
+* :ref:`corundum_ethernet_core_vcu118`
+
 Features
 --------------------------------------------------------------------------------
 
@@ -21,25 +29,20 @@ Features
 Files
 --------------------------------------------------------------------------------
 
-.. list-table::
-   :header-rows: 1
-
-   * - Name
-     - Description
-   * - :git-hdl:`library/corundum/ethernet_core/ethernet_core_vcu118.v`
-     - Verilog source for the Ethernet Core top module for the VCU118 board.
-   * - :git-hdl:`library/corundum/ethernet_core/eternet_ip.tcl`
-     - TCL script to generate the Vivado IP-integrator project.
+Depending on the board for which the IP is built, different source files will
+be available.
 
 Configuration Parameters
 --------------------------------------------------------------------------------
 
-.. hdl-parameters::
+Depending on the board for which the IP is built, different HDL parameters will
+be available.
 
 Interface
 --------------------------------------------------------------------------------
 
-.. hdl-interfaces::
+Depending on the board for which the IP is built, different HDL interfaces and
+ports will be available.
 
 Building
 --------------------------------------------------------------------------------
@@ -104,4 +107,4 @@ appropriate configuration.
 References
 --------------------------------------------------------------------------------
 
-* HDL IP core at :git-hdl:`library/corundum`
+* HDL IP core at :git-hdl:`library/corundum/ethernet`

docs/library/corundum/ethernet/vcu118/index.rst

@@ -0,0 +1,34 @@
+.. _corundum_ethernet_core_vcu118:
+
+Corundum Ethernet Core for VCU118
+================================================================================
+
+.. hdl-component-diagram::
+
+Files
+--------------------------------------------------------------------------------
+
+.. list-table::
+   :header-rows: 1
+
+   * - Name
+     - Description
+   * - :git-hdl:`library/corundum/ethernet_core/ethernet_core_vcu118.v`
+     - Verilog source for the Ethernet Core top module for the VCU118 board.
+   * - :git-hdl:`library/corundum/ethernet_core/eternet_ip.tcl`
+     - TCL script to generate the Vivado IP-integrator project.
+
+Configuration Parameters
+--------------------------------------------------------------------------------
+
+.. hdl-parameters::
+
+Interface
+--------------------------------------------------------------------------------
+
+.. hdl-interfaces::
+
+References
+--------------------------------------------------------------------------------
+
+* HDL IP core at :git-hdl:`library/corundum/ethernet_core`

library/corundum/ethernet/ethernet_ip.tcl

@@ -8,10 +8,15 @@ source $ad_hdl_dir/library/scripts/adi_ip_xilinx.tcl
 
 global VIVADO_IP_LIBRARY
 
-adi_ip_create ethernet
-
 if [info exists ::env(BOARD)] {
   set board $::env(BOARD)
+  set board_lowercase [string tolower $board]
+  set ethernet_ip "ethernet_${board_lowercase}"
+
+  adi_ip_create $ethernet_ip $board_lowercase
+
+  cd ./$board_lowercase
+
   if [string equal $board VCU118] {
     set_property part xcvu9p-flga2104-2L-e [current_project]
 
@@ -20,7 +25,7 @@ if [info exists ::env(BOARD)] {
 
     # Corundum sources
     adi_ip_files ethernet_core_vcu118 [list \
-      "ethernet_core_vcu118.v" \
+      "../ethernet_core_vcu118.v" \
       "$ad_hdl_dir/../corundum/fpga/mqnic/VCU118/fpga_100g/rtl/sync_signal.v" \
       "$ad_hdl_dir/../corundum/fpga/common/rtl/mqnic_port_map_mac_axis.v" \
       "$ad_hdl_dir/../corundum/fpga/lib/eth/lib/axis/rtl/sync_reset.v" \
@@ -37,13 +42,13 @@ if [info exists ::env(BOARD)] {
   error "Missing BOARD environment variable definition from Makefile!"
 }
 
-adi_ip_properties_lite ethernet
-set_property company_url {https://analogdevicesinc.github.io/hdl/library/corundum} [ipx::current_core]
+adi_ip_properties_lite $ethernet_ip
 
 set cc [ipx::current_core]
 
-set_property display_name "Corundum Ethernet" $cc
+set_property display_name "Corundum Ethernet $board" $cc
 set_property description "Corundum Ethernet Core IP" $cc
+set_property company_url {https://analogdevicesinc.github.io/hdl/library/corundum} [ipx::current_core]
 
 # Remove all inferred interfaces and address spaces
 ipx::remove_all_bus_interface [ipx::current_core]

library/corundum/scripts/corundum.tcl

@@ -196,7 +196,9 @@ ad_ip_instance corundum_core corundum_core [list \
   AXIS_IF_RX_USER_WIDTH_APP $AXIS_IF_RX_USER_WIDTH_APP \
 ]
 
-ad_ip_instance ethernet ethernet_core [list \
+set board [string tolower $::env(BOARD)]
+
+ad_ip_instance ethernet_${board} ethernet_core [list \
   TDMA_BER_ENABLE $TDMA_BER_ENABLE \
   QSFP_CNT $QSFP_CNT \
   IF_COUNT $IF_COUNT \

library/scripts/adi_ip_xilinx.tcl

@@ -253,7 +253,7 @@ proc adi_ip_add_core_dependencies {vlnvs} {
 #
 # \param[ip_name] - IP name
 #
-proc adi_ip_create {ip_name} {
+proc adi_ip_create {ip_name {folder_name {}}} {
 
   global ad_hdl_dir
   global ad_ghdl_dir
@@ -277,7 +277,12 @@ proc adi_ip_create {ip_name} {
     }
   }
 
-  create_project $ip_name . -force
+  if {$folder_name == {}} {
+    create_project $ip_name . -force
+  } else {
+    create_project $ip_name $folder_name -force
+  }
+
 
   ## Load custom message severity definitions