xref: /freebsd/share/man/man4/hv_netvsc.4 (revision 7a7741af18d6c8a804cc643cb7ecda9d730c6aa6)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2012 Microsoft Corp.
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd September 10, 2013
29.Dt HYPER-V 4
30.Os
31.Sh NAME
32.Nm hv_netvsc
33.Nd Hyper-V Network Virtual Service Consumer
34.Sh SYNOPSIS
35To compile this driver into the kernel, place the following lines in
36the system kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device hyperv"
39.Ed
40.Sh DESCRIPTION
41The
42.Nm
43driver implements the virtual network device for
44.Fx
45guest
46partitions running on Hyper-V.
47.Fx
48guest partitions running on Hyper-V do not have direct access to
49network devices attached to the Hyper-V server.
50Although a
51.Fx
52guest can access network devices using Hyper-V's
53full emulation mode, the performance in this mode tends to be unsatisfactory.
54.Pp
55To counter the above issues, the
56.Nm
57driver implements a network
58Virtual
59Service Consumer (VSC) that relays network requests from the guest partition
60to the network Virtual Service Provider (VSP) hosted in the root partition
61using the high performance data exchange infrastructure provided by
62.Xr hv_vmbus 4
63driver.
64The VSP in the root partition then forwards the network related requests to
65the physical network card.
66.Sh SEE ALSO
67.Xr hv_ata_pci_disengage 4 ,
68.Xr hv_storvsc 4 ,
69.Xr hv_utils 4 ,
70.Xr hv_vmbus 4
71.Sh HISTORY
72Support for
73.Nm
74first appeared in
75.Fx 10.0 .
76The driver was developed through a joint effort between Citrix Incorporated,
77Microsoft Corporation, and Network Appliance Incorporated.
78.Sh AUTHORS
79.An -nosplit
80.Fx
81support for
82.Nm
83was first added by
84.An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .
85