1*f4802209STuomas Tynkkynen /* SPDX-License-Identifier: BSD-3-Clause */ 2*f4802209STuomas Tynkkynen /* 3*f4802209STuomas Tynkkynen * Copyright (C) 2018, Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> 4*f4802209STuomas Tynkkynen * Copyright (C) 2018, Bin Meng <bmeng.cn@gmail.com> 5*f4802209STuomas Tynkkynen * 6*f4802209STuomas Tynkkynen * From Linux kernel include/uapi/linux/virtio_blk.h 7*f4802209STuomas Tynkkynen */ 8*f4802209STuomas Tynkkynen 9*f4802209STuomas Tynkkynen #ifndef _LINUX_VIRTIO_BLK_H 10*f4802209STuomas Tynkkynen #define _LINUX_VIRTIO_BLK_H 11*f4802209STuomas Tynkkynen 12*f4802209STuomas Tynkkynen /* Feature bits */ 13*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_SIZE_MAX 1 /* Indicates maximum segment size */ 14*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_SEG_MAX 2 /* Indicates maximum # of segments */ 15*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_GEOMETRY 4 /* Legacy geometry available */ 16*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_RO 5 /* Disk is read-only */ 17*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_BLK_SIZE 6 /* Block size of disk is available */ 18*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_TOPOLOGY 10 /* Topology information is available */ 19*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_MQ 12 /* Support more than one vq */ 20*f4802209STuomas Tynkkynen 21*f4802209STuomas Tynkkynen /* Legacy feature bits */ 22*f4802209STuomas Tynkkynen #ifndef VIRTIO_BLK_NO_LEGACY 23*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_BARRIER 0 /* Does host support barriers? */ 24*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_SCSI 7 /* Supports scsi command passthru */ 25*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_FLUSH 9 /* Flush command supported */ 26*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_CONFIG_WCE 11 /* Writeback mode available in config */ 27*f4802209STuomas Tynkkynen #ifndef __KERNEL__ 28*f4802209STuomas Tynkkynen /* Old (deprecated) name for VIRTIO_BLK_F_FLUSH */ 29*f4802209STuomas Tynkkynen #define VIRTIO_BLK_F_WCE VIRTIO_BLK_F_FLUSH 30*f4802209STuomas Tynkkynen #endif 31*f4802209STuomas Tynkkynen #endif /* !VIRTIO_BLK_NO_LEGACY */ 32*f4802209STuomas Tynkkynen 33*f4802209STuomas Tynkkynen #define VIRTIO_BLK_ID_BYTES 20 /* ID string length */ 34*f4802209STuomas Tynkkynen 35*f4802209STuomas Tynkkynen struct __packed virtio_blk_config { 36*f4802209STuomas Tynkkynen /* The capacity (in 512-byte sectors) */ 37*f4802209STuomas Tynkkynen __u64 capacity; 38*f4802209STuomas Tynkkynen /* The maximum segment size (if VIRTIO_BLK_F_SIZE_MAX) */ 39*f4802209STuomas Tynkkynen __u32 size_max; 40*f4802209STuomas Tynkkynen /* The maximum number of segments (if VIRTIO_BLK_F_SEG_MAX) */ 41*f4802209STuomas Tynkkynen __u32 seg_max; 42*f4802209STuomas Tynkkynen /* geometry of the device (if VIRTIO_BLK_F_GEOMETRY) */ 43*f4802209STuomas Tynkkynen struct virtio_blk_geometry { 44*f4802209STuomas Tynkkynen __u16 cylinders; 45*f4802209STuomas Tynkkynen __u8 heads; 46*f4802209STuomas Tynkkynen __u8 sectors; 47*f4802209STuomas Tynkkynen } geometry; 48*f4802209STuomas Tynkkynen 49*f4802209STuomas Tynkkynen /* block size of device (if VIRTIO_BLK_F_BLK_SIZE) */ 50*f4802209STuomas Tynkkynen __u32 blk_size; 51*f4802209STuomas Tynkkynen 52*f4802209STuomas Tynkkynen /* the next 4 entries are guarded by VIRTIO_BLK_F_TOPOLOGY */ 53*f4802209STuomas Tynkkynen /* exponent for physical block per logical block */ 54*f4802209STuomas Tynkkynen __u8 physical_block_exp; 55*f4802209STuomas Tynkkynen /* alignment offset in logical blocks */ 56*f4802209STuomas Tynkkynen __u8 alignment_offset; 57*f4802209STuomas Tynkkynen /* minimum I/O size without performance penalty in logical blocks */ 58*f4802209STuomas Tynkkynen __u16 min_io_size; 59*f4802209STuomas Tynkkynen /* optimal sustained I/O size in logical blocks */ 60*f4802209STuomas Tynkkynen __u32 opt_io_size; 61*f4802209STuomas Tynkkynen 62*f4802209STuomas Tynkkynen /* writeback mode (if VIRTIO_BLK_F_CONFIG_WCE) */ 63*f4802209STuomas Tynkkynen __u8 wce; 64*f4802209STuomas Tynkkynen __u8 unused; 65*f4802209STuomas Tynkkynen 66*f4802209STuomas Tynkkynen /* number of vqs, only available when VIRTIO_BLK_F_MQ is set */ 67*f4802209STuomas Tynkkynen __u16 num_queues; 68*f4802209STuomas Tynkkynen }; 69*f4802209STuomas Tynkkynen 70*f4802209STuomas Tynkkynen /* 71*f4802209STuomas Tynkkynen * Command types 72*f4802209STuomas Tynkkynen * 73*f4802209STuomas Tynkkynen * Usage is a bit tricky as some bits are used as flags and some are not. 74*f4802209STuomas Tynkkynen * 75*f4802209STuomas Tynkkynen * Rules: 76*f4802209STuomas Tynkkynen * VIRTIO_BLK_T_OUT may be combined with VIRTIO_BLK_T_SCSI_CMD or 77*f4802209STuomas Tynkkynen * VIRTIO_BLK_T_BARRIER. VIRTIO_BLK_T_FLUSH is a command of its own 78*f4802209STuomas Tynkkynen * and may not be combined with any of the other flags. 79*f4802209STuomas Tynkkynen */ 80*f4802209STuomas Tynkkynen 81*f4802209STuomas Tynkkynen /* These two define direction */ 82*f4802209STuomas Tynkkynen #define VIRTIO_BLK_T_IN 0 83*f4802209STuomas Tynkkynen #define VIRTIO_BLK_T_OUT 1 84*f4802209STuomas Tynkkynen 85*f4802209STuomas Tynkkynen #ifndef VIRTIO_BLK_NO_LEGACY 86*f4802209STuomas Tynkkynen /* This bit says it's a scsi command, not an actual read or write */ 87*f4802209STuomas Tynkkynen #define VIRTIO_BLK_T_SCSI_CMD 2 88*f4802209STuomas Tynkkynen #endif /* VIRTIO_BLK_NO_LEGACY */ 89*f4802209STuomas Tynkkynen 90*f4802209STuomas Tynkkynen /* Cache flush command */ 91*f4802209STuomas Tynkkynen #define VIRTIO_BLK_T_FLUSH 4 92*f4802209STuomas Tynkkynen 93*f4802209STuomas Tynkkynen /* Get device ID command */ 94*f4802209STuomas Tynkkynen #define VIRTIO_BLK_T_GET_ID 8 95*f4802209STuomas Tynkkynen 96*f4802209STuomas Tynkkynen #ifndef VIRTIO_BLK_NO_LEGACY 97*f4802209STuomas Tynkkynen /* Barrier before this op */ 98*f4802209STuomas Tynkkynen #define VIRTIO_BLK_T_BARRIER 0x80000000 99*f4802209STuomas Tynkkynen #endif /* !VIRTIO_BLK_NO_LEGACY */ 100*f4802209STuomas Tynkkynen 101*f4802209STuomas Tynkkynen /* 102*f4802209STuomas Tynkkynen * This comes first in the read scatter-gather list. 103*f4802209STuomas Tynkkynen * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, 104*f4802209STuomas Tynkkynen * this is the first element of the read scatter-gather list. 105*f4802209STuomas Tynkkynen */ 106*f4802209STuomas Tynkkynen struct virtio_blk_outhdr { 107*f4802209STuomas Tynkkynen /* VIRTIO_BLK_T* */ 108*f4802209STuomas Tynkkynen __virtio32 type; 109*f4802209STuomas Tynkkynen /* io priority */ 110*f4802209STuomas Tynkkynen __virtio32 ioprio; 111*f4802209STuomas Tynkkynen /* Sector (ie. 512 byte offset) */ 112*f4802209STuomas Tynkkynen __virtio64 sector; 113*f4802209STuomas Tynkkynen }; 114*f4802209STuomas Tynkkynen 115*f4802209STuomas Tynkkynen #ifndef VIRTIO_BLK_NO_LEGACY 116*f4802209STuomas Tynkkynen struct virtio_scsi_inhdr { 117*f4802209STuomas Tynkkynen __virtio32 errors; 118*f4802209STuomas Tynkkynen __virtio32 data_len; 119*f4802209STuomas Tynkkynen __virtio32 sense_len; 120*f4802209STuomas Tynkkynen __virtio32 residual; 121*f4802209STuomas Tynkkynen }; 122*f4802209STuomas Tynkkynen #endif /* !VIRTIO_BLK_NO_LEGACY */ 123*f4802209STuomas Tynkkynen 124*f4802209STuomas Tynkkynen /* And this is the final byte of the write scatter-gather list */ 125*f4802209STuomas Tynkkynen #define VIRTIO_BLK_S_OK 0 126*f4802209STuomas Tynkkynen #define VIRTIO_BLK_S_IOERR 1 127*f4802209STuomas Tynkkynen #define VIRTIO_BLK_S_UNSUPP 2 128*f4802209STuomas Tynkkynen 129*f4802209STuomas Tynkkynen #endif /* _LINUX_VIRTIO_BLK_H */ 130