[v1,6/6] doc: updated naming convention for acc200 PMD
Checks
Commit Message
The documentation for the Intel vRAN Boost PMD
is being updated in term of filename and content
to match with new branding and product name.
Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
.../bbdevs/features/{acc200.ini => vrb1.ini} | 2 +-
doc/guides/bbdevs/{acc200.rst => vrb1.rst} | 33 ++++++++++---------
2 files changed, 18 insertions(+), 17 deletions(-)
rename doc/guides/bbdevs/features/{acc200.ini => vrb1.ini} (83%)
rename doc/guides/bbdevs/{acc200.rst => vrb1.rst} (90%)
Comments
On 1/17/23 23:36, Nicolas Chautru wrote:
> The documentation for the Intel vRAN Boost PMD
> is being updated in term of filename and content
> to match with new branding and product name.
>
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> ---
> .../bbdevs/features/{acc200.ini => vrb1.ini} | 2 +-
> doc/guides/bbdevs/{acc200.rst => vrb1.rst} | 33 ++++++++++---------
> 2 files changed, 18 insertions(+), 17 deletions(-)
> rename doc/guides/bbdevs/features/{acc200.ini => vrb1.ini} (83%)
> rename doc/guides/bbdevs/{acc200.rst => vrb1.rst} (90%)
>
Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Thanks,
Maxime
Hello,
On Tue, Jan 31, 2023 at 4:12 PM Maxime Coquelin
<maxime.coquelin@redhat.com> wrote:
> On 1/17/23 23:36, Nicolas Chautru wrote:
> > The documentation for the Intel vRAN Boost PMD
> > is being updated in term of filename and content
> > to match with new branding and product name.
> >
> > Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> > ---
> > .../bbdevs/features/{acc200.ini => vrb1.ini} | 2 +-
> > doc/guides/bbdevs/{acc200.rst => vrb1.rst} | 33 ++++++++++---------
> > 2 files changed, 18 insertions(+), 17 deletions(-)
> > rename doc/guides/bbdevs/features/{acc200.ini => vrb1.ini} (83%)
> > rename doc/guides/bbdevs/{acc200.rst => vrb1.rst} (90%)
> >
>
> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Guys, the CI failure was obvious, but it seems nobody looked at it...
http://mails.dpdk.org/archives/test-report/2023-January/341526.html
[122/716] Generating html_guides with a custom command.
FAILED: doc/guides/html
/usr/bin/python3 ../buildtools/call-sphinx-build.py
/usr/bin/sphinx-build 23.03.0-rc0
/home/runner/work/dpdk/dpdk/doc/guides
/home/runner/work/dpdk/dpdk/build/doc/guides -W
Warning, treated as error:
/home/runner/work/dpdk/dpdk/doc/guides/bbdevs/index.rst:7:toctree
contains reference to nonexisting document 'bbdevs/acc200'
[123/716] Compiling C object 'examples/c590b3c@@dpdk-l2fwd-jobstats at
exe/l2fwd-jobstats_main.c.o'.
[124/716] Compiling C object 'examples/c590b3c@@dpdk-l2fwd-crypto at
exe/l2fwd-crypto_main.c.o'.
ninja: build stopped: subcommand failed.
I'll send a fix quickly.
On Tue, Feb 7, 2023 at 9:00 AM David Marchand <david.marchand@redhat.com> wrote:
>
> Hello,
>
> On Tue, Jan 31, 2023 at 4:12 PM Maxime Coquelin
> <maxime.coquelin@redhat.com> wrote:
> > On 1/17/23 23:36, Nicolas Chautru wrote:
> > > The documentation for the Intel vRAN Boost PMD
> > > is being updated in term of filename and content
> > > to match with new branding and product name.
> > >
> > > Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> > > ---
> > > .../bbdevs/features/{acc200.ini => vrb1.ini} | 2 +-
> > > doc/guides/bbdevs/{acc200.rst => vrb1.rst} | 33 ++++++++++---------
> > > 2 files changed, 18 insertions(+), 17 deletions(-)
> > > rename doc/guides/bbdevs/features/{acc200.ini => vrb1.ini} (83%)
> > > rename doc/guides/bbdevs/{acc200.rst => vrb1.rst} (90%)
> > >
> >
> > Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
>
> Guys, the CI failure was obvious, but it seems nobody looked at it...
>
> http://mails.dpdk.org/archives/test-report/2023-January/341526.html
>
> [122/716] Generating html_guides with a custom command.
> FAILED: doc/guides/html
> /usr/bin/python3 ../buildtools/call-sphinx-build.py
> /usr/bin/sphinx-build 23.03.0-rc0
> /home/runner/work/dpdk/dpdk/doc/guides
> /home/runner/work/dpdk/dpdk/build/doc/guides -W
>
> Warning, treated as error:
> /home/runner/work/dpdk/dpdk/doc/guides/bbdevs/index.rst:7:toctree
> contains reference to nonexisting document 'bbdevs/acc200'
> [123/716] Compiling C object 'examples/c590b3c@@dpdk-l2fwd-jobstats at
> exe/l2fwd-jobstats_main.c.o'.
> [124/716] Compiling C object 'examples/c590b3c@@dpdk-l2fwd-crypto at
> exe/l2fwd-crypto_main.c.o'.
> ninja: build stopped: subcommand failed.
Looking closer, Maxime had fixed this first issue, but it was hiding
another one.
/usr/bin/python3 ../buildtools/call-sphinx-build.py
/usr/bin/sphinx-build 23.03.0-rc0
/home/runner/work/dpdk/dpdk/doc/guides
/home/runner/work/dpdk/dpdk/build/doc/guides -W
Warning, treated as error:
/home/runner/work/dpdk/dpdk/doc/guides/rel_notes/release_22_11.rst:222:unknown
document: ../bbdevs/acc200
[130/718] Compiling C object
'examples/c590b3c@@dpdk-l3fwd-power@exe/l3fwd-power_main.c.o'.
[131/718] Compiling C object
'examples/c590b3c@@dpdk-link_status_interrupt@exe/link_status_interrupt_main.c.o'.
similarity index 83%
rename from doc/guides/bbdevs/features/acc200.ini
rename to doc/guides/bbdevs/features/vrb1.ini
@@ -1,5 +1,5 @@
;
-; Supported features of the 'acc200' bbdev driver.
+; Supported features of the 'intel vran boost' bbdev driver.
;
; Refer to default.ini for the full list of available PMD features.
;
similarity index 90%
rename from doc/guides/bbdevs/acc200.rst
rename to doc/guides/bbdevs/vrb1.rst
@@ -3,39 +3,39 @@
.. include:: <isonum.txt>
-Intel\ |reg| ACC200 vRAN Dedicated Accelerator Poll Mode Driver
-===============================================================
+Intel\ |reg| vRAN Boost Poll Mode Driver (PMD)
+==============================================
-The Intel\ |reg| vRAN Dedicated Accelerator ACC200 peripheral enables
+The Intel\ |reg| vRAN Boost integrated accelerator enables
cost-effective 4G and 5G next-generation virtualized Radio Access Network (vRAN)
-solutions integrated on Sapphire Rapids Edge Enhanced Processor (SPR-EE)
-Intel\ |reg| 7 based Xeon\ |reg| multi-core server processor.
-
+solutions.
+The Intel vRAN Boost v1.0 (VRB1 in the code) is specifically integrated on the
+4th Gen Intel\ |reg| Xeon\ |reg| Scalable processor with Intel\ |reg| vRAN Boost,
+also known as Sapphire Rapids Edge Enhanced (SPR-EE).
Features
--------
-The ACC200 includes a 5G Low Density Parity Check (LDPC) encoder/decoder,
+Intel vRAN Boost v1.0 includes a 5G Low Density Parity Check (LDPC) encoder/decoder,
rate match/dematch, Hybrid Automatic Repeat Request (HARQ) with access to DDR
memory for buffer management, a 4G Turbo encoder/decoder,
a Fast Fourier Transform (FFT) block providing DFT/iDFT processing offload
for the 5G Sounding Reference Signal (SRS), a Queue Manager (QMGR),
and a DMA subsystem.
-There is no dedicated on-card memory for HARQ,
-this is using coherent memory on the CPU side.
+There is no dedicated on-card memory for HARQ, the coherent memory on the CPU side is being used.
-These correspond to the following features exposed by the PMD:
+These hardware blocks provide the following features exposed by the PMD:
- LDPC Encode in the Downlink (5GNR)
- LDPC Decode in the Uplink (5GNR)
- Turbo Encode in the Downlink (4G)
- Turbo Decode in the Uplink (4G)
- FFT processing
-- SR-IOV with 16 VFs per PF
+- Single Root I/O Virtualization (SR-IOV) with 16 Virtual Functions (VFs) per Physical Function (PF)
- Maximum of 256 queues per VF
-- MSI
+- Message Signaled Interrupts (MSIs)
-ACC200 PMD supports the following bbdev capabilities:
+The Intel vRAN Boost v1.0 PMD supports the following bbdev capabilities:
* For the LDPC encode operation:
- ``RTE_BBDEV_LDPC_CRC_24B_ATTACH``: set to attach CRC24B to CB(s).
@@ -104,7 +104,7 @@ Initialization
--------------
When the device first powers up, its PCI Physical Functions (PF)
-can be listed through these commands for ACC200:
+can be listed through these commands for VRB1:
.. code-block:: console
@@ -123,7 +123,7 @@ Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
The igb_uio driver may be bound to the PF PCI device using one of two methods
-for ACC200:
+for VRB1:
#. PCI functions (physical or virtual, depending on the use case) can be bound
to the UIO driver by repeating this command for every function.
@@ -252,7 +252,8 @@ 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 ACC200 PMD, the command below can be used:
+Specifically for the bbdev VRB1 PMD, the command below can be used (note that ACC200 was used
+prevously to refer to VRB1):
.. code-block:: console