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