diff mbox series

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

Message ID 20240125040041.5589-1-witu@nvidia.com (mailing list archive)
State Accepted
Commit 6f83b62283edc295be1cfa18dd49d4f278575118
Delegated to: Netdev Maintainers
Headers show
Series [net-next] Documentation: mlx5.rst: Add note for eswitch MD | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 0 of 0 maintainers
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 10 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-01-27--09-00 (tests: 612)

Commit Message

William Tu Jan. 25, 2024, 4 a.m. UTC
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(+)

Comments

patchwork-bot+netdevbpf@kernel.org Jan. 27, 2024, 2:30 p.m. UTC | #1
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!
diff mbox series

Patch

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