[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 "vl.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 */
	0x10, 0x00, /*  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) {
            scsi_read_data(s->scsi_dev, s->tag);
        } else if (s->mode == USB_MSDM_DATAOUT) {
            scsi_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 = scsi_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;
    scsi_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;
            scsi_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) {
                    scsi_read_data(s->scsi_dev, s->tag);
                } else if (s->mode == USB_MSDM_DATAOUT) {
                    scsi_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;

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