[qemu.git] / hw / usb-msd.c

/*
 * USB Mass Storage Device emulation
 *
 * Copyright (c) 2006 CodeSourcery.
 * Written by Paul Brook
 *
 * This code is licensed under the LGPL.
 */

#include "qemu-common.h"
#include "qemu-option.h"
#include "qemu-config.h"
#include "usb.h"
#include "usb-desc.h"
#include "scsi.h"
#include "console.h"
#include "monitor.h"
#include "sysemu.h"
#include "blockdev.h"

//#define DEBUG_MSD

#ifdef DEBUG_MSD
#define DPRINTF(fmt, ...) \
do { printf("usb-msd: " fmt , ## __VA_ARGS__); } while (0)
#else
#define DPRINTF(fmt, ...) do {} while(0)
#endif

/* USB requests.  */
#define MassStorageReset  0xff
#define GetMaxLun         0xfe

enum USBMSDMode {
    USB_MSDM_CBW, /* Command Block.  */
    USB_MSDM_DATAOUT, /* Transfer data to device.  */
    USB_MSDM_DATAIN, /* Transfer data from device.  */
    USB_MSDM_CSW /* Command Status.  */
};

struct usb_msd_csw {
    uint32_t sig;
    uint32_t tag;
    uint32_t residue;
    uint8_t status;
};

typedef struct {
    USBDevice dev;
    enum USBMSDMode mode;
    uint32_t scsi_len;
    uint8_t *scsi_buf;
    uint32_t data_len;
    uint32_t residue;
    uint32_t tag;
    struct usb_msd_csw csw;
    SCSIRequest *req;
    SCSIBus bus;
    BlockConf conf;
    char *serial;
    SCSIDevice *scsi_dev;
    uint32_t removable;
    int result;
    /* For async completion.  */
    USBPacket *packet;
} MSDState;

struct usb_msd_cbw {
    uint32_t sig;
    uint32_t tag;
    uint32_t data_len;
    uint8_t flags;
    uint8_t lun;
    uint8_t cmd_len;
    uint8_t cmd[16];
};

enum {
    STR_MANUFACTURER = 1,
    STR_PRODUCT,
    STR_SERIALNUMBER,
    STR_CONFIG_FULL,
    STR_CONFIG_HIGH,
};

static const USBDescStrings desc_strings = {
    [STR_MANUFACTURER] = "QEMU " QEMU_VERSION,
    [STR_PRODUCT]      = "QEMU USB HARDDRIVE",
    [STR_SERIALNUMBER] = "1",
    [STR_CONFIG_FULL]  = "Full speed config (usb 1.1)",
    [STR_CONFIG_HIGH]  = "High speed config (usb 2.0)",
};

static const USBDescIface desc_iface_full = {
    .bInterfaceNumber              = 0,
    .bNumEndpoints                 = 2,
    .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
    .bInterfaceSubClass            = 0x06, /* SCSI */
    .bInterfaceProtocol            = 0x50, /* Bulk */
    .eps = (USBDescEndpoint[]) {
        {
            .bEndpointAddress      = USB_DIR_IN | 0x01,
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
            .wMaxPacketSize        = 64,
        },{
            .bEndpointAddress      = USB_DIR_OUT | 0x02,
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
            .wMaxPacketSize        = 64,
        },
    }
};

static const USBDescDevice desc_device_full = {
    .bcdUSB                        = 0x0200,
    .bMaxPacketSize0               = 8,
    .bNumConfigurations            = 1,
    .confs = (USBDescConfig[]) {
        {
            .bNumInterfaces        = 1,
            .bConfigurationValue   = 1,
            .iConfiguration        = STR_CONFIG_FULL,
            .bmAttributes          = 0xc0,
            .nif = 1,
            .ifs = &desc_iface_full,
        },
    },
};

static const USBDescIface desc_iface_high = {
    .bInterfaceNumber              = 0,
    .bNumEndpoints                 = 2,
    .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
    .bInterfaceSubClass            = 0x06, /* SCSI */
    .bInterfaceProtocol            = 0x50, /* Bulk */
    .eps = (USBDescEndpoint[]) {
        {
            .bEndpointAddress      = USB_DIR_IN | 0x01,
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
            .wMaxPacketSize        = 512,
        },{
            .bEndpointAddress      = USB_DIR_OUT | 0x02,
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
            .wMaxPacketSize        = 512,
        },
    }
};

static const USBDescDevice desc_device_high = {
    .bcdUSB                        = 0x0200,
    .bMaxPacketSize0               = 64,
    .bNumConfigurations            = 1,
    .confs = (USBDescConfig[]) {
        {
            .bNumInterfaces        = 1,
            .bConfigurationValue   = 1,
            .iConfiguration        = STR_CONFIG_HIGH,
            .bmAttributes          = 0xc0,
            .nif = 1,
            .ifs = &desc_iface_high,
        },
    },
};

static const USBDesc desc = {
    .id = {
        .idVendor          = 0x46f4, /* CRC16() of "QEMU" */
        .idProduct         = 0x0001,
        .bcdDevice         = 0,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device_full,
    .high = &desc_device_high,
    .str  = desc_strings,
};

static void usb_msd_copy_data(MSDState *s, USBPacket *p)
{
    uint32_t len;
    len = p->iov.size - p->result;
    if (len > s->scsi_len)
        len = s->scsi_len;
    usb_packet_copy(p, s->scsi_buf, len);
    s->scsi_len -= len;
    s->scsi_buf += len;
    s->data_len -= len;
    if (s->scsi_len == 0 || s->data_len == 0) {
        scsi_req_continue(s->req);
    }
}

static void usb_msd_send_status(MSDState *s, USBPacket *p)
{
    int len;

    DPRINTF("Command status %d tag 0x%x, len %zd\n",
            s->csw.status, s->csw.tag, p->iov.size);

    assert(s->csw.sig == 0x53425355);
    len = MIN(sizeof(s->csw), p->iov.size);
    usb_packet_copy(p, &s->csw, len);
    memset(&s->csw, 0, sizeof(s->csw));
}

static void usb_msd_transfer_data(SCSIRequest *req, uint32_t len)
{
    MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
    USBPacket *p = s->packet;

    assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
    s->scsi_len = len;
    s->scsi_buf = scsi_req_get_buf(req);
    if (p) {
        usb_msd_copy_data(s, p);
        p = s->packet;
        if (p && p->result == p->iov.size) {
            /* Set s->packet to NULL before calling usb_packet_complete
               because another request may be issued before
               usb_packet_complete returns.  */
            DPRINTF("Packet complete %p\n", p);
            s->packet = NULL;
            usb_packet_complete(&s->dev, p);
        }
    }
}

static void usb_msd_command_complete(SCSIRequest *req, uint32_t status)
{
    MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
    USBPacket *p = s->packet;

    DPRINTF("Command complete %d\n", status);
    s->residue = s->data_len;
    s->result = status != 0;

    s->csw.sig = cpu_to_le32(0x53425355);
    s->csw.tag = cpu_to_le32(s->tag);
    s->csw.residue = s->residue;
    s->csw.status = s->result;

    if (s->packet) {
        if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
            /* A deferred packet with no write data remaining must be
               the status read packet.  */
            usb_msd_send_status(s, p);
            s->mode = USB_MSDM_CBW;
        } else {
            if (s->data_len) {
                int len = (p->iov.size - p->result);
                usb_packet_skip(p, len);
                s->data_len -= len;
            }
            if (s->data_len == 0) {
                s->mode = USB_MSDM_CSW;
            }
        }
        s->packet = NULL;
        usb_packet_complete(&s->dev, p);
    } else if (s->data_len == 0) {
        s->mode = USB_MSDM_CSW;
    }

    scsi_req_unref(req);
    s->req = NULL;
}

static void usb_msd_request_cancelled(SCSIRequest *req)
{
    MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);

    if (req == s->req) {
        scsi_req_unref(s->req);
        s->req = NULL;
        s->packet = NULL;
        s->scsi_len = 0;
    }
}

static void usb_msd_handle_reset(USBDevice *dev)
{
    MSDState *s = (MSDState *)dev;

    DPRINTF("Reset\n");
    s->mode = USB_MSDM_CBW;
}

static int usb_msd_handle_control(USBDevice *dev, USBPacket *p,
               int request, int value, int index, int length, uint8_t *data)
{
    MSDState *s = (MSDState *)dev;
    int ret;

    ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
    if (ret >= 0) {
        return ret;
    }

    ret = 0;
    switch (request) {
    case DeviceRequest | USB_REQ_GET_INTERFACE:
        data[0] = 0;
        ret = 1;
        break;
    case DeviceOutRequest | USB_REQ_SET_INTERFACE:
        ret = 0;
        break;
    case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
        ret = 0;
        break;
    case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
        ret = 0;
        break;
        /* Class specific requests.  */
    case ClassInterfaceOutRequest | MassStorageReset:
        /* Reset state ready for the next CBW.  */
        s->mode = USB_MSDM_CBW;
        ret = 0;
        break;
    case ClassInterfaceRequest | GetMaxLun:
        data[0] = 0;
        ret = 1;
        break;
    default:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

static void usb_msd_cancel_io(USBDevice *dev, USBPacket *p)
{
    MSDState *s = DO_UPCAST(MSDState, dev, dev);

    if (s->req) {
        scsi_req_cancel(s->req);
    }
}

static int usb_msd_handle_data(USBDevice *dev, USBPacket *p)
{
    MSDState *s = (MSDState *)dev;
    int ret = 0;
    struct usb_msd_cbw cbw;
    uint8_t devep = p->devep;

    switch (p->pid) {
    case USB_TOKEN_OUT:
        if (devep != 2)
            goto fail;

        switch (s->mode) {
        case USB_MSDM_CBW:
            if (p->iov.size != 31) {
                fprintf(stderr, "usb-msd: Bad CBW size");
                goto fail;
            }
            usb_packet_copy(p, &cbw, 31);
            if (le32_to_cpu(cbw.sig) != 0x43425355) {
                fprintf(stderr, "usb-msd: Bad signature %08x\n",
                        le32_to_cpu(cbw.sig));
                goto fail;
            }
            DPRINTF("Command on LUN %d\n", cbw.lun);
            if (cbw.lun != 0) {
                fprintf(stderr, "usb-msd: Bad LUN %d\n", cbw.lun);
                goto fail;
            }
            s->tag = le32_to_cpu(cbw.tag);
            s->data_len = le32_to_cpu(cbw.data_len);
            if (s->data_len == 0) {
                s->mode = USB_MSDM_CSW;
            } else if (cbw.flags & 0x80) {
                s->mode = USB_MSDM_DATAIN;
            } else {
                s->mode = USB_MSDM_DATAOUT;
            }
            DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
                    s->tag, cbw.flags, cbw.cmd_len, s->data_len);
            s->residue = 0;
            s->scsi_len = 0;
            s->req = scsi_req_new(s->scsi_dev, s->tag, 0, cbw.cmd, NULL);
            scsi_req_enqueue(s->req);
            /* ??? Should check that USB and SCSI data transfer
               directions match.  */
            if (s->mode != USB_MSDM_CSW && s->residue == 0) {
                scsi_req_continue(s->req);
            }
            ret = p->result;
            break;

        case USB_MSDM_DATAOUT:
            DPRINTF("Data out %zd/%d\n", p->iov.size, s->data_len);
            if (p->iov.size > s->data_len) {
                goto fail;
            }

            if (s->scsi_len) {
                usb_msd_copy_data(s, p);
            }
            if (s->residue) {
                int len = p->iov.size - p->result;
                if (len) {
                    usb_packet_skip(p, len);
                    s->data_len -= len;
                    if (s->data_len == 0) {
                        s->mode = USB_MSDM_CSW;
                    }
                }
            }
            if (p->result < p->iov.size) {
                DPRINTF("Deferring packet %p\n", p);
                s->packet = p;
                ret = USB_RET_ASYNC;
            } else {
                ret = p->result;
            }
            break;

        default:
            DPRINTF("Unexpected write (len %zd)\n", p->iov.size);
            goto fail;
        }
        break;

    case USB_TOKEN_IN:
        if (devep != 1)
            goto fail;

        switch (s->mode) {
        case USB_MSDM_DATAOUT:
            if (s->data_len != 0 || p->iov.size < 13) {
                goto fail;
            }
            /* Waiting for SCSI write to complete.  */
            s->packet = p;
            ret = USB_RET_ASYNC;
            break;

        case USB_MSDM_CSW:
            if (p->iov.size < 13) {
                goto fail;
            }

            usb_msd_send_status(s, p);
            s->mode = USB_MSDM_CBW;
            ret = 13;
            break;

        case USB_MSDM_DATAIN:
            DPRINTF("Data in %zd/%d, scsi_len %d\n",
                    p->iov.size, s->data_len, s->scsi_len);
            if (s->scsi_len) {
                usb_msd_copy_data(s, p);
            }
            if (s->residue) {
                int len = p->iov.size - p->result;
                if (len) {
                    usb_packet_skip(p, len);
                    s->data_len -= len;
                    if (s->data_len == 0) {
                        s->mode = USB_MSDM_CSW;
                    }
                }
            }
            if (p->result < p->iov.size) {
                DPRINTF("Deferring packet %p\n", p);
                s->packet = p;
                ret = USB_RET_ASYNC;
            } else {
                ret = p->result;
            }
            break;

        default:
            DPRINTF("Unexpected read (len %zd)\n", p->iov.size);
            goto fail;
        }
        break;

    default:
        DPRINTF("Bad token\n");
    fail:
        ret = USB_RET_STALL;
        break;
    }

    return ret;
}

static void usb_msd_password_cb(void *opaque, int err)
{
    MSDState *s = opaque;

    if (!err)
        err = usb_device_attach(&s->dev);

    if (err)
        qdev_unplug(&s->dev.qdev);
}

static const struct SCSIBusInfo usb_msd_scsi_info = {
    .tcq = false,
    .max_target = 0,
    .max_lun = 0,

    .transfer_data = usb_msd_transfer_data,
    .complete = usb_msd_command_complete,
    .cancel = usb_msd_request_cancelled
};

static int usb_msd_initfn(USBDevice *dev)
{
    MSDState *s = DO_UPCAST(MSDState, dev, dev);
    BlockDriverState *bs = s->conf.bs;
    DriveInfo *dinfo;

    if (!bs) {
        error_report("usb-msd: drive property not set");
        return -1;
    }

    /*
     * Hack alert: this pretends to be a block device, but it's really
     * a SCSI bus that can serve only a single device, which it
     * creates automatically.  But first it needs to detach from its
     * blockdev, or else scsi_bus_legacy_add_drive() dies when it
     * attaches again.
     *
     * The hack is probably a bad idea.
     */
    bdrv_detach_dev(bs, &s->dev.qdev);
    s->conf.bs = NULL;

    if (!s->serial) {
        /* try to fall back to value set with legacy -drive serial=... */
        dinfo = drive_get_by_blockdev(bs);
        if (*dinfo->serial) {
            s->serial = strdup(dinfo->serial);
        }
    }
    if (s->serial) {
        usb_desc_set_string(dev, STR_SERIALNUMBER, s->serial);
    }

    usb_desc_init(dev);
    scsi_bus_new(&s->bus, &s->dev.qdev, &usb_msd_scsi_info);
    s->scsi_dev = scsi_bus_legacy_add_drive(&s->bus, bs, 0, !!s->removable);
    if (!s->scsi_dev) {
        return -1;
    }
    s->bus.qbus.allow_hotplug = 0;
    usb_msd_handle_reset(dev);

    if (bdrv_key_required(bs)) {
        if (cur_mon) {
            monitor_read_bdrv_key_start(cur_mon, bs, usb_msd_password_cb, s);
            s->dev.auto_attach = 0;
        } else {
            autostart = 0;
        }
    }

    add_boot_device_path(s->conf.bootindex, &dev->qdev, "/disk@0,0");
    return 0;
}

static USBDevice *usb_msd_init(const char *filename)
{
    static int nr=0;
    char id[8];
    QemuOpts *opts;
    DriveInfo *dinfo;
    USBDevice *dev;
    const char *p1;
    char fmt[32];

    /* parse -usbdevice disk: syntax into drive opts */
    snprintf(id, sizeof(id), "usb%d", nr++);
    opts = qemu_opts_create(qemu_find_opts("drive"), id, 0);

    p1 = strchr(filename, ':');
    if (p1++) {
        const char *p2;

        if (strstart(filename, "format=", &p2)) {
            int len = MIN(p1 - p2, sizeof(fmt));
            pstrcpy(fmt, len, p2);
            qemu_opt_set(opts, "format", fmt);
        } else if (*filename != ':') {
            printf("unrecognized USB mass-storage option %s\n", filename);
            return NULL;
        }
        filename = p1;
    }
    if (!*filename) {
        printf("block device specification needed\n");
        return NULL;
    }
    qemu_opt_set(opts, "file", filename);
    qemu_opt_set(opts, "if", "none");

    /* create host drive */
    dinfo = drive_init(opts, 0);
    if (!dinfo) {
        qemu_opts_del(opts);
        return NULL;
    }

    /* create guest device */
    dev = usb_create(NULL /* FIXME */, "usb-storage");
    if (!dev) {
        return NULL;
    }
    if (qdev_prop_set_drive(&dev->qdev, "drive", dinfo->bdrv) < 0) {
        qdev_free(&dev->qdev);
        return NULL;
    }
    if (qdev_init(&dev->qdev) < 0)
        return NULL;

    return dev;
}

static const VMStateDescription vmstate_usb_msd = {
    .name = "usb-storage",
    .unmigratable = 1, /* FIXME: handle transactions which are in flight */
    .version_id = 1,
    .minimum_version_id = 1,
    .fields = (VMStateField []) {
        VMSTATE_USB_DEVICE(dev, MSDState),
        VMSTATE_END_OF_LIST()
    }
};

static struct USBDeviceInfo msd_info = {
    .product_desc   = "QEMU USB MSD",
    .qdev.name      = "usb-storage",
    .qdev.fw_name      = "storage",
    .qdev.size      = sizeof(MSDState),
    .qdev.vmsd      = &vmstate_usb_msd,
    .usb_desc       = &desc,
    .init           = usb_msd_initfn,
    .handle_packet  = usb_generic_handle_packet,
    .cancel_packet  = usb_msd_cancel_io,
    .handle_attach  = usb_desc_attach,
    .handle_reset   = usb_msd_handle_reset,
    .handle_control = usb_msd_handle_control,
    .handle_data    = usb_msd_handle_data,
    .usbdevice_name = "disk",
    .usbdevice_init = usb_msd_init,
    .qdev.props     = (Property[]) {
        DEFINE_BLOCK_PROPERTIES(MSDState, conf),
        DEFINE_PROP_STRING("serial", MSDState, serial),
        DEFINE_PROP_BIT("removable", MSDState, removable, 0, false),
        DEFINE_PROP_END_OF_LIST(),
    },
};

static void usb_msd_register_devices(void)
{
    usb_qdev_register(&msd_info);
}
device_init(usb_msd_register_devices)
Commit	Line	Data
5fafdf24	1	/*
2e5d83bb PB	2	* USB Mass Storage Device emulation
	3	*
	4	* Copyright (c) 2006 CodeSourcery.
	5	* Written by Paul Brook
	6	*
8e31bf38	7	* This code is licensed under the LGPL.
2e5d83bb PB	8	*/
2e5d83bb PB	9
87ecb68b	10	#include "qemu-common.h"
7fc2f2c0 GH	11	#include "qemu-option.h"
7fc2f2c0 GH	12	#include "qemu-config.h"
87ecb68b	13	#include "usb.h"
81bfd2f2	14	#include "usb-desc.h"
43b443b6	15	#include "scsi.h"
c0f4ce77	16	#include "console.h"
b3e461d3	17	#include "monitor.h"
666daa68	18	#include "sysemu.h"
2446333c	19	#include "blockdev.h"
2e5d83bb PB	20
	21	//#define DEBUG_MSD
	22
	23	#ifdef DEBUG_MSD
001faf32 BS	24	#define DPRINTF(fmt, ...) \
001faf32 BS	25	do { printf("usb-msd: " fmt , ## __VA_ARGS__); } while (0)
2e5d83bb	26	#else
001faf32	27	#define DPRINTF(fmt, ...) do {} while(0)
2e5d83bb PB	28	#endif
	29
	30	/* USB requests. */
	31	#define MassStorageReset 0xff
	32	#define GetMaxLun 0xfe
	33
	34	enum USBMSDMode {
	35	USB_MSDM_CBW, /* Command Block. */
94843f66	36	USB_MSDM_DATAOUT, /* Transfer data to device. */
2e5d83bb PB	37	USB_MSDM_DATAIN, /* Transfer data from device. */
	38	USB_MSDM_CSW /* Command Status. */
	39	};
	40
92a114f6 GH	41	struct usb_msd_csw {
	42	uint32_t sig;
	43	uint32_t tag;
	44	uint32_t residue;
	45	uint8_t status;
	46	};
	47
2e5d83bb PB	48	typedef struct {
	49	USBDevice dev;
	50	enum USBMSDMode mode;
a917d384 PB	51	uint32_t scsi_len;
a917d384 PB	52	uint8_t *scsi_buf;
2e5d83bb	53	uint32_t data_len;
a917d384	54	uint32_t residue;
2e5d83bb	55	uint32_t tag;
92a114f6	56	struct usb_msd_csw csw;
5c6c0e51	57	SCSIRequest *req;
ca9c39fa	58	SCSIBus bus;
428c149b	59	BlockConf conf;
c3a90cb1	60	char *serial;
2e5d83bb	61	SCSIDevice *scsi_dev;
6bb7b867	62	uint32_t removable;
2e5d83bb	63	int result;
4d611c9a PB	64	/* For async completion. */
4d611c9a PB	65	USBPacket *packet;
2e5d83bb PB	66	} MSDState;
2e5d83bb PB	67
a917d384 PB	68	struct usb_msd_cbw {
	69	uint32_t sig;
	70	uint32_t tag;
	71	uint32_t data_len;
	72	uint8_t flags;
	73	uint8_t lun;
	74	uint8_t cmd_len;
	75	uint8_t cmd[16];
	76	};
	77
81bfd2f2 GH	78	enum {
	79	STR_MANUFACTURER = 1,
	80	STR_PRODUCT,
	81	STR_SERIALNUMBER,
ca0c730d GH	82	STR_CONFIG_FULL,
ca0c730d GH	83	STR_CONFIG_HIGH,
2e5d83bb PB	84	};
2e5d83bb PB	85
81bfd2f2 GH	86	static const USBDescStrings desc_strings = {
	87	[STR_MANUFACTURER] = "QEMU " QEMU_VERSION,
	88	[STR_PRODUCT] = "QEMU USB HARDDRIVE",
	89	[STR_SERIALNUMBER] = "1",
ca0c730d GH	90	[STR_CONFIG_FULL] = "Full speed config (usb 1.1)",
ca0c730d GH	91	[STR_CONFIG_HIGH] = "High speed config (usb 2.0)",
81bfd2f2 GH	92	};
81bfd2f2 GH	93
ca0c730d	94	static const USBDescIface desc_iface_full = {
81bfd2f2 GH	95	.bInterfaceNumber = 0,
	96	.bNumEndpoints = 2,
	97	.bInterfaceClass = USB_CLASS_MASS_STORAGE,
	98	.bInterfaceSubClass = 0x06, /* SCSI */
	99	.bInterfaceProtocol = 0x50, /* Bulk */
	100	.eps = (USBDescEndpoint[]) {
	101	{
	102	.bEndpointAddress = USB_DIR_IN \| 0x01,
	103	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	104	.wMaxPacketSize = 64,
	105	},{
	106	.bEndpointAddress = USB_DIR_OUT \| 0x02,
	107	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	108	.wMaxPacketSize = 64,
	109	},
	110	}
	111	};
	112
ca0c730d GH	113	static const USBDescDevice desc_device_full = {
ca0c730d GH	114	.bcdUSB = 0x0200,
81bfd2f2 GH	115	.bMaxPacketSize0 = 8,
	116	.bNumConfigurations = 1,
	117	.confs = (USBDescConfig[]) {
	118	{
	119	.bNumInterfaces = 1,
	120	.bConfigurationValue = 1,
ca0c730d	121	.iConfiguration = STR_CONFIG_FULL,
81bfd2f2	122	.bmAttributes = 0xc0,
add75088	123	.nif = 1,
ca0c730d GH	124	.ifs = &desc_iface_full,
	125	},
	126	},
	127	};
	128
	129	static const USBDescIface desc_iface_high = {
	130	.bInterfaceNumber = 0,
	131	.bNumEndpoints = 2,
	132	.bInterfaceClass = USB_CLASS_MASS_STORAGE,
	133	.bInterfaceSubClass = 0x06, /* SCSI */
	134	.bInterfaceProtocol = 0x50, /* Bulk */
	135	.eps = (USBDescEndpoint[]) {
	136	{
	137	.bEndpointAddress = USB_DIR_IN \| 0x01,
	138	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	139	.wMaxPacketSize = 512,
	140	},{
	141	.bEndpointAddress = USB_DIR_OUT \| 0x02,
	142	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	143	.wMaxPacketSize = 512,
	144	},
	145	}
	146	};
	147
	148	static const USBDescDevice desc_device_high = {
	149	.bcdUSB = 0x0200,
	150	.bMaxPacketSize0 = 64,
	151	.bNumConfigurations = 1,
	152	.confs = (USBDescConfig[]) {
	153	{
	154	.bNumInterfaces = 1,
	155	.bConfigurationValue = 1,
	156	.iConfiguration = STR_CONFIG_HIGH,
	157	.bmAttributes = 0xc0,
add75088	158	.nif = 1,
ca0c730d	159	.ifs = &desc_iface_high,
81bfd2f2 GH	160	},
	161	},
	162	};
	163
	164	static const USBDesc desc = {
	165	.id = {
db80358a RT	166	.idVendor = 0x46f4, /* CRC16() of "QEMU" */
db80358a RT	167	.idProduct = 0x0001,
81bfd2f2 GH	168	.bcdDevice = 0,
	169	.iManufacturer = STR_MANUFACTURER,
	170	.iProduct = STR_PRODUCT,
	171	.iSerialNumber = STR_SERIALNUMBER,
	172	},
ca0c730d GH	173	.full = &desc_device_full,
ca0c730d GH	174	.high = &desc_device_high,
81bfd2f2	175	.str = desc_strings,
2e5d83bb PB	176	};
2e5d83bb PB	177
29c74f76	178	static void usb_msd_copy_data(MSDState s, USBPacket p)
a917d384 PB	179	{
a917d384 PB	180	uint32_t len;
29c74f76	181	len = p->iov.size - p->result;
a917d384 PB	182	if (len > s->scsi_len)
a917d384 PB	183	len = s->scsi_len;
29c74f76	184	usb_packet_copy(p, s->scsi_buf, len);
a917d384	185	s->scsi_len -= len;
a917d384 PB	186	s->scsi_buf += len;
a917d384 PB	187	s->data_len -= len;
fa7935c1	188	if (s->scsi_len == 0 \|\| s->data_len == 0) {
ad3376cc	189	scsi_req_continue(s->req);
a917d384 PB	190	}
	191	}
	192
ab4797ad	193	static void usb_msd_send_status(MSDState s, USBPacket p)
a917d384	194	{
ab4797ad	195	int len;
a917d384	196
e04da7c3	197	DPRINTF("Command status %d tag 0x%x, len %zd\n",
92a114f6 GH	198	s->csw.status, s->csw.tag, p->iov.size);
	199
	200	assert(s->csw.sig == 0x53425355);
	201	len = MIN(sizeof(s->csw), p->iov.size);
	202	usb_packet_copy(p, &s->csw, len);
	203	memset(&s->csw, 0, sizeof(s->csw));
a917d384 PB	204	}
a917d384 PB	205
aba1f023	206	static void usb_msd_transfer_data(SCSIRequest *req, uint32_t len)
2e5d83bb	207	{
5c6c0e51	208	MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
a917d384	209	USBPacket *p = s->packet;
4d611c9a	210
ad3376cc	211	assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
aba1f023	212	s->scsi_len = len;
0c34459b	213	s->scsi_buf = scsi_req_get_buf(req);
a917d384	214	if (p) {
29c74f76 GH	215	usb_msd_copy_data(s, p);
	216	p = s->packet;
	217	if (p && p->result == p->iov.size) {
a917d384	218	/* Set s->packet to NULL before calling usb_packet_complete
94843f66	219	because another request may be issued before
a917d384 PB	220	usb_packet_complete returns. */
	221	DPRINTF("Packet complete %p\n", p);
	222	s->packet = NULL;
13a9a0d3	223	usb_packet_complete(&s->dev, p);
a917d384	224	}
4d611c9a	225	}
2e5d83bb PB	226	}
2e5d83bb PB	227
aba1f023	228	static void usb_msd_command_complete(SCSIRequest *req, uint32_t status)
c6df7102 PB	229	{
	230	MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
	231	USBPacket *p = s->packet;
	232
aba1f023	233	DPRINTF("Command complete %d\n", status);
c6df7102	234	s->residue = s->data_len;
aba1f023	235	s->result = status != 0;
92a114f6 GH	236
	237	s->csw.sig = cpu_to_le32(0x53425355);
	238	s->csw.tag = cpu_to_le32(s->tag);
	239	s->csw.residue = s->residue;
	240	s->csw.status = s->result;
	241
c6df7102 PB	242	if (s->packet) {
	243	if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
	244	/* A deferred packet with no write data remaining must be
	245	the status read packet. */
	246	usb_msd_send_status(s, p);
	247	s->mode = USB_MSDM_CBW;
	248	} else {
	249	if (s->data_len) {
29c74f76 GH	250	int len = (p->iov.size - p->result);
	251	usb_packet_skip(p, len);
	252	s->data_len -= len;
c6df7102 PB	253	}
	254	if (s->data_len == 0) {
	255	s->mode = USB_MSDM_CSW;
	256	}
	257	}
	258	s->packet = NULL;
	259	usb_packet_complete(&s->dev, p);
	260	} else if (s->data_len == 0) {
	261	s->mode = USB_MSDM_CSW;
	262	}
92a114f6	263
c6df7102 PB	264	scsi_req_unref(req);
	265	s->req = NULL;
	266	}
	267
94d3f98a PB	268	static void usb_msd_request_cancelled(SCSIRequest *req)
	269	{
	270	MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
	271
	272	if (req == s->req) {
	273	scsi_req_unref(s->req);
	274	s->req = NULL;
	275	s->packet = NULL;
	276	s->scsi_len = 0;
	277	}
	278	}
	279
059809e4	280	static void usb_msd_handle_reset(USBDevice *dev)
2e5d83bb PB	281	{
	282	MSDState s = (MSDState )dev;
	283
	284	DPRINTF("Reset\n");
	285	s->mode = USB_MSDM_CBW;
2e5d83bb PB	286	}
2e5d83bb PB	287
007fd62f HG	288	static int usb_msd_handle_control(USBDevice dev, USBPacket p,
007fd62f HG	289	int request, int value, int index, int length, uint8_t *data)
2e5d83bb PB	290	{
2e5d83bb PB	291	MSDState s = (MSDState )dev;
81bfd2f2	292	int ret;
2e5d83bb	293
007fd62f	294	ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
81bfd2f2 GH	295	if (ret >= 0) {
	296	return ret;
	297	}
	298
	299	ret = 0;
2e5d83bb	300	switch (request) {
2e5d83bb PB	301	case DeviceRequest \| USB_REQ_GET_INTERFACE:
	302	data[0] = 0;
	303	ret = 1;
	304	break;
	305	case DeviceOutRequest \| USB_REQ_SET_INTERFACE:
	306	ret = 0;
	307	break;
	308	case EndpointOutRequest \| USB_REQ_CLEAR_FEATURE:
e5322f76 APR	309	ret = 0;
	310	break;
	311	case InterfaceOutRequest \| USB_REQ_SET_INTERFACE:
2e5d83bb PB	312	ret = 0;
	313	break;
	314	/* Class specific requests. */
f3571b1a	315	case ClassInterfaceOutRequest \| MassStorageReset:
2e5d83bb PB	316	/* Reset state ready for the next CBW. */
	317	s->mode = USB_MSDM_CBW;
	318	ret = 0;
	319	break;
f3571b1a	320	case ClassInterfaceRequest \| GetMaxLun:
2e5d83bb PB	321	data[0] = 0;
	322	ret = 1;
	323	break;
	324	default:
2e5d83bb PB	325	ret = USB_RET_STALL;
	326	break;
	327	}
	328	return ret;
	329	}
	330
eb5e680a	331	static void usb_msd_cancel_io(USBDevice dev, USBPacket p)
4d611c9a	332	{
eb5e680a	333	MSDState *s = DO_UPCAST(MSDState, dev, dev);
d3ac1a87 GH	334
	335	if (s->req) {
	336	scsi_req_cancel(s->req);
	337	}
4d611c9a PB	338	}
	339
	340	static int usb_msd_handle_data(USBDevice dev, USBPacket p)
2e5d83bb PB	341	{
	342	MSDState s = (MSDState )dev;
	343	int ret = 0;
	344	struct usb_msd_cbw cbw;
4d611c9a	345	uint8_t devep = p->devep;
2e5d83bb	346
4d611c9a	347	switch (p->pid) {
2e5d83bb PB	348	case USB_TOKEN_OUT:
	349	if (devep != 2)
	350	goto fail;
	351
	352	switch (s->mode) {
	353	case USB_MSDM_CBW:
29c74f76	354	if (p->iov.size != 31) {
2e5d83bb PB	355	fprintf(stderr, "usb-msd: Bad CBW size");
	356	goto fail;
	357	}
29c74f76	358	usb_packet_copy(p, &cbw, 31);
2e5d83bb PB	359	if (le32_to_cpu(cbw.sig) != 0x43425355) {
	360	fprintf(stderr, "usb-msd: Bad signature %08x\n",
	361	le32_to_cpu(cbw.sig));
	362	goto fail;
	363	}
	364	DPRINTF("Command on LUN %d\n", cbw.lun);
	365	if (cbw.lun != 0) {
	366	fprintf(stderr, "usb-msd: Bad LUN %d\n", cbw.lun);
	367	goto fail;
	368	}
	369	s->tag = le32_to_cpu(cbw.tag);
	370	s->data_len = le32_to_cpu(cbw.data_len);
	371	if (s->data_len == 0) {
	372	s->mode = USB_MSDM_CSW;
	373	} else if (cbw.flags & 0x80) {
	374	s->mode = USB_MSDM_DATAIN;
	375	} else {
	376	s->mode = USB_MSDM_DATAOUT;
	377	}
	378	DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
	379	s->tag, cbw.flags, cbw.cmd_len, s->data_len);
a917d384	380	s->residue = 0;
ef0bdf77	381	s->scsi_len = 0;
c39ce112 PB	382	s->req = scsi_req_new(s->scsi_dev, s->tag, 0, cbw.cmd, NULL);
c39ce112 PB	383	scsi_req_enqueue(s->req);
a917d384 PB	384	/* ??? Should check that USB and SCSI data transfer
a917d384 PB	385	directions match. */
ad3376cc PB	386	if (s->mode != USB_MSDM_CSW && s->residue == 0) {
ad3376cc PB	387	scsi_req_continue(s->req);
a917d384	388	}
29c74f76	389	ret = p->result;
2e5d83bb PB	390	break;
	391
	392	case USB_MSDM_DATAOUT:
29c74f76 GH	393	DPRINTF("Data out %zd/%d\n", p->iov.size, s->data_len);
29c74f76 GH	394	if (p->iov.size > s->data_len) {
2e5d83bb	395	goto fail;
29c74f76	396	}
2e5d83bb	397
a917d384	398	if (s->scsi_len) {
29c74f76	399	usb_msd_copy_data(s, p);
a917d384	400	}
29c74f76 GH	401	if (s->residue) {
	402	int len = p->iov.size - p->result;
	403	if (len) {
	404	usb_packet_skip(p, len);
	405	s->data_len -= len;
	406	if (s->data_len == 0) {
	407	s->mode = USB_MSDM_CSW;
	408	}
	409	}
a917d384	410	}
29c74f76	411	if (p->result < p->iov.size) {
4d611c9a	412	DPRINTF("Deferring packet %p\n", p);
4d611c9a PB	413	s->packet = p;
4d611c9a PB	414	ret = USB_RET_ASYNC;
a917d384	415	} else {
29c74f76	416	ret = p->result;
4d611c9a	417	}
2e5d83bb PB	418	break;
	419
	420	default:
29c74f76	421	DPRINTF("Unexpected write (len %zd)\n", p->iov.size);
2e5d83bb PB	422	goto fail;
	423	}
	424	break;
	425
	426	case USB_TOKEN_IN:
	427	if (devep != 1)
	428	goto fail;
	429
	430	switch (s->mode) {
a917d384	431	case USB_MSDM_DATAOUT:
29c74f76	432	if (s->data_len != 0 \|\| p->iov.size < 13) {
a917d384	433	goto fail;
29c74f76	434	}
a917d384	435	/* Waiting for SCSI write to complete. */
a917d384 PB	436	s->packet = p;
	437	ret = USB_RET_ASYNC;
	438	break;
	439
2e5d83bb	440	case USB_MSDM_CSW:
29c74f76	441	if (p->iov.size < 13) {
2e5d83bb	442	goto fail;
29c74f76	443	}
2e5d83bb	444
ab4797ad	445	usb_msd_send_status(s, p);
2e5d83bb	446	s->mode = USB_MSDM_CBW;
a917d384	447	ret = 13;
2e5d83bb PB	448	break;
	449
	450	case USB_MSDM_DATAIN:
29c74f76 GH	451	DPRINTF("Data in %zd/%d, scsi_len %d\n",
29c74f76 GH	452	p->iov.size, s->data_len, s->scsi_len);
a917d384	453	if (s->scsi_len) {
29c74f76	454	usb_msd_copy_data(s, p);
a917d384	455	}
29c74f76 GH	456	if (s->residue) {
	457	int len = p->iov.size - p->result;
	458	if (len) {
	459	usb_packet_skip(p, len);
	460	s->data_len -= len;
	461	if (s->data_len == 0) {
	462	s->mode = USB_MSDM_CSW;
	463	}
	464	}
a917d384	465	}
29c74f76	466	if (p->result < p->iov.size) {
4d611c9a	467	DPRINTF("Deferring packet %p\n", p);
4d611c9a PB	468	s->packet = p;
4d611c9a PB	469	ret = USB_RET_ASYNC;
a917d384	470	} else {
29c74f76	471	ret = p->result;
4d611c9a	472	}
2e5d83bb PB	473	break;
	474
	475	default:
29c74f76	476	DPRINTF("Unexpected read (len %zd)\n", p->iov.size);
2e5d83bb PB	477	goto fail;
	478	}
	479	break;
	480
	481	default:
	482	DPRINTF("Bad token\n");
	483	fail:
	484	ret = USB_RET_STALL;
	485	break;
	486	}
	487
	488	return ret;
	489	}
	490
b3e461d3 GH	491	static void usb_msd_password_cb(void *opaque, int err)
	492	{
	493	MSDState *s = opaque;
	494
	495	if (!err)
fa19bf83 HG	496	err = usb_device_attach(&s->dev);
	497
	498	if (err)
b3e461d3 GH	499	qdev_unplug(&s->dev.qdev);
	500	}
	501
afd4030c PB	502	static const struct SCSIBusInfo usb_msd_scsi_info = {
afd4030c PB	503	.tcq = false,
7e0380b9 PB	504	.max_target = 0,
7e0380b9 PB	505	.max_lun = 0,
afd4030c	506
c6df7102	507	.transfer_data = usb_msd_transfer_data,
94d3f98a PB	508	.complete = usb_msd_command_complete,
94d3f98a PB	509	.cancel = usb_msd_request_cancelled
cfdc1bb0 PB	510	};
cfdc1bb0 PB	511
806b6024 GH	512	static int usb_msd_initfn(USBDevice *dev)
	513	{
	514	MSDState *s = DO_UPCAST(MSDState, dev, dev);
f8b6cc00	515	BlockDriverState *bs = s->conf.bs;
4a1e1bc4	516	DriveInfo *dinfo;
806b6024	517
f8b6cc00	518	if (!bs) {
1ecda02b	519	error_report("usb-msd: drive property not set");
7fc2f2c0 GH	520	return -1;
	521	}
	522
14bafc54 MA	523	/*
	524	* Hack alert: this pretends to be a block device, but it's really
	525	* a SCSI bus that can serve only a single device, which it
18846dee MA	526	* creates automatically. But first it needs to detach from its
	527	* blockdev, or else scsi_bus_legacy_add_drive() dies when it
	528	* attaches again.
14bafc54 MA	529	*
	530	* The hack is probably a bad idea.
	531	*/
fa879d62	532	bdrv_detach_dev(bs, &s->dev.qdev);
f8b6cc00	533	s->conf.bs = NULL;
14bafc54	534
c3a90cb1 MA	535	if (!s->serial) {
	536	/* try to fall back to value set with legacy -drive serial=... */
	537	dinfo = drive_get_by_blockdev(bs);
	538	if (*dinfo->serial) {
	539	s->serial = strdup(dinfo->serial);
	540	}
	541	}
	542	if (s->serial) {
	543	usb_desc_set_string(dev, STR_SERIALNUMBER, s->serial);
4a1e1bc4 GH	544	}
4a1e1bc4 GH	545
a980a065	546	usb_desc_init(dev);
afd4030c	547	scsi_bus_new(&s->bus, &s->dev.qdev, &usb_msd_scsi_info);
6bb7b867	548	s->scsi_dev = scsi_bus_legacy_add_drive(&s->bus, bs, 0, !!s->removable);
fa66b909 MA	549	if (!s->scsi_dev) {
	550	return -1;
	551	}
cb23117b	552	s->bus.qbus.allow_hotplug = 0;
7fc2f2c0	553	usb_msd_handle_reset(dev);
b3e461d3	554
f8b6cc00	555	if (bdrv_key_required(bs)) {
a4426488	556	if (cur_mon) {
f8b6cc00	557	monitor_read_bdrv_key_start(cur_mon, bs, usb_msd_password_cb, s);
b3e461d3 GH	558	s->dev.auto_attach = 0;
	559	} else {
	560	autostart = 0;
	561	}
	562	}
	563
cf8ce30d	564	add_boot_device_path(s->conf.bootindex, &dev->qdev, "/disk@0,0");
806b6024 GH	565	return 0;
	566	}
	567
b3e461d3	568	static USBDevice usb_msd_init(const char filename)
2e5d83bb	569	{
7fc2f2c0 GH	570	static int nr=0;
	571	char id[8];
	572	QemuOpts *opts;
	573	DriveInfo *dinfo;
806b6024	574	USBDevice *dev;
334c0241 AJ	575	const char *p1;
	576	char fmt[32];
	577
7fc2f2c0 GH	578	/* parse -usbdevice disk: syntax into drive opts */
7fc2f2c0 GH	579	snprintf(id, sizeof(id), "usb%d", nr++);
3329f07b	580	opts = qemu_opts_create(qemu_find_opts("drive"), id, 0);
7fc2f2c0	581
334c0241 AJ	582	p1 = strchr(filename, ':');
	583	if (p1++) {
	584	const char *p2;
	585
	586	if (strstart(filename, "format=", &p2)) {
	587	int len = MIN(p1 - p2, sizeof(fmt));
	588	pstrcpy(fmt, len, p2);
7fc2f2c0	589	qemu_opt_set(opts, "format", fmt);
334c0241 AJ	590	} else if (*filename != ':') {
	591	printf("unrecognized USB mass-storage option %s\n", filename);
	592	return NULL;
	593	}
334c0241 AJ	594	filename = p1;
334c0241 AJ	595	}
334c0241 AJ	596	if (!*filename) {
	597	printf("block device specification needed\n");
	598	return NULL;
	599	}
7fc2f2c0 GH	600	qemu_opt_set(opts, "file", filename);
7fc2f2c0 GH	601	qemu_opt_set(opts, "if", "none");
2e5d83bb	602
7fc2f2c0	603	/* create host drive */
319ae529	604	dinfo = drive_init(opts, 0);
7fc2f2c0 GH	605	if (!dinfo) {
7fc2f2c0 GH	606	qemu_opts_del(opts);
806b6024	607	return NULL;
7fc2f2c0	608	}
2e5d83bb	609
7fc2f2c0	610	/* create guest device */
556cd098	611	dev = usb_create(NULL /* FIXME */, "usb-storage");
d44168ff PB	612	if (!dev) {
	613	return NULL;
	614	}
18846dee MA	615	if (qdev_prop_set_drive(&dev->qdev, "drive", dinfo->bdrv) < 0) {
	616	qdev_free(&dev->qdev);
	617	return NULL;
	618	}
33e66b86 MA	619	if (qdev_init(&dev->qdev) < 0)
33e66b86 MA	620	return NULL;
1f6e24e7	621
7fc2f2c0	622	return dev;
2e5d83bb	623	}
bb5fc20f	624
f54b6563 GH	625	static const VMStateDescription vmstate_usb_msd = {
	626	.name = "usb-storage",
	627	.unmigratable = 1, /* FIXME: handle transactions which are in flight */
	628	.version_id = 1,
	629	.minimum_version_id = 1,
	630	.fields = (VMStateField []) {
	631	VMSTATE_USB_DEVICE(dev, MSDState),
	632	VMSTATE_END_OF_LIST()
	633	}
	634	};
	635
806b6024	636	static struct USBDeviceInfo msd_info = {
06384698	637	.product_desc = "QEMU USB MSD",
556cd098	638	.qdev.name = "usb-storage",
cf8ce30d	639	.qdev.fw_name = "storage",
806b6024	640	.qdev.size = sizeof(MSDState),
f54b6563	641	.qdev.vmsd = &vmstate_usb_msd,
81bfd2f2	642	.usb_desc = &desc,
806b6024 GH	643	.init = usb_msd_initfn,
806b6024 GH	644	.handle_packet = usb_generic_handle_packet,
eb5e680a	645	.cancel_packet = usb_msd_cancel_io,
ca0c730d	646	.handle_attach = usb_desc_attach,
806b6024 GH	647	.handle_reset = usb_msd_handle_reset,
	648	.handle_control = usb_msd_handle_control,
	649	.handle_data = usb_msd_handle_data,
b3e461d3 GH	650	.usbdevice_name = "disk",
b3e461d3 GH	651	.usbdevice_init = usb_msd_init,
7fc2f2c0	652	.qdev.props = (Property[]) {
428c149b	653	DEFINE_BLOCK_PROPERTIES(MSDState, conf),
c3a90cb1	654	DEFINE_PROP_STRING("serial", MSDState, serial),
6bb7b867	655	DEFINE_PROP_BIT("removable", MSDState, removable, 0, false),
7fc2f2c0 GH	656	DEFINE_PROP_END_OF_LIST(),
7fc2f2c0 GH	657	},
806b6024 GH	658	};
	659
	660	static void usb_msd_register_devices(void)
	661	{
	662	usb_qdev_register(&msd_info);
	663	}
	664	device_init(usb_msd_register_devices)