xref: /freebsd/share/man/man4/vmd.4 (revision a0409676120c1e558d0ade943019934e0f15118d)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3.\"
4.\" Copyright 2019 Cisco Systems, Inc.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd October 9, 2019
30.Dt VMD 4
31.Os
32.Sh NAME
33.Nm vmd
34.Nd Intel Volume Management Device driver
35.Sh SYNOPSIS
36To compile this driver into the kernel, place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset -indent
39.Cd "device vmd"
40.Cd "device vmd_bus"
41.Ed
42.Pp
43Alternatively, to load the driver as a module at boot time, place the following
44line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47vmd_load="YES"
48.Ed
49.Sh DESCRIPTION
50This driver attaches to Intel VMD devices as a new PCI domain and then
51triggers a probe of PCI devices.
52Intel VMD is used with Intel's VROC (Virtual RAID on chip) used with
53NVME drives on Skylake SP servers.
54.Sh SEE ALSO
55.Xr graid 8
56.Sh HISTORY
57The
58.Nm
59driver first appeared in
60.Fx 13.0 .
61.Sh BUGS
62.Nm
63is currently only available on amd64.
64