|
@@ -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
|