diff options
Diffstat (limited to '')
| -rw-r--r-- | Documentation/nvme-nvm-id-ns.html (renamed from Documentation/nvme-lnvm-create.html) | 126 |
1 files changed, 71 insertions, 55 deletions
diff --git a/Documentation/nvme-lnvm-create.html b/Documentation/nvme-nvm-id-ns.html index f1472f1..82645dc 100644 --- a/Documentation/nvme-lnvm-create.html +++ b/Documentation/nvme-nvm-id-ns.html @@ -1,11 +1,10 @@ -<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.6.10" />
-<title>nvme-lnvm-create(1)</title>
+<meta name="generator" content="AsciiDoc 8.6.8" />
+<title>nvme-nvm-id-ns(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -95,9 +94,7 @@ ul > li > * { color: black; } padding: 0;
margin: 0;
}
-pre {
- white-space: pre-wrap;
-}
+
#author {
color: #527bbd;
@@ -226,7 +223,7 @@ div.exampleblock > div.content { }
div.imageblock div.content { padding-left: 0; }
-span.image img { border-style: none; vertical-align: text-bottom; }
+span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
@@ -436,7 +433,7 @@ thead, p.table.header { p.table {
margin-top: 0;
}
-/* Because the table frame attribute is overriden by CSS in most browsers. */
+/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@@ -735,12 +732,12 @@ asciidoc.install(); <body class="manpage">
<div id="header">
<h1>
-nvme-lnvm-create(1) Manual Page
+nvme-nvm-id-ns(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
-<p>nvme-lnvm-create -
- Instantiate a target on top of a LightNVM enabled device
+<p>nvme-nvm-id-ns -
+ Send NVMe Identify NVM Command Set specific Namespace data structure, display structure
</p>
</div>
</div>
@@ -749,11 +746,10 @@ nvme-lnvm-create(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme lnvm-create</em> [--device-name=<DEVICE> | -d <DEVICE>]
- [--target-name=<TARGET> | -n <TARGET>]
- [--target-type=<TARGETTYPE> | -t <TARGETTYPE>]
- [--lun-begin <NUM> | -b <NUM>]
- [--lun-end <NUM> | -e <NUM>]</pre>
+<pre class="content"><em>nvme nvm-id-ns</em> <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
+ [--namespace-id=<NUM> | -n <NUM>]
+ [-v | --verbose]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -761,12 +757,13 @@ nvme-lnvm-create(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Instantiate a target on top of a LightNVM enabled device. This exposes the
-physical for the user to use.</p></div>
-<div class="paragraph"><p>The target name is the name of which the media is exposed as in
-/dev/<targetname></p></div>
-<div class="paragraph"><p>The target type is the target to be instantiated. Typically pblk or rrpc.</p></div>
-<div class="paragraph"><p>LUN begin and end defines the range of LUNs to use for a target instantiation.</p></div>
+<div class="paragraph"><p>Identify NVM Command Set specific Namespace data structure for the specified
+NSID for the NVM Command Set specified in the CSI field.</p></div>
+<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>
+<div class="paragraph"><p>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.</p></div>
</div>
</div>
<div class="sect1">
@@ -774,58 +771,50 @@ physical for the user to use.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---device-name=<DEVICE>
-</dt>
-<dt class="hdlist1">
--d <DEVICE>
-</dt>
-<dd>
-<p>
- Device name to initialize.
-</p>
-</dd>
-<dt class="hdlist1">
---target-name=<TARGET>
+-n <NUM>
</dt>
<dt class="hdlist1">
--n <TARGET>
+--namespace-id=<NUM>
</dt>
<dd>
<p>
- Target name of the device to initialize. For example: target0.
+ Use the provided namespace id for the command. If not provided, the
+ namespace id of the block device will be used. If the command is issued
+ to a non-block device, the parameter is required.
</p>
</dd>
<dt class="hdlist1">
---target-type=<TARGETTYPE>
+-U <uuid-index>
</dt>
<dt class="hdlist1">
--t <TARGETTYPE>
+--uuid-index=<uuid-index>
</dt>
<dd>
<p>
- Target type of the device to use. For example: pblk
+ UUID Index of the feature
</p>
</dd>
<dt class="hdlist1">
---lun-begin <NUM>
+-v
</dt>
<dt class="hdlist1">
--b <NUM>
+--verbose
</dt>
<dd>
<p>
- Begin LUN id offset to use for target
+ Increase the information detail in the output.
</p>
</dd>
<dt class="hdlist1">
---lun-end <NUM>
+-o <format>
</dt>
<dt class="hdlist1">
--e <NUM>
+--output-format=<format>
</dt>
<dd>
<p>
- End LUN id offset to use for target
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -837,19 +826,47 @@ physical for the user to use.</p></div> <div class="ulist"><ul>
<li>
<p>
-Initialize nvme0n1 with pblk target with 64 LUNs.
+Has the program interpret the returned buffer and display the known
+fields in a human readable format:
</p>
+<div class="listingblock">
+<div class="content">
+<pre><code># nvme nvm-id-ns /dev/nvme0n1</code></pre>
+</div></div>
</li>
-</ul></div>
+<li>
+<p>
+If using the character device or overriding namespace id:
+</p>
<div class="listingblock">
<div class="content">
-<pre><code># nvme lnvm-create -d nvme0n1 -t pblk -n target0 -b 0 -e 63</code></pre>
+<pre><code># nvme nvm-id-ns /dev/nvme0 -n 1
+# nvme nvm-id-ns /dev/nvme0n1 -n 1
+# nvme nvm-id-ns /dev/nvme0 --namespace-id=1</code></pre>
</div></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_nvme">NVME</h2>
-<div class="sectionbody">
+</li>
+<li>
+<p>
+Have the program return the raw structure in binary:
+</p>
+<div class="listingblock">
+<div class="content">
+<pre><code># nvme nvm-id-ns /dev/nvme0n1 -o binary > id_ns.raw
+# nvme nvm-id-ns /dev/nvme0n1 --output-format=binary > id_ns.raw</code></pre>
+</div></div>
+<div class="paragraph"><p>It is probably a bad idea to not redirect stdout when using this mode.</p></div>
+</li>
+<li>
+<p>
+Alternatively you may want to send the data to another program that
+can parse the raw buffer.
+</p>
+<div class="listingblock">
+<div class="content">
+<pre><code>NVME</code></pre>
+</div></div>
+</li>
+</ul></div>
<div class="paragraph"><p>Part of the nvme-user suite</p></div>
</div>
</div>
@@ -857,8 +874,7 @@ Initialize nvme0n1 with pblk target with 64 LUNs. <div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated
- 2021-07-19 10:10:19 PDT
+Last updated 2022-01-07 14:55:44 KST
</div>
</div>
</body>
|