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

[Tom Rix <trix@redhat.com>]

On 11/3/20 7:58 AM, Chautru, Nicolas wrote:
>
>> -----Original Message-----
>> From: Tom Rix <trix@redhat.com>
>> Sent: Tuesday, November 3, 2020 7:07 AM
>> To: Chautru, Nicolas <nicolas.chautru@intel.com>; dev@dpdk.org;
>> akhil.goyal@nxp.com; thomas@monjalon.net
>> Cc: Mcnamara, John <john.mcnamara@intel.com>;
>> david.marchand@redhat.com; Richardson, Bruce
>> <bruce.richardson@intel.com>; Liu, Tianjiao <tianjiao.liu@intel.com>
>> Subject: Re: [PATCH v2] doc: add reference to companion configuration tool
>>
>>
>> On 11/2/20 12:53 PM, Nicolas Chautru wrote:
>>> 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..b772854 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 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..78c1ce7 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 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
>>> +
>>> +  
>>> + ./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..a1b3e33 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 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
>> From inspection, pf_bb_config does not care about the case of FPGA_lte
> What do you mean?
comparing the call examples in the doc

./pf_bb_config ACC100 -c acc100/acc100_config_vf_5g.cfg
./pf_bb_config FPGA_5GNR -c fpga_5gnr/fpga_5gnr_config_vf.cfg
./pf_bb_config FPGA_lte -c fpga_lte/fpga_lte_config_vf.cfg

For consistency, the last should use FPGA_LTE

Tom

>
>> However for documentation, it is best if these examples are consistent.
>>
>> So this should be
>>
>> ./pf_bb_config FPGA_LTE ...
>>
>> Tom
>>
>>
>>> +  ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64
>>> + -b 32 -l 1 -v ./turbo_dec_default.data