2 * This header is BSD licensed so anyone can use the definitions to implement
3 * compatible drivers/servers.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #ifndef _LINUX_VIRTIO_SCSI_H
28 #define _LINUX_VIRTIO_SCSI_H
30 #include <linux/virtio_types.h>
32 #define VIRTIO_SCSI_CDB_SIZE 32
33 #define VIRTIO_SCSI_SENSE_SIZE 96
35 /* SCSI command request, followed by data-out */
36 struct virtio_scsi_cmd_req {
37 __u8 lun[8]; /* Logical Unit Number */
38 __virtio64 tag; /* Command identifier */
39 __u8 task_attr; /* Task attribute */
40 __u8 prio; /* SAM command priority field */
42 __u8 cdb[VIRTIO_SCSI_CDB_SIZE];
43 } __attribute__((packed));
45 /* SCSI command request, followed by protection information */
46 struct virtio_scsi_cmd_req_pi {
47 __u8 lun[8]; /* Logical Unit Number */
48 __virtio64 tag; /* Command identifier */
49 __u8 task_attr; /* Task attribute */
50 __u8 prio; /* SAM command priority field */
52 __virtio32 pi_bytesout; /* DataOUT PI Number of bytes */
53 __virtio32 pi_bytesin; /* DataIN PI Number of bytes */
54 __u8 cdb[VIRTIO_SCSI_CDB_SIZE];
55 } __attribute__((packed));
57 /* Response, followed by sense data and data-in */
58 struct virtio_scsi_cmd_resp {
59 __virtio32 sense_len; /* Sense data length */
60 __virtio32 resid; /* Residual bytes in data buffer */
61 __virtio16 status_qualifier; /* Status qualifier */
62 __u8 status; /* Command completion status */
63 __u8 response; /* Response values */
64 __u8 sense[VIRTIO_SCSI_SENSE_SIZE];
65 } __attribute__((packed));
67 /* Task Management Request */
68 struct virtio_scsi_ctrl_tmf_req {
73 } __attribute__((packed));
75 struct virtio_scsi_ctrl_tmf_resp {
77 } __attribute__((packed));
79 /* Asynchronous notification query/subscription */
80 struct virtio_scsi_ctrl_an_req {
83 __virtio32 event_requested;
84 } __attribute__((packed));
86 struct virtio_scsi_ctrl_an_resp {
87 __virtio32 event_actual;
89 } __attribute__((packed));
91 struct virtio_scsi_event {
95 } __attribute__((packed));
97 struct virtio_scsi_config {
102 __u32 event_info_size;
108 } __attribute__((packed));
111 #define VIRTIO_SCSI_F_INOUT 0
112 #define VIRTIO_SCSI_F_HOTPLUG 1
113 #define VIRTIO_SCSI_F_CHANGE 2
114 #define VIRTIO_SCSI_F_T10_PI 3
117 #define VIRTIO_SCSI_S_OK 0
118 #define VIRTIO_SCSI_S_OVERRUN 1
119 #define VIRTIO_SCSI_S_ABORTED 2
120 #define VIRTIO_SCSI_S_BAD_TARGET 3
121 #define VIRTIO_SCSI_S_RESET 4
122 #define VIRTIO_SCSI_S_BUSY 5
123 #define VIRTIO_SCSI_S_TRANSPORT_FAILURE 6
124 #define VIRTIO_SCSI_S_TARGET_FAILURE 7
125 #define VIRTIO_SCSI_S_NEXUS_FAILURE 8
126 #define VIRTIO_SCSI_S_FAILURE 9
127 #define VIRTIO_SCSI_S_FUNCTION_SUCCEEDED 10
128 #define VIRTIO_SCSI_S_FUNCTION_REJECTED 11
129 #define VIRTIO_SCSI_S_INCORRECT_LUN 12
131 /* Controlq type codes. */
132 #define VIRTIO_SCSI_T_TMF 0
133 #define VIRTIO_SCSI_T_AN_QUERY 1
134 #define VIRTIO_SCSI_T_AN_SUBSCRIBE 2
136 /* Valid TMF subtypes. */
137 #define VIRTIO_SCSI_T_TMF_ABORT_TASK 0
138 #define VIRTIO_SCSI_T_TMF_ABORT_TASK_SET 1
139 #define VIRTIO_SCSI_T_TMF_CLEAR_ACA 2
140 #define VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET 3
141 #define VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET 4
142 #define VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET 5
143 #define VIRTIO_SCSI_T_TMF_QUERY_TASK 6
144 #define VIRTIO_SCSI_T_TMF_QUERY_TASK_SET 7
147 #define VIRTIO_SCSI_T_EVENTS_MISSED 0x80000000
148 #define VIRTIO_SCSI_T_NO_EVENT 0
149 #define VIRTIO_SCSI_T_TRANSPORT_RESET 1
150 #define VIRTIO_SCSI_T_ASYNC_NOTIFY 2
151 #define VIRTIO_SCSI_T_PARAM_CHANGE 3
153 /* Reasons of transport reset event */
154 #define VIRTIO_SCSI_EVT_RESET_HARD 0
155 #define VIRTIO_SCSI_EVT_RESET_RESCAN 1
156 #define VIRTIO_SCSI_EVT_RESET_REMOVED 2
158 #define VIRTIO_SCSI_S_SIMPLE 0
159 #define VIRTIO_SCSI_S_ORDERED 1
160 #define VIRTIO_SCSI_S_HEAD 2
161 #define VIRTIO_SCSI_S_ACA 3
164 #endif /* _LINUX_VIRTIO_SCSI_H */