[dpdk-dev] [PATCH] doc: add reference to bbdev companion configuration tool

[dpdk-dev] [PATCH] doc: add reference to bbdev companion configuration tool

[Nicolas Chautru]

Adding reference to companion tool to perform PF device configuration
of HW bbdev devices : pf_bb_config
This topic was previously discussed in https://patches.dpdk.org/patch/74270/
and it was preferred for the tool to be be upstreamed outside of DPDK
in github.
This dependency notably allows to run the bbdev workload from VF.
Kept this as a single commit affecting the 3 distinct docs.

Nicolas Chautru (1):
  doc: add reference to companion configuration tool

 doc/guides/bbdevs/acc100.rst        | 19 +++++++++++++++++++
 doc/guides/bbdevs/fpga_5gnr_fec.rst | 19 +++++++++++++++++++
 doc/guides/bbdevs/fpga_lte_fec.rst  | 19 +++++++++++++++++++
 3 files changed, 57 insertions(+)

-- 
1.8.3.1

[dpdk-dev] [PATCH] doc: add reference to companion configuration tool

[Nicolas Chautru]

Adding reference to pf_bb_config in github to do
device configuration of the fpga_5gnr, fpga_lte and
acc100 devices and pmds.

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
 doc/guides/bbdevs/acc100.rst        | 19 +++++++++++++++++++
 doc/guides/bbdevs/fpga_5gnr_fec.rst | 19 +++++++++++++++++++
 doc/guides/bbdevs/fpga_lte_fec.rst  | 19 +++++++++++++++++++
 3 files changed, 57 insertions(+)

diff --git a/doc/guides/bbdevs/acc100.rst b/doc/guides/bbdevs/acc100.rst
index 7a23c16..3cbdabf 100644
--- a/doc/guides/bbdevs/acc100.rst
+++ b/doc/guides/bbdevs/acc100.rst
@@ -223,3 +223,22 @@ In addition to the simple LDPC decoder and LDPC encoder tests, bbdev also provid
 a range of additional tests under the test_vectors folder, which may be useful. The results
 of these tests will depend on the ACC100 5G/4G FEC capabilities which may cause some
 testcases to be skipped, but no failure should be reported.
+
+
+Alternate Baseband Device configuration tool
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On top of the embedded configuration feature supported in test-bbdev using "- -init-device"
+option mentioned above, there is also a tool available to perform that device configuration
+using a companion application.
+The ``pf_bb_config`` application notably enables then to run bbdev-test from the VF
+and not only limited to the the PF as captured above.
+
+See for more details: https://github.com/intel/pf-bb-config
+
+Specifically for the BBDEV ACC100 PMD, the command below can be used:
+
+.. code-block:: console
+
+  ./pf_bb_config ACC100 -c acc100/acc100_config_vf_5g.cfg
+  ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst b/doc/guides/bbdevs/fpga_5gnr_fec.rst
index 61c19c3..58ea141 100644
--- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
+++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
@@ -286,3 +286,22 @@ Test Vectors
 In addition to the simple LDPC decoder and LDPC encoder tests, bbdev also provides
 a range of additional tests under the test_vectors folder, which may be useful. The results
 of these tests will depend on the FPGA 5GNR FEC capabilities.
+
+
+Alternate Baseband Device configuration tool
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On top of the embedded configuration feature supported in test-bbdev using "- -init-device"
+option, there is also a tool available to perform that device configuration using a companion
+application.
+The ``pf_bb_config`` application notably enables then to run bbdev-test from the VF
+and not only limited to the the PF as captured above.
+
+See for more details: https://github.com/intel/pf-bb-config
+
+Specifically for the BBDEV FPGA 5GNR FEC PMD, the command below can be used:
+
+.. code-block:: console
+
+  ./pf_bb_config FPGA_5GNR -c fpga_5gnr/fpga_5gnr_config_vf.cfg
+  ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst b/doc/guides/bbdevs/fpga_lte_fec.rst
index 9d64e15..7bfd628 100644
--- a/doc/guides/bbdevs/fpga_lte_fec.rst
+++ b/doc/guides/bbdevs/fpga_lte_fec.rst
@@ -305,3 +305,22 @@ of these tests will depend on the FPGA LTE FEC capabilities:
    - ``turbo_enc_c2_k5952_r0_e17868_crc24b.data``
    - ``turbo_enc_c3_k4800_r2_e14412_crc24b.data``
    - ``turbo_enc_c4_k4800_r2_e14412_crc24b.data``
+
+
+Alternate Baseband Device configuration tool
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On top of the embedded configuration feature supported in test-bbdev using "- -init-device"
+option, there is also a tool available to perform that device configuration using a companion
+application.
+The ``pf_bb_config`` application notably enables then to run bbdev-test from the VF
+and not only limited to the the PF as captured above.
+
+See for more details: https://github.com/intel/pf-bb-config
+
+Specifically for the BBDEV FPGA LTE FEC PMD, the command below can be used:
+
+.. code-block:: console
+
+  ./pf_bb_config FPGA_lte -c fpga_lte/fpga_lte_config_vf.cfg
+  ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./turbo_dec_default.data
-- 
1.8.3.1