diff mbox series

[iwl-next,v1,3/3] igc: Add default Rx Queue into documentation

Message ID 20240730012336.775912-1-yoong.siang.song@intel.com (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series Add Default Rx Queue Setting for igc driver | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Guessed tree name to be net-next, async
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: 7 this patch: 7
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 10 of 10 maintainers
netdev/build_clang success Errors and warnings before: 7 this patch: 7
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: 7 this patch: 7
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 27 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

Commit Message

Song Yoong Siang July 30, 2024, 1:23 a.m. UTC 
From: Blanco Alcaine Hector <hector.blanco.alcaine@intel.com>

Add description on default Rx Queue, including the get and set
method, into documentation.

Signed-off-by: Blanco Alcaine Hector <hector.blanco.alcaine@intel.com>
Signed-off-by: Song Yoong Siang <yoong.siang.song@intel.com>
---
 .../device_drivers/ethernet/intel/igc.rst     | 21 +++++++++++++++++++
 1 file changed, 21 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/networking/device_drivers/ethernet/intel/igc.rst b/Documentation/networking/device_drivers/ethernet/intel/igc.rst
index 08b2cfacc7c0..bef396d9ec53 100644
--- a/Documentation/networking/device_drivers/ethernet/intel/igc.rst
+++ b/Documentation/networking/device_drivers/ethernet/intel/igc.rst
@@ -63,6 +63,27 @@  diagnostics, as well as displaying statistical information. The latest ethtool
 version is required for this functionality. Download it at:
 https://www.kernel.org/pub/software/network/ethtool/
 
+Default Rx queue selection
+--------------------------
+In Multiple Receive Queues modes, ingress traffic may be redirected to specific
+Rx queue based on different programmable filters.
+
+When none of the filters is matched, the incoming frame will be redirected to
+the "Default Rx queue", which is Rx Queue 0 by default.
+
+For configurations where Queue 0 pair is used for high priority traffic (like
+AF_XDP), this may not be desirable. To address this, the driver provides the
+option to modify the default Rx queue via sysfs.
+
+A sysfs attribute "default_rx_queue" is available under /sys/devices. E.g.:
+/sys/devices/pci0000:00/.../default_rx_queue
+
+To check the currently configured default Rx queue:
+cat /sys/devices/pci0000:00/.../default_rx_queue
+
+To set the default queue to a desired value, for example 3:
+echo 3 > /sys/devices/pci0000:00/.../default_rx_queue
+
 
 Support
 =======