[src/trunk]: src/share/man/man4 Document hw.wmX.txex_workqueue sysctl

[manu <manu%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/870c54adbe7c
branches:  trunk
changeset: 366456:870c54adbe7c
user:      manu <manu%NetBSD.org@localhost>
date:      Sat May 28 00:53:41 2022 +0000

description:
Document hw.wmX.txex_workqueue sysctl

diffstat:

 share/man/man4/wm.4 |  15 +++++++++++++--
 1 files changed, 13 insertions(+), 2 deletions(-)

diffs (36 lines):

diff -r aec9d08e0836 -r 870c54adbe7c share/man/man4/wm.4
--- a/share/man/man4/wm.4       Fri May 27 23:29:15 2022 +0000
+++ b/share/man/man4/wm.4       Sat May 28 00:53:41 2022 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: wm.4,v 1.42 2021/02/17 08:15:43 knakahara Exp $
+.\"    $NetBSD: wm.4,v 1.43 2022/05/28 00:53:41 manu Exp $
 .\"
 .\" Copyright 2002, 2003 Wasabi Systems, Inc.
 .\" All rights reserved.
@@ -184,6 +184,16 @@
 .\" .Sh DIAGNOSTICS
 .\" XXX to be done.
 .Sh OPTIONS
+The driver default behavior is to handle packets in interrupt context,
+which reduces the CPU time available to user processes when under 
+heavy nerwork load. The 
+.Em hw.wmX.txrx_workqueue
+.Xr sysctl 8
+alters this behavior so that packets are handled by a kernel thread, 
+which executes at a lower priority. This gives user processes more
+opportunity to be executed, at the exepense of network throughput.
+.Pp
+The following options can be set at build time:
 .Bl -tag -width WM_RX_INTR_PROCESS_LIMIT_DEFAULT -offset 3n
 .It Dv WM_RX_PROCESS_LIMIT_DEFAULT
 The maximum number of received packets processed in each
@@ -247,7 +257,8 @@
 .Xr mii 4 ,
 .Xr netintro 4 ,
 .Xr pci 4 ,
-.Xr ifconfig 8
+.Xr ifconfig 8 ,
+.Xr sysctl 8
 .Sh HISTORY
 The
 .Nm