Skip to content

Commit e6d0d47

Browse files
francispravin5igaw
authored andcommitted
doc: Add sanitize command emvs option
Add Enter Media Verification State (EVMS) option of Sanitize command. Signed-off-by: Francis Pravin <francis.p@samsung.com>
1 parent f260a8d commit e6d0d47

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

Documentation/nvme-sanitize.txt

+11-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SYNOPSIS
1212
[--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]
1313
[--ause | -u] [--sanact=<action> | -a <action>]
1414
[--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]
15-
[--force]
15+
[--emvs | -e] [--force]
1616
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
1717

1818
DESCRIPTION
@@ -73,6 +73,7 @@ OPTIONS
7373
|0x02 \| 'start-block-erase'| Start a Block Erase sanitize operation
7474
|0x03 \| 'start-overwrite'| Start an Overwrite sanitize operation
7575
|0x04 \| 'start-crypto-erase'| Start a Crypto Erase sanitize operation
76+
|0x05 \| 'exit-media-verification'| Exit Media Verification State
7677
|=================
7778

7879
-p <overwrite-pattern>::
@@ -83,6 +84,15 @@ OPTIONS
8384
specifies a 32-bit pattern that is used for the Overwrite
8485
sanitize operation.
8586

87+
-e::
88+
--emvs::
89+
Enter Media Verification State:
90+
If set, then the Media Verification state shall be entered if sanitize
91+
processing completes successfully. If cleared, then this bit shall have
92+
no effect. If SANACT field does not specify starting a sanitize operation
93+
(i.e., is set to any value other than 010b, 011b, or 100b), then this bit
94+
shall be ignored by the controller.
95+
8696
--force::
8797
Ignore namespace is currently busy and performed the operation
8898
even though.

completions/_nvme

+3-1
Original file line numberDiff line numberDiff line change
@@ -1525,10 +1525,12 @@ _nvme () {
15251525
-n':alias of --owpass'
15261526
--ause':Allow unrestricted sanitize exit'
15271527
-u':alias of --ause'
1528-
--sanact=':Sanitize action: 1 = Exit failure mode, 2 = Start block erase, 3 = Start overwrite, 4 = Start crypto erase'
1528+
--sanact=':Sanitize action: 1 = Exit failure mode, 2 = Start block erase, 3 = Start overwrite, 4 = Start crypto erase, 5 = Exit media verification'
15291529
-a':alias of --sanact'
15301530
--ovrpat=':Overwrite pattern'
15311531
-p':alias of --ovrpat'
1532+
--emvs=':Enter media verification state'
1533+
-e':alias of --emvs'
15321534
)
15331535
_arguments '*:: :->subcmds'
15341536
_describe -t commands "nvme sanitize options" _sanitize

completions/bash-nvme-completion.sh

+3-2
Original file line numberDiff line numberDiff line change
@@ -356,10 +356,11 @@ nvme_list_opts () {
356356
;;
357357
"sanitize")
358358
opts+=" --no-dealloc -d --oipbp -i --owpass= -n \
359-
--ause -u --sanact= -a --ovrpat= -p"
359+
--ause -u --sanact= -a --ovrpat= -p --emvs= -e"
360360
case $opt in
361361
--sanact|-a)
362-
vals+=" exit-failure start-block-erase start-overwrite start-crypto-erase"
362+
vals+=" exit-failure start-block-erase start-overwrite \
363+
start-crypto-erase exit-media-verification"
363364
;;
364365
esac
365366
;;

0 commit comments

Comments
 (0)