summaryrefslogtreecommitdiff
path: root/Documentation/scsi
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-03-02 09:15:45 +0100
committerMartin K. Petersen <martin.petersen@oracle.com>2020-03-11 23:07:59 -0400
commitd2ba7ca33840a1e58368594c552fa1fa11b15152 (patch)
tree4f2cacb4982be1b49de1b4779ea7bae38752f9f2 /Documentation/scsi
parent977b899ce3cc4c5ca6776f1a62d7817f49c7581f (diff)
scsi: docs: convert cxgb3i.txt to ReST
Link: https://lore.kernel.org/r/0708b62b6ec4f0dddc581e412bb02ba6476f4523.1583136624.git.mchehab+huawei@kernel.org Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
Diffstat (limited to 'Documentation/scsi')
-rw-r--r--Documentation/scsi/cxgb3i.rst (renamed from Documentation/scsi/cxgb3i.txt)22
-rw-r--r--Documentation/scsi/index.rst1
2 files changed, 15 insertions, 8 deletions
diff --git a/Documentation/scsi/cxgb3i.txt b/Documentation/scsi/cxgb3i.rst
index 7ac8032ee9b2..e01f18fbfa9f 100644
--- a/Documentation/scsi/cxgb3i.txt
+++ b/Documentation/scsi/cxgb3i.rst
@@ -1,4 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================================
Chelsio S3 iSCSI Driver for Linux
+=================================
Introduction
============
@@ -49,7 +53,8 @@ The following steps need to be taken to accelerates the open-iscsi initiator:
The cxgb3i module registers a new transport class "cxgb3i" with open-iscsi.
- * in the case of recompiling the kernel, the cxgb3i selection is located at
+ * in the case of recompiling the kernel, the cxgb3i selection is located at::
+
Device Drivers
SCSI device support --->
[*] SCSI low-level drivers --->
@@ -58,25 +63,26 @@ The following steps need to be taken to accelerates the open-iscsi initiator:
2. Create an interface file located under /etc/iscsi/ifaces/ for the new
transport class "cxgb3i".
- The content of the file should be in the following format:
+ The content of the file should be in the following format::
+
iface.transport_name = cxgb3i
iface.net_ifacename = <ethX>
iface.ipaddress = <iscsi ip address>
* if iface.ipaddress is specified, <iscsi ip address> needs to be either the
- same as the ethX's ip address or an address on the same subnet. Make
- sure the ip address is unique in the network.
+ same as the ethX's ip address or an address on the same subnet. Make
+ sure the ip address is unique in the network.
3. edit /etc/iscsi/iscsid.conf
The default setting for MaxRecvDataSegmentLength (131072) is too big;
- replace with a value no bigger than 15360 (for example 8192):
+ replace with a value no bigger than 15360 (for example 8192)::
node.conn[0].iscsi.MaxRecvDataSegmentLength = 8192
* The login would fail for a normal session if MaxRecvDataSegmentLength is
- too big. A error message in the format of
- "cxgb3i: ERR! MaxRecvSegmentLength <X> too big. Need to be <= <Y>."
- would be logged to dmesg.
+ too big. A error message in the format of
+ "cxgb3i: ERR! MaxRecvSegmentLength <X> too big. Need to be <= <Y>."
+ would be logged to dmesg.
4. To direct open-iscsi traffic to go through cxgb3i's accelerated path,
"-I <iface file name>" option needs to be specified with most of the
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 6bb2428c1d56..3809213b83da 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -16,5 +16,6 @@ Linux SCSI Subsystem
bfa
bnx2fc
BusLogic
+ cxgb3i
scsi_transport_srp/figures