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-wdc-cap-diag.html | 863 +++++++++++++++++++++++++++++++++++ 1 file changed, 863 insertions(+) create mode 100644 Documentation/nvme-wdc-cap-diag.html (limited to 'Documentation/nvme-wdc-cap-diag.html') diff --git a/Documentation/nvme-wdc-cap-diag.html b/Documentation/nvme-wdc-cap-diag.html new file mode 100644 index 0000000..f25b31c --- /dev/null +++ b/Documentation/nvme-wdc-cap-diag.html @@ -0,0 +1,863 @@ + + + + + + +nvme-wdc-cap-diag(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc cap-diag <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the WDC Vendor Unique Capture-Diagnostics +request and saves the result to a file.

+

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

+

This will only work on WDC devices supporting this feature. +Results for any other device are undefined.

+
+
+
+

OPTIONS

+
+
+
+-o <FILE> +
+
+--output-file=<FILE> +
+
+

+ Output file; defaults to device serial number followed by "cap_diag" suffix +

+
+
+-s <SIZE> +
+
+--transfer-size=<SIZE> +
+
+

+ Transfer size; defaults to 0x10000 (65536 decimal) bytes +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Gets the capture diagnostics log from the device and saves to default file in current directory (e.g. STM00019F3F9cap_diag.bin): +

    +
    +
    +
    # nvme wdc cap-diag /dev/nvme0
    +
    +
    • +
  • +

    +Gets the capture diagnostics log from the device and saves to defined file in current directory (e.g. testSTM00019F3F9cap_diag.bin): +

    +
    +
    +
    # nvme wdc cap-diag /dev/nvme0 -o test
    +
    +
    • +
  • +

    +Gets the capture diagnostics log from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9cap_diag.bin): +

    +
    +
    +
    # nvme wdc cap-diag /dev/nvme0 -o /tmp/test
    +
    +
    • +
  • +

    +Gets the capture diagnostics log from the device transferring the data in 64k chunks and saves to default file in current directory (e.g. STM00019F3F9internal_fw_log.bin): +

    +
    +
    +
    # nvme wdc cap-diag /dev/nvme0 -s 0x10000
    +
    +
    • +
  • +

    +Gets the capture diagnostics log from the device transferring the data in 16k chunks and saves to default file in current directory (e.g. STM00019F3F9internal_fw_log.bin): +

    +
    +
    +
    # nvme wdc cap-diag /dev/nvme0 -s 16384
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

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