From 81d6a5ded50a26338e1b36462b3e0a6e45beb9a6 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 5 May 2024 13:11:05 +0200
Subject: Adding upstream version 2.9.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 Documentation/nvme-set-reg.txt | 102 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 102 insertions(+)
 create mode 100644 Documentation/nvme-set-reg.txt

(limited to 'Documentation/nvme-set-reg.txt')

diff --git a/Documentation/nvme-set-reg.txt b/Documentation/nvme-set-reg.txt
new file mode 100644
index 0000000..6fd6a49
--- /dev/null
+++ b/Documentation/nvme-set-reg.txt
@@ -0,0 +1,102 @@
+nvme-set-reg(1)
+===============
+
+NAME
+----
+nvme-set-reg - Writes and shows the defined NVMe controller register
+
+SYNOPSIS
+--------
+[verse]
+'nvme set-reg' <device> [--offset=<offset>, -O <offset>]
+			[--value=<val> | -V <val>] [--mmio32 | -m]
+			[--intms=<val>] [--intmc=<val>] [--cc=<val>]
+			[--csts=<val>] [--nssr=<val>] [--aqa=<val>]
+			[--asq=<val>] [--acq=<val>] [--bprsel=<val>]
+			[--bpmbl=<val>] [--cmbmsc=<val>] [--nssd=<val>]
+			[--pmrctl=<val>] [--pmrmscl=<val>] [--pmrmscu=<val>]
+			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Writes and shows the defined NVMe controller register.
+
+OPTIONS
+-------
+-O <offset>::
+--offset=<offset>::
+	offset of the requested register
+
+-V <val>::
+--value=<val>::
+	the value of the register to be set
+
+--mmio32::
+-m::
+	Access 64-bit registers as 2 32-bit
+
+--intms=<val>::
+	INTMS=0xc register offset
+
+--intmc=<val>::
+	INTMC=0x10 register offset
+
+--cc=<val>::
+	CC=0x14 register offset
+
+--csts=<val>::
+	CSTS=0x1c register offset
+
+--nssr=<val>::
+	NSSR=0x20 register offset
+
+--aqa=<val>::
+	AQA=0x24 register offset
+
+--asq=<val>::
+	ASQ=0x28 register offset
+
+--acq=<val>::
+	ACQ=0x30 register offset
+
+--bprsel=<val>::
+	BPRSEL=0x44 register offset
+
+--bpmbl=<val>::
+	BPMBL=0x48 register offset
+
+--cmbmsc=<val>::
+	CMBMSC=0x50 register offset
+
+--nssd=<val>::
+	NSSD=0x64 register offset
+
+--pmrctl=<val>::
+	PMRCTL=0xe04 register offset
+
+--pmrmscl=<val>::
+	PMRMSCL=0xe14 register offset
+
+--pmrmscu=<val>::
+	PMRMSCU=0xe18 register offset
+
+-o <fmt>::
+--output-format=<fmt>::
+	Set the reporting format to 'normal', 'json' or 'binary'. Only one
+	output format can be used at a time.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+EXAMPLES
+--------
+* The following will run the set-reg command with offset 0x14 and value 0x460000
++
+------------
+# nvme set-reg /dev/nvme0 -O 0x14 -V 0x460000
+------------
+
+NVME
+----
+Part of the nvme-user suite.
-- 
cgit v1.2.3