Skip to content

Commit d60c082

Browse files
jeff-lien-sndkigaw
jeff-lien-sndk
authored and
igaw
committed
sndk: Add documentation for Sandisk plugin commands
Add documentation files for new Sandisk plugin commands. Signed-off-by: jeff-lien-wdc <[email protected]>
1 parent 7a9b839 commit d60c082

30 files changed

+1618
-1
lines changed

‎Documentation/cmd-plugins.txt‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,87 @@ linknvme:nvme-netapp-ontapdevices[1]::
5555
linknvme:nvme-netapp-smdevices[1]::
5656
Display information for each NVMe path to an E-Series volume
5757

58+
linknvme:nvme-sndk-capabilities[1]::
59+
Display Sandisk plugin command capabilities
60+
61+
linknvme:nvme-sndk-clear-assert-dump[1]::
62+
Clears the assert dump (if present)
63+
64+
linknvme:nvme-sndk-clear-fw-activate-history[1]::
65+
Clears the firmware activate history table
66+
67+
linknvme:nvme-sndk-clear-pcie-correctable-errors[1]::
68+
Clears the pcie correctable errors returned in the smart-log-add command
69+
70+
linknvme:nvme-sndk-cloud-SSD-plugin-version[1]::
71+
Display Sandisk plugin Cloud SSD Plugin Version
72+
73+
linknvme:nvme-sndk-cloud-boot-SSD-version[1]::
74+
Display Sandisk Cloud Boot SSD Version
75+
76+
linknvme:nvme-sndk-drive-resize[1]::
77+
Send NVMe Sandisk Resize Vendor Unique Command
78+
79+
linknvme:nvme-sndk-get-drive-status[1]::
80+
Send the NVMe Sandisk get-drive-status command
81+
82+
linknvme:nvme-sndk-get-dev-capabilities-log[1]::
83+
Display device capabilities og page data in human readable format
84+
85+
linknvme:nvme-sndk-get-error-recovery-log[1]::
86+
Display error recovery log page data in human readable format
87+
88+
linknvme:nvme-sndk-get-latency-monitor-log[1]::
89+
Display latency monitor log page data in human readable format
90+
91+
linknvme:nvme-sndk-get-unsupported-reqs-log[1]::
92+
Display unsupported requirements log page data in human readable format
93+
94+
linknvme:nvme-sndk-log-page-directory[1]::
95+
Retrieves the list of Log IDs supported by the drive
96+
97+
linknvme:nvme-sndk-namespace-resize[1]::
98+
Resizes the device's namespace
99+
100+
linknvme:nvme-sndk-set-latency-monitor-feature[1]::
101+
Set Latency Monitor feature
102+
103+
linknvme:nvme-sndk-vs-cloud-log[1]::
104+
Display the cloud log page
105+
106+
linknvme:nvme-sndk-vs-device-waf[1]::
107+
Display calculated device Write Amplication Factor
108+
109+
linknvme:nvme-sndk-vs-drive-info[1]::
110+
Send the NVMe Sandisk vs-drive-info command
111+
112+
linknvme:nvme-sndk-vs-error-reason-identifier[1]::
113+
Retrieve Sandisk device's telemetry log error reason identifier field
114+
115+
linknvme:nvme-sndk-vs-fw-activate-history[1]::
116+
Execute NVMe Sandisk vs-fw-activate-history Vendor Unique Command
117+
118+
linknvme:nvme-sndk-vs-hw-rev-log[1]::
119+
Display hardware revision log page
120+
121+
linknvme:nvme-sndk-vs-internal-log[1]::
122+
Retrieve Sandisk device's internal firmware log and save to file
123+
124+
linknvme:nvme-sndk-vs-nand-stats[1]::
125+
Send NVMe Sandisk vs-nand-stats Vendor Unique Command
126+
127+
linknvme:nvme-sndk-vs-pcie-stats[1]::
128+
Send the NVMe Sandisk vs-pcie-stats command
129+
130+
linknvme:nvme-sndk-vs-smart-add-log[1]::
131+
Send NVMe Sandisk smart add log Vendor Unique Command
132+
133+
linknvme:nvme-sndk-vs-telemetry-controller-option[1]::
134+
Disable/Enable the controller initiated option of the telemetry log page
135+
136+
linknvme:nvme-sndk-vs-temperature-stats[1]::
137+
Display temperature-related statistics
138+
58139
linknvme:nvme-toshiba-clear-pcie-correctable-errors[1]::
59140
Reset the PCIe correctable errors count to zero
60141

‎Documentation/meson.build‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,33 @@ adoc_sources = [
144144
'nvme-show-regs',
145145
'nvme-show-topology',
146146
'nvme-smart-log',
147+
'nvme-sndk-capabilities',
148+
'nvme-sndk-clear-assert-dump',
149+
'nvme-sndk-clear-fw-activate-history',
150+
'nvme-sndk-clear-pcie-correctable-errors',
151+
'nvme-sndk-cloud-SSD-plugin-version',
152+
'nvme-sndk-cloud-boot-SSD-version',
153+
'nvme-sndk-drive-resize',
154+
'nvme-sndk-get-drive-status',
155+
'nvme-sndk-get-dev-capabilities-log',
156+
'nvme-sndk-get-error-recovery-log',
157+
'nvme-sndk-get-latency-monitor-log',
158+
'nvme-sndk-get-unsupported-reqs-log',
159+
'nvme-sndk-log-page-directory',
160+
'nvme-sndk-namespace-resize',
161+
'nvme-sndk-set-latency-monitor-feature',
162+
'nvme-sndk-vs-cloud-log',
163+
'nvme-sndk-vs-device-waf',
164+
'nvme-sndk-vs-drive-info',
165+
'nvme-sndk-vs-error-reason-identifier',
166+
'nvme-sndk-vs-fw-activate-history',
167+
'nvme-sndk-vs-hw-rev-log',
168+
'nvme-sndk-vs-internal-log',
169+
'nvme-sndk-vs-nand-stats',
170+
'nvme-sndk-vs-pcie-stats',
171+
'nvme-sndk-vs-smart-add-log',
172+
'nvme-sndk-vs-telemetry-controller-option',
173+
'nvme-sndk-vs-temperature-stats',
147174
'nvme-solidigm-clear-fw-activate-history',
148175
'nvme-solidigm-clear-pcie-correctable-errors',
149176
'nvme-solidigm-cloud-SSDplugin-version',

‎Documentation/nvme-sndk-capabilities.txt‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
nvme-sndk-capabilities(1)
2+
=========================
3+
4+
NAME
5+
----
6+
nvme-sndk-capabilities - Display sndk device command capabilities
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme sndk capabilities' <device>
12+
13+
DESCRIPTION
14+
-----------
15+
16+
For the NVMe device given, displays list of commands and support status.
17+
18+
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
19+
20+
On success it returns 0, error code otherwise.
21+
22+
EXAMPLES
23+
--------
24+
* Displays the capabilities for the device:
25+
+
26+
------------
27+
# nvme sndk capabilities /dev/nvme0
28+
------------
29+
30+
NVME
31+
----
32+
Part of the nvme-user suite.

‎Documentation/nvme-sndk-clear-assert-dump.txt‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
nvme-sndk-clear-assert-dump(1)
2+
==============================
3+
4+
NAME
5+
----
6+
nvme-sndk-clear-assert-dump - Clears the assert dump (if present).
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme sndk clear-assert-dump' <device>
12+
13+
DESCRIPTION
14+
-----------
15+
For the NVMe device given, sends the sndk vendor unique clear assert
16+
dump command.
17+
18+
The <device> parameter is mandatory and must be the NVMe character
19+
device (ex: /dev/nvme0).
20+
21+
This will only work on Sandisk devices supporting this feature.
22+
The command will not be executed on devices that don't support it.
23+
24+
OPTIONS
25+
-------
26+
None
27+
28+
EXAMPLES
29+
--------
30+
* Clears the assert dump (if present):
31+
+
32+
------------
33+
# nvme sndk clear-assert-dump /dev/nvme0
34+
------------
35+
36+
NVME
37+
----
38+
Part of the nvme-user suite

‎Documentation/nvme-sndk-clear-fw-activate-history.txt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
nvme-sndk-clear-fw-activate-history(1)
2+
======================================
3+
4+
NAME
5+
----
6+
nvme-sndk-clear-fw-activate-history - Clears the firmware activate history table.
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme sndk clear-fw-activate-history' <device>
12+
13+
DESCRIPTION
14+
-----------
15+
For the NVMe device given, sends the sndk vendor unique clear fw activate
16+
history command.
17+
18+
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).
19+
20+
This will only work on Sandisk devices supporting this feature.
21+
Results for any other device are undefined.
22+
23+
OPTIONS
24+
-------
25+
None
26+
27+
EXAMPLES
28+
--------
29+
* Clears the firmware activate history table:
30+
+
31+
------------
32+
# nvme sndk clear-fw-activate-history /dev/nvme0
33+
------------
34+
35+
NVME
36+
----
37+
Part of the nvme-user suite

‎Documentation/nvme-sndk-clear-pcie-correctable-errors.txt‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
nvme-sndk-clear-pcie-correctable-errors(1)
2+
==========================================
3+
4+
NAME
5+
----
6+
nvme-sndk-clear-pcie-correctable-errors - Clears the pcie correctable errors field returned in the smart-log-add command.
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme sndk clear-pcie-correctable-errors' <device>
12+
13+
DESCRIPTION
14+
-----------
15+
For the NVMe device given, sends the sndk vendor unique clear pcie
16+
correctable errors command.
17+
18+
The <device> parameter is mandatory and may be either the NVMe
19+
character device (ex: /dev/nvme0), or a namespace block device (ex:
20+
/dev/nvme0n1).
21+
22+
This will only work on Sandisk devices supporting this feature.
23+
Results for any other device are undefined.
24+
25+
OPTIONS
26+
-------
27+
None
28+
29+
EXAMPLES
30+
--------
31+
* Clears the PCIe Correctable Error Count field returned in the smart-log-add command:
32+
+
33+
------------
34+
# nvme sndk clear-pcie-correctable-errors /dev/nvme0
35+
------------
36+
37+
NVME
38+
----
39+
Part of the nvme-user suite

‎Documentation/nvme-sndk-cloud-SSD-plugin-version.txt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
nvme-sndk-cloud-SSD-plugin-version(1)
2+
=====================================
3+
4+
NAME
5+
----
6+
nvme-sndk-cloud-SSD-plugin-version - Display sndk plugin Cloud SSD Plugin Version
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme sndk cloud-SSD-plugin-version' <device>
12+
13+
DESCRIPTION
14+
-----------
15+
16+
For the NVMe device given, this command displays the current Cloud SSD
17+
Plugin Version (if supported by the device).
18+
19+
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
20+
21+
On success it returns 0, error code otherwise.
22+
23+
EXAMPLES
24+
--------
25+
* Displays the cloud ssd plugin version for the device:
26+
+
27+
------------
28+
# nvme sndk cloud-SSD-plugin-version /dev/nvme0
29+
------------
30+
31+
NVME
32+
----
33+
Part of the nvme-user suite.

‎Documentation/nvme-sndk-cloud-boot-SSD-version.txt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
nvme-sndk-cloud-boot-SSD-version(1)
2+
===================================
3+
4+
NAME
5+
----
6+
nvme-sndk-cloud-boot-SSD-version - Display sndk plugin Cloud Boot SSD Version
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme sndk cloud-boot-SSD-version' <device>
12+
13+
DESCRIPTION
14+
-----------
15+
16+
For the NVMe device given, this command displays the current Cloud Hyperscale
17+
Boot Version (if supported by the device).
18+
19+
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
20+
21+
On success it returns 0, error code otherwise.
22+
23+
EXAMPLES
24+
--------
25+
* Displays the cloud boot ssd version for the device:
26+
+
27+
------------
28+
# nvme sndk cloud-boot-SSD-version /dev/nvme0
29+
------------
30+
31+
NVME
32+
----
33+
Part of the nvme-user suite.

‎Documentation/nvme-sndk-drive-resize.txt‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
nvme-sndk-drive-resize(1)
2+
=========================
3+
4+
NAME
5+
----
6+
nvme-sndk-drive-resize - Send NVMe sndk Resize Vendor Unique Command,
7+
return result.
8+
9+
SYNOPSIS
10+
--------
11+
[verse]
12+
'nvme sndk drive-resize' <device> [--size=<sz> | -s <sz>]
13+
14+
DESCRIPTION
15+
-----------
16+
For the NVMe device given, sends a Vendor Unique sndk Resize command.
17+
18+
The <device> parameter is mandatory and may be either the NVMe character
19+
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
20+
21+
This will only work on Sandisk devices supporting this feature.
22+
Results for any other device are undefined.
23+
24+
On success it returns 0, error code otherwise.
25+
26+
OPTIONS
27+
-------
28+
-s <sz>::
29+
--size=<sz>::
30+
The new size (in GB) to resize the drive to.
31+
32+
EXAMPLES
33+
--------
34+
* Has the program issue sndk Resize Vendor Unique Command :
35+
+
36+
------------
37+
# nvme sndk drive-resize /dev/nvme0n1 --size=100
38+
------------
39+
40+
NVME
41+
----
42+
Part of the nvme-user suite.

0 commit comments

Comments
 (0)