Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix document misspelling #1312

Merged
merged 5 commits into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ CMAKE_BUILD_TYPE := $(shell echo ${BUILD_TYPE} | sed 's/_\?pgo//' | sed 's/_\?st
# e.g. make CMAKE_FLAGS="-DCMAKE_CXX_COMPILER=g++-9'
override CMAKE_FLAGS := -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -G 'Unix Makefiles' ${CMAKE_FLAGS}

# -s : Suppresss makefile output (e.g. entering/leaving directories)
# -s : Suppress makefile output (e.g. entering/leaving directories)
# --output-sync target : For parallel compilation ensure output for each target is synchronized (make version >= 4.0)
MAKEFLAGS := -s

Expand Down
18 changes: 9 additions & 9 deletions docs/source/dev_manual/cicd_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ in which case the docker image compiled for the latest master branch is used for
];

RunRegression [
label = "Run functional regeression test"
label = "Run functional regression test"
shape = box
];

Expand All @@ -69,7 +69,7 @@ in which case the docker image compiled for the latest master branch is used for

.. option:: Build regression test

The OpenFPGA soure is compiled with the following set of compilers.
The OpenFPGA source is compiled with the following set of compilers.

#. gcc-7
#. gcc-8
Expand All @@ -81,9 +81,9 @@ in which case the docker image compiled for the latest master branch is used for
#. clang-8
#. clang-10

The docker images for these build enviroment are available on `github packages <https://github.com/orgs/lnis-uofu/packages>`_.
The docker images for these build environment are available on `github packages <https://github.com/orgs/lnis-uofu/packages>`_.

.. option:: Functional regeression test
.. option:: Functional regression test

OpenFPGA maintains a set of functional tests to validate the different functionality.
The test are broadly catagories into ``basic_reg_test``, ``fpga_verilog_reg_test``,
Expand All @@ -93,7 +93,7 @@ in which case the docker image compiled for the latest master branch is used for

How to debug failed regression test
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In case the ``funtional regression test`` fails,
In case the ``functional regression test`` fails,
the actions script will collect all ``.log`` files from
the task directory and upload as a artifacts on github storage.
These artifacts can be downloaded from the github website actions tab, for more reference follow `this <https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts>`_ article.
Expand All @@ -113,11 +113,11 @@ Release Docker Images

CI after cloning repository
^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you clone the repository the CI setup will still function, except the based images are still pullled from "lnis-uofu" repsitory and the master branch
If you clone the repository the CI setup will still function, except the based images are still pulled from "lnis-uofu" repository and the master branch
of cloned repo will not push final docker image to any repository .

**In case you want to host your own copies of OpenFPGA base images** and final release create a githib secret variable with name ``DOCKER_REPO`` and set it to ``true``. This will make ci script to download base images from your own repo pakcages, and upload final realse to the same.
**In case you want to host your own copies of OpenFPGA base images** and final release create a github secret variable with name ``DOCKER_REPO`` and set it to ``true``. This will make ci script to download base images from your own repo packages, and upload final release to the same.

**If you don not want to use docker images based regression test** and like to compile all the bianries for each CI run. You can set ``IGNORE_DOCKER_TEST`` secrete variable to ``true``.
**If you don not want to use docker images based regression test** and like to compile all the binaries for each CI run. You can set ``IGNORE_DOCKER_TEST`` secrete variable to ``true``.

.. note:: Once you add ``DOCKER_REPO`` variable, you need to genrerate base images. To do this trigger mannual workflow ``Build docker CI images``
.. note:: Once you add ``DOCKER_REPO`` variable, you need to generate base images. To do this trigger manual workflow ``Build docker CI images``
2 changes: 1 addition & 1 deletion docs/source/dev_manual/version_number.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ Version updates are made in the following scenario

- significant improvements on Quality-of-Results (QoR).
- significant changes on user interface.
- a techical feature is developed and validated by the community, which can impact the complete design flow.
- a technical feature is developed and validated by the community, which can impact the complete design flow.


4 changes: 2 additions & 2 deletions docs/source/manual/file_formats/fabric_bitstream.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Plain text (.bit)
This file format is designed to be directly loaded to an FPGA fabric.
It does not include any comments but only bitstream.

The information depends on the type of configuration procotol.
The information depends on the type of configuration protocol.

.. option:: vanilla

Expand Down Expand Up @@ -232,7 +232,7 @@ A quick example:
<bit id="0" value="1" path="fpga_top.grid_clb_1__2_.logical_tile_clb_mode_clb__0.mem_fle_9_in_5.mem_out[0]"/>
</bit>

Other information may depend on the type of configuration procotol.
Other information may depend on the type of configuration protocol.

.. option:: memory_bank

Expand Down
2 changes: 1 addition & 1 deletion docs/source/manual/file_formats/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
File Formats
------------

OpenFPGA widely uses XML format for interchangable files
OpenFPGA widely uses XML format for interchangeable files


.. _file_formats:
Expand Down
16 changes: 8 additions & 8 deletions docs/source/manual/fpga_spice/command_line_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ FPGA-SPICE Supported Options::
--fpga_spice_testbench_load_extraction_off
--fpga_spice_sim_mt_num <int>

.. note:: FPGA-SPICE requires the input of activity estimation results (\*.act file) from ACE2.
Remember to use the option --activity_file <act_file> to read the activity file.
.. note:: FPGA-SPICE requires the input of activity estimation results (\*.act file) from ACE2.
Remember to use the option --activity_file <act_file> to read the activity file.

.. note:: To dump full-chip-level testbenches, the option –-fpga_spice_print_top_testbench should be enabled.

.. note:: To dump grid-level testbenches, the options -- fpga_spice_print_grid_testbench, -- fpga_spice_print_cb_testbench and -- fpga_spice_print_sb_testbench should be enabled.

.. note:: To dump component-level testbenches, the options –fpga_spice_print_lut_testbench, --fpga_spice_print_hardlogic_testbench, --fpga_spice_print_pb_mux_testbench, --fpga_spice_print_cb_mux_testbench and --fpga_spice_print_sb_mux_testbench should be enabled.
.. note:: To dump full-chip-level testbenches, the option –-fpga_spice_print_top_testbench should be enabled.

.. csv-table:: Commmand-line Options of FPGA-SPICE
.. note:: To dump grid-level testbenches, the options -- fpga_spice_print_grid_testbench, -- fpga_spice_print_cb_testbench and -- fpga_spice_print_sb_testbench should be enabled.

.. note:: To dump component-level testbenches, the options –fpga_spice_print_lut_testbench, --fpga_spice_print_hardlogic_testbench, --fpga_spice_print_pb_mux_testbench, --fpga_spice_print_cb_mux_testbench and --fpga_spice_print_sb_mux_testbench should be enabled.

.. csv-table:: Command-line Options of FPGA-SPICE
:header: "Command Options", "Description"
:widths: 15, 20

Expand Down
9 changes: 4 additions & 5 deletions docs/source/manual/fpga_verilog/testbench.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To enable self-testing, the FPGA and user's RTL design (simulate using an HDL si

Full Testbench
~~~~~~~~~~~~~~
Full testbench aims at simulating an entire FPGA operating period, consisting of two phases:
Full testbench aims at simulating an entire FPGA operating period, consisting of two phases:

- the **Configuration Phase**, where the synthesized design bitstream is loaded to the programmable fabric, as highlighted by the green rectangle of :numref:`fig_verilog_full_testbench_waveform`;

Expand All @@ -63,7 +63,7 @@ Inside the directory, the Verilog testbenches are organized as illustrated in :n

Hierarchy of Verilog testbenches for a FPGA fabric implemented with an application

.. note:: ``<bench_name>`` is the module name of users' RTL design.
.. note:: ``<bench_name>`` is the module name of users' RTL design.

.. option:: <bench_name>_include_netlist.v

Expand All @@ -84,14 +84,13 @@ Inside the directory, the Verilog testbenches are organized as illustrated in :n
.. option:: <bench_name>_top_formal_verification.v

This netlist includes a Verilog module of a pre-configured FPGA fabric, which is a wrapper on top of the ``fpga_top.v`` netlist.
The wrapper module has the same port map as the top-level module of user's RTL design, which be directly def to formal verification tools to validate FPGA's functional equivalence.
The wrapper module has the same port map as the top-level module of user's RTL design, which be directly def to formal verification tools to validate FPGA's functional equivalence.
:numref:`fig_preconfig_module` illustrates the organization of a pre-configured module, which consists of a FPGA fabric (see :ref:`fabric_netlists`) and a hard-coded bitstream.
Only used I/Os of FPGA fabric will appear in the port list of the pre-configured module.
Only used I/Os of FPGA fabric will appear in the port list of the pre-configured module.

.. _fig_preconfig_module:

.. figure:: ./figures/preconfig_module.png
:width: 100%

Internal structure of a pre-configured FPGA module

2 changes: 1 addition & 1 deletion docs/source/tutorials/arch_modeling/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A summary of the architectural features is as follows:
- K4N4 Configurable Logic Block (CLB), which consists of four Basic Logic Elements (BLEs) and a fully-connected crossbar. Each BLE contains a 4-input Look-Up Table (LUT), a Flip-Flop (FF) and a 2:1 routing multiplexer
- Length-1 routing wires interconnected by Wilton-Style Switch Block (SB)

The VPR architecture description is designed for EDA needs mainly, which lacks the details physical modelingrequired by OpenFPGA.
The VPR architecture description is designed for EDA needs mainly, which lacks the details physical modeling required by OpenFPGA.
Here, we show a step-by-step adaption on the architecture template.

Physical I/O Modeling
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/getting_started/shell_shortcuts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Once the ``openfpga.sh`` script is sourced, you can run any following commands d

.. option:: clear-task-run <task_name>

Clears all run diretories of the given task
Clears all run directories of the given task

.. option:: run-modelsim <task_name>

Expand Down
2 changes: 1 addition & 1 deletion openfpga.sh
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ goto-task () {
done
}

# Clears enviroment variables and fucntions
# Clears environment variables and functions
unset-openfpga (){
unset -v OPENFPGA_PATH
unset -f list-tasks run-task run-flow goto-task goto-root >/dev/null 2>&1
Expand Down
Loading