blob: e52029e98919bb38401dd1848de418277ba271a9 [file] [log] [blame]
Rusty Russelle467cde2007-10-22 11:03:38 +10001#ifndef _LINUX_VIRTIO_BLK_H
2#define _LINUX_VIRTIO_BLK_H
Rusty Russell674bfc22008-07-25 12:06:03 -05003/* This header is BSD licensed so anyone can use the definitions to implement
4 * compatible drivers/servers. */
Jaswinder Singh Rajput982f8182009-01-30 22:27:58 +05305#include <linux/types.h>
Christian Borntraegere95646c2009-09-30 11:17:21 +02006#include <linux/virtio_ids.h>
Rusty Russelle467cde2007-10-22 11:03:38 +10007#include <linux/virtio_config.h>
8
Rusty Russelle467cde2007-10-22 11:03:38 +10009/* Feature bits */
Rusty Russella586d4f2008-02-04 23:49:56 -050010#define VIRTIO_BLK_F_BARRIER 0 /* Does host support barriers? */
11#define VIRTIO_BLK_F_SIZE_MAX 1 /* Indicates maximum segment size */
12#define VIRTIO_BLK_F_SEG_MAX 2 /* Indicates maximum # of segments */
Ryan Harper48e40432008-04-16 13:56:37 -050013#define VIRTIO_BLK_F_GEOMETRY 4 /* Legacy geometry available */
Christian Borntraeger3ef53602008-05-16 11:17:03 +020014#define VIRTIO_BLK_F_RO 5 /* Disk is read-only */
Christian Borntraeger066f4d82008-05-29 11:08:26 +020015#define VIRTIO_BLK_F_BLK_SIZE 6 /* Block size of disk is available*/
Hannes Reinecke1cde26f2009-05-18 14:41:30 +020016#define VIRTIO_BLK_F_SCSI 7 /* Supports scsi command passthru */
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +020017#define VIRTIO_BLK_F_FLUSH 9 /* Cache flush command support */
Christoph Hellwig69740c82010-02-24 14:22:25 -060018#define VIRTIO_BLK_F_TOPOLOGY 10 /* Topology information is available */
john cooper1d589bb2009-06-09 14:41:40 +020019
Rusty Russell1842f232009-07-30 16:03:46 -060020struct virtio_blk_config {
Rusty Russella586d4f2008-02-04 23:49:56 -050021 /* The capacity (in 512-byte sectors). */
Christian Borntraeger7757f092008-05-29 11:10:01 +020022 __u64 capacity;
Rusty Russella586d4f2008-02-04 23:49:56 -050023 /* The maximum segment size (if VIRTIO_BLK_F_SIZE_MAX) */
Christian Borntraeger7757f092008-05-29 11:10:01 +020024 __u32 size_max;
Rusty Russella586d4f2008-02-04 23:49:56 -050025 /* The maximum number of segments (if VIRTIO_BLK_F_SEG_MAX) */
Christian Borntraeger7757f092008-05-29 11:10:01 +020026 __u32 seg_max;
Ryan Harper48e40432008-04-16 13:56:37 -050027 /* geometry the device (if VIRTIO_BLK_F_GEOMETRY) */
28 struct virtio_blk_geometry {
Christian Borntraeger7757f092008-05-29 11:10:01 +020029 __u16 cylinders;
Ryan Harper48e40432008-04-16 13:56:37 -050030 __u8 heads;
31 __u8 sectors;
32 } geometry;
Christoph Hellwig69740c82010-02-24 14:22:25 -060033
Christian Borntraeger066f4d82008-05-29 11:08:26 +020034 /* block size of device (if VIRTIO_BLK_F_BLK_SIZE) */
35 __u32 blk_size;
Christoph Hellwig69740c82010-02-24 14:22:25 -060036
37 /* the next 4 entries are guarded by VIRTIO_BLK_F_TOPOLOGY */
38 /* exponent for physical block per logical block. */
39 __u8 physical_block_exp;
40 /* alignment offset in logical blocks. */
41 __u8 alignment_offset;
42 /* minimum I/O size without performance penalty in logical blocks. */
43 __u16 min_io_size;
44 /* optimal sustained I/O size in logical blocks. */
45 __u32 opt_io_size;
46
Rusty Russella586d4f2008-02-04 23:49:56 -050047} __attribute__((packed));
Rusty Russelle467cde2007-10-22 11:03:38 +100048
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +020049/*
50 * Command types
51 *
52 * Usage is a bit tricky as some bits are used as flags and some are not.
53 *
54 * Rules:
55 * VIRTIO_BLK_T_OUT may be combined with VIRTIO_BLK_T_SCSI_CMD or
56 * VIRTIO_BLK_T_BARRIER. VIRTIO_BLK_T_FLUSH is a command of its own
57 * and may not be combined with any of the other flags.
58 */
59
Rusty Russelle467cde2007-10-22 11:03:38 +100060/* These two define direction. */
61#define VIRTIO_BLK_T_IN 0
62#define VIRTIO_BLK_T_OUT 1
63
64/* This bit says it's a scsi command, not an actual read or write. */
65#define VIRTIO_BLK_T_SCSI_CMD 2
66
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +020067/* Cache flush command */
68#define VIRTIO_BLK_T_FLUSH 4
69
Rusty Russelle467cde2007-10-22 11:03:38 +100070/* Barrier before this op. */
71#define VIRTIO_BLK_T_BARRIER 0x80000000
72
73/* This is the first element of the read scatter-gather list. */
Rusty Russell1842f232009-07-30 16:03:46 -060074struct virtio_blk_outhdr {
Rusty Russelle467cde2007-10-22 11:03:38 +100075 /* VIRTIO_BLK_T* */
76 __u32 type;
77 /* io priority. */
78 __u32 ioprio;
79 /* Sector (ie. 512 byte offset) */
80 __u64 sector;
Rusty Russelle467cde2007-10-22 11:03:38 +100081};
82
Hannes Reinecke1cde26f2009-05-18 14:41:30 +020083struct virtio_scsi_inhdr {
84 __u32 errors;
85 __u32 data_len;
86 __u32 sense_len;
87 __u32 residual;
88};
89
Rusty Russellcb38fa22008-05-02 21:50:45 -050090/* And this is the final byte of the write scatter-gather list. */
Rusty Russelle467cde2007-10-22 11:03:38 +100091#define VIRTIO_BLK_S_OK 0
92#define VIRTIO_BLK_S_IOERR 1
93#define VIRTIO_BLK_S_UNSUPP 2
Rusty Russelle467cde2007-10-22 11:03:38 +100094#endif /* _LINUX_VIRTIO_BLK_H */