diff mbox series

[net-next,2/2] Documentation: ABI: sysfs-class-net-qmi: document tx aggregation files

Message ID 20221019132503.6783-3-dnlplm@gmail.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series net: usb: qmi_wwan implement tx packets aggregation | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Series has a cover letter
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers success CCed 2 of 2 maintainers
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
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: 0 this patch: 0
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 31 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Daniele Palmas Oct. 19, 2022, 1:25 p.m. UTC
Add documentation for:

/sys/class/net/<iface>/qmi/tx_max_datagrams_mux
/sys/class/net/<iface>/qmi/tx_max_size_mux

related to the qmap tx aggregation feature.

Signed-off-by: Daniele Palmas <dnlplm@gmail.com>
---
 Documentation/ABI/testing/sysfs-class-net-qmi | 28 +++++++++++++++++++
 1 file changed, 28 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-net-qmi b/Documentation/ABI/testing/sysfs-class-net-qmi
index 47e6b9732337..9c69ffa64b51 100644
--- a/Documentation/ABI/testing/sysfs-class-net-qmi
+++ b/Documentation/ABI/testing/sysfs-class-net-qmi
@@ -74,3 +74,31 @@  Description:
 
 		'Pass-through' mode can be enabled when the device is in
 		'raw-ip' mode only.
+
+What:		/sys/class/net/<iface>/qmi/tx_max_datagrams_mux
+Date:		October 2022
+KernelVersion:	6.2
+Contact:	Daniele Palmas <dnlplm@gmail.com>
+Description:
+		Unsigned integer. Default: 1, meaning tx aggregation disabled
+
+		The maximum number of QMAP aggregated tx packets.
+
+		This value is returned by the modem when calling the QMI request
+		wda set data format with QMAP tx aggregation enabled: userspace
+		should take care of setting the returned value to this file.
+
+What:		/sys/class/net/<iface>/qmi/tx_max_size_mux
+Date:		October 2022
+KernelVersion:	6.2
+Contact:	Daniele Palmas <dnlplm@gmail.com>
+Description:
+		Unsigned integer
+
+		The maximum size in bytes of a block of QMAP aggregated tx packets.
+
+		This value is returned by the modem when calling the QMI request
+		wda set data format with QMAP tx aggregation enabled: userspace
+		should take care of setting the returned value to this file.
+
+		This value is not considered if tx_aggregation is disabled.