X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fbbdevs%2Fturbo_sw.rst;h=9661a306f998b0da36ffbeadc95d2d970f471b10;hb=241da076b1f75d9ea485848bccee7e4fd0ab2838;hp=7448dc997bb47cbc279ffb9dd0d47a84ef14f259;hpb=795ae2df4d7e853c8d997f1b0a2ee8bcfbbc0795;p=dpdk.git diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst index 7448dc997b..9661a306f9 100644 --- a/doc/guides/bbdevs/turbo_sw.rst +++ b/doc/guides/bbdevs/turbo_sw.rst @@ -4,7 +4,7 @@ SW Turbo Poll Mode Driver ========================= -The SW Turbo PMD (**turbo_sw**) provides a poll mode bbdev driver that utilizes +The SW Turbo PMD (**baseband_turbo_sw**) provides a poll mode bbdev driver that utilizes Intel optimized libraries for LTE Layer 1 workloads acceleration. This PMD supports the functions: Turbo FEC, Rate Matching and CRC functions. @@ -41,7 +41,7 @@ Installation FlexRAN SDK Download ~~~~~~~~~~~~~~~~~~~~ -To build DPDK with the *turbo_sw* PMD the user is required to download +To build DPDK with the *baseband_turbo_sw* PMD the user is required to download the export controlled ``FlexRAN SDK`` Libraries. An account at `Intel Resource Design Center `_ needs to be registered. @@ -98,6 +98,14 @@ The following instructions should be followed in this exact order: cd /FlexRAN-1.4.0/SDK-R1.4.0/sdk/ ./create-makefiles-linux.sh +#. If build as a shared library is required, then add ``"-fPIC"`` option to file + ``/FlexRAN-1.4.0/SDK-R1.4.0/sdk/cmake/intel-compile-options.cmake`` + as follows: + + .. code-block:: console + + add_compile_options("-fPIC") + #. A build folder is generated in this form ``build--``, enter that folder and install: @@ -131,9 +139,9 @@ Example: To use the PMD in an application, user must: -- Call ``rte_vdev_init("turbo_sw")`` within the application. +- Call ``rte_vdev_init("baseband_turbo_sw")`` within the application. -- Use ``--vdev="turbo_sw"`` in the EAL options, which will call ``rte_vdev_init()`` internally. +- Use ``--vdev="baseband_turbo_sw"`` in the EAL options, which will call ``rte_vdev_init()`` internally. The following parameters (all optional) can be provided in the previous two calls: @@ -147,5 +155,5 @@ Example: .. code-block:: console - ./test-bbdev.py -e="--vdev=turbo_sw,socket_id=0,max_nb_queues=8" \ + ./test-bbdev.py -e="--vdev=baseband_turbo_sw,socket_id=0,max_nb_queues=8" \ -c validation -v ./test_vectors/bbdev_vector_t?_default.data