Semi-automated cleanup of wording of bbdev sample guide. Refactored the bbdev sample application documentation for better clarity: - Simplified the overview section with clearer flow description - Improved formatting of command-line options using definition list - Clarified hardware/software device requirements - Enhanced example command explanation with bullet points - Fixed grammatical issues and improved readability
Signed-off-by: Stephen Hemminger <[email protected]> --- doc/guides/sample_app_ug/bbdev_app.rst | 69 +++++++++++++------------- 1 file changed, 34 insertions(+), 35 deletions(-) diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst index a699e8a61d..00bbd1aa27 100644 --- a/doc/guides/sample_app_ug/bbdev_app.rst +++ b/doc/guides/sample_app_ug/bbdev_app.rst @@ -14,14 +14,13 @@ Overview -------- The Baseband device sample application performs a loop-back operation using a -baseband device capable of transceiving data packets. -A packet is received on an ethernet port -> enqueued for downlink baseband -operation -> dequeued from the downlink baseband device -> enqueued for uplink -baseband operation -> dequeued from the baseband device -> then the received -packet is compared with the baseband operations output. Then it's looped back to -the ethernet port. +baseband device capable of performing encoding and decoding operations. +A packet is received on an Ethernet port, enqueued for downlink baseband +operation, dequeued from the downlink baseband device, enqueued for uplink +baseband operation, dequeued from the baseband device, compared with the +expected output, and then transmitted back to the Ethernet port. -* The MAC header is preserved in the packet +The MAC header is preserved in the packet throughout the loop-back operation. Limitations ----------- @@ -33,7 +32,7 @@ Compiling the Application DPDK needs to be built with ``baseband_turbo_sw`` PMD enabled along with ``FLEXRAN SDK`` Libraries. Refer to *SW Turbo Poll Mode Driver* -documentation for more details on this. +documentation for more details. To compile the sample application see :doc:`compiling`. @@ -48,40 +47,41 @@ The application accepts a number of command line options: $ ./<build_dir>/examples/dpdk-bbdev [EAL options] -- [-e ENCODING_CORES] / [-d DECODING_CORES] [-p ETH_PORT_ID] [-b BBDEV_ID] -where: +Where: + +``-e ENCODING_CORES`` + Hexadecimal bitmask specifying lcores for encoding operations (default: 0x2). + +``-d DECODING_CORES`` + Hexadecimal bitmask specifying lcores for decoding operations (default: 0x4). -* ``e ENCODING_CORES``: hexmask for encoding lcores (default = 0x2) -* ``d DECODING_CORES``: hexmask for decoding lcores (default = 0x4) -* ``p ETH_PORT_ID``: ethernet port ID (default = 0) -* ``b BBDEV_ID``: BBDev ID (default = 0) +``-p ETH_PORT_ID`` + Ethernet port ID (default: 0). -The application requires that baseband devices is capable of performing -the specified baseband operation are available on application initialization. -This means that HW baseband device/s must be bound to a DPDK driver or -a SW baseband device/s (virtual BBdev) must be created (using --vdev). +``-b BBDEV_ID`` + Baseband device ID (default: 0). -To run the application in linux environment with the turbo_sw baseband device -using the allow option for pci device running on 1 encoding lcore and 1 decoding lcore -issue the command: +The application requires that baseband devices are capable of performing +the specified baseband operations at initialization time. Hardware baseband +devices must be bound to a DPDK driver, or software baseband devices (virtual +BBdev) must be created using the ``--vdev`` option. + +To run the application in a Linux environment with the turbo_sw baseband device, +using one encoding lcore and one decoding lcore: .. code-block:: console $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a <NIC0PCIADDR> \ -l 3,4,5 --numa-mem=2,2 --file-prefix=bbdev -- -e 0x10 -d 0x20 -where, NIC0PCIADDR is the PCI address of the Rx port - -This command creates one virtual bbdev devices ``baseband_turbo_sw`` where the -device gets linked to a corresponding ethernet port as allowed by -the parameter -a. -3 cores are allocated to the application, and assigned as: - - - core 3 is the main and used to print the stats live on screen, +Where ``NIC0PCIADDR`` is the PCI address of the Ethernet port. - - core 4 is the encoding lcore performing Rx and Turbo Encode operations +This command creates one virtual BBdev device (``baseband_turbo_sw``) and +allows access to the specified Ethernet port. Three cores are allocated: - - core 5 is the downlink lcore performing Turbo Decode, validation and Tx - operations +- Core 3: Main lcore, prints statistics to screen +- Core 4: Encoding lcore, performs Rx and Turbo Encode operations +- Core 5: Decoding lcore, performs Turbo Decode, validation, and Tx operations Refer to the *DPDK Getting Started Guide* for general information on running @@ -91,9 +91,8 @@ Using Packet Generator with baseband device sample application -------------------------------------------------------------- To allow the bbdev sample app to do the loopback, an influx of traffic is required. -This can be done by using DPDK Pktgen to burst traffic on two ethernet ports, and -it will print the transmitted along with the looped-back traffic on Rx ports. -Executing the command below will generate traffic on the two allowed ethernet +This can be done using DPDK Pktgen to generate traffic on Ethernet ports. +Executing the command below will generate traffic on the allowed Ethernet ports. .. code-block:: console @@ -111,5 +110,5 @@ where: * ``-P``: PROMISCUOUS mode -Refer to *The Pktgen Application* documents for general information on running +Refer to *The Pktgen Application* documentation for general information on running Pktgen with DPDK applications. -- 2.53.0
