Skip to content

Commit a6d4f64

Browse files
authored
[doc] Remove -DBLOCK_ON_FAULT from doc since Block on Fault cannot be enabled/disabled through this build option (#638)
* [doc] remove block_on_fault from build option list * [doc] add usage of accel_conf.py to change BOF * [doc] add usage of accel-config
1 parent f0f1d75 commit a6d4f64

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

doc/source/documentation/get_started_docs/installation.rst

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ With configuration files found at either ``<qpl-library>/tools/configs/`` or ``<
6666
With configuration files of the format ``<# nodes>n<# devices>d<# engines>e<# of workqueues>w-s.conf`` or
6767
``<# nodes>n<# devices>d<# engines>e<# of workqueues>w-s-n<which node>.conf``.
6868

69+
Alternatively, users can use the following commands to directly configure the device with the ``accel-config``:
70+
71+
.. code-block:: shell
72+
73+
sudo accel-config load-config -c <config file>
74+
sudo accel-config enable-device <device>
75+
sudo accel-config enable-wq <device>/<wq>
76+
6977
.. attention::
7078

7179
Sudo privileges are required to configure Intel® IAA instance.
@@ -74,13 +82,11 @@ With configuration files of the format ``<# nodes>n<# devices>d<# engines>e<# of
7482

7583
By default, Intel® QPL uses the ``Block On Fault`` feature
7684
required to handle page faults on the Intel® IAA side. The
77-
``block on fault`` flag must be set with the ``accel-config`` for each
78-
device. Performance can be increased if an application performs its own
79-
``pre-faulting``. In this case, the ``block on fault`` flag is
80-
not required and the ``Block On Fault`` feature must be disabled with the
81-
CMake build option ``-DBLOCK_ON_FAULT=OFF`` (see the
82-
:ref:`building_library_build_reference_link` and
83-
:ref:`building_library_build_options_reference_link` sections).
85+
``block_on_fault`` attribute must be set with the ``accel-config`` for each
86+
work queue. Performance of Hardware Path applications can be increased if the application performs
87+
its own ``pre-faulting``. In this case, the ``Block On Fault`` feature must be disabled with the ``accel-config``
88+
by setting the ``block_on_fault`` attribute to ``0``. Users need to add ``"block_on_fault":0`` in the configuration file
89+
(refer to the configuration files mentioned above).
8490

8591
.. _building_library_reference_link:
8692

@@ -156,13 +162,6 @@ Intel QPL supports the following build options:
156162
- ``-DLOG_HW_INIT=[ON|OFF]`` - Enables hardware initialization log (``OFF`` by default).
157163
- ``-DEFFICIENT_WAIT=[ON|OFF]`` - Enables usage of efficient wait instructions (``OFF`` by default).
158164
- ``-DLIB_FUZZING_ENGINE=[ON|OFF]`` - Enables fuzz testing (``OFF`` by default).
159-
- ``-DBLOCK_ON_FAULT=[OFF|ON]`` - Disables Page Fault Processing on the accelerator side (``ON`` by default).
160-
161-
.. note::
162-
163-
The value of ``BLOCK_ON_FAULT`` can affect the performance of hardware path
164-
applications. Read more in the :ref:`accelerator_configuration_reference_link` section.
165-
166165
- ``-DQPL_BUILD_EXAMPLES=[OFF|ON]`` - Enables building library examples (``ON`` by default).
167166
For more information on existing examples, see :ref:`code_examples_c_reference_link`.
168167

0 commit comments

Comments
 (0)