[qemu.git] / hw / scsi-bus.c

#include "hw.h"
#include "qemu-error.h"
#include "scsi.h"
#include "scsi-defs.h"
#include "qdev.h"
#include "blockdev.h"
#include "trace.h"

static char *scsibus_get_fw_dev_path(DeviceState *dev);

static struct BusInfo scsi_bus_info = {
    .name  = "SCSI",
    .size  = sizeof(SCSIBus),
    .get_fw_dev_path = scsibus_get_fw_dev_path,
    .props = (Property[]) {
        DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
        DEFINE_PROP_END_OF_LIST(),
    },
};
static int next_scsi_bus;

/* Create a scsi bus, and attach devices to it.  */
void scsi_bus_new(SCSIBus *bus, DeviceState *host, int tcq, int ndev,
                  scsi_completionfn complete)
{
    qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
    bus->busnr = next_scsi_bus++;
    bus->tcq = tcq;
    bus->ndev = ndev;
    bus->complete = complete;
    bus->qbus.allow_hotplug = 1;
}

static int scsi_qdev_init(DeviceState *qdev, DeviceInfo *base)
{
    SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
    SCSIDeviceInfo *info = DO_UPCAST(SCSIDeviceInfo, qdev, base);
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
    int rc = -1;

    if (dev->id == -1) {
        for (dev->id = 0; dev->id < bus->ndev; dev->id++) {
            if (bus->devs[dev->id] == NULL)
                break;
        }
    }
    if (dev->id >= bus->ndev) {
        error_report("bad scsi device id: %d", dev->id);
        goto err;
    }

    if (bus->devs[dev->id]) {
        qdev_free(&bus->devs[dev->id]->qdev);
    }
    bus->devs[dev->id] = dev;

    dev->info = info;
    QTAILQ_INIT(&dev->requests);
    rc = dev->info->init(dev);
    if (rc != 0) {
        bus->devs[dev->id] = NULL;
    }

err:
    return rc;
}

static int scsi_qdev_exit(DeviceState *qdev)
{
    SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);

    assert(bus->devs[dev->id] != NULL);
    if (bus->devs[dev->id]->info->destroy) {
        bus->devs[dev->id]->info->destroy(bus->devs[dev->id]);
    }
    bus->devs[dev->id] = NULL;
    return 0;
}

void scsi_qdev_register(SCSIDeviceInfo *info)
{
    info->qdev.bus_info = &scsi_bus_info;
    info->qdev.init     = scsi_qdev_init;
    info->qdev.unplug   = qdev_simple_unplug_cb;
    info->qdev.exit     = scsi_qdev_exit;
    qdev_register(&info->qdev);
}

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

    driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
    dev = qdev_create(&bus->qbus, driver);
    qdev_prop_set_uint32(dev, "scsi-id", unit);
    if (qdev_prop_exists(dev, "removable")) {
        qdev_prop_set_bit(dev, "removable", removable);
    }
    if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
        qdev_free(dev);
        return NULL;
    }
    if (qdev_init(dev) < 0)
        return NULL;
    return DO_UPCAST(SCSIDevice, qdev, dev);
}

int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
{
    Location loc;
    DriveInfo *dinfo;
    int res = 0, unit;

    loc_push_none(&loc);
    for (unit = 0; unit < bus->ndev; unit++) {
        dinfo = drive_get(IF_SCSI, bus->busnr, unit);
        if (dinfo == NULL) {
            continue;
        }
        qemu_opts_loc_restore(dinfo->opts);
        if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false)) {
            res = -1;
            break;
        }
    }
    loc_pop(&loc);
    return res;
}

SCSIRequest *scsi_req_alloc(size_t size, SCSIDevice *d, uint32_t tag, uint32_t lun)
{
    SCSIRequest *req;

    req = qemu_mallocz(size);
    req->bus = scsi_bus_from_device(d);
    req->dev = d;
    req->tag = tag;
    req->lun = lun;
    req->status = -1;
    req->enqueued = true;
    trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
    QTAILQ_INSERT_TAIL(&d->requests, req, next);
    return req;
}

SCSIRequest *scsi_req_find(SCSIDevice *d, uint32_t tag)
{
    SCSIRequest *req;

    QTAILQ_FOREACH(req, &d->requests, next) {
        if (req->tag == tag) {
            return req;
        }
    }
    return NULL;
}

static void scsi_req_dequeue(SCSIRequest *req)
{
    trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
    if (req->enqueued) {
        QTAILQ_REMOVE(&req->dev->requests, req, next);
        req->enqueued = false;
    }
}

void scsi_req_free(SCSIRequest *req)
{
    scsi_req_dequeue(req);
    qemu_free(req);
}

static int scsi_req_length(SCSIRequest *req, uint8_t *cmd)
{
    switch (cmd[0] >> 5) {
    case 0:
        req->cmd.xfer = cmd[4];
        req->cmd.len = 6;
        /* length 0 means 256 blocks */
        if (req->cmd.xfer == 0)
            req->cmd.xfer = 256;
        break;
    case 1:
    case 2:
        req->cmd.xfer = cmd[8] | (cmd[7] << 8);
        req->cmd.len = 10;
        break;
    case 4:
        req->cmd.xfer = cmd[13] | (cmd[12] << 8) | (cmd[11] << 16) | (cmd[10] << 24);
        req->cmd.len = 16;
        break;
    case 5:
        req->cmd.xfer = cmd[9] | (cmd[8] << 8) | (cmd[7] << 16) | (cmd[6] << 24);
        req->cmd.len = 12;
        break;
    default:
        trace_scsi_req_parse_bad(req->dev->id, req->lun, req->tag, cmd[0]);
        return -1;
    }

    switch(cmd[0]) {
    case TEST_UNIT_READY:
    case REZERO_UNIT:
    case START_STOP:
    case SEEK_6:
    case WRITE_FILEMARKS:
    case SPACE:
    case RESERVE:
    case RELEASE:
    case ERASE:
    case ALLOW_MEDIUM_REMOVAL:
    case VERIFY:
    case SEEK_10:
    case SYNCHRONIZE_CACHE:
    case LOCK_UNLOCK_CACHE:
    case LOAD_UNLOAD:
    case SET_CD_SPEED:
    case SET_LIMITS:
    case WRITE_LONG:
    case MOVE_MEDIUM:
    case UPDATE_BLOCK:
        req->cmd.xfer = 0;
        break;
    case MODE_SENSE:
        break;
    case WRITE_SAME:
        req->cmd.xfer = 1;
        break;
    case READ_CAPACITY:
        req->cmd.xfer = 8;
        break;
    case READ_BLOCK_LIMITS:
        req->cmd.xfer = 6;
        break;
    case READ_POSITION:
        req->cmd.xfer = 20;
        break;
    case SEND_VOLUME_TAG:
        req->cmd.xfer *= 40;
        break;
    case MEDIUM_SCAN:
        req->cmd.xfer *= 8;
        break;
    case WRITE_10:
    case WRITE_VERIFY:
    case WRITE_6:
    case WRITE_12:
    case WRITE_VERIFY_12:
    case WRITE_16:
    case WRITE_VERIFY_16:
        req->cmd.xfer *= req->dev->blocksize;
        break;
    case READ_10:
    case READ_6:
    case READ_REVERSE:
    case RECOVER_BUFFERED_DATA:
    case READ_12:
    case READ_16:
        req->cmd.xfer *= req->dev->blocksize;
        break;
    case INQUIRY:
        req->cmd.xfer = cmd[4] | (cmd[3] << 8);
        break;
    case MAINTENANCE_OUT:
    case MAINTENANCE_IN:
        if (req->dev->type == TYPE_ROM) {
            /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
            req->cmd.xfer = cmd[9] | (cmd[8] << 8);
        }
        break;
    }
    return 0;
}

static int scsi_req_stream_length(SCSIRequest *req, uint8_t *cmd)
{
    switch(cmd[0]) {
    /* stream commands */
    case READ_6:
    case READ_REVERSE:
    case RECOVER_BUFFERED_DATA:
    case WRITE_6:
        req->cmd.len = 6;
        req->cmd.xfer = cmd[4] | (cmd[3] << 8) | (cmd[2] << 16);
        if (cmd[1] & 0x01) /* fixed */
            req->cmd.xfer *= req->dev->blocksize;
        break;
    case REWIND:
    case START_STOP:
        req->cmd.len = 6;
        req->cmd.xfer = 0;
        break;
    /* generic commands */
    default:
        return scsi_req_length(req, cmd);
    }
    return 0;
}

static void scsi_req_xfer_mode(SCSIRequest *req)
{
    switch (req->cmd.buf[0]) {
    case WRITE_6:
    case WRITE_10:
    case WRITE_VERIFY:
    case WRITE_12:
    case WRITE_VERIFY_12:
    case WRITE_16:
    case WRITE_VERIFY_16:
    case COPY:
    case COPY_VERIFY:
    case COMPARE:
    case CHANGE_DEFINITION:
    case LOG_SELECT:
    case MODE_SELECT:
    case MODE_SELECT_10:
    case SEND_DIAGNOSTIC:
    case WRITE_BUFFER:
    case FORMAT_UNIT:
    case REASSIGN_BLOCKS:
    case SEARCH_EQUAL:
    case SEARCH_HIGH:
    case SEARCH_LOW:
    case UPDATE_BLOCK:
    case WRITE_LONG:
    case WRITE_SAME:
    case SEARCH_HIGH_12:
    case SEARCH_EQUAL_12:
    case SEARCH_LOW_12:
    case SET_WINDOW:
    case MEDIUM_SCAN:
    case SEND_VOLUME_TAG:
    case WRITE_LONG_2:
    case PERSISTENT_RESERVE_OUT:
    case MAINTENANCE_OUT:
        req->cmd.mode = SCSI_XFER_TO_DEV;
        break;
    default:
        if (req->cmd.xfer)
            req->cmd.mode = SCSI_XFER_FROM_DEV;
        else {
            req->cmd.mode = SCSI_XFER_NONE;
        }
        break;
    }
}

static uint64_t scsi_req_lba(SCSIRequest *req)
{
    uint8_t *buf = req->cmd.buf;
    uint64_t lba;

    switch (buf[0] >> 5) {
    case 0:
        lba = (uint64_t) buf[3] | ((uint64_t) buf[2] << 8) |
              (((uint64_t) buf[1] & 0x1f) << 16);
        break;
    case 1:
    case 2:
        lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
              ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
        break;
    case 4:
        lba = (uint64_t) buf[9] | ((uint64_t) buf[8] << 8) |
              ((uint64_t) buf[7] << 16) | ((uint64_t) buf[6] << 24) |
              ((uint64_t) buf[5] << 32) | ((uint64_t) buf[4] << 40) |
              ((uint64_t) buf[3] << 48) | ((uint64_t) buf[2] << 56);
        break;
    case 5:
        lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
              ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
        break;
    default:
        lba = -1;

    }
    return lba;
}

int scsi_req_parse(SCSIRequest *req, uint8_t *buf)
{
    int rc;

    if (req->dev->type == TYPE_TAPE) {
        rc = scsi_req_stream_length(req, buf);
    } else {
        rc = scsi_req_length(req, buf);
    }
    if (rc != 0)
        return rc;

    memcpy(req->cmd.buf, buf, req->cmd.len);
    scsi_req_xfer_mode(req);
    req->cmd.lba = scsi_req_lba(req);
    trace_scsi_req_parsed(req->dev->id, req->lun, req->tag, buf[0],
                          req->cmd.mode, req->cmd.xfer, req->cmd.lba);
    return 0;
}

static const char *scsi_command_name(uint8_t cmd)
{
    static const char *names[] = {
        [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
        [ REZERO_UNIT              ] = "REZERO_UNIT",
        /* REWIND and REZERO_UNIT use the same operation code */
        [ REQUEST_SENSE            ] = "REQUEST_SENSE",
        [ FORMAT_UNIT              ] = "FORMAT_UNIT",
        [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
        [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS",
        [ READ_6                   ] = "READ_6",
        [ WRITE_6                  ] = "WRITE_6",
        [ SEEK_6                   ] = "SEEK_6",
        [ READ_REVERSE             ] = "READ_REVERSE",
        [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
        [ SPACE                    ] = "SPACE",
        [ INQUIRY                  ] = "INQUIRY",
        [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
        [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
        [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
        [ MODE_SELECT              ] = "MODE_SELECT",
        [ RESERVE                  ] = "RESERVE",
        [ RELEASE                  ] = "RELEASE",
        [ COPY                     ] = "COPY",
        [ ERASE                    ] = "ERASE",
        [ MODE_SENSE               ] = "MODE_SENSE",
        [ START_STOP               ] = "START_STOP",
        [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
        [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
        [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",

        [ SET_WINDOW               ] = "SET_WINDOW",
        [ READ_CAPACITY            ] = "READ_CAPACITY",
        [ READ_10                  ] = "READ_10",
        [ WRITE_10                 ] = "WRITE_10",
        [ SEEK_10                  ] = "SEEK_10",
        [ WRITE_VERIFY             ] = "WRITE_VERIFY",
        [ VERIFY                   ] = "VERIFY",
        [ SEARCH_HIGH              ] = "SEARCH_HIGH",
        [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
        [ SEARCH_LOW               ] = "SEARCH_LOW",
        [ SET_LIMITS               ] = "SET_LIMITS",
        [ PRE_FETCH                ] = "PRE_FETCH",
        /* READ_POSITION and PRE_FETCH use the same operation code */
        [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
        [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
        [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA",
        [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
        [ COMPARE                  ] = "COMPARE",
        [ COPY_VERIFY              ] = "COPY_VERIFY",
        [ WRITE_BUFFER             ] = "WRITE_BUFFER",
        [ READ_BUFFER              ] = "READ_BUFFER",
        [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
        [ READ_LONG                ] = "READ_LONG",
        [ WRITE_LONG               ] = "WRITE_LONG",
        [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
        [ WRITE_SAME               ] = "WRITE_SAME",
        [ READ_TOC                 ] = "READ_TOC",
        [ LOG_SELECT               ] = "LOG_SELECT",
        [ LOG_SENSE                ] = "LOG_SENSE",
        [ MODE_SELECT_10           ] = "MODE_SELECT_10",
        [ RESERVE_10               ] = "RESERVE_10",
        [ RELEASE_10               ] = "RELEASE_10",
        [ MODE_SENSE_10            ] = "MODE_SENSE_10",
        [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
        [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
        [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
        [ READ_12                  ] = "READ_12",
        [ WRITE_12                 ] = "WRITE_12",
        [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
        [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
        [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
        [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
        [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
        [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG",
        [ WRITE_LONG_2             ] = "WRITE_LONG_2",

        [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
        [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
        [ READ_16                  ] = "READ_16",
        [ WRITE_16                 ] = "WRITE_16",
        [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
        [ SERVICE_ACTION_IN        ] = "SERVICE_ACTION_IN",
        [ REPORT_LUNS              ] = "REPORT_LUNS",
        [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
        [ SET_CD_SPEED             ] = "SET_CD_SPEED",
        [ BLANK                    ] = "BLANK",
    };

    if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
        return "*UNKNOWN*";
    return names[cmd];
}

void scsi_req_print(SCSIRequest *req)
{
    FILE *fp = stderr;
    int i;

    fprintf(fp, "[%s id=%d] %s",
            req->dev->qdev.parent_bus->name,
            req->dev->id,
            scsi_command_name(req->cmd.buf[0]));
    for (i = 1; i < req->cmd.len; i++) {
        fprintf(fp, " 0x%02x", req->cmd.buf[i]);
    }
    switch (req->cmd.mode) {
    case SCSI_XFER_NONE:
        fprintf(fp, " - none\n");
        break;
    case SCSI_XFER_FROM_DEV:
        fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
        break;
    case SCSI_XFER_TO_DEV:
        fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
        break;
    default:
        fprintf(fp, " - Oops\n");
        break;
    }
}

void scsi_req_complete(SCSIRequest *req)
{
    assert(req->status != -1);
    scsi_req_dequeue(req);
    req->bus->complete(req->bus, SCSI_REASON_DONE,
                       req->tag,
                       req->status);
}

static char *scsibus_get_fw_dev_path(DeviceState *dev)
{
    SCSIDevice *d = (SCSIDevice*)dev;
    SCSIBus *bus = scsi_bus_from_device(d);
    char path[100];
    int i;

    for (i = 0; i < bus->ndev; i++) {
        if (bus->devs[i] == d) {
            break;
        }
    }

    assert(i != bus->ndev);

    snprintf(path, sizeof(path), "%s@%x", qdev_fw_name(dev), i);

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