BackPup/Linux
1
0 Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-10-07 05:31:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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 <[email protected]>
To: "Nicholas A. Bellinger" <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: "James E.J. Bottomley" <[email protected]>
Cc: "Martin K. Petersen" <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Signed-off-by: Martin K. Petersen <[email protected]>
This commit is contained in:
Randy Dunlap authored and Martin K. Petersen committed 2018-04-20 19:14:39 -04:00
1 parent 9ad97b8b40
commit 572ccdab50
2 files changed
+12 -7
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

drivers/target/target_core_user.c
+6 -2
View File
@@ -42,7 +42,11 @@
#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
* data to userspace for processing. This is to allow backends that
* 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
* command ring is defined, the particulars of the data area are
* 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
* moving buffer allocations, or even page flipping or other
* allocation techniques, without altering the command ring layout.
include/uapi/linux/target_core_user.h
+6 -5
View File
@@ -9,21 +9,22 @@
#define TCMU_VERSION "2.0"
/*
/**
* DOC: Ring Design
* Ring Design
* -----------
*
* The mmaped area is divided into three parts:
* 1) The mailbox (struct tcmu_mailbox, below)
* 2) The command ring
* 3) Everything beyond the command ring (data)
* 1) The mailbox (struct tcmu_mailbox, below);
* 2) The command ring;
* 3) Everything beyond the command ring (data).
*
* 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.
*
* The kernel passes SCSI commands to userspace by putting a struct
* 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,
* userspace should skip hdr->length bytes (mod cmdr_size) to find the