1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef __TARGET_CORE_USER_H
3 #define __TARGET_CORE_USER_H
5 /* This header will be used by application too */
7 #include <linux/types.h>
10 #define TCMU_VERSION "2.0"
16 * The mmaped area is divided into three parts:
17 * 1) The mailbox (struct tcmu_mailbox, below)
19 * 3) Everything beyond the command ring (data)
21 * The mailbox tells userspace the offset of the command ring from the
22 * start of the shared memory region, and how big the command ring is.
24 * The kernel passes SCSI commands to userspace by putting a struct
25 * tcmu_cmd_entry in the ring, updating mailbox->cmd_head, and poking
26 * userspace via uio's interrupt mechanism.
28 * tcmu_cmd_entry contains a header. If the header type is PAD,
29 * userspace should skip hdr->length bytes (mod cmdr_size) to find the
32 * Otherwise, the entry will contain offsets into the mmaped area that
33 * contain the cdb and data buffers -- the latter accessible via the
34 * iov array. iov addresses are also offsets into the shared area.
36 * When userspace is completed handling the command, set
37 * entry->rsp.scsi_status, fill in rsp.sense_buffer if appropriate,
38 * and also set mailbox->cmd_tail equal to the old cmd_tail plus
39 * hdr->length, mod cmdr_size. If cmd_tail doesn't equal cmd_head, it
40 * should process the next packet the same way, and so on.
43 #define TCMU_MAILBOX_VERSION 2
44 #define ALIGN_SIZE 64 /* Should be enough for most CPUs */
45 #define TCMU_MAILBOX_FLAG_CAP_OOOC (1 << 0) /* Out-of-order completions */
55 /* Updated by user. On its own cacheline */
56 __u32 cmd_tail __attribute__((__aligned__(ALIGN_SIZE)));
66 * Only a few opcodes, and length is 8-byte aligned, so use low bits for opcode.
68 struct tcmu_cmd_entry_hdr {
72 #define TCMU_UFLAG_UNKNOWN_OP 0x1
77 #define TCMU_OP_MASK 0x7
79 static inline enum tcmu_opcode tcmu_hdr_get_op(__u32 len_op)
81 return len_op & TCMU_OP_MASK;
84 static inline void tcmu_hdr_set_op(__u32 *len_op, enum tcmu_opcode op)
86 *len_op &= ~TCMU_OP_MASK;
87 *len_op |= (op & TCMU_OP_MASK);
90 static inline __u32 tcmu_hdr_get_len(__u32 len_op)
92 return len_op & ~TCMU_OP_MASK;
95 static inline void tcmu_hdr_set_len(__u32 *len_op, __u32 len)
97 *len_op &= TCMU_OP_MASK;
101 /* Currently the same as SCSI_SENSE_BUFFERSIZE */
102 #define TCMU_SENSE_BUFFERSIZE 96
104 struct tcmu_cmd_entry {
105 struct tcmu_cmd_entry_hdr hdr;
122 char sense_buffer[TCMU_SENSE_BUFFERSIZE];
128 #define TCMU_OP_ALIGN_SIZE sizeof(__u64)
132 TCMU_CMD_ADDED_DEVICE,
133 TCMU_CMD_REMOVED_DEVICE,
134 TCMU_CMD_RECONFIG_DEVICE,
135 TCMU_CMD_ADDED_DEVICE_DONE,
136 TCMU_CMD_REMOVED_DEVICE_DONE,
137 TCMU_CMD_RECONFIG_DEVICE_DONE,
138 TCMU_CMD_SET_FEATURES,
141 #define TCMU_CMD_MAX (__TCMU_CMD_MAX - 1)
143 enum tcmu_genl_attr {
150 TCMU_ATTR_WRITECACHE,
151 TCMU_ATTR_CMD_STATUS,
153 TCMU_ATTR_SUPP_KERN_CMD_REPLY,
156 #define TCMU_ATTR_MAX (__TCMU_ATTR_MAX - 1)