Add some descriptions to the man page for the supported log pages as

well as the new wdc commands. Make wdc be an alias for hgst when
specifying the vendor to use to interpret the page.
This commit is contained in:
Warner Losh 2017-02-05 00:45:02 +00:00
parent 43b595f6a5
commit 033ccbc91f
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=313257
2 changed files with 24 additions and 1 deletions

View File

@ -846,6 +846,8 @@ static struct logpage_function {
sizeof(struct nvme_firmware_page)},
{HGST_INFO_LOG, "hgst", print_hgst_info_log,
DEFAULT_SIZE},
{HGST_INFO_LOG, "wdc", print_hgst_info_log,
DEFAULT_SIZE},
{INTEL_LOG_TEMP_STATS, "intel", print_intel_temp_stats,
sizeof(struct intel_log_temp_stats)},
{INTEL_LOG_READ_LAT_LOG, "intel", print_intel_read_lat_log,

View File

@ -62,6 +62,7 @@
.Ic logpage
.Aq Fl p Ar page_id
.Op Fl x
.Op Fl v Ar vendor-string
.Aq device id
.Aq namespace id
.Nm
@ -74,7 +75,7 @@
.Ic power
.Op Fl l
.Op Fl p power_state
.Op fl w workload_hint
.Op Fl w workload_hint
.Nm
.Ic wdc cap-diag
.Op Fl o path_template
@ -96,6 +97,26 @@
.Sh DESCRIPTION
NVM Express (NVMe) is a storage protocol standard, for SSDs and other
high-speed storage devices over PCI Express.
.Pp
.Ss logpage
The logpage command knows how to print log pages of various types.
It also knows about vendor specific log pages from hgst/wdc and intel.
Page 0xc1 for hgst/wdc contains the advanced smart information about
the drive.
Page 0xc1 is read latency stats for intel.
Page 0xc2 is write latency stats for intel.
Page 0xc5 is temperature stats for intel.
Page 0xca is advanced smart information for intel.
.Ss wdc
The various wdc command retrieve log data from the wdc/hgst drives.
The
.Fl o
flag specifies a path template to use to output the files.
Each file takes the path template (which defaults to nothing), appends
the drive's serial number and the type of dump it is followed
by .bin.
These logs must be sent to the vendor for analysis.
This tool only provides a way to extract them.
.Sh EXAMPLES
.Dl nvmecontrol devlist
.Pp