p71924506
/
linux_old1
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

scsi: target: target_core_user.[ch]: convert comments into DOC: 

Make documentation on target-supported userspace-I/O design be
usable by kernel-doc by using "DOC:". This is used in the driver-api
Documentation chapter.

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>
This commit is contained in:
Randy Dunlap 2018-04-14 10:51:05 -07:00 committed by Martin K. Petersen
parent 9ad97b8b40
commit 572ccdab50
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/target/target_core_user.c
View File

@ -42,7 +42,11 @@
#include <linux/target_core_user.h> #include <linux/target_core_user.h>
/* /**
* DOC: Userspace I/O
* Userspace I/O
* -------------
*
* Define a shared-memory interface for LIO to pass SCSI commands and * Define a shared-memory interface for LIO to pass SCSI commands and
* data to userspace for processing. This is to allow backends that * data to userspace for processing. This is to allow backends that
* are too complex for in-kernel support to be possible. * are too complex for in-kernel support to be possible.
@ -53,7 +57,7 @@
* See the .h file for how the ring is laid out. Note that while the * See the .h file for how the ring is laid out. Note that while the
* command ring is defined, the particulars of the data area are * command ring is defined, the particulars of the data area are
* not. Offset values in the command entry point to other locations * not. Offset values in the command entry point to other locations
* internal to the mmap()ed area. There is separate space outside the * internal to the mmap-ed area. There is separate space outside the
* command ring for data buffers. This leaves maximum flexibility for * command ring for data buffers. This leaves maximum flexibility for
* moving buffer allocations, or even page flipping or other * moving buffer allocations, or even page flipping or other
* allocation techniques, without altering the command ring layout. * allocation techniques, without altering the command ring layout.

11
include/uapi/linux/target_core_user.h
View File

@ -9,21 +9,22 @@
#define TCMU_VERSION "2.0" #define TCMU_VERSION "2.0"
/* /**
* DOC: Ring Design
* Ring Design * Ring Design
* ----------- * -----------
* *
* The mmaped area is divided into three parts: * The mmaped area is divided into three parts:
* 1) The mailbox (struct tcmu_mailbox, below) * 1) The mailbox (struct tcmu_mailbox, below);
* 2) The command ring * 2) The command ring;
* 3) Everything beyond the command ring (data) * 3) Everything beyond the command ring (data).
* *
* The mailbox tells userspace the offset of the command ring from the * The mailbox tells userspace the offset of the command ring from the
* start of the shared memory region, and how big the command ring is. * start of the shared memory region, and how big the command ring is.
* *
* The kernel passes SCSI commands to userspace by putting a struct * The kernel passes SCSI commands to userspace by putting a struct
* tcmu_cmd_entry in the ring, updating mailbox->cmd_head, and poking * tcmu_cmd_entry in the ring, updating mailbox->cmd_head, and poking
* userspace via uio's interrupt mechanism. * userspace via UIO's interrupt mechanism.
* *
* tcmu_cmd_entry contains a header. If the header type is PAD, * tcmu_cmd_entry contains a header. If the header type is PAD,
* userspace should skip hdr->length bytes (mod cmdr_size) to find the * userspace should skip hdr->length bytes (mod cmdr_size) to find the