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