[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 "usb.h"
#include "block.h"
#include "scsi-disk.h"

//#define DEBUG_MSD

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

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

enum USBMSDMode {
    USB_MSDM_CBW, /* Command Block.  */
    USB_MSDM_DATAOUT, /* Tranfer 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;
    BlockDriverState *bs;
    SCSIDevice *scsi_dev;
    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;
};

static const uint8_t qemu_msd_dev_descriptor[] = {
	0x12,       /*  u8 bLength; */
	0x01,       /*  u8 bDescriptorType; Device */
	0x00, 0x01, /*  u16 bcdUSB; v1.0 */

	0x00,	    /*  u8  bDeviceClass; */
	0x00,	    /*  u8  bDeviceSubClass; */
	0x00,       /*  u8  bDeviceProtocol; [ low/full speeds only ] */
	0x08,       /*  u8  bMaxPacketSize0; 8 Bytes */

        /* Vendor and product id are arbitrary.  */
	0x00, 0x00, /*  u16 idVendor; */
 	0x00, 0x00, /*  u16 idProduct; */
	0x00, 0x00, /*  u16 bcdDevice */

	0x01,       /*  u8  iManufacturer; */
	0x02,       /*  u8  iProduct; */
	0x03,       /*  u8  iSerialNumber; */
	0x01        /*  u8  bNumConfigurations; */
};

static const uint8_t qemu_msd_config_descriptor[] = {

	/* one configuration */
	0x09,       /*  u8  bLength; */
	0x02,       /*  u8  bDescriptorType; Configuration */
	0x20, 0x00, /*  u16 wTotalLength; */
	0x01,       /*  u8  bNumInterfaces; (1) */
	0x01,       /*  u8  bConfigurationValue; */
	0x00,       /*  u8  iConfiguration; */
	0xc0,       /*  u8  bmAttributes;
				 Bit 7: must be set,
				     6: Self-powered,
				     5: Remote wakeup,
				     4..0: resvd */
	0x00,       /*  u8  MaxPower; */

	/* one interface */
	0x09,       /*  u8  if_bLength; */
	0x04,       /*  u8  if_bDescriptorType; Interface */
	0x00,       /*  u8  if_bInterfaceNumber; */
	0x00,       /*  u8  if_bAlternateSetting; */
	0x02,       /*  u8  if_bNumEndpoints; */
	0x08,       /*  u8  if_bInterfaceClass; MASS STORAGE */
	0x06,       /*  u8  if_bInterfaceSubClass; SCSI */
	0x50,       /*  u8  if_bInterfaceProtocol; Bulk Only */
	0x00,       /*  u8  if_iInterface; */

	/* Bulk-In endpoint */
	0x07,       /*  u8  ep_bLength; */
	0x05,       /*  u8  ep_bDescriptorType; Endpoint */
	0x81,       /*  u8  ep_bEndpointAddress; IN Endpoint 1 */
 	0x02,       /*  u8  ep_bmAttributes; Bulk */
 	0x40, 0x00, /*  u16 ep_wMaxPacketSize; */
	0x00,       /*  u8  ep_bInterval; */

	/* Bulk-Out endpoint */
	0x07,       /*  u8  ep_bLength; */
	0x05,       /*  u8  ep_bDescriptorType; Endpoint */
	0x02,       /*  u8  ep_bEndpointAddress; OUT Endpoint 2 */
 	0x02,       /*  u8  ep_bmAttributes; Bulk */
 	0x40, 0x00, /*  u16 ep_wMaxPacketSize; */
	0x00        /*  u8  ep_bInterval; */
};

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) {
        if (s->mode == USB_MSDM_DATAIN) {
            s->scsi_dev->read_data(s->scsi_dev, s->tag);
        } else if (s->mode == USB_MSDM_DATAOUT) {
            s->scsi_dev->write_data(s->scsi_dev, s->tag);
        }
    }
}

static void usb_msd_send_status(MSDState *s)
{
    struct usb_msd_csw csw;

    csw.sig = cpu_to_le32(0x53425355);
    csw.tag = cpu_to_le32(s->tag);
    csw.residue = s->residue;
    csw.status = s->result;
    memcpy(s->usb_buf, &csw, 13);
}

static void usb_msd_command_complete(void *opaque, int reason, uint32_t tag,
                                     uint32_t arg)
{
    MSDState *s = (MSDState *)opaque;
    USBPacket *p = s->packet;

    if (tag != s->tag) {
        fprintf(stderr, "usb-msd: Unexpected SCSI Tag 0x%x\n", tag);
    }
    if (reason == SCSI_REASON_DONE) {
        DPRINTF("Command complete %d\n", arg);
        s->residue = s->data_len;
        s->result = arg != 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);
                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(p);
        } else if (s->data_len == 0) {
            s->mode = USB_MSDM_CSW;
        }
        return;
    }
    s->scsi_len = arg;
    s->scsi_buf = s->scsi_dev->get_buf(s->scsi_dev, tag);
    if (p) {
        usb_msd_copy_data(s);
        if (s->usb_len == 0) {
            /* Set s->packet to NULL before calling usb_packet_complete
               because annother request may be issued before
               usb_packet_complete returns.  */
            DPRINTF("Packet complete %p\n", p);
            s->packet = NULL;
            usb_packet_complete(p);
        }
    }
}

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, int request, int value,
                                  int index, int length, uint8_t *data)
{
    MSDState *s = (MSDState *)dev;
    int ret = 0;

    switch (request) {
    case DeviceRequest | USB_REQ_GET_STATUS:
        data[0] = (1 << USB_DEVICE_SELF_POWERED) |
            (dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
        data[1] = 0x00;
        ret = 2;
        break;
    case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 0;
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case DeviceOutRequest | USB_REQ_SET_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 1;
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case DeviceOutRequest | USB_REQ_SET_ADDRESS:
        dev->addr = value;
        ret = 0;
        break;
    case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
        switch(value >> 8) {
        case USB_DT_DEVICE:
            memcpy(data, qemu_msd_dev_descriptor,
                   sizeof(qemu_msd_dev_descriptor));
            ret = sizeof(qemu_msd_dev_descriptor);
            break;
        case USB_DT_CONFIG:
            memcpy(data, qemu_msd_config_descriptor,
                   sizeof(qemu_msd_config_descriptor));
            ret = sizeof(qemu_msd_config_descriptor);
            break;
        case USB_DT_STRING:
            switch(value & 0xff) {
            case 0:
                /* language ids */
                data[0] = 4;
                data[1] = 3;
                data[2] = 0x09;
                data[3] = 0x04;
                ret = 4;
                break;
            case 1:
                /* vendor description */
                ret = set_usb_string(data, "QEMU " QEMU_VERSION);
                break;
            case 2:
                /* product description */
                ret = set_usb_string(data, "QEMU USB HARDDRIVE");
                break;
            case 3:
                /* serial number */
                ret = set_usb_string(data, "1");
                break;
            default:
                goto fail;
            }
            break;
        default:
            goto fail;
        }
        break;
    case DeviceRequest | USB_REQ_GET_CONFIGURATION:
        data[0] = 1;
        ret = 1;
        break;
    case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
        ret = 0;
        break;
    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:
        if (value == 0 && index != 0x81) { /* clear ep halt */
            goto fail;
        }
        ret = 0;
        break;
        /* Class specific requests.  */
    case MassStorageReset:
        /* Reset state ready for the next CBW.  */
        s->mode = USB_MSDM_CBW;
        ret = 0;
        break;
    case GetMaxLun:
        data[0] = 0;
        ret = 1;
        break;
    default:
    fail:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

static void usb_msd_cancel_io(USBPacket *p, void *opaque)
{
    MSDState *s = opaque;
    s->scsi_dev->cancel_io(s->scsi_dev, s->tag);
    s->packet = NULL;
    s->scsi_len = 0;
}

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_dev->send_command(s->scsi_dev, s->tag, cbw.cmd, 0);
            /* ??? Should check that USB and SCSI data transfer
               directions match.  */
            if (s->residue == 0) {
                if (s->mode == USB_MSDM_DATAIN) {
                    s->scsi_dev->read_data(s->scsi_dev, s->tag);
                } else if (s->mode == USB_MSDM_DATAOUT) {
                    s->scsi_dev->write_data(s->scsi_dev, s->tag);
                }
            }
            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);
                usb_defer_packet(p, usb_msd_cancel_io, s);
                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.  */
            usb_defer_packet(p, usb_msd_cancel_io, s);
            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;

            s->usb_len = len;
            s->usb_buf = data;
            usb_msd_send_status(s);
            s->mode = USB_MSDM_CBW;
            ret = 13;
            break;

        case USB_MSDM_DATAIN:
            DPRINTF("Data in %d/%d\n", len, s->data_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);
                usb_defer_packet(p, usb_msd_cancel_io, s);
                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_handle_destroy(USBDevice *dev)
{
    MSDState *s = (MSDState *)dev;

    s->scsi_dev->destroy(s->scsi_dev);
    bdrv_delete(s->bs);
    qemu_free(s);
}

USBDevice *usb_msd_init(const char *filename)
{
    MSDState *s;
    BlockDriverState *bdrv;

    s = qemu_mallocz(sizeof(MSDState));
    if (!s)
        return NULL;

    bdrv = bdrv_new("usb");
    if (bdrv_open(bdrv, filename, 0) < 0)
        goto fail;
    if (qemu_key_check(bdrv, filename))
        goto fail;
    s->bs = bdrv;

    s->dev.speed = USB_SPEED_FULL;
    s->dev.handle_packet = usb_generic_handle_packet;

    s->dev.handle_reset = usb_msd_handle_reset;
    s->dev.handle_control = usb_msd_handle_control;
    s->dev.handle_data = usb_msd_handle_data;
    s->dev.handle_destroy = usb_msd_handle_destroy;

    snprintf(s->dev.devname, sizeof(s->dev.devname), "QEMU USB MSD(%.16s)",
             filename);

    s->scsi_dev = scsi_disk_init(bdrv, 0, usb_msd_command_complete, s);
    usb_msd_handle_reset((USBDevice *)s);
    return (USBDevice *)s;
 fail:
    qemu_free(s);
    return NULL;
}
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 PB	10	#include "qemu-common.h"
	11	#include "usb.h"
	12	#include "block.h"
	13	#include "scsi-disk.h"
2e5d83bb PB	14
	15	//#define DEBUG_MSD
	16
	17	#ifdef DEBUG_MSD
	18	#define DPRINTF(fmt, args...) \
	19	do { printf("usb-msd: " fmt , ##args); } while (0)
	20	#else
	21	#define DPRINTF(fmt, args...) do {} while(0)
	22	#endif
	23
	24	/* USB requests. */
	25	#define MassStorageReset 0xff
	26	#define GetMaxLun 0xfe
	27
	28	enum USBMSDMode {
	29	USB_MSDM_CBW, /* Command Block. */
	30	USB_MSDM_DATAOUT, /* Tranfer data to device. */
	31	USB_MSDM_DATAIN, /* Transfer data from device. */
	32	USB_MSDM_CSW /* Command Status. */
	33	};
	34
	35	typedef struct {
	36	USBDevice dev;
	37	enum USBMSDMode mode;
a917d384 PB	38	uint32_t scsi_len;
	39	uint8_t *scsi_buf;
	40	uint32_t usb_len;
	41	uint8_t *usb_buf;
2e5d83bb	42	uint32_t data_len;
a917d384	43	uint32_t residue;
2e5d83bb	44	uint32_t tag;
b56bdb32	45	BlockDriverState *bs;
2e5d83bb PB	46	SCSIDevice *scsi_dev;
2e5d83bb PB	47	int result;
4d611c9a PB	48	/* For async completion. */
4d611c9a PB	49	USBPacket *packet;
2e5d83bb PB	50	} MSDState;
2e5d83bb PB	51
a917d384 PB	52	struct usb_msd_cbw {
	53	uint32_t sig;
	54	uint32_t tag;
	55	uint32_t data_len;
	56	uint8_t flags;
	57	uint8_t lun;
	58	uint8_t cmd_len;
	59	uint8_t cmd[16];
	60	};
	61
	62	struct usb_msd_csw {
	63	uint32_t sig;
	64	uint32_t tag;
	65	uint32_t residue;
	66	uint8_t status;
	67	};
	68
2e5d83bb PB	69	static const uint8_t qemu_msd_dev_descriptor[] = {
	70	0x12, /* u8 bLength; */
	71	0x01, /* u8 bDescriptorType; Device */
e126cf13	72	0x00, 0x01, /* u16 bcdUSB; v1.0 */
2e5d83bb PB	73
	74	0x00, /* u8 bDeviceClass; */
	75	0x00, /* u8 bDeviceSubClass; */
	76	0x00, /* u8 bDeviceProtocol; [ low/full speeds only ] */
	77	0x08, /* u8 bMaxPacketSize0; 8 Bytes */
	78
	79	/* Vendor and product id are arbitrary. */
	80	0x00, 0x00, /* u16 idVendor; */
	81	0x00, 0x00, /* u16 idProduct; */
	82	0x00, 0x00, /* u16 bcdDevice */
	83
	84	0x01, /* u8 iManufacturer; */
	85	0x02, /* u8 iProduct; */
	86	0x03, /* u8 iSerialNumber; */
	87	0x01 /* u8 bNumConfigurations; */
	88	};
	89
	90	static const uint8_t qemu_msd_config_descriptor[] = {
	91
	92	/* one configuration */
	93	0x09, /* u8 bLength; */
	94	0x02, /* u8 bDescriptorType; Configuration */
	95	0x20, 0x00, /* u16 wTotalLength; */
	96	0x01, /* u8 bNumInterfaces; (1) */
	97	0x01, /* u8 bConfigurationValue; */
	98	0x00, /* u8 iConfiguration; */
5fafdf24	99	0xc0, /* u8 bmAttributes;
2e5d83bb PB	100	Bit 7: must be set,
	101	6: Self-powered,
	102	5: Remote wakeup,
	103	4..0: resvd */
	104	0x00, /* u8 MaxPower; */
3b46e624	105
2e5d83bb PB	106	/* one interface */
	107	0x09, /* u8 if_bLength; */
	108	0x04, /* u8 if_bDescriptorType; Interface */
	109	0x00, /* u8 if_bInterfaceNumber; */
	110	0x00, /* u8 if_bAlternateSetting; */
	111	0x02, /* u8 if_bNumEndpoints; */
	112	0x08, /* u8 if_bInterfaceClass; MASS STORAGE */
	113	0x06, /* u8 if_bInterfaceSubClass; SCSI */
	114	0x50, /* u8 if_bInterfaceProtocol; Bulk Only */
	115	0x00, /* u8 if_iInterface; */
3b46e624	116
2e5d83bb PB	117	/* Bulk-In endpoint */
	118	0x07, /* u8 ep_bLength; */
	119	0x05, /* u8 ep_bDescriptorType; Endpoint */
	120	0x81, /* u8 ep_bEndpointAddress; IN Endpoint 1 */
	121	0x02, /* u8 ep_bmAttributes; Bulk */
	122	0x40, 0x00, /* u16 ep_wMaxPacketSize; */
	123	0x00, /* u8 ep_bInterval; */
	124
	125	/* Bulk-Out endpoint */
	126	0x07, /* u8 ep_bLength; */
	127	0x05, /* u8 ep_bDescriptorType; Endpoint */
	128	0x02, /* u8 ep_bEndpointAddress; OUT Endpoint 2 */
	129	0x02, /* u8 ep_bmAttributes; Bulk */
	130	0x40, 0x00, /* u16 ep_wMaxPacketSize; */
	131	0x00 /* u8 ep_bInterval; */
	132	};
	133
a917d384 PB	134	static void usb_msd_copy_data(MSDState *s)
	135	{
	136	uint32_t len;
	137	len = s->usb_len;
	138	if (len > s->scsi_len)
	139	len = s->scsi_len;
	140	if (s->mode == USB_MSDM_DATAIN) {
	141	memcpy(s->usb_buf, s->scsi_buf, len);
	142	} else {
	143	memcpy(s->scsi_buf, s->usb_buf, len);
	144	}
	145	s->usb_len -= len;
	146	s->scsi_len -= len;
	147	s->usb_buf += len;
	148	s->scsi_buf += len;
	149	s->data_len -= len;
	150	if (s->scsi_len == 0) {
	151	if (s->mode == USB_MSDM_DATAIN) {
8ccc2ace	152	s->scsi_dev->read_data(s->scsi_dev, s->tag);
a917d384	153	} else if (s->mode == USB_MSDM_DATAOUT) {
8ccc2ace	154	s->scsi_dev->write_data(s->scsi_dev, s->tag);
a917d384 PB	155	}
	156	}
	157	}
	158
	159	static void usb_msd_send_status(MSDState *s)
	160	{
	161	struct usb_msd_csw csw;
	162
	163	csw.sig = cpu_to_le32(0x53425355);
	164	csw.tag = cpu_to_le32(s->tag);
	165	csw.residue = s->residue;
	166	csw.status = s->result;
	167	memcpy(s->usb_buf, &csw, 13);
	168	}
	169
	170	static void usb_msd_command_complete(void *opaque, int reason, uint32_t tag,
	171	uint32_t arg)
2e5d83bb PB	172	{
2e5d83bb PB	173	MSDState s = (MSDState )opaque;
a917d384	174	USBPacket *p = s->packet;
4d611c9a	175
a917d384 PB	176	if (tag != s->tag) {
	177	fprintf(stderr, "usb-msd: Unexpected SCSI Tag 0x%x\n", tag);
	178	}
4d611c9a	179	if (reason == SCSI_REASON_DONE) {
a917d384 PB	180	DPRINTF("Command complete %d\n", arg);
	181	s->residue = s->data_len;
	182	s->result = arg != 0;
	183	if (s->packet) {
	184	if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
	185	/* A deferred packet with no write data remaining must be
	186	the status read packet. */
	187	usb_msd_send_status(s);
	188	s->mode = USB_MSDM_CBW;
	189	} else {
	190	if (s->data_len) {
	191	s->data_len -= s->usb_len;
	192	if (s->mode == USB_MSDM_DATAIN)
	193	memset(s->usb_buf, 0, s->usb_len);
	194	s->usb_len = 0;
	195	}
	196	if (s->data_len == 0)
	197	s->mode = USB_MSDM_CSW;
	198	}
	199	s->packet = NULL;
	200	usb_packet_complete(p);
	201	} else if (s->data_len == 0) {
	202	s->mode = USB_MSDM_CSW;
	203	}
	204	return;
4d611c9a	205	}
a917d384	206	s->scsi_len = arg;
8ccc2ace	207	s->scsi_buf = s->scsi_dev->get_buf(s->scsi_dev, tag);
a917d384 PB	208	if (p) {
	209	usb_msd_copy_data(s);
	210	if (s->usb_len == 0) {
	211	/* Set s->packet to NULL before calling usb_packet_complete
	212	because annother request may be issued before
	213	usb_packet_complete returns. */
	214	DPRINTF("Packet complete %p\n", p);
	215	s->packet = NULL;
	216	usb_packet_complete(p);
	217	}
4d611c9a	218	}
2e5d83bb PB	219	}
2e5d83bb PB	220
059809e4	221	static void usb_msd_handle_reset(USBDevice *dev)
2e5d83bb PB	222	{
	223	MSDState s = (MSDState )dev;
	224
	225	DPRINTF("Reset\n");
	226	s->mode = USB_MSDM_CBW;
2e5d83bb PB	227	}
	228
	229	static int usb_msd_handle_control(USBDevice *dev, int request, int value,
	230	int index, int length, uint8_t *data)
	231	{
	232	MSDState s = (MSDState )dev;
	233	int ret = 0;
	234
	235	switch (request) {
	236	case DeviceRequest \| USB_REQ_GET_STATUS:
	237	data[0] = (1 << USB_DEVICE_SELF_POWERED) \|
	238	(dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
	239	data[1] = 0x00;
	240	ret = 2;
	241	break;
	242	case DeviceOutRequest \| USB_REQ_CLEAR_FEATURE:
	243	if (value == USB_DEVICE_REMOTE_WAKEUP) {
	244	dev->remote_wakeup = 0;
	245	} else {
	246	goto fail;
	247	}
	248	ret = 0;
	249	break;
	250	case DeviceOutRequest \| USB_REQ_SET_FEATURE:
	251	if (value == USB_DEVICE_REMOTE_WAKEUP) {
	252	dev->remote_wakeup = 1;
	253	} else {
	254	goto fail;
	255	}
	256	ret = 0;
	257	break;
	258	case DeviceOutRequest \| USB_REQ_SET_ADDRESS:
	259	dev->addr = value;
	260	ret = 0;
	261	break;
	262	case DeviceRequest \| USB_REQ_GET_DESCRIPTOR:
	263	switch(value >> 8) {
	264	case USB_DT_DEVICE:
5fafdf24	265	memcpy(data, qemu_msd_dev_descriptor,
2e5d83bb PB	266	sizeof(qemu_msd_dev_descriptor));
	267	ret = sizeof(qemu_msd_dev_descriptor);
	268	break;
	269	case USB_DT_CONFIG:
5fafdf24	270	memcpy(data, qemu_msd_config_descriptor,
2e5d83bb PB	271	sizeof(qemu_msd_config_descriptor));
	272	ret = sizeof(qemu_msd_config_descriptor);
	273	break;
	274	case USB_DT_STRING:
	275	switch(value & 0xff) {
	276	case 0:
	277	/* language ids */
	278	data[0] = 4;
	279	data[1] = 3;
	280	data[2] = 0x09;
	281	data[3] = 0x04;
	282	ret = 4;
	283	break;
	284	case 1:
	285	/* vendor description */
	286	ret = set_usb_string(data, "QEMU " QEMU_VERSION);
	287	break;
	288	case 2:
	289	/* product description */
	290	ret = set_usb_string(data, "QEMU USB HARDDRIVE");
	291	break;
	292	case 3:
	293	/* serial number */
	294	ret = set_usb_string(data, "1");
	295	break;
	296	default:
	297	goto fail;
	298	}
	299	break;
	300	default:
	301	goto fail;
	302	}
	303	break;
	304	case DeviceRequest \| USB_REQ_GET_CONFIGURATION:
	305	data[0] = 1;
	306	ret = 1;
	307	break;
	308	case DeviceOutRequest \| USB_REQ_SET_CONFIGURATION:
	309	ret = 0;
	310	break;
	311	case DeviceRequest \| USB_REQ_GET_INTERFACE:
	312	data[0] = 0;
	313	ret = 1;
	314	break;
	315	case DeviceOutRequest \| USB_REQ_SET_INTERFACE:
	316	ret = 0;
	317	break;
	318	case EndpointOutRequest \| USB_REQ_CLEAR_FEATURE:
	319	if (value == 0 && index != 0x81) { /* clear ep halt */
	320	goto fail;
	321	}
	322	ret = 0;
	323	break;
	324	/* Class specific requests. */
	325	case MassStorageReset:
	326	/* Reset state ready for the next CBW. */
	327	s->mode = USB_MSDM_CBW;
	328	ret = 0;
	329	break;
	330	case GetMaxLun:
	331	data[0] = 0;
	332	ret = 1;
	333	break;
	334	default:
335	fail:
336	ret = USB_RET_STALL;
337	break;
338	}
339	return ret;
340	}
341
4d611c9a PB	342	static void usb_msd_cancel_io(USBPacket p, void opaque)
	343	{
	344	MSDState *s = opaque;
8ccc2ace	345	s->scsi_dev->cancel_io(s->scsi_dev, s->tag);
4d611c9a	346	s->packet = NULL;
a917d384	347	s->scsi_len = 0;
4d611c9a PB	348	}
	349
	350	static int usb_msd_handle_data(USBDevice dev, USBPacket p)
2e5d83bb PB	351	{
	352	MSDState s = (MSDState )dev;
	353	int ret = 0;
	354	struct usb_msd_cbw cbw;
4d611c9a PB	355	uint8_t devep = p->devep;
	356	uint8_t *data = p->data;
	357	int len = p->len;
2e5d83bb	358
4d611c9a	359	switch (p->pid) {
2e5d83bb PB	360	case USB_TOKEN_OUT:
	361	if (devep != 2)
	362	goto fail;
	363
	364	switch (s->mode) {
	365	case USB_MSDM_CBW:
	366	if (len != 31) {
	367	fprintf(stderr, "usb-msd: Bad CBW size");
	368	goto fail;
	369	}
	370	memcpy(&cbw, data, 31);
	371	if (le32_to_cpu(cbw.sig) != 0x43425355) {
	372	fprintf(stderr, "usb-msd: Bad signature %08x\n",
	373	le32_to_cpu(cbw.sig));
	374	goto fail;
	375	}
	376	DPRINTF("Command on LUN %d\n", cbw.lun);
	377	if (cbw.lun != 0) {
	378	fprintf(stderr, "usb-msd: Bad LUN %d\n", cbw.lun);
	379	goto fail;
	380	}
	381	s->tag = le32_to_cpu(cbw.tag);
	382	s->data_len = le32_to_cpu(cbw.data_len);
	383	if (s->data_len == 0) {
	384	s->mode = USB_MSDM_CSW;
	385	} else if (cbw.flags & 0x80) {
	386	s->mode = USB_MSDM_DATAIN;
	387	} else {
	388	s->mode = USB_MSDM_DATAOUT;
	389	}
	390	DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
	391	s->tag, cbw.flags, cbw.cmd_len, s->data_len);
a917d384	392	s->residue = 0;
8ccc2ace	393	s->scsi_dev->send_command(s->scsi_dev, s->tag, cbw.cmd, 0);
a917d384 PB	394	/* ??? Should check that USB and SCSI data transfer
	395	directions match. */
	396	if (s->residue == 0) {
	397	if (s->mode == USB_MSDM_DATAIN) {
8ccc2ace	398	s->scsi_dev->read_data(s->scsi_dev, s->tag);
a917d384	399	} else if (s->mode == USB_MSDM_DATAOUT) {
8ccc2ace	400	s->scsi_dev->write_data(s->scsi_dev, s->tag);
a917d384 PB	401	}
a917d384 PB	402	}
2e5d83bb PB	403	ret = len;
	404	break;
	405
	406	case USB_MSDM_DATAOUT:
	407	DPRINTF("Data out %d/%d\n", len, s->data_len);
	408	if (len > s->data_len)
	409	goto fail;
	410
a917d384 PB	411	s->usb_buf = data;
	412	s->usb_len = len;
	413	if (s->scsi_len) {
	414	usb_msd_copy_data(s);
	415	}
	416	if (s->residue && s->usb_len) {
	417	s->data_len -= s->usb_len;
	418	if (s->data_len == 0)
	419	s->mode = USB_MSDM_CSW;
	420	s->usb_len = 0;
	421	}
	422	if (s->usb_len) {
4d611c9a PB	423	DPRINTF("Deferring packet %p\n", p);
	424	usb_defer_packet(p, usb_msd_cancel_io, s);
	425	s->packet = p;
	426	ret = USB_RET_ASYNC;
a917d384 PB	427	} else {
a917d384 PB	428	ret = len;
4d611c9a	429	}
2e5d83bb PB	430	break;
	431
	432	default:
	433	DPRINTF("Unexpected write (len %d)\n", len);
	434	goto fail;
	435	}
	436	break;
	437
	438	case USB_TOKEN_IN:
	439	if (devep != 1)
	440	goto fail;
	441
	442	switch (s->mode) {
a917d384 PB	443	case USB_MSDM_DATAOUT:
	444	if (s->data_len != 0 \|\| len < 13)
	445	goto fail;
	446	/* Waiting for SCSI write to complete. */
	447	usb_defer_packet(p, usb_msd_cancel_io, s);
	448	s->packet = p;
	449	ret = USB_RET_ASYNC;
	450	break;
	451
2e5d83bb PB	452	case USB_MSDM_CSW:
	453	DPRINTF("Command status %d tag 0x%x, len %d\n",
	454	s->result, s->tag, len);
	455	if (len < 13)
	456	goto fail;
	457
a917d384 PB	458	s->usb_len = len;
	459	s->usb_buf = data;
	460	usb_msd_send_status(s);
2e5d83bb	461	s->mode = USB_MSDM_CBW;
a917d384	462	ret = 13;
2e5d83bb PB	463	break;
	464
	465	case USB_MSDM_DATAIN:
	466	DPRINTF("Data in %d/%d\n", len, s->data_len);
	467	if (len > s->data_len)
	468	len = s->data_len;
a917d384 PB	469	s->usb_buf = data;
	470	s->usb_len = len;
	471	if (s->scsi_len) {
	472	usb_msd_copy_data(s);
	473	}
	474	if (s->residue && s->usb_len) {
	475	s->data_len -= s->usb_len;
	476	memset(s->usb_buf, 0, s->usb_len);
	477	if (s->data_len == 0)
	478	s->mode = USB_MSDM_CSW;
	479	s->usb_len = 0;
	480	}
	481	if (s->usb_len) {
4d611c9a PB	482	DPRINTF("Deferring packet %p\n", p);
	483	usb_defer_packet(p, usb_msd_cancel_io, s);
	484	s->packet = p;
	485	ret = USB_RET_ASYNC;
a917d384 PB	486	} else {
a917d384 PB	487	ret = len;
4d611c9a	488	}
2e5d83bb PB	489	break;
	490
	491	default:
	492	DPRINTF("Unexpected read (len %d)\n", len);
	493	goto fail;
	494	}
	495	break;
	496
	497	default:
	498	DPRINTF("Bad token\n");
	499	fail:
	500	ret = USB_RET_STALL;
	501	break;
	502	}
	503
	504	return ret;
	505	}
	506
059809e4 FB	507	static void usb_msd_handle_destroy(USBDevice *dev)
	508	{
	509	MSDState s = (MSDState )dev;
	510
8ccc2ace	511	s->scsi_dev->destroy(s->scsi_dev);
b56bdb32	512	bdrv_delete(s->bs);
059809e4 FB	513	qemu_free(s);
059809e4 FB	514	}
2e5d83bb PB	515
	516	USBDevice usb_msd_init(const char filename)
	517	{
	518	MSDState *s;
	519	BlockDriverState *bdrv;
	520
	521	s = qemu_mallocz(sizeof(MSDState));
	522	if (!s)
	523	return NULL;
	524
	525	bdrv = bdrv_new("usb");
b56bdb32 FB	526	if (bdrv_open(bdrv, filename, 0) < 0)
b56bdb32 FB	527	goto fail;
2bac6019 AZ	528	if (qemu_key_check(bdrv, filename))
2bac6019 AZ	529	goto fail;
b56bdb32	530	s->bs = bdrv;
2e5d83bb PB	531
	532	s->dev.speed = USB_SPEED_FULL;
	533	s->dev.handle_packet = usb_generic_handle_packet;
	534
	535	s->dev.handle_reset = usb_msd_handle_reset;
	536	s->dev.handle_control = usb_msd_handle_control;
	537	s->dev.handle_data = usb_msd_handle_data;
059809e4	538	s->dev.handle_destroy = usb_msd_handle_destroy;
2e5d83bb	539
1f6e24e7 FB	540	snprintf(s->dev.devname, sizeof(s->dev.devname), "QEMU USB MSD(%.16s)",
	541	filename);
	542
a917d384	543	s->scsi_dev = scsi_disk_init(bdrv, 0, usb_msd_command_complete, s);
059809e4	544	usb_msd_handle_reset((USBDevice *)s);
2e5d83bb	545	return (USBDevice *)s;
b56bdb32 FB	546	fail:
	547	qemu_free(s);
	548	return NULL;
2e5d83bb	549	}