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 #define DEFAULT_IO_TIMEOUT 30 22 23 struct SCSIRequest { 24 SCSIBus *bus; 25 SCSIDevice *dev; 26 const SCSIReqOps *ops; 27 uint32_t refcount; 28 uint32_t tag; 29 uint32_t lun; 30 int16_t status; 31 int16_t host_status; 32 void *hba_private; 33 uint64_t residual; 34 SCSICommand cmd; 35 NotifierList cancel_notifiers; 36 37 /* Note: 38 * - fields before sense are initialized by scsi_req_alloc; 39 * - sense[] is uninitialized; 40 * - fields after sense are memset to 0 by scsi_req_alloc. 41 * */ 42 43 uint8_t sense[SCSI_SENSE_BUF_SIZE]; 44 uint32_t sense_len; 45 bool enqueued; 46 bool io_canceled; 47 bool retry; 48 bool dma_started; 49 BlockAIOCB *aiocb; 50 QEMUSGList *sg; 51 QTAILQ_ENTRY(SCSIRequest) next; 52 }; 53 54 #define TYPE_SCSI_DEVICE "scsi-device" 55 OBJECT_DECLARE_TYPE(SCSIDevice, SCSIDeviceClass, SCSI_DEVICE) 56 57 struct SCSIDeviceClass { 58 DeviceClass parent_class; 59 void (*realize)(SCSIDevice *dev, Error **errp); 60 void (*unrealize)(SCSIDevice *dev); 61 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf, 62 size_t buf_len, void *hba_private); 63 SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun, 64 uint8_t *buf, void *hba_private); 65 void (*unit_attention_reported)(SCSIDevice *s); 66 }; 67 68 struct SCSIDevice 69 { 70 DeviceState qdev; 71 VMChangeStateEntry *vmsentry; 72 QEMUBH *bh; 73 uint32_t id; 74 BlockConf conf; 75 SCSISense unit_attention; 76 bool sense_is_ua; 77 uint8_t sense[SCSI_SENSE_BUF_SIZE]; 78 uint32_t sense_len; 79 QTAILQ_HEAD(, SCSIRequest) requests; 80 uint32_t channel; 81 uint32_t lun; 82 int blocksize; 83 int type; 84 uint64_t max_lba; 85 uint64_t wwn; 86 uint64_t port_wwn; 87 int scsi_version; 88 int default_scsi_version; 89 uint32_t io_timeout; 90 bool needs_vpd_bl_emulation; 91 bool hba_supports_iothread; 92 }; 93 94 extern const VMStateDescription vmstate_scsi_device; 95 96 #define VMSTATE_SCSI_DEVICE(_field, _state) { \ 97 .name = (stringify(_field)), \ 98 .size = sizeof(SCSIDevice), \ 99 .vmsd = &vmstate_scsi_device, \ 100 .flags = VMS_STRUCT, \ 101 .offset = vmstate_offset_value(_state, _field, SCSIDevice), \ 102 } 103 104 /* cdrom.c */ 105 int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track); 106 int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num); 107 108 /* scsi-bus.c */ 109 struct SCSIReqOps { 110 size_t size; 111 void (*init_req)(SCSIRequest *req); 112 void (*free_req)(SCSIRequest *req); 113 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf); 114 void (*read_data)(SCSIRequest *req); 115 void (*write_data)(SCSIRequest *req); 116 uint8_t *(*get_buf)(SCSIRequest *req); 117 118 void (*save_request)(QEMUFile *f, SCSIRequest *req); 119 void (*load_request)(QEMUFile *f, SCSIRequest *req); 120 }; 121 122 struct SCSIBusInfo { 123 int tcq; 124 int max_channel, max_target, max_lun; 125 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf, 126 size_t buf_len, void *hba_private); 127 void (*transfer_data)(SCSIRequest *req, uint32_t arg); 128 void (*fail)(SCSIRequest *req); 129 void (*complete)(SCSIRequest *req, size_t residual); 130 void (*cancel)(SCSIRequest *req); 131 void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense); 132 QEMUSGList *(*get_sg_list)(SCSIRequest *req); 133 134 void (*save_request)(QEMUFile *f, SCSIRequest *req); 135 void *(*load_request)(QEMUFile *f, SCSIRequest *req); 136 void (*free_request)(SCSIBus *bus, void *priv); 137 138 /* 139 * Temporarily stop submitting new requests between drained_begin() and 140 * drained_end(). Called from the main loop thread with the BQL held. 141 * 142 * Implement these callbacks if request processing is triggered by a file 143 * descriptor like an EventNotifier. Otherwise set them to NULL. 144 */ 145 void (*drained_begin)(SCSIBus *bus); 146 void (*drained_end)(SCSIBus *bus); 147 }; 148 149 #define TYPE_SCSI_BUS "SCSI" 150 OBJECT_DECLARE_SIMPLE_TYPE(SCSIBus, SCSI_BUS) 151 152 struct SCSIBus { 153 BusState qbus; 154 int busnr; 155 156 SCSISense unit_attention; 157 const SCSIBusInfo *info; 158 159 int drain_count; /* protected by BQL */ 160 }; 161 162 /** 163 * scsi_bus_init_named: Initialize a SCSI bus with the specified name 164 * @bus: SCSIBus object to initialize 165 * @bus_size: size of @bus object 166 * @host: Device which owns the bus (generally the SCSI controller) 167 * @info: structure defining callbacks etc for the controller 168 * @bus_name: Name to use for this bus 169 * 170 * This in-place initializes @bus as a new SCSI bus with a name 171 * provided by the caller. It is the caller's responsibility to make 172 * sure that name does not clash with the name of any other bus in the 173 * system. Unless you need the new bus to have a specific name, you 174 * should use scsi_bus_init() instead. 175 */ 176 void scsi_bus_init_named(SCSIBus *bus, size_t bus_size, DeviceState *host, 177 const SCSIBusInfo *info, const char *bus_name); 178 179 /** 180 * scsi_bus_init: Initialize a SCSI bus 181 * 182 * This in-place-initializes @bus as a new SCSI bus and gives it 183 * an automatically generated unique name. 184 */ 185 static inline void scsi_bus_init(SCSIBus *bus, size_t bus_size, 186 DeviceState *host, const SCSIBusInfo *info) 187 { 188 scsi_bus_init_named(bus, bus_size, host, info, NULL); 189 } 190 191 static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d) 192 { 193 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus); 194 } 195 196 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk, 197 int unit, bool removable, int bootindex, 198 bool share_rw, 199 BlockdevOnError rerror, 200 BlockdevOnError werror, 201 const char *serial, Error **errp); 202 void scsi_bus_set_ua(SCSIBus *bus, SCSISense sense); 203 void scsi_bus_legacy_handle_cmdline(SCSIBus *bus); 204 205 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d, 206 uint32_t tag, uint32_t lun, void *hba_private); 207 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun, 208 uint8_t *buf, size_t buf_len, void *hba_private); 209 int32_t scsi_req_enqueue(SCSIRequest *req); 210 SCSIRequest *scsi_req_ref(SCSIRequest *req); 211 void scsi_req_unref(SCSIRequest *req); 212 213 int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf, 214 size_t buf_len, void *hba_private); 215 int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf, 216 size_t buf_len); 217 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense); 218 void scsi_req_print(SCSIRequest *req); 219 void scsi_req_continue(SCSIRequest *req); 220 void scsi_req_data(SCSIRequest *req, int len); 221 void scsi_req_complete(SCSIRequest *req, int status); 222 void scsi_req_complete_failed(SCSIRequest *req, int host_status); 223 uint8_t *scsi_req_get_buf(SCSIRequest *req); 224 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len); 225 void scsi_req_cancel_complete(SCSIRequest *req); 226 void scsi_req_cancel(SCSIRequest *req); 227 void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier); 228 void scsi_req_retry(SCSIRequest *req); 229 void scsi_device_drained_begin(SCSIDevice *sdev); 230 void scsi_device_drained_end(SCSIDevice *sdev); 231 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense); 232 void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense); 233 void scsi_device_report_change(SCSIDevice *dev, SCSISense sense); 234 void scsi_device_unit_attention_reported(SCSIDevice *dev); 235 void scsi_generic_read_device_inquiry(SCSIDevice *dev); 236 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed); 237 int scsi_SG_IO_FROM_DEV(BlockBackend *blk, uint8_t *cmd, uint8_t cmd_size, 238 uint8_t *buf, uint8_t buf_size, uint32_t timeout); 239 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun); 240 SCSIDevice *scsi_device_get(SCSIBus *bus, int channel, int target, int lun); 241 242 /* scsi-generic.c. */ 243 extern const SCSIReqOps scsi_generic_req_ops; 244 245 /* scsi-disk.c */ 246 #define SCSI_DISK_QUIRK_MODE_PAGE_APPLE_VENDOR 0 247 #define SCSI_DISK_QUIRK_MODE_SENSE_ROM_USE_DBD 1 248 #define SCSI_DISK_QUIRK_MODE_PAGE_VENDOR_SPECIFIC_APPLE 2 249 #define SCSI_DISK_QUIRK_MODE_PAGE_TRUNCATED 3 250 251 #endif 252