1 #ifndef QEMU_HW_SCSI_H 2 #define QEMU_HW_SCSI_H 3 4 #include "block/aio.h" 5 #include "hw/block/block.h" 6 #include "hw/qdev-core.h" 7 #include "scsi/utils.h" 8 #include "qemu/notify.h" 9 #include "qom/object.h" 10 11 #define MAX_SCSI_DEVS 255 12 13 typedef struct SCSIBus SCSIBus; 14 typedef struct SCSIBusInfo SCSIBusInfo; 15 typedef struct SCSIDevice SCSIDevice; 16 typedef struct SCSIRequest SCSIRequest; 17 typedef struct SCSIReqOps SCSIReqOps; 18 19 #define SCSI_SENSE_BUF_SIZE_OLD 96 20 #define SCSI_SENSE_BUF_SIZE 252 21 22 struct SCSIRequest { 23 SCSIBus *bus; 24 SCSIDevice *dev; 25 const SCSIReqOps *ops; 26 uint32_t refcount; 27 uint32_t tag; 28 uint32_t lun; 29 uint32_t status; 30 void *hba_private; 31 size_t resid; 32 SCSICommand cmd; 33 NotifierList cancel_notifiers; 34 35 /* Note: 36 * - fields before sense are initialized by scsi_req_alloc; 37 * - sense[] is uninitialized; 38 * - fields after sense are memset to 0 by scsi_req_alloc. 39 * */ 40 41 uint8_t sense[SCSI_SENSE_BUF_SIZE]; 42 uint32_t sense_len; 43 bool enqueued; 44 bool io_canceled; 45 bool retry; 46 bool dma_started; 47 BlockAIOCB *aiocb; 48 QEMUSGList *sg; 49 QTAILQ_ENTRY(SCSIRequest) next; 50 }; 51 52 #define TYPE_SCSI_DEVICE "scsi-device" 53 typedef struct SCSIDeviceClass SCSIDeviceClass; 54 #define SCSI_DEVICE(obj) \ 55 OBJECT_CHECK(SCSIDevice, (obj), TYPE_SCSI_DEVICE) 56 #define SCSI_DEVICE_CLASS(klass) \ 57 OBJECT_CLASS_CHECK(SCSIDeviceClass, (klass), TYPE_SCSI_DEVICE) 58 #define SCSI_DEVICE_GET_CLASS(obj) \ 59 OBJECT_GET_CLASS(SCSIDeviceClass, (obj), TYPE_SCSI_DEVICE) 60 61 struct SCSIDeviceClass { 62 DeviceClass parent_class; 63 void (*realize)(SCSIDevice *dev, Error **errp); 64 void (*unrealize)(SCSIDevice *dev); 65 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf, 66 void *hba_private); 67 SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun, 68 uint8_t *buf, void *hba_private); 69 void (*unit_attention_reported)(SCSIDevice *s); 70 }; 71 72 struct SCSIDevice 73 { 74 DeviceState qdev; 75 VMChangeStateEntry *vmsentry; 76 QEMUBH *bh; 77 uint32_t id; 78 BlockConf conf; 79 SCSISense unit_attention; 80 bool sense_is_ua; 81 uint8_t sense[SCSI_SENSE_BUF_SIZE]; 82 uint32_t sense_len; 83 QTAILQ_HEAD(, SCSIRequest) requests; 84 uint32_t channel; 85 uint32_t lun; 86 int blocksize; 87 int type; 88 uint64_t max_lba; 89 uint64_t wwn; 90 uint64_t port_wwn; 91 int scsi_version; 92 int default_scsi_version; 93 bool needs_vpd_bl_emulation; 94 bool hba_supports_iothread; 95 }; 96 97 extern const VMStateDescription vmstate_scsi_device; 98 99 #define VMSTATE_SCSI_DEVICE(_field, _state) { \ 100 .name = (stringify(_field)), \ 101 .size = sizeof(SCSIDevice), \ 102 .vmsd = &vmstate_scsi_device, \ 103 .flags = VMS_STRUCT, \ 104 .offset = vmstate_offset_value(_state, _field, SCSIDevice), \ 105 } 106 107 /* cdrom.c */ 108 int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track); 109 int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num); 110 111 /* scsi-bus.c */ 112 struct SCSIReqOps { 113 size_t size; 114 void (*free_req)(SCSIRequest *req); 115 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf); 116 void (*read_data)(SCSIRequest *req); 117 void (*write_data)(SCSIRequest *req); 118 uint8_t *(*get_buf)(SCSIRequest *req); 119 120 void (*save_request)(QEMUFile *f, SCSIRequest *req); 121 void (*load_request)(QEMUFile *f, SCSIRequest *req); 122 }; 123 124 struct SCSIBusInfo { 125 int tcq; 126 int max_channel, max_target, max_lun; 127 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf, 128 void *hba_private); 129 void (*transfer_data)(SCSIRequest *req, uint32_t arg); 130 void (*complete)(SCSIRequest *req, uint32_t arg, size_t resid); 131 void (*cancel)(SCSIRequest *req); 132 void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense); 133 QEMUSGList *(*get_sg_list)(SCSIRequest *req); 134 135 void (*save_request)(QEMUFile *f, SCSIRequest *req); 136 void *(*load_request)(QEMUFile *f, SCSIRequest *req); 137 void (*free_request)(SCSIBus *bus, void *priv); 138 }; 139 140 #define TYPE_SCSI_BUS "SCSI" 141 #define SCSI_BUS(obj) OBJECT_CHECK(SCSIBus, (obj), TYPE_SCSI_BUS) 142 143 struct SCSIBus { 144 BusState qbus; 145 int busnr; 146 147 SCSISense unit_attention; 148 const SCSIBusInfo *info; 149 }; 150 151 void scsi_bus_new(SCSIBus *bus, size_t bus_size, DeviceState *host, 152 const SCSIBusInfo *info, const char *bus_name); 153 154 static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d) 155 { 156 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus); 157 } 158 159 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk, 160 int unit, bool removable, int bootindex, 161 bool share_rw, 162 BlockdevOnError rerror, 163 BlockdevOnError werror, 164 const char *serial, Error **errp); 165 void scsi_bus_legacy_handle_cmdline(SCSIBus *bus); 166 void scsi_legacy_handle_cmdline(void); 167 168 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d, 169 uint32_t tag, uint32_t lun, void *hba_private); 170 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun, 171 uint8_t *buf, void *hba_private); 172 int32_t scsi_req_enqueue(SCSIRequest *req); 173 SCSIRequest *scsi_req_ref(SCSIRequest *req); 174 void scsi_req_unref(SCSIRequest *req); 175 176 int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf, 177 void *hba_private); 178 int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf); 179 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense); 180 void scsi_req_print(SCSIRequest *req); 181 void scsi_req_continue(SCSIRequest *req); 182 void scsi_req_data(SCSIRequest *req, int len); 183 void scsi_req_complete(SCSIRequest *req, int status); 184 uint8_t *scsi_req_get_buf(SCSIRequest *req); 185 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len); 186 void scsi_req_cancel_complete(SCSIRequest *req); 187 void scsi_req_cancel(SCSIRequest *req); 188 void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier); 189 void scsi_req_retry(SCSIRequest *req); 190 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense); 191 void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense); 192 void scsi_device_report_change(SCSIDevice *dev, SCSISense sense); 193 void scsi_device_unit_attention_reported(SCSIDevice *dev); 194 void scsi_generic_read_device_inquiry(SCSIDevice *dev); 195 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed); 196 int scsi_SG_IO_FROM_DEV(BlockBackend *blk, uint8_t *cmd, uint8_t cmd_size, 197 uint8_t *buf, uint8_t buf_size); 198 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun); 199 200 /* scsi-generic.c. */ 201 extern const SCSIReqOps scsi_generic_req_ops; 202 203 #endif 204