2 .\" Copyright (c) 2012 Intel Corporation
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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.
30 .\" nvmecontrol man page.
32 .\" Author: Jim Harris <jimharris@FreeBSD.org>
41 .Nd NVM Express control utility
52 .Aq Fl n Ar num_threads
53 .Aq Fl o Ar read|write
55 .Aq Fl s Ar size_in_bytes
56 .Aq Fl t Ar time_in_sec
70 .Op Fl f Ar path_to_firmware
74 NVM Express (NVMe) is a storage protocol standard, for SSDs and other
75 high-speed storage devices over PCI Express.
77 .Dl nvmecontrol devlist
79 Display a list of NVMe controllers and namespaces along with their device nodes.
81 .Dl nvmecontrol identify nvme0
83 Display a human-readable summary of the nvme0 IDENTIFY_CONTROLLER data.
85 .Dl nvmecontrol identify -x -v nvme0ns1
87 Display a hexadecimal dump of the nvme0 IDENTIFY_NAMESPACE data for namespace
90 .Dl nvmecontrol perftest -n 32 -o read -s 512 -t 30 nvme0ns1
92 Run a performance test on nvme0ns1 using 32 kernel threads for 30 seconds. Each
93 thread will issue a single 512 byte read command. Results are printed to
94 stdout when 30 seconds expires.
96 .Dl nvmecontrol reset nvme0
98 Perform a controller-level reset of the nvme0 controller.
100 .Dl nvmecontrol logpage -p 1 nvme0
102 Display a human-readable summary of the nvme0 controller's Error Information Log.
103 Log pages defined by the NVMe specification include Error Information Log (ID=1),
104 SMART/Health Information Log (ID=2), and Firmware Slot Log (ID=3).
106 .Dl nvmecontrol logpage -p 1 -x nvme0
108 Display a hexidecimal dump of the nvme0 controller's Error Information Log.
110 .Dl nvmecontrol firmware -s 2 -f /tmp/nvme_firmware nvme0
112 Download the firmware image contained in "/tmp/nvme_firmware" to slot 2 of the
113 nvme0 controller, but do not activate the image.
115 .Dl nvmecontrol firmware -s 4 -a nvme0
117 Activate the firmware in slot 4 of the nvme0 controller on the next reset.
119 .Dl nvmecontrol firmware -s 7 -f /tmp/nvme_firmware -a nvme0
121 Download the firmware image contained in "/tmp/nvme_firmware" to slot 7 of the
122 nvme0 controller and activate it on the next reset.
126 was developed by Intel and originally written by
127 .An Jim Harris Aq jimharris@FreeBSD.org .
129 This man page was written by
130 .An Jim Harris Aq jimharris@FreeBSD.org .