[PATCH net-next] Documentation: mlx5.rst: Add note for eswitch MD

[PATCH net-next] Documentation: mlx5.rst: Add note for eswitch MD

[William Tu]

Add a note when using esw_port_metadata. The parameter has runtime
mode but setting it does not take effect immediately. Setting it must
happen in legacy mode, and the port metadata takes effects when the
switchdev mode is enabled.

Disable eswitch port metadata::
  $ devlink dev param set pci/0000:06:00.0 name esw_port_metadata value \
    false cmode runtime
Change eswitch mode to switchdev mode where after choosing the metadata value::
  $ devlink dev eswitch set pci/0000:06:00.0 mode switchdev

Note that other mlx5 devlink runtime parameters, esw_multiport and
flow_steering_mode, do not have this limitation.

Signed-off-by: William Tu <witu@nvidia.com>
Reviewed-by: Jiri Pirko <jiri@nvidia.com>
---
 Documentation/networking/devlink/mlx5.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/networking/devlink/mlx5.rst b/Documentation/networking/devlink/mlx5.rst
index 3f70417cf792..16700c1bc963 100644
--- a/Documentation/networking/devlink/mlx5.rst
+++ b/Documentation/networking/devlink/mlx5.rst
@@ -105,6 +105,10 @@ parameters.
 
        When metadata is disabled, the above use cases will fail to initialize if
        users try to enable them.
+
+       Note: Setting this parameter does not take effect immediately. Setting
+       must happen in legacy mode and eswitch port metadata takes effect after
+       enabling switchdev mode.
    * - ``hairpin_num_queues``
      - u32
      - driverinit
-- 
2.34.1

Re: [PATCH net-next] Documentation: mlx5.rst: Add note for eswitch MD

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by David S. Miller <davem@davemloft.net>:

On Wed, 24 Jan 2024 20:00:41 -0800 you wrote:
> Add a note when using esw_port_metadata. The parameter has runtime
> mode but setting it does not take effect immediately. Setting it must
> happen in legacy mode, and the port metadata takes effects when the
> switchdev mode is enabled.
> 
> Disable eswitch port metadata::
>   $ devlink dev param set pci/0000:06:00.0 name esw_port_metadata value \
>     false cmode runtime
> Change eswitch mode to switchdev mode where after choosing the metadata value::
>   $ devlink dev eswitch set pci/0000:06:00.0 mode switchdev
> 
> [...]

Here is the summary with links:
  - [net-next] Documentation: mlx5.rst: Add note for eswitch MD
    https://git.kernel.org/netdev/net-next/c/6f83b62283ed

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