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

SYNOPSIS

+
+
+
nvme wdc purge-monitor <device>
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send a Vendor Unique WDC Purge-Monitor command and +provide the status of the purge command.

+

Expected status and description :-

+
+ +++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status Code Description

0x00

Purge State Idle.

0x01

Purge State Done.

0x02

Purge State Busy.

0x03

Purge State Error : Purge operation resulted in error, power cycle required.

0x04

Purge State Error : Purge operation interrupted by power cycle or reset.

+
+

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

+

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

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

+
+

No options yet.

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue WDC Purge-Monitor Vendor Unique Command : +

    +
    +
    +
    # nvme wdc purge-monitor /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

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