summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-nvme-mi-recv.txt
blob: 152bbe67c0dfcf2c8481eb38341209d934652ad8 (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
nvme-nvme-mi-recv(1)
====================

NAME
----
nvme-nvme-mi-recv - Send a NVMe-MI Receive command to the specified device

SYNOPSIS
--------
[verse]
'nvme nvme-mi-recv' <device> [--opcode=<opcode> | -O <opcode>]
			[--namespace-id=<nsid> | -n <nsid>]
			[--data-len=<data-len> | -l <data-len>]
			[--nmimt=<nmimt> | -m <nmimt>]
			[--nmd0=<nmd0> | -0 <nmd0>] [--nmd1=<nmd1> | -1 <nmd1>]
			[--input-file=<file> | -i <file>]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
Send a NVMe-MI Receive command to the specified device, return results.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

On success it returns 0, error code otherwise.

OPTIONS
-------
-O <opcode>::
--opcode=<opcode>::
	The NVMe-MI opcode to send to the device in the command

-n <nsid>::
--namespace-id=<nsid>::
	The value for the ns-id in the command.

-l <data-len>::
--data-len=<data-len>::
	The data length for the buffer used for this command.

-m <nmimt>::
--nmimt=<nmimt>::
	The value for the NVMe-MI message type in the command.

-0 <nmd0>::
--nmd0=<nmd0>::
	The value for the NVMe management request dword 0 in the command.

-1 <nmd1>::
--nmd1=<nmd1>::
	The value for the NVMe management request dword 1 in the command.

-i <file>::
--input-file=<file>::
	If the command is a data-out (write) command, use this file
	to fill the buffer sent to the device. If no file is given,
	assumed to use STDIN.

-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal', 'json' or 'binary'. Only one
	output format can be used at a time.

-v::
--verbose::
	Increase the information detail in the output.

EXAMPLES
--------
* Has the program issue a nvme-mi-recv to execute the VPD read.
+
------------
# nvme nvme-mi-recv /dev/nvme0n1 -O 5 -m 1 -0 0 -1 0x100 -l 256
------------

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