From: Eyal Ben David Date: Sat, 4 Aug 2018 20:12:05 +0000 (+0300) Subject: nvme-get-property : Add documentation X-Git-Tag: v1.7~100^2 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=c83798f8dc57238e11d0299438169c341fd669e5;p=users%2Fsagi%2Fnvme-cli.git nvme-get-property : Add documentation --- diff --git a/Documentation/cmds-main.txt b/Documentation/cmds-main.txt index b34d48d7..3de4c3fa 100644 --- a/Documentation/cmds-main.txt +++ b/Documentation/cmds-main.txt @@ -124,3 +124,5 @@ linknvme:nvme-discover[1]:: linknvme:nvme-connect[1]:: Connect to an NVMe-over-Fabrics subsystem +linknvme:nvme-get-property[1]:: + Reads and shows NVMe-over-Fabrics controller property diff --git a/Documentation/nvme-get-property.1 b/Documentation/nvme-get-property.1 new file mode 100644 index 00000000..3d0dbba8 --- /dev/null +++ b/Documentation/nvme-get-property.1 @@ -0,0 +1,123 @@ +'\" t +.\" Title: nvme-get-property +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 08/05/2018 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-GET\-PROPERTY" "1" "08/05/2018" "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-get-property \- Reads and shows the defined NVMe controller property for NVMe over Fabric +.SH "SYNOPSIS" +.sp +.nf +\fInvme get\-property\fR [\-\-offset= | \-o ] + [\-\-human\-readable | \-H ] +.fi +.SH "DESCRIPTION" +.sp +Reads and shows the defined NVMe controller property for NVMe over Fabric\&. +.SH "OPTIONS" +.PP +\-o, \-\-offset +.RS 4 +The offset of the property\&. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 +.RE +.PP +\-H +.RS 4 +\-\-human\-readable: Show the fields packed in the propery +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The following will run the get\-property command with offset 0 +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme get\-property /dev/nvme0 \-\-offset=0x0 \-\-human\-readable +.fi +.if n \{\ +.RE +.\} +.RE +.SH "BUGS" +.sp +Currently the CAP value is truncated to 32 bits due to a limitation in the ioctl interface\&. +.sp +In a recent enough kernel, the 64 bit value is shown in kernel traces\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +First enable traces by this command +.sp +.if n \{\ +.RS 4 +.\} +.nf +# echo 1 > /sys/kernel/debug/tracing/events/nvme/enable +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Then look for NVMe Fabrics command (0x7f) at trace +.sp +.if n \{\ +.RS 4 +.\} +.nf +/sys/kernel/debug/tracing/trace +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-get-property.html b/Documentation/nvme-get-property.html new file mode 100644 index 00000000..911638b5 --- /dev/null +++ b/Documentation/nvme-get-property.html @@ -0,0 +1,846 @@ + + + + + +nvme-get-property(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme get-property <device> [--offset=<offset> | -o <offset>]
+                                [--human-readable | -H ]
+
+
+
+
+
+

DESCRIPTION

+
+

Reads and shows the defined NVMe controller property for NVMe over Fabric.

+
+
+
+

OPTIONS

+
+
+
+-o +
+
+--offset +
+
+

+ The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 +

+
+
+-H +
+
+

+--human-readable: + Show the fields packed in the propery +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +The following will run the get-property command with offset 0 +

    +
    +
    +
    # nvme get-property /dev/nvme0 --offset=0x0 --human-readable
    +
    +
    • +
+
+
+
+

BUGS

+
+

Currently the CAP value is truncated to 32 bits due to a limitation in +the ioctl interface.

+

In a recent enough kernel, the 64 bit value is shown in kernel traces.

+
    +
  • +

    +First enable traces by this command +

    +
    +
    +
    # echo 1 > /sys/kernel/debug/tracing/events/nvme/enable
    +
    +
    • +
  • +

    +Then look for NVMe Fabrics command (0x7f) at trace +

    +
    +
    +
    /sys/kernel/debug/tracing/trace
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-get-property.txt b/Documentation/nvme-get-property.txt new file mode 100644 index 00000000..2cecd4f0 --- /dev/null +++ b/Documentation/nvme-get-property.txt @@ -0,0 +1,62 @@ +nvme-get-property(1) +==================== + +NAME +---- +nvme-get-property - Reads and shows the defined NVMe controller property +for NVMe over Fabric + +SYNOPSIS +-------- +[verse] +'nvme get-property' [--offset= | -o ] + [--human-readable | -H ] + + +DESCRIPTION +----------- +Reads and shows the defined NVMe controller property for NVMe over Fabric. + + +OPTIONS +------- +-o:: +--offset:: + The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 + +-H:: +--human-readable: + Show the fields packed in the propery + + +EXAMPLES +-------- +* The following will run the get-property command with offset 0 ++ +------------ +# nvme get-property /dev/nvme0 --offset=0x0 --human-readable +------------ + + +BUGS +---- +Currently the CAP value is truncated to 32 bits due to a limitation in +the ioctl interface. + +In a recent enough kernel, the 64 bit value is shown in kernel traces. + +* First enable traces by this command ++ +------------ +# echo 1 > /sys/kernel/debug/tracing/events/nvme/enable +------------ + +* Then look for NVMe Fabrics command (0x7f) at trace ++ +------------ +/sys/kernel/debug/tracing/trace +------------ + +NVME +---- +Part of the nvme-user suite