2 * Permission is hereby granted, free of charge, to any person obtaining a copy
3 * of this software and associated documentation files (the "Software"), to
4 * deal in the Software without restriction, including without limitation the
5 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
6 * sell copies of the Software, and to permit persons to whom the Software is
7 * furnished to do so, subject to the following conditions:
9 * The above copyright notice and this permission notice shall be included in
10 * all copies or substantial portions of the Software.
12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
17 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
18 * DEALINGS IN THE SOFTWARE.
21 #ifndef __XEN_BLKIF_H__
22 #define __XEN_BLKIF_H__
24 #include <xen/interface/io/ring.h>
25 #include <xen/interface/io/blkif.h>
26 #include <xen/interface/io/protocols.h>
28 /* Not a real protocol. Used to generate ring structs which contain
29 * the elements common to all protocols only. This way we get a
30 * compiler-checkable way to use common struct elements, so we can
31 * avoid using switch(protocol) in a number of places. */
32 struct blkif_common_request {
35 struct blkif_common_response {
39 /* i386 protocol version */
41 struct blkif_x86_32_request {
42 uint8_t operation; /* BLKIF_OP_??? */
43 uint8_t nr_segments; /* number of segments */
44 blkif_vdev_t handle; /* only for read/write requests */
45 uint64_t id; /* private guest value, echoed in resp */
46 blkif_sector_t sector_number;/* start sector idx on disk (r/w only) */
47 struct blkif_request_segment seg[BLKIF_MAX_SEGMENTS_PER_REQUEST];
49 struct blkif_x86_32_response {
50 uint64_t id; /* copied from request */
51 uint8_t operation; /* copied from request */
52 int16_t status; /* BLKIF_RSP_??? */
54 typedef struct blkif_x86_32_request blkif_x86_32_request_t;
55 typedef struct blkif_x86_32_response blkif_x86_32_response_t;
58 /* x86_64 protocol version */
59 struct blkif_x86_64_request {
60 uint8_t operation; /* BLKIF_OP_??? */
61 uint8_t nr_segments; /* number of segments */
62 blkif_vdev_t handle; /* only for read/write requests */
63 uint64_t __attribute__((__aligned__(8))) id;
64 blkif_sector_t sector_number;/* start sector idx on disk (r/w only) */
65 struct blkif_request_segment seg[BLKIF_MAX_SEGMENTS_PER_REQUEST];
67 struct blkif_x86_64_response {
68 uint64_t __attribute__((__aligned__(8))) id;
69 uint8_t operation; /* copied from request */
70 int16_t status; /* BLKIF_RSP_??? */
72 typedef struct blkif_x86_64_request blkif_x86_64_request_t;
73 typedef struct blkif_x86_64_response blkif_x86_64_response_t;
75 DEFINE_RING_TYPES(blkif_common, struct blkif_common_request, struct blkif_common_response);
76 DEFINE_RING_TYPES(blkif_x86_32, struct blkif_x86_32_request, struct blkif_x86_32_response);
77 DEFINE_RING_TYPES(blkif_x86_64, struct blkif_x86_64_request, struct blkif_x86_64_response);
79 union blkif_back_rings {
80 struct blkif_back_ring native;
81 struct blkif_common_back_ring common;
82 struct blkif_x86_32_back_ring x86_32;
83 struct blkif_x86_64_back_ring x86_64;
87 BLKIF_PROTOCOL_NATIVE = 1,
88 BLKIF_PROTOCOL_X86_32 = 2,
89 BLKIF_PROTOCOL_X86_64 = 3,
92 #endif /* __XEN_BLKIF_H__ */