All of lore.kernel.org
 help / color / mirror / Atom feed
From: Nicolas Chautru <nicolas.chautru@intel.com>
To: dev@dpdk.org, maxime.coquelin@redhat.com
Cc: hernan.vargas@intel.com, Nicolas Chautru <nicolas.chautru@intel.com>
Subject: [PATCH v1 6/6] doc: updated naming convention for acc200 PMD
Date: Tue, 17 Jan 2023 22:36:42 +0000	[thread overview]
Message-ID: <20230117223642.17618-7-nicolas.chautru@intel.com> (raw)
In-Reply-To: <20230117223642.17618-1-nicolas.chautru@intel.com>

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%)

diff --git a/doc/guides/bbdevs/features/acc200.ini b/doc/guides/bbdevs/features/vrb1.ini
similarity index 83%
rename from doc/guides/bbdevs/features/acc200.ini
rename to doc/guides/bbdevs/features/vrb1.ini
index 7319aea726..0372b656ec 100644
--- a/doc/guides/bbdevs/features/acc200.ini
+++ b/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.
 ;
diff --git a/doc/guides/bbdevs/acc200.rst b/doc/guides/bbdevs/vrb1.rst
similarity index 90%
rename from doc/guides/bbdevs/acc200.rst
rename to doc/guides/bbdevs/vrb1.rst
index 012b3870a8..881ca5443c 100644
--- a/doc/guides/bbdevs/acc200.rst
+++ b/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
 
-- 
2.34.1


  parent reply	other threads:[~2023-01-17 22:40 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-17 22:36 [PATCH v1 0/6] baseband/acc: ACC200 PMD refactor and rename Nicolas Chautru
2023-01-17 22:36 ` [PATCH v1 1/6] baseband/acc: file renaming from acc200 to generic vrb Nicolas Chautru
2023-01-31 14:23   ` Maxime Coquelin
2023-01-17 22:36 ` [PATCH v1 2/6] baseband/acc: extension of the device structure Nicolas Chautru
2023-01-31 14:44   ` Maxime Coquelin
2023-01-17 22:36 ` [PATCH v1 3/6] baseband/acc: adding prefix to VRB1 registers Nicolas Chautru
2023-01-31 14:45   ` Maxime Coquelin
2023-01-17 22:36 ` [PATCH v1 4/6] baseband/acc: update prefix for VRB PMD functions Nicolas Chautru
2023-01-31 14:51   ` Maxime Coquelin
2023-01-17 22:36 ` [PATCH v1 5/6] baseband/acc: rename of remaining acc200 prefix to vrb1 Nicolas Chautru
2023-01-31 15:11   ` Maxime Coquelin
2023-01-17 22:36 ` Nicolas Chautru [this message]
2023-01-31 15:11   ` [PATCH v1 6/6] doc: updated naming convention for acc200 PMD Maxime Coquelin
2023-02-07  8:00     ` David Marchand
2023-02-07  8:08       ` David Marchand
2023-02-03 11:03 ` [PATCH v1 0/6] baseband/acc: ACC200 PMD refactor and rename Maxime Coquelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230117223642.17618-7-nicolas.chautru@intel.com \
    --to=nicolas.chautru@intel.com \
    --cc=dev@dpdk.org \
    --cc=hernan.vargas@intel.com \
    --cc=maxime.coquelin@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.