[v4,30/30] baseband/acc100: update guide docs

Message ID 20221019003918.257506-31-hernan.vargas@intel.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series baseband/acc100: changes for 22.11 |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Hernan Vargas Oct. 19, 2022, 12:39 a.m. UTC
  Add new flags ACC100_EXT_MEM and RTE_LIBRTE_BBDEV_SKIP_VALIDATE to the
documentation.

Signed-off-by: Hernan Vargas <hernan.vargas@intel.com>
---
 doc/guides/bbdevs/acc100.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
  

Comments

Akhil Goyal Oct. 20, 2022, 9:59 a.m. UTC | #1
> Add new flags ACC100_EXT_MEM and RTE_LIBRTE_BBDEV_SKIP_VALIDATE to
> the
> documentation.
> 
> Signed-off-by: Hernan Vargas <hernan.vargas@intel.com>

Squash the patch where these flags were introduced.

> ---
>  doc/guides/bbdevs/acc100.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/guides/bbdevs/acc100.rst b/doc/guides/bbdevs/acc100.rst
> index 8b29b92a9d..b0ac2526de 100644
> --- a/doc/guides/bbdevs/acc100.rst
> +++ b/doc/guides/bbdevs/acc100.rst
> @@ -65,6 +65,15 @@ ACC100 and ACC101 5G/4G FEC PMDs support the
> following BBDEV capabilities:
>     - ``RTE_BBDEV_TURBO_DEC_SCATTER_GATHER`` :  supports scatter-gather
> for input/output data
>     - ``RTE_BBDEV_TURBO_HALF_ITERATION_EVEN`` :  set half iteration
> granularity
> 
> +* PMD Specific build flags:
> +  The ACC100 PMD includes some optional build flags which may be used for
> troubleshooting.
> +  Recommended build configuration is for these to be kept as default.
> +   - ``ACC100_EXT_MEM`` : default option with memory external to CPU on the
> PCie card DDR itself.
> +     Alternative build option will use CPU memory (not recommended).
> +   - ``RTE_LIBRTE_BBDEV_SKIP_VALIDATE`` : option to skip API input validation.
> +     Recommended value is to keep the validation enable by default as a
> protection for negative
> +     scenarios at a cost of some cycles spent to enforce these checks.
> +
>  Installation
>  ------------
> 
> --
> 2.37.1
  

Patch

diff --git a/doc/guides/bbdevs/acc100.rst b/doc/guides/bbdevs/acc100.rst
index 8b29b92a9d..b0ac2526de 100644
--- a/doc/guides/bbdevs/acc100.rst
+++ b/doc/guides/bbdevs/acc100.rst
@@ -65,6 +65,15 @@  ACC100 and ACC101 5G/4G FEC PMDs support the following BBDEV capabilities:
    - ``RTE_BBDEV_TURBO_DEC_SCATTER_GATHER`` :  supports scatter-gather for input/output data
    - ``RTE_BBDEV_TURBO_HALF_ITERATION_EVEN`` :  set half iteration granularity
 
+* PMD Specific build flags:
+  The ACC100 PMD includes some optional build flags which may be used for troubleshooting.
+  Recommended build configuration is for these to be kept as default.
+   - ``ACC100_EXT_MEM`` : default option with memory external to CPU on the PCie card DDR itself.
+     Alternative build option will use CPU memory (not recommended).
+   - ``RTE_LIBRTE_BBDEV_SKIP_VALIDATE`` : option to skip API input validation.
+     Recommended value is to keep the validation enable by default as a protection for negative
+     scenarios at a cost of some cycles spent to enforce these checks.
+
 Installation
 ------------