kernel: Bring in a port of FreeBSD's virtio_random(4) driver.
[dragonfly.git] / share / man / man4 / virtio_random.4
1 .\" Copyright (c) 2013 Bryan Venteicher
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: head/share/man/man4/virtio_random.4 275990 2014-12-21 09:53:29Z brueffer $
26 .\"
27 .Dd September 30, 2018
28 .Dt VIRTIO_RANDOM 4
29 .Os
30 .Sh NAME
31 .Nm virtio_random
32 .Nd VirtIO Entropy driver
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd "device virtio_random"
39 .Ed
40 .Pp
41 Alternatively, to load the driver as a
42 module at boot time, place the following line in
43 .Xr loader.conf 5 :
44 .Bd -literal -offset indent
45 virtio_random_load="YES"
46 .Ed
47 .Sh DESCRIPTION
48 The
49 .Nm
50 device driver provides support for VirtIO entropy devices.
51 .Pp
52 The entropy device supplies high-quality randomness from the
53 hypervisor to the guest.
54 .Pp
55 See the URL in
56 .Sx SEE ALSO
57 for some instrunctions on how to test the
58 .Nm
59 driver.
60 .Sh SEE ALSO
61 .Xr random 4 ,
62 .Xr virtio 4
63 .Pp
64 .Pa https://fedoraproject.org/wiki/QA:Testcase_Virtualization_VirtioRNG
65 .Sh HISTORY
66 The
67 .Nm
68 driver was written by
69 .An Bryan Venteicher Aq Mt bryanv@FreeBSD.org .