Fix -device help and documentation
[qemu/aliguori-queue.git] / hw / virtio-blk.h
blob7a7ece3d93a995367ddbb3bb9109da06724d195f
1 /*
2 * Virtio Block Device
4 * Copyright IBM, Corp. 2007
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
14 #ifndef _QEMU_VIRTIO_BLK_H
15 #define _QEMU_VIRTIO_BLK_H
17 #include "virtio.h"
18 #include "block.h"
20 /* from Linux's linux/virtio_blk.h */
22 /* The ID for virtio_block */
23 #define VIRTIO_ID_BLOCK 2
25 /* Feature bits */
26 #define VIRTIO_BLK_F_BARRIER 0 /* Does host support barriers? */
27 #define VIRTIO_BLK_F_SIZE_MAX 1 /* Indicates maximum segment size */
28 #define VIRTIO_BLK_F_SEG_MAX 2 /* Indicates maximum # of segments */
29 #define VIRTIO_BLK_F_GEOMETRY 4 /* Indicates support of legacy geometry */
30 #define VIRTIO_BLK_F_RO 5 /* Disk is read-only */
31 #define VIRTIO_BLK_F_BLK_SIZE 6 /* Block size of disk is available*/
32 #define VIRTIO_BLK_F_SCSI 7 /* Supports scsi command passthru */
33 /* #define VIRTIO_BLK_F_IDENTIFY 8 ATA IDENTIFY supported, DEPRECATED */
34 #define VIRTIO_BLK_F_WCACHE 9 /* write cache enabled */
35 #define VIRTIO_BLK_F_TOPOLOGY 10 /* Topology information is available */
37 struct virtio_blk_config
39 uint64_t capacity;
40 uint32_t size_max;
41 uint32_t seg_max;
42 uint16_t cylinders;
43 uint8_t heads;
44 uint8_t sectors;
45 uint32_t blk_size;
46 uint8_t physical_block_exp;
47 uint8_t alignment_offset;
48 uint16_t min_io_size;
49 uint32_t opt_io_size;
50 } __attribute__((packed));
52 /* These two define direction. */
53 #define VIRTIO_BLK_T_IN 0
54 #define VIRTIO_BLK_T_OUT 1
56 /* This bit says it's a scsi command, not an actual read or write. */
57 #define VIRTIO_BLK_T_SCSI_CMD 2
59 /* Flush the volatile write cache */
60 #define VIRTIO_BLK_T_FLUSH 4
62 /* Barrier before this op. */
63 #define VIRTIO_BLK_T_BARRIER 0x80000000
65 /* This is the first element of the read scatter-gather list. */
66 struct virtio_blk_outhdr
68 /* VIRTIO_BLK_T* */
69 uint32_t type;
70 /* io priority. */
71 uint32_t ioprio;
72 /* Sector (ie. 512 byte offset) */
73 uint64_t sector;
76 #define VIRTIO_BLK_S_OK 0
77 #define VIRTIO_BLK_S_IOERR 1
78 #define VIRTIO_BLK_S_UNSUPP 2
80 /* This is the last element of the write scatter-gather list */
81 struct virtio_blk_inhdr
83 unsigned char status;
86 /* SCSI pass-through header */
87 struct virtio_scsi_inhdr
89 uint32_t errors;
90 uint32_t data_len;
91 uint32_t sense_len;
92 uint32_t residual;
95 #ifdef __linux__
96 #define DEFINE_VIRTIO_BLK_FEATURES(_state, _field) \
97 DEFINE_VIRTIO_COMMON_FEATURES(_state, _field), \
98 DEFINE_PROP_BIT("scsi", _state, _field, VIRTIO_BLK_F_SCSI, true)
99 #else
100 #define DEFINE_VIRTIO_BLK_FEATURES(_state, _field) \
101 DEFINE_VIRTIO_COMMON_FEATURES(_state, _field)
102 #endif
103 #endif