summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-write-zeroes.txt
blob: a644ac76d1a7d4eae0c86e327763ab956f4adba2 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
nvme-zeroes(1)
==============

NAME
----
nvme-write-zeroes - Send an NVMe write zeroes command, return results

SYNOPSIS
--------
[verse]
'nvme-write-zeroes' <device> [--start-block=<slba> | -s <slba>]
			[--block-count=<nlb> | -c <nlb>]
			[--ref-tag=<reftag> | -r <reftag>]
			[--prinfo=<prinfo> | -p <prinfo>]
			[--app-tag-mask=<appmask> | -m <appmask>]
			[--app-tag=<apptag> | -a <apptag>]
			[--deac | -d]
			[--limited-retry | -l]
			[--force-unit-access | -f]
			[--namespace-id=<nsid> | -n <nsid>]
			[--storage-tag<storage-tag> | -S <storage-tag>]
			[--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
			[--force]

DESCRIPTION
-----------
The Write Zeroes command is used to set a range of logical blocks to 0.

OPTIONS
-------
--start-block=<slba>::
-s <slba>::
	Start block.

--block-count=<nlb>::
-c <nlb>::
	Number of logical blocks to write zeroes.

--prinfo=<prinfo>::
-p <prinfo>::
	Protection Information field definition.
+
[]
|=================
|Bit|Description
|3|PRACT: Protection Information Action. When set to 1, PI is stripped/inserted
on read/write when the block format's metadata size is 8. When set to 0,
metadata is passes.
|2:0|PRCHK: Protection Information Check:
|2|Set to 1 enables checking the guard tag
|1|Set to 1 enables checking the application tag
|0|Set to 1 enables checking the reference tag
|=================

--ref-tag=<reftag>::
-r <reftag>::
	Optional reftag when used with protection information.

--app-tag-mask=<appmask>::
-m <appmask>::
	Optional application tag mask when used with protection information.

--app-tag=<apptag>::
-a <apptag>::
	Optional application tag when used with protection information.

--limited-retry::
-l::
	Sets the limited retry flag.

--deac::
-d::
	Sets the DEAC bit, requesting controller deallocate the logical blocks.

--force-unit-access::
-f::
	Set the force-unit access flag.

--namespace-id=<nsid>::
-n <nsid>::
	Namespace ID use in the command.

--storage-tag=<storage-tag>::
-n <storage-tag>::
	Variable Sized Expected Logical Block Storage Tag(ELBST) and Expected Logical
	Block Reference Tag (ELBRT), CDW2 and CDW3 (00:47) bits.

--storage-tag-check=<storage-tag-check>::
-C <storage-tag-check>::
	This bit specifies the Storage Tag field shall be checked as part of end-to-end
	data protection processing.

--force::
    Ignore namespace is currently busy and perfome the operation
    even though.

EXAMPLES
--------
No examples yet.

NVME
----
Part of the nvme-user suite