]> git.proxmox.com Git - mirror_qemu.git/blame - hw/scsi-bus.c
scsi: pass residual amount to command_complete
[mirror_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;
01e95455
PB
536 req->resid = req->cmd.xfer;
537
98254542
PB
538 switch (buf[0]) {
539 case INQUIRY:
540 trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
541 break;
542 case TEST_UNIT_READY:
543 trace_scsi_test_unit_ready(d->id, lun, tag);
544 break;
545 case REPORT_LUNS:
546 trace_scsi_report_luns(d->id, lun, tag);
547 break;
548 case REQUEST_SENSE:
549 trace_scsi_request_sense(d->id, lun, tag);
550 break;
551 default:
552 break;
553 }
554
c39ce112 555 return req;
43a2b339
PB
556}
557
0c34459b
PB
558uint8_t *scsi_req_get_buf(SCSIRequest *req)
559{
12010e7b 560 return req->ops->get_buf(req);
0c34459b
PB
561}
562
6dc06f08
PB
563static void scsi_clear_unit_attention(SCSIRequest *req)
564{
565 SCSISense *ua;
566 if (req->dev->unit_attention.key != UNIT_ATTENTION &&
567 req->bus->unit_attention.key != UNIT_ATTENTION) {
568 return;
569 }
570
571 /*
572 * If an INQUIRY command enters the enabled command state,
573 * the device server shall [not] clear any unit attention condition;
574 * See also MMC-6, paragraphs 6.5 and 6.6.2.
575 */
576 if (req->cmd.buf[0] == INQUIRY ||
577 req->cmd.buf[0] == GET_CONFIGURATION ||
578 req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
579 return;
580 }
581
582 if (req->dev->unit_attention.key == UNIT_ATTENTION) {
583 ua = &req->dev->unit_attention;
584 } else {
585 ua = &req->bus->unit_attention;
586 }
587
588 /*
589 * If a REPORT LUNS command enters the enabled command state, [...]
590 * the device server shall clear any pending unit attention condition
591 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
592 */
593 if (req->cmd.buf[0] == REPORT_LUNS &&
594 !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
595 ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
596 return;
597 }
598
599 *ua = SENSE_CODE(NO_SENSE);
600}
601
74382217
HR
602int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
603{
6dc06f08
PB
604 int ret;
605
b45ef674
PB
606 assert(len >= 14);
607 if (!req->sense_len) {
74382217
HR
608 return 0;
609 }
6dc06f08
PB
610
611 ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
612
613 /*
614 * FIXME: clearing unit attention conditions upon autosense should be done
615 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
616 * (SAM-5, 5.14).
617 *
618 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
619 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
3653d8c4 620 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
6dc06f08 621 */
3653d8c4 622 if (req->dev->sense_is_ua) {
b9eea3e6 623 scsi_device_unit_attention_reported(req->dev);
3653d8c4
PB
624 req->dev->sense_len = 0;
625 req->dev->sense_is_ua = false;
626 }
6dc06f08 627 return ret;
b45ef674
PB
628}
629
630int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
631{
632 return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
633}
634
635void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
636{
637 trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
638 sense.key, sense.asc, sense.ascq);
639 memset(req->sense, 0, 18);
640 req->sense[0] = 0xf0;
641 req->sense[2] = sense.key;
eae31cb9 642 req->sense[7] = 10;
b45ef674
PB
643 req->sense[12] = sense.asc;
644 req->sense[13] = sense.ascq;
645 req->sense_len = 18;
74382217
HR
646}
647
c39ce112 648int32_t scsi_req_enqueue(SCSIRequest *req)
89b08ae1 649{
fc4f0754
PB
650 int32_t rc;
651
5c6c0e51
HR
652 assert(!req->enqueued);
653 scsi_req_ref(req);
654 req->enqueued = true;
655 QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
fc4f0754
PB
656
657 scsi_req_ref(req);
c39ce112 658 rc = req->ops->send_command(req, req->cmd.buf);
fc4f0754
PB
659 scsi_req_unref(req);
660 return rc;
89b08ae1
GH
661}
662
a1f0cce2 663static void scsi_req_dequeue(SCSIRequest *req)
e8637c90 664{
5138efec 665 trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
71544d30 666 req->retry = false;
e8637c90
JK
667 if (req->enqueued) {
668 QTAILQ_REMOVE(&req->dev->requests, req, next);
669 req->enqueued = false;
ad2d30f7 670 scsi_req_unref(req);
e8637c90
JK
671 }
672}
673
06b86357
PB
674static int scsi_get_performance_length(int num_desc, int type, int data_type)
675{
676 /* MMC-6, paragraph 6.7. */
677 switch (type) {
678 case 0:
679 if ((data_type & 3) == 0) {
680 /* Each descriptor is as in Table 295 - Nominal performance. */
681 return 16 * num_desc + 8;
682 } else {
683 /* Each descriptor is as in Table 296 - Exceptions. */
684 return 6 * num_desc + 8;
685 }
686 case 1:
687 case 4:
688 case 5:
689 return 8 * num_desc + 8;
690 case 2:
691 return 2048 * num_desc + 8;
692 case 3:
693 return 16 * num_desc + 8;
694 default:
695 return 8;
696 }
697}
698
2599aece 699static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
2ec749cb 700{
2599aece 701 switch (buf[0] >> 5) {
2ec749cb 702 case 0:
2599aece
PB
703 cmd->xfer = buf[4];
704 cmd->len = 6;
2ec749cb 705 /* length 0 means 256 blocks */
2599aece
PB
706 if (cmd->xfer == 0) {
707 cmd->xfer = 256;
708 }
2ec749cb
GH
709 break;
710 case 1:
711 case 2:
bd5da232 712 cmd->xfer = lduw_be_p(&buf[7]);
2599aece 713 cmd->len = 10;
2ec749cb
GH
714 break;
715 case 4:
06b86357 716 cmd->xfer = ldl_be_p(&buf[10]) & 0xffffffffULL;
2599aece 717 cmd->len = 16;
2ec749cb
GH
718 break;
719 case 5:
06b86357 720 cmd->xfer = ldl_be_p(&buf[6]) & 0xffffffffULL;
2599aece 721 cmd->len = 12;
2ec749cb
GH
722 break;
723 default:
724 return -1;
725 }
726
2599aece 727 switch (buf[0]) {
2ec749cb 728 case TEST_UNIT_READY:
5e30a07d 729 case REWIND:
2ec749cb 730 case START_STOP:
00a01ad4 731 case SET_CAPACITY:
2ec749cb 732 case WRITE_FILEMARKS:
06b86357 733 case WRITE_FILEMARKS_16:
2ec749cb 734 case SPACE:
a5e3d9ef
BK
735 case RESERVE:
736 case RELEASE:
2ec749cb
GH
737 case ERASE:
738 case ALLOW_MEDIUM_REMOVAL:
5e30a07d 739 case VERIFY_10:
2ec749cb
GH
740 case SEEK_10:
741 case SYNCHRONIZE_CACHE:
06b86357
PB
742 case SYNCHRONIZE_CACHE_16:
743 case LOCATE_16:
2ec749cb
GH
744 case LOCK_UNLOCK_CACHE:
745 case LOAD_UNLOAD:
746 case SET_CD_SPEED:
747 case SET_LIMITS:
5e30a07d 748 case WRITE_LONG_10:
2ec749cb
GH
749 case MOVE_MEDIUM:
750 case UPDATE_BLOCK:
06b86357
PB
751 case RESERVE_TRACK:
752 case SET_READ_AHEAD:
753 case PRE_FETCH:
754 case PRE_FETCH_16:
755 case ALLOW_OVERWRITE:
2599aece 756 cmd->xfer = 0;
2ec749cb
GH
757 break;
758 case MODE_SENSE:
759 break;
5e30a07d 760 case WRITE_SAME_10:
2599aece 761 cmd->xfer = 1;
2ec749cb 762 break;
5e30a07d 763 case READ_CAPACITY_10:
2599aece 764 cmd->xfer = 8;
2ec749cb
GH
765 break;
766 case READ_BLOCK_LIMITS:
2599aece 767 cmd->xfer = 6;
2ec749cb 768 break;
2ec749cb 769 case SEND_VOLUME_TAG:
06b86357
PB
770 /* GPCMD_SET_STREAMING from multimedia commands. */
771 if (dev->type == TYPE_ROM) {
772 cmd->xfer = buf[10] | (buf[9] << 8);
773 } else {
774 cmd->xfer = buf[9] | (buf[8] << 8);
775 }
2ec749cb
GH
776 break;
777 case WRITE_10:
5e30a07d 778 case WRITE_VERIFY_10:
2ec749cb
GH
779 case WRITE_6:
780 case WRITE_12:
781 case WRITE_VERIFY_12:
bd536cf3
GH
782 case WRITE_16:
783 case WRITE_VERIFY_16:
2599aece 784 cmd->xfer *= dev->blocksize;
2ec749cb
GH
785 break;
786 case READ_10:
787 case READ_6:
788 case READ_REVERSE:
789 case RECOVER_BUFFERED_DATA:
790 case READ_12:
bd536cf3 791 case READ_16:
2599aece 792 cmd->xfer *= dev->blocksize;
2ec749cb 793 break;
06b86357
PB
794 case FORMAT_UNIT:
795 /* MMC mandates the parameter list to be 12-bytes long. Parameters
796 * for block devices are restricted to the header right now. */
797 if (dev->type == TYPE_ROM && (buf[1] & 16)) {
798 cmd->xfer = 12;
799 } else {
800 cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
801 }
802 break;
2ec749cb 803 case INQUIRY:
06b86357
PB
804 case RECEIVE_DIAGNOSTIC:
805 case SEND_DIAGNOSTIC:
2599aece 806 cmd->xfer = buf[4] | (buf[3] << 8);
2ec749cb 807 break;
06b86357
PB
808 case READ_CD:
809 case READ_BUFFER:
810 case WRITE_BUFFER:
811 case SEND_CUE_SHEET:
812 cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
813 break;
814 case PERSISTENT_RESERVE_OUT:
815 cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
816 break;
817 case ERASE_12:
818 if (dev->type == TYPE_ROM) {
819 /* MMC command GET PERFORMANCE. */
820 cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
821 buf[10], buf[1] & 0x1f);
822 }
823 break;
824 case MECHANISM_STATUS:
825 case READ_DVD_STRUCTURE:
826 case SEND_DVD_STRUCTURE:
c7126d5b
NB
827 case MAINTENANCE_OUT:
828 case MAINTENANCE_IN:
2599aece 829 if (dev->type == TYPE_ROM) {
c7126d5b 830 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
2599aece 831 cmd->xfer = buf[9] | (buf[8] << 8);
c7126d5b
NB
832 }
833 break;
2ec749cb
GH
834 }
835 return 0;
836}
837
2599aece 838static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
2ec749cb 839{
2599aece 840 switch (buf[0]) {
2ec749cb 841 /* stream commands */
06b86357
PB
842 case ERASE_12:
843 case ERASE_16:
844 cmd->xfer = 0;
845 break;
2ec749cb
GH
846 case READ_6:
847 case READ_REVERSE:
848 case RECOVER_BUFFERED_DATA:
849 case WRITE_6:
2599aece
PB
850 cmd->len = 6;
851 cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
852 if (buf[1] & 0x01) { /* fixed */
853 cmd->xfer *= dev->blocksize;
854 }
2ec749cb
GH
855 break;
856 case REWIND:
857 case START_STOP:
2599aece
PB
858 cmd->len = 6;
859 cmd->xfer = 0;
2ec749cb 860 break;
06b86357
PB
861 case SPACE_16:
862 cmd->xfer = buf[13] | (buf[12] << 8);
863 break;
864 case READ_POSITION:
865 cmd->xfer = buf[8] | (buf[7] << 8);
866 break;
867 case FORMAT_UNIT:
868 cmd->xfer = buf[4] | (buf[3] << 8);
869 break;
2ec749cb
GH
870 /* generic commands */
871 default:
2599aece 872 return scsi_req_length(cmd, dev, buf);
2ec749cb
GH
873 }
874 return 0;
875}
876
2599aece 877static void scsi_cmd_xfer_mode(SCSICommand *cmd)
97a06435 878{
2599aece 879 switch (cmd->buf[0]) {
97a06435
GH
880 case WRITE_6:
881 case WRITE_10:
5e30a07d 882 case WRITE_VERIFY_10:
97a06435
GH
883 case WRITE_12:
884 case WRITE_VERIFY_12:
bd536cf3
GH
885 case WRITE_16:
886 case WRITE_VERIFY_16:
97a06435
GH
887 case COPY:
888 case COPY_VERIFY:
889 case COMPARE:
890 case CHANGE_DEFINITION:
891 case LOG_SELECT:
892 case MODE_SELECT:
893 case MODE_SELECT_10:
894 case SEND_DIAGNOSTIC:
895 case WRITE_BUFFER:
896 case FORMAT_UNIT:
897 case REASSIGN_BLOCKS:
97a06435
GH
898 case SEARCH_EQUAL:
899 case SEARCH_HIGH:
900 case SEARCH_LOW:
901 case UPDATE_BLOCK:
5e30a07d
HR
902 case WRITE_LONG_10:
903 case WRITE_SAME_10:
97a06435
GH
904 case SEARCH_HIGH_12:
905 case SEARCH_EQUAL_12:
906 case SEARCH_LOW_12:
97a06435
GH
907 case MEDIUM_SCAN:
908 case SEND_VOLUME_TAG:
06b86357
PB
909 case SEND_CUE_SHEET:
910 case SEND_DVD_STRUCTURE:
01bedeba 911 case PERSISTENT_RESERVE_OUT:
c7126d5b 912 case MAINTENANCE_OUT:
2599aece 913 cmd->mode = SCSI_XFER_TO_DEV;
97a06435
GH
914 break;
915 default:
2599aece
PB
916 if (cmd->xfer)
917 cmd->mode = SCSI_XFER_FROM_DEV;
97a06435 918 else {
2599aece 919 cmd->mode = SCSI_XFER_NONE;
97a06435
GH
920 }
921 break;
922 }
923}
924
2599aece 925static uint64_t scsi_cmd_lba(SCSICommand *cmd)
2ec749cb 926{
2599aece 927 uint8_t *buf = cmd->buf;
2ec749cb
GH
928 uint64_t lba;
929
930 switch (buf[0] >> 5) {
931 case 0:
bd5da232 932 lba = ldl_be_p(&buf[0]) & 0x1fffff;
2ec749cb
GH
933 break;
934 case 1:
935 case 2:
bd5da232 936 case 5:
06b86357 937 lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
2ec749cb
GH
938 break;
939 case 4:
bd5da232 940 lba = ldq_be_p(&buf[2]);
2ec749cb
GH
941 break;
942 default:
943 lba = -1;
944
945 }
946 return lba;
947}
948
afa46c46 949int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
2ec749cb
GH
950{
951 int rc;
952
afa46c46
PB
953 if (dev->type == TYPE_TAPE) {
954 rc = scsi_req_stream_length(cmd, dev, buf);
2ec749cb 955 } else {
afa46c46 956 rc = scsi_req_length(cmd, dev, buf);
2ec749cb
GH
957 }
958 if (rc != 0)
959 return rc;
960
afa46c46
PB
961 memcpy(cmd->buf, buf, cmd->len);
962 scsi_cmd_xfer_mode(cmd);
963 cmd->lba = scsi_cmd_lba(cmd);
2ec749cb
GH
964 return 0;
965}
ed3a34a3 966
a1f0cce2
HR
967/*
968 * Predefined sense codes
969 */
970
971/* No sense data available */
972const struct SCSISense sense_code_NO_SENSE = {
973 .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
974};
975
976/* LUN not ready, Manual intervention required */
977const struct SCSISense sense_code_LUN_NOT_READY = {
978 .key = NOT_READY, .asc = 0x04, .ascq = 0x03
979};
980
981/* LUN not ready, Medium not present */
982const struct SCSISense sense_code_NO_MEDIUM = {
983 .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
984};
985
68bb01f3
MA
986/* LUN not ready, medium removal prevented */
987const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
988 .key = NOT_READY, .asc = 0x53, .ascq = 0x00
989};
990
a1f0cce2
HR
991/* Hardware error, internal target failure */
992const struct SCSISense sense_code_TARGET_FAILURE = {
993 .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
994};
995
996/* Illegal request, invalid command operation code */
997const struct SCSISense sense_code_INVALID_OPCODE = {
998 .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
999};
1000
1001/* Illegal request, LBA out of range */
1002const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1003 .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1004};
1005
1006/* Illegal request, Invalid field in CDB */
1007const struct SCSISense sense_code_INVALID_FIELD = {
1008 .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1009};
1010
1011/* Illegal request, LUN not supported */
1012const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1013 .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1014};
1015
a872a304
PB
1016/* Illegal request, Saving parameters not supported */
1017const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1018 .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1019};
1020
1021/* Illegal request, Incompatible medium installed */
67cc61e4 1022const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
a872a304
PB
1023 .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1024};
1025
68bb01f3
MA
1026/* Illegal request, medium removal prevented */
1027const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1028 .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x00
1029};
1030
a1f0cce2
HR
1031/* Command aborted, I/O process terminated */
1032const struct SCSISense sense_code_IO_ERROR = {
1033 .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1034};
1035
1036/* Command aborted, I_T Nexus loss occurred */
1037const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1038 .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1039};
1040
1041/* Command aborted, Logical Unit failure */
1042const struct SCSISense sense_code_LUN_FAILURE = {
1043 .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1044};
1045
a872a304
PB
1046/* Unit attention, Power on, reset or bus device reset occurred */
1047const struct SCSISense sense_code_RESET = {
1048 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1049};
1050
8a9c16f6
PB
1051/* Unit attention, No medium */
1052const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1053 .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1054};
1055
a872a304
PB
1056/* Unit attention, Medium may have changed */
1057const struct SCSISense sense_code_MEDIUM_CHANGED = {
1058 .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1059};
1060
1061/* Unit attention, Reported LUNs data has changed */
1062const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1063 .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1064};
1065
1066/* Unit attention, Device internal reset */
1067const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1068 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1069};
1070
a1f0cce2
HR
1071/*
1072 * scsi_build_sense
1073 *
b45ef674 1074 * Convert between fixed and descriptor sense buffers
a1f0cce2 1075 */
b45ef674
PB
1076int scsi_build_sense(uint8_t *in_buf, int in_len,
1077 uint8_t *buf, int len, bool fixed)
a1f0cce2 1078{
b45ef674
PB
1079 bool fixed_in;
1080 SCSISense sense;
a1f0cce2
HR
1081 if (!fixed && len < 8) {
1082 return 0;
1083 }
1084
b45ef674
PB
1085 if (in_len == 0) {
1086 sense.key = NO_SENSE;
1087 sense.asc = 0;
1088 sense.ascq = 0;
1089 } else {
1090 fixed_in = (in_buf[0] & 2) == 0;
1091
1092 if (fixed == fixed_in) {
1093 memcpy(buf, in_buf, MIN(len, in_len));
1094 return MIN(len, in_len);
1095 }
1096
1097 if (fixed_in) {
1098 sense.key = in_buf[2];
1099 sense.asc = in_buf[12];
1100 sense.ascq = in_buf[13];
1101 } else {
1102 sense.key = in_buf[1];
1103 sense.asc = in_buf[2];
1104 sense.ascq = in_buf[3];
1105 }
1106 }
1107
a1f0cce2
HR
1108 memset(buf, 0, len);
1109 if (fixed) {
1110 /* Return fixed format sense buffer */
1111 buf[0] = 0xf0;
1112 buf[2] = sense.key;
eae31cb9 1113 buf[7] = 10;
a1f0cce2
HR
1114 buf[12] = sense.asc;
1115 buf[13] = sense.ascq;
1116 return MIN(len, 18);
1117 } else {
1118 /* Return descriptor format sense buffer */
1119 buf[0] = 0x72;
1120 buf[1] = sense.key;
1121 buf[2] = sense.asc;
1122 buf[3] = sense.ascq;
1123 return 8;
1124 }
1125}
1126
ec766865
GH
1127static const char *scsi_command_name(uint8_t cmd)
1128{
1129 static const char *names[] = {
1130 [ TEST_UNIT_READY ] = "TEST_UNIT_READY",
5e30a07d 1131 [ REWIND ] = "REWIND",
ec766865
GH
1132 [ REQUEST_SENSE ] = "REQUEST_SENSE",
1133 [ FORMAT_UNIT ] = "FORMAT_UNIT",
1134 [ READ_BLOCK_LIMITS ] = "READ_BLOCK_LIMITS",
1135 [ REASSIGN_BLOCKS ] = "REASSIGN_BLOCKS",
1136 [ READ_6 ] = "READ_6",
1137 [ WRITE_6 ] = "WRITE_6",
00a01ad4 1138 [ SET_CAPACITY ] = "SET_CAPACITY",
ec766865
GH
1139 [ READ_REVERSE ] = "READ_REVERSE",
1140 [ WRITE_FILEMARKS ] = "WRITE_FILEMARKS",
1141 [ SPACE ] = "SPACE",
1142 [ INQUIRY ] = "INQUIRY",
1143 [ RECOVER_BUFFERED_DATA ] = "RECOVER_BUFFERED_DATA",
c7126d5b
NB
1144 [ MAINTENANCE_IN ] = "MAINTENANCE_IN",
1145 [ MAINTENANCE_OUT ] = "MAINTENANCE_OUT",
ec766865
GH
1146 [ MODE_SELECT ] = "MODE_SELECT",
1147 [ RESERVE ] = "RESERVE",
1148 [ RELEASE ] = "RELEASE",
1149 [ COPY ] = "COPY",
1150 [ ERASE ] = "ERASE",
1151 [ MODE_SENSE ] = "MODE_SENSE",
1152 [ START_STOP ] = "START_STOP",
1153 [ RECEIVE_DIAGNOSTIC ] = "RECEIVE_DIAGNOSTIC",
1154 [ SEND_DIAGNOSTIC ] = "SEND_DIAGNOSTIC",
1155 [ ALLOW_MEDIUM_REMOVAL ] = "ALLOW_MEDIUM_REMOVAL",
5e30a07d 1156 [ READ_CAPACITY_10 ] = "READ_CAPACITY_10",
ec766865
GH
1157 [ READ_10 ] = "READ_10",
1158 [ WRITE_10 ] = "WRITE_10",
1159 [ SEEK_10 ] = "SEEK_10",
5e30a07d
HR
1160 [ WRITE_VERIFY_10 ] = "WRITE_VERIFY_10",
1161 [ VERIFY_10 ] = "VERIFY_10",
ec766865
GH
1162 [ SEARCH_HIGH ] = "SEARCH_HIGH",
1163 [ SEARCH_EQUAL ] = "SEARCH_EQUAL",
1164 [ SEARCH_LOW ] = "SEARCH_LOW",
1165 [ SET_LIMITS ] = "SET_LIMITS",
00a01ad4 1166 [ PRE_FETCH ] = "PRE_FETCH/READ_POSITION",
545557d4 1167 /* READ_POSITION and PRE_FETCH use the same operation code */
ec766865
GH
1168 [ SYNCHRONIZE_CACHE ] = "SYNCHRONIZE_CACHE",
1169 [ LOCK_UNLOCK_CACHE ] = "LOCK_UNLOCK_CACHE",
1170 [ READ_DEFECT_DATA ] = "READ_DEFECT_DATA",
1171 [ MEDIUM_SCAN ] = "MEDIUM_SCAN",
1172 [ COMPARE ] = "COMPARE",
1173 [ COPY_VERIFY ] = "COPY_VERIFY",
1174 [ WRITE_BUFFER ] = "WRITE_BUFFER",
1175 [ READ_BUFFER ] = "READ_BUFFER",
1176 [ UPDATE_BLOCK ] = "UPDATE_BLOCK",
5e30a07d
HR
1177 [ READ_LONG_10 ] = "READ_LONG_10",
1178 [ WRITE_LONG_10 ] = "WRITE_LONG_10",
ec766865 1179 [ CHANGE_DEFINITION ] = "CHANGE_DEFINITION",
5e30a07d
HR
1180 [ WRITE_SAME_10 ] = "WRITE_SAME_10",
1181 [ UNMAP ] = "UNMAP",
ec766865 1182 [ READ_TOC ] = "READ_TOC",
5e30a07d
HR
1183 [ REPORT_DENSITY_SUPPORT ] = "REPORT_DENSITY_SUPPORT",
1184 [ GET_CONFIGURATION ] = "GET_CONFIGURATION",
ec766865
GH
1185 [ LOG_SELECT ] = "LOG_SELECT",
1186 [ LOG_SENSE ] = "LOG_SENSE",
1187 [ MODE_SELECT_10 ] = "MODE_SELECT_10",
1188 [ RESERVE_10 ] = "RESERVE_10",
1189 [ RELEASE_10 ] = "RELEASE_10",
1190 [ MODE_SENSE_10 ] = "MODE_SENSE_10",
1191 [ PERSISTENT_RESERVE_IN ] = "PERSISTENT_RESERVE_IN",
1192 [ PERSISTENT_RESERVE_OUT ] = "PERSISTENT_RESERVE_OUT",
5e30a07d
HR
1193 [ WRITE_FILEMARKS_16 ] = "WRITE_FILEMARKS_16",
1194 [ EXTENDED_COPY ] = "EXTENDED_COPY",
1195 [ ATA_PASSTHROUGH ] = "ATA_PASSTHROUGH",
1196 [ ACCESS_CONTROL_IN ] = "ACCESS_CONTROL_IN",
1197 [ ACCESS_CONTROL_OUT ] = "ACCESS_CONTROL_OUT",
1198 [ READ_16 ] = "READ_16",
1199 [ COMPARE_AND_WRITE ] = "COMPARE_AND_WRITE",
1200 [ WRITE_16 ] = "WRITE_16",
1201 [ WRITE_VERIFY_16 ] = "WRITE_VERIFY_16",
1202 [ VERIFY_16 ] = "VERIFY_16",
00a01ad4
PB
1203 [ PRE_FETCH_16 ] = "PRE_FETCH_16",
1204 [ SYNCHRONIZE_CACHE_16 ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1205 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
5e30a07d 1206 [ LOCATE_16 ] = "LOCATE_16",
00a01ad4 1207 [ WRITE_SAME_16 ] = "ERASE_16/WRITE_SAME_16",
48bb9f53 1208 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
f6515262 1209 [ SERVICE_ACTION_IN_16 ] = "SERVICE_ACTION_IN_16",
5e30a07d
HR
1210 [ WRITE_LONG_16 ] = "WRITE_LONG_16",
1211 [ REPORT_LUNS ] = "REPORT_LUNS",
1212 [ BLANK ] = "BLANK",
ec766865 1213 [ MOVE_MEDIUM ] = "MOVE_MEDIUM",
5e30a07d 1214 [ LOAD_UNLOAD ] = "LOAD_UNLOAD",
ec766865
GH
1215 [ READ_12 ] = "READ_12",
1216 [ WRITE_12 ] = "WRITE_12",
00a01ad4
PB
1217 [ ERASE_12 ] = "ERASE_12/GET_PERFORMANCE",
1218 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
f6515262 1219 [ SERVICE_ACTION_IN_12 ] = "SERVICE_ACTION_IN_12",
ec766865 1220 [ WRITE_VERIFY_12 ] = "WRITE_VERIFY_12",
5e30a07d 1221 [ VERIFY_12 ] = "VERIFY_12",
ec766865
GH
1222 [ SEARCH_HIGH_12 ] = "SEARCH_HIGH_12",
1223 [ SEARCH_EQUAL_12 ] = "SEARCH_EQUAL_12",
1224 [ SEARCH_LOW_12 ] = "SEARCH_LOW_12",
1225 [ READ_ELEMENT_STATUS ] = "READ_ELEMENT_STATUS",
00a01ad4
PB
1226 [ SEND_VOLUME_TAG ] = "SEND_VOLUME_TAG/SET_STREAMING",
1227 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1228 [ READ_CD ] = "READ_CD",
5e30a07d 1229 [ READ_DEFECT_DATA_12 ] = "READ_DEFECT_DATA_12",
00a01ad4
PB
1230 [ READ_DVD_STRUCTURE ] = "READ_DVD_STRUCTURE",
1231 [ RESERVE_TRACK ] = "RESERVE_TRACK",
1232 [ SEND_CUE_SHEET ] = "SEND_CUE_SHEET",
1233 [ SEND_DVD_STRUCTURE ] = "SEND_DVD_STRUCTURE",
ec766865 1234 [ SET_CD_SPEED ] = "SET_CD_SPEED",
00a01ad4
PB
1235 [ SET_READ_AHEAD ] = "SET_READ_AHEAD",
1236 [ ALLOW_OVERWRITE ] = "ALLOW_OVERWRITE",
1237 [ MECHANISM_STATUS ] = "MECHANISM_STATUS",
ec766865
GH
1238 };
1239
1240 if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1241 return "*UNKNOWN*";
1242 return names[cmd];
1243}
1244
ad2d30f7
PB
1245SCSIRequest *scsi_req_ref(SCSIRequest *req)
1246{
1247 req->refcount++;
1248 return req;
1249}
1250
1251void scsi_req_unref(SCSIRequest *req)
1252{
1253 if (--req->refcount == 0) {
12010e7b
PB
1254 if (req->ops->free_req) {
1255 req->ops->free_req(req);
ad2d30f7 1256 }
7267c094 1257 g_free(req);
ad2d30f7
PB
1258 }
1259}
1260
ad3376cc
PB
1261/* Tell the device that we finished processing this chunk of I/O. It
1262 will start the next chunk or complete the command. */
1263void scsi_req_continue(SCSIRequest *req)
1264{
1265 trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1266 if (req->cmd.mode == SCSI_XFER_TO_DEV) {
12010e7b 1267 req->ops->write_data(req);
ad3376cc 1268 } else {
12010e7b 1269 req->ops->read_data(req);
ad3376cc
PB
1270 }
1271}
1272
ab9adc88
PB
1273/* Called by the devices when data is ready for the HBA. The HBA should
1274 start a DMA operation to read or fill the device's data buffer.
ad3376cc 1275 Once it completes, calling scsi_req_continue will restart I/O. */
ab9adc88
PB
1276void scsi_req_data(SCSIRequest *req, int len)
1277{
e88c591d
PB
1278 if (req->io_canceled) {
1279 trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
01e95455 1280 return;
e88c591d 1281 }
01e95455
PB
1282 trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1283 assert(req->cmd.mode != SCSI_XFER_NONE);
1284 req->resid -= len;
1285 req->bus->info->transfer_data(req, len);
ab9adc88
PB
1286}
1287
ec766865
GH
1288void scsi_req_print(SCSIRequest *req)
1289{
1290 FILE *fp = stderr;
1291 int i;
1292
1293 fprintf(fp, "[%s id=%d] %s",
1294 req->dev->qdev.parent_bus->name,
1295 req->dev->id,
1296 scsi_command_name(req->cmd.buf[0]));
1297 for (i = 1; i < req->cmd.len; i++) {
1298 fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1299 }
1300 switch (req->cmd.mode) {
1301 case SCSI_XFER_NONE:
1302 fprintf(fp, " - none\n");
1303 break;
1304 case SCSI_XFER_FROM_DEV:
1305 fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1306 break;
1307 case SCSI_XFER_TO_DEV:
1308 fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1309 break;
1310 default:
1311 fprintf(fp, " - Oops\n");
1312 break;
1313 }
1314}
1315
682a9b21 1316void scsi_req_complete(SCSIRequest *req, int status)
ed3a34a3 1317{
682a9b21
PB
1318 assert(req->status == -1);
1319 req->status = status;
b45ef674
PB
1320
1321 assert(req->sense_len < sizeof(req->sense));
1322 if (status == GOOD) {
1323 req->sense_len = 0;
1324 }
1325
1326 if (req->sense_len) {
1327 memcpy(req->dev->sense, req->sense, req->sense_len);
3653d8c4
PB
1328 req->dev->sense_len = req->sense_len;
1329 req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1330 } else {
1331 req->dev->sense_len = 0;
1332 req->dev->sense_is_ua = false;
b45ef674 1333 }
b45ef674 1334
6dc06f08
PB
1335 /*
1336 * Unit attention state is now stored in the device's sense buffer
1337 * if the HBA didn't do autosense. Clear the pending unit attention
1338 * flags.
1339 */
1340 scsi_clear_unit_attention(req);
1341
ad2d30f7 1342 scsi_req_ref(req);
e8637c90 1343 scsi_req_dequeue(req);
01e95455 1344 req->bus->info->complete(req, req->status, req->resid);
ad2d30f7 1345 scsi_req_unref(req);
ed3a34a3 1346}
db07c0f8 1347
94d3f98a
PB
1348void scsi_req_cancel(SCSIRequest *req)
1349{
e88c591d
PB
1350 if (!req->enqueued) {
1351 return;
94d3f98a
PB
1352 }
1353 scsi_req_ref(req);
1354 scsi_req_dequeue(req);
e88c591d
PB
1355 req->io_canceled = true;
1356 if (req->ops->cancel_io) {
1357 req->ops->cancel_io(req);
1358 }
afd4030c
PB
1359 if (req->bus->info->cancel) {
1360 req->bus->info->cancel(req);
94d3f98a
PB
1361 }
1362 scsi_req_unref(req);
1363}
1364
19d110ab
PB
1365void scsi_req_abort(SCSIRequest *req, int status)
1366{
e88c591d
PB
1367 if (!req->enqueued) {
1368 return;
1369 }
1370 scsi_req_ref(req);
1371 scsi_req_dequeue(req);
1372 req->io_canceled = true;
12010e7b
PB
1373 if (req->ops->cancel_io) {
1374 req->ops->cancel_io(req);
19d110ab 1375 }
682a9b21 1376 scsi_req_complete(req, status);
e88c591d 1377 scsi_req_unref(req);
19d110ab
PB
1378}
1379
c7b48872 1380void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
c557e889
PB
1381{
1382 SCSIRequest *req;
1383
1384 while (!QTAILQ_EMPTY(&sdev->requests)) {
1385 req = QTAILQ_FIRST(&sdev->requests);
94d3f98a 1386 scsi_req_cancel(req);
c557e889 1387 }
c7b48872 1388 sdev->unit_attention = sense;
c557e889
PB
1389}
1390
db07c0f8
GN
1391static char *scsibus_get_fw_dev_path(DeviceState *dev)
1392{
b9eea3e6 1393 SCSIDevice *d = SCSI_DEVICE(dev);
db07c0f8 1394 char path[100];
db07c0f8 1395
795928f6
PB
1396 snprintf(path, sizeof(path), "channel@%x/%s@%x,%x", d->channel,
1397 qdev_fw_name(dev), d->id, d->lun);
db07c0f8 1398
f48a7a6e
PB
1399 return strdup(path);
1400}
1401
0d3545e7 1402SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
f48a7a6e
PB
1403{
1404 DeviceState *qdev;
1405 SCSIDevice *target_dev = NULL;
db07c0f8 1406
f48a7a6e 1407 QTAILQ_FOREACH_REVERSE(qdev, &bus->qbus.children, ChildrenHead, sibling) {
b9eea3e6 1408 SCSIDevice *dev = SCSI_DEVICE(qdev);
db07c0f8 1409
0d3545e7 1410 if (dev->channel == channel && dev->id == id) {
f48a7a6e
PB
1411 if (dev->lun == lun) {
1412 return dev;
1413 }
1414 target_dev = dev;
1415 }
1416 }
1417 return target_dev;
db07c0f8 1418}
b9eea3e6 1419
39bffca2
AL
1420static void scsi_device_class_init(ObjectClass *klass, void *data)
1421{
1422 DeviceClass *k = DEVICE_CLASS(klass);
1423 k->bus_info = &scsi_bus_info;
1424 k->init = scsi_qdev_init;
1425 k->unplug = qdev_simple_unplug_cb;
1426 k->exit = scsi_qdev_exit;
1427}
1428
b9eea3e6
AL
1429static TypeInfo scsi_device_type_info = {
1430 .name = TYPE_SCSI_DEVICE,
1431 .parent = TYPE_DEVICE,
1432 .instance_size = sizeof(SCSIDevice),
1433 .abstract = true,
1434 .class_size = sizeof(SCSIDeviceClass),
39bffca2 1435 .class_init = scsi_device_class_init,
b9eea3e6
AL
1436};
1437
83f7d43a 1438static void scsi_register_types(void)
b9eea3e6
AL
1439{
1440 type_register_static(&scsi_device_type_info);
1441}
1442
83f7d43a 1443type_init(scsi_register_types)