Statistics
| Branch: | Revision:

root / hw / scsi-bus.c @ 3c3d8a95

History | View | Annotate | Download (45.9 kB)

1
#include "hw.h"
2
#include "qemu-error.h"
3
#include "scsi.h"
4
#include "scsi-defs.h"
5
#include "qdev.h"
6
#include "blockdev.h"
7
#include "trace.h"
8
#include "dma.h"
9

    
10
static char *scsibus_get_dev_path(DeviceState *dev);
11
static char *scsibus_get_fw_dev_path(DeviceState *dev);
12
static int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf);
13
static void scsi_req_dequeue(SCSIRequest *req);
14

    
15
static struct BusInfo scsi_bus_info = {
16
    .name  = "SCSI",
17
    .size  = sizeof(SCSIBus),
18
    .get_dev_path = scsibus_get_dev_path,
19
    .get_fw_dev_path = scsibus_get_fw_dev_path,
20
    .props = (Property[]) {
21
        DEFINE_PROP_UINT32("channel", SCSIDevice, channel, 0),
22
        DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
23
        DEFINE_PROP_UINT32("lun", SCSIDevice, lun, -1),
24
        DEFINE_PROP_END_OF_LIST(),
25
    },
26
};
27
static int next_scsi_bus;
28

    
29
static int scsi_device_init(SCSIDevice *s)
30
{
31
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
32
    if (sc->init) {
33
        return sc->init(s);
34
    }
35
    return 0;
36
}
37

    
38
static void scsi_device_destroy(SCSIDevice *s)
39
{
40
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
41
    if (sc->destroy) {
42
        sc->destroy(s);
43
    }
44
}
45

    
46
static SCSIRequest *scsi_device_alloc_req(SCSIDevice *s, uint32_t tag, uint32_t lun,
47
                                          uint8_t *buf, void *hba_private)
48
{
49
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
50
    if (sc->alloc_req) {
51
        return sc->alloc_req(s, tag, lun, buf, hba_private);
52
    }
53

    
54
    return NULL;
55
}
56

    
57
static void scsi_device_unit_attention_reported(SCSIDevice *s)
58
{
59
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
60
    if (sc->unit_attention_reported) {
61
        sc->unit_attention_reported(s);
62
    }
63
}
64

    
65
/* Create a scsi bus, and attach devices to it.  */
66
void scsi_bus_new(SCSIBus *bus, DeviceState *host, const SCSIBusInfo *info)
67
{
68
    qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
69
    bus->busnr = next_scsi_bus++;
70
    bus->info = info;
71
    bus->qbus.allow_hotplug = 1;
72
}
73

    
74
static void scsi_dma_restart_bh(void *opaque)
75
{
76
    SCSIDevice *s = opaque;
77
    SCSIRequest *req, *next;
78

    
79
    qemu_bh_delete(s->bh);
80
    s->bh = NULL;
81

    
82
    QTAILQ_FOREACH_SAFE(req, &s->requests, next, next) {
83
        scsi_req_ref(req);
84
        if (req->retry) {
85
            req->retry = false;
86
            switch (req->cmd.mode) {
87
            case SCSI_XFER_FROM_DEV:
88
            case SCSI_XFER_TO_DEV:
89
                scsi_req_continue(req);
90
                break;
91
            case SCSI_XFER_NONE:
92
                assert(!req->sg);
93
                scsi_req_dequeue(req);
94
                scsi_req_enqueue(req);
95
                break;
96
            }
97
        }
98
        scsi_req_unref(req);
99
    }
100
}
101

    
102
void scsi_req_retry(SCSIRequest *req)
103
{
104
    /* No need to save a reference, because scsi_dma_restart_bh just
105
     * looks at the request list.  */
106
    req->retry = true;
107
}
108

    
109
static void scsi_dma_restart_cb(void *opaque, int running, RunState state)
110
{
111
    SCSIDevice *s = opaque;
112

    
113
    if (!running) {
114
        return;
115
    }
116
    if (!s->bh) {
117
        s->bh = qemu_bh_new(scsi_dma_restart_bh, s);
118
        qemu_bh_schedule(s->bh);
119
    }
120
}
121

    
122
static int scsi_qdev_init(DeviceState *qdev)
123
{
124
    SCSIDevice *dev = SCSI_DEVICE(qdev);
125
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
126
    SCSIDevice *d;
127
    int rc = -1;
128

    
129
    if (dev->channel > bus->info->max_channel) {
130
        error_report("bad scsi channel id: %d", dev->channel);
131
        goto err;
132
    }
133
    if (dev->id != -1 && dev->id > bus->info->max_target) {
134
        error_report("bad scsi device id: %d", dev->id);
135
        goto err;
136
    }
137
    if (dev->lun != -1 && dev->lun > bus->info->max_lun) {
138
        error_report("bad scsi device lun: %d", dev->lun);
139
        goto err;
140
    }
141

    
142
    if (dev->id == -1) {
143
        int id = -1;
144
        if (dev->lun == -1) {
145
            dev->lun = 0;
146
        }
147
        do {
148
            d = scsi_device_find(bus, dev->channel, ++id, dev->lun);
149
        } while (d && d->lun == dev->lun && id < bus->info->max_target);
150
        if (d && d->lun == dev->lun) {
151
            error_report("no free target");
152
            goto err;
153
        }
154
        dev->id = id;
155
    } else if (dev->lun == -1) {
156
        int lun = -1;
157
        do {
158
            d = scsi_device_find(bus, dev->channel, dev->id, ++lun);
159
        } while (d && d->lun == lun && lun < bus->info->max_lun);
160
        if (d && d->lun == lun) {
161
            error_report("no free lun");
162
            goto err;
163
        }
164
        dev->lun = lun;
165
    } else {
166
        d = scsi_device_find(bus, dev->channel, dev->id, dev->lun);
167
        assert(d);
168
        if (d->lun == dev->lun && dev != d) {
169
            qdev_free(&d->qdev);
170
        }
171
    }
172

    
173
    QTAILQ_INIT(&dev->requests);
174
    rc = scsi_device_init(dev);
175
    if (rc == 0) {
176
        dev->vmsentry = qemu_add_vm_change_state_handler(scsi_dma_restart_cb,
177
                                                         dev);
178
    }
179

    
180
err:
181
    return rc;
182
}
183

    
184
static int scsi_qdev_exit(DeviceState *qdev)
185
{
186
    SCSIDevice *dev = SCSI_DEVICE(qdev);
187

    
188
    if (dev->vmsentry) {
189
        qemu_del_vm_change_state_handler(dev->vmsentry);
190
    }
191
    scsi_device_destroy(dev);
192
    return 0;
193
}
194

    
195
/* handle legacy '-drive if=scsi,...' cmd line args */
196
SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
197
                                      int unit, bool removable, int bootindex)
198
{
199
    const char *driver;
200
    DeviceState *dev;
201

    
202
    driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
203
    dev = qdev_create(&bus->qbus, driver);
204
    qdev_prop_set_uint32(dev, "scsi-id", unit);
205
    if (bootindex >= 0) {
206
        qdev_prop_set_int32(dev, "bootindex", bootindex);
207
    }
208
    if (qdev_prop_exists(dev, "removable")) {
209
        qdev_prop_set_bit(dev, "removable", removable);
210
    }
211
    if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
212
        qdev_free(dev);
213
        return NULL;
214
    }
215
    if (qdev_init(dev) < 0)
216
        return NULL;
217
    return SCSI_DEVICE(dev);
218
}
219

    
220
int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
221
{
222
    Location loc;
223
    DriveInfo *dinfo;
224
    int res = 0, unit;
225

    
226
    loc_push_none(&loc);
227
    for (unit = 0; unit <= bus->info->max_target; unit++) {
228
        dinfo = drive_get(IF_SCSI, bus->busnr, unit);
229
        if (dinfo == NULL) {
230
            continue;
231
        }
232
        qemu_opts_loc_restore(dinfo->opts);
233
        if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1)) {
234
            res = -1;
235
            break;
236
        }
237
    }
238
    loc_pop(&loc);
239
    return res;
240
}
241

    
242
static int32_t scsi_invalid_field(SCSIRequest *req, uint8_t *buf)
243
{
244
    scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
245
    scsi_req_complete(req, CHECK_CONDITION);
246
    return 0;
247
}
248

    
249
static const struct SCSIReqOps reqops_invalid_field = {
250
    .size         = sizeof(SCSIRequest),
251
    .send_command = scsi_invalid_field
252
};
253

    
254
/* SCSIReqOps implementation for invalid commands.  */
255

    
256
static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
257
{
258
    scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
259
    scsi_req_complete(req, CHECK_CONDITION);
260
    return 0;
261
}
262

    
263
static const struct SCSIReqOps reqops_invalid_opcode = {
264
    .size         = sizeof(SCSIRequest),
265
    .send_command = scsi_invalid_command
266
};
267

    
268
/* SCSIReqOps implementation for unit attention conditions.  */
269

    
270
static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
271
{
272
    if (req->dev && req->dev->unit_attention.key == UNIT_ATTENTION) {
273
        scsi_req_build_sense(req, req->dev->unit_attention);
274
    } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
275
        scsi_req_build_sense(req, req->bus->unit_attention);
276
    }
277
    scsi_req_complete(req, CHECK_CONDITION);
278
    return 0;
279
}
280

    
281
static const struct SCSIReqOps reqops_unit_attention = {
282
    .size         = sizeof(SCSIRequest),
283
    .send_command = scsi_unit_attention
284
};
285

    
286
/* SCSIReqOps implementation for REPORT LUNS and for commands sent to
287
   an invalid LUN.  */
288

    
289
typedef struct SCSITargetReq SCSITargetReq;
290

    
291
struct SCSITargetReq {
292
    SCSIRequest req;
293
    int len;
294
    uint8_t buf[2056];
295
};
296

    
297
static void store_lun(uint8_t *outbuf, int lun)
298
{
299
    if (lun < 256) {
300
        outbuf[1] = lun;
301
        return;
302
    }
303
    outbuf[1] = (lun & 255);
304
    outbuf[0] = (lun >> 8) | 0x40;
305
}
306

    
307
static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
308
{
309
    DeviceState *qdev;
310
    int i, len, n;
311
    int channel, id;
312
    bool found_lun0;
313

    
314
    if (r->req.cmd.xfer < 16) {
315
        return false;
316
    }
317
    if (r->req.cmd.buf[2] > 2) {
318
        return false;
319
    }
320
    channel = r->req.dev->channel;
321
    id = r->req.dev->id;
322
    found_lun0 = false;
323
    n = 0;
324
    QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
325
        SCSIDevice *dev = SCSI_DEVICE(qdev);
326

    
327
        if (dev->channel == channel && dev->id == id) {
328
            if (dev->lun == 0) {
329
                found_lun0 = true;
330
            }
331
            n += 8;
332
        }
333
    }
334
    if (!found_lun0) {
335
        n += 8;
336
    }
337
    len = MIN(n + 8, r->req.cmd.xfer & ~7);
338
    if (len > sizeof(r->buf)) {
339
        /* TODO: > 256 LUNs? */
340
        return false;
341
    }
342

    
343
    memset(r->buf, 0, len);
344
    stl_be_p(&r->buf, n);
345
    i = found_lun0 ? 8 : 16;
346
    QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
347
        SCSIDevice *dev = SCSI_DEVICE(qdev);
348

    
349
        if (dev->channel == channel && dev->id == id) {
350
            store_lun(&r->buf[i], dev->lun);
351
            i += 8;
352
        }
353
    }
354
    assert(i == n + 8);
355
    r->len = len;
356
    return true;
357
}
358

    
359
static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
360
{
361
    assert(r->req.dev->lun != r->req.lun);
362
    if (r->req.cmd.buf[1] & 0x2) {
363
        /* Command support data - optional, not implemented */
364
        return false;
365
    }
366

    
367
    if (r->req.cmd.buf[1] & 0x1) {
368
        /* Vital product data */
369
        uint8_t page_code = r->req.cmd.buf[2];
370
        r->buf[r->len++] = page_code ; /* this page */
371
        r->buf[r->len++] = 0x00;
372

    
373
        switch (page_code) {
374
        case 0x00: /* Supported page codes, mandatory */
375
        {
376
            int pages;
377
            pages = r->len++;
378
            r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
379
            r->buf[pages] = r->len - pages - 1; /* number of pages */
380
            break;
381
        }
382
        default:
383
            return false;
384
        }
385
        /* done with EVPD */
386
        assert(r->len < sizeof(r->buf));
387
        r->len = MIN(r->req.cmd.xfer, r->len);
388
        return true;
389
    }
390

    
391
    /* Standard INQUIRY data */
392
    if (r->req.cmd.buf[2] != 0) {
393
        return false;
394
    }
395

    
396
    /* PAGE CODE == 0 */
397
    r->len = MIN(r->req.cmd.xfer, 36);
398
    memset(r->buf, 0, r->len);
399
    if (r->req.lun != 0) {
400
        r->buf[0] = TYPE_NO_LUN;
401
    } else {
402
        r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
403
        r->buf[2] = 5; /* Version */
404
        r->buf[3] = 2 | 0x10; /* HiSup, response data format */
405
        r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
406
        r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ.  */
407
        memcpy(&r->buf[8], "QEMU    ", 8);
408
        memcpy(&r->buf[16], "QEMU TARGET     ", 16);
409
        strncpy((char *) &r->buf[32], QEMU_VERSION, 4);
410
    }
411
    return true;
412
}
413

    
414
static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
415
{
416
    SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
417

    
418
    switch (buf[0]) {
419
    case REPORT_LUNS:
420
        if (!scsi_target_emulate_report_luns(r)) {
421
            goto illegal_request;
422
        }
423
        break;
424
    case INQUIRY:
425
        if (!scsi_target_emulate_inquiry(r)) {
426
            goto illegal_request;
427
        }
428
        break;
429
    case REQUEST_SENSE:
430
        if (req->cmd.xfer < 4) {
431
            goto illegal_request;
432
        }
433
        r->len = scsi_device_get_sense(r->req.dev, r->buf,
434
                                       MIN(req->cmd.xfer, sizeof r->buf),
435
                                       (req->cmd.buf[1] & 1) == 0);
436
        if (r->req.dev->sense_is_ua) {
437
            scsi_device_unit_attention_reported(req->dev);
438
            r->req.dev->sense_len = 0;
439
            r->req.dev->sense_is_ua = false;
440
        }
441
        break;
442
    default:
443
        scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
444
        scsi_req_complete(req, CHECK_CONDITION);
445
        return 0;
446
    illegal_request:
447
        scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
448
        scsi_req_complete(req, CHECK_CONDITION);
449
        return 0;
450
    }
451

    
452
    if (!r->len) {
453
        scsi_req_complete(req, GOOD);
454
    }
455
    return r->len;
456
}
457

    
458
static void scsi_target_read_data(SCSIRequest *req)
459
{
460
    SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
461
    uint32_t n;
462

    
463
    n = r->len;
464
    if (n > 0) {
465
        r->len = 0;
466
        scsi_req_data(&r->req, n);
467
    } else {
468
        scsi_req_complete(&r->req, GOOD);
469
    }
470
}
471

    
472
static uint8_t *scsi_target_get_buf(SCSIRequest *req)
473
{
474
    SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
475

    
476
    return r->buf;
477
}
478

    
479
static const struct SCSIReqOps reqops_target_command = {
480
    .size         = sizeof(SCSITargetReq),
481
    .send_command = scsi_target_send_command,
482
    .read_data    = scsi_target_read_data,
483
    .get_buf      = scsi_target_get_buf,
484
};
485

    
486

    
487
SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
488
                            uint32_t tag, uint32_t lun, void *hba_private)
489
{
490
    SCSIRequest *req;
491

    
492
    req = g_malloc0(reqops->size);
493
    req->refcount = 1;
494
    req->bus = scsi_bus_from_device(d);
495
    req->dev = d;
496
    req->tag = tag;
497
    req->lun = lun;
498
    req->hba_private = hba_private;
499
    req->status = -1;
500
    req->sense_len = 0;
501
    req->ops = reqops;
502
    trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
503
    return req;
504
}
505

    
506
SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
507
                          uint8_t *buf, void *hba_private)
508
{
509
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
510
    SCSIRequest *req;
511
    SCSICommand cmd;
512

    
513
    if (scsi_req_parse(&cmd, d, buf) != 0) {
514
        trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
515
        req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
516
    } else {
517
        trace_scsi_req_parsed(d->id, lun, tag, buf[0],
518
                              cmd.mode, cmd.xfer);
519
        if (cmd.lba != -1) {
520
            trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
521
                                      cmd.lba);
522
        }
523

    
524
        if (cmd.xfer > INT32_MAX) {
525
            req = scsi_req_alloc(&reqops_invalid_field, d, tag, lun, hba_private);
526
        } else if ((d->unit_attention.key == UNIT_ATTENTION ||
527
                   bus->unit_attention.key == UNIT_ATTENTION) &&
528
                  (buf[0] != INQUIRY &&
529
                   buf[0] != REPORT_LUNS &&
530
                   buf[0] != GET_CONFIGURATION &&
531
                   buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
532

    
533
                   /*
534
                    * If we already have a pending unit attention condition,
535
                    * report this one before triggering another one.
536
                    */
537
                   !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
538
            req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
539
                                 hba_private);
540
        } else if (lun != d->lun ||
541
            buf[0] == REPORT_LUNS ||
542
            (buf[0] == REQUEST_SENSE && (d->sense_len || cmd.xfer < 4))) {
543
            req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
544
                                 hba_private);
545
        } else {
546
            req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
547
        }
548
    }
549

    
550
    req->cmd = cmd;
551
    req->resid = req->cmd.xfer;
552

    
553
    switch (buf[0]) {
554
    case INQUIRY:
555
        trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
556
        break;
557
    case TEST_UNIT_READY:
558
        trace_scsi_test_unit_ready(d->id, lun, tag);
559
        break;
560
    case REPORT_LUNS:
561
        trace_scsi_report_luns(d->id, lun, tag);
562
        break;
563
    case REQUEST_SENSE:
564
        trace_scsi_request_sense(d->id, lun, tag);
565
        break;
566
    default:
567
        break;
568
    }
569

    
570
    return req;
571
}
572

    
573
uint8_t *scsi_req_get_buf(SCSIRequest *req)
574
{
575
    return req->ops->get_buf(req);
576
}
577

    
578
static void scsi_clear_unit_attention(SCSIRequest *req)
579
{
580
    SCSISense *ua;
581
    if (req->dev->unit_attention.key != UNIT_ATTENTION &&
582
        req->bus->unit_attention.key != UNIT_ATTENTION) {
583
        return;
584
    }
585

    
586
    /*
587
     * If an INQUIRY command enters the enabled command state,
588
     * the device server shall [not] clear any unit attention condition;
589
     * See also MMC-6, paragraphs 6.5 and 6.6.2.
590
     */
591
    if (req->cmd.buf[0] == INQUIRY ||
592
        req->cmd.buf[0] == GET_CONFIGURATION ||
593
        req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
594
        return;
595
    }
596

    
597
    if (req->dev->unit_attention.key == UNIT_ATTENTION) {
598
        ua = &req->dev->unit_attention;
599
    } else {
600
        ua = &req->bus->unit_attention;
601
    }
602

    
603
    /*
604
     * If a REPORT LUNS command enters the enabled command state, [...]
605
     * the device server shall clear any pending unit attention condition
606
     * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
607
     */
608
    if (req->cmd.buf[0] == REPORT_LUNS &&
609
        !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
610
          ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
611
        return;
612
    }
613

    
614
    *ua = SENSE_CODE(NO_SENSE);
615
}
616

    
617
int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
618
{
619
    int ret;
620

    
621
    assert(len >= 14);
622
    if (!req->sense_len) {
623
        return 0;
624
    }
625

    
626
    ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
627

    
628
    /*
629
     * FIXME: clearing unit attention conditions upon autosense should be done
630
     * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
631
     * (SAM-5, 5.14).
632
     *
633
     * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
634
     * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
635
     * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
636
     */
637
    if (req->dev->sense_is_ua) {
638
        scsi_device_unit_attention_reported(req->dev);
639
        req->dev->sense_len = 0;
640
        req->dev->sense_is_ua = false;
641
    }
642
    return ret;
643
}
644

    
645
int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
646
{
647
    return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
648
}
649

    
650
void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
651
{
652
    trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
653
                               sense.key, sense.asc, sense.ascq);
654
    memset(req->sense, 0, 18);
655
    req->sense[0] = 0xf0;
656
    req->sense[2] = sense.key;
657
    req->sense[7] = 10;
658
    req->sense[12] = sense.asc;
659
    req->sense[13] = sense.ascq;
660
    req->sense_len = 18;
661
}
662

    
663
static void scsi_req_enqueue_internal(SCSIRequest *req)
664
{
665
    assert(!req->enqueued);
666
    scsi_req_ref(req);
667
    if (req->bus->info->get_sg_list) {
668
        req->sg = req->bus->info->get_sg_list(req);
669
    } else {
670
        req->sg = NULL;
671
    }
672
    req->enqueued = true;
673
    QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
674
}
675

    
676
int32_t scsi_req_enqueue(SCSIRequest *req)
677
{
678
    int32_t rc;
679

    
680
    assert(!req->retry);
681
    scsi_req_enqueue_internal(req);
682
    scsi_req_ref(req);
683
    rc = req->ops->send_command(req, req->cmd.buf);
684
    scsi_req_unref(req);
685
    return rc;
686
}
687

    
688
static void scsi_req_dequeue(SCSIRequest *req)
689
{
690
    trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
691
    req->retry = false;
692
    if (req->enqueued) {
693
        QTAILQ_REMOVE(&req->dev->requests, req, next);
694
        req->enqueued = false;
695
        scsi_req_unref(req);
696
    }
697
}
698

    
699
static int scsi_get_performance_length(int num_desc, int type, int data_type)
700
{
701
    /* MMC-6, paragraph 6.7.  */
702
    switch (type) {
703
    case 0:
704
        if ((data_type & 3) == 0) {
705
            /* Each descriptor is as in Table 295 - Nominal performance.  */
706
            return 16 * num_desc + 8;
707
        } else {
708
            /* Each descriptor is as in Table 296 - Exceptions.  */
709
            return 6 * num_desc + 8;
710
        }
711
    case 1:
712
    case 4:
713
    case 5:
714
        return 8 * num_desc + 8;
715
    case 2:
716
        return 2048 * num_desc + 8;
717
    case 3:
718
        return 16 * num_desc + 8;
719
    default:
720
        return 8;
721
    }
722
}
723

    
724
static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
725
{
726
    switch (buf[0] >> 5) {
727
    case 0:
728
        cmd->xfer = buf[4];
729
        cmd->len = 6;
730
        break;
731
    case 1:
732
    case 2:
733
        cmd->xfer = lduw_be_p(&buf[7]);
734
        cmd->len = 10;
735
        break;
736
    case 4:
737
        cmd->xfer = ldl_be_p(&buf[10]) & 0xffffffffULL;
738
        cmd->len = 16;
739
        break;
740
    case 5:
741
        cmd->xfer = ldl_be_p(&buf[6]) & 0xffffffffULL;
742
        cmd->len = 12;
743
        break;
744
    default:
745
        return -1;
746
    }
747

    
748
    switch (buf[0]) {
749
    case TEST_UNIT_READY:
750
    case REWIND:
751
    case START_STOP:
752
    case SET_CAPACITY:
753
    case WRITE_FILEMARKS:
754
    case WRITE_FILEMARKS_16:
755
    case SPACE:
756
    case RESERVE:
757
    case RELEASE:
758
    case ERASE:
759
    case ALLOW_MEDIUM_REMOVAL:
760
    case VERIFY_10:
761
    case SEEK_10:
762
    case SYNCHRONIZE_CACHE:
763
    case SYNCHRONIZE_CACHE_16:
764
    case LOCATE_16:
765
    case LOCK_UNLOCK_CACHE:
766
    case LOAD_UNLOAD:
767
    case SET_CD_SPEED:
768
    case SET_LIMITS:
769
    case WRITE_LONG_10:
770
    case MOVE_MEDIUM:
771
    case UPDATE_BLOCK:
772
    case RESERVE_TRACK:
773
    case SET_READ_AHEAD:
774
    case PRE_FETCH:
775
    case PRE_FETCH_16:
776
    case ALLOW_OVERWRITE:
777
        cmd->xfer = 0;
778
        break;
779
    case MODE_SENSE:
780
        break;
781
    case WRITE_SAME_10:
782
    case WRITE_SAME_16:
783
        cmd->xfer = dev->blocksize;
784
        break;
785
    case READ_CAPACITY_10:
786
        cmd->xfer = 8;
787
        break;
788
    case READ_BLOCK_LIMITS:
789
        cmd->xfer = 6;
790
        break;
791
    case SEND_VOLUME_TAG:
792
        /* GPCMD_SET_STREAMING from multimedia commands.  */
793
        if (dev->type == TYPE_ROM) {
794
            cmd->xfer = buf[10] | (buf[9] << 8);
795
        } else {
796
            cmd->xfer = buf[9] | (buf[8] << 8);
797
        }
798
        break;
799
    case WRITE_6:
800
        /* length 0 means 256 blocks */
801
        if (cmd->xfer == 0) {
802
            cmd->xfer = 256;
803
        }
804
    case WRITE_10:
805
    case WRITE_VERIFY_10:
806
    case WRITE_12:
807
    case WRITE_VERIFY_12:
808
    case WRITE_16:
809
    case WRITE_VERIFY_16:
810
        cmd->xfer *= dev->blocksize;
811
        break;
812
    case READ_6:
813
    case READ_REVERSE:
814
        /* length 0 means 256 blocks */
815
        if (cmd->xfer == 0) {
816
            cmd->xfer = 256;
817
        }
818
    case READ_10:
819
    case RECOVER_BUFFERED_DATA:
820
    case READ_12:
821
    case READ_16:
822
        cmd->xfer *= dev->blocksize;
823
        break;
824
    case FORMAT_UNIT:
825
        /* MMC mandates the parameter list to be 12-bytes long.  Parameters
826
         * for block devices are restricted to the header right now.  */
827
        if (dev->type == TYPE_ROM && (buf[1] & 16)) {
828
            cmd->xfer = 12;
829
        } else {
830
            cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
831
        }
832
        break;
833
    case INQUIRY:
834
    case RECEIVE_DIAGNOSTIC:
835
    case SEND_DIAGNOSTIC:
836
        cmd->xfer = buf[4] | (buf[3] << 8);
837
        break;
838
    case READ_CD:
839
    case READ_BUFFER:
840
    case WRITE_BUFFER:
841
    case SEND_CUE_SHEET:
842
        cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
843
        break;
844
    case PERSISTENT_RESERVE_OUT:
845
        cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
846
        break;
847
    case ERASE_12:
848
        if (dev->type == TYPE_ROM) {
849
            /* MMC command GET PERFORMANCE.  */
850
            cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
851
                                                    buf[10], buf[1] & 0x1f);
852
        }
853
        break;
854
    case MECHANISM_STATUS:
855
    case READ_DVD_STRUCTURE:
856
    case SEND_DVD_STRUCTURE:
857
    case MAINTENANCE_OUT:
858
    case MAINTENANCE_IN:
859
        if (dev->type == TYPE_ROM) {
860
            /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
861
            cmd->xfer = buf[9] | (buf[8] << 8);
862
        }
863
        break;
864
    }
865
    return 0;
866
}
867

    
868
static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
869
{
870
    switch (buf[0]) {
871
    /* stream commands */
872
    case ERASE_12:
873
    case ERASE_16:
874
        cmd->xfer = 0;
875
        break;
876
    case READ_6:
877
    case READ_REVERSE:
878
    case RECOVER_BUFFERED_DATA:
879
    case WRITE_6:
880
        cmd->len = 6;
881
        cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
882
        if (buf[1] & 0x01) { /* fixed */
883
            cmd->xfer *= dev->blocksize;
884
        }
885
        break;
886
    case READ_16:
887
    case READ_REVERSE_16:
888
    case VERIFY_16:
889
    case WRITE_16:
890
        cmd->len = 16;
891
        cmd->xfer = buf[14] | (buf[13] << 8) | (buf[12] << 16);
892
        if (buf[1] & 0x01) { /* fixed */
893
            cmd->xfer *= dev->blocksize;
894
        }
895
        break;
896
    case REWIND:
897
    case START_STOP:
898
        cmd->len = 6;
899
        cmd->xfer = 0;
900
        break;
901
    case SPACE_16:
902
        cmd->xfer = buf[13] | (buf[12] << 8);
903
        break;
904
    case READ_POSITION:
905
        cmd->xfer = buf[8] | (buf[7] << 8);
906
        break;
907
    case FORMAT_UNIT:
908
        cmd->xfer = buf[4] | (buf[3] << 8);
909
        break;
910
    /* generic commands */
911
    default:
912
        return scsi_req_length(cmd, dev, buf);
913
    }
914
    return 0;
915
}
916

    
917
static void scsi_cmd_xfer_mode(SCSICommand *cmd)
918
{
919
    if (!cmd->xfer) {
920
        cmd->mode = SCSI_XFER_NONE;
921
        return;
922
    }
923
    switch (cmd->buf[0]) {
924
    case WRITE_6:
925
    case WRITE_10:
926
    case WRITE_VERIFY_10:
927
    case WRITE_12:
928
    case WRITE_VERIFY_12:
929
    case WRITE_16:
930
    case WRITE_VERIFY_16:
931
    case COPY:
932
    case COPY_VERIFY:
933
    case COMPARE:
934
    case CHANGE_DEFINITION:
935
    case LOG_SELECT:
936
    case MODE_SELECT:
937
    case MODE_SELECT_10:
938
    case SEND_DIAGNOSTIC:
939
    case WRITE_BUFFER:
940
    case FORMAT_UNIT:
941
    case REASSIGN_BLOCKS:
942
    case SEARCH_EQUAL:
943
    case SEARCH_HIGH:
944
    case SEARCH_LOW:
945
    case UPDATE_BLOCK:
946
    case WRITE_LONG_10:
947
    case WRITE_SAME_10:
948
    case WRITE_SAME_16:
949
    case UNMAP:
950
    case SEARCH_HIGH_12:
951
    case SEARCH_EQUAL_12:
952
    case SEARCH_LOW_12:
953
    case MEDIUM_SCAN:
954
    case SEND_VOLUME_TAG:
955
    case SEND_CUE_SHEET:
956
    case SEND_DVD_STRUCTURE:
957
    case PERSISTENT_RESERVE_OUT:
958
    case MAINTENANCE_OUT:
959
    case ATA_PASSTHROUGH:
960
        cmd->mode = SCSI_XFER_TO_DEV;
961
        break;
962
    default:
963
        cmd->mode = SCSI_XFER_FROM_DEV;
964
        break;
965
    }
966
}
967

    
968
static uint64_t scsi_cmd_lba(SCSICommand *cmd)
969
{
970
    uint8_t *buf = cmd->buf;
971
    uint64_t lba;
972

    
973
    switch (buf[0] >> 5) {
974
    case 0:
975
        lba = ldl_be_p(&buf[0]) & 0x1fffff;
976
        break;
977
    case 1:
978
    case 2:
979
    case 5:
980
        lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
981
        break;
982
    case 4:
983
        lba = ldq_be_p(&buf[2]);
984
        break;
985
    default:
986
        lba = -1;
987

    
988
    }
989
    return lba;
990
}
991

    
992
int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
993
{
994
    int rc;
995

    
996
    if (dev->type == TYPE_TAPE) {
997
        rc = scsi_req_stream_length(cmd, dev, buf);
998
    } else {
999
        rc = scsi_req_length(cmd, dev, buf);
1000
    }
1001
    if (rc != 0)
1002
        return rc;
1003

    
1004
    memcpy(cmd->buf, buf, cmd->len);
1005
    scsi_cmd_xfer_mode(cmd);
1006
    cmd->lba = scsi_cmd_lba(cmd);
1007
    return 0;
1008
}
1009

    
1010
/*
1011
 * Predefined sense codes
1012
 */
1013

    
1014
/* No sense data available */
1015
const struct SCSISense sense_code_NO_SENSE = {
1016
    .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
1017
};
1018

    
1019
/* LUN not ready, Manual intervention required */
1020
const struct SCSISense sense_code_LUN_NOT_READY = {
1021
    .key = NOT_READY, .asc = 0x04, .ascq = 0x03
1022
};
1023

    
1024
/* LUN not ready, Medium not present */
1025
const struct SCSISense sense_code_NO_MEDIUM = {
1026
    .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
1027
};
1028

    
1029
/* LUN not ready, medium removal prevented */
1030
const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
1031
    .key = NOT_READY, .asc = 0x53, .ascq = 0x00
1032
};
1033

    
1034
/* Hardware error, internal target failure */
1035
const struct SCSISense sense_code_TARGET_FAILURE = {
1036
    .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
1037
};
1038

    
1039
/* Illegal request, invalid command operation code */
1040
const struct SCSISense sense_code_INVALID_OPCODE = {
1041
    .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
1042
};
1043

    
1044
/* Illegal request, LBA out of range */
1045
const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1046
    .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1047
};
1048

    
1049
/* Illegal request, Invalid field in CDB */
1050
const struct SCSISense sense_code_INVALID_FIELD = {
1051
    .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1052
};
1053

    
1054
/* Illegal request, LUN not supported */
1055
const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1056
    .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1057
};
1058

    
1059
/* Illegal request, Saving parameters not supported */
1060
const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1061
    .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1062
};
1063

    
1064
/* Illegal request, Incompatible medium installed */
1065
const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
1066
    .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1067
};
1068

    
1069
/* Illegal request, medium removal prevented */
1070
const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1071
    .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x00
1072
};
1073

    
1074
/* Command aborted, I/O process terminated */
1075
const struct SCSISense sense_code_IO_ERROR = {
1076
    .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1077
};
1078

    
1079
/* Command aborted, I_T Nexus loss occurred */
1080
const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1081
    .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1082
};
1083

    
1084
/* Command aborted, Logical Unit failure */
1085
const struct SCSISense sense_code_LUN_FAILURE = {
1086
    .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1087
};
1088

    
1089
/* Unit attention, Power on, reset or bus device reset occurred */
1090
const struct SCSISense sense_code_RESET = {
1091
    .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1092
};
1093

    
1094
/* Unit attention, No medium */
1095
const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1096
    .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1097
};
1098

    
1099
/* Unit attention, Medium may have changed */
1100
const struct SCSISense sense_code_MEDIUM_CHANGED = {
1101
    .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1102
};
1103

    
1104
/* Unit attention, Reported LUNs data has changed */
1105
const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1106
    .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1107
};
1108

    
1109
/* Unit attention, Device internal reset */
1110
const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1111
    .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1112
};
1113

    
1114
/*
1115
 * scsi_build_sense
1116
 *
1117
 * Convert between fixed and descriptor sense buffers
1118
 */
1119
int scsi_build_sense(uint8_t *in_buf, int in_len,
1120
                     uint8_t *buf, int len, bool fixed)
1121
{
1122
    bool fixed_in;
1123
    SCSISense sense;
1124
    if (!fixed && len < 8) {
1125
        return 0;
1126
    }
1127

    
1128
    if (in_len == 0) {
1129
        sense.key = NO_SENSE;
1130
        sense.asc = 0;
1131
        sense.ascq = 0;
1132
    } else {
1133
        fixed_in = (in_buf[0] & 2) == 0;
1134

    
1135
        if (fixed == fixed_in) {
1136
            memcpy(buf, in_buf, MIN(len, in_len));
1137
            return MIN(len, in_len);
1138
        }
1139

    
1140
        if (fixed_in) {
1141
            sense.key = in_buf[2];
1142
            sense.asc = in_buf[12];
1143
            sense.ascq = in_buf[13];
1144
        } else {
1145
            sense.key = in_buf[1];
1146
            sense.asc = in_buf[2];
1147
            sense.ascq = in_buf[3];
1148
        }
1149
    }
1150

    
1151
    memset(buf, 0, len);
1152
    if (fixed) {
1153
        /* Return fixed format sense buffer */
1154
        buf[0] = 0xf0;
1155
        buf[2] = sense.key;
1156
        buf[7] = 10;
1157
        buf[12] = sense.asc;
1158
        buf[13] = sense.ascq;
1159
        return MIN(len, 18);
1160
    } else {
1161
        /* Return descriptor format sense buffer */
1162
        buf[0] = 0x72;
1163
        buf[1] = sense.key;
1164
        buf[2] = sense.asc;
1165
        buf[3] = sense.ascq;
1166
        return 8;
1167
    }
1168
}
1169

    
1170
static const char *scsi_command_name(uint8_t cmd)
1171
{
1172
    static const char *names[] = {
1173
        [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
1174
        [ REWIND                   ] = "REWIND",
1175
        [ REQUEST_SENSE            ] = "REQUEST_SENSE",
1176
        [ FORMAT_UNIT              ] = "FORMAT_UNIT",
1177
        [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
1178
        [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS",
1179
        [ READ_6                   ] = "READ_6",
1180
        [ WRITE_6                  ] = "WRITE_6",
1181
        [ SET_CAPACITY             ] = "SET_CAPACITY",
1182
        [ READ_REVERSE             ] = "READ_REVERSE",
1183
        [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
1184
        [ SPACE                    ] = "SPACE",
1185
        [ INQUIRY                  ] = "INQUIRY",
1186
        [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
1187
        [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
1188
        [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
1189
        [ MODE_SELECT              ] = "MODE_SELECT",
1190
        [ RESERVE                  ] = "RESERVE",
1191
        [ RELEASE                  ] = "RELEASE",
1192
        [ COPY                     ] = "COPY",
1193
        [ ERASE                    ] = "ERASE",
1194
        [ MODE_SENSE               ] = "MODE_SENSE",
1195
        [ START_STOP               ] = "START_STOP",
1196
        [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
1197
        [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
1198
        [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
1199
        [ READ_CAPACITY_10         ] = "READ_CAPACITY_10",
1200
        [ READ_10                  ] = "READ_10",
1201
        [ WRITE_10                 ] = "WRITE_10",
1202
        [ SEEK_10                  ] = "SEEK_10",
1203
        [ WRITE_VERIFY_10          ] = "WRITE_VERIFY_10",
1204
        [ VERIFY_10                ] = "VERIFY_10",
1205
        [ SEARCH_HIGH              ] = "SEARCH_HIGH",
1206
        [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
1207
        [ SEARCH_LOW               ] = "SEARCH_LOW",
1208
        [ SET_LIMITS               ] = "SET_LIMITS",
1209
        [ PRE_FETCH                ] = "PRE_FETCH/READ_POSITION",
1210
        /* READ_POSITION and PRE_FETCH use the same operation code */
1211
        [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
1212
        [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
1213
        [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA",
1214
        [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
1215
        [ COMPARE                  ] = "COMPARE",
1216
        [ COPY_VERIFY              ] = "COPY_VERIFY",
1217
        [ WRITE_BUFFER             ] = "WRITE_BUFFER",
1218
        [ READ_BUFFER              ] = "READ_BUFFER",
1219
        [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
1220
        [ READ_LONG_10             ] = "READ_LONG_10",
1221
        [ WRITE_LONG_10            ] = "WRITE_LONG_10",
1222
        [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
1223
        [ WRITE_SAME_10            ] = "WRITE_SAME_10",
1224
        [ UNMAP                    ] = "UNMAP",
1225
        [ READ_TOC                 ] = "READ_TOC",
1226
        [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
1227
        [ SANITIZE                 ] = "SANITIZE",
1228
        [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
1229
        [ LOG_SELECT               ] = "LOG_SELECT",
1230
        [ LOG_SENSE                ] = "LOG_SENSE",
1231
        [ MODE_SELECT_10           ] = "MODE_SELECT_10",
1232
        [ RESERVE_10               ] = "RESERVE_10",
1233
        [ RELEASE_10               ] = "RELEASE_10",
1234
        [ MODE_SENSE_10            ] = "MODE_SENSE_10",
1235
        [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
1236
        [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
1237
        [ WRITE_FILEMARKS_16       ] = "WRITE_FILEMARKS_16",
1238
        [ EXTENDED_COPY            ] = "EXTENDED_COPY",
1239
        [ ATA_PASSTHROUGH          ] = "ATA_PASSTHROUGH",
1240
        [ ACCESS_CONTROL_IN        ] = "ACCESS_CONTROL_IN",
1241
        [ ACCESS_CONTROL_OUT       ] = "ACCESS_CONTROL_OUT",
1242
        [ READ_16                  ] = "READ_16",
1243
        [ COMPARE_AND_WRITE        ] = "COMPARE_AND_WRITE",
1244
        [ WRITE_16                 ] = "WRITE_16",
1245
        [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
1246
        [ VERIFY_16                ] = "VERIFY_16",
1247
        [ PRE_FETCH_16             ] = "PRE_FETCH_16",
1248
        [ SYNCHRONIZE_CACHE_16     ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1249
        /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1250
        [ LOCATE_16                ] = "LOCATE_16",
1251
        [ WRITE_SAME_16            ] = "ERASE_16/WRITE_SAME_16",
1252
        /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1253
        [ SERVICE_ACTION_IN_16     ] = "SERVICE_ACTION_IN_16",
1254
        [ WRITE_LONG_16            ] = "WRITE_LONG_16",
1255
        [ REPORT_LUNS              ] = "REPORT_LUNS",
1256
        [ BLANK                    ] = "BLANK",
1257
        [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
1258
        [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
1259
        [ READ_12                  ] = "READ_12",
1260
        [ WRITE_12                 ] = "WRITE_12",
1261
        [ ERASE_12                 ] = "ERASE_12/GET_PERFORMANCE",
1262
        /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1263
        [ SERVICE_ACTION_IN_12     ] = "SERVICE_ACTION_IN_12",
1264
        [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
1265
        [ VERIFY_12                ] = "VERIFY_12",
1266
        [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
1267
        [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
1268
        [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
1269
        [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
1270
        [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG/SET_STREAMING",
1271
        /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1272
        [ READ_CD                  ] = "READ_CD",
1273
        [ READ_DEFECT_DATA_12      ] = "READ_DEFECT_DATA_12",
1274
        [ READ_DVD_STRUCTURE       ] = "READ_DVD_STRUCTURE",
1275
        [ RESERVE_TRACK            ] = "RESERVE_TRACK",
1276
        [ SEND_CUE_SHEET           ] = "SEND_CUE_SHEET",
1277
        [ SEND_DVD_STRUCTURE       ] = "SEND_DVD_STRUCTURE",
1278
        [ SET_CD_SPEED             ] = "SET_CD_SPEED",
1279
        [ SET_READ_AHEAD           ] = "SET_READ_AHEAD",
1280
        [ ALLOW_OVERWRITE          ] = "ALLOW_OVERWRITE",
1281
        [ MECHANISM_STATUS         ] = "MECHANISM_STATUS",
1282
    };
1283

    
1284
    if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1285
        return "*UNKNOWN*";
1286
    return names[cmd];
1287
}
1288

    
1289
SCSIRequest *scsi_req_ref(SCSIRequest *req)
1290
{
1291
    req->refcount++;
1292
    return req;
1293
}
1294

    
1295
void scsi_req_unref(SCSIRequest *req)
1296
{
1297
    if (--req->refcount == 0) {
1298
        if (req->ops->free_req) {
1299
            req->ops->free_req(req);
1300
        }
1301
        g_free(req);
1302
    }
1303
}
1304

    
1305
/* Tell the device that we finished processing this chunk of I/O.  It
1306
   will start the next chunk or complete the command.  */
1307
void scsi_req_continue(SCSIRequest *req)
1308
{
1309
    trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1310
    if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1311
        req->ops->write_data(req);
1312
    } else {
1313
        req->ops->read_data(req);
1314
    }
1315
}
1316

    
1317
/* Called by the devices when data is ready for the HBA.  The HBA should
1318
   start a DMA operation to read or fill the device's data buffer.
1319
   Once it completes, calling scsi_req_continue will restart I/O.  */
1320
void scsi_req_data(SCSIRequest *req, int len)
1321
{
1322
    uint8_t *buf;
1323
    if (req->io_canceled) {
1324
        trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
1325
        return;
1326
    }
1327
    trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1328
    assert(req->cmd.mode != SCSI_XFER_NONE);
1329
    if (!req->sg) {
1330
        req->resid -= len;
1331
        req->bus->info->transfer_data(req, len);
1332
        return;
1333
    }
1334

    
1335
    /* If the device calls scsi_req_data and the HBA specified a
1336
     * scatter/gather list, the transfer has to happen in a single
1337
     * step.  */
1338
    assert(!req->dma_started);
1339
    req->dma_started = true;
1340

    
1341
    buf = scsi_req_get_buf(req);
1342
    if (req->cmd.mode == SCSI_XFER_FROM_DEV) {
1343
        req->resid = dma_buf_read(buf, len, req->sg);
1344
    } else {
1345
        req->resid = dma_buf_write(buf, len, req->sg);
1346
    }
1347
    scsi_req_continue(req);
1348
}
1349

    
1350
void scsi_req_print(SCSIRequest *req)
1351
{
1352
    FILE *fp = stderr;
1353
    int i;
1354

    
1355
    fprintf(fp, "[%s id=%d] %s",
1356
            req->dev->qdev.parent_bus->name,
1357
            req->dev->id,
1358
            scsi_command_name(req->cmd.buf[0]));
1359
    for (i = 1; i < req->cmd.len; i++) {
1360
        fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1361
    }
1362
    switch (req->cmd.mode) {
1363
    case SCSI_XFER_NONE:
1364
        fprintf(fp, " - none\n");
1365
        break;
1366
    case SCSI_XFER_FROM_DEV:
1367
        fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1368
        break;
1369
    case SCSI_XFER_TO_DEV:
1370
        fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1371
        break;
1372
    default:
1373
        fprintf(fp, " - Oops\n");
1374
        break;
1375
    }
1376
}
1377

    
1378
void scsi_req_complete(SCSIRequest *req, int status)
1379
{
1380
    assert(req->status == -1);
1381
    req->status = status;
1382

    
1383
    assert(req->sense_len < sizeof(req->sense));
1384
    if (status == GOOD) {
1385
        req->sense_len = 0;
1386
    }
1387

    
1388
    if (req->sense_len) {
1389
        memcpy(req->dev->sense, req->sense, req->sense_len);
1390
        req->dev->sense_len = req->sense_len;
1391
        req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1392
    } else {
1393
        req->dev->sense_len = 0;
1394
        req->dev->sense_is_ua = false;
1395
    }
1396

    
1397
    /*
1398
     * Unit attention state is now stored in the device's sense buffer
1399
     * if the HBA didn't do autosense.  Clear the pending unit attention
1400
     * flags.
1401
     */
1402
    scsi_clear_unit_attention(req);
1403

    
1404
    scsi_req_ref(req);
1405
    scsi_req_dequeue(req);
1406
    req->bus->info->complete(req, req->status, req->resid);
1407
    scsi_req_unref(req);
1408
}
1409

    
1410
void scsi_req_cancel(SCSIRequest *req)
1411
{
1412
    if (!req->enqueued) {
1413
        return;
1414
    }
1415
    scsi_req_ref(req);
1416
    scsi_req_dequeue(req);
1417
    req->io_canceled = true;
1418
    if (req->ops->cancel_io) {
1419
        req->ops->cancel_io(req);
1420
    }
1421
    if (req->bus->info->cancel) {
1422
        req->bus->info->cancel(req);
1423
    }
1424
    scsi_req_unref(req);
1425
}
1426

    
1427
void scsi_req_abort(SCSIRequest *req, int status)
1428
{
1429
    if (!req->enqueued) {
1430
        return;
1431
    }
1432
    scsi_req_ref(req);
1433
    scsi_req_dequeue(req);
1434
    req->io_canceled = true;
1435
    if (req->ops->cancel_io) {
1436
        req->ops->cancel_io(req);
1437
    }
1438
    scsi_req_complete(req, status);
1439
    scsi_req_unref(req);
1440
}
1441

    
1442
void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
1443
{
1444
    SCSIRequest *req;
1445

    
1446
    while (!QTAILQ_EMPTY(&sdev->requests)) {
1447
        req = QTAILQ_FIRST(&sdev->requests);
1448
        scsi_req_cancel(req);
1449
    }
1450
    sdev->unit_attention = sense;
1451
}
1452

    
1453
static char *scsibus_get_dev_path(DeviceState *dev)
1454
{
1455
    SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
1456
    DeviceState *hba = dev->parent_bus->parent;
1457
    char *id = NULL;
1458
    char *path;
1459

    
1460
    if (hba && hba->parent_bus && hba->parent_bus->info->get_dev_path) {
1461
        id = hba->parent_bus->info->get_dev_path(hba);
1462
    }
1463
    if (id) {
1464
        path = g_strdup_printf("%s/%d:%d:%d", id, d->channel, d->id, d->lun);
1465
    } else {
1466
        path = g_strdup_printf("%d:%d:%d", d->channel, d->id, d->lun);
1467
    }
1468
    g_free(id);
1469
    return path;
1470
}
1471

    
1472
static char *scsibus_get_fw_dev_path(DeviceState *dev)
1473
{
1474
    SCSIDevice *d = SCSI_DEVICE(dev);
1475
    char path[100];
1476

    
1477
    snprintf(path, sizeof(path), "channel@%x/%s@%x,%x", d->channel,
1478
             qdev_fw_name(dev), d->id, d->lun);
1479

    
1480
    return strdup(path);
1481
}
1482

    
1483
SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
1484
{
1485
    DeviceState *qdev;
1486
    SCSIDevice *target_dev = NULL;
1487

    
1488
    QTAILQ_FOREACH_REVERSE(qdev, &bus->qbus.children, ChildrenHead, sibling) {
1489
        SCSIDevice *dev = SCSI_DEVICE(qdev);
1490

    
1491
        if (dev->channel == channel && dev->id == id) {
1492
            if (dev->lun == lun) {
1493
                return dev;
1494
            }
1495
            target_dev = dev;
1496
        }
1497
    }
1498
    return target_dev;
1499
}
1500

    
1501
/* SCSI request list.  For simplicity, pv points to the whole device */
1502

    
1503
static void put_scsi_requests(QEMUFile *f, void *pv, size_t size)
1504
{
1505
    SCSIDevice *s = pv;
1506
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1507
    SCSIRequest *req;
1508

    
1509
    QTAILQ_FOREACH(req, &s->requests, next) {
1510
        assert(!req->io_canceled);
1511
        assert(req->status == -1);
1512
        assert(req->retry);
1513
        assert(req->enqueued);
1514

    
1515
        qemu_put_sbyte(f, 1);
1516
        qemu_put_buffer(f, req->cmd.buf, sizeof(req->cmd.buf));
1517
        qemu_put_be32s(f, &req->tag);
1518
        qemu_put_be32s(f, &req->lun);
1519
        if (bus->info->save_request) {
1520
            bus->info->save_request(f, req);
1521
        }
1522
        if (req->ops->save_request) {
1523
            req->ops->save_request(f, req);
1524
        }
1525
    }
1526
    qemu_put_sbyte(f, 0);
1527
}
1528

    
1529
static int get_scsi_requests(QEMUFile *f, void *pv, size_t size)
1530
{
1531
    SCSIDevice *s = pv;
1532
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1533

    
1534
    while (qemu_get_sbyte(f)) {
1535
        uint8_t buf[SCSI_CMD_BUF_SIZE];
1536
        uint32_t tag;
1537
        uint32_t lun;
1538
        SCSIRequest *req;
1539

    
1540
        qemu_get_buffer(f, buf, sizeof(buf));
1541
        qemu_get_be32s(f, &tag);
1542
        qemu_get_be32s(f, &lun);
1543
        req = scsi_req_new(s, tag, lun, buf, NULL);
1544
        if (bus->info->load_request) {
1545
            req->hba_private = bus->info->load_request(f, req);
1546
        }
1547
        if (req->ops->load_request) {
1548
            req->ops->load_request(f, req);
1549
        }
1550

    
1551
        /* Just restart it later.  */
1552
        req->retry = true;
1553
        scsi_req_enqueue_internal(req);
1554

    
1555
        /* At this point, the request will be kept alive by the reference
1556
         * added by scsi_req_enqueue_internal, so we can release our reference.
1557
         * The HBA of course will add its own reference in the load_request
1558
         * callback if it needs to hold on the SCSIRequest.
1559
         */
1560
        scsi_req_unref(req);
1561
    }
1562

    
1563
    return 0;
1564
}
1565

    
1566
const VMStateInfo vmstate_info_scsi_requests = {
1567
    .name = "scsi-requests",
1568
    .get  = get_scsi_requests,
1569
    .put  = put_scsi_requests,
1570
};
1571

    
1572
const VMStateDescription vmstate_scsi_device = {
1573
    .name = "SCSIDevice",
1574
    .version_id = 1,
1575
    .minimum_version_id = 1,
1576
    .minimum_version_id_old = 1,
1577
    .fields = (VMStateField[]) {
1578
        VMSTATE_UINT8(unit_attention.key, SCSIDevice),
1579
        VMSTATE_UINT8(unit_attention.asc, SCSIDevice),
1580
        VMSTATE_UINT8(unit_attention.ascq, SCSIDevice),
1581
        VMSTATE_BOOL(sense_is_ua, SCSIDevice),
1582
        VMSTATE_UINT8_ARRAY(sense, SCSIDevice, SCSI_SENSE_BUF_SIZE),
1583
        VMSTATE_UINT32(sense_len, SCSIDevice),
1584
        {
1585
            .name         = "requests",
1586
            .version_id   = 0,
1587
            .field_exists = NULL,
1588
            .size         = 0,   /* ouch */
1589
            .info         = &vmstate_info_scsi_requests,
1590
            .flags        = VMS_SINGLE,
1591
            .offset       = 0,
1592
        },
1593
        VMSTATE_END_OF_LIST()
1594
    }
1595
};
1596

    
1597
static void scsi_device_class_init(ObjectClass *klass, void *data)
1598
{
1599
    DeviceClass *k = DEVICE_CLASS(klass);
1600
    k->bus_info = &scsi_bus_info;
1601
    k->init     = scsi_qdev_init;
1602
    k->unplug   = qdev_simple_unplug_cb;
1603
    k->exit     = scsi_qdev_exit;
1604
}
1605

    
1606
static TypeInfo scsi_device_type_info = {
1607
    .name = TYPE_SCSI_DEVICE,
1608
    .parent = TYPE_DEVICE,
1609
    .instance_size = sizeof(SCSIDevice),
1610
    .abstract = true,
1611
    .class_size = sizeof(SCSIDeviceClass),
1612
    .class_init = scsi_device_class_init,
1613
};
1614

    
1615
static void scsi_register_types(void)
1616
{
1617
    type_register_static(&scsi_device_type_info);
1618
}
1619

    
1620
type_init(scsi_register_types)