From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 21:41:32 +0200 Subject: Adding upstream version 2.8. Signed-off-by: Daniel Baumann --- Documentation/nvme-nvme-mi-send.html | 912 +++++++++++++++++++++++++++++++++++ 1 file changed, 912 insertions(+) create mode 100644 Documentation/nvme-nvme-mi-send.html (limited to 'Documentation/nvme-nvme-mi-send.html') diff --git a/Documentation/nvme-nvme-mi-send.html b/Documentation/nvme-nvme-mi-send.html new file mode 100644 index 0000000..85aef3a --- /dev/null +++ b/Documentation/nvme-nvme-mi-send.html @@ -0,0 +1,912 @@ + + + + + + +nvme-nvme-mi-send(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme nvme-mi-send <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 Send 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-send to execute the VPD write. +

    +
    +
    +
    # nvme nvme-mi-send /dev/nvme0n1 -O 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + -- cgit v1.2.3