summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-smart-add-log.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-ocp-smart-add-log.1 (renamed from Documentation/nvme-lnvm-diag-set-bbtbl.1)58
1 files changed, 19 insertions, 39 deletions
diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.1 b/Documentation/nvme-ocp-smart-add-log.1
index d46ee65..3127edc 100644
--- a/Documentation/nvme-lnvm-diag-set-bbtbl.1
+++ b/Documentation/nvme-ocp-smart-add-log.1
@@ -1,13 +1,13 @@
'\" t
-.\" Title: nvme-lnvm-diag-set-bbtbl
+.\" Title: nvme-ocp-smart-add-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 11/11/2021
+.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LNVM\-DIAG\-SE" "1" "11/11/2021" "NVMe" "NVMe Manual"
+.TH "NVME\-OCP\-SMART\-AD" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,49 +28,29 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-nvme-lnvm-diag-set-bbtbl \- Set a block state in the bad block table
+nvme-ocp-smart-add-log \- Retrieves Extended SMART information of given OCP compliant device
.SH "SYNOPSIS"
.sp
.nf
-\fInvme lnvm\-diag\-set\-bbtbl\fR [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-channel\-id=<CHID> | \-c <CHID>]
- [\-\-lun\-id=<LUNID> | \-l <LUNID>]
- [\-\-plane\-id=<PLANEID> | \-p <PLANEID>]
- [\-\-block\-id=<BLKID> | \-b <BLKID>]
- [\-\-value=<NUM> | \-v <NUM>]
+\fInvme ocp smart\-add\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
-Set the bad block table for a given channel, lun, plane and block with value v\&.
+For the NVMe device given, send a smart\-add\-log command and provide the additional smart log\&.
.sp
-For each block available, the status byte is read as follows:
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&.
.sp
-0: Good block 1: Bad block 2: Grown bad block 4: Device reserved block 8: Host\-side reserved block 16: Media managed reserved block
+This will only work on OCP compliant devices supporting this feature\&. Results for any other device are undefined\&.
+.sp
+On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-\-namespace\-id=<NUM>, \-n <NUM>
-.RS 4
-Namespace id to use
-.RE
-.PP
-\-\-channel\-id, \-c
+\-o <format>, \-\-output\-format=<format>
.RS 4
-Channel id
-.RE
-.PP
-\-\-lun\-id, \-l
-.RS 4
-LUN id
-.RE
-.PP
-\-\-plane\-id, \-p
-.RS 4
-Plane id
-.RE
-.PP
-\-\-block\-id, \-b
-.RS 4
-Block id
+Set the reporting format to
+\fInormal\fR
+or
+\fIjson\fR\&. Only one output format can be used at a time\&. The default is normal\&.
.RE
.SH "EXAMPLES"
.sp
@@ -82,18 +62,18 @@ Block id
.sp -1
.IP \(bu 2.3
.\}
-Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad) on physical device /dev/nvme0
-.RE
+Has the program issue a smart\-add\-log command to retrieve the 0xC0 log page\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-# nvme lnvm\-diag\-set\-bbtbl /dev/nvme0 \-c 0 \-l 0 \-p 0 \-b 10 \-v 2
+# nvme ocp smart\-add\-log /dev/nvme0
.fi
.if n \{\
.RE
.\}
+.RE
.SH "NVME"
.sp
-Part of the nvme\-user suite
+Part of the nvme\-user suite\&.