Merge pull request #133 from antmicro/add-nisp-data

Add building data for NISP

Author: mkurc-ant

.github/scripts/centos-setup.sh

@@ -28,6 +28,9 @@ make install
 popd
 ln -sf /usr/local/bin/make /usr/bin/make
 
+# Copy java.capnp needed by NISP
+cp ./third_party/nextpnr-fpga-interchange-site-preprocessor/third_party/capnproto-java/compiler/src/main/schema/capnp/java.capnp /usr/include/capnp/java.capnp
+
 # Check versions
 make --version
 cmake --version

.github/scripts/pack-interchange-data.sh

@@ -37,6 +37,7 @@ LINK_PREFIX=$3
 INSTALL_DIR="$(pwd)/install"
 
 # Prepare environment
+source "$HOME/.cargo/env"
 make env
 source env/conda/bin/activate fpga-interchange
 

.github/scripts/ubuntu-setup.sh

@@ -10,9 +10,12 @@
 set -e
 apt-get -qqy update
 apt-get -qqy install build-essential git make locales libtinfo-dev \
-  cmake python3 wget unzip curl openjdk-11-jdk-headless capnproto
+  cmake python3 wget unzip curl openjdk-11-jdk-headless capnproto libcapnp-dev
 dpkg-reconfigure locales
 
+# Copy java.capnp needed by NISP
+cp ./third_party/nextpnr-fpga-interchange-site-preprocessor/third_party/capnproto-java/compiler/src/main/schema/capnp/java.capnp /usr/include/capnp/java.capnp
+
 # Vivado is erroring out due to a missing library in CI.
 # https://support.xilinx.com/s/article/76585?language=en_US
 ln -s /lib/x86_64-linux-gnu/libtinfo.so.6 /lib/x86_64-linux-gnu/libtinfo.so.5

.github/workflows/ci.yml

@@ -80,11 +80,17 @@ jobs:
       run: |
         .github/scripts/ubuntu-setup.sh
 
+    - name: Install Rust
+      run: |
+        curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+
     - name: Create environment
-      run: make env
+      run: |
+        make env
 
     - name: Build CMake
       run: |
+        source "$HOME/.cargo/env"
         make build
         make update
 

.github/workflows/upload.yml

@@ -36,6 +36,8 @@ jobs:
     steps:
 
     - uses: actions/checkout@v2
+      with:
+        submodules: recursive
 
     - name: Install prerequisites
       run: |
@@ -47,6 +49,10 @@ jobs:
         apt update -qqy
         apt install -qqy gnupg2 google-cloud-cli
 
+    - name: Install Rust
+      run: |
+        curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+
     - name: Save timestamp
       id: timestamp
       run: |

.gitmodules

@@ -34,3 +34,6 @@
 [submodule "third_party/litex-boards"]
 	path = third_party/litex-boards
 	url = https://github.com/litex-hub/litex-boards.git
+[submodule "third_party/nextpnr-fpga-interchange-site-preprocessor"]
+	path = third_party/nextpnr-fpga-interchange-site-preprocessor
+	url = https://github.com/antmicro/nextpnr-fpga-interchange-site-preprocessor

CMakeLists.txt

@@ -53,6 +53,16 @@ set_program(vvp)
 set_program(xcfasm)
 set_program(yosys)
 
+if(DEFINED ENV{"NISP"})
+    set(NISP_PATH $ENV{"NISP"})
+else()
+    get_filename_component(NISP_PATH "third_party/nextpnr-fpga-interchange-site-preprocessor/nisp" ABSOLUTE)
+endif()
+
+set_target_properties(
+    programs PROPERTIES NISP ${NISP_PATH}
+)
+
 include(boards/boards.cmake)
 include(devices/chipdb.cmake)
 

Makefile

@@ -12,6 +12,7 @@ ENVIRONMENT_FILE := conda_lock.yml
 
 # Paths
 RAPIDWRIGHT_PATH ?= $(TOP_DIR)/third_party/RapidWright
+NISP_PATH = third_party/nextpnr-fpga-interchange-site-preprocessor
 
 third_party/make-env/conda.mk:
 	git submodule init
@@ -26,11 +27,23 @@ update:
 		make compile && \
 		popd
 
+${NISP_PATH}/nisp:
+	@$(IN_CONDA_ENV) cd ${NISP_PATH} && (FPGA_INTERCHANGE_SCHEMA_DIR=third_party/fpga-interchange-schema cargo build --release)
+	@ln -s `realpath ${NISP_PATH}/target/release/nisp` ${NISP_PATH}/nisp
+
+.PHONY: nisp
+nisp: ${NISP_PATH}/nisp
+
+.PHONY: clean-nisp
+clean-nisp:
+	@rm -rf ${NISP_PATH}/target
+	-@unlink ${NISP_PATH}/nisp
+
 .PHONY: build
-build:
+build: ${NISP_PATH}/nisp
 	# Build test suite
 	@$(IN_CONDA_ENV) mkdir -p build && cd build && cmake .. ${CMAKE_FLAGS}
 
 .PHONY: clean-build
-clean-build:
+clean-build: clean-nisp
 	rm -rf build/*

devices/chipdb.cmake

@@ -248,6 +248,7 @@ function(generate_chipdb)
 
     get_target_property(PYTHON3 programs PYTHON3)
     get_target_property(BBASM programs BBASM)
+    get_target_property(NISP programs NISP)
 
     get_target_property(device_loc ${device_target} LOCATION)
     set(chipdb_bba ${CMAKE_CURRENT_BINARY_DIR}/chipdb.bba)
@@ -280,6 +281,22 @@ function(generate_chipdb)
 
     add_custom_target(chipdb-${device}-bin DEPENDS ${chipdb_bin})
 
+    # TODO: Currently we invoke NISP to generate JSON data and we keep the
+    # JSON file. Ultimately this data should be imported to the BBA file.
+    set(nisp_json ${CMAKE_CURRENT_BINARY_DIR}/${device}_site_routability.json)
+    add_custom_command(
+        OUTPUT ${nisp_json}
+        COMMAND
+            ${NISP} ${device_loc} ${chipdb_bba} preprocess --json :all --threads 1 --no-formula-opt -c
+        DEPENDS
+            chipdb-${device}-bba
+            ${device_target}
+            ${device_loc}
+            ${NISP}
+    )
+
+    add_custom_target(chipdb-${device}-json DEPENDS ${nisp_json})
+
     # Setting device target properties
     add_custom_target(device-${device})
     set_target_properties(
@@ -299,16 +316,19 @@ function(generate_chipdb)
 
     install(FILES ${device_loc} DESTINATION devices/${device})
     install(FILES ${chipdb_bin} DESTINATION devices/${device})
+    install(FILES ${nisp_json}  DESTINATION devices/${device})
 
     add_custom_target(
         install_${device}_device
         ALL
         DEPENDS
             ${device_target}
             chipdb-${device}-bin
+            chipdb-${device}-json
     )
 
     add_dependencies(all-device-data chipdb-${device}-bin)
+    add_dependencies(all-device-data chipdb-${device}-json)
 
 endfunction()