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