share/man/man4/nvd.4

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