blob: 15cb666581d7cbdb42cd7d39f4d309ac59399fb0 [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>
Rusty Russelle467cde2007-10-22 11:03:38 +10006#include <linux/virtio_config.h>
7
Rusty Russelle467cde2007-10-22 11:03:38 +10008/* Feature bits */
Rusty Russella586d4f2008-02-04 23:49:56 -05009#define VIRTIO_BLK_F_BARRIER 0 /* Does host support barriers? */
10#define VIRTIO_BLK_F_SIZE_MAX 1 /* Indicates maximum segment size */
11#define VIRTIO_BLK_F_SEG_MAX 2 /* Indicates maximum # of segments */
Ryan Harper48e40432008-04-16 13:56:37 -050012#define VIRTIO_BLK_F_GEOMETRY 4 /* Legacy geometry available */
Christian Borntraeger3ef53602008-05-16 11:17:03 +020013#define VIRTIO_BLK_F_RO 5 /* Disk is read-only */
Christian Borntraeger066f4d82008-05-29 11:08:26 +020014#define VIRTIO_BLK_F_BLK_SIZE 6 /* Block size of disk is available*/
Hannes Reinecke1cde26f2009-05-18 14:41:30 +020015#define VIRTIO_BLK_F_SCSI 7 /* Supports scsi command passthru */
john cooper1d589bb2009-06-09 14:41:40 +020016#define VIRTIO_BLK_F_IDENTIFY 8 /* ATA IDENTIFY supported */
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +020017#define VIRTIO_BLK_F_FLUSH 9 /* Cache flush command support */
john cooper1d589bb2009-06-09 14:41:40 +020018
19#define VIRTIO_BLK_ID_BYTES (sizeof(__u16[256])) /* IDENTIFY DATA */
Rusty Russelle467cde2007-10-22 11:03:38 +100020
Rusty Russell1842f232009-07-30 16:03:46 -060021struct virtio_blk_config {
Rusty Russella586d4f2008-02-04 23:49:56 -050022 /* The capacity (in 512-byte sectors). */
Christian Borntraeger7757f092008-05-29 11:10:01 +020023 __u64 capacity;
Rusty Russella586d4f2008-02-04 23:49:56 -050024 /* The maximum segment size (if VIRTIO_BLK_F_SIZE_MAX) */
Christian Borntraeger7757f092008-05-29 11:10:01 +020025 __u32 size_max;
Rusty Russella586d4f2008-02-04 23:49:56 -050026 /* The maximum number of segments (if VIRTIO_BLK_F_SEG_MAX) */
Christian Borntraeger7757f092008-05-29 11:10:01 +020027 __u32 seg_max;
Ryan Harper48e40432008-04-16 13:56:37 -050028 /* geometry the device (if VIRTIO_BLK_F_GEOMETRY) */
29 struct virtio_blk_geometry {
Christian Borntraeger7757f092008-05-29 11:10:01 +020030 __u16 cylinders;
Ryan Harper48e40432008-04-16 13:56:37 -050031 __u8 heads;
32 __u8 sectors;
33 } geometry;
Christian Borntraeger066f4d82008-05-29 11:08:26 +020034 /* block size of device (if VIRTIO_BLK_F_BLK_SIZE) */
35 __u32 blk_size;
john cooper1d589bb2009-06-09 14:41:40 +020036 __u8 identify[VIRTIO_BLK_ID_BYTES];
Rusty Russella586d4f2008-02-04 23:49:56 -050037} __attribute__((packed));
Rusty Russelle467cde2007-10-22 11:03:38 +100038
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +020039/*
40 * Command types
41 *
42 * Usage is a bit tricky as some bits are used as flags and some are not.
43 *
44 * Rules:
45 * VIRTIO_BLK_T_OUT may be combined with VIRTIO_BLK_T_SCSI_CMD or
46 * VIRTIO_BLK_T_BARRIER. VIRTIO_BLK_T_FLUSH is a command of its own
47 * and may not be combined with any of the other flags.
48 */
49
Rusty Russelle467cde2007-10-22 11:03:38 +100050/* These two define direction. */
51#define VIRTIO_BLK_T_IN 0
52#define VIRTIO_BLK_T_OUT 1
53
54/* This bit says it's a scsi command, not an actual read or write. */
55#define VIRTIO_BLK_T_SCSI_CMD 2
56
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +020057/* Cache flush command */
58#define VIRTIO_BLK_T_FLUSH 4
59
Rusty Russelle467cde2007-10-22 11:03:38 +100060/* Barrier before this op. */
61#define VIRTIO_BLK_T_BARRIER 0x80000000
62
63/* This is the first element of the read scatter-gather list. */
Rusty Russell1842f232009-07-30 16:03:46 -060064struct virtio_blk_outhdr {
Rusty Russelle467cde2007-10-22 11:03:38 +100065 /* VIRTIO_BLK_T* */
66 __u32 type;
67 /* io priority. */
68 __u32 ioprio;
69 /* Sector (ie. 512 byte offset) */
70 __u64 sector;
Rusty Russelle467cde2007-10-22 11:03:38 +100071};
72
Hannes Reinecke1cde26f2009-05-18 14:41:30 +020073struct virtio_scsi_inhdr {
74 __u32 errors;
75 __u32 data_len;
76 __u32 sense_len;
77 __u32 residual;
78};
79
Rusty Russellcb38fa22008-05-02 21:50:45 -050080/* And this is the final byte of the write scatter-gather list. */
Rusty Russelle467cde2007-10-22 11:03:38 +100081#define VIRTIO_BLK_S_OK 0
82#define VIRTIO_BLK_S_IOERR 1
83#define VIRTIO_BLK_S_UNSUPP 2
Rusty Russelle467cde2007-10-22 11:03:38 +100084#endif /* _LINUX_VIRTIO_BLK_H */