2 .\" Copyright (c) 2018 Alexander Motin <mav@FreeBSD.org>
3 .\" Copyright (c) 2012 Intel Corporation
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions, and the following disclaimer,
11 .\" without modification.
12 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
13 .\" substantially similar to the "NO WARRANTY" disclaimer below
14 .\" ("Disclaimer") and any redistribution must be conditioned upon
15 .\" including a substantially similar Disclaimer requirement for further
16 .\" binary redistribution.
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
22 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
28 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 .\" POSSIBILITY OF SUCH DAMAGES.
31 .\" nvmecontrol man page.
33 .\" Author: Jim Harris <jimharris@FreeBSD.org>
42 .Nd NVM Express control utility
54 .Aq Fl n Ar num_threads
55 .Aq Fl o Ar read|write
57 .Aq Fl s Ar size_in_bytes
58 .Aq Fl t Ar time_in_sec
67 .Op Fl v Ar vendor-string
74 .Op Fl f Ar path_to_firmware
91 .Op Fl w workload_hint
94 .Op Fl o path_template
98 .Op Fl o path_template
101 .Ic wdc get-crash-dump
102 .Op Fl o path_template
108 .\" .Ic wdc purge-monitor
111 NVM Express (NVMe) is a storage protocol standard, for SSDs and other
112 high-speed storage devices over PCI Express.
115 The logpage command knows how to print log pages of various types.
116 It also knows about vendor specific log pages from hgst/wdc and intel.
117 Page 0xc1 for hgst/wdc contains the advanced smart information about
119 Page 0xc1 is read latency stats for intel.
120 Page 0xc2 is write latency stats for intel.
121 Page 0xc5 is temperature stats for intel.
122 Page 0xca is advanced smart information for intel.
127 will list all valid vendors and pages.
129 will print the page as hex.
131 will print the binary data for the page.
133 Format either specified namespace, or all namespaces of specified controller,
134 using specified parameters:
140 Protection Information,
142 Protection Information Location.
143 When formatting specific namespace, existing values are used as defaults.
144 When formatting all namespaces, all parameters should be specified.
145 Some controllers may not support formatting or erasing specific or all
149 enables User Data Erase during format.
152 enables Cryptographic Erase during format.
154 The various wdc command retrieve log data from the wdc/hgst drives.
157 flag specifies a path template to use to output the files.
158 Each file takes the path template (which defaults to nothing), appends
159 the drive's serial number and the type of dump it is followed
161 These logs must be sent to the vendor for analysis.
162 This tool only provides a way to extract them.
164 .Dl nvmecontrol devlist
166 Display a list of NVMe controllers and namespaces along with their device nodes.
168 .Dl nvmecontrol identify nvme0
170 Display a human-readable summary of the nvme0 IDENTIFY_CONTROLLER data.
172 .Dl nvmecontrol identify -x -v nvme0ns1
174 Display an hexadecimal dump of the nvme0 IDENTIFY_NAMESPACE data for namespace
177 .Dl nvmecontrol perftest -n 32 -o read -s 512 -t 30 nvme0ns1
179 Run a performance test on nvme0ns1 using 32 kernel threads for 30 seconds.
180 Each thread will issue a single 512 byte read command.
181 Results are printed to stdout when 30 seconds expires.
183 .Dl nvmecontrol reset nvme0
185 Perform a controller-level reset of the nvme0 controller.
187 .Dl nvmecontrol logpage -p 1 nvme0
189 Display a human-readable summary of the nvme0 controller's Error Information Log.
190 Log pages defined by the NVMe specification include Error Information Log (ID=1),
191 SMART/Health Information Log (ID=2), and Firmware Slot Log (ID=3).
193 .Dl nvmecontrol logpage -p 0xc1 -v wdc nvme0
195 Display a human-readable summary of the nvme0's wdc-specific advanced
198 .Dl nvmecontrol logpage -p 1 -x nvme0
200 Display a hexadecimal dump of the nvme0 controller's Error Information Log.
202 .Dl nvmecontrol logpage -p 0xcb -b nvme0 > /tmp/page-cb.bin
204 Print the contents of vendor specific page 0xcb as binary data on
206 Redirect it to a temporary file.
208 .Dl nvmecontrol firmware -s 2 -f /tmp/nvme_firmware nvme0
210 Download the firmware image contained in "/tmp/nvme_firmware" to slot 2 of the
211 nvme0 controller, but do not activate the image.
213 .Dl nvmecontrol firmware -s 4 -a nvme0
215 Activate the firmware in slot 4 of the nvme0 controller on the next reset.
217 .Dl nvmecontrol firmware -s 7 -f /tmp/nvme_firmware -a nvme0
219 Download the firmware image contained in "/tmp/nvme_firmware" to slot 7 of the
220 nvme0 controller and activate it on the next reset.
222 .Dl nvmecontrol power -l nvme0
224 List all the current power modes.
226 .Dl nvmecontrol power -p 3 nvme0
228 Set the current power mode.
230 .Dl nvmecontrol power nvme0
232 Get the current power mode.
237 .Pa /usr/local/lib/nvmecontrol
238 are scanned for any .so files.
239 These files are loaded.
242 linker set are added to the top-level commands.
245 linker set are added to the logpage parsers.
254 was developed by Intel and originally written by
255 .An Jim Harris Aq Mt jimharris@FreeBSD.org .
257 This man page was written by
258 .An Jim Harris Aq Mt jimharris@FreeBSD.org .