]> git.proxmox.com Git - qemu.git/blame - hw/scsi-bus.c
Merge remote-tracking branch 'qemu-kvm/uq/master' into staging
[qemu.git] / hw / scsi-bus.c
CommitLineData
d52affa7 1#include "hw.h"
2f792016 2#include "qemu-error.h"
43b443b6 3#include "scsi.h"
2ec749cb 4#include "scsi-defs.h"
d52affa7 5#include "qdev.h"
2446333c 6#include "blockdev.h"
5138efec 7#include "trace.h"
d52affa7 8
db07c0f8 9static char *scsibus_get_fw_dev_path(DeviceState *dev);
afa46c46 10static int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf);
71544d30 11static void scsi_req_dequeue(SCSIRequest *req);
db07c0f8 12
d52affa7
GH
13static struct BusInfo scsi_bus_info = {
14 .name = "SCSI",
15 .size = sizeof(SCSIBus),
db07c0f8 16 .get_fw_dev_path = scsibus_get_fw_dev_path,
d52affa7 17 .props = (Property[]) {
0d3545e7 18 DEFINE_PROP_UINT32("channel", SCSIDevice, channel, 0),
d52affa7 19 DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
7e0380b9 20 DEFINE_PROP_UINT32("lun", SCSIDevice, lun, -1),
d52affa7
GH
21 DEFINE_PROP_END_OF_LIST(),
22 },
23};
24static int next_scsi_bus;
25
b9eea3e6
AL
26static int scsi_device_init(SCSIDevice *s)
27{
28 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
29 if (sc->init) {
30 return sc->init(s);
31 }
32 return 0;
33}
34
35static void scsi_device_destroy(SCSIDevice *s)
36{
37 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
38 if (sc->destroy) {
39 sc->destroy(s);
40 }
41}
42
43static SCSIRequest *scsi_device_alloc_req(SCSIDevice *s, uint32_t tag, uint32_t lun,
44 uint8_t *buf, void *hba_private)
45{
46 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
47 if (sc->alloc_req) {
48 return sc->alloc_req(s, tag, lun, buf, hba_private);
49 }
50
51 return NULL;
52}
53
54static void scsi_device_unit_attention_reported(SCSIDevice *s)
55{
56 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
57 if (sc->unit_attention_reported) {
58 sc->unit_attention_reported(s);
59 }
60}
61
d52affa7 62/* Create a scsi bus, and attach devices to it. */
afd4030c 63void scsi_bus_new(SCSIBus *bus, DeviceState *host, const SCSIBusInfo *info)
d52affa7 64{
ca9c39fa 65 qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
d52affa7 66 bus->busnr = next_scsi_bus++;
afd4030c 67 bus->info = info;
cb23117b 68 bus->qbus.allow_hotplug = 1;
d52affa7
GH
69}
70
71544d30
PB
71static void scsi_dma_restart_bh(void *opaque)
72{
73 SCSIDevice *s = opaque;
74 SCSIRequest *req, *next;
75
76 qemu_bh_delete(s->bh);
77 s->bh = NULL;
78
79 QTAILQ_FOREACH_SAFE(req, &s->requests, next, next) {
80 scsi_req_ref(req);
81 if (req->retry) {
82 req->retry = false;
83 switch (req->cmd.mode) {
84 case SCSI_XFER_FROM_DEV:
85 case SCSI_XFER_TO_DEV:
86 scsi_req_continue(req);
87 break;
88 case SCSI_XFER_NONE:
89 scsi_req_dequeue(req);
90 scsi_req_enqueue(req);
91 break;
92 }
93 }
94 scsi_req_unref(req);
95 }
96}
97
98void scsi_req_retry(SCSIRequest *req)
99{
100 /* No need to save a reference, because scsi_dma_restart_bh just
101 * looks at the request list. */
102 req->retry = true;
103}
104
105static void scsi_dma_restart_cb(void *opaque, int running, RunState state)
106{
107 SCSIDevice *s = opaque;
108
109 if (!running) {
110 return;
111 }
112 if (!s->bh) {
113 s->bh = qemu_bh_new(scsi_dma_restart_bh, s);
114 qemu_bh_schedule(s->bh);
115 }
116}
117
d307af79 118static int scsi_qdev_init(DeviceState *qdev)
d52affa7 119{
b9eea3e6 120 SCSIDevice *dev = SCSI_DEVICE(qdev);
d52affa7 121 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
7e0380b9 122 SCSIDevice *d;
01985dcf 123 int rc = -1;
d52affa7 124
0d3545e7
PB
125 if (dev->channel > bus->info->max_channel) {
126 error_report("bad scsi channel id: %d", dev->channel);
127 goto err;
128 }
7e0380b9 129 if (dev->id != -1 && dev->id > bus->info->max_target) {
1ecda02b 130 error_report("bad scsi device id: %d", dev->id);
d52affa7
GH
131 goto err;
132 }
133
7e0380b9
PB
134 if (dev->id == -1) {
135 int id = -1;
136 if (dev->lun == -1) {
137 dev->lun = 0;
138 }
139 do {
0d3545e7 140 d = scsi_device_find(bus, dev->channel, ++id, dev->lun);
7e0380b9
PB
141 } while (d && d->lun == dev->lun && id <= bus->info->max_target);
142 if (id > bus->info->max_target) {
143 error_report("no free target");
144 goto err;
145 }
146 dev->id = id;
147 } else if (dev->lun == -1) {
148 int lun = -1;
149 do {
0d3545e7 150 d = scsi_device_find(bus, dev->channel, dev->id, ++lun);
7e0380b9
PB
151 } while (d && d->lun == lun && lun < bus->info->max_lun);
152 if (lun > bus->info->max_lun) {
153 error_report("no free lun");
154 goto err;
155 }
156 dev->lun = lun;
157 } else {
0d3545e7 158 d = scsi_device_find(bus, dev->channel, dev->id, dev->lun);
7e0380b9
PB
159 if (dev->lun == d->lun && dev != d) {
160 qdev_free(&d->qdev);
161 }
d52affa7 162 }
d52affa7 163
9af99d98 164 QTAILQ_INIT(&dev->requests);
b9eea3e6 165 rc = scsi_device_init(dev);
71544d30
PB
166 if (rc == 0) {
167 dev->vmsentry = qemu_add_vm_change_state_handler(scsi_dma_restart_cb,
168 dev);
169 }
d52affa7
GH
170
171err:
01985dcf
GH
172 return rc;
173}
174
175static int scsi_qdev_exit(DeviceState *qdev)
176{
b9eea3e6 177 SCSIDevice *dev = SCSI_DEVICE(qdev);
01985dcf 178
71544d30
PB
179 if (dev->vmsentry) {
180 qemu_del_vm_change_state_handler(dev->vmsentry);
181 }
b9eea3e6 182 scsi_device_destroy(dev);
01985dcf 183 return 0;
d52affa7
GH
184}
185
d52affa7 186/* handle legacy '-drive if=scsi,...' cmd line args */
2d1fd261 187SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
ce4e7e46 188 int unit, bool removable, int bootindex)
d52affa7
GH
189{
190 const char *driver;
191 DeviceState *dev;
192
f8b6cc00 193 driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
d52affa7
GH
194 dev = qdev_create(&bus->qbus, driver);
195 qdev_prop_set_uint32(dev, "scsi-id", unit);
ce4e7e46
PB
196 if (bootindex >= 0) {
197 qdev_prop_set_int32(dev, "bootindex", bootindex);
198 }
2d1fd261
SH
199 if (qdev_prop_exists(dev, "removable")) {
200 qdev_prop_set_bit(dev, "removable", removable);
201 }
18846dee
MA
202 if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
203 qdev_free(dev);
204 return NULL;
205 }
33e66b86
MA
206 if (qdev_init(dev) < 0)
207 return NULL;
b9eea3e6 208 return SCSI_DEVICE(dev);
d52affa7
GH
209}
210
fa66b909 211int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
d52affa7 212{
42e766a2 213 Location loc;
d52affa7 214 DriveInfo *dinfo;
fa66b909 215 int res = 0, unit;
d52affa7 216
42e766a2 217 loc_push_none(&loc);
7e0380b9 218 for (unit = 0; unit < bus->info->max_target; unit++) {
d52affa7
GH
219 dinfo = drive_get(IF_SCSI, bus->busnr, unit);
220 if (dinfo == NULL) {
221 continue;
222 }
42e766a2 223 qemu_opts_loc_restore(dinfo->opts);
ce4e7e46 224 if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1)) {
fa66b909
MA
225 res = -1;
226 break;
227 }
d52affa7 228 }
42e766a2 229 loc_pop(&loc);
fa66b909 230 return res;
d52affa7 231}
89b08ae1 232
afa46c46
PB
233/* SCSIReqOps implementation for invalid commands. */
234
235static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
236{
237 scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
238 scsi_req_complete(req, CHECK_CONDITION);
239 return 0;
240}
241
adcf2754 242static const struct SCSIReqOps reqops_invalid_opcode = {
afa46c46
PB
243 .size = sizeof(SCSIRequest),
244 .send_command = scsi_invalid_command
245};
246
6dc06f08
PB
247/* SCSIReqOps implementation for unit attention conditions. */
248
249static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
250{
251 if (req->dev && req->dev->unit_attention.key == UNIT_ATTENTION) {
252 scsi_req_build_sense(req, req->dev->unit_attention);
253 } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
254 scsi_req_build_sense(req, req->bus->unit_attention);
255 }
256 scsi_req_complete(req, CHECK_CONDITION);
257 return 0;
258}
259
adcf2754 260static const struct SCSIReqOps reqops_unit_attention = {
6dc06f08
PB
261 .size = sizeof(SCSIRequest),
262 .send_command = scsi_unit_attention
263};
264
fdaef069
PB
265/* SCSIReqOps implementation for REPORT LUNS and for commands sent to
266 an invalid LUN. */
267
268typedef struct SCSITargetReq SCSITargetReq;
269
270struct SCSITargetReq {
271 SCSIRequest req;
272 int len;
ba74307c 273 uint8_t buf[2056];
fdaef069
PB
274};
275
276static void store_lun(uint8_t *outbuf, int lun)
277{
278 if (lun < 256) {
279 outbuf[1] = lun;
280 return;
281 }
282 outbuf[1] = (lun & 255);
283 outbuf[0] = (lun >> 8) | 0x40;
284}
285
286static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
287{
ba74307c
PB
288 DeviceState *qdev;
289 int i, len, n;
0d3545e7 290 int channel, id;
ba74307c
PB
291 bool found_lun0;
292
fdaef069
PB
293 if (r->req.cmd.xfer < 16) {
294 return false;
295 }
296 if (r->req.cmd.buf[2] > 2) {
297 return false;
298 }
0d3545e7 299 channel = r->req.dev->channel;
ba74307c
PB
300 id = r->req.dev->id;
301 found_lun0 = false;
302 n = 0;
303 QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
b9eea3e6 304 SCSIDevice *dev = SCSI_DEVICE(qdev);
ba74307c 305
0d3545e7 306 if (dev->channel == channel && dev->id == id) {
ba74307c
PB
307 if (dev->lun == 0) {
308 found_lun0 = true;
309 }
310 n += 8;
311 }
312 }
313 if (!found_lun0) {
314 n += 8;
315 }
316 len = MIN(n + 8, r->req.cmd.xfer & ~7);
317 if (len > sizeof(r->buf)) {
318 /* TODO: > 256 LUNs? */
319 return false;
320 }
321
fdaef069 322 memset(r->buf, 0, len);
ba74307c
PB
323 stl_be_p(&r->buf, n);
324 i = found_lun0 ? 8 : 16;
325 QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
b9eea3e6 326 SCSIDevice *dev = SCSI_DEVICE(qdev);
ba74307c 327
0d3545e7 328 if (dev->channel == channel && dev->id == id) {
ba74307c
PB
329 store_lun(&r->buf[i], dev->lun);
330 i += 8;
331 }
fdaef069 332 }
ba74307c
PB
333 assert(i == n + 8);
334 r->len = len;
fdaef069
PB
335 return true;
336}
337
338static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
339{
340 assert(r->req.dev->lun != r->req.lun);
341 if (r->req.cmd.buf[1] & 0x2) {
342 /* Command support data - optional, not implemented */
343 return false;
344 }
345
346 if (r->req.cmd.buf[1] & 0x1) {
347 /* Vital product data */
348 uint8_t page_code = r->req.cmd.buf[2];
349 if (r->req.cmd.xfer < 4) {
350 return false;
351 }
352
353 r->buf[r->len++] = page_code ; /* this page */
354 r->buf[r->len++] = 0x00;
355
356 switch (page_code) {
357 case 0x00: /* Supported page codes, mandatory */
358 {
359 int pages;
360 pages = r->len++;
361 r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
362 r->buf[pages] = r->len - pages - 1; /* number of pages */
363 break;
364 }
365 default:
366 return false;
367 }
368 /* done with EVPD */
369 assert(r->len < sizeof(r->buf));
370 r->len = MIN(r->req.cmd.xfer, r->len);
371 return true;
372 }
373
374 /* Standard INQUIRY data */
375 if (r->req.cmd.buf[2] != 0) {
376 return false;
377 }
378
379 /* PAGE CODE == 0 */
380 if (r->req.cmd.xfer < 5) {
381 return -1;
382 }
383
384 r->len = MIN(r->req.cmd.xfer, 36);
385 memset(r->buf, 0, r->len);
386 if (r->req.lun != 0) {
387 r->buf[0] = TYPE_NO_LUN;
388 } else {
389 r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
390 r->buf[2] = 5; /* Version */
391 r->buf[3] = 2 | 0x10; /* HiSup, response data format */
392 r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
afd4030c 393 r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ. */
fdaef069
PB
394 memcpy(&r->buf[8], "QEMU ", 8);
395 memcpy(&r->buf[16], "QEMU TARGET ", 16);
396 strncpy((char *) &r->buf[32], QEMU_VERSION, 4);
397 }
398 return true;
399}
400
401static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
402{
403 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
404
405 switch (buf[0]) {
406 case REPORT_LUNS:
407 if (!scsi_target_emulate_report_luns(r)) {
408 goto illegal_request;
409 }
410 break;
411 case INQUIRY:
412 if (!scsi_target_emulate_inquiry(r)) {
413 goto illegal_request;
414 }
415 break;
739df215
PB
416 case REQUEST_SENSE:
417 if (req->cmd.xfer < 4) {
418 goto illegal_request;
419 }
8b2a04ee
PB
420 r->len = scsi_device_get_sense(r->req.dev, r->buf,
421 MIN(req->cmd.xfer, sizeof r->buf),
739df215 422 (req->cmd.buf[1] & 1) == 0);
3653d8c4 423 if (r->req.dev->sense_is_ua) {
b9eea3e6 424 scsi_device_unit_attention_reported(req->dev);
3653d8c4
PB
425 r->req.dev->sense_len = 0;
426 r->req.dev->sense_is_ua = false;
427 }
739df215 428 break;
fdaef069
PB
429 default:
430 scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
431 scsi_req_complete(req, CHECK_CONDITION);
432 return 0;
433 illegal_request:
434 scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
435 scsi_req_complete(req, CHECK_CONDITION);
436 return 0;
437 }
438
439 if (!r->len) {
440 scsi_req_complete(req, GOOD);
441 }
442 return r->len;
443}
444
445static void scsi_target_read_data(SCSIRequest *req)
446{
447 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
448 uint32_t n;
449
450 n = r->len;
451 if (n > 0) {
452 r->len = 0;
453 scsi_req_data(&r->req, n);
454 } else {
455 scsi_req_complete(&r->req, GOOD);
456 }
457}
458
459static uint8_t *scsi_target_get_buf(SCSIRequest *req)
460{
461 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
462
463 return r->buf;
464}
465
adcf2754 466static const struct SCSIReqOps reqops_target_command = {
fdaef069
PB
467 .size = sizeof(SCSITargetReq),
468 .send_command = scsi_target_send_command,
469 .read_data = scsi_target_read_data,
470 .get_buf = scsi_target_get_buf,
471};
472
473
adcf2754
PB
474SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
475 uint32_t tag, uint32_t lun, void *hba_private)
89b08ae1
GH
476{
477 SCSIRequest *req;
478
7267c094 479 req = g_malloc0(reqops->size);
5c6c0e51 480 req->refcount = 1;
89b08ae1
GH
481 req->bus = scsi_bus_from_device(d);
482 req->dev = d;
483 req->tag = tag;
484 req->lun = lun;
c5bf71a9 485 req->hba_private = hba_private;
ed3a34a3 486 req->status = -1;
b45ef674 487 req->sense_len = 0;
8dbd4574 488 req->ops = reqops;
5138efec 489 trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
89b08ae1
GH
490 return req;
491}
492
c5bf71a9 493SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
c39ce112 494 uint8_t *buf, void *hba_private)
43a2b339 495{
6dc06f08 496 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
c39ce112 497 SCSIRequest *req;
afa46c46
PB
498 SCSICommand cmd;
499
500 if (scsi_req_parse(&cmd, d, buf) != 0) {
501 trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
502 req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
503 } else {
504 trace_scsi_req_parsed(d->id, lun, tag, buf[0],
505 cmd.mode, cmd.xfer);
3b6ffe50 506 if (cmd.lba != -1) {
afa46c46
PB
507 trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
508 cmd.lba);
509 }
fdaef069 510
6dc06f08
PB
511 if ((d->unit_attention.key == UNIT_ATTENTION ||
512 bus->unit_attention.key == UNIT_ATTENTION) &&
513 (buf[0] != INQUIRY &&
514 buf[0] != REPORT_LUNS &&
515 buf[0] != GET_CONFIGURATION &&
3653d8c4
PB
516 buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
517
518 /*
519 * If we already have a pending unit attention condition,
520 * report this one before triggering another one.
521 */
522 !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
6dc06f08
PB
523 req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
524 hba_private);
525 } else if (lun != d->lun ||
739df215 526 buf[0] == REPORT_LUNS ||
f3b338ef 527 (buf[0] == REQUEST_SENSE && (d->sense_len || cmd.xfer < 4))) {
fdaef069
PB
528 req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
529 hba_private);
530 } else {
b9eea3e6 531 req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
fdaef069 532 }
afa46c46
PB
533 }
534
535 req->cmd = cmd;
98254542
PB
536 switch (buf[0]) {
537 case INQUIRY:
538 trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
539 break;
540 case TEST_UNIT_READY:
541 trace_scsi_test_unit_ready(d->id, lun, tag);
542 break;
543 case REPORT_LUNS:
544 trace_scsi_report_luns(d->id, lun, tag);
545 break;
546 case REQUEST_SENSE:
547 trace_scsi_request_sense(d->id, lun, tag);
548 break;
549 default:
550 break;
551 }
552
c39ce112 553 return req;
43a2b339
PB
554}
555
0c34459b
PB
556uint8_t *scsi_req_get_buf(SCSIRequest *req)
557{
12010e7b 558 return req->ops->get_buf(req);
0c34459b
PB
559}
560
6dc06f08
PB
561static void scsi_clear_unit_attention(SCSIRequest *req)
562{
563 SCSISense *ua;
564 if (req->dev->unit_attention.key != UNIT_ATTENTION &&
565 req->bus->unit_attention.key != UNIT_ATTENTION) {
566 return;
567 }
568
569 /*
570 * If an INQUIRY command enters the enabled command state,
571 * the device server shall [not] clear any unit attention condition;
572 * See also MMC-6, paragraphs 6.5 and 6.6.2.
573 */
574 if (req->cmd.buf[0] == INQUIRY ||
575 req->cmd.buf[0] == GET_CONFIGURATION ||
576 req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
577 return;
578 }
579
580 if (req->dev->unit_attention.key == UNIT_ATTENTION) {
581 ua = &req->dev->unit_attention;
582 } else {
583 ua = &req->bus->unit_attention;
584 }
585
586 /*
587 * If a REPORT LUNS command enters the enabled command state, [...]
588 * the device server shall clear any pending unit attention condition
589 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
590 */
591 if (req->cmd.buf[0] == REPORT_LUNS &&
592 !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
593 ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
594 return;
595 }
596
597 *ua = SENSE_CODE(NO_SENSE);
598}
599
74382217
HR
600int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
601{
6dc06f08
PB
602 int ret;
603
b45ef674
PB
604 assert(len >= 14);
605 if (!req->sense_len) {
74382217
HR
606 return 0;
607 }
6dc06f08
PB
608
609 ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
610
611 /*
612 * FIXME: clearing unit attention conditions upon autosense should be done
613 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
614 * (SAM-5, 5.14).
615 *
616 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
617 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
3653d8c4 618 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
6dc06f08 619 */
3653d8c4 620 if (req->dev->sense_is_ua) {
b9eea3e6 621 scsi_device_unit_attention_reported(req->dev);
3653d8c4
PB
622 req->dev->sense_len = 0;
623 req->dev->sense_is_ua = false;
624 }
6dc06f08 625 return ret;
b45ef674
PB
626}
627
628int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
629{
630 return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
631}
632
633void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
634{
635 trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
636 sense.key, sense.asc, sense.ascq);
637 memset(req->sense, 0, 18);
638 req->sense[0] = 0xf0;
639 req->sense[2] = sense.key;
eae31cb9 640 req->sense[7] = 10;
b45ef674
PB
641 req->sense[12] = sense.asc;
642 req->sense[13] = sense.ascq;
643 req->sense_len = 18;
74382217
HR
644}
645
c39ce112 646int32_t scsi_req_enqueue(SCSIRequest *req)
89b08ae1 647{
fc4f0754
PB
648 int32_t rc;
649
5c6c0e51
HR
650 assert(!req->enqueued);
651 scsi_req_ref(req);
652 req->enqueued = true;
653 QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
fc4f0754
PB
654
655 scsi_req_ref(req);
c39ce112 656 rc = req->ops->send_command(req, req->cmd.buf);
fc4f0754
PB
657 scsi_req_unref(req);
658 return rc;
89b08ae1
GH
659}
660
a1f0cce2 661static void scsi_req_dequeue(SCSIRequest *req)
e8637c90 662{
5138efec 663 trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
71544d30 664 req->retry = false;
e8637c90
JK
665 if (req->enqueued) {
666 QTAILQ_REMOVE(&req->dev->requests, req, next);
667 req->enqueued = false;
ad2d30f7 668 scsi_req_unref(req);
e8637c90
JK
669 }
670}
671
06b86357
PB
672static int scsi_get_performance_length(int num_desc, int type, int data_type)
673{
674 /* MMC-6, paragraph 6.7. */
675 switch (type) {
676 case 0:
677 if ((data_type & 3) == 0) {
678 /* Each descriptor is as in Table 295 - Nominal performance. */
679 return 16 * num_desc + 8;
680 } else {
681 /* Each descriptor is as in Table 296 - Exceptions. */
682 return 6 * num_desc + 8;
683 }
684 case 1:
685 case 4:
686 case 5:
687 return 8 * num_desc + 8;
688 case 2:
689 return 2048 * num_desc + 8;
690 case 3:
691 return 16 * num_desc + 8;
692 default:
693 return 8;
694 }
695}
696
2599aece 697static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
2ec749cb 698{
2599aece 699 switch (buf[0] >> 5) {
2ec749cb 700 case 0:
2599aece
PB
701 cmd->xfer = buf[4];
702 cmd->len = 6;
2ec749cb 703 /* length 0 means 256 blocks */
2599aece
PB
704 if (cmd->xfer == 0) {
705 cmd->xfer = 256;
706 }
2ec749cb
GH
707 break;
708 case 1:
709 case 2:
bd5da232 710 cmd->xfer = lduw_be_p(&buf[7]);
2599aece 711 cmd->len = 10;
2ec749cb
GH
712 break;
713 case 4:
06b86357 714 cmd->xfer = ldl_be_p(&buf[10]) & 0xffffffffULL;
2599aece 715 cmd->len = 16;
2ec749cb
GH
716 break;
717 case 5:
06b86357 718 cmd->xfer = ldl_be_p(&buf[6]) & 0xffffffffULL;
2599aece 719 cmd->len = 12;
2ec749cb
GH
720 break;
721 default:
722 return -1;
723 }
724
2599aece 725 switch (buf[0]) {
2ec749cb 726 case TEST_UNIT_READY:
5e30a07d 727 case REWIND:
2ec749cb 728 case START_STOP:
00a01ad4 729 case SET_CAPACITY:
2ec749cb 730 case WRITE_FILEMARKS:
06b86357 731 case WRITE_FILEMARKS_16:
2ec749cb 732 case SPACE:
a5e3d9ef
BK
733 case RESERVE:
734 case RELEASE:
2ec749cb
GH
735 case ERASE:
736 case ALLOW_MEDIUM_REMOVAL:
5e30a07d 737 case VERIFY_10:
2ec749cb
GH
738 case SEEK_10:
739 case SYNCHRONIZE_CACHE:
06b86357
PB
740 case SYNCHRONIZE_CACHE_16:
741 case LOCATE_16:
2ec749cb
GH
742 case LOCK_UNLOCK_CACHE:
743 case LOAD_UNLOAD:
744 case SET_CD_SPEED:
745 case SET_LIMITS:
5e30a07d 746 case WRITE_LONG_10:
2ec749cb
GH
747 case MOVE_MEDIUM:
748 case UPDATE_BLOCK:
06b86357
PB
749 case RESERVE_TRACK:
750 case SET_READ_AHEAD:
751 case PRE_FETCH:
752 case PRE_FETCH_16:
753 case ALLOW_OVERWRITE:
2599aece 754 cmd->xfer = 0;
2ec749cb
GH
755 break;
756 case MODE_SENSE:
757 break;
5e30a07d 758 case WRITE_SAME_10:
2599aece 759 cmd->xfer = 1;
2ec749cb 760 break;
5e30a07d 761 case READ_CAPACITY_10:
2599aece 762 cmd->xfer = 8;
2ec749cb
GH
763 break;
764 case READ_BLOCK_LIMITS:
2599aece 765 cmd->xfer = 6;
2ec749cb 766 break;
2ec749cb 767 case SEND_VOLUME_TAG:
06b86357
PB
768 /* GPCMD_SET_STREAMING from multimedia commands. */
769 if (dev->type == TYPE_ROM) {
770 cmd->xfer = buf[10] | (buf[9] << 8);
771 } else {
772 cmd->xfer = buf[9] | (buf[8] << 8);
773 }
2ec749cb
GH
774 break;
775 case WRITE_10:
5e30a07d 776 case WRITE_VERIFY_10:
2ec749cb
GH
777 case WRITE_6:
778 case WRITE_12:
779 case WRITE_VERIFY_12:
bd536cf3
GH
780 case WRITE_16:
781 case WRITE_VERIFY_16:
2599aece 782 cmd->xfer *= dev->blocksize;
2ec749cb
GH
783 break;
784 case READ_10:
785 case READ_6:
786 case READ_REVERSE:
787 case RECOVER_BUFFERED_DATA:
788 case READ_12:
bd536cf3 789 case READ_16:
2599aece 790 cmd->xfer *= dev->blocksize;
2ec749cb 791 break;
06b86357
PB
792 case FORMAT_UNIT:
793 /* MMC mandates the parameter list to be 12-bytes long. Parameters
794 * for block devices are restricted to the header right now. */
795 if (dev->type == TYPE_ROM && (buf[1] & 16)) {
796 cmd->xfer = 12;
797 } else {
798 cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
799 }
800 break;
2ec749cb 801 case INQUIRY:
06b86357
PB
802 case RECEIVE_DIAGNOSTIC:
803 case SEND_DIAGNOSTIC:
2599aece 804 cmd->xfer = buf[4] | (buf[3] << 8);
2ec749cb 805 break;
06b86357
PB
806 case READ_CD:
807 case READ_BUFFER:
808 case WRITE_BUFFER:
809 case SEND_CUE_SHEET:
810 cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
811 break;
812 case PERSISTENT_RESERVE_OUT:
813 cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
814 break;
815 case ERASE_12:
816 if (dev->type == TYPE_ROM) {
817 /* MMC command GET PERFORMANCE. */
818 cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
819 buf[10], buf[1] & 0x1f);
820 }
821 break;
822 case MECHANISM_STATUS:
823 case READ_DVD_STRUCTURE:
824 case SEND_DVD_STRUCTURE:
c7126d5b
NB
825 case MAINTENANCE_OUT:
826 case MAINTENANCE_IN:
2599aece 827 if (dev->type == TYPE_ROM) {
c7126d5b 828 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
2599aece 829 cmd->xfer = buf[9] | (buf[8] << 8);
c7126d5b
NB
830 }
831 break;
2ec749cb
GH
832 }
833 return 0;
834}
835
2599aece 836static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
2ec749cb 837{
2599aece 838 switch (buf[0]) {
2ec749cb 839 /* stream commands */
06b86357
PB
840 case ERASE_12:
841 case ERASE_16:
842 cmd->xfer = 0;
843 break;
2ec749cb
GH
844 case READ_6:
845 case READ_REVERSE:
846 case RECOVER_BUFFERED_DATA:
847 case WRITE_6:
2599aece
PB
848 cmd->len = 6;
849 cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
850 if (buf[1] & 0x01) { /* fixed */
851 cmd->xfer *= dev->blocksize;
852 }
2ec749cb
GH
853 break;
854 case REWIND:
855 case START_STOP:
2599aece
PB
856 cmd->len = 6;
857 cmd->xfer = 0;
2ec749cb 858 break;
06b86357
PB
859 case SPACE_16:
860 cmd->xfer = buf[13] | (buf[12] << 8);
861 break;
862 case READ_POSITION:
863 cmd->xfer = buf[8] | (buf[7] << 8);
864 break;
865 case FORMAT_UNIT:
866 cmd->xfer = buf[4] | (buf[3] << 8);
867 break;
2ec749cb
GH
868 /* generic commands */
869 default:
2599aece 870 return scsi_req_length(cmd, dev, buf);
2ec749cb
GH
871 }
872 return 0;
873}
874
2599aece 875static void scsi_cmd_xfer_mode(SCSICommand *cmd)
97a06435 876{
2599aece 877 switch (cmd->buf[0]) {
97a06435
GH
878 case WRITE_6:
879 case WRITE_10:
5e30a07d 880 case WRITE_VERIFY_10:
97a06435
GH
881 case WRITE_12:
882 case WRITE_VERIFY_12:
bd536cf3
GH
883 case WRITE_16:
884 case WRITE_VERIFY_16:
97a06435
GH
885 case COPY:
886 case COPY_VERIFY:
887 case COMPARE:
888 case CHANGE_DEFINITION:
889 case LOG_SELECT:
890 case MODE_SELECT:
891 case MODE_SELECT_10:
892 case SEND_DIAGNOSTIC:
893 case WRITE_BUFFER:
894 case FORMAT_UNIT:
895 case REASSIGN_BLOCKS:
97a06435
GH
896 case SEARCH_EQUAL:
897 case SEARCH_HIGH:
898 case SEARCH_LOW:
899 case UPDATE_BLOCK:
5e30a07d
HR
900 case WRITE_LONG_10:
901 case WRITE_SAME_10:
97a06435
GH
902 case SEARCH_HIGH_12:
903 case SEARCH_EQUAL_12:
904 case SEARCH_LOW_12:
97a06435
GH
905 case MEDIUM_SCAN:
906 case SEND_VOLUME_TAG:
06b86357
PB
907 case SEND_CUE_SHEET:
908 case SEND_DVD_STRUCTURE:
01bedeba 909 case PERSISTENT_RESERVE_OUT:
c7126d5b 910 case MAINTENANCE_OUT:
2599aece 911 cmd->mode = SCSI_XFER_TO_DEV;
97a06435
GH
912 break;
913 default:
2599aece
PB
914 if (cmd->xfer)
915 cmd->mode = SCSI_XFER_FROM_DEV;
97a06435 916 else {
2599aece 917 cmd->mode = SCSI_XFER_NONE;
97a06435
GH
918 }
919 break;
920 }
921}
922
2599aece 923static uint64_t scsi_cmd_lba(SCSICommand *cmd)
2ec749cb 924{
2599aece 925 uint8_t *buf = cmd->buf;
2ec749cb
GH
926 uint64_t lba;
927
928 switch (buf[0] >> 5) {
929 case 0:
bd5da232 930 lba = ldl_be_p(&buf[0]) & 0x1fffff;
2ec749cb
GH
931 break;
932 case 1:
933 case 2:
bd5da232 934 case 5:
06b86357 935 lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
2ec749cb
GH
936 break;
937 case 4:
bd5da232 938 lba = ldq_be_p(&buf[2]);
2ec749cb
GH
939 break;
940 default:
941 lba = -1;
942
943 }
944 return lba;
945}
946
afa46c46 947int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
2ec749cb
GH
948{
949 int rc;
950
afa46c46
PB
951 if (dev->type == TYPE_TAPE) {
952 rc = scsi_req_stream_length(cmd, dev, buf);
2ec749cb 953 } else {
afa46c46 954 rc = scsi_req_length(cmd, dev, buf);
2ec749cb
GH
955 }
956 if (rc != 0)
957 return rc;
958
afa46c46
PB
959 memcpy(cmd->buf, buf, cmd->len);
960 scsi_cmd_xfer_mode(cmd);
961 cmd->lba = scsi_cmd_lba(cmd);
2ec749cb
GH
962 return 0;
963}
ed3a34a3 964
a1f0cce2
HR
965/*
966 * Predefined sense codes
967 */
968
969/* No sense data available */
970const struct SCSISense sense_code_NO_SENSE = {
971 .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
972};
973
974/* LUN not ready, Manual intervention required */
975const struct SCSISense sense_code_LUN_NOT_READY = {
976 .key = NOT_READY, .asc = 0x04, .ascq = 0x03
977};
978
979/* LUN not ready, Medium not present */
980const struct SCSISense sense_code_NO_MEDIUM = {
981 .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
982};
983
68bb01f3
MA
984/* LUN not ready, medium removal prevented */
985const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
986 .key = NOT_READY, .asc = 0x53, .ascq = 0x00
987};
988
a1f0cce2
HR
989/* Hardware error, internal target failure */
990const struct SCSISense sense_code_TARGET_FAILURE = {
991 .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
992};
993
994/* Illegal request, invalid command operation code */
995const struct SCSISense sense_code_INVALID_OPCODE = {
996 .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
997};
998
999/* Illegal request, LBA out of range */
1000const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1001 .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1002};
1003
1004/* Illegal request, Invalid field in CDB */
1005const struct SCSISense sense_code_INVALID_FIELD = {
1006 .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1007};
1008
1009/* Illegal request, LUN not supported */
1010const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1011 .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1012};
1013
a872a304
PB
1014/* Illegal request, Saving parameters not supported */
1015const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1016 .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1017};
1018
1019/* Illegal request, Incompatible medium installed */
67cc61e4 1020const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
a872a304
PB
1021 .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1022};
1023
68bb01f3
MA
1024/* Illegal request, medium removal prevented */
1025const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1026 .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x00
1027};
1028
a1f0cce2
HR
1029/* Command aborted, I/O process terminated */
1030const struct SCSISense sense_code_IO_ERROR = {
1031 .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1032};
1033
1034/* Command aborted, I_T Nexus loss occurred */
1035const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1036 .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1037};
1038
1039/* Command aborted, Logical Unit failure */
1040const struct SCSISense sense_code_LUN_FAILURE = {
1041 .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1042};
1043
a872a304
PB
1044/* Unit attention, Power on, reset or bus device reset occurred */
1045const struct SCSISense sense_code_RESET = {
1046 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1047};
1048
8a9c16f6
PB
1049/* Unit attention, No medium */
1050const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1051 .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1052};
1053
a872a304
PB
1054/* Unit attention, Medium may have changed */
1055const struct SCSISense sense_code_MEDIUM_CHANGED = {
1056 .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1057};
1058
1059/* Unit attention, Reported LUNs data has changed */
1060const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1061 .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1062};
1063
1064/* Unit attention, Device internal reset */
1065const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1066 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1067};
1068
a1f0cce2
HR
1069/*
1070 * scsi_build_sense
1071 *
b45ef674 1072 * Convert between fixed and descriptor sense buffers
a1f0cce2 1073 */
b45ef674
PB
1074int scsi_build_sense(uint8_t *in_buf, int in_len,
1075 uint8_t *buf, int len, bool fixed)
a1f0cce2 1076{
b45ef674
PB
1077 bool fixed_in;
1078 SCSISense sense;
a1f0cce2
HR
1079 if (!fixed && len < 8) {
1080 return 0;
1081 }
1082
b45ef674
PB
1083 if (in_len == 0) {
1084 sense.key = NO_SENSE;
1085 sense.asc = 0;
1086 sense.ascq = 0;
1087 } else {
1088 fixed_in = (in_buf[0] & 2) == 0;
1089
1090 if (fixed == fixed_in) {
1091 memcpy(buf, in_buf, MIN(len, in_len));
1092 return MIN(len, in_len);
1093 }
1094
1095 if (fixed_in) {
1096 sense.key = in_buf[2];
1097 sense.asc = in_buf[12];
1098 sense.ascq = in_buf[13];
1099 } else {
1100 sense.key = in_buf[1];
1101 sense.asc = in_buf[2];
1102 sense.ascq = in_buf[3];
1103 }
1104 }
1105
a1f0cce2
HR
1106 memset(buf, 0, len);
1107 if (fixed) {
1108 /* Return fixed format sense buffer */
1109 buf[0] = 0xf0;
1110 buf[2] = sense.key;
eae31cb9 1111 buf[7] = 10;
a1f0cce2
HR
1112 buf[12] = sense.asc;
1113 buf[13] = sense.ascq;
1114 return MIN(len, 18);
1115 } else {
1116 /* Return descriptor format sense buffer */
1117 buf[0] = 0x72;
1118 buf[1] = sense.key;
1119 buf[2] = sense.asc;
1120 buf[3] = sense.ascq;
1121 return 8;
1122 }
1123}
1124
ec766865
GH
1125static const char *scsi_command_name(uint8_t cmd)
1126{
1127 static const char *names[] = {
1128 [ TEST_UNIT_READY ] = "TEST_UNIT_READY",
5e30a07d 1129 [ REWIND ] = "REWIND",
ec766865
GH
1130 [ REQUEST_SENSE ] = "REQUEST_SENSE",
1131 [ FORMAT_UNIT ] = "FORMAT_UNIT",
1132 [ READ_BLOCK_LIMITS ] = "READ_BLOCK_LIMITS",
1133 [ REASSIGN_BLOCKS ] = "REASSIGN_BLOCKS",
1134 [ READ_6 ] = "READ_6",
1135 [ WRITE_6 ] = "WRITE_6",
00a01ad4 1136 [ SET_CAPACITY ] = "SET_CAPACITY",
ec766865
GH
1137 [ READ_REVERSE ] = "READ_REVERSE",
1138 [ WRITE_FILEMARKS ] = "WRITE_FILEMARKS",
1139 [ SPACE ] = "SPACE",
1140 [ INQUIRY ] = "INQUIRY",
1141 [ RECOVER_BUFFERED_DATA ] = "RECOVER_BUFFERED_DATA",
c7126d5b
NB
1142 [ MAINTENANCE_IN ] = "MAINTENANCE_IN",
1143 [ MAINTENANCE_OUT ] = "MAINTENANCE_OUT",
ec766865
GH
1144 [ MODE_SELECT ] = "MODE_SELECT",
1145 [ RESERVE ] = "RESERVE",
1146 [ RELEASE ] = "RELEASE",
1147 [ COPY ] = "COPY",
1148 [ ERASE ] = "ERASE",
1149 [ MODE_SENSE ] = "MODE_SENSE",
1150 [ START_STOP ] = "START_STOP",
1151 [ RECEIVE_DIAGNOSTIC ] = "RECEIVE_DIAGNOSTIC",
1152 [ SEND_DIAGNOSTIC ] = "SEND_DIAGNOSTIC",
1153 [ ALLOW_MEDIUM_REMOVAL ] = "ALLOW_MEDIUM_REMOVAL",
5e30a07d 1154 [ READ_CAPACITY_10 ] = "READ_CAPACITY_10",
ec766865
GH
1155 [ READ_10 ] = "READ_10",
1156 [ WRITE_10 ] = "WRITE_10",
1157 [ SEEK_10 ] = "SEEK_10",
5e30a07d
HR
1158 [ WRITE_VERIFY_10 ] = "WRITE_VERIFY_10",
1159 [ VERIFY_10 ] = "VERIFY_10",
ec766865
GH
1160 [ SEARCH_HIGH ] = "SEARCH_HIGH",
1161 [ SEARCH_EQUAL ] = "SEARCH_EQUAL",
1162 [ SEARCH_LOW ] = "SEARCH_LOW",
1163 [ SET_LIMITS ] = "SET_LIMITS",
00a01ad4 1164 [ PRE_FETCH ] = "PRE_FETCH/READ_POSITION",
545557d4 1165 /* READ_POSITION and PRE_FETCH use the same operation code */
ec766865
GH
1166 [ SYNCHRONIZE_CACHE ] = "SYNCHRONIZE_CACHE",
1167 [ LOCK_UNLOCK_CACHE ] = "LOCK_UNLOCK_CACHE",
1168 [ READ_DEFECT_DATA ] = "READ_DEFECT_DATA",
1169 [ MEDIUM_SCAN ] = "MEDIUM_SCAN",
1170 [ COMPARE ] = "COMPARE",
1171 [ COPY_VERIFY ] = "COPY_VERIFY",
1172 [ WRITE_BUFFER ] = "WRITE_BUFFER",
1173 [ READ_BUFFER ] = "READ_BUFFER",
1174 [ UPDATE_BLOCK ] = "UPDATE_BLOCK",
5e30a07d
HR
1175 [ READ_LONG_10 ] = "READ_LONG_10",
1176 [ WRITE_LONG_10 ] = "WRITE_LONG_10",
ec766865 1177 [ CHANGE_DEFINITION ] = "CHANGE_DEFINITION",
5e30a07d
HR
1178 [ WRITE_SAME_10 ] = "WRITE_SAME_10",
1179 [ UNMAP ] = "UNMAP",
ec766865 1180 [ READ_TOC ] = "READ_TOC",
5e30a07d
HR
1181 [ REPORT_DENSITY_SUPPORT ] = "REPORT_DENSITY_SUPPORT",
1182 [ GET_CONFIGURATION ] = "GET_CONFIGURATION",
ec766865
GH
1183 [ LOG_SELECT ] = "LOG_SELECT",
1184 [ LOG_SENSE ] = "LOG_SENSE",
1185 [ MODE_SELECT_10 ] = "MODE_SELECT_10",
1186 [ RESERVE_10 ] = "RESERVE_10",
1187 [ RELEASE_10 ] = "RELEASE_10",
1188 [ MODE_SENSE_10 ] = "MODE_SENSE_10",
1189 [ PERSISTENT_RESERVE_IN ] = "PERSISTENT_RESERVE_IN",
1190 [ PERSISTENT_RESERVE_OUT ] = "PERSISTENT_RESERVE_OUT",
5e30a07d
HR
1191 [ WRITE_FILEMARKS_16 ] = "WRITE_FILEMARKS_16",
1192 [ EXTENDED_COPY ] = "EXTENDED_COPY",
1193 [ ATA_PASSTHROUGH ] = "ATA_PASSTHROUGH",
1194 [ ACCESS_CONTROL_IN ] = "ACCESS_CONTROL_IN",
1195 [ ACCESS_CONTROL_OUT ] = "ACCESS_CONTROL_OUT",
1196 [ READ_16 ] = "READ_16",
1197 [ COMPARE_AND_WRITE ] = "COMPARE_AND_WRITE",
1198 [ WRITE_16 ] = "WRITE_16",
1199 [ WRITE_VERIFY_16 ] = "WRITE_VERIFY_16",
1200 [ VERIFY_16 ] = "VERIFY_16",
00a01ad4
PB
1201 [ PRE_FETCH_16 ] = "PRE_FETCH_16",
1202 [ SYNCHRONIZE_CACHE_16 ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1203 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
5e30a07d 1204 [ LOCATE_16 ] = "LOCATE_16",
00a01ad4 1205 [ WRITE_SAME_16 ] = "ERASE_16/WRITE_SAME_16",
48bb9f53 1206 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
f6515262 1207 [ SERVICE_ACTION_IN_16 ] = "SERVICE_ACTION_IN_16",
5e30a07d
HR
1208 [ WRITE_LONG_16 ] = "WRITE_LONG_16",
1209 [ REPORT_LUNS ] = "REPORT_LUNS",
1210 [ BLANK ] = "BLANK",
ec766865 1211 [ MOVE_MEDIUM ] = "MOVE_MEDIUM",
5e30a07d 1212 [ LOAD_UNLOAD ] = "LOAD_UNLOAD",
ec766865
GH
1213 [ READ_12 ] = "READ_12",
1214 [ WRITE_12 ] = "WRITE_12",
00a01ad4
PB
1215 [ ERASE_12 ] = "ERASE_12/GET_PERFORMANCE",
1216 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
f6515262 1217 [ SERVICE_ACTION_IN_12 ] = "SERVICE_ACTION_IN_12",
ec766865 1218 [ WRITE_VERIFY_12 ] = "WRITE_VERIFY_12",
5e30a07d 1219 [ VERIFY_12 ] = "VERIFY_12",
ec766865
GH
1220 [ SEARCH_HIGH_12 ] = "SEARCH_HIGH_12",
1221 [ SEARCH_EQUAL_12 ] = "SEARCH_EQUAL_12",
1222 [ SEARCH_LOW_12 ] = "SEARCH_LOW_12",
1223 [ READ_ELEMENT_STATUS ] = "READ_ELEMENT_STATUS",
00a01ad4
PB
1224 [ SEND_VOLUME_TAG ] = "SEND_VOLUME_TAG/SET_STREAMING",
1225 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1226 [ READ_CD ] = "READ_CD",
5e30a07d 1227 [ READ_DEFECT_DATA_12 ] = "READ_DEFECT_DATA_12",
00a01ad4
PB
1228 [ READ_DVD_STRUCTURE ] = "READ_DVD_STRUCTURE",
1229 [ RESERVE_TRACK ] = "RESERVE_TRACK",
1230 [ SEND_CUE_SHEET ] = "SEND_CUE_SHEET",
1231 [ SEND_DVD_STRUCTURE ] = "SEND_DVD_STRUCTURE",
ec766865 1232 [ SET_CD_SPEED ] = "SET_CD_SPEED",
00a01ad4
PB
1233 [ SET_READ_AHEAD ] = "SET_READ_AHEAD",
1234 [ ALLOW_OVERWRITE ] = "ALLOW_OVERWRITE",
1235 [ MECHANISM_STATUS ] = "MECHANISM_STATUS",
ec766865
GH
1236 };
1237
1238 if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1239 return "*UNKNOWN*";
1240 return names[cmd];
1241}
1242
ad2d30f7
PB
1243SCSIRequest *scsi_req_ref(SCSIRequest *req)
1244{
1245 req->refcount++;
1246 return req;
1247}
1248
1249void scsi_req_unref(SCSIRequest *req)
1250{
1251 if (--req->refcount == 0) {
12010e7b
PB
1252 if (req->ops->free_req) {
1253 req->ops->free_req(req);
ad2d30f7 1254 }
7267c094 1255 g_free(req);
ad2d30f7
PB
1256 }
1257}
1258
ad3376cc
PB
1259/* Tell the device that we finished processing this chunk of I/O. It
1260 will start the next chunk or complete the command. */
1261void scsi_req_continue(SCSIRequest *req)
1262{
1263 trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1264 if (req->cmd.mode == SCSI_XFER_TO_DEV) {
12010e7b 1265 req->ops->write_data(req);
ad3376cc 1266 } else {
12010e7b 1267 req->ops->read_data(req);
ad3376cc
PB
1268 }
1269}
1270
ab9adc88
PB
1271/* Called by the devices when data is ready for the HBA. The HBA should
1272 start a DMA operation to read or fill the device's data buffer.
ad3376cc 1273 Once it completes, calling scsi_req_continue will restart I/O. */
ab9adc88
PB
1274void scsi_req_data(SCSIRequest *req, int len)
1275{
e88c591d
PB
1276 if (req->io_canceled) {
1277 trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
1278 } else {
1279 trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1280 req->bus->info->transfer_data(req, len);
1281 }
ab9adc88
PB
1282}
1283
ec766865
GH
1284void scsi_req_print(SCSIRequest *req)
1285{
1286 FILE *fp = stderr;
1287 int i;
1288
1289 fprintf(fp, "[%s id=%d] %s",
1290 req->dev->qdev.parent_bus->name,
1291 req->dev->id,
1292 scsi_command_name(req->cmd.buf[0]));
1293 for (i = 1; i < req->cmd.len; i++) {
1294 fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1295 }
1296 switch (req->cmd.mode) {
1297 case SCSI_XFER_NONE:
1298 fprintf(fp, " - none\n");
1299 break;
1300 case SCSI_XFER_FROM_DEV:
1301 fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1302 break;
1303 case SCSI_XFER_TO_DEV:
1304 fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1305 break;
1306 default:
1307 fprintf(fp, " - Oops\n");
1308 break;
1309 }
1310}
1311
682a9b21 1312void scsi_req_complete(SCSIRequest *req, int status)
ed3a34a3 1313{
682a9b21
PB
1314 assert(req->status == -1);
1315 req->status = status;
b45ef674
PB
1316
1317 assert(req->sense_len < sizeof(req->sense));
1318 if (status == GOOD) {
1319 req->sense_len = 0;
1320 }
1321
1322 if (req->sense_len) {
1323 memcpy(req->dev->sense, req->sense, req->sense_len);
3653d8c4
PB
1324 req->dev->sense_len = req->sense_len;
1325 req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1326 } else {
1327 req->dev->sense_len = 0;
1328 req->dev->sense_is_ua = false;
b45ef674 1329 }
b45ef674 1330
6dc06f08
PB
1331 /*
1332 * Unit attention state is now stored in the device's sense buffer
1333 * if the HBA didn't do autosense. Clear the pending unit attention
1334 * flags.
1335 */
1336 scsi_clear_unit_attention(req);
1337
ad2d30f7 1338 scsi_req_ref(req);
e8637c90 1339 scsi_req_dequeue(req);
afd4030c 1340 req->bus->info->complete(req, req->status);
ad2d30f7 1341 scsi_req_unref(req);
ed3a34a3 1342}
db07c0f8 1343
94d3f98a
PB
1344void scsi_req_cancel(SCSIRequest *req)
1345{
e88c591d
PB
1346 if (!req->enqueued) {
1347 return;
94d3f98a
PB
1348 }
1349 scsi_req_ref(req);
1350 scsi_req_dequeue(req);
e88c591d
PB
1351 req->io_canceled = true;
1352 if (req->ops->cancel_io) {
1353 req->ops->cancel_io(req);
1354 }
afd4030c
PB
1355 if (req->bus->info->cancel) {
1356 req->bus->info->cancel(req);
94d3f98a
PB
1357 }
1358 scsi_req_unref(req);
1359}
1360
19d110ab
PB
1361void scsi_req_abort(SCSIRequest *req, int status)
1362{
e88c591d
PB
1363 if (!req->enqueued) {
1364 return;
1365 }
1366 scsi_req_ref(req);
1367 scsi_req_dequeue(req);
1368 req->io_canceled = true;
12010e7b
PB
1369 if (req->ops->cancel_io) {
1370 req->ops->cancel_io(req);
19d110ab 1371 }
682a9b21 1372 scsi_req_complete(req, status);
e88c591d 1373 scsi_req_unref(req);
19d110ab
PB
1374}
1375
c7b48872 1376void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
c557e889
PB
1377{
1378 SCSIRequest *req;
1379
1380 while (!QTAILQ_EMPTY(&sdev->requests)) {
1381 req = QTAILQ_FIRST(&sdev->requests);
94d3f98a 1382 scsi_req_cancel(req);
c557e889 1383 }
c7b48872 1384 sdev->unit_attention = sense;
c557e889
PB
1385}
1386
db07c0f8
GN
1387static char *scsibus_get_fw_dev_path(DeviceState *dev)
1388{
b9eea3e6 1389 SCSIDevice *d = SCSI_DEVICE(dev);
db07c0f8 1390 char path[100];
db07c0f8 1391
795928f6
PB
1392 snprintf(path, sizeof(path), "channel@%x/%s@%x,%x", d->channel,
1393 qdev_fw_name(dev), d->id, d->lun);
db07c0f8 1394
f48a7a6e
PB
1395 return strdup(path);
1396}
1397
0d3545e7 1398SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
f48a7a6e
PB
1399{
1400 DeviceState *qdev;
1401 SCSIDevice *target_dev = NULL;
db07c0f8 1402
f48a7a6e 1403 QTAILQ_FOREACH_REVERSE(qdev, &bus->qbus.children, ChildrenHead, sibling) {
b9eea3e6 1404 SCSIDevice *dev = SCSI_DEVICE(qdev);
db07c0f8 1405
0d3545e7 1406 if (dev->channel == channel && dev->id == id) {
f48a7a6e
PB
1407 if (dev->lun == lun) {
1408 return dev;
1409 }
1410 target_dev = dev;
1411 }
1412 }
1413 return target_dev;
db07c0f8 1414}
b9eea3e6 1415
39bffca2
AL
1416static void scsi_device_class_init(ObjectClass *klass, void *data)
1417{
1418 DeviceClass *k = DEVICE_CLASS(klass);
1419 k->bus_info = &scsi_bus_info;
1420 k->init = scsi_qdev_init;
1421 k->unplug = qdev_simple_unplug_cb;
1422 k->exit = scsi_qdev_exit;
1423}
1424
b9eea3e6
AL
1425static TypeInfo scsi_device_type_info = {
1426 .name = TYPE_SCSI_DEVICE,
1427 .parent = TYPE_DEVICE,
1428 .instance_size = sizeof(SCSIDevice),
1429 .abstract = true,
1430 .class_size = sizeof(SCSIDeviceClass),
39bffca2 1431 .class_init = scsi_device_class_init,
b9eea3e6
AL
1432};
1433
83f7d43a 1434static void scsi_register_types(void)
b9eea3e6
AL
1435{
1436 type_register_static(&scsi_device_type_info);
1437}
1438
83f7d43a 1439type_init(scsi_register_types)