xref: /freebsd/share/man/man4/nvd.4 (revision 1cb022703ec635c8106969bb9ff5e0de4347ef1a)
1e3e90193SJim Harris.\"
2*1cb02270SJim Harris.\" Copyright (c) 2012-2013 Intel Corporation
3e3e90193SJim Harris.\" All rights reserved.
4e3e90193SJim Harris.\"
5e3e90193SJim Harris.\" Redistribution and use in source and binary forms, with or without
6e3e90193SJim Harris.\" modification, are permitted provided that the following conditions
7e3e90193SJim Harris.\" are met:
8e3e90193SJim Harris.\" 1. Redistributions of source code must retain the above copyright
9e3e90193SJim Harris.\"    notice, this list of conditions, and the following disclaimer,
10e3e90193SJim Harris.\"    without modification.
11e3e90193SJim Harris.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
12e3e90193SJim Harris.\"    substantially similar to the "NO WARRANTY" disclaimer below
13e3e90193SJim Harris.\"    ("Disclaimer") and any redistribution must be conditioned upon
14e3e90193SJim Harris.\"    including a substantially similar Disclaimer requirement for further
15e3e90193SJim Harris.\"    binary redistribution.
16e3e90193SJim Harris.\"
17e3e90193SJim Harris.\" NO WARRANTY
18e3e90193SJim Harris.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19e3e90193SJim Harris.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20e3e90193SJim Harris.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21e3e90193SJim Harris.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22e3e90193SJim Harris.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23e3e90193SJim Harris.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24e3e90193SJim Harris.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25e3e90193SJim Harris.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26e3e90193SJim Harris.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27e3e90193SJim Harris.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28e3e90193SJim Harris.\" POSSIBILITY OF SUCH DAMAGES.
29e3e90193SJim Harris.\"
30e3e90193SJim Harris.\" nvd driver man page.
31e3e90193SJim Harris.\"
32e3e90193SJim Harris.\" Author: Jim Harris <jimharris@FreeBSD.org>
33e3e90193SJim Harris.\"
34e3e90193SJim Harris.\" $FreeBSD$
35e3e90193SJim Harris.\"
36e3e90193SJim Harris.Dd October 10, 2012
37e3e90193SJim Harris.Dt NVD 4
38e3e90193SJim Harris.Os
39e3e90193SJim Harris.Sh NAME
40e3e90193SJim Harris.Nm nvd
41e3e90193SJim Harris.Nd NVM Express disk driver
42e3e90193SJim Harris.Sh SYNOPSIS
43e3e90193SJim HarrisTo compile this driver into your kernel,
44e3e90193SJim Harrisplace the following lines in your kernel configuration file:
45e3e90193SJim Harris.Bd -ragged -offset indent
46e3e90193SJim Harris.Cd "device nvme"
47e3e90193SJim Harris.Cd "device nvd"
48e3e90193SJim Harris.Ed
49e3e90193SJim Harris.Pp
50e3e90193SJim HarrisOr, to load the driver as a module at boot, place the following lines in
51e3e90193SJim Harris.Xr loader.conf 5 :
52e3e90193SJim Harris.Bd -literal -offset indent
53e3e90193SJim Harrisnvme_load="YES"
54e3e90193SJim Harrisnvd_load="YES"
55e3e90193SJim Harris.Ed
56e3e90193SJim Harris.Sh DESCRIPTION
57e3e90193SJim HarrisThe
58e3e90193SJim Harris.Nm
59e3e90193SJim Harrisdriver exposes NVM Express (NVMe) namespaces as disks to the kernel disk
60e3e90193SJim Harrisstorage API.
61e3e90193SJim HarrisIt depends on the
62e3e90193SJim Harris.Xr nvme 4
63e3e90193SJim Harrisdriver for notification of existing NVMe namespaces and submission of NVM
64e3e90193SJim HarrisI/O commands.
65e3e90193SJim Harris.Sh SEE ALSO
66e3e90193SJim Harris.Xr nvme 4 ,
67e3e90193SJim Harris.Xr nvmecontrol 8 ,
68e3e90193SJim Harris.Xr disk 9 .
69*1cb02270SJim Harris.Sh HISTORY
70*1cb02270SJim HarrisThe
71*1cb02270SJim Harris.Nm
72*1cb02270SJim Harrisdriver first appeared in
73*1cb02270SJim Harris.Fx 9.2.
74e3e90193SJim Harris.Sh AUTHORS
75e3e90193SJim Harris.An -nosplit
76e3e90193SJim HarrisThe
77e3e90193SJim Harris.Nm
78e3e90193SJim Harrisdriver was developed by Intel and originally written by
79e3e90193SJim Harris.An Jim Harris Aq jimharris@FreeBSD.org ,
80e3e90193SJim Harriswith contributions from Joe Golio at EMC.
81e3e90193SJim Harris.Pp
82e3e90193SJim HarrisThis man page was written by
83e3e90193SJim Harris.An Jim Harris Aq jimharris@FreeBSD.org .
84