]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
nvme: Add id-ns-lba-format(CNS 09h) command from TP4095
authorSteven Seungcheol Lee <sc108.lee@samsung.com>
Thu, 6 Jan 2022 07:54:07 +0000 (16:54 +0900)
committerDaniel Wagner <dwagner@suse.de>
Fri, 4 Feb 2022 13:07:09 +0000 (14:07 +0100)
Identify Namespace data structure for the specified
User Data Format index containing the namespace capabilities
for the NVM Command Set.

None capabilities from nvme_id_ns structure are returned as 0 with this command

Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>
Documentation/nvme-id-ns-lba-format.1 [new file with mode: 0644]
Documentation/nvme-id-ns-lba-format.html [new file with mode: 0644]
Documentation/nvme-id-ns-lba-format.txt [new file with mode: 0644]
completions/_nvme
completions/bash-nvme-completion.sh
nvme-builtin.h
nvme-print.c
nvme-print.h
nvme.c

diff --git a/Documentation/nvme-id-ns-lba-format.1 b/Documentation/nvme-id-ns-lba-format.1
new file mode 100644 (file)
index 0000000..cb6c2a9
--- /dev/null
@@ -0,0 +1,172 @@
+'\" t
+.\"     Title: nvme-id-ns-lba-format
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\"      Date: 01/07/2022
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ID\-NS\-LBA\-F" "1" "01/07/2022" "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-id-ns-lba-format \- Send NVMe Identify Namespace for the specified LBA Format index, display structure
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme id\-ns\fR <device> [\-\-uuid\-index=<uuid\-index> | \-U <uuid_index>]
+                    [\-\-lba\-format\-index=<lba_format_index> | \-i <lba_format_index>]
+                        [\-v | \-\-verbose]
+                        [\-\-output\-format=<fmt> | \-o <fmt>]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, sends an identify namespace for the specified LBA Format index command and provides the result that is include capability field only and returned structure\&.
+.sp
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
+.sp
+On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&.
+.SH "OPTIONS"
+.PP
+\-U <uuid\-index>, \-\-uuid\-index=<uuid\-index>
+.RS 4
+UUID Index of the feature
+.RE
+.PP
+\-i <lba_format_index>, \-\-lba\-format\-index=<lba_format_index>
+.RS 4
+This field specifies the index into the LBA Format list identifying the LBA Format capabilities that are to be returned
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
+.PP
+\-o <format>, \-\-output\-format=<format>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR, or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Has the program interpret the returned buffer and display the known fields in a human readable format:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme id\-ns\-lba\-format /dev/nvme0n1 \-i 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Have the program return the raw structure in binary:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme id\-ns\-lba\-format /dev/nvme0n1 \-i 0 \-o binary > id_ns\&.raw
+# nvme id\-ns\-lba\-format /dev/nvme0n1 \-i 0 \-\-output\-format=binary > id_ns\&.raw
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+It is probably a bad idea to not redirect stdout when using this mode\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Alternatively you may want to send the data to another program that can parse the raw buffer\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme id\-ns\-lba\-format /dev/nvme0n1 \-i 0 \-\-raw\-binary | nvme_parse_id_ns
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+The parse program in the above example can be a program that shows the structure in a way you like\&. The following program is such an example that will parse it and can accept the output through a pipe,
+\*(Aq|\*(Aq, as shown in the above example, or you can
+\*(Aqcat\*(Aq
+a saved output buffer to it\&.
+.RE
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+/* File: nvme_parse_id_ns_lba_format\&.c */
+
+#include <linux/nvme\&.h>
+#include <stdio\&.h>
+#include <unistd\&.h>
+
+int main(int argc, char **argv)
+{
+        unsigned char buf[sizeof(struct nvme_id_ns)];
+        struct nvme_id_ns *ns = (struct nvme_id_ns *)buf;
+
+        if (read(STDIN_FILENO, buf, sizeof(buf)))
+                return 1;
+
+        printf("nsze : %#llx\en", ns\->nlbaf);
+        printf("ncap : %#llx\en", ns\->mc);
+        return 0;
+}
+.fi
+.if n \{\
+.RE
+.\}
+.SH "NVME"
+.sp
+Part of the nvme\-user suite
diff --git a/Documentation/nvme-id-ns-lba-format.html b/Documentation/nvme-id-ns-lba-format.html
new file mode 100644 (file)
index 0000000..1a4b83f
--- /dev/null
@@ -0,0 +1,901 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 8.6.8" />\r
+<title>nvme-id-ns-lba-format(1)</title>\r
+<style type="text/css">\r
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
+\r
+/* Default font. */\r
+body {\r
+  font-family: Georgia,serif;\r
+}\r
+\r
+/* Title font. */\r
+h1, h2, h3, h4, h5, h6,\r
+div.title, caption.title,\r
+thead, p.table.header,\r
+#toctitle,\r
+#author, #revnumber, #revdate, #revremark,\r
+#footer {\r
+  font-family: Arial,Helvetica,sans-serif;\r
+}\r
+\r
+body {\r
+  margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a {\r
+  color: blue;\r
+  text-decoration: underline;\r
+}\r
+a:visited {\r
+  color: fuchsia;\r
+}\r
+\r
+em {\r
+  font-style: italic;\r
+  color: navy;\r
+}\r
+\r
+strong {\r
+  font-weight: bold;\r
+  color: #083194;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+  color: #527bbd;\r
+  margin-top: 1.2em;\r
+  margin-bottom: 0.5em;\r
+  line-height: 1.3;\r
+}\r
+\r
+h1, h2, h3 {\r
+  border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+  padding-top: 0.5em;\r
+}\r
+h3 {\r
+  float: left;\r
+}\r
+h3 + * {\r
+  clear: left;\r
+}\r
+h5 {\r
+  font-size: 1.0em;\r
+}\r
+\r
+div.sectionbody {\r
+  margin-left: 0;\r
+}\r
+\r
+hr {\r
+  border: 1px solid silver;\r
+}\r
+\r
+p {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+ul, ol, li > p {\r
+  margin-top: 0;\r
+}\r
+ul > li     { color: #aaa; }\r
+ul > li > * { color: black; }\r
+\r
+.monospaced, code, pre {\r
+  font-family: "Courier New", Courier, monospace;\r
+  font-size: inherit;\r
+  color: navy;\r
+  padding: 0;\r
+  margin: 0;\r
+}\r
+\r
+\r
+#author {\r
+  color: #527bbd;\r
+  font-weight: bold;\r
+  font-size: 1.1em;\r
+}\r
+#email {\r
+}\r
+#revnumber, #revdate, #revremark {\r
+}\r
+\r
+#footer {\r
+  font-size: small;\r
+  border-top: 2px solid silver;\r
+  padding-top: 0.5em;\r
+  margin-top: 4.0em;\r
+}\r
+#footer-text {\r
+  float: left;\r
+  padding-bottom: 0.5em;\r
+}\r
+#footer-badges {\r
+  float: right;\r
+  padding-bottom: 0.5em;\r
+}\r
+\r
+#preamble {\r
+  margin-top: 1.5em;\r
+  margin-bottom: 1.5em;\r
+}\r
+div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+  margin-top: 1.0em;\r
+  margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+  margin-top: 2.0em;\r
+  margin-bottom: 2.0em;\r
+  margin-right: 10%;\r
+  color: #606060;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+  padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+  color: #527bbd;\r
+  font-weight: bold;\r
+  text-align: left;\r
+  margin-top: 1.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+  margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+  margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+  background: #ffffee;\r
+  border: 1px solid #dddddd;\r
+  border-left: 4px solid #f0f0f0;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+  border: 1px solid #dddddd;\r
+  border-left: 5px solid #f0f0f0;\r
+  background: #f8f8f8;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock, div.verseblock {\r
+  padding-left: 1.0em;\r
+  margin-left: 1.0em;\r
+  margin-right: 10%;\r
+  border-left: 5px solid #f0f0f0;\r
+  color: #888;\r
+}\r
+\r
+div.quoteblock > div.attribution {\r
+  padding-top: 0.5em;\r
+  text-align: right;\r
+}\r
+\r
+div.verseblock > pre.content {\r
+  font-family: inherit;\r
+  font-size: inherit;\r
+}\r
+div.verseblock > div.attribution {\r
+  padding-top: 0.75em;\r
+  text-align: left;\r
+}\r
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */\r
+div.verseblock + div.attribution {\r
+  text-align: left;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+  vertical-align: top;\r
+  font-size: 1.1em;\r
+  font-weight: bold;\r
+  text-decoration: underline;\r
+  color: #527bbd;\r
+  padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+  padding-left: 0.5em;\r
+  border-left: 3px solid #dddddd;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+  border-left: 3px solid #dddddd;\r
+  padding-left: 0.5em;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+span.image img { border-style: none; }\r
+a.image:visited { color: white; }\r
+\r
+dl {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+dt {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0;\r
+  font-style: normal;\r
+  color: navy;\r
+}\r
+dd > *:first-child {\r
+  margin-top: 0.1em;\r
+}\r
+\r
+ul, ol {\r
+    list-style-position: outside;\r
+}\r
+ol.arabic {\r
+  list-style-type: decimal;\r
+}\r
+ol.loweralpha {\r
+  list-style-type: lower-alpha;\r
+}\r
+ol.upperalpha {\r
+  list-style-type: upper-alpha;\r
+}\r
+ol.lowerroman {\r
+  list-style-type: lower-roman;\r
+}\r
+ol.upperroman {\r
+  list-style-type: upper-roman;\r
+}\r
+\r
+div.compact ul, div.compact ol,\r
+div.compact p, div.compact p,\r
+div.compact div, div.compact div {\r
+  margin-top: 0.1em;\r
+  margin-bottom: 0.1em;\r
+}\r
+\r
+tfoot {\r
+  font-weight: bold;\r
+}\r
+td > div.verse {\r
+  white-space: pre;\r
+}\r
+\r
+div.hdlist {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+div.hdlist tr {\r
+  padding-bottom: 15px;\r
+}\r
+dt.hdlist1.strong, td.hdlist1.strong {\r
+  font-weight: bold;\r
+}\r
+td.hdlist1 {\r
+  vertical-align: top;\r
+  font-style: normal;\r
+  padding-right: 0.8em;\r
+  color: navy;\r
+}\r
+td.hdlist2 {\r
+  vertical-align: top;\r
+}\r
+div.hdlist.compact tr {\r
+  margin: 0;\r
+  padding-bottom: 0;\r
+}\r
+\r
+.comment {\r
+  background: yellow;\r
+}\r
+\r
+.footnote, .footnoteref {\r
+  font-size: 0.8em;\r
+}\r
+\r
+span.footnote, span.footnoteref {\r
+  vertical-align: super;\r
+}\r
+\r
+#footnotes {\r
+  margin: 20px 0 20px 0;\r
+  padding: 7px 0 0 0;\r
+}\r
+\r
+#footnotes div.footnote {\r
+  margin: 0 0 5px 0;\r
+}\r
+\r
+#footnotes hr {\r
+  border: none;\r
+  border-top: 1px solid silver;\r
+  height: 1px;\r
+  text-align: left;\r
+  margin-left: 0;\r
+  width: 20%;\r
+  min-width: 100px;\r
+}\r
+\r
+div.colist td {\r
+  padding-right: 0.5em;\r
+  padding-bottom: 0.3em;\r
+  vertical-align: top;\r
+}\r
+div.colist td img {\r
+  margin-top: 0.3em;\r
+}\r
+\r
+@media print {\r
+  #footer-badges { display: none; }\r
+}\r
+\r
+#toc {\r
+  margin-bottom: 2.5em;\r
+}\r
+\r
+#toctitle {\r
+  color: #527bbd;\r
+  font-size: 1.1em;\r
+  font-weight: bold;\r
+  margin-top: 1.0em;\r
+  margin-bottom: 0.1em;\r
+}\r
+\r
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
+  margin-top: 0;\r
+  margin-bottom: 0;\r
+}\r
+div.toclevel2 {\r
+  margin-left: 2em;\r
+  font-size: 0.9em;\r
+}\r
+div.toclevel3 {\r
+  margin-left: 4em;\r
+  font-size: 0.9em;\r
+}\r
+div.toclevel4 {\r
+  margin-left: 6em;\r
+  font-size: 0.9em;\r
+}\r
+\r
+span.aqua { color: aqua; }\r
+span.black { color: black; }\r
+span.blue { color: blue; }\r
+span.fuchsia { color: fuchsia; }\r
+span.gray { color: gray; }\r
+span.green { color: green; }\r
+span.lime { color: lime; }\r
+span.maroon { color: maroon; }\r
+span.navy { color: navy; }\r
+span.olive { color: olive; }\r
+span.purple { color: purple; }\r
+span.red { color: red; }\r
+span.silver { color: silver; }\r
+span.teal { color: teal; }\r
+span.white { color: white; }\r
+span.yellow { color: yellow; }\r
+\r
+span.aqua-background { background: aqua; }\r
+span.black-background { background: black; }\r
+span.blue-background { background: blue; }\r
+span.fuchsia-background { background: fuchsia; }\r
+span.gray-background { background: gray; }\r
+span.green-background { background: green; }\r
+span.lime-background { background: lime; }\r
+span.maroon-background { background: maroon; }\r
+span.navy-background { background: navy; }\r
+span.olive-background { background: olive; }\r
+span.purple-background { background: purple; }\r
+span.red-background { background: red; }\r
+span.silver-background { background: silver; }\r
+span.teal-background { background: teal; }\r
+span.white-background { background: white; }\r
+span.yellow-background { background: yellow; }\r
+\r
+span.big { font-size: 2em; }\r
+span.small { font-size: 0.6em; }\r
+\r
+span.underline { text-decoration: underline; }\r
+span.overline { text-decoration: overline; }\r
+span.line-through { text-decoration: line-through; }\r
+\r
+div.unbreakable { page-break-inside: avoid; }\r
+\r
+\r
+/*\r
+ * xhtml11 specific\r
+ *\r
+ * */\r
+\r
+div.tableblock {\r
+  margin-top: 1.0em;\r
+  margin-bottom: 1.5em;\r
+}\r
+div.tableblock > table {\r
+  border: 3px solid #527bbd;\r
+}\r
+thead, p.table.header {\r
+  font-weight: bold;\r
+  color: #527bbd;\r
+}\r
+p.table {\r
+  margin-top: 0;\r
+}\r
+/* Because the table frame attribute is overridden by CSS in most browsers. */\r
+div.tableblock > table[frame="void"] {\r
+  border-style: none;\r
+}\r
+div.tableblock > table[frame="hsides"] {\r
+  border-left-style: none;\r
+  border-right-style: none;\r
+}\r
+div.tableblock > table[frame="vsides"] {\r
+  border-top-style: none;\r
+  border-bottom-style: none;\r
+}\r
+\r
+\r
+/*\r
+ * html5 specific\r
+ *\r
+ * */\r
+\r
+table.tableblock {\r
+  margin-top: 1.0em;\r
+  margin-bottom: 1.5em;\r
+}\r
+thead, p.tableblock.header {\r
+  font-weight: bold;\r
+  color: #527bbd;\r
+}\r
+p.tableblock {\r
+  margin-top: 0;\r
+}\r
+table.tableblock {\r
+  border-width: 3px;\r
+  border-spacing: 0px;\r
+  border-style: solid;\r
+  border-color: #527bbd;\r
+  border-collapse: collapse;\r
+}\r
+th.tableblock, td.tableblock {\r
+  border-width: 1px;\r
+  padding: 4px;\r
+  border-style: solid;\r
+  border-color: #527bbd;\r
+}\r
+\r
+table.tableblock.frame-topbot {\r
+  border-left-style: hidden;\r
+  border-right-style: hidden;\r
+}\r
+table.tableblock.frame-sides {\r
+  border-top-style: hidden;\r
+  border-bottom-style: hidden;\r
+}\r
+table.tableblock.frame-none {\r
+  border-style: hidden;\r
+}\r
+\r
+th.tableblock.halign-left, td.tableblock.halign-left {\r
+  text-align: left;\r
+}\r
+th.tableblock.halign-center, td.tableblock.halign-center {\r
+  text-align: center;\r
+}\r
+th.tableblock.halign-right, td.tableblock.halign-right {\r
+  text-align: right;\r
+}\r
+\r
+th.tableblock.valign-top, td.tableblock.valign-top {\r
+  vertical-align: top;\r
+}\r
+th.tableblock.valign-middle, td.tableblock.valign-middle {\r
+  vertical-align: middle;\r
+}\r
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {\r
+  vertical-align: bottom;\r
+}\r
+\r
+\r
+/*\r
+ * manpage specific\r
+ *\r
+ * */\r
+\r
+body.manpage h1 {\r
+  padding-top: 0.5em;\r
+  padding-bottom: 0.5em;\r
+  border-top: 2px solid silver;\r
+  border-bottom: 2px solid silver;\r
+}\r
+body.manpage h2 {\r
+  border-style: none;\r
+}\r
+body.manpage div.sectionbody {\r
+  margin-left: 3em;\r
+}\r
+\r
+@media print {\r
+  body.manpage div#toc { display: none; }\r
+}\r
+\r
+\r
+</style>\r
+<script type="text/javascript">\r
+/*<![CDATA[*/\r
+var asciidoc = {  // Namespace.\r
+\r
+/////////////////////////////////////////////////////////////////////\r
+// Table Of Contents generator\r
+/////////////////////////////////////////////////////////////////////\r
+\r
+/* Author: Mihai Bazon, September 2002\r
+ * http://students.infoiasi.ro/~mishoo\r
+ *\r
+ * Table Of Content generator\r
+ * Version: 0.4\r
+ *\r
+ * Feel free to use this script under the terms of the GNU General Public\r
+ * License, as long as you do not remove or alter this notice.\r
+ */\r
+\r
+ /* modified by Troy D. Hanson, September 2006. License: GPL */\r
+ /* modified by Stuart Rackham, 2006, 2009. License: GPL */\r
+\r
+// toclevels = 1..4.\r
+toc: function (toclevels) {\r
+\r
+  function getText(el) {\r
+    var text = "";\r
+    for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
+      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.\r
+        text += i.data;\r
+      else if (i.firstChild != null)\r
+        text += getText(i);\r
+    }\r
+    return text;\r
+  }\r
+\r
+  function TocEntry(el, text, toclevel) {\r
+    this.element = el;\r
+    this.text = text;\r
+    this.toclevel = toclevel;\r
+  }\r
+\r
+  function tocEntries(el, toclevels) {\r
+    var result = new Array;\r
+    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');\r
+    // Function that scans the DOM tree for header elements (the DOM2\r
+    // nodeIterator API would be a better technique but not supported by all\r
+    // browsers).\r
+    var iterate = function (el) {\r
+      for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
+        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
+          var mo = re.exec(i.tagName);\r
+          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
+            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
+          }\r
+          iterate(i);\r
+        }\r
+      }\r
+    }\r
+    iterate(el);\r
+    return result;\r
+  }\r
+\r
+  var toc = document.getElementById("toc");\r
+  if (!toc) {\r
+    return;\r
+  }\r
+\r
+  // Delete existing TOC entries in case we're reloading the TOC.\r
+  var tocEntriesToRemove = [];\r
+  var i;\r
+  for (i = 0; i < toc.childNodes.length; i++) {\r
+    var entry = toc.childNodes[i];\r
+    if (entry.nodeName.toLowerCase() == 'div'\r
+     && entry.getAttribute("class")\r
+     && entry.getAttribute("class").match(/^toclevel/))\r
+      tocEntriesToRemove.push(entry);\r
+  }\r
+  for (i = 0; i < tocEntriesToRemove.length; i++) {\r
+    toc.removeChild(tocEntriesToRemove[i]);\r
+  }\r
+\r
+  // Rebuild TOC entries.\r
+  var entries = tocEntries(document.getElementById("content"), toclevels);\r
+  for (var i = 0; i < entries.length; ++i) {\r
+    var entry = entries[i];\r
+    if (entry.element.id == "")\r
+      entry.element.id = "_toc_" + i;\r
+    var a = document.createElement("a");\r
+    a.href = "#" + entry.element.id;\r
+    a.appendChild(document.createTextNode(entry.text));\r
+    var div = document.createElement("div");\r
+    div.appendChild(a);\r
+    div.className = "toclevel" + entry.toclevel;\r
+    toc.appendChild(div);\r
+  }\r
+  if (entries.length == 0)\r
+    toc.parentNode.removeChild(toc);\r
+},\r
+\r
+\r
+/////////////////////////////////////////////////////////////////////\r
+// Footnotes generator\r
+/////////////////////////////////////////////////////////////////////\r
+\r
+/* Based on footnote generation code from:\r
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
+ */\r
+\r
+footnotes: function () {\r
+  // Delete existing footnote entries in case we're reloading the footnodes.\r
+  var i;\r
+  var noteholder = document.getElementById("footnotes");\r
+  if (!noteholder) {\r
+    return;\r
+  }\r
+  var entriesToRemove = [];\r
+  for (i = 0; i < noteholder.childNodes.length; i++) {\r
+    var entry = noteholder.childNodes[i];\r
+    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")\r
+      entriesToRemove.push(entry);\r
+  }\r
+  for (i = 0; i < entriesToRemove.length; i++) {\r
+    noteholder.removeChild(entriesToRemove[i]);\r
+  }\r
+\r
+  // Rebuild footnote entries.\r
+  var cont = document.getElementById("content");\r
+  var spans = cont.getElementsByTagName("span");\r
+  var refs = {};\r
+  var n = 0;\r
+  for (i=0; i<spans.length; i++) {\r
+    if (spans[i].className == "footnote") {\r
+      n++;\r
+      var note = spans[i].getAttribute("data-note");\r
+      if (!note) {\r
+        // Use [\s\S] in place of . so multi-line matches work.\r
+        // Because JavaScript has no s (dotall) regex flag.\r
+        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
+        spans[i].innerHTML =\r
+          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
+          "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+        spans[i].setAttribute("data-note", note);\r
+      }\r
+      noteholder.innerHTML +=\r
+        "<div class='footnote' id='_footnote_" + n + "'>" +\r
+        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
+        n + "</a>. " + note + "</div>";\r
+      var id =spans[i].getAttribute("id");\r
+      if (id != null) refs["#"+id] = n;\r
+    }\r
+  }\r
+  if (n == 0)\r
+    noteholder.parentNode.removeChild(noteholder);\r
+  else {\r
+    // Process footnoterefs.\r
+    for (i=0; i<spans.length; i++) {\r
+      if (spans[i].className == "footnoteref") {\r
+        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
+        href = href.match(/#.*/)[0];  // Because IE return full URL.\r
+        n = refs[href];\r
+        spans[i].innerHTML =\r
+          "[<a href='#_footnote_" + n +\r
+          "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+      }\r
+    }\r
+  }\r
+},\r
+\r
+install: function(toclevels) {\r
+  var timerId;\r
+\r
+  function reinstall() {\r
+    asciidoc.footnotes();\r
+    if (toclevels) {\r
+      asciidoc.toc(toclevels);\r
+    }\r
+  }\r
+\r
+  function reinstallAndRemoveTimer() {\r
+    clearInterval(timerId);\r
+    reinstall();\r
+  }\r
+\r
+  timerId = setInterval(reinstall, 500);\r
+  if (document.addEventListener)\r
+    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
+  else\r
+    window.onload = reinstallAndRemoveTimer;\r
+}\r
+\r
+}\r
+asciidoc.install();\r
+/*]]>*/\r
+</script>\r
+</head>\r
+<body class="manpage">\r
+<div id="header">\r
+<h1>\r
+nvme-id-ns-lba-format(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>nvme-id-ns-lba-format -\r
+   Send NVMe Identify Namespace for the specified LBA Format index, display structure\r
+</p>\r
+</div>\r
+</div>\r
+<div id="content">\r
+<div class="sect1">\r
+<h2 id="_synopsis">SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<div class="verseblock">\r
+<pre class="content"><em>nvme id-ns</em> &lt;device&gt; [--uuid-index=&lt;uuid-index&gt; | -U &lt;uuid_index&gt;]\r
+                    [--lba-format-index=&lt;lba_format_index&gt; | -i &lt;lba_format_index&gt;]\r
+                        [-v | --verbose]\r
+                        [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>\r
+<div class="attribution">\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_description">DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>For the NVMe device given, sends an identify namespace for\r
+the specified LBA Format index command and provides the result\r
+that is include capability field only and returned structure.</p></div>\r
+<div class="paragraph"><p>The &lt;device&gt; parameter is mandatory and may be either the NVMe character\r
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>\r
+<div class="paragraph"><p>On success, the structure may be returned in one of several ways depending\r
+on the option flags; the structure may be parsed by the program or the\r
+raw buffer may be printed to stdout.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_options">OPTIONS</h2>\r
+<div class="sectionbody">\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-U &lt;uuid-index&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--uuid-index=&lt;uuid-index&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        UUID Index of the feature\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-i &lt;lba_format_index&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--lba-format-index=&lt;lba_format_index&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        This field specifies the index into the LBA Format list identifying\r
+        the LBA Format capabilities that are to be returned\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+        Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-o &lt;format&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=&lt;format&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+              Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+              <em>binary</em>. Only one output format can be used at a time.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_examples">EXAMPLES</h2>\r
+<div class="sectionbody">\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+Has the program interpret the returned buffer and display the known\r
+fields in a human readable format:\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme id-ns-lba-format /dev/nvme0n1 -i 0</code></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+Have the program return the raw structure in binary:\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme id-ns-lba-format /dev/nvme0n1 -i 0 -o binary &gt; id_ns.raw\r
+# nvme id-ns-lba-format /dev/nvme0n1 -i 0 --output-format=binary &gt; id_ns.raw</code></pre>\r
+</div></div>\r
+<div class="paragraph"><p>It is probably a bad idea to not redirect stdout when using this mode.</p></div>\r
+</li>\r
+<li>\r
+<p>\r
+Alternatively you may want to send the data to another program that\r
+can parse the raw buffer.\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme id-ns-lba-format /dev/nvme0n1 -i 0 --raw-binary | nvme_parse_id_ns</code></pre>\r
+</div></div>\r
+<div class="paragraph"><p>The parse program in the above example can be a program that shows the\r
+structure in a way you like. The following program is such an example\r
+that will parse it and can accept the output through a pipe, <code>'|'</code>,\r
+as shown in the above example, or you can <code>'cat'</code> a saved output buffer\r
+to it.</p></div>\r
+</li>\r
+</ul></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code>/* File: nvme_parse_id_ns_lba_format.c */\r
+\r
+#include &lt;linux/nvme.h&gt;\r
+#include &lt;stdio.h&gt;\r
+#include &lt;unistd.h&gt;\r
+\r
+int main(int argc, char **argv)\r
+{\r
+        unsigned char buf[sizeof(struct nvme_id_ns)];\r
+        struct nvme_id_ns *ns = (struct nvme_id_ns *)buf;\r
+\r
+        if (read(STDIN_FILENO, buf, sizeof(buf)))\r
+                return 1;\r
+\r
+        printf("nsze : %#llx\n", ns-&gt;nlbaf);\r
+        printf("ncap : %#llx\n", ns-&gt;mc);\r
+        return 0;\r
+}</code></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_nvme">NVME</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Part of the nvme-user suite</p></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div id="footnotes"><hr /></div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated 2022-01-07 13:48:12 KST\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
diff --git a/Documentation/nvme-id-ns-lba-format.txt b/Documentation/nvme-id-ns-lba-format.txt
new file mode 100644 (file)
index 0000000..32df2f6
--- /dev/null
@@ -0,0 +1,102 @@
+nvme-id-ns-lba-format(1)
+========================
+
+NAME
+----
+nvme-id-ns-lba-format - Send NVMe Identify Namespace for the specified LBA Format index, display structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme id-ns' <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
+                   [--lba-format-index=<lba_format_index> | -i <lba_format_index>]
+                       [-v | --verbose]
+                       [--output-format=<fmt> | -o <fmt>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends an identify namespace for
+the specified LBA Format index command and provides the result
+that is include capability field only and returned structure.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the structure may be returned in one of several ways depending
+on the option flags; the structure may be parsed by the program or the
+raw buffer may be printed to stdout.
+
+OPTIONS
+-------
+-U <uuid-index>::
+--uuid-index=<uuid-index>::
+       UUID Index of the feature
+       
+-i <lba_format_index>::
+--lba-format-index=<lba_format_index>::
+       This field specifies the index into the LBA Format list identifying
+       the LBA Format capabilities that are to be returned
+
+-v::
+--verbose::
+       Increase the information detail in the output.
+
+-o <format>::
+--output-format=<format>::
+              Set the reporting format to 'normal', 'json', or
+              'binary'. Only one output format can be used at a time.
+
+EXAMPLES
+--------
+* Has the program interpret the returned buffer and display the known
+fields in a human readable format:
++
+------------
+# nvme id-ns-lba-format /dev/nvme0n1 -i 0
+------------
++
+* Have the program return the raw structure in binary:
++
+------------
+# nvme id-ns-lba-format /dev/nvme0n1 -i 0 -o binary > id_ns.raw
+# nvme id-ns-lba-format /dev/nvme0n1 -i 0 --output-format=binary > id_ns.raw
+------------
++
+It is probably a bad idea to not redirect stdout when using this mode.
+
+* Alternatively you may want to send the data to another program that
+can parse the raw buffer.
++
+------------
+# nvme id-ns-lba-format /dev/nvme0n1 -i 0 --raw-binary | nvme_parse_id_ns
+------------
++
+The parse program in the above example can be a program that shows the
+structure in a way you like. The following program is such an example
+that will parse it and can accept the output through a pipe, `'|'`,
+as shown in the above example, or you can `'cat'` a saved output buffer
+to it.
+------------
+/* File: nvme_parse_id_ns_lba_format.c */
+
+#include <linux/nvme.h>
+#include <stdio.h>
+#include <unistd.h>
+
+int main(int argc, char **argv)
+{
+       unsigned char buf[sizeof(struct nvme_id_ns)];
+       struct nvme_id_ns *ns = (struct nvme_id_ns *)buf;
+
+       if (read(STDIN_FILENO, buf, sizeof(buf)))
+               return 1;
+
+       printf("nsze : %#llx\n", ns->nlbaf);
+       printf("ncap : %#llx\n", ns->mc);
+       return 0;
+}
+------------
+
+NVME
+----
+Part of the nvme-user suite
index b2836158adfa46b5ef883bdbb18c70bf44bbbf01..03398f3a58285886fe6c694341af44914a0e29cf 100644 (file)
@@ -9,6 +9,7 @@ _nvme () {
        _cmds=(
        'id-ctrl:display information about the controller'
        'id-ns:display information about the namespace'
+       'id-ns-lba-format:display information about the namespace capability fields for specific LBA format'
        'list-ns:identify all namespace(s) attached'
        'cmdset-ind-id-ns:display I/O Command Set Independent information about the namespace'
        'id-iocs:display information about I/O command sets'
@@ -100,6 +101,22 @@ _nvme () {
                        _arguments '*:: :->subcmds'
                        _describe -t commands "nvme id-ns options" _idns
                        ;;
+               (id-ns-lba-format)
+                       local _idns_lba_format
+                       _idns_lba_format=(
+                       /dev/nvme':supply a device to use (required)'
+                       --lba-format-index=':show infos for lba format index <lba-format-index>'
+                       -i':alias of --lba-format-index'
+                       --uuid-index=':uuid index'
+                       -U':alias for --uuid-index'
+                       --output-format=':Output format: normal|json|binary'
+                       -o':alias for --output-format'
+                       --verbose':show infos verbosely'
+                       -v':alias of --verbose'
+                       )
+                       _arguments '*:: :->subcmds'
+                       _describe -t commands "nvme id-ns-lba-format options" _idns_lba_format
+                       ;;
                (list-ns)
                        local _listns
                        _listns=(
@@ -914,7 +931,7 @@ _nvme () {
                             resv-report flush compare read write copy show-regs persistent-event-log
                                 pred-lat-event-agg-log nvm-id-ctrl endurance-event-agg-log lba-status-log
                                 resv-notif-log capacity-mgmt id-domain boot-part-log fid-support-effects-log
-                                supported-log-pages lockdown media-unit-stat-log
+                                supported-log-pages lockdown media-unit-stat-log id-ns-lba-format
                           )
                        _arguments '*:: :->subcmds'
                        _describe -t commands "help: infos on a specific nvme command, or provide no option to see a synopsis of all nvme commands" _h
index 469dfb5e8fb81bf33844b258b8db234b42e4141c..facffb87e6615b86bdbdf4041185c19d5146ac18 100644 (file)
@@ -78,6 +78,7 @@ readonly _plugin_funcs=(
 # Top level commands
 _cmds="list list-subsys id-ctrl id-ns \
        id-ns-granularity list-ns list-ctrl \
+       id-ns-lba-format \
        nvm-id-ctrl primary-ctrl-caps list-secondary \
        ns-descs id-nvmset id-uuid id-iocs create-ns \
        delete-ns get-ns-id get-log telemetry-log \
@@ -144,6 +145,10 @@ nvme_list_opts () {
                "id-ns-granularity")
                opts+=" --output-format= -o"
                        ;;
+               "id-ns-lba-format")
+               opts+=" --lba-format-index= -i --uuid-index= -U \
+                       --verbose -v --output-format= -o"
+                       ;;
                "list-ns")
                opts+=" --namespace-id= -n --al -a --csi= -y \
                        --outputformat= -o"
index f64ac24beb503412eaa25838469ae289c3462b63..89c3c14f615582d2deb080473415ceae107af29f 100644 (file)
@@ -12,6 +12,7 @@ COMMAND_LIST(
        ENTRY("id-ctrl", "Send NVMe Identify Controller", id_ctrl)
        ENTRY("id-ns", "Send NVMe Identify Namespace, display structure", id_ns)
        ENTRY("id-ns-granularity", "Send NVMe Identify Namespace Granularity List, display structure", id_ns_granularity)
+       ENTRY("id-ns-lba-format", "Send NVMe Identify Namespace for the specified LBA Format index, display structure", id_ns_lba_format)
        ENTRY("list-ns", "Send NVMe Identify List, display structure", list_ns)
        ENTRY("list-ctrl", "Send NVMe Identify Controller List, display structure", list_ctrl)
        ENTRY("nvm-id-ctrl", "Send NVMe Identify Controller NVM Command Set, display structure", nvm_id_ctrl)
index 999266758f9a3b648035edf15f73da6242f04e01..0da0ba564e72cf35cd32adff7992767a669df424 100644 (file)
@@ -148,7 +148,7 @@ static const char *get_sanitize_log_sstat_status_str(__u16 status)
        }
 }
 
-static void json_nvme_id_ns(struct nvme_id_ns *ns)
+static void json_nvme_id_ns(struct nvme_id_ns *ns, bool cap_only)
 {
        char nguid_buf[2 * sizeof(ns->nguid) + 1],
                eui64_buf[2 * sizeof(ns->eui64) + 1];
@@ -161,56 +161,63 @@ static void json_nvme_id_ns(struct nvme_id_ns *ns)
 
        root = json_create_object();
 
-       json_object_add_value_uint64(root, "nsze", le64_to_cpu(ns->nsze));
-       json_object_add_value_uint64(root, "ncap", le64_to_cpu(ns->ncap));
-       json_object_add_value_uint64(root, "nuse", le64_to_cpu(ns->nuse));
-       json_object_add_value_int(root, "nsfeat", ns->nsfeat);
+       if (!cap_only) {
+               json_object_add_value_uint64(root, "nsze", le64_to_cpu(ns->nsze));
+               json_object_add_value_uint64(root, "ncap", le64_to_cpu(ns->ncap));
+               json_object_add_value_uint64(root, "nuse", le64_to_cpu(ns->nuse));
+               json_object_add_value_int(root, "nsfeat", ns->nsfeat);
+       }
        json_object_add_value_int(root, "nlbaf", ns->nlbaf);
-       json_object_add_value_int(root, "flbas", ns->flbas);
+       if (!cap_only)
+               json_object_add_value_int(root, "flbas", ns->flbas);
        json_object_add_value_int(root, "mc", ns->mc);
        json_object_add_value_int(root, "dpc", ns->dpc);
-       json_object_add_value_int(root, "dps", ns->dps);
-       json_object_add_value_int(root, "nmic", ns->nmic);
-       json_object_add_value_int(root, "rescap", ns->rescap);
-       json_object_add_value_int(root, "fpi", ns->fpi);
-       json_object_add_value_int(root, "dlfeat", ns->dlfeat);
-       json_object_add_value_int(root, "nawun", le16_to_cpu(ns->nawun));
-       json_object_add_value_int(root, "nawupf", le16_to_cpu(ns->nawupf));
-       json_object_add_value_int(root, "nacwu", le16_to_cpu(ns->nacwu));
-       json_object_add_value_int(root, "nabsn", le16_to_cpu(ns->nabsn));
-       json_object_add_value_int(root, "nabo", le16_to_cpu(ns->nabo));
-       json_object_add_value_int(root, "nabspf", le16_to_cpu(ns->nabspf));
-       json_object_add_value_int(root, "noiob", le16_to_cpu(ns->noiob));
-       json_object_add_value_float(root, "nvmcap", nvmcap);
-       json_object_add_value_int(root, "nsattr", ns->nsattr);
-       json_object_add_value_int(root, "nvmsetid", le16_to_cpu(ns->nvmsetid));
+       if (!cap_only) {
+               json_object_add_value_int(root, "dps", ns->dps);
+               json_object_add_value_int(root, "nmic", ns->nmic);
+               json_object_add_value_int(root, "rescap", ns->rescap);
+               json_object_add_value_int(root, "fpi", ns->fpi);
+               json_object_add_value_int(root, "dlfeat", ns->dlfeat);
+               json_object_add_value_int(root, "nawun", le16_to_cpu(ns->nawun));
+               json_object_add_value_int(root, "nawupf", le16_to_cpu(ns->nawupf));
+               json_object_add_value_int(root, "nacwu", le16_to_cpu(ns->nacwu));
+               json_object_add_value_int(root, "nabsn", le16_to_cpu(ns->nabsn));
+               json_object_add_value_int(root, "nabo", le16_to_cpu(ns->nabo));
+               json_object_add_value_int(root, "nabspf", le16_to_cpu(ns->nabspf));
+               json_object_add_value_int(root, "noiob", le16_to_cpu(ns->noiob));
+               json_object_add_value_float(root, "nvmcap", nvmcap);
+               json_object_add_value_int(root, "nsattr", ns->nsattr);
+               json_object_add_value_int(root, "nvmsetid", le16_to_cpu(ns->nvmsetid));
+
+               if (ns->nsfeat & 0x10) {
+                       json_object_add_value_int(root, "npwg", le16_to_cpu(ns->npwg));
+                       json_object_add_value_int(root, "npwa", le16_to_cpu(ns->npwa));
+                       json_object_add_value_int(root, "npdg", le16_to_cpu(ns->npdg));
+                       json_object_add_value_int(root, "npda", le16_to_cpu(ns->npda));
+                       json_object_add_value_int(root, "nows", le16_to_cpu(ns->nows));
+               }
 
-       if (ns->nsfeat & 0x10) {
-               json_object_add_value_int(root, "npwg", le16_to_cpu(ns->npwg));
-               json_object_add_value_int(root, "npwa", le16_to_cpu(ns->npwa));
-               json_object_add_value_int(root, "npdg", le16_to_cpu(ns->npdg));
-               json_object_add_value_int(root, "npda", le16_to_cpu(ns->npda));
-               json_object_add_value_int(root, "nows", le16_to_cpu(ns->nows));
+               json_object_add_value_int(root, "mssrl", le16_to_cpu(ns->mssrl));
+               json_object_add_value_int(root, "mcl", le32_to_cpu(ns->mcl));
+               json_object_add_value_int(root, "msrc", ns->msrc);
        }
-
-       json_object_add_value_int(root, "mssrl", le16_to_cpu(ns->mssrl));
-       json_object_add_value_int(root, "mcl", le32_to_cpu(ns->mcl));
-       json_object_add_value_int(root, "msrc", ns->msrc);
        json_object_add_value_int(root, "nulbaf", ns->nulbaf);
 
-       json_object_add_value_int(root, "anagrpid", le32_to_cpu(ns->anagrpid));
-       json_object_add_value_int(root, "endgid", le16_to_cpu(ns->endgid));
+       if (!cap_only) {
+               json_object_add_value_int(root, "anagrpid", le32_to_cpu(ns->anagrpid));
+               json_object_add_value_int(root, "endgid", le16_to_cpu(ns->endgid));
 
-       memset(eui64, 0, sizeof(eui64_buf));
-       for (i = 0; i < sizeof(ns->eui64); i++)
-               eui64 += sprintf(eui64, "%02x", ns->eui64[i]);
+               memset(eui64, 0, sizeof(eui64_buf));
+               for (i = 0; i < sizeof(ns->eui64); i++)
+                       eui64 += sprintf(eui64, "%02x", ns->eui64[i]);
 
-       memset(nguid, 0, sizeof(nguid_buf));
-       for (i = 0; i < sizeof(ns->nguid); i++)
-               nguid += sprintf(nguid, "%02x", ns->nguid[i]);
+               memset(nguid, 0, sizeof(nguid_buf));
+               for (i = 0; i < sizeof(ns->nguid); i++)
+                       nguid += sprintf(nguid, "%02x", ns->nguid[i]);
 
-       json_object_add_value_string(root, "eui64", eui64_buf);
-       json_object_add_value_string(root, "nguid", nguid_buf);
+               json_object_add_value_string(root, "eui64", eui64_buf);
+               json_object_add_value_string(root, "nguid", nguid_buf);
+       }
 
        lbafs = json_create_array();
        json_object_add_value_array(root, "lbafs", lbafs);
@@ -3780,85 +3787,98 @@ static void nvme_show_id_ns_dlfeat(__u8 dlfeat)
 }
 
 void nvme_show_id_ns(struct nvme_id_ns *ns, unsigned int nsid,
-               enum nvme_print_flags flags)
+               unsigned int lba_index, bool cap_only, enum nvme_print_flags flags)
 {
        bool human = flags & VERBOSE;
        int vs = flags & VS;
        int i;
        __u8 flbas;
+       char *in_use = "(in use)";
 
        if (flags & BINARY)
                return d_raw((unsigned char *)ns, sizeof(*ns));
        if (flags & JSON)
-               return json_nvme_id_ns(ns);
+               return json_nvme_id_ns(ns, cap_only);
+
+       if (!cap_only) {
+               printf("NVME Identify Namespace %d:\n", nsid);
+               printf("nsze    : %#"PRIx64"\n", le64_to_cpu(ns->nsze));
+               printf("ncap    : %#"PRIx64"\n", le64_to_cpu(ns->ncap));
+               printf("nuse    : %#"PRIx64"\n", le64_to_cpu(ns->nuse));
+               printf("nsfeat  : %#x\n", ns->nsfeat);
+               if (human)
+                       nvme_show_id_ns_nsfeat(ns->nsfeat);
+       } else
+               printf("NVMe Identify Namespace for LBA format[%d]:\n", lba_index);
 
-       printf("NVME Identify Namespace %d:\n", nsid);
-       printf("nsze    : %#"PRIx64"\n", le64_to_cpu(ns->nsze));
-       printf("ncap    : %#"PRIx64"\n", le64_to_cpu(ns->ncap));
-       printf("nuse    : %#"PRIx64"\n", le64_to_cpu(ns->nuse));
-       printf("nsfeat  : %#x\n", ns->nsfeat);
-       if (human)
-               nvme_show_id_ns_nsfeat(ns->nsfeat);
        printf("nlbaf   : %d\n", ns->nlbaf);
-       printf("flbas   : %#x\n", ns->flbas);
-       if (human)
-               nvme_show_id_ns_flbas(ns->flbas);
+       if (!cap_only) {
+               printf("flbas   : %#x\n", ns->flbas);
+               if (human)
+                       nvme_show_id_ns_flbas(ns->flbas);
+       } else
+               in_use = "";
+
        printf("mc      : %#x\n", ns->mc);
        if (human)
                nvme_show_id_ns_mc(ns->mc);
        printf("dpc     : %#x\n", ns->dpc);
        if (human)
                nvme_show_id_ns_dpc(ns->dpc);
-       printf("dps     : %#x\n", ns->dps);
-       if (human)
-               nvme_show_id_ns_dps(ns->dps);
-       printf("nmic    : %#x\n", ns->nmic);
-       if (human)
-               nvme_show_id_ns_nmic(ns->nmic);
-       printf("rescap  : %#x\n", ns->rescap);
-       if (human)
-               nvme_show_id_ns_rescap(ns->rescap);
-       printf("fpi     : %#x\n", ns->fpi);
-       if (human)
-               nvme_show_id_ns_fpi(ns->fpi);
-       printf("dlfeat  : %d\n", ns->dlfeat);
-       if (human)
-               nvme_show_id_ns_dlfeat(ns->dlfeat);
-       printf("nawun   : %d\n", le16_to_cpu(ns->nawun));
-       printf("nawupf  : %d\n", le16_to_cpu(ns->nawupf));
-       printf("nacwu   : %d\n", le16_to_cpu(ns->nacwu));
-       printf("nabsn   : %d\n", le16_to_cpu(ns->nabsn));
-       printf("nabo    : %d\n", le16_to_cpu(ns->nabo));
-       printf("nabspf  : %d\n", le16_to_cpu(ns->nabspf));
-       printf("noiob   : %d\n", le16_to_cpu(ns->noiob));
-       printf("nvmcap  : %.0Lf\n", int128_to_double(ns->nvmcap));
-       if (ns->nsfeat & 0x10) {
-               printf("npwg    : %u\n", le16_to_cpu(ns->npwg));
-               printf("npwa    : %u\n", le16_to_cpu(ns->npwa));
-               printf("npdg    : %u\n", le16_to_cpu(ns->npdg));
-               printf("npda    : %u\n", le16_to_cpu(ns->npda));
-               printf("nows    : %u\n", le16_to_cpu(ns->nows));
-       }
-       printf("mssrl   : %u\n", le16_to_cpu(ns->mssrl));
-       printf("mcl     : %d\n", le32_to_cpu(ns->mcl));
-       printf("msrc    : %u\n", ns->msrc);
+       if (!cap_only) {
+               printf("dps     : %#x\n", ns->dps);
+               if (human)
+                       nvme_show_id_ns_dps(ns->dps);
+               printf("nmic    : %#x\n", ns->nmic);
+               if (human)
+                       nvme_show_id_ns_nmic(ns->nmic);
+               printf("rescap  : %#x\n", ns->rescap);
+               if (human)
+                       nvme_show_id_ns_rescap(ns->rescap);
+               printf("fpi     : %#x\n", ns->fpi);
+               if (human)
+                       nvme_show_id_ns_fpi(ns->fpi);
+               printf("dlfeat  : %d\n", ns->dlfeat);
+               if (human)
+                       nvme_show_id_ns_dlfeat(ns->dlfeat);
+               printf("nawun   : %d\n", le16_to_cpu(ns->nawun));
+               printf("nawupf  : %d\n", le16_to_cpu(ns->nawupf));
+               printf("nacwu   : %d\n", le16_to_cpu(ns->nacwu));
+               printf("nabsn   : %d\n", le16_to_cpu(ns->nabsn));
+               printf("nabo    : %d\n", le16_to_cpu(ns->nabo));
+               printf("nabspf  : %d\n", le16_to_cpu(ns->nabspf));
+               printf("noiob   : %d\n", le16_to_cpu(ns->noiob));
+               printf("nvmcap  : %.0Lf\n", int128_to_double(ns->nvmcap));
+               if (ns->nsfeat & 0x10) {
+                       printf("npwg    : %u\n", le16_to_cpu(ns->npwg));
+                       printf("npwa    : %u\n", le16_to_cpu(ns->npwa));
+                       printf("npdg    : %u\n", le16_to_cpu(ns->npdg));
+                       printf("npda    : %u\n", le16_to_cpu(ns->npda));
+                       printf("nows    : %u\n", le16_to_cpu(ns->nows));
+               }
+               printf("mssrl   : %u\n", le16_to_cpu(ns->mssrl));
+               printf("mcl     : %d\n", le32_to_cpu(ns->mcl));
+               printf("msrc    : %u\n", ns->msrc);
+       }
        printf("nulbaf  : %u\n", ns->nulbaf);
-       printf("anagrpid: %u\n", le32_to_cpu(ns->anagrpid));
-       printf("nsattr  : %u\n", ns->nsattr);
-       printf("nvmsetid: %d\n", le16_to_cpu(ns->nvmsetid));
-       printf("endgid  : %d\n", le16_to_cpu(ns->endgid));
-
-       printf("nguid   : ");
-       for (i = 0; i < 16; i++)
-               printf("%02x", ns->nguid[i]);
-       printf("\n");
+       if (!cap_only) {
+               printf("anagrpid: %u\n", le32_to_cpu(ns->anagrpid));
+               printf("nsattr  : %u\n", ns->nsattr);
+               printf("nvmsetid: %d\n", le16_to_cpu(ns->nvmsetid));
+               printf("endgid  : %d\n", le16_to_cpu(ns->endgid));
+
+               printf("nguid   : ");
+               for (i = 0; i < 16; i++)
+                       printf("%02x", ns->nguid[i]);
+               printf("\n");
+       }
 
        printf("eui64   : ");
        for (i = 0; i < 8; i++)
                printf("%02x", ns->eui64[i]);
        printf("\n");
        nvme_id_ns_flbas_to_lbaf_inuse(ns->flbas, &flbas);
-       for (i = 0; i <= ns->nlbaf; i++) {
+       for (i = 0; i <= ns->nlbaf + ns->nulbaf; i++) {
                if (human)
                        printf("LBA Format %2d : Metadata Size: %-3d bytes - "
                                "Data Size: %-2d bytes - Relative Performance: %#x %s %s\n",
@@ -3867,14 +3887,14 @@ void nvme_show_id_ns(struct nvme_id_ns *ns, unsigned int nsid,
                                ns->lbaf[i].rp == 3 ? "Degraded" :
                                        ns->lbaf[i].rp == 2 ? "Good" :
                                        ns->lbaf[i].rp == 1 ? "Better" : "Best",
-                               i == flbas ? "(in use)" : "");
+                                       i == flbas ? in_use : "");
                else
                        printf("lbaf %2d : ms:%-3d lbads:%-2d rp:%#x %s\n", i,
                                le16_to_cpu(ns->lbaf[i].ms), ns->lbaf[i].ds,
-                               ns->lbaf[i].rp, i == flbas ? "(in use)" : "");
+                               ns->lbaf[i].rp, i == flbas ? in_use : "");
        }
 
-       if (vs) {
+       if (vs && !cap_only) {
                printf("vs[]:\n");
                d(ns->vs, sizeof(ns->vs), 16, 1);
        }
index ea2d7e88c8b32935a17784ff4c3848b2c2191cf3..073e171e929dd249ca7011d2a00dba2e896a9567 100644 (file)
@@ -25,7 +25,7 @@ void __nvme_show_id_ctrl(struct nvme_id_ctrl *ctrl, unsigned int mode,
        void (*vendor_show)(__u8 *vs, struct json_object *root));
 void nvme_show_id_ctrl(struct nvme_id_ctrl *ctrl, unsigned int mode);
 void nvme_show_id_ns(struct nvme_id_ns *ns, unsigned int nsid,
-       enum nvme_print_flags flags);
+               unsigned int lba_index, bool cap_only, enum nvme_print_flags flags);
 void nvme_show_cmd_set_independent_id_ns(
        struct nvme_id_independent_id_ns *ns, unsigned int nsid,
        enum nvme_print_flags flags);
diff --git a/nvme.c b/nvme.c
index d4de5d7fb085b9013305a2798f5f11ef27e18e1e..dbf557b778d7f6e6c1429a7379dcfdfb8aa7a041 100644 (file)
--- a/nvme.c
+++ b/nvme.c
@@ -2010,6 +2010,66 @@ ret:
        return err;
 }
 
+static int id_ns_lba_format(int argc, char **argv, struct command *cmd, struct plugin *plugin)
+{
+       const char *desc = "Send an Identify Namespace command to the given "\
+               "device, returns capability field properties of the specified "\
+               "LBA Format index in  various formats.";
+       const char *lba_format_index = "The index into the LBA Format list "\
+               "identifying the LBA Format capabilities that are to be returned";
+       const char *uuid_index = "UUID index";
+       const char *verbose = "Increase output verbosity";
+       enum nvme_print_flags flags;
+       struct nvme_id_ns ns;
+       int err = -1, fd;
+
+       struct config {
+               __u16 lba_format_index;
+               __u8  uuid_index;
+               int verbose;
+               char *output_format;
+       };
+
+       struct config cfg = {
+               .lba_format_index = 0,
+               .uuid_index = NVME_UUID_NONE,
+               .verbose = 0,
+               .output_format = "normal",
+       };
+
+       OPT_ARGS(opts) = {
+               OPT_UINT("lba-format-index", 'i', &cfg.lba_format_index, lba_format_index),
+               OPT_BYTE("uuid-index",       'U', &cfg.uuid_index,       uuid_index),
+               OPT_FLAG("verbose",          'v', &cfg.verbose,          verbose),
+               OPT_FMT("output-format",     'o', &cfg.output_format,    output_format),
+               OPT_END()
+       };
+
+       err = fd = parse_and_open(argc, argv, desc, opts);
+       if (fd < 0)
+               goto ret;
+
+       err = flags = validate_output_format(cfg.output_format);
+       if (flags < 0)
+               goto close_fd;
+
+       if (cfg.verbose)
+               flags |= VERBOSE;
+
+       err = nvme_identify_ns_csi_user_data_format(fd, cfg.lba_format_index,
+                                                                               cfg.uuid_index, NVME_CSI_NVM, &ns);
+       if (!err)
+               nvme_show_id_ns(&ns, 0, cfg.lba_format_index, true, flags);
+       else if (err > 0)
+               nvme_show_status(err);
+       else
+               perror("identify namespace for specific LBA format");
+close_fd:
+       close(fd);
+ret:
+       return nvme_status_to_errno(err, false);
+}
+
 static int id_endurance_grp_list(int argc, char **argv, struct command *cmd,
        struct plugin *plugin)
 {
@@ -2729,7 +2789,7 @@ static int id_ns(int argc, char **argv, struct command *cmd, struct plugin *plug
                err = nvme_identify_ns(fd, cfg.namespace_id, &ns);
 
        if (!err)
-               nvme_show_id_ns(&ns, cfg.namespace_id, flags);
+               nvme_show_id_ns(&ns, cfg.namespace_id, 0, false, flags);
        else if (err > 0)
                nvme_show_status(err);
        else