virtio_blk.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. #ifndef _LINUX_VIRTIO_BLK_H
  2. #define _LINUX_VIRTIO_BLK_H
  3. /* This header is BSD licensed so anyone can use the definitions to implement
  4. * compatible drivers/servers.
  5. *
  6. * Redistribution and use in source and binary forms, with or without
  7. * modification, are permitted provided that the following conditions
  8. * are met:
  9. * 1. Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. * 2. Redistributions in binary form must reproduce the above copyright
  12. * notice, this list of conditions and the following disclaimer in the
  13. * documentation and/or other materials provided with the distribution.
  14. * 3. Neither the name of IBM nor the names of its contributors
  15. * may be used to endorse or promote products derived from this software
  16. * without specific prior written permission.
  17. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
  18. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20. * ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
  21. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27. * SUCH DAMAGE. */
  28. #include <linux/types.h>
  29. #include <linux/virtio_ids.h>
  30. #include <linux/virtio_config.h>
  31. #include <linux/virtio_types.h>
  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. #define VIRTIO_BLK_F_DISCARD 13 /* DISCARD is supported */
  41. #define VIRTIO_BLK_F_WRITE_ZEROES 14 /* WRITE ZEROES is supported */
  42. #define VIRTIO_BLK_F_SECURE_ERASE 16 /* Secure Erase is supported */
  43. #define VIRTIO_BLK_F_ZONED 17 /* Zoned block device */
  44. /* Legacy feature bits */
  45. #ifndef VIRTIO_BLK_NO_LEGACY
  46. #define VIRTIO_BLK_F_BARRIER 0 /* Does host support barriers? */
  47. #define VIRTIO_BLK_F_SCSI 7 /* Supports scsi command passthru */
  48. #define VIRTIO_BLK_F_FLUSH 9 /* Flush command supported */
  49. #define VIRTIO_BLK_F_CONFIG_WCE 11 /* Writeback mode available in config */
  50. /* Old (deprecated) name for VIRTIO_BLK_F_FLUSH. */
  51. #define VIRTIO_BLK_F_WCE VIRTIO_BLK_F_FLUSH
  52. #endif /* !VIRTIO_BLK_NO_LEGACY */
  53. #define VIRTIO_BLK_ID_BYTES 20 /* ID string length */
  54. struct virtio_blk_config {
  55. /* The capacity (in 512-byte sectors). */
  56. __virtio64 capacity;
  57. /* The maximum segment size (if VIRTIO_BLK_F_SIZE_MAX) */
  58. __virtio32 size_max;
  59. /* The maximum number of segments (if VIRTIO_BLK_F_SEG_MAX) */
  60. __virtio32 seg_max;
  61. /* geometry of the device (if VIRTIO_BLK_F_GEOMETRY) */
  62. struct virtio_blk_geometry {
  63. __virtio16 cylinders;
  64. __u8 heads;
  65. __u8 sectors;
  66. } geometry;
  67. /* block size of device (if VIRTIO_BLK_F_BLK_SIZE) */
  68. __virtio32 blk_size;
  69. /* the next 4 entries are guarded by VIRTIO_BLK_F_TOPOLOGY */
  70. /* exponent for physical block per logical block. */
  71. __u8 physical_block_exp;
  72. /* alignment offset in logical blocks. */
  73. __u8 alignment_offset;
  74. /* minimum I/O size without performance penalty in logical blocks. */
  75. __virtio16 min_io_size;
  76. /* optimal sustained I/O size in logical blocks. */
  77. __virtio32 opt_io_size;
  78. /* writeback mode (if VIRTIO_BLK_F_CONFIG_WCE) */
  79. __u8 wce;
  80. __u8 unused;
  81. /* number of vqs, only available when VIRTIO_BLK_F_MQ is set */
  82. __virtio16 num_queues;
  83. /* the next 3 entries are guarded by VIRTIO_BLK_F_DISCARD */
  84. /*
  85. * The maximum discard sectors (in 512-byte sectors) for
  86. * one segment.
  87. */
  88. __virtio32 max_discard_sectors;
  89. /*
  90. * The maximum number of discard segments in a
  91. * discard command.
  92. */
  93. __virtio32 max_discard_seg;
  94. /* Discard commands must be aligned to this number of sectors. */
  95. __virtio32 discard_sector_alignment;
  96. /* the next 3 entries are guarded by VIRTIO_BLK_F_WRITE_ZEROES */
  97. /*
  98. * The maximum number of write zeroes sectors (in 512-byte sectors) in
  99. * one segment.
  100. */
  101. __virtio32 max_write_zeroes_sectors;
  102. /*
  103. * The maximum number of segments in a write zeroes
  104. * command.
  105. */
  106. __virtio32 max_write_zeroes_seg;
  107. /*
  108. * Set if a VIRTIO_BLK_T_WRITE_ZEROES request may result in the
  109. * deallocation of one or more of the sectors.
  110. */
  111. __u8 write_zeroes_may_unmap;
  112. __u8 unused1[3];
  113. /* the next 3 entries are guarded by VIRTIO_BLK_F_SECURE_ERASE */
  114. /*
  115. * The maximum secure erase sectors (in 512-byte sectors) for
  116. * one segment.
  117. */
  118. __virtio32 max_secure_erase_sectors;
  119. /*
  120. * The maximum number of secure erase segments in a
  121. * secure erase command.
  122. */
  123. __virtio32 max_secure_erase_seg;
  124. /* Secure erase commands must be aligned to this number of sectors. */
  125. __virtio32 secure_erase_sector_alignment;
  126. /* Zoned block device characteristics (if VIRTIO_BLK_F_ZONED) */
  127. struct virtio_blk_zoned_characteristics {
  128. __virtio32 zone_sectors;
  129. __virtio32 max_open_zones;
  130. __virtio32 max_active_zones;
  131. __virtio32 max_append_sectors;
  132. __virtio32 write_granularity;
  133. __u8 model;
  134. __u8 unused2[3];
  135. } zoned;
  136. } __attribute__((packed));
  137. /*
  138. * Command types
  139. *
  140. * Usage is a bit tricky as some bits are used as flags and some are not.
  141. *
  142. * Rules:
  143. * VIRTIO_BLK_T_OUT may be combined with VIRTIO_BLK_T_SCSI_CMD or
  144. * VIRTIO_BLK_T_BARRIER. VIRTIO_BLK_T_FLUSH is a command of its own
  145. * and may not be combined with any of the other flags.
  146. */
  147. /* These two define direction. */
  148. #define VIRTIO_BLK_T_IN 0
  149. #define VIRTIO_BLK_T_OUT 1
  150. #ifndef VIRTIO_BLK_NO_LEGACY
  151. /* This bit says it's a scsi command, not an actual read or write. */
  152. #define VIRTIO_BLK_T_SCSI_CMD 2
  153. #endif /* VIRTIO_BLK_NO_LEGACY */
  154. /* Cache flush command */
  155. #define VIRTIO_BLK_T_FLUSH 4
  156. /* Get device ID command */
  157. #define VIRTIO_BLK_T_GET_ID 8
  158. /* Discard command */
  159. #define VIRTIO_BLK_T_DISCARD 11
  160. /* Write zeroes command */
  161. #define VIRTIO_BLK_T_WRITE_ZEROES 13
  162. /* Secure erase command */
  163. #define VIRTIO_BLK_T_SECURE_ERASE 14
  164. /* Zone append command */
  165. #define VIRTIO_BLK_T_ZONE_APPEND 15
  166. /* Report zones command */
  167. #define VIRTIO_BLK_T_ZONE_REPORT 16
  168. /* Open zone command */
  169. #define VIRTIO_BLK_T_ZONE_OPEN 18
  170. /* Close zone command */
  171. #define VIRTIO_BLK_T_ZONE_CLOSE 20
  172. /* Finish zone command */
  173. #define VIRTIO_BLK_T_ZONE_FINISH 22
  174. /* Reset zone command */
  175. #define VIRTIO_BLK_T_ZONE_RESET 24
  176. /* Reset All zones command */
  177. #define VIRTIO_BLK_T_ZONE_RESET_ALL 26
  178. #ifndef VIRTIO_BLK_NO_LEGACY
  179. /* Barrier before this op. */
  180. #define VIRTIO_BLK_T_BARRIER 0x80000000
  181. #endif /* !VIRTIO_BLK_NO_LEGACY */
  182. /*
  183. * This comes first in the read scatter-gather list.
  184. * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated,
  185. * this is the first element of the read scatter-gather list.
  186. */
  187. struct virtio_blk_outhdr {
  188. /* VIRTIO_BLK_T* */
  189. __virtio32 type;
  190. /* io priority. */
  191. __virtio32 ioprio;
  192. /* Sector (ie. 512 byte offset) */
  193. __virtio64 sector;
  194. };
  195. /*
  196. * Supported zoned device models.
  197. */
  198. /* Regular block device */
  199. #define VIRTIO_BLK_Z_NONE 0
  200. /* Host-managed zoned device */
  201. #define VIRTIO_BLK_Z_HM 1
  202. /* Host-aware zoned device */
  203. #define VIRTIO_BLK_Z_HA 2
  204. /*
  205. * Zone descriptor. A part of VIRTIO_BLK_T_ZONE_REPORT command reply.
  206. */
  207. struct virtio_blk_zone_descriptor {
  208. /* Zone capacity */
  209. __virtio64 z_cap;
  210. /* The starting sector of the zone */
  211. __virtio64 z_start;
  212. /* Zone write pointer position in sectors */
  213. __virtio64 z_wp;
  214. /* Zone type */
  215. __u8 z_type;
  216. /* Zone state */
  217. __u8 z_state;
  218. __u8 reserved[38];
  219. };
  220. struct virtio_blk_zone_report {
  221. __virtio64 nr_zones;
  222. __u8 reserved[56];
  223. struct virtio_blk_zone_descriptor zones[];
  224. };
  225. /*
  226. * Supported zone types.
  227. */
  228. /* Conventional zone */
  229. #define VIRTIO_BLK_ZT_CONV 1
  230. /* Sequential Write Required zone */
  231. #define VIRTIO_BLK_ZT_SWR 2
  232. /* Sequential Write Preferred zone */
  233. #define VIRTIO_BLK_ZT_SWP 3
  234. /*
  235. * Zone states that are available for zones of all types.
  236. */
  237. /* Not a write pointer (conventional zones only) */
  238. #define VIRTIO_BLK_ZS_NOT_WP 0
  239. /* Empty */
  240. #define VIRTIO_BLK_ZS_EMPTY 1
  241. /* Implicitly Open */
  242. #define VIRTIO_BLK_ZS_IOPEN 2
  243. /* Explicitly Open */
  244. #define VIRTIO_BLK_ZS_EOPEN 3
  245. /* Closed */
  246. #define VIRTIO_BLK_ZS_CLOSED 4
  247. /* Read-Only */
  248. #define VIRTIO_BLK_ZS_RDONLY 13
  249. /* Full */
  250. #define VIRTIO_BLK_ZS_FULL 14
  251. /* Offline */
  252. #define VIRTIO_BLK_ZS_OFFLINE 15
  253. /* Unmap this range (only valid for write zeroes command) */
  254. #define VIRTIO_BLK_WRITE_ZEROES_FLAG_UNMAP 0x00000001
  255. /* Discard/write zeroes range for each request. */
  256. struct virtio_blk_discard_write_zeroes {
  257. /* discard/write zeroes start sector */
  258. __le64 sector;
  259. /* number of discard/write zeroes sectors */
  260. __le32 num_sectors;
  261. /* flags for this range */
  262. __le32 flags;
  263. };
  264. #ifndef VIRTIO_BLK_NO_LEGACY
  265. struct virtio_scsi_inhdr {
  266. __virtio32 errors;
  267. __virtio32 data_len;
  268. __virtio32 sense_len;
  269. __virtio32 residual;
  270. };
  271. #endif /* !VIRTIO_BLK_NO_LEGACY */
  272. /* And this is the final byte of the write scatter-gather list. */
  273. #define VIRTIO_BLK_S_OK 0
  274. #define VIRTIO_BLK_S_IOERR 1
  275. #define VIRTIO_BLK_S_UNSUPP 2
  276. /* Error codes that are specific to zoned block devices */
  277. #define VIRTIO_BLK_S_ZONE_INVALID_CMD 3
  278. #define VIRTIO_BLK_S_ZONE_UNALIGNED_WP 4
  279. #define VIRTIO_BLK_S_ZONE_OPEN_RESOURCE 5
  280. #define VIRTIO_BLK_S_ZONE_ACTIVE_RESOURCE 6
  281. #endif /* _LINUX_VIRTIO_BLK_H */