summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-vs-drive-info.1
blob: 28162772e9b0f4f6d7698f124041f95761a20ba4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
'\" t
.\"     Title: nvme-wdc-vs-drive-info
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 02/14/2024
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-WDC\-VS\-DRIVE" "1" "02/14/2024" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-wdc-vs-drive-info \- Send the NVMe WDC vs\-drive\-info command, return result
.SH "SYNOPSIS"
.sp
.nf
\fInvme wdc vs\-drive\-info\fR <device>
.fi
.SH "DESCRIPTION"
.sp
For the NVMe device given, send the unique WDC vs\-drive\-info command and provide the additional drive information\&.
.sp
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0)\&.
.sp
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
.sp
On success it returns 0, error code otherwise\&.
.SH "OUTPUT EXPLANATION"
.sp
There are several different fields returned from this command depending on the drive:
.sp
Drive HW Revision
.sp
FTL Unit Size
.sp
Customer Serial Number
.sp
HyperScale Boot Version
.sp
TCG Device Ownership
.SH "EXAMPLE"
.sp
# nvme wdc vs\-drive\-info /dev/nvme0
.SH "NVME"
.sp
Part of the nvme\-user suite\&.