11e17c2c1SAlexander Graf /* 21e17c2c1SAlexander Graf * Virtio driver bits 31e17c2c1SAlexander Graf * 41e17c2c1SAlexander Graf * Copyright (c) 2013 Alexander Graf <agraf@suse.de> 51e17c2c1SAlexander Graf * 61e17c2c1SAlexander Graf * This work is licensed under the terms of the GNU GPL, version 2 or (at 71e17c2c1SAlexander Graf * your option) any later version. See the COPYING file in the top-level 81e17c2c1SAlexander Graf * directory. 91e17c2c1SAlexander Graf */ 101e17c2c1SAlexander Graf 111e17c2c1SAlexander Graf #ifndef VIRTIO_H 121e17c2c1SAlexander Graf #define VIRTIO_H 131e17c2c1SAlexander Graf 141e17c2c1SAlexander Graf #include "s390-ccw.h" 151e17c2c1SAlexander Graf 161e17c2c1SAlexander Graf /* Status byte for guest to report progress, and synchronize features. */ 171e17c2c1SAlexander Graf /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */ 181e17c2c1SAlexander Graf #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1 191e17c2c1SAlexander Graf /* We have found a driver for the device. */ 201e17c2c1SAlexander Graf #define VIRTIO_CONFIG_S_DRIVER 2 211e17c2c1SAlexander Graf /* Driver has used its parts of the config, and is happy */ 221e17c2c1SAlexander Graf #define VIRTIO_CONFIG_S_DRIVER_OK 4 231e17c2c1SAlexander Graf /* We've given up on this device. */ 241e17c2c1SAlexander Graf #define VIRTIO_CONFIG_S_FAILED 0x80 251e17c2c1SAlexander Graf 261e17c2c1SAlexander Graf enum virtio_dev_type { 271e17c2c1SAlexander Graf VIRTIO_ID_NET = 1, 281e17c2c1SAlexander Graf VIRTIO_ID_BLOCK = 2, 291e17c2c1SAlexander Graf VIRTIO_ID_CONSOLE = 3, 301e17c2c1SAlexander Graf VIRTIO_ID_BALLOON = 5, 311e17c2c1SAlexander Graf }; 321e17c2c1SAlexander Graf 331e17c2c1SAlexander Graf struct virtio_dev_header { 341e17c2c1SAlexander Graf enum virtio_dev_type type : 8; 351e17c2c1SAlexander Graf u8 num_vq; 361e17c2c1SAlexander Graf u8 feature_len; 371e17c2c1SAlexander Graf u8 config_len; 381e17c2c1SAlexander Graf u8 status; 391e17c2c1SAlexander Graf u8 vqconfig[]; 401e17c2c1SAlexander Graf } __attribute__((packed)); 411e17c2c1SAlexander Graf 421e17c2c1SAlexander Graf struct virtio_vqconfig { 431e17c2c1SAlexander Graf u64 token; 441e17c2c1SAlexander Graf u64 address; 451e17c2c1SAlexander Graf u16 num; 461e17c2c1SAlexander Graf u8 pad[6]; 471e17c2c1SAlexander Graf } __attribute__((packed)); 481e17c2c1SAlexander Graf 491e17c2c1SAlexander Graf struct vq_info_block { 501e17c2c1SAlexander Graf u64 queue; 511e17c2c1SAlexander Graf u32 align; 521e17c2c1SAlexander Graf u16 index; 531e17c2c1SAlexander Graf u16 num; 541e17c2c1SAlexander Graf } __attribute__((packed)); 551e17c2c1SAlexander Graf 56abbbe3deSCornelia Huck struct vq_config_block { 57abbbe3deSCornelia Huck u16 index; 58abbbe3deSCornelia Huck u16 num; 59abbbe3deSCornelia Huck } __attribute__((packed)); 60abbbe3deSCornelia Huck 611e17c2c1SAlexander Graf struct virtio_dev { 621e17c2c1SAlexander Graf struct virtio_dev_header *header; 631e17c2c1SAlexander Graf struct virtio_vqconfig *vqconfig; 641e17c2c1SAlexander Graf char *host_features; 651e17c2c1SAlexander Graf char *guest_features; 661e17c2c1SAlexander Graf char *config; 671e17c2c1SAlexander Graf }; 681e17c2c1SAlexander Graf 691e17c2c1SAlexander Graf #define KVM_S390_VIRTIO_RING_ALIGN 4096 701e17c2c1SAlexander Graf 711e17c2c1SAlexander Graf #define VRING_USED_F_NO_NOTIFY 1 721e17c2c1SAlexander Graf 731e17c2c1SAlexander Graf /* This marks a buffer as continuing via the next field. */ 741e17c2c1SAlexander Graf #define VRING_DESC_F_NEXT 1 751e17c2c1SAlexander Graf /* This marks a buffer as write-only (otherwise read-only). */ 761e17c2c1SAlexander Graf #define VRING_DESC_F_WRITE 2 771e17c2c1SAlexander Graf /* This means the buffer contains a list of buffer descriptors. */ 781e17c2c1SAlexander Graf #define VRING_DESC_F_INDIRECT 4 791e17c2c1SAlexander Graf 801e17c2c1SAlexander Graf /* Internal flag to mark follow-up segments as such */ 811e17c2c1SAlexander Graf #define VRING_HIDDEN_IS_CHAIN 256 821e17c2c1SAlexander Graf 831e17c2c1SAlexander Graf /* Virtio ring descriptors: 16 bytes. These can chain together via "next". */ 841e17c2c1SAlexander Graf struct vring_desc { 851e17c2c1SAlexander Graf /* Address (guest-physical). */ 861e17c2c1SAlexander Graf u64 addr; 871e17c2c1SAlexander Graf /* Length. */ 881e17c2c1SAlexander Graf u32 len; 891e17c2c1SAlexander Graf /* The flags as indicated above. */ 901e17c2c1SAlexander Graf u16 flags; 911e17c2c1SAlexander Graf /* We chain unused descriptors via this, too */ 921e17c2c1SAlexander Graf u16 next; 931e17c2c1SAlexander Graf } __attribute__((packed)); 941e17c2c1SAlexander Graf 951e17c2c1SAlexander Graf struct vring_avail { 961e17c2c1SAlexander Graf u16 flags; 971e17c2c1SAlexander Graf u16 idx; 981e17c2c1SAlexander Graf u16 ring[]; 991e17c2c1SAlexander Graf } __attribute__((packed)); 1001e17c2c1SAlexander Graf 1011e17c2c1SAlexander Graf /* u32 is used here for ids for padding reasons. */ 1021e17c2c1SAlexander Graf struct vring_used_elem { 1031e17c2c1SAlexander Graf /* Index of start of used descriptor chain. */ 1041e17c2c1SAlexander Graf u32 id; 1051e17c2c1SAlexander Graf /* Total length of the descriptor chain which was used (written to) */ 1061e17c2c1SAlexander Graf u32 len; 1071e17c2c1SAlexander Graf } __attribute__((packed)); 1081e17c2c1SAlexander Graf 1091e17c2c1SAlexander Graf struct vring_used { 1101e17c2c1SAlexander Graf u16 flags; 1111e17c2c1SAlexander Graf u16 idx; 1121e17c2c1SAlexander Graf struct vring_used_elem ring[]; 1131e17c2c1SAlexander Graf } __attribute__((packed)); 1141e17c2c1SAlexander Graf 1151e17c2c1SAlexander Graf struct vring { 1161e17c2c1SAlexander Graf unsigned int num; 1171e17c2c1SAlexander Graf int next_idx; 118441ea695SCornelia Huck int used_idx; 1191e17c2c1SAlexander Graf struct vring_desc *desc; 1201e17c2c1SAlexander Graf struct vring_avail *avail; 1211e17c2c1SAlexander Graf struct vring_used *used; 1221e17c2c1SAlexander Graf struct subchannel_id schid; 1231e17c2c1SAlexander Graf }; 1241e17c2c1SAlexander Graf 1251e17c2c1SAlexander Graf 1261e17c2c1SAlexander Graf /*********************************************** 1271e17c2c1SAlexander Graf * Virtio block * 1281e17c2c1SAlexander Graf ***********************************************/ 1291e17c2c1SAlexander Graf 1301e17c2c1SAlexander Graf /* 1311e17c2c1SAlexander Graf * Command types 1321e17c2c1SAlexander Graf * 1331e17c2c1SAlexander Graf * Usage is a bit tricky as some bits are used as flags and some are not. 1341e17c2c1SAlexander Graf * 1351e17c2c1SAlexander Graf * Rules: 1361e17c2c1SAlexander Graf * VIRTIO_BLK_T_OUT may be combined with VIRTIO_BLK_T_SCSI_CMD or 1371e17c2c1SAlexander Graf * VIRTIO_BLK_T_BARRIER. VIRTIO_BLK_T_FLUSH is a command of its own 1381e17c2c1SAlexander Graf * and may not be combined with any of the other flags. 1391e17c2c1SAlexander Graf */ 1401e17c2c1SAlexander Graf 1411e17c2c1SAlexander Graf /* These two define direction. */ 1421e17c2c1SAlexander Graf #define VIRTIO_BLK_T_IN 0 1431e17c2c1SAlexander Graf #define VIRTIO_BLK_T_OUT 1 1441e17c2c1SAlexander Graf 1451e17c2c1SAlexander Graf /* This bit says it's a scsi command, not an actual read or write. */ 1461e17c2c1SAlexander Graf #define VIRTIO_BLK_T_SCSI_CMD 2 1471e17c2c1SAlexander Graf 1481e17c2c1SAlexander Graf /* Cache flush command */ 1491e17c2c1SAlexander Graf #define VIRTIO_BLK_T_FLUSH 4 1501e17c2c1SAlexander Graf 1511e17c2c1SAlexander Graf /* Barrier before this op. */ 1521e17c2c1SAlexander Graf #define VIRTIO_BLK_T_BARRIER 0x80000000 1531e17c2c1SAlexander Graf 1541e17c2c1SAlexander Graf /* This is the first element of the read scatter-gather list. */ 1551e17c2c1SAlexander Graf struct virtio_blk_outhdr { 1561e17c2c1SAlexander Graf /* VIRTIO_BLK_T* */ 1571e17c2c1SAlexander Graf u32 type; 1581e17c2c1SAlexander Graf /* io priority. */ 1591e17c2c1SAlexander Graf u32 ioprio; 1601e17c2c1SAlexander Graf /* Sector (ie. 512 byte offset) */ 1611e17c2c1SAlexander Graf u64 sector; 1621e17c2c1SAlexander Graf }; 1631e17c2c1SAlexander Graf 16491a03f9bSEugene (jno) Dvurechenski typedef struct VirtioBlkConfig { 16591a03f9bSEugene (jno) Dvurechenski u64 capacity; /* in 512-byte sectors */ 16691a03f9bSEugene (jno) Dvurechenski u32 size_max; /* max segment size (if VIRTIO_BLK_F_SIZE_MAX) */ 16791a03f9bSEugene (jno) Dvurechenski u32 seg_max; /* max number of segments (if VIRTIO_BLK_F_SEG_MAX) */ 16891a03f9bSEugene (jno) Dvurechenski 16991a03f9bSEugene (jno) Dvurechenski struct virtio_blk_geometry { 17091a03f9bSEugene (jno) Dvurechenski u16 cylinders; 17191a03f9bSEugene (jno) Dvurechenski u8 heads; 17291a03f9bSEugene (jno) Dvurechenski u8 sectors; 17391a03f9bSEugene (jno) Dvurechenski } geometry; /* (if VIRTIO_BLK_F_GEOMETRY) */ 17491a03f9bSEugene (jno) Dvurechenski 17591a03f9bSEugene (jno) Dvurechenski u32 blk_size; /* block size of device (if VIRTIO_BLK_F_BLK_SIZE) */ 17691a03f9bSEugene (jno) Dvurechenski 17791a03f9bSEugene (jno) Dvurechenski /* the next 4 entries are guarded by VIRTIO_BLK_F_TOPOLOGY */ 17891a03f9bSEugene (jno) Dvurechenski u8 physical_block_exp; /* exponent for physical block per logical block */ 17991a03f9bSEugene (jno) Dvurechenski u8 alignment_offset; /* alignment offset in logical blocks */ 18091a03f9bSEugene (jno) Dvurechenski u16 min_io_size; /* min I/O size without performance penalty 18191a03f9bSEugene (jno) Dvurechenski in logical blocks */ 18291a03f9bSEugene (jno) Dvurechenski u32 opt_io_size; /* optimal sustained I/O size in logical blocks */ 18391a03f9bSEugene (jno) Dvurechenski 18491a03f9bSEugene (jno) Dvurechenski u8 wce; /* writeback mode (if VIRTIO_BLK_F_CONFIG_WCE) */ 18591a03f9bSEugene (jno) Dvurechenski } __attribute__((packed)) VirtioBlkConfig; 18691a03f9bSEugene (jno) Dvurechenski 18791a03f9bSEugene (jno) Dvurechenski bool virtio_guessed_disk_nature(void); 18891a03f9bSEugene (jno) Dvurechenski void virtio_assume_scsi(void); 18991a03f9bSEugene (jno) Dvurechenski void virtio_assume_eckd(void); 19091a03f9bSEugene (jno) Dvurechenski 19191a03f9bSEugene (jno) Dvurechenski extern bool virtio_disk_is_scsi(void); 19291a03f9bSEugene (jno) Dvurechenski extern bool virtio_disk_is_eckd(void); 19391a03f9bSEugene (jno) Dvurechenski extern bool virtio_ipl_disk_is_valid(void); 19491a03f9bSEugene (jno) Dvurechenski extern int virtio_get_block_size(void); 19591a03f9bSEugene (jno) Dvurechenski extern uint8_t virtio_get_heads(void); 19691a03f9bSEugene (jno) Dvurechenski extern uint8_t virtio_get_sectors(void); 197*f04db28bSEugene (jno) Dvurechenski extern uint64_t virtio_get_blocks(void); 19891a03f9bSEugene (jno) Dvurechenski extern int virtio_read_many(ulong sector, void *load_addr, int sec_num); 19991a03f9bSEugene (jno) Dvurechenski 20091a03f9bSEugene (jno) Dvurechenski #define VIRTIO_SECTOR_SIZE 512 20191a03f9bSEugene (jno) Dvurechenski 20291a03f9bSEugene (jno) Dvurechenski static inline ulong virtio_eckd_sector_adjust(ulong sector) 20391a03f9bSEugene (jno) Dvurechenski { 20491a03f9bSEugene (jno) Dvurechenski return sector * (virtio_get_block_size() / VIRTIO_SECTOR_SIZE); 20591a03f9bSEugene (jno) Dvurechenski } 20691a03f9bSEugene (jno) Dvurechenski 20791a03f9bSEugene (jno) Dvurechenski static inline ulong virtio_sector_adjust(ulong sector) 20891a03f9bSEugene (jno) Dvurechenski { 20991a03f9bSEugene (jno) Dvurechenski return virtio_disk_is_eckd() ? virtio_eckd_sector_adjust(sector) : sector; 21091a03f9bSEugene (jno) Dvurechenski } 21191a03f9bSEugene (jno) Dvurechenski 2121e17c2c1SAlexander Graf #endif /* VIRTIO_H */ 213