[qemu.git] / hw / usb.c

/*
 * QEMU USB emulation
 *
 * Copyright (c) 2005 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#include "vl.h"

void usb_attach(USBPort *port, USBDevice *dev)
{
    port->attach(port, dev);
}

/**********************/
/* generic USB device helpers (you are not forced to use them when
   writing your USB device driver, but they help handling the
   protocol)
*/

#define SETUP_STATE_IDLE 0
#define SETUP_STATE_DATA 1
#define SETUP_STATE_ACK  2

int usb_generic_handle_packet(USBDevice *s, USBPacket *p)
{
    int l, ret = 0;
    int len = p->len;
    uint8_t *data = p->data;

    switch(p->pid) {
    case USB_MSG_ATTACH:
        s->state = USB_STATE_ATTACHED;
        break;
    case USB_MSG_DETACH:
        s->state = USB_STATE_NOTATTACHED;
        break;
    case USB_MSG_RESET:
        s->remote_wakeup = 0;
        s->addr = 0;
        s->state = USB_STATE_DEFAULT;
        s->handle_reset(s);
        break;
    case USB_TOKEN_SETUP:
        if (s->state < USB_STATE_DEFAULT || p->devaddr != s->addr)
            return USB_RET_NODEV;
        if (len != 8)
            goto fail;
        memcpy(s->setup_buf, data, 8);
        s->setup_len = (s->setup_buf[7] << 8) | s->setup_buf[6];
        s->setup_index = 0;
        if (s->setup_buf[0] & USB_DIR_IN) {
            ret = s->handle_control(s,
                                    (s->setup_buf[0] << 8) | s->setup_buf[1],
                                    (s->setup_buf[3] << 8) | s->setup_buf[2],
                                    (s->setup_buf[5] << 8) | s->setup_buf[4],
                                    s->setup_len,
                                    s->data_buf);
            if (ret < 0)
                return ret;
            if (ret < s->setup_len)
                s->setup_len = ret;
            s->setup_state = SETUP_STATE_DATA;
        } else {
            if (s->setup_len == 0)
                s->setup_state = SETUP_STATE_ACK;
            else
                s->setup_state = SETUP_STATE_DATA;
        }
        break;
    case USB_TOKEN_IN:
        if (s->state < USB_STATE_DEFAULT || p->devaddr != s->addr)
            return USB_RET_NODEV;
        switch(p->devep) {
        case 0:
            switch(s->setup_state) {
            case SETUP_STATE_ACK:
                if (!(s->setup_buf[0] & USB_DIR_IN)) {
                    s->setup_state = SETUP_STATE_IDLE;
                    ret = s->handle_control(s,
                                      (s->setup_buf[0] << 8) | s->setup_buf[1],
                                      (s->setup_buf[3] << 8) | s->setup_buf[2],
                                      (s->setup_buf[5] << 8) | s->setup_buf[4],
                                      s->setup_len,
                                      s->data_buf);
                    if (ret > 0)
                        ret = 0;
                } else {
                    /* return 0 byte */
                }
                break;
            case SETUP_STATE_DATA:
                if (s->setup_buf[0] & USB_DIR_IN) {
                    l = s->setup_len - s->setup_index;
                    if (l > len)
                        l = len;
                    memcpy(data, s->data_buf + s->setup_index, l);
                    s->setup_index += l;
                    if (s->setup_index >= s->setup_len)
                        s->setup_state = SETUP_STATE_ACK;
                    ret = l;
                } else {
                    s->setup_state = SETUP_STATE_IDLE;
                    goto fail;
                }
                break;
            default:
                goto fail;
            }
            break;
        default:
            ret = s->handle_data(s, p);
            break;
        }
        break;
    case USB_TOKEN_OUT:
        if (s->state < USB_STATE_DEFAULT || p->devaddr != s->addr)
            return USB_RET_NODEV;
        switch(p->devep) {
        case 0:
            switch(s->setup_state) {
            case SETUP_STATE_ACK:
                if (s->setup_buf[0] & USB_DIR_IN) {
                    s->setup_state = SETUP_STATE_IDLE;
                    /* transfer OK */
                } else {
                    /* ignore additional output */
                }
                break;
            case SETUP_STATE_DATA:
                if (!(s->setup_buf[0] & USB_DIR_IN)) {
                    l = s->setup_len - s->setup_index;
                    if (l > len)
                        l = len;
                    memcpy(s->data_buf + s->setup_index, data, l);
                    s->setup_index += l;
                    if (s->setup_index >= s->setup_len)
                        s->setup_state = SETUP_STATE_ACK;
                    ret = l;
                } else {
                    s->setup_state = SETUP_STATE_IDLE;
                    goto fail;
                }
                break;
            default:
                goto fail;
            }
            break;
        default:
            ret = s->handle_data(s, p);
            break;
        }
        break;
    default:
    fail:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

/* XXX: fix overflow */
int set_usb_string(uint8_t *buf, const char *str)
{
    int len, i;
    uint8_t *q;

    q = buf;
    len = strlen(str);
    *q++ = 2 * len + 2;
    *q++ = 3;
    for(i = 0; i < len; i++) {
        *q++ = str[i];
        *q++ = 0;
    }
    return q - buf;
}

/* Send an internal message to a USB device.  */
void usb_send_msg(USBDevice *dev, int msg)
{
    USBPacket p;
    memset(&p, 0, sizeof(p));
    p.pid = msg;
    dev->handle_packet(dev, &p);
}
Commit	Line	Data
bb36d470 FB	1	/*
	2	* QEMU USB emulation
	3	*
	4	* Copyright (c) 2005 Fabrice Bellard
5fafdf24	5	*
bb36d470 FB	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24	#include "vl.h"
	25
	26	void usb_attach(USBPort port, USBDevice dev)
	27	{
	28	port->attach(port, dev);
	29	}
	30
	31	/**********************/
	32	/* generic USB device helpers (you are not forced to use them when
	33	writing your USB device driver, but they help handling the
5fafdf24	34	protocol)
bb36d470 FB	35	*/
	36
	37	#define SETUP_STATE_IDLE 0
	38	#define SETUP_STATE_DATA 1
	39	#define SETUP_STATE_ACK 2
	40
4d611c9a	41	int usb_generic_handle_packet(USBDevice s, USBPacket p)
bb36d470 FB	42	{
bb36d470 FB	43	int l, ret = 0;
4d611c9a PB	44	int len = p->len;
4d611c9a PB	45	uint8_t *data = p->data;
bb36d470	46
4d611c9a	47	switch(p->pid) {
bb36d470 FB	48	case USB_MSG_ATTACH:
	49	s->state = USB_STATE_ATTACHED;
	50	break;
	51	case USB_MSG_DETACH:
	52	s->state = USB_STATE_NOTATTACHED;
	53	break;
	54	case USB_MSG_RESET:
	55	s->remote_wakeup = 0;
	56	s->addr = 0;
	57	s->state = USB_STATE_DEFAULT;
059809e4	58	s->handle_reset(s);
bb36d470 FB	59	break;
bb36d470 FB	60	case USB_TOKEN_SETUP:
4d611c9a	61	if (s->state < USB_STATE_DEFAULT \|\| p->devaddr != s->addr)
bb36d470 FB	62	return USB_RET_NODEV;
	63	if (len != 8)
	64	goto fail;
	65	memcpy(s->setup_buf, data, 8);
	66	s->setup_len = (s->setup_buf[7] << 8) \| s->setup_buf[6];
	67	s->setup_index = 0;
	68	if (s->setup_buf[0] & USB_DIR_IN) {
5fafdf24	69	ret = s->handle_control(s,
bb36d470 FB	70	(s->setup_buf[0] << 8) \| s->setup_buf[1],
	71	(s->setup_buf[3] << 8) \| s->setup_buf[2],
	72	(s->setup_buf[5] << 8) \| s->setup_buf[4],
	73	s->setup_len,
	74	s->data_buf);
	75	if (ret < 0)
	76	return ret;
	77	if (ret < s->setup_len)
	78	s->setup_len = ret;
	79	s->setup_state = SETUP_STATE_DATA;
	80	} else {
	81	if (s->setup_len == 0)
	82	s->setup_state = SETUP_STATE_ACK;
	83	else
	84	s->setup_state = SETUP_STATE_DATA;
	85	}
	86	break;
	87	case USB_TOKEN_IN:
4d611c9a	88	if (s->state < USB_STATE_DEFAULT \|\| p->devaddr != s->addr)
bb36d470	89	return USB_RET_NODEV;
4d611c9a	90	switch(p->devep) {
bb36d470 FB	91	case 0:
	92	switch(s->setup_state) {
	93	case SETUP_STATE_ACK:
bb36d470	94	if (!(s->setup_buf[0] & USB_DIR_IN)) {
56bebe70	95	s->setup_state = SETUP_STATE_IDLE;
5fafdf24	96	ret = s->handle_control(s,
bb36d470 FB	97	(s->setup_buf[0] << 8) \| s->setup_buf[1],
	98	(s->setup_buf[3] << 8) \| s->setup_buf[2],
	99	(s->setup_buf[5] << 8) \| s->setup_buf[4],
	100	s->setup_len,
	101	s->data_buf);
	102	if (ret > 0)
	103	ret = 0;
	104	} else {
56bebe70	105	/* return 0 byte */
bb36d470 FB	106	}
	107	break;
	108	case SETUP_STATE_DATA:
	109	if (s->setup_buf[0] & USB_DIR_IN) {
	110	l = s->setup_len - s->setup_index;
	111	if (l > len)
	112	l = len;
	113	memcpy(data, s->data_buf + s->setup_index, l);
	114	s->setup_index += l;
	115	if (s->setup_index >= s->setup_len)
	116	s->setup_state = SETUP_STATE_ACK;
	117	ret = l;
	118	} else {
	119	s->setup_state = SETUP_STATE_IDLE;
	120	goto fail;
	121	}
	122	break;
	123	default:
	124	goto fail;
	125	}
	126	break;
	127	default:
4d611c9a	128	ret = s->handle_data(s, p);
bb36d470 FB	129	break;
	130	}
	131	break;
	132	case USB_TOKEN_OUT:
4d611c9a	133	if (s->state < USB_STATE_DEFAULT \|\| p->devaddr != s->addr)
bb36d470	134	return USB_RET_NODEV;
4d611c9a	135	switch(p->devep) {
bb36d470 FB	136	case 0:
	137	switch(s->setup_state) {
	138	case SETUP_STATE_ACK:
bb36d470	139	if (s->setup_buf[0] & USB_DIR_IN) {
56bebe70	140	s->setup_state = SETUP_STATE_IDLE;
bb36d470 FB	141	/* transfer OK */
bb36d470 FB	142	} else {
aa1f17c1	143	/* ignore additional output */
bb36d470 FB	144	}
	145	break;
	146	case SETUP_STATE_DATA:
	147	if (!(s->setup_buf[0] & USB_DIR_IN)) {
	148	l = s->setup_len - s->setup_index;
	149	if (l > len)
	150	l = len;
	151	memcpy(s->data_buf + s->setup_index, data, l);
	152	s->setup_index += l;
	153	if (s->setup_index >= s->setup_len)
	154	s->setup_state = SETUP_STATE_ACK;
	155	ret = l;
	156	} else {
	157	s->setup_state = SETUP_STATE_IDLE;
	158	goto fail;
	159	}
	160	break;
	161	default:
	162	goto fail;
	163	}
	164	break;
	165	default:
4d611c9a	166	ret = s->handle_data(s, p);
bb36d470 FB	167	break;
	168	}
	169	break;
	170	default:
	171	fail:
	172	ret = USB_RET_STALL;
	173	break;
	174	}
	175	return ret;
	176	}
	177
	178	/* XXX: fix overflow */
	179	int set_usb_string(uint8_t buf, const char str)
	180	{
	181	int len, i;
	182	uint8_t *q;
	183
	184	q = buf;
	185	len = strlen(str);
ce5c37c2	186	q++ = 2 len + 2;
bb36d470 FB	187	*q++ = 3;
	188	for(i = 0; i < len; i++) {
	189	*q++ = str[i];
	190	*q++ = 0;
	191	}
	192	return q - buf;
	193	}
4d611c9a PB	194
	195	/* Send an internal message to a USB device. */
	196	void usb_send_msg(USBDevice *dev, int msg)
	197	{
	198	USBPacket p;
	199	memset(&p, 0, sizeof(p));
	200	p.pid = msg;
	201	dev->handle_packet(dev, &p);
	202	}
	203