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