[src/trunk]: src/share/man/man4 Document capability of TX/RX offload and envi...

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

details:   https://anonhg.NetBSD.org/src/rev/2ccf15871717
branches:  trunk
changeset: 446591:2ccf15871717
user:      rin <rin%NetBSD.org@localhost>
date:      Wed Dec 12 02:26:40 2018 +0000

description:
Document capability of TX/RX offload and environment variable
RUMP_SHMIF_CAPENABLE. Bump date.

part of PR kern/53562

diffstat:

 share/man/man4/shmif.4 |  28 ++++++++++++++++++++++++++--
 1 files changed, 26 insertions(+), 2 deletions(-)

diffs (49 lines):

diff -r 9d1956807b9e -r 2ccf15871717 share/man/man4/shmif.4
--- a/share/man/man4/shmif.4    Wed Dec 12 01:53:52 2018 +0000
+++ b/share/man/man4/shmif.4    Wed Dec 12 02:26:40 2018 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: shmif.4,v 1.4 2015/10/19 14:33:11 pooka Exp $
+.\"    $NetBSD: shmif.4,v 1.5 2018/12/12 02:26:40 rin Exp $
 .\"
 .\" Copyright (c) 2010 Antti Kantee
 .\" All rights reserved.
@@ -23,7 +23,7 @@
 .\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd November 17, 2010
+.Dd December 12, 2018
 .Dt SHMIF 4
 .Os
 .Sh NAME
@@ -90,6 +90,30 @@
 interface is possible only via
 .Xr ifconfig 8
 .Em destroy .
+.Pp
+An
+.Nm
+interface emulates TX/RX offload options in software.
+They are specified by
+.Xr ifconfig 8 .
+Alternatively, its
+.Em if_capenable
+flag is directly specified by
+environment variable
+.Ev RUMP_SHMIF_CAPENABLE ,
+for example:
+.Bl -tag -width 0xfffff
+.It Ar 0x7ff80
+for all TX/RX offload
+.It Ar 0x6aa80
+for all TX offload
+.It Ar 0x15500
+for all RX offload
+.El
+.Pp
+See
+.Pa /usr/include/net/if.h
+for more details.
 .Sh SEE ALSO
 .Xr rump 3 ,
 .Xr virt 4 ,