X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Ftools%2Ftestbbdev.rst;h=7e6a4db2e0c0015588aafb1978d6e03fa6b06345;hb=739a6674ab943a762cb5e9a7b82cc344ee5c1467;hp=234a64f53cee75ff5c675b95219b8e3e5deb5410;hpb=7ce00bf31bbe8c5566d53d6149354f5f12613048;p=dpdk.git diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst index 234a64f53c..7e6a4db2e0 100644 --- a/doc/guides/tools/testbbdev.rst +++ b/doc/guides/tools/testbbdev.rst @@ -62,7 +62,8 @@ The following are the command-line options: ``-e EAL_PARAMS, --eal_params EAL_PARAMS`` Specifies EAL arguments which are passed to the test app. For more details, - refer to DPDK documentation at http://dpdk.org/doc. + refer to DPDK documentation at + http://doc.dpdk.org/guides/linux_gsg/linux_eal_parameters.html. ``-t TIMEOUT, --timeout TIMEOUT`` Specifies timeout in seconds. If not specified timeout is set to 300 seconds. @@ -138,7 +139,7 @@ There are 6 main test cases that can be executed using testbbdev tool: * Latency measurement [-c latency] - Measures the time consumed from the first enqueue until the first appearance of a dequeued result - - This measurment represents the full latency of a bbdev operation + - This measurement represents the full latency of a bbdev operation (encode or decode) to execute * Poll-mode Throughput measurement [-c throughput] @@ -226,7 +227,7 @@ Running Tests ------------- Shortened tree of isg_cid-wireless_dpdk_ae with dpdk compiled for -x86_64-native-linuxapp-icc target: +x86_64-native-linux-icc target: :: @@ -255,7 +256,7 @@ x86_64-native-linuxapp-icc target: |-- turbo_enc_c1_k40_r0_e1194_rm.data |-- turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data - |-- x86_64-native-linuxapp-icc + |-- x86_64-native-linux-icc |-- app |-- testbbdev @@ -264,7 +265,7 @@ All bbdev devices .. code-block:: console - ./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev + ./test-bbdev.py -p ../../x86_64-native-linux-icc/app/testbbdev -v turbo_dec_default.data It runs all available tests using the test vector filled based on @@ -278,7 +279,7 @@ baseband turbo_sw device .. code-block:: console - ./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev + ./test-bbdev.py -p ../../x86_64-native-linux-icc/app/testbbdev -e="--vdev=baseband_turbo_sw" -t 120 -c validation -v ./test_vectors/turbo_* -n 64 -b 8 32 @@ -306,7 +307,7 @@ baseband_null device does not have to be defined explicitly as it is created by Test Vector files -================= +----------------- Test Vector files contain the data which is used to set turbo decoder/encoder parameters and buffers for validation purpose. New test vector files should be @@ -315,7 +316,7 @@ the syntax of the test vector files is in the following section. Basic principles for test vector files --------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Line started with ``#`` is treated as a comment and is ignored. If variable is a chain of values, values should be separated by a comma. If @@ -350,7 +351,7 @@ documented in *rte_bbdev_op.h* Turbo decoder test vectors template ------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For turbo decoder it has to be always set to ``RTE_BBDEV_OP_TURBO_DEC`` @@ -527,7 +528,7 @@ Following statuses can be used: Turbo encoder test vectors template ------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For turbo encoder it has to be always set to ``RTE_BBDEV_OP_TURBO_ENC``