hw/scsi-bus.c

   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
   8 static struct BusInfo scsi_bus_info = {
   9     .name  = "SCSI",
  10     .size  = sizeof(SCSIBus),
  11     .props = (Property[]) {
  12         DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
  13         DEFINE_PROP_END_OF_LIST(),
  14     },
  15 };
  16 static int next_scsi_bus;
  17
  18 /* Create a scsi bus, and attach devices to it.  */
  19 void scsi_bus_new(SCSIBus *bus, DeviceState *host, int tcq, int ndev,
  20                   scsi_completionfn complete)
  21 {
  22     qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
  23     bus->busnr = next_scsi_bus++;
  24     bus->tcq = tcq;
  25     bus->ndev = ndev;
  26     bus->complete = complete;
  27     bus->qbus.allow_hotplug = 1;
  28 }
  29
  30 static int scsi_qdev_init(DeviceState *qdev, DeviceInfo *base)
  31 {
  32     SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
  33     SCSIDeviceInfo *info = DO_UPCAST(SCSIDeviceInfo, qdev, base);
  34     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
  35     int rc = -1;
  36
  37     if (dev->id == -1) {
  38         for (dev->id = 0; dev->id < bus->ndev; dev->id++) {
  39             if (bus->devs[dev->id] == NULL)
  40                 break;
  41         }
  42     }
  43     if (dev->id >= bus->ndev) {
  44         error_report("bad scsi device id: %d", dev->id);
  45         goto err;
  46     }
  47
  48     if (bus->devs[dev->id]) {
  49         qdev_free(&bus->devs[dev->id]->qdev);
  50     }
  51     bus->devs[dev->id] = dev;
  52
  53     dev->info = info;
  54     QTAILQ_INIT(&dev->requests);
  55     rc = dev->info->init(dev);
  56     if (rc != 0) {
  57         bus->devs[dev->id] = NULL;
  58     }
  59
  60 err:
  61     return rc;
  62 }
  63
  64 static int scsi_qdev_exit(DeviceState *qdev)
  65 {
  66     SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
  67     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
  68
  69     assert(bus->devs[dev->id] != NULL);
  70     if (bus->devs[dev->id]->info->destroy) {
  71         bus->devs[dev->id]->info->destroy(bus->devs[dev->id]);
  72     }
  73     bus->devs[dev->id] = NULL;
  74     return 0;
  75 }
  76
  77 void scsi_qdev_register(SCSIDeviceInfo *info)
  78 {
  79     info->qdev.bus_info = &scsi_bus_info;
  80     info->qdev.init     = scsi_qdev_init;
  81     info->qdev.unplug   = qdev_simple_unplug_cb;
  82     info->qdev.exit     = scsi_qdev_exit;
  83     qdev_register(&info->qdev);
  84 }
  85
  86 /* handle legacy '-drive if=scsi,...' cmd line args */
  87 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv, int unit)
  88 {
  89     const char *driver;
  90     DeviceState *dev;
  91
  92     driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
  93     dev = qdev_create(&bus->qbus, driver);
  94     qdev_prop_set_uint32(dev, "scsi-id", unit);
  95     if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
  96         qdev_free(dev);
  97         return NULL;
  98     }
  99     if (qdev_init(dev) < 0)
 100         return NULL;
 101     return DO_UPCAST(SCSIDevice, qdev, dev);
 102 }
 103
 104 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
 105 {
 106     Location loc;
 107     DriveInfo *dinfo;
 108     int res = 0, unit;
 109
 110     loc_push_none(&loc);
 111     for (unit = 0; unit < bus->ndev; unit++) {
 112         dinfo = drive_get(IF_SCSI, bus->busnr, unit);
 113         if (dinfo == NULL) {
 114             continue;
 115         }
 116         qemu_opts_loc_restore(dinfo->opts);
 117         if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit)) {
 118             res = -1;
 119             break;
 120         }
 121     }
 122     loc_pop(&loc);
 123     return res;
 124 }
 125
 126 SCSIRequest *scsi_req_alloc(size_t size, SCSIDevice *d, uint32_t tag, uint32_t lun)
 127 {
 128     SCSIRequest *req;
 129
 130     req = qemu_mallocz(size);
 131     req->bus = scsi_bus_from_device(d);
 132     req->dev = d;
 133     req->tag = tag;
 134     req->lun = lun;
 135     req->status = -1;
 136     req->enqueued = true;
 137     QTAILQ_INSERT_TAIL(&d->requests, req, next);
 138     return req;
 139 }
 140
 141 SCSIRequest *scsi_req_find(SCSIDevice *d, uint32_t tag)
 142 {
 143     SCSIRequest *req;
 144
 145     QTAILQ_FOREACH(req, &d->requests, next) {
 146         if (req->tag == tag) {
 147             return req;
 148         }
 149     }
 150     return NULL;
 151 }
 152
 153 static void scsi_req_dequeue(SCSIRequest *req)
 154 {
 155     if (req->enqueued) {
 156         QTAILQ_REMOVE(&req->dev->requests, req, next);
 157         req->enqueued = false;
 158     }
 159 }
 160
 161 void scsi_req_free(SCSIRequest *req)
 162 {
 163     scsi_req_dequeue(req);
 164     qemu_free(req);
 165 }
 166
 167 static int scsi_req_length(SCSIRequest *req, uint8_t *cmd)
 168 {
 169     switch (cmd[0] >> 5) {
 170     case 0:
 171         req->cmd.xfer = cmd[4];
 172         req->cmd.len = 6;
 173         /* length 0 means 256 blocks */
 174         if (req->cmd.xfer == 0)
 175             req->cmd.xfer = 256;
 176         break;
 177     case 1:
 178     case 2:
 179         req->cmd.xfer = cmd[8] | (cmd[7] << 8);
 180         req->cmd.len = 10;
 181         break;
 182     case 4:
 183         req->cmd.xfer = cmd[13] | (cmd[12] << 8) | (cmd[11] << 16) | (cmd[10] << 24);
 184         req->cmd.len = 16;
 185         break;
 186     case 5:
 187         req->cmd.xfer = cmd[9] | (cmd[8] << 8) | (cmd[7] << 16) | (cmd[6] << 24);
 188         req->cmd.len = 12;
 189         break;
 190     default:
 191         return -1;
 192     }
 193
 194     switch(cmd[0]) {
 195     case TEST_UNIT_READY:
 196     case REZERO_UNIT:
 197     case START_STOP:
 198     case SEEK_6:
 199     case WRITE_FILEMARKS:
 200     case SPACE:
 201     case RESERVE:
 202     case RELEASE:
 203     case ERASE:
 204     case ALLOW_MEDIUM_REMOVAL:
 205     case VERIFY:
 206     case SEEK_10:
 207     case SYNCHRONIZE_CACHE:
 208     case LOCK_UNLOCK_CACHE:
 209     case LOAD_UNLOAD:
 210     case SET_CD_SPEED:
 211     case SET_LIMITS:
 212     case WRITE_LONG:
 213     case MOVE_MEDIUM:
 214     case UPDATE_BLOCK:
 215         req->cmd.xfer = 0;
 216         break;
 217     case MODE_SENSE:
 218         break;
 219     case WRITE_SAME:
 220         req->cmd.xfer = 1;
 221         break;
 222     case READ_CAPACITY:
 223         req->cmd.xfer = 8;
 224         break;
 225     case READ_BLOCK_LIMITS:
 226         req->cmd.xfer = 6;
 227         break;
 228     case READ_POSITION:
 229         req->cmd.xfer = 20;
 230         break;
 231     case SEND_VOLUME_TAG:
 232         req->cmd.xfer *= 40;
 233         break;
 234     case MEDIUM_SCAN:
 235         req->cmd.xfer *= 8;
 236         break;
 237     case WRITE_10:
 238     case WRITE_VERIFY:
 239     case WRITE_6:
 240     case WRITE_12:
 241     case WRITE_VERIFY_12:
 242     case WRITE_16:
 243     case WRITE_VERIFY_16:
 244         req->cmd.xfer *= req->dev->blocksize;
 245         break;
 246     case READ_10:
 247     case READ_6:
 248     case READ_REVERSE:
 249     case RECOVER_BUFFERED_DATA:
 250     case READ_12:
 251     case READ_16:
 252         req->cmd.xfer *= req->dev->blocksize;
 253         break;
 254     case INQUIRY:
 255         req->cmd.xfer = cmd[4] | (cmd[3] << 8);
 256         break;
 257     case MAINTENANCE_OUT:
 258     case MAINTENANCE_IN:
 259         if (req->dev->type == TYPE_ROM) {
 260             /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
 261             req->cmd.xfer = cmd[9] | (cmd[8] << 8);
 262         }
 263         break;
 264     }
 265     return 0;
 266 }
 267
 268 static int scsi_req_stream_length(SCSIRequest *req, uint8_t *cmd)
 269 {
 270     switch(cmd[0]) {
 271     /* stream commands */
 272     case READ_6:
 273     case READ_REVERSE:
 274     case RECOVER_BUFFERED_DATA:
 275     case WRITE_6:
 276         req->cmd.len = 6;
 277         req->cmd.xfer = cmd[4] | (cmd[3] << 8) | (cmd[2] << 16);
 278         if (cmd[1] & 0x01) /* fixed */
 279             req->cmd.xfer *= req->dev->blocksize;
 280         break;
 281     case REWIND:
 282     case START_STOP:
 283         req->cmd.len = 6;
 284         req->cmd.xfer = 0;
 285         break;
 286     /* generic commands */
 287     default:
 288         return scsi_req_length(req, cmd);
 289     }
 290     return 0;
 291 }
 292
 293 static void scsi_req_xfer_mode(SCSIRequest *req)
 294 {
 295     switch (req->cmd.buf[0]) {
 296     case WRITE_6:
 297     case WRITE_10:
 298     case WRITE_VERIFY:
 299     case WRITE_12:
 300     case WRITE_VERIFY_12:
 301     case WRITE_16:
 302     case WRITE_VERIFY_16:
 303     case COPY:
 304     case COPY_VERIFY:
 305     case COMPARE:
 306     case CHANGE_DEFINITION:
 307     case LOG_SELECT:
 308     case MODE_SELECT:
 309     case MODE_SELECT_10:
 310     case SEND_DIAGNOSTIC:
 311     case WRITE_BUFFER:
 312     case FORMAT_UNIT:
 313     case REASSIGN_BLOCKS:
 314     case SEARCH_EQUAL:
 315     case SEARCH_HIGH:
 316     case SEARCH_LOW:
 317     case UPDATE_BLOCK:
 318     case WRITE_LONG:
 319     case WRITE_SAME:
 320     case SEARCH_HIGH_12:
 321     case SEARCH_EQUAL_12:
 322     case SEARCH_LOW_12:
 323     case SET_WINDOW:
 324     case MEDIUM_SCAN:
 325     case SEND_VOLUME_TAG:
 326     case WRITE_LONG_2:
 327     case PERSISTENT_RESERVE_OUT:
 328     case MAINTENANCE_OUT:
 329         req->cmd.mode = SCSI_XFER_TO_DEV;
 330         break;
 331     default:
 332         if (req->cmd.xfer)
 333             req->cmd.mode = SCSI_XFER_FROM_DEV;
 334         else {
 335             req->cmd.mode = SCSI_XFER_NONE;
 336         }
 337         break;
 338     }
 339 }
 340
 341 static uint64_t scsi_req_lba(SCSIRequest *req)
 342 {
 343     uint8_t *buf = req->cmd.buf;
 344     uint64_t lba;
 345
 346     switch (buf[0] >> 5) {
 347     case 0:
 348         lba = (uint64_t) buf[3] | ((uint64_t) buf[2] << 8) |
 349               (((uint64_t) buf[1] & 0x1f) << 16);
 350         break;
 351     case 1:
 352     case 2:
 353         lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
 354               ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
 355         break;
 356     case 4:
 357         lba = (uint64_t) buf[9] | ((uint64_t) buf[8] << 8) |
 358               ((uint64_t) buf[7] << 16) | ((uint64_t) buf[6] << 24) |
 359               ((uint64_t) buf[5] << 32) | ((uint64_t) buf[4] << 40) |
 360               ((uint64_t) buf[3] << 48) | ((uint64_t) buf[2] << 56);
 361         break;
 362     case 5:
 363         lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
 364               ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
 365         break;
 366     default:
 367         lba = -1;
 368
 369     }
 370     return lba;
 371 }
 372
 373 int scsi_req_parse(SCSIRequest *req, uint8_t *buf)
 374 {
 375     int rc;
 376
 377     if (req->dev->type == TYPE_TAPE) {
 378         rc = scsi_req_stream_length(req, buf);
 379     } else {
 380         rc = scsi_req_length(req, buf);
 381     }
 382     if (rc != 0)
 383         return rc;
 384
 385     memcpy(req->cmd.buf, buf, req->cmd.len);
 386     scsi_req_xfer_mode(req);
 387     req->cmd.lba = scsi_req_lba(req);
 388     return 0;
 389 }
 390
 391 static const char *scsi_command_name(uint8_t cmd)
 392 {
 393     static const char *names[] = {
 394         [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
 395         [ REZERO_UNIT              ] = "REZERO_UNIT",
 396         /* REWIND and REZERO_UNIT use the same operation code */
 397         [ REQUEST_SENSE            ] = "REQUEST_SENSE",
 398         [ FORMAT_UNIT              ] = "FORMAT_UNIT",
 399         [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
 400         [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS",
 401         [ READ_6                   ] = "READ_6",
 402         [ WRITE_6                  ] = "WRITE_6",
 403         [ SEEK_6                   ] = "SEEK_6",
 404         [ READ_REVERSE             ] = "READ_REVERSE",
 405         [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
 406         [ SPACE                    ] = "SPACE",
 407         [ INQUIRY                  ] = "INQUIRY",
 408         [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
 409         [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
 410         [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
 411         [ MODE_SELECT              ] = "MODE_SELECT",
 412         [ RESERVE                  ] = "RESERVE",
 413         [ RELEASE                  ] = "RELEASE",
 414         [ COPY                     ] = "COPY",
 415         [ ERASE                    ] = "ERASE",
 416         [ MODE_SENSE               ] = "MODE_SENSE",
 417         [ START_STOP               ] = "START_STOP",
 418         [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
 419         [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
 420         [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
 421
 422         [ SET_WINDOW               ] = "SET_WINDOW",
 423         [ READ_CAPACITY            ] = "READ_CAPACITY",
 424         [ READ_10                  ] = "READ_10",
 425         [ WRITE_10                 ] = "WRITE_10",
 426         [ SEEK_10                  ] = "SEEK_10",
 427         [ WRITE_VERIFY             ] = "WRITE_VERIFY",
 428         [ VERIFY                   ] = "VERIFY",
 429         [ SEARCH_HIGH              ] = "SEARCH_HIGH",
 430         [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
 431         [ SEARCH_LOW               ] = "SEARCH_LOW",
 432         [ SET_LIMITS               ] = "SET_LIMITS",
 433         [ PRE_FETCH                ] = "PRE_FETCH",
 434         /* READ_POSITION and PRE_FETCH use the same operation code */
 435         [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
 436         [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
 437         [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA",
 438         [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
 439         [ COMPARE                  ] = "COMPARE",
 440         [ COPY_VERIFY              ] = "COPY_VERIFY",
 441         [ WRITE_BUFFER             ] = "WRITE_BUFFER",
 442         [ READ_BUFFER              ] = "READ_BUFFER",
 443         [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
 444         [ READ_LONG                ] = "READ_LONG",
 445         [ WRITE_LONG               ] = "WRITE_LONG",
 446         [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
 447         [ WRITE_SAME               ] = "WRITE_SAME",
 448         [ READ_TOC                 ] = "READ_TOC",
 449         [ LOG_SELECT               ] = "LOG_SELECT",
 450         [ LOG_SENSE                ] = "LOG_SENSE",
 451         [ MODE_SELECT_10           ] = "MODE_SELECT_10",
 452         [ RESERVE_10               ] = "RESERVE_10",
 453         [ RELEASE_10               ] = "RELEASE_10",
 454         [ MODE_SENSE_10            ] = "MODE_SENSE_10",
 455         [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
 456         [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
 457         [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
 458         [ READ_12                  ] = "READ_12",
 459         [ WRITE_12                 ] = "WRITE_12",
 460         [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
 461         [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
 462         [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
 463         [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
 464         [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
 465         [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG",
 466         [ WRITE_LONG_2             ] = "WRITE_LONG_2",
 467
 468         [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
 469         [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
 470         [ READ_16                  ] = "READ_16",
 471         [ WRITE_16                 ] = "WRITE_16",
 472         [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
 473         [ SERVICE_ACTION_IN        ] = "SERVICE_ACTION_IN",
 474         [ REPORT_LUNS              ] = "REPORT_LUNS",
 475         [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
 476         [ SET_CD_SPEED             ] = "SET_CD_SPEED",
 477         [ BLANK                    ] = "BLANK",
 478     };
 479
 480     if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
 481         return "*UNKNOWN*";
 482     return names[cmd];
 483 }
 484
 485 void scsi_req_print(SCSIRequest *req)
 486 {
 487     FILE *fp = stderr;
 488     int i;
 489
 490     fprintf(fp, "[%s id=%d] %s",
 491             req->dev->qdev.parent_bus->name,
 492             req->dev->id,
 493             scsi_command_name(req->cmd.buf[0]));
 494     for (i = 1; i < req->cmd.len; i++) {
 495         fprintf(fp, " 0x%02x", req->cmd.buf[i]);
 496     }
 497     switch (req->cmd.mode) {
 498     case SCSI_XFER_NONE:
 499         fprintf(fp, " - none\n");
 500         break;
 501     case SCSI_XFER_FROM_DEV:
 502         fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
 503         break;
 504     case SCSI_XFER_TO_DEV:
 505         fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
 506         break;
 507     default:
 508         fprintf(fp, " - Oops\n");
 509         break;
 510     }
 511 }
 512
 513 void scsi_req_complete(SCSIRequest *req)
 514 {
 515     assert(req->status != -1);
 516     scsi_req_dequeue(req);
 517     req->bus->complete(req->bus, SCSI_REASON_DONE,
 518                        req->tag,
 519                        req->status);
 520 }