From mboxrd@z Thu Jan 1 00:00:00 1970 From: chaitanya.kulkarni@hgst.com (Chaitanya Kulkarni) Date: Wed, 28 Jun 2017 19:19:28 -0700 Subject: [PATCH 4/4] nvme-cli : add sanitize-log command documentation. In-Reply-To: <20170629021928.19389-1-chaitanya.kulkarni@hgst.com> References: <20170629021928.19389-1-chaitanya.kulkarni@hgst.com> Message-ID: <20170629021928.19389-5-chaitanya.kulkarni@hgst.com> Signed-off-by: Chaitanya Kulkarni --- Documentation/nvme-sanitize-log.1 | 126 ++++++ Documentation/nvme-sanitize-log.html | 848 +++++++++++++++++++++++++++++++++++ Documentation/nvme-sanitize-log.txt | 67 +++ 3 files changed, 1041 insertions(+) create mode 100644 Documentation/nvme-sanitize-log.1 create mode 100644 Documentation/nvme-sanitize-log.html create mode 100644 Documentation/nvme-sanitize-log.txt diff --git a/Documentation/nvme-sanitize-log.1 b/Documentation/nvme-sanitize-log.1 new file mode 100644 index 0000000..d31dc69 --- /dev/null +++ b/Documentation/nvme-sanitize-log.1 @@ -0,0 +1,126 @@ +'\" t +.\" Title: nvme-sanitize-log +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 06/28/2017 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SANITIZE\-LOG" "1" "06/28/2017" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-sanitize-log \- Send NVMe sanitize\-log Command, return result +.SH "SYNOPSIS" +.sp +.nf +\fInvme sanitize\-log\fR +.fi +.SH "DESCRIPTION" +.sp +Retrieves the NVMe Sanitize log page from an NVMe device and provides the status of sanitize command\&. +.sp +The parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. +.sp +Expected status and description :\- +.TS +allbox tab(:); +ltB ltB. +T{ +Status Code +T}:T{ +Description +T} +.T& +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +0x0000 +T}:T{ +.sp +NVM subsystem has never been sanitized\&. +T} +T{ +.sp +0x0001 +T}:T{ +.sp +The most recent sanitize operation completed successfully\&. +T} +T{ +.sp +0x0002 +T}:T{ +.sp +A sanitize operation is currently in progress\&. +T} +T{ +.sp +0x0003 +T}:T{ +.sp +The most recent sanitize operation failed\&. +T} +T{ +.sp +0x0100 +T}:T{ +.sp +Global Data Erased bit If set to 1 then non\-volatile storage in the NVM subsystem has not been written to: a) since being manufactured and the NVM subsystem has never been sanitized; or b) since the most recent successful sanitize operation\&. If cleared to 0, then non\-volatile storage in the NVM subsystem has been written to: a) since being manufactured and the NVM subsystem has never been sanitized; or b) since the most recent successful sanitize operation of the NVM subsystem\&. +T} +.TE +.sp 1 +.sp +Sanitize Progress \- percentage complete +.sp +On success it returns 0, error code otherwise\&. +.SH "OPTIONS" +.sp +No options yet\&. +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program issue Sanitize\-log Command : +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme sanitize\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-sanitize-log.html b/Documentation/nvme-sanitize-log.html new file mode 100644 index 0000000..2b2c5f0 --- /dev/null +++ b/Documentation/nvme-sanitize-log.html @@ -0,0 +1,848 @@ + + + + + +nvme-sanitize-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme sanitize-log <device>
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe Sanitize log page from an NVMe device and provides the +status of sanitize command.

+

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

+

Expected status and description :-

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

0x0000

NVM subsystem has never been sanitized.

0x0001

The most recent sanitize operation completed successfully.

0x0002

A sanitize operation is currently in progress.

0x0003

The most recent sanitize operation failed.

0x0100

Global Data Erased bit +If set to 1 then non-volatile storage in the NVM subsystem has +not been written to: + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation. +If cleared to 0, then non-volatile storage in the NVM subsystem has been written to: + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation of the NVM subsystem.

+
+

Sanitize Progress - percentage complete

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

+
+

No options yet.

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue Sanitize-log Command : +

    +
    +
    +
    # nvme sanitize-log /dev/nvme0
    +
    +
  • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+

+ + + diff --git a/Documentation/nvme-sanitize-log.txt b/Documentation/nvme-sanitize-log.txt new file mode 100644 index 0000000..a4ff729 --- /dev/null +++ b/Documentation/nvme-sanitize-log.txt @@ -0,0 +1,67 @@ +nvme-sanitize-log(1) +==================== + +NAME +---- +nvme-sanitize-log - Send NVMe sanitize-log Command, return result + +SYNOPSIS +-------- +[verse] +'nvme sanitize-log' + +DESCRIPTION +----------- +Retrieves the NVMe Sanitize log page from an NVMe device and provides the +status of sanitize command. + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +Expected status and description :- + +[cols="2*", options="header"] +|=== +|Status Code |Description + +|0x0000 +|NVM subsystem has never been sanitized. + +|0x0001 +|The most recent sanitize operation completed successfully. + +|0x0002 +|A sanitize operation is currently in progress. + +|0x0003 +|The most recent sanitize operation failed. + +|0x0100 +|Global Data Erased bit +If set to 1 then non-volatile storage in the NVM subsystem has +not been written to: + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation. +If cleared to 0, then non-volatile storage in the NVM subsystem has been written to: + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation of the NVM subsystem. +|=== + +Sanitize Progress - percentage complete + +On success it returns 0, error code otherwise. + +OPTIONS +------- +No options yet. + +EXAMPLES +-------- +* Has the program issue Sanitize-log Command : ++ +------------ +# nvme sanitize-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. -- 2.7.4