VMM: Removed virtio_types.h and includes for that file
[akaros.git] / user / vmm / include / vmm / virtio_scsi.h
1 /*
2  * This header is BSD licensed so anyone can use the definitions to implement
3  * compatible drivers/servers.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 /* Default values of the CDB and sense data size configuration fields */
30 #define VIRTIO_SCSI_CDB_DEFAULT_SIZE   32
31 #define VIRTIO_SCSI_SENSE_DEFAULT_SIZE 96
32
33 #ifndef VIRTIO_SCSI_CDB_SIZE
34 #define VIRTIO_SCSI_CDB_SIZE VIRTIO_SCSI_CDB_DEFAULT_SIZE
35 #endif
36 #ifndef VIRTIO_SCSI_SENSE_SIZE
37 #define VIRTIO_SCSI_SENSE_SIZE VIRTIO_SCSI_SENSE_DEFAULT_SIZE
38 #endif
39
40 /* SCSI command request, followed by data-out */
41 struct virtio_scsi_cmd_req {
42         __u8 lun[8];            /* Logical Unit Number */
43         __virtio64 tag;         /* Command identifier */
44         __u8 task_attr;         /* Task attribute */
45         __u8 prio;              /* SAM command priority field */
46         __u8 crn;
47         __u8 cdb[VIRTIO_SCSI_CDB_SIZE];
48 } __attribute__((packed));
49
50 /* SCSI command request, followed by protection information */
51 struct virtio_scsi_cmd_req_pi {
52         __u8 lun[8];            /* Logical Unit Number */
53         __virtio64 tag;         /* Command identifier */
54         __u8 task_attr;         /* Task attribute */
55         __u8 prio;              /* SAM command priority field */
56         __u8 crn;
57         __virtio32 pi_bytesout; /* DataOUT PI Number of bytes */
58         __virtio32 pi_bytesin;          /* DataIN PI Number of bytes */
59         __u8 cdb[VIRTIO_SCSI_CDB_SIZE];
60 } __attribute__((packed));
61
62 /* Response, followed by sense data and data-in */
63 struct virtio_scsi_cmd_resp {
64         __virtio32 sense_len;           /* Sense data length */
65         __virtio32 resid;               /* Residual bytes in data buffer */
66         __virtio16 status_qualifier;    /* Status qualifier */
67         __u8 status;            /* Command completion status */
68         __u8 response;          /* Response values */
69         __u8 sense[VIRTIO_SCSI_SENSE_SIZE];
70 } __attribute__((packed));
71
72 /* Task Management Request */
73 struct virtio_scsi_ctrl_tmf_req {
74         __virtio32 type;
75         __virtio32 subtype;
76         __u8 lun[8];
77         __virtio64 tag;
78 } __attribute__((packed));
79
80 struct virtio_scsi_ctrl_tmf_resp {
81         __u8 response;
82 } __attribute__((packed));
83
84 /* Asynchronous notification query/subscription */
85 struct virtio_scsi_ctrl_an_req {
86         __virtio32 type;
87         __u8 lun[8];
88         __virtio32 event_requested;
89 } __attribute__((packed));
90
91 struct virtio_scsi_ctrl_an_resp {
92         __virtio32 event_actual;
93         __u8 response;
94 } __attribute__((packed));
95
96 struct virtio_scsi_event {
97         __virtio32 event;
98         __u8 lun[8];
99         __virtio32 reason;
100 } __attribute__((packed));
101
102 struct virtio_scsi_config {
103         __u32 num_queues;
104         __u32 seg_max;
105         __u32 max_sectors;
106         __u32 cmd_per_lun;
107         __u32 event_info_size;
108         __u32 sense_size;
109         __u32 cdb_size;
110         __u16 max_channel;
111         __u16 max_target;
112         __u32 max_lun;
113 } __attribute__((packed));
114
115 /* Feature Bits */
116 #define VIRTIO_SCSI_F_INOUT                    0
117 #define VIRTIO_SCSI_F_HOTPLUG                  1
118 #define VIRTIO_SCSI_F_CHANGE                   2
119 #define VIRTIO_SCSI_F_T10_PI                   3
120
121 /* Response codes */
122 #define VIRTIO_SCSI_S_OK                       0
123 #define VIRTIO_SCSI_S_OVERRUN                  1
124 #define VIRTIO_SCSI_S_ABORTED                  2
125 #define VIRTIO_SCSI_S_BAD_TARGET               3
126 #define VIRTIO_SCSI_S_RESET                    4
127 #define VIRTIO_SCSI_S_BUSY                     5
128 #define VIRTIO_SCSI_S_TRANSPORT_FAILURE        6
129 #define VIRTIO_SCSI_S_TARGET_FAILURE           7
130 #define VIRTIO_SCSI_S_NEXUS_FAILURE            8
131 #define VIRTIO_SCSI_S_FAILURE                  9
132 #define VIRTIO_SCSI_S_FUNCTION_SUCCEEDED       10
133 #define VIRTIO_SCSI_S_FUNCTION_REJECTED        11
134 #define VIRTIO_SCSI_S_INCORRECT_LUN            12
135
136 /* Controlq type codes.  */
137 #define VIRTIO_SCSI_T_TMF                      0
138 #define VIRTIO_SCSI_T_AN_QUERY                 1
139 #define VIRTIO_SCSI_T_AN_SUBSCRIBE             2
140
141 /* Valid TMF subtypes.  */
142 #define VIRTIO_SCSI_T_TMF_ABORT_TASK           0
143 #define VIRTIO_SCSI_T_TMF_ABORT_TASK_SET       1
144 #define VIRTIO_SCSI_T_TMF_CLEAR_ACA            2
145 #define VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET       3
146 #define VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET      4
147 #define VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET   5
148 #define VIRTIO_SCSI_T_TMF_QUERY_TASK           6
149 #define VIRTIO_SCSI_T_TMF_QUERY_TASK_SET       7
150
151 /* Events.  */
152 #define VIRTIO_SCSI_T_EVENTS_MISSED            0x80000000
153 #define VIRTIO_SCSI_T_NO_EVENT                 0
154 #define VIRTIO_SCSI_T_TRANSPORT_RESET          1
155 #define VIRTIO_SCSI_T_ASYNC_NOTIFY             2
156 #define VIRTIO_SCSI_T_PARAM_CHANGE             3
157
158 /* Reasons of transport reset event */
159 #define VIRTIO_SCSI_EVT_RESET_HARD             0
160 #define VIRTIO_SCSI_EVT_RESET_RESCAN           1
161 #define VIRTIO_SCSI_EVT_RESET_REMOVED          2
162
163 #define VIRTIO_SCSI_S_SIMPLE                   0
164 #define VIRTIO_SCSI_S_ORDERED                  1
165 #define VIRTIO_SCSI_S_HEAD                     2
166 #define VIRTIO_SCSI_S_ACA                      3
167
168
169