virtio_blk.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  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. /* Feature bits */
  32. #define VIRTIO_BLK_F_BARRIER 0 /* Does host support barriers? */
  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_SCSI 7 /* Supports scsi command passthru */
  39. #define VIRTIO_BLK_F_FLUSH 9 /* Cache flush command support */
  40. #define VIRTIO_BLK_F_TOPOLOGY 10 /* Topology information is available */
  41. #define VIRTIO_BLK_ID_BYTES 20 /* ID string length */
  42. struct virtio_blk_config {
  43. /* The capacity (in 512-byte sectors). */
  44. __u64 capacity;
  45. /* The maximum segment size (if VIRTIO_BLK_F_SIZE_MAX) */
  46. __u32 size_max;
  47. /* The maximum number of segments (if VIRTIO_BLK_F_SEG_MAX) */
  48. __u32 seg_max;
  49. /* geometry the device (if VIRTIO_BLK_F_GEOMETRY) */
  50. struct virtio_blk_geometry {
  51. __u16 cylinders;
  52. __u8 heads;
  53. __u8 sectors;
  54. } geometry;
  55. /* block size of device (if VIRTIO_BLK_F_BLK_SIZE) */
  56. __u32 blk_size;
  57. /* the next 4 entries are guarded by VIRTIO_BLK_F_TOPOLOGY */
  58. /* exponent for physical block per logical block. */
  59. __u8 physical_block_exp;
  60. /* alignment offset in logical blocks. */
  61. __u8 alignment_offset;
  62. /* minimum I/O size without performance penalty in logical blocks. */
  63. __u16 min_io_size;
  64. /* optimal sustained I/O size in logical blocks. */
  65. __u32 opt_io_size;
  66. } __attribute__((packed));
  67. /*
  68. * Command types
  69. *
  70. * Usage is a bit tricky as some bits are used as flags and some are not.
  71. *
  72. * Rules:
  73. * VIRTIO_BLK_T_OUT may be combined with VIRTIO_BLK_T_SCSI_CMD or
  74. * VIRTIO_BLK_T_BARRIER. VIRTIO_BLK_T_FLUSH is a command of its own
  75. * and may not be combined with any of the other flags.
  76. */
  77. /* These two define direction. */
  78. #define VIRTIO_BLK_T_IN 0
  79. #define VIRTIO_BLK_T_OUT 1
  80. /* This bit says it's a scsi command, not an actual read or write. */
  81. #define VIRTIO_BLK_T_SCSI_CMD 2
  82. /* Cache flush command */
  83. #define VIRTIO_BLK_T_FLUSH 4
  84. /* Get device ID command */
  85. #define VIRTIO_BLK_T_GET_ID 8
  86. /* Barrier before this op. */
  87. #define VIRTIO_BLK_T_BARRIER 0x80000000
  88. /* This is the first element of the read scatter-gather list. */
  89. struct virtio_blk_outhdr {
  90. /* VIRTIO_BLK_T* */
  91. __u32 type;
  92. /* io priority. */
  93. __u32 ioprio;
  94. /* Sector (ie. 512 byte offset) */
  95. __u64 sector;
  96. };
  97. struct virtio_scsi_inhdr {
  98. __u32 errors;
  99. __u32 data_len;
  100. __u32 sense_len;
  101. __u32 residual;
  102. };
  103. /* And this is the final byte of the write scatter-gather list. */
  104. #define VIRTIO_BLK_S_OK 0
  105. #define VIRTIO_BLK_S_IOERR 1
  106. #define VIRTIO_BLK_S_UNSUPP 2
  107. #endif /* _LINUX_VIRTIO_BLK_H */