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 * $FreeBSD$
27 */
28
29#ifndef _VIRTIO_SCSI_H
30#define _VIRTIO_SCSI_H
31
32/* Feature bits */
33#define VIRTIO_SCSI_F_INOUT	0x0001	/* Single request can contain both
34					 * read and write buffers */
35#define VIRTIO_SCSI_F_HOTPLUG	0x0002	/* Host should enable hot plug/unplug
36					 * of new LUNs and targets.
37					 */
38#define VIRTIO_SCSI_F_CHANGE	0x0004	/* Host can change the config */
39
40#define VIRTIO_SCSI_CDB_SIZE	32
41#define VIRTIO_SCSI_SENSE_SIZE	96
42
43/* SCSI command request, followed by data-out */
44struct virtio_scsi_cmd_req {
45	uint8_t lun[8];		/* Logical Unit Number */
46	uint64_t tag;		/* Command identifier */
47	uint8_t task_attr;	/* Task attribute */
48	uint8_t prio;
49	uint8_t crn;
50	uint8_t cdb[VIRTIO_SCSI_CDB_SIZE];
51} _PACKED;
52
53/* Response, followed by sense data and data-in */
54struct virtio_scsi_cmd_resp {
55	uint32_t sense_len;		/* Sense data length */
56	uint32_t resid;			/* Residual bytes in data buffer */
57	uint16_t status_qualifier;	/* Status qualifier */
58	uint8_t status;			/* Command completion status */
59	uint8_t response;		/* Response values */
60	uint8_t sense[VIRTIO_SCSI_SENSE_SIZE];
61} _PACKED;
62
63/* Task Management Request */
64struct virtio_scsi_ctrl_tmf_req {
65	uint32_t type;
66	uint32_t subtype;
67	uint8_t lun[8];
68	uint64_t tag;
69} _PACKED;
70
71struct virtio_scsi_ctrl_tmf_resp {
72	uint8_t response;
73} _PACKED;
74
75/* Asynchronous notification query/subscription */
76struct virtio_scsi_ctrl_an_req {
77	uint32_t type;
78	uint8_t lun[8];
79	uint32_t event_requested;
80} _PACKED;
81
82struct virtio_scsi_ctrl_an_resp {
83	uint32_t event_actual;
84	uint8_t response;
85} _PACKED;
86
87struct virtio_scsi_event {
88	uint32_t event;
89	uint8_t lun[8];
90	uint32_t reason;
91} _PACKED;
92
93struct virtio_scsi_config {
94	uint32_t num_queues;
95	uint32_t seg_max;
96	uint32_t max_sectors;
97	uint32_t cmd_per_lun;
98	uint32_t event_info_size;
99	uint32_t sense_size;
100	uint32_t cdb_size;
101	uint16_t max_channel;
102	uint16_t max_target;
103	uint32_t max_lun;
104} _PACKED;
105
106/* Response codes */
107#define VIRTIO_SCSI_S_OK                       0
108#define VIRTIO_SCSI_S_FUNCTION_COMPLETE        0
109#define VIRTIO_SCSI_S_OVERRUN                  1
110#define VIRTIO_SCSI_S_ABORTED                  2
111#define VIRTIO_SCSI_S_BAD_TARGET               3
112#define VIRTIO_SCSI_S_RESET                    4
113#define VIRTIO_SCSI_S_BUSY                     5
114#define VIRTIO_SCSI_S_TRANSPORT_FAILURE        6
115#define VIRTIO_SCSI_S_TARGET_FAILURE           7
116#define VIRTIO_SCSI_S_NEXUS_FAILURE            8
117#define VIRTIO_SCSI_S_FAILURE                  9
118#define VIRTIO_SCSI_S_FUNCTION_SUCCEEDED       10
119#define VIRTIO_SCSI_S_FUNCTION_REJECTED        11
120#define VIRTIO_SCSI_S_INCORRECT_LUN            12
121
122/* Controlq type codes.  */
123#define VIRTIO_SCSI_T_TMF                      0
124#define VIRTIO_SCSI_T_AN_QUERY                 1
125#define VIRTIO_SCSI_T_AN_SUBSCRIBE             2
126
127/* Valid TMF subtypes.  */
128#define VIRTIO_SCSI_T_TMF_ABORT_TASK           0
129#define VIRTIO_SCSI_T_TMF_ABORT_TASK_SET       1
130#define VIRTIO_SCSI_T_TMF_CLEAR_ACA            2
131#define VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET       3
132#define VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET      4
133#define VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET   5
134#define VIRTIO_SCSI_T_TMF_QUERY_TASK           6
135#define VIRTIO_SCSI_T_TMF_QUERY_TASK_SET       7
136
137/* Events.  */
138#define VIRTIO_SCSI_T_EVENTS_MISSED            0x80000000
139#define VIRTIO_SCSI_T_NO_EVENT                 0
140#define VIRTIO_SCSI_T_TRANSPORT_RESET          1
141#define VIRTIO_SCSI_T_ASYNC_NOTIFY             2
142#define VIRTIO_SCSI_T_PARAM_CHANGE             3
143
144/* Reasons of transport reset event */
145#define VIRTIO_SCSI_EVT_RESET_HARD             0
146#define VIRTIO_SCSI_EVT_RESET_RESCAN           1
147#define VIRTIO_SCSI_EVT_RESET_REMOVED          2
148
149#define VIRTIO_SCSI_S_SIMPLE                   0
150#define VIRTIO_SCSI_S_ORDERED                  1
151#define VIRTIO_SCSI_S_HEAD                     2
152#define VIRTIO_SCSI_S_ACA                      3
153
154#endif /* _VIRTIO_SCSI_H */
155