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

/*
 * USB Mass Storage Device emulation
 *
 * Copyright (c) 2006 CodeSourcery.
 * Written by Paul Brook
 *
 * This code is licenced 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.  */
};

typedef struct {
    USBDevice dev;
    enum USBMSDMode mode;
    uint32_t scsi_len;
    uint8_t *scsi_buf;
    uint32_t usb_len;
    uint8_t *usb_buf;
    uint32_t data_len;
    uint32_t residue;
    uint32_t tag;
    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];
};

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

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          = 0,
        .idProduct         = 0,
        .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)
{
    uint32_t len;
    len = s->usb_len;
    if (len > s->scsi_len)
        len = s->scsi_len;
    if (s->mode == USB_MSDM_DATAIN) {
        memcpy(s->usb_buf, s->scsi_buf, len);
    } else {
        memcpy(s->scsi_buf, s->usb_buf, len);
    }
    s->usb_len -= len;
    s->scsi_len -= len;
    s->usb_buf += 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)
{
    struct usb_msd_csw csw;
    int len;

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

    len = MIN(sizeof(csw), p->len);
    memcpy(p->data, &csw, len);
}

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);
        if (s->packet && s->usb_len == 0) {
            /* 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;
    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) {
                s->data_len -= s->usb_len;
                if (s->mode == USB_MSDM_DATAIN) {
                    memset(s->usb_buf, 0, s->usb_len);
                }
                s->usb_len = 0;
            }
            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);
    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;
    uint8_t *data = p->data;
    int len = p->len;

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

        switch (s->mode) {
        case USB_MSDM_CBW:
            if (len != 31) {
                fprintf(stderr, "usb-msd: Bad CBW size");
                goto fail;
            }
            memcpy(&cbw, data, 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, NULL);
            scsi_req_enqueue(s->req, cbw.cmd);
            /* ??? 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 = len;
            break;

        case USB_MSDM_DATAOUT:
            DPRINTF("Data out %d/%d\n", len, s->data_len);
            if (len > s->data_len)
                goto fail;

            s->usb_buf = data;
            s->usb_len = len;
            if (s->scsi_len) {
                usb_msd_copy_data(s);
            }
            if (s->residue && s->usb_len) {
                s->data_len -= s->usb_len;
                if (s->data_len == 0)
                    s->mode = USB_MSDM_CSW;
                s->usb_len = 0;
            }
            if (s->usb_len) {
                DPRINTF("Deferring packet %p\n", p);
                s->packet = p;
                ret = USB_RET_ASYNC;
            } else {
                ret = len;
            }
            break;

        default:
            DPRINTF("Unexpected write (len %d)\n", len);
            goto fail;
        }
        break;

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

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

        case USB_MSDM_CSW:
            DPRINTF("Command status %d tag 0x%x, len %d\n",
                    s->result, s->tag, len);
            if (len < 13)
                goto fail;

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

        case USB_MSDM_DATAIN:
            DPRINTF("Data in %d/%d, scsi_len %d\n", len, s->data_len, s->scsi_len);
            if (len > s->data_len)
                len = s->data_len;
            s->usb_buf = data;
            s->usb_len = len;
            if (s->scsi_len) {
                usb_msd_copy_data(s);
            }
            if (s->residue && s->usb_len) {
                s->data_len -= s->usb_len;
                memset(s->usb_buf, 0, s->usb_len);
                if (s->data_len == 0)
                    s->mode = USB_MSDM_CSW;
                s->usb_len = 0;
            }
            if (s->usb_len) {
                DPRINTF("Deferring packet %p\n", p);
                s->packet = p;
                ret = USB_RET_ASYNC;
            } else {
                ret = len;
            }
            break;

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