lkml.org 
[lkml]   [2020]   [Mar]   [2]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH 22/42] docs: scsi: convert megaraid.txt to ReST
Date
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/scsi/index.rst | 1 +
.../scsi/{megaraid.txt => megaraid.rst} | 47 +++++++++++--------
MAINTAINERS | 2 +-
3 files changed, 29 insertions(+), 21 deletions(-)
rename Documentation/scsi/{megaraid.txt => megaraid.rst} (66%)

diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 22427511e227..37be1fc9d128 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -26,5 +26,6 @@ Linux SCSI Subsystem
libsas
link_power_management_policy
lpfc
+ megaraid

scsi_transport_srp/figures
diff --git a/Documentation/scsi/megaraid.txt b/Documentation/scsi/megaraid.rst
similarity index 66%
rename from Documentation/scsi/megaraid.txt
rename to Documentation/scsi/megaraid.rst
index 3c7cea51e687..22b75a86ba72 100644
--- a/Documentation/scsi/megaraid.txt
+++ b/Documentation/scsi/megaraid.rst
@@ -1,7 +1,10 @@
- Notes on Management Module
- ~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. SPDX-License-Identifier: GPL-2.0

-Overview:
+==========================
+Notes on Management Module
+==========================
+
+Overview
--------

Different classes of controllers from LSI Logic accept and respond to the
@@ -25,28 +28,32 @@ ioctl commands. But this module is envisioned to handle all user space level
interactions. So any 'proc', 'sysfs' implementations will be localized in this
common module.

-Credits:
+Credits
-------

-"Shared code in a third module, a "library module", is an acceptable
-solution. modprobe automatically loads dependent modules, so users
-running "modprobe driver1" or "modprobe driver2" would automatically
-load the shared library module."
+::

- - Jeff Garzik (jgarzik@pobox.com), 02.25.2004 LKML
+ "Shared code in a third module, a "library module", is an acceptable
+ solution. modprobe automatically loads dependent modules, so users
+ running "modprobe driver1" or "modprobe driver2" would automatically
+ load the shared library module."

-"As Jeff hinted, if your userspace<->driver API is consistent between
-your new MPT-based RAID controllers and your existing megaraid driver,
-then perhaps you need a single small helper module (lsiioctl or some
-better name), loaded by both mptraid and megaraid automatically, which
-handles registering the /dev/megaraid node dynamically. In this case,
-both mptraid and megaraid would register with lsiioctl for each
-adapter discovered, and lsiioctl would essentially be a switch,
-redirecting userspace tool ioctls to the appropriate driver."
+- Jeff Garzik (jgarzik@pobox.com), 02.25.2004 LKML

- - Matt Domsch, (Matt_Domsch@dell.com), 02.25.2004 LKML
+::

-Design:
+ "As Jeff hinted, if your userspace<->driver API is consistent between
+ your new MPT-based RAID controllers and your existing megaraid driver,
+ then perhaps you need a single small helper module (lsiioctl or some
+ better name), loaded by both mptraid and megaraid automatically, which
+ handles registering the /dev/megaraid node dynamically. In this case,
+ both mptraid and megaraid would register with lsiioctl for each
+ adapter discovered, and lsiioctl would essentially be a switch,
+ redirecting userspace tool ioctls to the appropriate driver."
+
+- Matt Domsch, (Matt_Domsch@dell.com), 02.25.2004 LKML
+
+Design
------

The Common Management Module is implemented in megaraid_mm.[ch] files. This
@@ -61,7 +68,7 @@ uioc_t. The management module converts the older ioctl packets from the older
applications into uioc_t. After driver handles the uioc_t, the common module
will convert that back into the old format before returning to applications.

-As new applications evolve and replace the old ones, the old packet format
+As new applications evolve and replace the old ones, the old packet format
will be retired.

Common module dedicates one uioc_t packet to each controller registered. This
diff --git a/MAINTAINERS b/MAINTAINERS
index e2bd7911baa9..6d28bfc72259 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -10699,7 +10699,7 @@ L: megaraidlinux.pdl@broadcom.com
L: linux-scsi@vger.kernel.org
W: http://www.avagotech.com/support/
S: Maintained
-F: Documentation/scsi/megaraid.txt
+F: Documentation/scsi/megaraid.rst
F: drivers/scsi/megaraid.*
F: drivers/scsi/megaraid/

--
2.21.1
\
 
 \ /
  Last update: 2020-03-02 09:19    [W:0.163 / U:0.348 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site