[v3,20/37] doc: remove references to make in bbdev guides

Message ID 20200903152717.42095-21-ciara.power@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series remove make support in DPDK |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Power, Ciara Sept. 3, 2020, 3:27 p.m. UTC
  Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
Signed-off-by: Ciara Power <ciara.power@intel.com>
---
 doc/guides/bbdevs/fpga_5gnr_fec.rst |  7 ++-----
 doc/guides/bbdevs/fpga_lte_fec.rst  |  7 ++-----
 doc/guides/bbdevs/turbo_sw.rst      | 15 ---------------
 3 files changed, 4 insertions(+), 25 deletions(-)
  

Comments

Chautru, Nicolas Sept. 4, 2020, 1:35 a.m. UTC | #1
> From: Power, Ciara <ciara.power@intel.com>
> 
> Make is no longer supported for compiling DPDK, references are now removed
> in the documentation.
> 
> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> ---
>  doc/guides/bbdevs/fpga_5gnr_fec.rst |  7 ++-----
> doc/guides/bbdevs/fpga_lte_fec.rst  |  7 ++-----
>  doc/guides/bbdevs/turbo_sw.rst      | 15 ---------------
>  3 files changed, 4 insertions(+), 25 deletions(-)
> 
> diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> index 6760391e8c..8e00c4ef22 100644
> --- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> +++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> @@ -51,10 +51,7 @@ FPGA 5GNR FEC does not support the following:
>  Installation
>  ------------
> 
> -Section 3 of the DPDK manual provides instructions on installing and compiling
> DPDK. The -default set of bbdev compile flags may be found in
> config/common_base, where for example -the flag to build the FPGA 5GNR FEC
> device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_5GNR_FEC``,
> -is already set.
> +Section 3 of the DPDK manual provides instructions on installing and compiling
> DPDK.
> 
>  DPDK requires hugepages to be configured as detailed in section 2 of the DPDK
> manual.
>  The bbdev test application has been tested with a configuration 40 x 1GB
> hugepages. The @@ -94,7 +91,7 @@ the UIO driver by repeating this
> command for every function.
>  .. code-block:: console
> 
>    cd <dpdk-top-level-directory>
> -  insmod ./build/kmod/igb_uio.ko
> +  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
>    echo "8086 0d8f" > /sys/bus/pci/drivers/igb_uio/new_id
>    lspci -vd8086:0d8f
> 
> diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst
> b/doc/guides/bbdevs/fpga_lte_fec.rst
> index fdc8a76981..14ffa0ee14 100644
> --- a/doc/guides/bbdevs/fpga_lte_fec.rst
> +++ b/doc/guides/bbdevs/fpga_lte_fec.rst
> @@ -50,10 +50,7 @@ FPGA LTE FEC does not support the following:
>  Installation
>  --------------
> 
> -Section 3 of the DPDK manual provides instructions on installing and compiling
> DPDK. The -default set of bbdev compile flags may be found in
> config/common_base, where for example -the flag to build the FPGA LTE FEC
> device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC``, is already -set.
> +Section 3 of the DPDK manual provides instructions on installing and compiling
> DPDK.
> 
>  DPDK requires hugepages to be configured as detailed in section 2 of the DPDK
> manual.
>  The bbdev test application has been tested with a configuration 40 x 1GB
> hugepages. The @@ -93,7 +90,7 @@ the UIO driver by repeating this
> command for every function.
>  .. code-block:: console
> 
>    cd <dpdk-top-level-directory>
> -  insmod ./build/kmod/igb_uio.ko
> +  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
>    echo "1172 5052" > /sys/bus/pci/drivers/igb_uio/new_id
>    lspci -vd1172:
> 
> diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst
> index 20620c2e20..3b93157890 100644
> --- a/doc/guides/bbdevs/turbo_sw.rst
> +++ b/doc/guides/bbdevs/turbo_sw.rst
> @@ -12,14 +12,6 @@ Note that the driver can also be built without any
> dependency with reduced  functionality for maintenance purpose.
> 
>  To enable linking to the SDK libraries see detailed installation section below.
> -Two flags can be enabled depending on whether the target machine can
> support
> -AVX2 and AVX512 instructions sets and the related SDK libraries for vectorized
> -signal processing functions are installed :
> -- CONFIG_RTE_BBDEV_SDK_AVX2
> -- CONFIG_RTE_BBDEV_SDK_AVX512
> -By default these 2 flags are disabled by default. For AVX2 machine and SDK -
> library installed then the first flag can be enabled. For AVX512 machine and -
> SDK library installed then both flags can be enabled for full real time capability.
> 
>  This PMD supports the functions: FEC, Rate Matching and CRC functions
> detailed  in the Features section.
> @@ -151,13 +143,6 @@ Example:
>      export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-
> 04/sdk/build-avx2-icc/install
>      export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-
> 04/sdk/build-avx2-icc/
> 
> -* Set ``CONFIG_RTE_BBDEV_SDK_AVX2=y`` and
> ``CONFIG_RTE_BBDEV_SDK_AVX512=y``
> -  in DPDK common configuration file ``config/common_base`` to be able to use
> -  the SDK libraries as mentioned above.
> -  For AVX2 machine it is possible to only enable
> CONFIG_RTE_BBDEV_SDK_AVX2
> -  for limited 4G functionality.
> -  If no flag are set the PMD driver will still build but its capabilities
> -  will be limited accordingly.

Hi, 
This section needs to be replaced to match with the actual steps for meson: 

Initialization
--------------

In order to enable this virtual bbdev PMD, the user may:

* Build the ``FLEXRAN SDK`` libraries (explained in Installation section).

* Export the environmental variables ``FLEXRAN_SDK`` to the path where the
  FlexRAN SDK libraries were installed. And ``DIR_WIRELESS_SDK`` to the path
  where the libraries were extracted.

* Tune the meson build option pointing the location of the FlexRAN SDK libraries ``flexran_sdk``

Example:

.. code-block:: console

    export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install
    export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/
    cd build
    meson configure -Dflexran_sdk=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx512-icc/install

* For AVX512 machines with SDK libraries installed then both 4G and 5G can be enabled for full real time FEC capability. 
  For AVX2 machines it is possible to only enable the 4G libraries and the PMD capabilities will be limited to 4G FEC.
  If no library is present then the PMD driver will still build but its capabilities will be limited accordingly.

> 
>  To use the PMD in an application, user must:
> 
> --
> 2.17.1
  

Patch

diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst b/doc/guides/bbdevs/fpga_5gnr_fec.rst
index 6760391e8c..8e00c4ef22 100644
--- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
+++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
@@ -51,10 +51,7 @@  FPGA 5GNR FEC does not support the following:
 Installation
 ------------
 
-Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The
-default set of bbdev compile flags may be found in config/common_base, where for example
-the flag to build the FPGA 5GNR FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_5GNR_FEC``,
-is already set.
+Section 3 of the DPDK manual provides instructions on installing and compiling DPDK.
 
 DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual.
 The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The
@@ -94,7 +91,7 @@  the UIO driver by repeating this command for every function.
 .. code-block:: console
 
   cd <dpdk-top-level-directory>
-  insmod ./build/kmod/igb_uio.ko
+  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
   echo "8086 0d8f" > /sys/bus/pci/drivers/igb_uio/new_id
   lspci -vd8086:0d8f
 
diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst b/doc/guides/bbdevs/fpga_lte_fec.rst
index fdc8a76981..14ffa0ee14 100644
--- a/doc/guides/bbdevs/fpga_lte_fec.rst
+++ b/doc/guides/bbdevs/fpga_lte_fec.rst
@@ -50,10 +50,7 @@  FPGA LTE FEC does not support the following:
 Installation
 --------------
 
-Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The
-default set of bbdev compile flags may be found in config/common_base, where for example
-the flag to build the FPGA LTE FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC``, is already
-set.
+Section 3 of the DPDK manual provides instructions on installing and compiling DPDK.
 
 DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual.
 The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The
@@ -93,7 +90,7 @@  the UIO driver by repeating this command for every function.
 .. code-block:: console
 
   cd <dpdk-top-level-directory>
-  insmod ./build/kmod/igb_uio.ko
+  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
   echo "1172 5052" > /sys/bus/pci/drivers/igb_uio/new_id
   lspci -vd1172:
 
diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst
index 20620c2e20..3b93157890 100644
--- a/doc/guides/bbdevs/turbo_sw.rst
+++ b/doc/guides/bbdevs/turbo_sw.rst
@@ -12,14 +12,6 @@  Note that the driver can also be built without any dependency with reduced
 functionality for maintenance purpose.
 
 To enable linking to the SDK libraries see detailed installation section below.
-Two flags can be enabled depending on whether the target machine can support
-AVX2 and AVX512 instructions sets and the related SDK libraries for vectorized
-signal processing functions are installed :
-- CONFIG_RTE_BBDEV_SDK_AVX2
-- CONFIG_RTE_BBDEV_SDK_AVX512
-By default these 2 flags are disabled by default. For AVX2 machine and SDK
-library installed then the first flag can be enabled. For AVX512 machine and
-SDK library installed then both flags can be enabled for full real time capability.
 
 This PMD supports the functions: FEC, Rate Matching and CRC functions detailed
 in the Features section.
@@ -151,13 +143,6 @@  Example:
     export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install
     export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/
 
-* Set ``CONFIG_RTE_BBDEV_SDK_AVX2=y`` and ``CONFIG_RTE_BBDEV_SDK_AVX512=y``
-  in DPDK common configuration file ``config/common_base`` to be able to use
-  the SDK libraries as mentioned above.
-  For AVX2 machine it is possible to only enable CONFIG_RTE_BBDEV_SDK_AVX2
-  for limited 4G functionality.
-  If no flag are set the PMD driver will still build but its capabilities
-  will be limited accordingly.
 
 To use the PMD in an application, user must: