summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-copy.txt
blob: d6452ec0029c938624cb8e39060ff201e286052f (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
104
105
106
107
108
109
110
111
nvme-copy(1)
============

NAME
----
nvme-copy - Send an NVMe Simple Copy command, provide results

SYNOPSIS
--------
[verse]
'nvme-copy' <device> [--sdlba=<sdlba> | -d <sdlba>]
			[--blocks=<nlb-list,> | -b <nlb-list,>]
			[--slbs=<slbas,> | -s <slbas,>]
			[--limited-retry | -l]
			[--force-unit-access | -f]
			[--prinfow=<prinfow> | -p <prinfow>]
			[--prinfor=<prinfor> | -P <prinfor>]
			[--ref-tag=<reftag> | -r <reftag>]
			[--expected-ref-tags=<reftag,> | -R <reftag,>]
			[--app-tag=<apptag> | -a <apptag>]
			[--expected-app-tags=<apptag,> | -A <apptag,>]
			[--app-mask=<appmask> | -m <appmask>]
			[--expected-app-masks=<appmask,> | -M <appmask,>]
			[--dir-type=<type> | -T <type>]
			[--dir-spec=<spec> | -S <spec>]
			[--format=<entry-format> | -F <entry-format>]

DESCRIPTION
-----------
The Copy command is used by the host to copy data from one or more source
logical block ranges to a single consecutive destination logical block range.

OPTIONS
-------
--sdlba=<sdlba>::
-d <sdlba>::
	64-bit addr of first destination logical block

--blocks=<nlb-list,>::
-b <nlb-list,>::
	Comma separated list of the number of blocks in each range

--slbs=<slbas,>::
-s <slbas,>::
	Comma separated list of the starting blocks in each range

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

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

--prinfow=<prinfow>::
-p <prinfow>::
	Protection Information field write definition.

--prinfor=<prinfor>::
-P <prinfor>::
	Protection Information field read definition.

--ref-tag=<reftag>::
-r <reftag>::
	initial lba reference tag.

--expected-ref-tags=<reftag,>::
-R <reftag,>::
	expected lba reference tags (comma-separated list).

--app-tag=<apptag>::
-a <apptag>::
	lba app tag

--expected-app-tags=<apptag,>::
-A <apptag,>::
	expected lba app tags (comma-separated list)

--app-mask=<appmask>::
-m <appmask>::
	lba tag mask

--expected-app-masks=<appmask,>::
-M <appmask,>::
	expected lba tag masks (comma-separated list)

--dir-type=<type>::
-T <type>::
	Optional directive type. The nvme-cli only enforces the value
	be in the defined range for the directive type, though the NVMe
	specifcation (1.3a) defines only one directive, 01h, for write
	stream idenfiers.

--dir-spec=<spec>::
-S <spec>::
	Optional field for directive specifics. When used with
	write streams, this value is defined to be the write stream
	identifier. The nvme-cli will not validate the stream requested
	is within the controller's capabilities.

--format=<entry-format>::
-F <entry-format>::
	source range entry format

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

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