-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
scsi: target: add driver-api document
Add a driver-api document for target/iSCSI interfaces. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> To: "Nicholas A. Bellinger" <nab@linux-iscsi.org> Cc: linux-scsi@vger.kernel.org Cc: target-devel@vger.kernel.org Cc: linux-doc@vger.kernel.org Cc: "James E.J. Bottomley" <jejb@linux.vnet.ibm.com> Cc: "Martin K. Petersen" <martin.petersen@oracle.com> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
- Loading branch information
Randy Dunlap
authored and
Martin K. Petersen
committed
Apr 20, 2018
1 parent
572ccda
commit 6a59fd7
Showing
3 changed files
with
66 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ available subsections can be seen below. | |
edac | ||
scsi | ||
libata | ||
target | ||
mtdnand | ||
miscellaneous | ||
w1 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
================================= | ||
target and iSCSI Interfaces Guide | ||
================================= | ||
|
||
Introduction and Overview | ||
========================= | ||
|
||
TBD | ||
|
||
Target core device interfaces | ||
============================= | ||
|
||
.. kernel-doc:: drivers/target/target_core_device.c | ||
:export: | ||
|
||
Target core transport interfaces | ||
================================ | ||
|
||
.. kernel-doc:: drivers/target/target_core_transport.c | ||
:export: | ||
|
||
Target-supported userspace I/O | ||
============================== | ||
|
||
.. kernel-doc:: drivers/target/target_core_user.c | ||
:doc: Userspace I/O | ||
|
||
.. kernel-doc:: include/uapi/linux/target_core_user.h | ||
:doc: Ring Design | ||
|
||
iSCSI helper functions | ||
====================== | ||
|
||
.. kernel-doc:: drivers/scsi/libiscsi.c | ||
:export: | ||
|
||
|
||
iSCSI boot information | ||
====================== | ||
|
||
.. kernel-doc:: drivers/scsi/iscsi_boot_sysfs.c | ||
:export: | ||
|
||
|
||
iSCSI transport class | ||
===================== | ||
|
||
The file drivers/scsi/scsi_transport_iscsi.c defines transport | ||
attributes for the iSCSI class, which sends SCSI packets over TCP/IP | ||
connections. | ||
|
||
.. kernel-doc:: drivers/scsi/scsi_transport_iscsi.c | ||
:export: | ||
|
||
|
||
iSCSI TCP interfaces | ||
==================== | ||
|
||
.. kernel-doc:: drivers/scsi/iscsi_tcp.c | ||
:internal: | ||
|
||
.. kernel-doc:: drivers/scsi/libiscsi_tcp.c | ||
:export: | ||
|