Skip to content

Commit

Permalink
scsi: docs: convert megaraid.txt to ReST
Browse files Browse the repository at this point in the history
  • Loading branch information
mchehab authored and martinkpetersen committed Mar 12, 2020
1 parent b4adb75 commit a756185
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 21 deletions.
1 change: 1 addition & 0 deletions Documentation/scsi/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ Linux SCSI Subsystem
libsas
link_power_management_policy
lpfc
megaraid

scsi_transport_srp/figures
47 changes: 27 additions & 20 deletions Documentation/scsi/megaraid.txt → Documentation/scsi/megaraid.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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."
::

"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 ([email protected]), 02.25.2004 LKML

- Jeff Garzik ([email protected]), 02.25.2004 LKML
::

"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."
"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, ([email protected]), 02.25.2004 LKML
- Matt Domsch, ([email protected]), 02.25.2004 LKML

Design:
Design
------

The Common Management Module is implemented in megaraid_mm.[ch] files. This
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS
Original file line number Diff line number Diff line change
Expand Up @@ -10639,7 +10639,7 @@ L: [email protected]
L: [email protected]
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/

Expand Down

0 comments on commit a756185

Please sign in to comment.