Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Randy Dunlap and committed by
Martin K. Petersen
6a59fd77 572ccdab

+66 -1
+1
Documentation/driver-api/index.rst
··· 34 34 edac 35 35 scsi 36 36 libata 37 + target 37 38 mtdnand 38 39 miscellaneous 39 40 w1
+1 -1
Documentation/driver-api/scsi.rst
··· 334 334 ~~~~ 335 335 336 336 Parallel (fast/wide/ultra) SCSI, USB, SATA, SAS, Fibre Channel, 337 - FireWire, ATAPI devices, Infiniband, I2O, iSCSI, Parallel ports, 337 + FireWire, ATAPI devices, Infiniband, I2O, Parallel ports, 338 338 netlink...
+64
Documentation/driver-api/target.rst
··· 1 + ================================= 2 + target and iSCSI Interfaces Guide 3 + ================================= 4 + 5 + Introduction and Overview 6 + ========================= 7 + 8 + TBD 9 + 10 + Target core device interfaces 11 + ============================= 12 + 13 + .. kernel-doc:: drivers/target/target_core_device.c 14 + :export: 15 + 16 + Target core transport interfaces 17 + ================================ 18 + 19 + .. kernel-doc:: drivers/target/target_core_transport.c 20 + :export: 21 + 22 + Target-supported userspace I/O 23 + ============================== 24 + 25 + .. kernel-doc:: drivers/target/target_core_user.c 26 + :doc: Userspace I/O 27 + 28 + .. kernel-doc:: include/uapi/linux/target_core_user.h 29 + :doc: Ring Design 30 + 31 + iSCSI helper functions 32 + ====================== 33 + 34 + .. kernel-doc:: drivers/scsi/libiscsi.c 35 + :export: 36 + 37 + 38 + iSCSI boot information 39 + ====================== 40 + 41 + .. kernel-doc:: drivers/scsi/iscsi_boot_sysfs.c 42 + :export: 43 + 44 + 45 + iSCSI transport class 46 + ===================== 47 + 48 + The file drivers/scsi/scsi_transport_iscsi.c defines transport 49 + attributes for the iSCSI class, which sends SCSI packets over TCP/IP 50 + connections. 51 + 52 + .. kernel-doc:: drivers/scsi/scsi_transport_iscsi.c 53 + :export: 54 + 55 + 56 + iSCSI TCP interfaces 57 + ==================== 58 + 59 + .. kernel-doc:: drivers/scsi/iscsi_tcp.c 60 + :internal: 61 + 62 + .. kernel-doc:: drivers/scsi/libiscsi_tcp.c 63 + :export: 64 +