From 17d3fb5d5e634ec67a7d05e10e3317f0f6fc84cf Mon Sep 17 00:00:00 2001 From: bbleaptrot <35536624+bbleaptrot@users.noreply.github.com> Date: Wed, 28 Jul 2021 10:10:17 -0600 Subject: [PATCH 1/5] Add FAQ to source folder to go along in appendix --- docs/source/faq.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/source/faq.rst diff --git a/docs/source/faq.rst b/docs/source/faq.rst new file mode 100644 index 000000000..d8cb8cae5 --- /dev/null +++ b/docs/source/faq.rst @@ -0,0 +1,44 @@ +.. _faq: + +Frequently Asked Questions +========================== + +Where is the best place to get help with OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Currently, we have an active github issues page found `here `_. Users can see if their +questions have already been answered by searching the open or closed issues, and users are recommended to post questions there first. +Asking questions on the github issues page allows us to answer the question for everyone who may be experiencing similar problems as +well. + +What should I do if verification fails when first installing OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +First, check to make sure all dependencies for OpenFPGA have been installed and are up-to-date on the desired device. To see the full +list of depenencies, please visit +`our github dependencies page `_. +This issue has been discussed `in issue 280 `_. + + +Can I test multiple script parameters for a single variable? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Testing multiple script parameters for a variable is possible by modifying the task.conf file. Doing so will create a job for +each combination of the variables. A solution is discussed `in issue 228 `_. + + +How do I setup OpenFPGA to be used by multiple users on a single device? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +OpenFPGA can support multiple users on a shared device using the environment variable ``OPENFPGA_ROOT``. The OpenFPGA script for +running tasks needs ``OPENFPGA_ROOT`` to be the path to the OpenFPGA root directory. Users can then run the script on a task in the +current working directory. A solution is discussed `in issue 209 `_. + + +Which branch should I work on to contribute to OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Users of OpenFPGA that are interested in contributing can select any `github branch `_ +that relates to the changes the user is interested in making. They can then submit a pull request to have their +changes implemented into OpenFPGA after passing the CI/CD tests. + From 2bb76e4a82b1a6d340ce20dd39983df2db440ebd Mon Sep 17 00:00:00 2001 From: bbleaptrot <35536624+bbleaptrot@users.noreply.github.com> Date: Wed, 28 Jul 2021 10:13:25 -0600 Subject: [PATCH 2/5] Update to include suggested changes --- docs/source/faq.rst | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/source/faq.rst b/docs/source/faq.rst index d8cb8cae5..035cbc2a7 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -11,17 +11,17 @@ questions have already been answered by searching the open or closed issues, and Asking questions on the github issues page allows us to answer the question for everyone who may be experiencing similar problems as well. -What should I do if verification fails when first installing OpenFPGA? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +What should I do if check-in tests failed when first installing OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -First, check to make sure all dependencies for OpenFPGA have been installed and are up-to-date on the desired device. To see the full +First, check to make sure all dependencies for OpenFPGA and Python have been installed and are up-to-date on the desired device. To see the full list of depenencies, please visit `our github dependencies page `_. This issue has been discussed `in issue 280 `_. -Can I test multiple script parameters for a single variable? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +How to sweep design parameters in a task run of OpenFPGA design flow? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Testing multiple script parameters for a variable is possible by modifying the task.conf file. Doing so will create a job for each combination of the variables. A solution is discussed `in issue 228 `_. @@ -35,10 +35,13 @@ running tasks needs ``OPENFPGA_ROOT`` to be the path to the OpenFPGA root direct current working directory. A solution is discussed `in issue 209 `_. -Which branch should I work on to contribute to OpenFPGA? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +How do I contribute to OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Users of OpenFPGA that are interested in contributing can select any `github branch `_ -that relates to the changes the user is interested in making. They can then submit a pull request to have their -changes implemented into OpenFPGA after passing the CI/CD tests. +Users of OpenFPGA that are interested in contributing must complete the following: + + - Create a branch. For external collaborators, please fork the repository first and create a branch in the fork. + - Creatre a pull request and fill out our pull request template. It is easy for us to acknowledge and review your pull request. + - Wait or keep debugging until all the CI tests pass. + - Request for a review. You may expect several rounds of review and discussion before the pull request is approved. From c867c7e6288388a0831f047dff093bbc6f28a40c Mon Sep 17 00:00:00 2001 From: bbleaptrot <35536624+bbleaptrot@users.noreply.github.com> Date: Wed, 28 Jul 2021 10:14:31 -0600 Subject: [PATCH 3/5] Update index to include FAQ page --- docs/source/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index df991919f..be9a43257 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -36,6 +36,7 @@ Welcome to OpenFPGA's documentation! contact reference + faq For more information on the VTR see vtr_doc_ or vtr_github_ From b867db815f3f2667aed9fd88010243535f3064ab Mon Sep 17 00:00:00 2001 From: slt <37230248+foggy-slt@users.noreply.github.com> Date: Fri, 17 Sep 2021 14:02:26 +0800 Subject: [PATCH 4/5] Update fpgaflow_default_tool_path.conf Update regex for VPR --- openfpga_flow/misc/fpgaflow_default_tool_path.conf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openfpga_flow/misc/fpgaflow_default_tool_path.conf b/openfpga_flow/misc/fpgaflow_default_tool_path.conf index 62220e535..91108dbac 100644 --- a/openfpga_flow/misc/fpgaflow_default_tool_path.conf +++ b/openfpga_flow/misc/fpgaflow_default_tool_path.conf @@ -24,8 +24,8 @@ mult_blocks = "Netlist mult_36 blocks: ([0-9]+)", str memory_blocks = "Netlist memory blocks: ([0-9]+)", str logic_delay = "Total logic delay: ([0-9.]+)", str total_net_delay = "total net delay: ([0-9.]+)", str -total_routing_area = "Total routing area: ([0-9.]+)", str -total_logic_block_area = "Total used logic block area: ([0-9]+)", str +total_routing_area = "Total routing area: ([0-9.]+[e|E\+[0-9]+)", str +total_logic_block_area = "Total used logic block area: ([0-9.]+[e|E\+[0-9]+)", str total_wire_length = "Total wirelength: ([0-9]+)", str packing_time = "Packing took ([0-9.]+) seconds", str placement_time = "Placement took ([0-9.]+) seconds", str From f60f5b4ae52cf334f41a7ddec412ffd35331f9e9 Mon Sep 17 00:00:00 2001 From: coolbreeze413 Date: Fri, 8 Oct 2021 03:22:30 +0530 Subject: [PATCH 5/5] add wget to list of dependencies --- .github/workflows/install_dependencies_build.sh | 1 + .github/workflows/install_dependencies_run.sh | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/install_dependencies_build.sh b/.github/workflows/install_dependencies_build.sh index 3f6ef089e..4741cf053 100644 --- a/.github/workflows/install_dependencies_build.sh +++ b/.github/workflows/install_dependencies_build.sh @@ -37,4 +37,5 @@ apt-get update && apt-get install -y \ texinfo \ time \ valgrind \ + wget \ zip diff --git a/.github/workflows/install_dependencies_run.sh b/.github/workflows/install_dependencies_run.sh index 3efb3affb..4c022ee15 100644 --- a/.github/workflows/install_dependencies_run.sh +++ b/.github/workflows/install_dependencies_run.sh @@ -1,4 +1,4 @@ apt-get install --no-install-recommends -y \ libdatetime-perl libc6 libffi6 libgcc1 libreadline7 libstdc++6 \ libtcl8.6 python3.8 python3-pip zlib1g libbz2-1.0 \ -iverilog git rsync make curl +iverilog git rsync make curl wget