[PATCH] ice: document RDMA devlink parameters

[PATCH] ice: document RDMA devlink parameters

[Jacob Keller]

Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
devlink param") added support for the enable_roce and enable_iwarp
parameters in the ice driver. It didn't document these parameters in the
ice devlink documentation file. Add this documentation, including a note
about the mutual exclusion between the two modes.

Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
---
 Documentation/networking/devlink/ice.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/Documentation/networking/devlink/ice.rst b/Documentation/networking/devlink/ice.rst
index 10f282c2117c..0e39a0caba55 100644
--- a/Documentation/networking/devlink/ice.rst
+++ b/Documentation/networking/devlink/ice.rst
@@ -7,6 +7,21 @@ ice devlink support
 This document describes the devlink features implemented by the ``ice``
 device driver.
 
+Parameters
+==========
+
+.. list-table:: Generic parameters implemented
+
+   * - Name
+     - Mode
+     - Notes
+   * - ``enable_roce``
+     - runtime
+     - mutually exclusive with ``enable_iwarp``
+   * - ``enable_iwarp``
+     - runtime
+     - mutually exclusive with ``enable_roce``
+
 Info versions
 =============
 
-- 
2.40.0.131.gc918699d9952

Re: [PATCH] ice: document RDMA devlink parameters

[Jakub Kicinski]

On Fri, 14 Apr 2023 09:26:14 -0700 Jacob Keller wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.

Thanks! We do need an ack from Tony if we're supposed to take 
this directly, tho. FWIW in case Tony takes it in - it should 
go towards net.

Re: [PATCH] ice: document RDMA devlink parameters

[Leon Romanovsky]

On Fri, Apr 14, 2023 at 09:26:14AM -0700, Jacob Keller wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
> ---
>  Documentation/networking/devlink/ice.rst | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 

Thanks,
Reviewed-by: Leon Romanovsky <leonro@nvidia.com>

Re: [PATCH] ice: document RDMA devlink parameters

[Tony Nguyen]

On 4/14/2023 6:18 PM, Jakub Kicinski wrote:
> On Fri, 14 Apr 2023 09:26:14 -0700 Jacob Keller wrote:
>> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
>> devlink param") added support for the enable_roce and enable_iwarp
>> parameters in the ice driver. It didn't document these parameters in the
>> ice devlink documentation file. Add this documentation, including a note
>> about the mutual exclusion between the two modes.
> 
> Thanks! We do need an ack from Tony if we're supposed to take
> this directly, tho. FWIW in case Tony takes it in - it should
> go towards net.

Since this is documentation only, I feel like it doesn't need to go 
through IWL, unless you'd like it to. I'm ok either way. I'll add my ack 
on to the patch in case you want to take it directly.

Thanks,
Tony

Re: [PATCH] ice: document RDMA devlink parameters

[Tony Nguyen]

On 4/14/2023 9:26 AM, Jacob Keller wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>

Acked-by: Tony Nguyen <anthony.l.nguyen@intel.com>

> ---
>   Documentation/networking/devlink/ice.rst | 15 +++++++++++++++
>   1 file changed, 15 insertions(+)
> 
> diff --git a/Documentation/networking/devlink/ice.rst b/Documentation/networking/devlink/ice.rst
> index 10f282c2117c..0e39a0caba55 100644
> --- a/Documentation/networking/devlink/ice.rst
> +++ b/Documentation/networking/devlink/ice.rst
> @@ -7,6 +7,21 @@ ice devlink support
>   This document describes the devlink features implemented by the ``ice``
>   device driver.
>   
> +Parameters
> +==========
> +
> +.. list-table:: Generic parameters implemented
> +
> +   * - Name
> +     - Mode
> +     - Notes
> +   * - ``enable_roce``
> +     - runtime
> +     - mutually exclusive with ``enable_iwarp``
> +   * - ``enable_iwarp``
> +     - runtime
> +     - mutually exclusive with ``enable_roce``
> +
>   Info versions
>   =============
>   

Re: [PATCH] ice: document RDMA devlink parameters

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Fri, 14 Apr 2023 09:26:14 -0700 you wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
> 
> [...]

Here is the summary with links:
  - ice: document RDMA devlink parameters
    https://git.kernel.org/netdev/net/c/1a2bd3bd72e9

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html