Changeset View
Changeset View
Standalone View
Standalone View
sbin/nvmecontrol/nvmecontrol.8
Show All 27 Lines | |||||
.\" POSSIBILITY OF SUCH DAMAGES. | .\" POSSIBILITY OF SUCH DAMAGES. | ||||
.\" | .\" | ||||
.\" nvmecontrol man page. | .\" nvmecontrol man page. | ||||
.\" | .\" | ||||
.\" Author: Jim Harris <jimharris@FreeBSD.org> | .\" Author: Jim Harris <jimharris@FreeBSD.org> | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd February 24, 2017 | .Dd February 24, 2017 | ||||
wblock: Please remember to bump .Dd. | |||||
.Dt NVMECONTROL 8 | .Dt NVMECONTROL 8 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm nvmecontrol | .Nm nvmecontrol | ||||
.Nd NVM Express control utility | .Nd NVM Express control utility | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.Nm | .Nm | ||||
.Ic devlist | .Ic devlist | ||||
▲ Show 20 Lines • Show All 45 Lines • ▼ Show 20 Lines | |||||
.Op Fl o path_template | .Op Fl o path_template | ||||
.Aq device id | .Aq device id | ||||
.\" .Nm | .\" .Nm | ||||
.\" .Ic wdc purge | .\" .Ic wdc purge | ||||
.\" .Aq device id | .\" .Aq device id | ||||
.\" .Nm | .\" .Nm | ||||
.\" .Ic wdc purge-monitor | .\" .Ic wdc purge-monitor | ||||
.\" .Aq device id | .\" .Aq device id | ||||
.Nm | |||||
.Ic format | |||||
.Op Fl f Ar LBAF | |||||
.Op Fl m Ar MSET | |||||
.Op Fl p Ar PI | |||||
.Op Fl s Ar SES | |||||
.Aq namespace id | |||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
NVM Express (NVMe) is a storage protocol standard, for SSDs and other | NVM Express (NVMe) is a storage protocol standard, for SSDs and other | ||||
high-speed storage devices over PCI Express. | high-speed storage devices over PCI Express. | ||||
.Pp | .Pp | ||||
.Ss logpage | .Ss logpage | ||||
The logpage command knows how to print log pages of various types. | 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. | It also knows about vendor specific log pages from hgst/wdc and intel. | ||||
Page 0xc1 for hgst/wdc contains the advanced smart information about | Page 0xc1 for hgst/wdc contains the advanced smart information about | ||||
Show All 16 Lines | |||||
The | The | ||||
.Fl o | .Fl o | ||||
flag specifies a path template to use to output the files. | flag specifies a path template to use to output the files. | ||||
Each file takes the path template (which defaults to nothing), appends | Each file takes the path template (which defaults to nothing), appends | ||||
the drive's serial number and the type of dump it is followed | the drive's serial number and the type of dump it is followed | ||||
by .bin. | by .bin. | ||||
These logs must be sent to the vendor for analysis. | These logs must be sent to the vendor for analysis. | ||||
This tool only provides a way to extract them. | This tool only provides a way to extract them. | ||||
.Ss format | |||||
The format command allows a low level format of the NVM media. Each of the | |||||
wblockUnsubmitted Not Done Inline ActionsPlease start new sentences on new lines. This section would be easier to read as a list (.Bl): .Ss format The format command allows a low level format of the NVM media. Each of the options mirror the field names defined in the NVM Express specification. .Bl -tag -width 10n .It Fl f Choose the LBA Format. Valid values are 0-15. .It Fl m Choose whether metadata is appended to the block (extended LBA) or sent in a separate buffer. .It Fl p Select the end-to-end protection information (Type 0 - 3). .It Fl l Select whether the protection information is first (1) or last (0) in the metadata. .It Fl s Select the type of low level format (none = 0, user erase = 1, cryptographic erase = 2). wblock: Please start new sentences on new lines.
This section would be easier to read as a list (.Bl)… | |||||
options mirror the field names defined in the NVM Express specification. | |||||
.Fl f | |||||
chooses the LBA Format. Valid values are 0-15. | |||||
.Fl m | |||||
chooses whether metadata is appended to the block (extended LBA) or sent | |||||
in a separate buffer. | |||||
.Fl p | |||||
selects the end-to-end protection information (Type 0 - 3). | |||||
.Fl l | |||||
selects whether the protection information is first (1) or last (0) in the | |||||
metadata. | |||||
.Fl s | |||||
selects the type of low level format (none = 0, user erase = 1, cryptographic | |||||
erase = 2). | |||||
.Sh EXAMPLES | .Sh EXAMPLES | ||||
.Dl nvmecontrol devlist | .Dl nvmecontrol devlist | ||||
.Pp | .Pp | ||||
Display a list of NVMe controllers and namespaces along with their device nodes. | Display a list of NVMe controllers and namespaces along with their device nodes. | ||||
.Pp | .Pp | ||||
.Dl nvmecontrol identify nvme0 | .Dl nvmecontrol identify nvme0 | ||||
.Pp | .Pp | ||||
Display a human-readable summary of the nvme0 IDENTIFY_CONTROLLER data. | Display a human-readable summary of the nvme0 IDENTIFY_CONTROLLER data. | ||||
▲ Show 20 Lines • Show All 75 Lines • Show Last 20 Lines |
Please remember to bump .Dd.