doc: add list of environment variables used by cnxk

Message ID 20220624113215.2589-1-ndabilpuram@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series doc: add list of environment variables used by cnxk |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues
ci/intel-Testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Nithin Dabilpuram June 24, 2022, 11:32 a.m. UTC
  Add list of environment variables used by cnxk drivers.

Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
---
 doc/guides/platform/cnxk.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
  

Comments

Jerin Jacob July 4, 2022, 12:58 p.m. UTC | #1
On Fri, Jun 24, 2022 at 5:02 PM Nithin Dabilpuram
<ndabilpuram@marvell.com> wrote:
>
> Add list of environment variables used by cnxk drivers.
>
> Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>


Applied to dpdk-next-net-mrvl/for-next-net. Thanks


> ---
>  doc/guides/platform/cnxk.rst | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
>
> diff --git a/doc/guides/platform/cnxk.rst b/doc/guides/platform/cnxk.rst
> index 423b3d7..97b2be5 100644
> --- a/doc/guides/platform/cnxk.rst
> +++ b/doc/guides/platform/cnxk.rst
> @@ -620,3 +620,18 @@ CN10K:
>     if Marvell toolchain is available then it can be used by overriding the
>     c, cpp, ar, strip ``binaries`` attributes to respective Marvell
>     toolchain binaries in ``config/arm/arm64_cn10k_linux_gcc`` file.
> +
> +Environment Variables
> +~~~~~~~~~~~~~~~~~~~~~
> +
> +* ``BPHY_INTR_MLOCK_DISABLE``
> +   When defined disables memory locking in
> +   BPHY environment.
> +
> +* ``ROC_CN10K_MBOX_TIMEOUT``, ``ROC_MBOX_TIMEOUT``
> +   When set, overrides MBOX timeout by value in milli seconds.
> +
> +* ``ETH_SEC_IV_OVR``
> +   When set, overrides outbound inline SA IV. By default IV is generated
> +   by HW. Format of variable is string of comma separated one byte values as
> +   for ex: "0x0, 0x10, 0x20, ..."
> --
> 2.8.4
>
  

Patch

diff --git a/doc/guides/platform/cnxk.rst b/doc/guides/platform/cnxk.rst
index 423b3d7..97b2be5 100644
--- a/doc/guides/platform/cnxk.rst
+++ b/doc/guides/platform/cnxk.rst
@@ -620,3 +620,18 @@  CN10K:
    if Marvell toolchain is available then it can be used by overriding the
    c, cpp, ar, strip ``binaries`` attributes to respective Marvell
    toolchain binaries in ``config/arm/arm64_cn10k_linux_gcc`` file.
+
+Environment Variables
+~~~~~~~~~~~~~~~~~~~~~
+
+* ``BPHY_INTR_MLOCK_DISABLE``
+   When defined disables memory locking in
+   BPHY environment.
+
+* ``ROC_CN10K_MBOX_TIMEOUT``, ``ROC_MBOX_TIMEOUT``
+   When set, overrides MBOX timeout by value in milli seconds.
+
+* ``ETH_SEC_IV_OVR``
+   When set, overrides outbound inline SA IV. By default IV is generated
+   by HW. Format of variable is string of comma separated one byte values as
+   for ex: "0x0, 0x10, 0x20, ..."