[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;
    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 tag 0x%x\n", status, req->tag);
    s->residue = s->data_len;
    s->result = status != 0;

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