cleaning scripts (#4)

Signed-off-by: Bruno Mesnet <[email protected]>

Signed-off-by: Bruno Mesnet <[email protected]>

Author: bmesnet

README.md

@@ -45,7 +45,7 @@ Any new board or additional ports can be easily added. Board specific files can
 
 I2C communication with these boards can be done with a Rasberry Pi.
 
-AMD/Xilinx Vivado 2018.3 is used to build the FPGA binary images.
+AMD/Xilinx Vivado 2021.2 is used to build the FPGA binary images.
 
 Code is designed for AMD/Xilinx UltraScale+ FPGA family.
 
@@ -81,8 +81,8 @@ GUI). The command output is written to `$design/$command.log`, and
 also colorized and printed to the screen. Output files are saved in
 the `$design/` directory, including a design checkpoint (.dcp file).
 
-__run_fire.sh__: Runs the main synthesize, then implement using strategy 8,
-and gen_bitstream with implementation strategy result 8. This number will be
+__run_fire.sh__: Runs the main synthesize, then implement using strategy 17,
+and gen_bitstream with implementation strategy result 17. This number will be
 adapted depending on the design and the WNS result displayed at the end of 
 the place and route phase.  If run on
 a machine with a `bsub` binary found (aka LSF is installed), then the
@@ -128,6 +128,8 @@ __build.lsf__: LSF configuration used for all commands submitted via `bsub`.
 
 __clean_all.sh__: clean the whole project removing all files generated by scripts.
 
+__clean_fire.sh__: clean the whole fire project removing all files generated by scripts.
+
 ## Work-In-Progress
 
 These files are either a work-in-progress or stale, and should not be
@@ -136,5 +138,5 @@ used.
 __waived_warnings.txt__: List of warnings that are known and
 acceptable.
 
-__print_warnings.sh__: Print all the warnings in run.log that are not
+__print_warnings_fire.sh__: Print all the warnings in run.log that are not
 waived in waived_warnings.txt.

build/README.md

@@ -2,8 +2,7 @@
 
 This directory contains the various scripts needed to synthesize and
 implement RTL, as well as generate a bitstream, for an FPGA using the
-Fire design. (it was targeting fire (host) and ice (device) but
-only fire is available yet. Any "$design" found should be set to "fire")
+Fire design.
 
 The following command launches for the entire process, with some parallelization:
 
@@ -19,7 +18,7 @@ GUI). The command output is written to `$design/$command.log`, and
 also colorized and printed to the screen. Output files are saved in
 the `$design/` directory, including a design checkpoint (.dcp file).
 
-__run_all.sh__: Takes a design as an argument, and runs the main
+__run_fire.sh__: Runs the build image process for fire. Runs the main
 synthesize, implement, and gen_bitstream loop sequentially. If run on
 a machine with a `bsub` binary found (aka LSF is installed), then the
 commands are dispatched via LSF. Additionally, 16 implementation
@@ -32,10 +31,6 @@ __fire/__ : Contain all output files from Vivado. Each
 command outputs to a log stored in the top-level directory, and other
 files are stored in a sub-directory per command.
 
-__fire_deploy/__ : Contain "important" files from
-the run_all.sh script. These are files that could be worth using at a
-later point.
-
 ## Vivado TCL Scripts
 
 __synthesize.tcl__: Load libraries and read RTL and constraint files,

build/bsub_batch

@@ -1,4 +1,25 @@
 #!/usr/bin/env bash
+##
+## Copyright 2022 International Business Machines
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## The patent license granted to you in Section 3 of the License, as applied
+## to the "Work," hereby includes implementations of the Work in physical form.
+##
+## Unless required by applicable law or agreed to in writing, the reference design
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+## The background Specification upon which this is based is managed by and available from
+## the OpenCAPI Consortium.  More information can be found at https://opencapi.org.
+##
+
 
 set -e
 

build/bsub_run

@@ -1,4 +1,25 @@
 #!/usr/bin/env bash
+##
+## Copyright 2022 International Business Machines
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## The patent license granted to you in Section 3 of the License, as applied
+## to the "Work," hereby includes implementations of the Work in physical form.
+##
+## Unless required by applicable law or agreed to in writing, the reference design
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+## The background Specification upon which this is based is managed by and available from
+## the OpenCAPI Consortium.  More information can be found at https://opencapi.org.
+##
+
 
 set -e
 

build/clean_all.sh

@@ -1,13 +1,34 @@
+##
+## Copyright 2022 International Business Machines
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## The patent license granted to you in Section 3 of the License, as applied
+## to the "Work," hereby includes implementations of the Work in physical form.
+##
+## Unless required by applicable law or agreed to in writing, the reference design
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+## The background Specification upon which this is based is managed by and available from
+## the OpenCAPI Consortium.  More information can be found at https://opencapi.org.
+##
+
 rm -rf .cache/ 
-rm .OMI_IPs*
-rm -rf ../ip_created_for*
-rm -rf fire*
 rm -rf .Xil
 rm -rf .ip_user_files
 rm -rf ip_dir
 rm *.log
 rm *.jou
+rm vivado*.str
+rm iter*
 rm usage_statistics_webtalk.*
-rm ../fire/src/verilog/DLx*
-rm ../fire/src/verilog/dlx*
-rm -rf ../fire/src/headers
+rm tight_setup_hold_pins.txt
+rm -rf ./.tmpCRC
+source ./clean_fire.sh
+source ./clean_ice.sh

build/clean_fire.sh

@@ -0,0 +1,30 @@
+
+##
+## Copyright 2022 International Business Machines
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## The patent license granted to you in Section 3 of the License, as applied
+## to the "Work," hereby includes implementations of the Work in physical form.
+##
+## Unless required by applicable law or agreed to in writing, the reference design
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+## The background Specification upon which this is based is managed by and available from
+## the OpenCAPI Consortium.  More information can be found at https://opencapi.org.
+##
+
+rm .OMI_IPs_fire_*
+rm -rf ../ip_created_for_fire
+rm -rf fire*
+rm -rf ../fire/src/ip/managed_ip_project
+rm ../fire/src/verilog/DLx*
+rm ../fire/src/verilog/dlx*
+rm -rf ../fire/src/headers
+rm ../fire/src/vhdl/meta_pkg.vhdl