sbin/nvmecontrol/nvmecontrol.8

   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 .\" nvmecontrol man page.
  31 .\"
  32 .\" Author: Jim Harris <jimharris@FreeBSD.org>
  33 .\"
  34 .\" $FreeBSD$
  35 .\"
  36 .Dd March 26, 2013
  37 .Dt NVMECONTROL 8
  38 .Os
  39 .Sh NAME
  40 .Nm nvmecontrol
  41 .Nd NVM Express control utility
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Ic devlist
  45 .Nm
  46 .Ic identify
  47 .Op Fl v
  48 .Op Fl x
  49 .Aq device id
  50 .Nm
  51 .Ic perftest
  52 .Aq Fl n Ar num_threads
  53 .Aq Fl o Ar read|write
  54 .Op Fl p
  55 .Aq Fl s Ar size_in_bytes
  56 .Aq Fl t Ar time_in_sec
  57 .Aq namespace id
  58 .Nm
  59 .Ic reset
  60 .Aq controller id
  61 .Sh DESCRIPTION
  62 NVM Express (NVMe) is a storage protocol standard, for SSDs and other
  63 high-speed storage devices over PCI Express.
  64 .Sh EXAMPLES
  65 .Dl nvmecontrol devlist
  66 .Pp
  67 Display a list of NVMe controllers and namespaces along with their device nodes.
  68 .Pp
  69 .Dl nvmecontrol identify nvme0
  70 .Pp
  71 Display a human-readable summary of the nvme0 IDENTIFY_CONTROLLER data.
  72 .Pp
  73 .Dl nvmecontrol identify -x -v nvme0ns1
  74 .Pp
  75 Display a hexadecimal dump of the nvme0 IDENTIFY_NAMESPACE data for namespace
  76 1.
  77 .Pp
  78 .Dl nvmecontrol perftest -n 32 -o read -s 512 -t 30 nvme0ns1
  79 .Pp
  80 Run a performance test on nvme0ns1 using 32 kernel threads for 30 seconds.  Each
  81 thread will issue a single 512 byte read command.  Results are printed to
  82 stdout when 30 seconds expires.
  83 .Pp
  84 .Dl nvmecontrol reset nvme0
  85 .Pp
  86 Perform a controller-level reset of the nvme0 controller.
  87 .Sh AUTHORS
  88 .An -nosplit
  89 .Nm
  90 was developed by Intel and originally written by
  91 .An Jim Harris Aq jimharris@FreeBSD.org .
  92 .Pp
  93 This man page was written by
  94 .An Jim Harris Aq jimharris@FreeBSD.org .