nvme-lnvm-create(1)

From: Keith Busch Date: Thu, 2 Jun 2016 19:34:41 +0000 (-0600) Subject: Genarate lnvm documentation X-Git-Tag: v0.8~41 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=5ab6c77138c29dabf73d0bf1763ec7feabf0c28d;p=users%2Fsagi%2Fnvme-cli.git Genarate lnvm documentation Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-lnvm-create.1 b/Documentation/nvme-lnvm-create.1 new file mode 100644 index 00000000..31275709 --- /dev/null +++ b/Documentation/nvme-lnvm-create.1 @@ -0,0 +1,100 @@ +'\" t +.\" Title: nvme-lnvm-create +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-CREATE" "1" "06/02/2016" "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-lnvm-create \- Instantiate a target on top of a LightNVM enabled device +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-create\fR [\-\-device\-name= | \-d ] + [\-\-target\-name= | \-n ] + [\-\-target\-type= | \-t ] + [\-\-lun\-begin | \-b ] + [\-\-lun\-end | \-e ] +.fi +.SH "DESCRIPTION" +.sp +Instantiate a target on top of a LightNVM enabled device\&. This exposes the physical for the user to use\&. +.sp +The target name is the name of which the media is exposed as in /dev/ +.sp +The target type is the target to be instantiated\&. Typically pblk or rrpc\&. +.sp +LUN begin and end defines the range of LUNs to use for a target instantiation\&. +.SH "OPTIONS" +.PP +\-\-device\-name=, \-d +.RS 4 +Device name to initialize\&. +.RE +.PP +\-\-target\-name=, \-n +.RS 4 +Target name of the device to initialize\&. For example: target0\&. +.RE +.PP +\-\-target\-type=, \-t +.RS 4 +Target type of the device to use\&. For example: pblk +.RE +.PP +\-\-lun\-begin , \-b +.RS 4 +Begin LUN id offset to use for target +.RE +.PP +\-\-lun\-end , \-e +.RS 4 +End LUN id offset to use for target +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Initialize nvme0n1 with pblk target with 64 LUNs\&. +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-create \-d nvme0n1 \-t pblk \-n target0 \-b 0 \-e 63 +.fi +.if n \{\ +.RE +.\} +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-create.html b/Documentation/nvme-lnvm-create.html new file mode 100644 index 00000000..82ae0822 --- /dev/null +++ b/Documentation/nvme-lnvm-create.html @@ -0,0 +1,867 @@ + + + + + +nvme-lnvm-create(1) + + + + + +

SYNOPSIS

nvme lnvm-create [--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>]

DESCRIPTION

Instantiate a target on top of a LightNVM enabled device. This exposes the +physical for the user to use.

The target name is the name of which the media is exposed as in +/dev/<targetname>

The target type is the target to be instantiated. Typically pblk or rrpc.

LUN begin and end defines the range of LUNs to use for a target instantiation.

OPTIONS

+--device-name=<DEVICE> +
+-d <DEVICE> +: +
+ Device name to initialize. +
+
+--target-name=<TARGET> +
+-n <TARGET> +: +
+ Target name of the device to initialize. For example: target0. +
+
+--target-type=<TARGETTYPE> +
+-t <TARGETTYPE> +: +
+ Target type of the device to use. For example: pblk +
+
+--lun-begin <NUM> +
+-b <NUM> +: +
+ Begin LUN id offset to use for target +
+
+--lun-end <NUM> +
+-e <NUM> +: +
+ End LUN id offset to use for target +
+

EXAMPLES

+
+Initialize nvme0n1 with pblk target with 64 LUNs. +
+

# nvme lnvm-create -d nvme0n1 -t pblk -n target0 -b 0 -e 63

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-diag-bbtbl.1 b/Documentation/nvme-lnvm-diag-bbtbl.1 new file mode 100644 index 00000000..528c108f --- /dev/null +++ b/Documentation/nvme-lnvm-diag-bbtbl.1 @@ -0,0 +1,117 @@ +'\" t +.\" Title: nvme-lnvm-diag-bbtbl +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-DIAG\-BB" "1" "06/02/2016" "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-lnvm-diag-bbtbl \- Diagnose the bad block table +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-diag\-bbtbl\fR [\-\-namespace\-id= | \-n ] + [\-\-channel\-id= | \-c ] + [\-\-lun\-id= | \-l ] + [\-\-raw\-binary | \-b] +.fi +.SH "DESCRIPTION" +.sp +Retrieve the bad block table for a given channel and lun\&. +.sp +The statistics will be shown in the default case, and the actual output bad block information can be retrieved when \-\-raw\-binary is passed\&. +.sp +The raw binary output follows this format: +.sp +Channel 0, LUN0 (Dual plane flash) +.sp +Byte 0 \(-> Plane 0, Block 0 Byte 1 \(-> Plane 1, Block 0 Byte 2 \(-> Plane 0, Block 1 \&... +.SH "OPTIONS" +.PP +\-\-namespace\-id=, \-n +.RS 4 +Namespace id to use +.RE +.PP +\-\-channel\-id=, \-c +.RS 4 +Channel id +.RE +.PP +\-\-lun\-id=, \-l +.RS 4 +LUN id +.RE +.PP +\-\-raw\-binary, \-b +.RS 4 +Returns the bad block table in binary form without statistics\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve bad block table statistics for physical device nvme0, channel 0, and lun 0: +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-diag\-bbtbl /dev/nvme0 \-c 0 \-n 0 +.fi +.if n \{\ +.RE +.\} +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Display the bad block table in raw form without statistics for same query: +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-diag\-bbtbl /dev/nvme0 \-c 0 \-n 0 \-b | hexdump +.fi +.if n \{\ +.RE +.\} +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-diag-bbtbl.html b/Documentation/nvme-lnvm-diag-bbtbl.html new file mode 100644 index 00000000..13a011fb --- /dev/null +++ b/Documentation/nvme-lnvm-diag-bbtbl.html @@ -0,0 +1,870 @@ + + + + + +nvme-lnvm-diag-bbtbl(1) + + + + + +

SYNOPSIS

nvme lnvm-diag-bbtbl [--namespace-id=<NUM> | -n <NUM>]
+                        [--channel-id=<CHID> | -c <CHID>]
+                        [--lun-id=<LUNID> | -l <LUNID>]
+                        [--raw-binary | -b]

DESCRIPTION

Retrieve the bad block table for a given channel and lun.

The statistics will be shown in the default case, and the actual output bad +block information can be retrieved when --raw-binary is passed.

The raw binary output follows this format:

Channel 0, LUN0 (Dual plane flash)

Byte 0 → Plane 0, Block 0 +Byte 1 → Plane 1, Block 0 +Byte 2 → Plane 0, Block 1 +…

OPTIONS

+--namespace-id=<NUM> +
+-n <NUM> +: +
+ Namespace id to use +
+
+--channel-id=<NUM> +
+-c +: +
+ Channel id +
+
+--lun-id=<NUM> +
+-l +: +
+ LUN id +
+
+--raw-binary +
+-b +: +
+ Returns the bad block table in binary form without statistics. +
+

EXAMPLES

+
+Retrieve bad block table statistics for physical device nvme0, channel 0, and +lun 0: +
+

# nvme lnvm-diag-bbtbl /dev/nvme0 -c 0 -n 0

+
+Display the bad block table in raw form without statistics for same query: +
+

# nvme lnvm-diag-bbtbl /dev/nvme0 -c 0 -n 0 -b | hexdump

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.1 b/Documentation/nvme-lnvm-diag-set-bbtbl.1 new file mode 100644 index 00000000..91b5919d --- /dev/null +++ b/Documentation/nvme-lnvm-diag-set-bbtbl.1 @@ -0,0 +1,99 @@ +'\" t +.\" Title: nvme-lnvm-diag-set-bbtbl +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-DIAG\-SE" "1" "06/02/2016" "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-lnvm-diag-set-bbtbl \- Set a block state in the bad block table +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-diag\-set\-bbtbl\fR [\-\-namespace\-id= | \-n ] + [\-\-channel\-id= | \-c ] + [\-\-lun\-id= | \-l ] + [\-\-plane\-id= | \-p ] + [\-\-block\-id= | \-b ] + [\-\-value= | \-v ] +.fi +.SH "DESCRIPTION" +.sp +Set the bad block table for a given channel, lun, plane and block with value v\&. +.sp +For each block available, the status byte is read as follows: +.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 +.SH "OPTIONS" +.PP +\-\-namespace\-id=, \-n +.RS 4 +Namespace id to use +.RE +.PP +\-\-channel\-id, \-c +.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 +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.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 +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-diag\-set\-bbtbl /dev/nvme0 \-c 0 \-l 0 \-p 0 \-b 10 \-v 2 +.fi +.if n \{\ +.RE +.\} +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.html b/Documentation/nvme-lnvm-diag-set-bbtbl.html new file mode 100644 index 00000000..2ef09575 --- /dev/null +++ b/Documentation/nvme-lnvm-diag-set-bbtbl.html @@ -0,0 +1,871 @@ + + + + + +nvme-lnvm-diag-set-bbtbl(1) + + + + + +

SYNOPSIS

nvme lnvm-diag-set-bbtbl [--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>]

DESCRIPTION

Set the bad block table for a given channel, lun, plane and block with value v.

For each block available, the status byte is read as follows:

0: Good block +1: Bad block +2: Grown bad block +4: Device reserved block +8: Host-side reserved block +16: Media managed reserved block

OPTIONS

+--namespace-id=<NUM> +
+-n <NUM> +: +
+ Namespace id to use +
+
+--channel-id +
+-c +: +
+ Channel id +
+
+--lun-id +
+-l +: +
+ LUN id +
+
+--plane-id +
+-p +: +
+ Plane id +
+
+--block-id +
+-b +: +
+ Block id +
+

EXAMPLES

+
+Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad) + on physical device /dev/nvme0 +
+

# nvme lnvm-diag-set-bbtbl /dev/nvme0 -c 0 -l 0 -p 0 -b 10 -v 2

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-factory.1 b/Documentation/nvme-lnvm-factory.1 new file mode 100644 index 00000000..d6e29018 --- /dev/null +++ b/Documentation/nvme-lnvm-factory.1 @@ -0,0 +1,109 @@ +'\" t +.\" Title: nvme-lnvm-factory +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-FACTORY" "1" "06/02/2016" "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-lnvm-factory \- Factory reset a LightNVM device +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-factory\fR [\-\-device\-name= | \-d ] + [\-\-erase\-only\-marked | \-e] + [\-\-clear\-host\-side\-blks | \-s] + [\-\-clear\-bb\-blks | \-b] +.fi +.SH "DESCRIPTION" +.sp +Instantiate a target on top of a LightNVM enabled device\&. This exposes the physical for the user to use\&. +.SH "OPTIONS" +.PP +\-\-device\-name=, \-d +.RS 4 +Device name to factory initialize +.RE +.PP +\-\-erase\-only\-marked, \-e +.RS 4 +Erases only blocks that are marked in the bad block list +.RE +.PP +\-\-clear\-host\-side\-blks, \-s +.RS 4 +Remove host\-side bad block marks\&. This clear the media manager registration +.RE +.PP +\-\-clear\-bb\-blks, \-b +.RS 4 +Removes the grown bad block marks\&. Allowing them to be rediscovered\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Factory reset of device nvme0n1 +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-factory \-d nvme0n1 +.fi +.if n \{\ +.RE +.\} +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Complete factory reset of device nvme0n1 +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-factory \-d nvme0n1 \-s \-b +.fi +.if n \{\ +.RE +.\} +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-factory.html b/Documentation/nvme-lnvm-factory.html new file mode 100644 index 00000000..3b874702 --- /dev/null +++ b/Documentation/nvme-lnvm-factory.html @@ -0,0 +1,863 @@ + + + + + +nvme-lnvm-factory(1) + + + + + +

SYNOPSIS

nvme lnvm-factory [--device-name=<DEVICE> | -d <DEVICE>]
+                        [--erase-only-marked | -e]
+                        [--clear-host-side-blks | -s]
+                        [--clear-bb-blks | -b]

DESCRIPTION

Instantiate a target on top of a LightNVM enabled device. This exposes the +physical for the user to use.

OPTIONS

+--device-name=<DEVICE> +
+-d <DEVICE> +: +
+ Device name to factory initialize +
+
+--erase-only-marked +
+-e +: +
+ Erases only blocks that are marked in the bad block list +
+
+--clear-host-side-blks +
+-s +: +
+ Remove host-side bad block marks. This clear the media manager + registration +
+
+--clear-bb-blks +
+-b +: +
+ Removes the grown bad block marks. Allowing them to be rediscovered. +
+

EXAMPLES

+
+Factory reset of device nvme0n1 +
+

# nvme lnvm-factory -d nvme0n1

+
+Complete factory reset of device nvme0n1 +
+

# nvme lnvm-factory -d nvme0n1 -s -b

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-id-ns.1 b/Documentation/nvme-lnvm-id-ns.1 new file mode 100644 index 00000000..59852094 --- /dev/null +++ b/Documentation/nvme-lnvm-id-ns.1 @@ -0,0 +1,88 @@ +'\" t +.\" Title: nvme-lnvm-id-ns +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-ID\-NS" "1" "06/02/2016" "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-lnvm-id-ns \- Identify Geometry for LightNVM NVMe device +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-id\-ns\fR [\-\-namespace\-id= | \-n ] + [\-\-force | \-f] + [\-\-raw\-binary | \-b] + [\-\-human\-readable | \-H] +.fi +.SH "DESCRIPTION" +.sp +Send an Identify Geometry command to the given LightNVM device, returns properties of the specified namespace in either human\-readable or binary format\&. +.SH "OPTIONS" +.PP +\-\-namespace\-id=, \-n +.RS 4 +Retrieve the geometry from the selected namespace\&. +.RE +.PP +\-\-force, \-f +.RS 4 +Try to read the data and assume it is a LightNVM device +.RE +.PP +\-\-raw\-binary, \-b +.RS 4 +Output the raw output +.RE +.PP +\-\-human\-readable, \-H +.RS 4 +Output the status in human readable format +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the geometry from nvme0 +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-id\-ns /dev/nvme0 \-n 1 +.fi +.if n \{\ +.RE +.\} +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-id-ns.html b/Documentation/nvme-lnvm-id-ns.html new file mode 100644 index 00000000..2a5aa41e --- /dev/null +++ b/Documentation/nvme-lnvm-id-ns.html @@ -0,0 +1,852 @@ + + + + + +nvme-lnvm-id-ns(1) + + + + + +

SYNOPSIS

nvme lnvm-id-ns <device> [--namespace-id=<nsid> | -n <nsid>]
+                        [--force | -f]
+                        [--raw-binary | -b]
+                        [--human-readable | -H]

DESCRIPTION

Send an Identify Geometry command to the given LightNVM device, returns +properties of the specified namespace in either human-readable or binary +format.

OPTIONS

+--namespace-id=<nsid> +
+-n <nsid> +: +
+ Retrieve the geometry from the selected namespace. +
+
+--force +
+-f +: +
+ Try to read the data and assume it is a LightNVM device +
+
+--raw-binary +
+-b +: +
+ Output the raw output +
+
+--human-readable +
+-H +: +
+ Output the status in human readable format +
+

EXAMPLES

+
+Retrieve the geometry from nvme0 +
+

# nvme lnvm-id-ns /dev/nvme0 -n 1

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-info.1 b/Documentation/nvme-lnvm-info.1 new file mode 100644 index 00000000..4c421ac1 --- /dev/null +++ b/Documentation/nvme-lnvm-info.1 @@ -0,0 +1,48 @@ +'\" t +.\" Title: nvme-lnvm-info +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-INFO" "1" "06/02/2016" "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-lnvm-info \- Show general information and registered target types with LightNVM +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-info\fR +.fi +.SH "DESCRIPTION" +.sp +Show general information and registered target types with LightNVM\&. +.SH "OPTIONS" +.sp +No options yet\&. +.SH "EXAMPLES" +.sp +No examples yet\&. +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-info.html b/Documentation/nvme-lnvm-info.html new file mode 100644 index 00000000..9f9e95f4 --- /dev/null +++ b/Documentation/nvme-lnvm-info.html @@ -0,0 +1,792 @@ + + + + + +nvme-lnvm-info(1) + + + + + +

SYNOPSIS

nvme lnvm-info

DESCRIPTION

Show general information and registered target types with LightNVM.

OPTIONS

No options yet.

EXAMPLES

No examples yet.

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-init.1 b/Documentation/nvme-lnvm-init.1 new file mode 100644 index 00000000..aef3eb56 --- /dev/null +++ b/Documentation/nvme-lnvm-init.1 @@ -0,0 +1,97 @@ +'\" t +.\" Title: nvme-lnvm-init +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-INIT" "1" "06/02/2016" "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-lnvm-init \- Initialize LightNVM device with media manager +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-init\fR [\-\-device\-name= | \-d ] + [\-\-mediamgr\-name | \-m] +.fi +.SH "DESCRIPTION" +.sp +Initialize LightNVM device\&. A LightNVM/Open\-Channel SSD must have a media manager associated before it can be exposed to the user\&. The default is to initialize the general media manager on top of the device\&. +.SH "OPTIONS" +.PP +\-\-device\-name=, \-d +.RS 4 +Device name to initialize\&. +.RE +.PP +\-\-mediamgr\-name=, \-m +.RS 4 +Media Manager name to use for initialization\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Initialize nvme0n1 +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-init \-d nvme0n1 +.fi +.if n \{\ +.RE +.\} +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Initialize nvme0n1 with gennvm media manager (default media manager) +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme lnvm\-init \-d nvme0n1 \-m gennvm +.fi +.if n \{\ +.RE +.\} +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-init.html b/Documentation/nvme-lnvm-init.html new file mode 100644 index 00000000..9f4b0888 --- /dev/null +++ b/Documentation/nvme-lnvm-init.html @@ -0,0 +1,839 @@ + + + + + +nvme-lnvm-init(1) + + + + + +

SYNOPSIS

nvme lnvm-init [--device-name=<DEVICE> | -d <DEVICE>]
+                        [--mediamgr-name | -m]

DESCRIPTION

Initialize LightNVM device. A LightNVM/Open-Channel SSD must have a media +manager associated before it can be exposed to the user. The default is to +initialize the general media manager on top of the device.

OPTIONS

+--device-name=<DEVICE> +
+-d <DEVICE> +: +
+ Device name to initialize. +
+
+--mediamgr-name=<MediaMgr> +
+-m <MediaMgr> +: +
+ Media Manager name to use for initialization. +
+

EXAMPLES

+
+Initialize nvme0n1 +
+

# nvme lnvm-init -d nvme0n1

+
+Initialize nvme0n1 with gennvm media manager (default media manager) +
+

# nvme lnvm-init -d nvme0n1 -m gennvm

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-list.1 b/Documentation/nvme-lnvm-list.1 new file mode 100644 index 00000000..dd37b45a --- /dev/null +++ b/Documentation/nvme-lnvm-list.1 @@ -0,0 +1,48 @@ +'\" t +.\" Title: nvme-lnvm-list +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-LIST" "1" "06/02/2016" "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-lnvm-list \- List all recognized LightNVM NVMe devices +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-list\fR +.fi +.SH "DESCRIPTION" +.sp +List all registered LightNVM devices\&. +.SH "OPTIONS" +.sp +No options yet\&. +.SH "EXAMPLES" +.sp +No examples yet\&. +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-list.html b/Documentation/nvme-lnvm-list.html new file mode 100644 index 00000000..2c50a8a3 --- /dev/null +++ b/Documentation/nvme-lnvm-list.html @@ -0,0 +1,792 @@ + + + + + +nvme-lnvm-list(1) + + + + + +

SYNOPSIS

nvme lnvm-list

DESCRIPTION

List all registered LightNVM devices.

OPTIONS

No options yet.

EXAMPLES

No examples yet.

NVME

Part of the nvme-user suite

+ + + diff --git a/Documentation/nvme-lnvm-remove.1 b/Documentation/nvme-lnvm-remove.1 new file mode 100644 index 00000000..8e2b5fdb --- /dev/null +++ b/Documentation/nvme-lnvm-remove.1 @@ -0,0 +1,53 @@ +'\" t +.\" Title: nvme-lnvm-remove +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/02/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LNVM\-REMOVE" "1" "06/02/2016" "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-lnvm-remove \- Remove an initialized LightNVM target\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme lnvm\-remove\fR [\-\-target\-name= | \-n ] +.fi +.SH "DESCRIPTION" +.sp +Remove an initialized target\&. +.sp +The target name is the name of which the media is exposed as in /dev/ +.SH "OPTIONS" +.PP +\-\-target\-name=, \-n +.RS 4 +Target name of the device to initialize\&. For example: target0\&. +.RE +.SH "EXAMPLES" +.sp +None yet +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-remove.html b/Documentation/nvme-lnvm-remove.html new file mode 100644 index 00000000..9a8c1940 --- /dev/null +++ b/Documentation/nvme-lnvm-remove.html @@ -0,0 +1,806 @@ + + + + + +nvme-lnvm-remove(1) + + + + + +

SYNOPSIS

nvme lnvm-remove [--target-name=<TARGET> | -n <TARGET>]

DESCRIPTION

Remove an initialized target.

The target name is the name of which the media is exposed as in +/dev/<TARGET>

OPTIONS

+--target-name=<TARGET> +
+-n <TARGET> +: +
+ Target name of the device to initialize. For example: target0. +
+

EXAMPLES

None yet

NVME

Part of the nvme-user suite

+ + +

+nvme-lnvm-create(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-diag-bbtbl(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-diag-set-bbtbl(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-factory(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-id-ns(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-info(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-init(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-list(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME

+nvme-lnvm-remove(1) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

NVME