doc: add list of environment variables used by cnxk
Checks
Commit Message
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
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
>
@@ -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, ..."