xref: /openbsd-src/share/man/man4/hyperv.4 (revision 91ef7e7f4862c9264ef9e31ea6c0070302a7d56c)
1.\"	$OpenBSD: hyperv.4,v 1.5 2017/09/18 19:45:52 mikeb Exp $
2.\"
3.\" Copyright (c) 2016 Mike Belopuhov
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: September 18 2017 $
18.Dt HYPERV 4
19.Os
20.Sh NAME
21.Nm hyperv
22.Nd Hyper-V guest nexus device
23.Sh SYNOPSIS
24.Cd "hyperv0 at pvbus?"
25.Sh DESCRIPTION
26.Nm
27driver performs Synthetic Interrupt Controller initialization,
28sets up hypercalls,
29and provides access to VMBus services required by paravirtualized
30devices such as disk and network interfaces.
31.Pp
32An access is also provided to the Key-Value Pair exchange interface
33via
34.Xr pvbus 4 .
35All keys are associated to one of several key pools:
36.Em Auto ,
37.Em Guest ,
38.Em External
39or
40.Em Guest/Parameters .
41It's possible to modify values of keys in the
42.Em Auto
43pool as well as
44set new keys in the
45.Em Guest
46pool with
47.Xr hostctl 8 .
48The Host provides its read-only keys in
49.Em External
50and
51.Em Guest/Parameters
52pools.
53.Sh SEE ALSO
54.Xr autoconf 4 ,
55.Xr intro 4 ,
56.Xr pvbus 4 ,
57.Xr hostctl 8
58.Sh HISTORY
59The
60.Nm
61driver first appeared in
62.Ox 6.1 .
63.Sh AUTHORS
64The
65.Nm
66driver was written by
67.An Mike Belopuhov Aq Mt mikeb@openbsd.org
68based on the
69.Fx
70driver by the Microsoft BSD Integration Services Team
71.Aq Mt bsdic@microsoft.com .
72.Sh CAVEATS
73Generation 2 Virtual Machines are currently not supported.
74