xref: /illumos-gate/usr/src/man/man4d/vioif.4d (revision 1a2d662a91cee3bf82f41cd47c7ae6f3825d9db2)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2020 Oxide Computer Company
13.\"
14.Dd October 3, 2020
15.Dt VIOIF 4D
16.Os
17.Sh NAME
18.Nm vioif
19.Nd Virtio Networking Driver
20.Sh SYNOPSIS
21.Pa /dev/net/vioif*
22.Sh DESCRIPTION
23The
24.Nm
25driver is a GLDv3 NIC driver that supports the virtio para-virtualization
26specification which is commonly used by many hypervisors and emulators.
27The device supports what the specification calls the more commonly found
28.Sq legacy
29interface for devices.
30.Pp
31The driver supports the following networking features, if offered by the
32device:
33.Bl -dash
34.It
35Jumbo frames up to 65535 bytes
36.It
37Transmit and receive TCP and UDP checksum offload
38.It
39IPv4 and IPv6 TCP segmentation offload
40.El
41.Sh APPLICATION PROGRAMMING INTERFACE
42For each supported device instance, which corresponds to a port, a
43character-special file is created.
44This device can be used with the Data Link Provider Interface
45.Pq DLPI
46through either
47.Xr libdlpi 3LIB
48or
49.Xr dlpi 4P .
50.Pp
51Each instance is assigned a unique ascending integer identifier starting
52from zero.
53The first instance in the system would be enumerated with the id 0 and
54be named
55.Sy vioif0
56and be found in the file system at
57.Pa /dev/net/vioif0 .
58.Sh CONFIGURATION
59The networking devices created by the
60.Nm
61driver can be controlled through
62.Xr dladm 8 .
63There is no
64.Xr driver.conf 5
65file for
66.Nm
67currently.
68.Sh ARCHITECTURE
69The
70.Nm
71driver is only supported on
72.Sy x86 .
73.Sh FILES
74.Bl -tag -width Pa
75.It Pa /dev/net/vioif*
76.Nm
77special character device.
78.It Pa /kernel/drv/amd64/vioif
79x86 device driver.
80.El
81.Sh SEE ALSO
82.Xr libdlpi 3LIB ,
83.Xr virtio 4D ,
84.Xr dlpi 4P ,
85.Xr dladm 8 ,
86.Xr mac 9E
87.Rs
88.%T Virtual I/O Device (VIRTIO) Version 1.1
89.%D April, 2019
90.%U https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html
91.Re
92