1 #ifndef __TARGET_CORE_USER_H
2 #define __TARGET_CORE_USER_H
4 /* This header will be used by application too */
6 #include <linux/types.h>
9 #define TCMU_VERSION "2.0"
15 * The mmaped area is divided into three parts:
16 * 1) The mailbox (struct tcmu_mailbox, below)
18 * 3) Everything beyond the command ring (data)
20 * The mailbox tells userspace the offset of the command ring from the
21 * start of the shared memory region, and how big the command ring is.
23 * The kernel passes SCSI commands to userspace by putting a struct
24 * tcmu_cmd_entry in the ring, updating mailbox->cmd_head, and poking
25 * userspace via uio's interrupt mechanism.
27 * tcmu_cmd_entry contains a header. If the header type is PAD,
28 * userspace should skip hdr->length bytes (mod cmdr_size) to find the
31 * Otherwise, the entry will contain offsets into the mmaped area that
32 * contain the cdb and data buffers -- the latter accessible via the
33 * iov array. iov addresses are also offsets into the shared area.
35 * When userspace is completed handling the command, set
36 * entry->rsp.scsi_status, fill in rsp.sense_buffer if appropriate,
37 * and also set mailbox->cmd_tail equal to the old cmd_tail plus
38 * hdr->length, mod cmdr_size. If cmd_tail doesn't equal cmd_head, it
39 * should process the next packet the same way, and so on.
42 #define TCMU_MAILBOX_VERSION 2
43 #define ALIGN_SIZE 64 /* Should be enough for most CPUs */
45 /* See https://gcc.gnu.org/onlinedocs/cpp/Stringification.html */
46 #define xstr(s) str(s)
57 /* Updated by user. On its own cacheline */
58 __u32 cmd_tail __attribute__((__aligned__(ALIGN_SIZE)));
68 * Only a few opcodes, and length is 8-byte aligned, so use low bits for opcode.
70 struct tcmu_cmd_entry_hdr {
74 #define TCMU_UFLAG_UNKNOWN_OP 0x1
79 #define TCMU_OP_MASK 0x7
81 static inline enum tcmu_opcode tcmu_hdr_get_op(__u32 len_op)
83 return len_op & TCMU_OP_MASK;
86 static inline void tcmu_hdr_set_op(__u32 *len_op, enum tcmu_opcode op)
88 *len_op &= ~TCMU_OP_MASK;
89 *len_op |= (op & TCMU_OP_MASK);
92 static inline __u32 tcmu_hdr_get_len(__u32 len_op)
94 return len_op & ~TCMU_OP_MASK;
97 static inline void tcmu_hdr_set_len(__u32 *len_op, __u32 len)
99 *len_op &= TCMU_OP_MASK;
103 /* Currently the same as SCSI_SENSE_BUFFERSIZE */
104 #define TCMU_SENSE_BUFFERSIZE 96
106 struct tcmu_cmd_entry {
107 struct tcmu_cmd_entry_hdr hdr;
112 uint32_t iov_bidi_cnt;
113 uint32_t iov_dif_cnt;
124 char sense_buffer[TCMU_SENSE_BUFFERSIZE];
130 #define TCMU_OP_ALIGN_SIZE sizeof(uint64_t)
134 TCMU_CMD_ADDED_DEVICE,
135 TCMU_CMD_REMOVED_DEVICE,
138 #define TCMU_CMD_MAX (__TCMU_CMD_MAX - 1)
140 enum tcmu_genl_attr {
146 #define TCMU_ATTR_MAX (__TCMU_ATTR_MAX - 1)