2012-10-10 21:38:17 +00:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2012 Intel Corporation
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions, and the following disclaimer,
|
|
|
|
|
.\" without modification.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
|
|
|
|
|
.\" substantially similar to the "NO WARRANTY" disclaimer below
|
|
|
|
|
.\" ("Disclaimer") and any redistribution must be conditioned upon
|
|
|
|
|
.\" including a substantially similar Disclaimer requirement for further
|
|
|
|
|
.\" binary redistribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" NO WARRANTY
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
|
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
|
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
|
|
|
|
|
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
|
.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
|
|
|
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
|
|
|
|
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
|
.\" POSSIBILITY OF SUCH DAMAGES.
|
|
|
|
|
.\"
|
|
|
|
|
.\" nvd driver man page.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Author: Jim Harris <jimharris@FreeBSD.org>
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
|
|
|
|
.Dd October 10, 2012
|
|
|
|
|
.Dt NVD 4
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm nvd
|
|
|
|
|
.Nd NVM Express disk driver
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
To compile this driver into your kernel,
|
|
|
|
|
place the following lines in your kernel configuration file:
|
|
|
|
|
.Bd -ragged -offset indent
|
|
|
|
|
.Cd "device nvme"
|
|
|
|
|
.Cd "device nvd"
|
|
|
|
|
.Ed
|
|
|
|
|
.Pp
|
|
|
|
|
Or, to load the driver as a module at boot, place the following lines in
|
|
|
|
|
.Xr loader.conf 5 :
|
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
|
nvme_load="YES"
|
|
|
|
|
nvd_load="YES"
|
|
|
|
|
.Ed
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
driver exposes NVM Express (NVMe) namespaces as disks to the kernel disk
|
|
|
|
|
storage API.
|
|
|
|
|
It depends on the
|
|
|
|
|
.Xr nvme 4
|
|
|
|
|
driver for notification of existing NVMe namespaces and submission of NVM
|
|
|
|
|
I/O commands.
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr nvme 4 ,
|
2012-10-12 06:16:51 +00:00
|
|
|
.Xr nvmecontrol 8 ,
|
2012-10-10 21:38:17 +00:00
|
|
|
.Xr disk 9 .
|
|
|
|
|
.Sh AUTHORS
|
|
|
|
|
.An -nosplit
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
driver was developed by Intel and originally written by
|
|
|
|
|
.An Jim Harris Aq jimharris@FreeBSD.org ,
|
|
|
|
|
with contributions from Joe Golio at EMC.
|
|
|
|
|
.Pp
|
|
|
|
|
This man page was written by
|
|
|
|
|
.An Jim Harris Aq jimharris@FreeBSD.org .
|
|
|
|
|
.Sh BUGS
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
driver is considered experimental.
|
|
|
|
|
Development and testing have been primarily focused on amd64.
|
|
|
|
|
The following areas of development and testing are in progress:
|
|
|
|
|
.Bl -bullet
|
|
|
|
|
.It
|
|
|
|
|
testing on i386
|
2012-10-12 06:16:51 +00:00
|
|
|
.It
|
2012-10-10 21:38:17 +00:00
|
|
|
command timeout error handling
|
|
|
|
|
.El
|
