VMM: Converted headers to use pragma once
[akaros.git] / user / vmm / include / vmm / virtio_blk.h
1 #pragma once
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  * 3. Neither the name of IBM nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE. */
27 #include <linux/types.h>
28 #include <linux/virtio_ids.h>
29 #include <linux/virtio_config.h>
30 #include <linux/virtio_types.h>
31
32 /* Feature bits */
33 #define VIRTIO_BLK_F_SIZE_MAX   1       /* Indicates maximum segment size */
34 #define VIRTIO_BLK_F_SEG_MAX    2       /* Indicates maximum # of segments */
35 #define VIRTIO_BLK_F_GEOMETRY   4       /* Legacy geometry available  */
36 #define VIRTIO_BLK_F_RO         5       /* Disk is read-only */
37 #define VIRTIO_BLK_F_BLK_SIZE   6       /* Block size of disk is available*/
38 #define VIRTIO_BLK_F_TOPOLOGY   10      /* Topology information is available */
39 #define VIRTIO_BLK_F_MQ         12      /* support more than one vq */
40
41 /* Legacy feature bits */
42 #ifndef VIRTIO_BLK_NO_LEGACY
43 #define VIRTIO_BLK_F_BARRIER    0       /* Does host support barriers? */
44 #define VIRTIO_BLK_F_SCSI       7       /* Supports scsi command passthru */
45 #define VIRTIO_BLK_F_WCE        9       /* Writeback mode enabled after reset */
46 #define VIRTIO_BLK_F_CONFIG_WCE 11      /* Writeback mode available in config */
47 #ifndef __KERNEL__
48 /* Old (deprecated) name for VIRTIO_BLK_F_WCE. */
49 #define VIRTIO_BLK_F_FLUSH VIRTIO_BLK_F_WCE
50 #endif
51 #endif /* !VIRTIO_BLK_NO_LEGACY */
52
53 #define VIRTIO_BLK_ID_BYTES     20      /* ID string length */
54
55 struct virtio_blk_config {
56         /* The capacity (in 512-byte sectors). */
57         __u64 capacity;
58         /* The maximum segment size (if VIRTIO_BLK_F_SIZE_MAX) */
59         __u32 size_max;
60         /* The maximum number of segments (if VIRTIO_BLK_F_SEG_MAX) */
61         __u32 seg_max;
62         /* geometry of the device (if VIRTIO_BLK_F_GEOMETRY) */
63         struct virtio_blk_geometry {
64                 __u16 cylinders;
65                 __u8 heads;
66                 __u8 sectors;
67         } geometry;
68
69         /* block size of device (if VIRTIO_BLK_F_BLK_SIZE) */
70         __u32 blk_size;
71
72         /* the next 4 entries are guarded by VIRTIO_BLK_F_TOPOLOGY  */
73         /* exponent for physical block per logical block. */
74         __u8 physical_block_exp;
75         /* alignment offset in logical blocks. */
76         __u8 alignment_offset;
77         /* minimum I/O size without performance penalty in logical blocks. */
78         __u16 min_io_size;
79         /* optimal sustained I/O size in logical blocks. */
80         __u32 opt_io_size;
81
82         /* writeback mode (if VIRTIO_BLK_F_CONFIG_WCE) */
83         __u8 wce;
84         __u8 unused;
85
86         /* number of vqs, only available when VIRTIO_BLK_F_MQ is set */
87         __u16 num_queues;
88 } __attribute__((packed));
89
90 /*
91  * Command types
92  *
93  * Usage is a bit tricky as some bits are used as flags and some are not.
94  *
95  * Rules:
96  *   VIRTIO_BLK_T_OUT may be combined with VIRTIO_BLK_T_SCSI_CMD or
97  *   VIRTIO_BLK_T_BARRIER.  VIRTIO_BLK_T_FLUSH is a command of its own
98  *   and may not be combined with any of the other flags.
99  */
100
101 /* These two define direction. */
102 #define VIRTIO_BLK_T_IN         0
103 #define VIRTIO_BLK_T_OUT        1
104
105 #ifndef VIRTIO_BLK_NO_LEGACY
106 /* This bit says it's a scsi command, not an actual read or write. */
107 #define VIRTIO_BLK_T_SCSI_CMD   2
108 #endif /* VIRTIO_BLK_NO_LEGACY */
109
110 /* Cache flush command */
111 #define VIRTIO_BLK_T_FLUSH      4
112
113 /* Get device ID command */
114 #define VIRTIO_BLK_T_GET_ID    8
115
116 #ifndef VIRTIO_BLK_NO_LEGACY
117 /* Barrier before this op. */
118 #define VIRTIO_BLK_T_BARRIER    0x80000000
119 #endif /* !VIRTIO_BLK_NO_LEGACY */
120
121 /*
122  * This comes first in the read scatter-gather list.
123  * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated,
124  * this is the first element of the read scatter-gather list.
125  */
126 struct virtio_blk_outhdr {
127         /* VIRTIO_BLK_T* */
128         __virtio32 type;
129         /* io priority. */
130         __virtio32 ioprio;
131         /* Sector (ie. 512 byte offset) */
132         __virtio64 sector;
133 };
134
135 #ifndef VIRTIO_BLK_NO_LEGACY
136 struct virtio_scsi_inhdr {
137         __virtio32 errors;
138         __virtio32 data_len;
139         __virtio32 sense_len;
140         __virtio32 residual;
141 };
142 #endif /* !VIRTIO_BLK_NO_LEGACY */
143
144 /* And this is the final byte of the write scatter-gather list. */
145 #define VIRTIO_BLK_S_OK         0
146 #define VIRTIO_BLK_S_IOERR      1
147 #define VIRTIO_BLK_S_UNSUPP     2
148