Adding upstream version 2.11.upstream/2.11upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 183 insertions, 0 deletions

diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.1 b/Documentation/nvme-solidigm-parse-telemetry-log.1
new file mode 100644
index 0000000..9764fdf
--- /dev/null
+++ b/Documentation/nvme-solidigm-parse-telemetry-log.1
@@ -0,0 +1,183 @@
+'\" t
+.\"     Title: nvme-solidigm-parse-telemetry-log
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 10/31/2024
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-SOLIDIGM\-PARS" "1" "10/31/2024" "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-solidigm-parse-telemetry-log \- Parse and display Solidigm Telemetry log
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme solidigm parse\-telemetry\-log\fR <device> [OPTIONS]
+.fi
+.SH "DESCRIPTION"
+.sp
+Retrieves, parses, and displays the Telemetry log for the given Solidigm NVMe device\&. This command provides detailed information about the device\(cqs telemetry data, which can be useful for diagnostics and performance analysis\&.
+.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)\&.
+.SH "OPTIONS"
+.PP
+\-g <num>, \-\-host\-generate=<num>
+.RS 4
+Controls when to generate a new host\-initiated report\&. Default value
+\fI1\fR
+generates a new host\-initiated report, value
+\fI0\fR
+causes retrieval of an existing log\&. Valid values are 0 and 1\&.
+.RE
+.PP
+\-c, \-\-controller\-init
+.RS 4
+Gather report generated by the controller\&.
+.RE
+.PP
+\-d <num>, \-\-data\-area=<num>
+.RS 4
+Pick which telemetry data area to report\&. Default is 3 to fetch areas 1\-3\&. Valid options are 1, 2, 3, 4\&.
+.RE
+.PP
+\-j <file>, \-\-config\-file=<file>
+.RS 4
+Specify a JSON configuration file for custom parsing of the telemetry log\&.
+.RE
+.PP
+\-s, \-\-source\-file
+.RS 4
+Indicates that the <device> argument is a binary file containing a log dump instead of a block or character device\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Retrieve and parse the telemetry log with default options:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme solidigm parse\-telemetry\-log /dev/nvme0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Retrieve an existing telemetry log without generating a new one:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-g 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Parse a specific data area of the telemetry log:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-d 2
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Use a custom configuration file for parsing:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-j config\&.json
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Parse a telemetry log from a binary file:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme solidigm parse\-telemetry\-log telemetry_dump\&.bin \-s
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "OUTPUT"
+.sp
+The command outputs the parsed telemetry log in JSON format to stdout\&.
+.SH "NVME"
+.sp
+Part of the nvme\-cli suite