From: Kamil Chalupnik Date: Thu, 26 Apr 2018 14:31:14 +0000 (+0200) Subject: bbdev: change names of baseband devices X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=7ce00bf31bbe;p=dpdk.git bbdev: change names of baseband devices Change baseband device name: - from turbo_sw to baseband_turbo_sw - from bbdev_null to baseband_null To keep backwards compatibility the old names are still valid Signed-off-by: Kamil Chalupnik Acked-by: Amr Mokhtar --- diff --git a/app/test-bbdev/test-bbdev.py b/app/test-bbdev/test-bbdev.py index e3b1e6cf35..acab9eb165 100755 --- a/app/test-bbdev/test-bbdev.py +++ b/app/test-bbdev/test-bbdev.py @@ -33,7 +33,7 @@ parser.add_argument("-p", "--testapp-path", default=dpdk_path + "/" + dpdk_target + "/app/testbbdev") parser.add_argument("-e", "--eal-params", help="EAL arguments which are passed to the test app", - default="--vdev=bbdev_null0") + default="--vdev=baseband_null0") parser.add_argument("-t", "--timeout", type=int, help="Timeout in seconds", diff --git a/doc/guides/bbdevs/null.rst b/doc/guides/bbdevs/null.rst index 9baf2a9979..0b885d17fc 100644 --- a/doc/guides/bbdevs/null.rst +++ b/doc/guides/bbdevs/null.rst @@ -4,7 +4,7 @@ BBDEV null Poll Mode Driver ============================ -The (**bbdev_null**) is a bbdev poll mode driver which provides a minimal +The (**baseband_null**) is a bbdev poll mode driver which provides a minimal implementation of a software bbdev device. As a null device it does not modify the data in the mbuf on which the bbdev operation is to operate and it only works for operation type ``RTE_BBDEV_OP_NONE``. @@ -30,9 +30,9 @@ Initialization To use the PMD in an application, user must: -- Call ``rte_vdev_init("bbdev_null")`` within the application. +- Call ``rte_vdev_init("baseband_null")`` within the application. -- Use ``--vdev="bbdev_null"`` in the EAL options, which will call ``rte_vdev_init()`` internally. +- Use ``--vdev="baseband_null"`` in the EAL options, which will call ``rte_vdev_init()`` internally. The following parameters (all optional) can be provided in the previous two calls: @@ -46,4 +46,4 @@ Example: .. code-block:: console - ./test-bbdev.py -e="--vdev=bbdev_null,socket_id=0,max_nb_queues=8" + ./test-bbdev.py -e="--vdev=baseband_null,socket_id=0,max_nb_queues=8" diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst index 914b9724b3..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. @@ -139,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: @@ -155,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 diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst index 4616594276..b0f44cc0e4 100644 --- a/doc/guides/prog_guide/bbdev.rst +++ b/doc/guides/prog_guide/bbdev.rst @@ -42,13 +42,13 @@ From the command line using the --vdev EAL option .. code-block:: console - --vdev 'turbo_sw,max_nb_queues=8,socket_id=0' + --vdev 'baseband_turbo_sw,max_nb_queues=8,socket_id=0' Our using the rte_vdev_init API within the application code. .. code-block:: c - rte_vdev_init("turbo_sw", "max_nb_queues=2,socket_id=0") + rte_vdev_init("baseband_turbo_sw", "max_nb_queues=2,socket_id=0") All virtual bbdev devices support the following initialization parameters: diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst index f17125da26..653f972f3b 100644 --- a/doc/guides/sample_app_ug/bbdev_app.rst +++ b/doc/guides/sample_app_ug/bbdev_app.rst @@ -31,8 +31,8 @@ Limitations Compiling the Application ------------------------- -#. DPDK needs to be built with ``turbo_sw`` PMD driver enabled along with - ``FLEXRAN SDK`` Libraries. Refer to *SW Turbo Poll Mode Driver* +#. DPDK needs to be built with ``baseband_turbo_sw`` PMD driver enabled along + with ``FLEXRAN SDK`` Libraries. Refer to *SW Turbo Poll Mode Driver* documentation for more details on this. #. Go to the example directory: @@ -84,13 +84,14 @@ issue the command: .. code-block:: console - $ ./build/bbdev --vdev='turbo_sw' -w -c 0x38 --socket-mem=2,2 \ + $ ./build/bbdev --vdev='baseband_turbo_sw' -w -c 0x38 --socket-mem=2,2 \ --file-prefix=bbdev -- -e 0x10 -d 0x20 where, NIC0PCIADDR is the PCI addresse of the Rx port -This command creates one virtual bbdev devices ``turbo_sw`` where the device -gets linked to a corresponding ethernet port as whitelisted by the parameter -w. +This command creates one virtual bbdev devices ``baseband_turbo_sw`` where the +device gets linked to a corresponding ethernet port as whitelisted by +the parameter -w. 3 cores are allocated to the application, and assigned as: - core 3 is the master and used to print the stats live on screen, diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst index 611cf7ef9b..234a64f53c 100644 --- a/doc/guides/tools/testbbdev.rst +++ b/doc/guides/tools/testbbdev.rst @@ -21,7 +21,7 @@ The bbdevice drivers PMD which should be tested can be enabled by setting ``CONFIG_RTE_LIBRTE_PMD_=y`` -Setting example for (*turbo_sw*) PMD +Setting example for (*baseband_turbo_sw*) PMD ``CONFIG_RTE_LIBRTE_PMD_BBDEV_TURBO_SW=y`` @@ -271,21 +271,21 @@ It runs all available tests using the test vector filled based on *turbo_dec_default.data* file. By default number of operations to process on device is set to 32, timeout is set to 300s and operations enqueue/dequeue burst size is set to 32. -Moreover a bbdev (*bbdev_null*) device will be created. +Moreover a bbdev (*baseband_null*) device will be created. -bbdev turbo_sw device -~~~~~~~~~~~~~~~~~~~~~ +baseband turbo_sw device +~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console ./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev - -e="--vdev=turbo_sw" -t 120 -c validation + -e="--vdev=baseband_turbo_sw" -t 120 -c validation -v ./test_vectors/turbo_* -n 64 -b 8 32 It runs **validation** test for each vector file that matches the given pattern. Number of operations to process on device is set to 64 and operations timeout is set to 120s and enqueue/dequeue burst size is set to 8 and to 32. -Moreover a bbdev (*turbo_sw*) device will be created. +Moreover a bbdev (*baseband_turbo_sw*) device will be created. bbdev null device @@ -296,12 +296,12 @@ overhead introduced by the bbdev framework. .. code-block:: console - ./test-bbdev.py -e="--vdev=bbdev_null0" + ./test-bbdev.py -e="--vdev=baseband_null0" -v ./test_vectors/bbdev_null.data **Note:** -bbdev_null device does not have to be defined explicitly as it is created by default. +baseband_null device does not have to be defined explicitly as it is created by default. diff --git a/drivers/baseband/null/bbdev_null.c b/drivers/baseband/null/bbdev_null.c index e8e541f89e..76fc9d7ace 100644 --- a/drivers/baseband/null/bbdev_null.c +++ b/drivers/baseband/null/bbdev_null.c @@ -13,7 +13,7 @@ #include #include -#define DRIVER_NAME bbdev_null +#define DRIVER_NAME baseband_null /* NULL BBDev logging ID */ static int bbdev_null_logtype; @@ -346,6 +346,7 @@ RTE_PMD_REGISTER_VDEV(DRIVER_NAME, bbdev_null_pmd_drv); RTE_PMD_REGISTER_PARAM_STRING(DRIVER_NAME, BBDEV_NULL_MAX_NB_QUEUES_ARG"= " BBDEV_NULL_SOCKET_ID_ARG"="); +RTE_PMD_REGISTER_ALIAS(DRIVER_NAME, bbdev_null); RTE_INIT(null_bbdev_init_log); static void diff --git a/drivers/baseband/turbo_sw/bbdev_turbo_software.c b/drivers/baseband/turbo_sw/bbdev_turbo_software.c index b816a7f5cd..d3e51038ab 100644 --- a/drivers/baseband/turbo_sw/bbdev_turbo_software.c +++ b/drivers/baseband/turbo_sw/bbdev_turbo_software.c @@ -19,7 +19,7 @@ #include #include -#define DRIVER_NAME turbo_sw +#define DRIVER_NAME baseband_turbo_sw /* Turbo SW PMD logging ID */ static int bbdev_turbo_sw_logtype; @@ -1297,6 +1297,7 @@ RTE_PMD_REGISTER_VDEV(DRIVER_NAME, bbdev_turbo_sw_pmd_drv); RTE_PMD_REGISTER_PARAM_STRING(DRIVER_NAME, TURBO_SW_MAX_NB_QUEUES_ARG"= " TURBO_SW_SOCKET_ID_ARG"="); +RTE_PMD_REGISTER_ALIAS(DRIVER_NAME, turbo_sw); RTE_INIT(null_bbdev_init_log); static void