[qemu.git] / hw / usb / dev-hid.c

/*
 * QEMU USB HID devices
 *
 * Copyright (c) 2005 Fabrice Bellard
 * Copyright (c) 2007 OpenMoko, Inc.  ([email protected])
 *
 * 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 "hw/hw.h"
#include "console.h"
#include "hw/usb.h"
#include "hw/usb/desc.h"
#include "qemu-timer.h"
#include "hw/hid.h"

/* HID interface requests */
#define GET_REPORT   0xa101
#define GET_IDLE     0xa102
#define GET_PROTOCOL 0xa103
#define SET_REPORT   0x2109
#define SET_IDLE     0x210a
#define SET_PROTOCOL 0x210b

/* HID descriptor types */
#define USB_DT_HID    0x21
#define USB_DT_REPORT 0x22
#define USB_DT_PHY    0x23

typedef struct USBHIDState {
    USBDevice dev;
    USBEndpoint *intr;
    HIDState hid;
} USBHIDState;

enum {
    STR_MANUFACTURER = 1,
    STR_PRODUCT_MOUSE,
    STR_PRODUCT_TABLET,
    STR_PRODUCT_KEYBOARD,
    STR_SERIALNUMBER,
    STR_CONFIG_MOUSE,
    STR_CONFIG_TABLET,
    STR_CONFIG_KEYBOARD,
};

static const USBDescStrings desc_strings = {
    [STR_MANUFACTURER]     = "QEMU",
    [STR_PRODUCT_MOUSE]    = "QEMU USB Mouse",
    [STR_PRODUCT_TABLET]   = "QEMU USB Tablet",
    [STR_PRODUCT_KEYBOARD] = "QEMU USB Keyboard",
    [STR_SERIALNUMBER]     = "42", /* == remote wakeup works */
    [STR_CONFIG_MOUSE]     = "HID Mouse",
    [STR_CONFIG_TABLET]    = "HID Tablet",
    [STR_CONFIG_KEYBOARD]  = "HID Keyboard",
};

static const USBDescIface desc_iface_mouse = {
    .bInterfaceNumber              = 0,
    .bNumEndpoints                 = 1,
    .bInterfaceClass               = USB_CLASS_HID,
    .bInterfaceSubClass            = 0x01, /* boot */
    .bInterfaceProtocol            = 0x02,
    .ndesc                         = 1,
    .descs = (USBDescOther[]) {
        {
            /* HID descriptor */
            .data = (uint8_t[]) {
                0x09,          /*  u8  bLength */
                USB_DT_HID,    /*  u8  bDescriptorType */
                0x01, 0x00,    /*  u16 HID_class */
                0x00,          /*  u8  country_code */
                0x01,          /*  u8  num_descriptors */
                USB_DT_REPORT, /*  u8  type: Report */
                52, 0,         /*  u16 len */
            },
        },
    },
    .eps = (USBDescEndpoint[]) {
        {
            .bEndpointAddress      = USB_DIR_IN | 0x01,
            .bmAttributes          = USB_ENDPOINT_XFER_INT,
            .wMaxPacketSize        = 4,
            .bInterval             = 0x0a,
        },
    },
};

static const USBDescIface desc_iface_tablet = {
    .bInterfaceNumber              = 0,
    .bNumEndpoints                 = 1,
    .bInterfaceClass               = USB_CLASS_HID,
    .bInterfaceProtocol            = 0x02,
    .ndesc                         = 1,
    .descs = (USBDescOther[]) {
        {
            /* HID descriptor */
            .data = (uint8_t[]) {
                0x09,          /*  u8  bLength */
                USB_DT_HID,    /*  u8  bDescriptorType */
                0x01, 0x00,    /*  u16 HID_class */
                0x00,          /*  u8  country_code */
                0x01,          /*  u8  num_descriptors */
                USB_DT_REPORT, /*  u8  type: Report */
                74, 0,         /*  u16 len */
            },
        },
    },
    .eps = (USBDescEndpoint[]) {
        {
            .bEndpointAddress      = USB_DIR_IN | 0x01,
            .bmAttributes          = USB_ENDPOINT_XFER_INT,
            .wMaxPacketSize        = 8,
            .bInterval             = 0x0a,
        },
    },
};

static const USBDescIface desc_iface_keyboard = {
    .bInterfaceNumber              = 0,
    .bNumEndpoints                 = 1,
    .bInterfaceClass               = USB_CLASS_HID,
    .bInterfaceSubClass            = 0x01, /* boot */
    .bInterfaceProtocol            = 0x01, /* keyboard */
    .ndesc                         = 1,
    .descs = (USBDescOther[]) {
        {
            /* HID descriptor */
            .data = (uint8_t[]) {
                0x09,          /*  u8  bLength */
                USB_DT_HID,    /*  u8  bDescriptorType */
                0x11, 0x01,    /*  u16 HID_class */
                0x00,          /*  u8  country_code */
                0x01,          /*  u8  num_descriptors */
                USB_DT_REPORT, /*  u8  type: Report */
                0x3f, 0,       /*  u16 len */
            },
        },
    },
    .eps = (USBDescEndpoint[]) {
        {
            .bEndpointAddress      = USB_DIR_IN | 0x01,
            .bmAttributes          = USB_ENDPOINT_XFER_INT,
            .wMaxPacketSize        = 8,
            .bInterval             = 0x0a,
        },
    },
};

static const USBDescDevice desc_device_mouse = {
    .bcdUSB                        = 0x0100,
    .bMaxPacketSize0               = 8,
    .bNumConfigurations            = 1,
    .confs = (USBDescConfig[]) {
        {
            .bNumInterfaces        = 1,
            .bConfigurationValue   = 1,
            .iConfiguration        = STR_CONFIG_MOUSE,
            .bmAttributes          = 0xa0,
            .bMaxPower             = 50,
            .nif = 1,
            .ifs = &desc_iface_mouse,
        },
    },
};

static const USBDescDevice desc_device_tablet = {
    .bcdUSB                        = 0x0100,
    .bMaxPacketSize0               = 8,
    .bNumConfigurations            = 1,
    .confs = (USBDescConfig[]) {
        {
            .bNumInterfaces        = 1,
            .bConfigurationValue   = 1,
            .iConfiguration        = STR_CONFIG_TABLET,
            .bmAttributes          = 0xa0,
            .bMaxPower             = 50,
            .nif = 1,
            .ifs = &desc_iface_tablet,
        },
    },
};

static const USBDescDevice desc_device_keyboard = {
    .bcdUSB                        = 0x0100,
    .bMaxPacketSize0               = 8,
    .bNumConfigurations            = 1,
    .confs = (USBDescConfig[]) {
        {
            .bNumInterfaces        = 1,
            .bConfigurationValue   = 1,
            .iConfiguration        = STR_CONFIG_KEYBOARD,
            .bmAttributes          = 0xa0,
            .bMaxPower             = 50,
            .nif = 1,
            .ifs = &desc_iface_keyboard,
        },
    },
};

static const USBDesc desc_mouse = {
    .id = {
        .idVendor          = 0x0627,
        .idProduct         = 0x0001,
        .bcdDevice         = 0,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT_MOUSE,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device_mouse,
    .str  = desc_strings,
};

static const USBDesc desc_tablet = {
    .id = {
        .idVendor          = 0x0627,
        .idProduct         = 0x0001,
        .bcdDevice         = 0,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT_TABLET,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device_tablet,
    .str  = desc_strings,
};

static const USBDesc desc_keyboard = {
    .id = {
        .idVendor          = 0x0627,
        .idProduct         = 0x0001,
        .bcdDevice         = 0,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT_KEYBOARD,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device_keyboard,
    .str  = desc_strings,
};

static const uint8_t qemu_mouse_hid_report_descriptor[] = {
    0x05, 0x01,		/* Usage Page (Generic Desktop) */
    0x09, 0x02,		/* Usage (Mouse) */
    0xa1, 0x01,		/* Collection (Application) */
    0x09, 0x01,		/*   Usage (Pointer) */
    0xa1, 0x00,		/*   Collection (Physical) */
    0x05, 0x09,		/*     Usage Page (Button) */
    0x19, 0x01,		/*     Usage Minimum (1) */
    0x29, 0x03,		/*     Usage Maximum (3) */
    0x15, 0x00,		/*     Logical Minimum (0) */
    0x25, 0x01,		/*     Logical Maximum (1) */
    0x95, 0x03,		/*     Report Count (3) */
    0x75, 0x01,		/*     Report Size (1) */
    0x81, 0x02,		/*     Input (Data, Variable, Absolute) */
    0x95, 0x01,		/*     Report Count (1) */
    0x75, 0x05,		/*     Report Size (5) */
    0x81, 0x01,		/*     Input (Constant) */
    0x05, 0x01,		/*     Usage Page (Generic Desktop) */
    0x09, 0x30,		/*     Usage (X) */
    0x09, 0x31,		/*     Usage (Y) */
    0x09, 0x38,		/*     Usage (Wheel) */
    0x15, 0x81,		/*     Logical Minimum (-0x7f) */
    0x25, 0x7f,		/*     Logical Maximum (0x7f) */
    0x75, 0x08,		/*     Report Size (8) */
    0x95, 0x03,		/*     Report Count (3) */
    0x81, 0x06,		/*     Input (Data, Variable, Relative) */
    0xc0,		/*   End Collection */
    0xc0,		/* End Collection */
};

static const uint8_t qemu_tablet_hid_report_descriptor[] = {
    0x05, 0x01,		/* Usage Page (Generic Desktop) */
    0x09, 0x01,		/* Usage (Pointer) */
    0xa1, 0x01,		/* Collection (Application) */
    0x09, 0x01,		/*   Usage (Pointer) */
    0xa1, 0x00,		/*   Collection (Physical) */
    0x05, 0x09,		/*     Usage Page (Button) */
    0x19, 0x01,		/*     Usage Minimum (1) */
    0x29, 0x03,		/*     Usage Maximum (3) */
    0x15, 0x00,		/*     Logical Minimum (0) */
    0x25, 0x01,		/*     Logical Maximum (1) */
    0x95, 0x03,		/*     Report Count (3) */
    0x75, 0x01,		/*     Report Size (1) */
    0x81, 0x02,		/*     Input (Data, Variable, Absolute) */
    0x95, 0x01,		/*     Report Count (1) */
    0x75, 0x05,		/*     Report Size (5) */
    0x81, 0x01,		/*     Input (Constant) */
    0x05, 0x01,		/*     Usage Page (Generic Desktop) */
    0x09, 0x30,		/*     Usage (X) */
    0x09, 0x31,		/*     Usage (Y) */
    0x15, 0x00,		/*     Logical Minimum (0) */
    0x26, 0xff, 0x7f,	/*     Logical Maximum (0x7fff) */
    0x35, 0x00,		/*     Physical Minimum (0) */
    0x46, 0xff, 0x7f,	/*     Physical Maximum (0x7fff) */
    0x75, 0x10,		/*     Report Size (16) */
    0x95, 0x02,		/*     Report Count (2) */
    0x81, 0x02,		/*     Input (Data, Variable, Absolute) */
    0x05, 0x01,		/*     Usage Page (Generic Desktop) */
    0x09, 0x38,		/*     Usage (Wheel) */
    0x15, 0x81,		/*     Logical Minimum (-0x7f) */
    0x25, 0x7f,		/*     Logical Maximum (0x7f) */
    0x35, 0x00,		/*     Physical Minimum (same as logical) */
    0x45, 0x00,		/*     Physical Maximum (same as logical) */
    0x75, 0x08,		/*     Report Size (8) */
    0x95, 0x01,		/*     Report Count (1) */
    0x81, 0x06,		/*     Input (Data, Variable, Relative) */
    0xc0,		/*   End Collection */
    0xc0,		/* End Collection */
};

static const uint8_t qemu_keyboard_hid_report_descriptor[] = {
    0x05, 0x01,		/* Usage Page (Generic Desktop) */
    0x09, 0x06,		/* Usage (Keyboard) */
    0xa1, 0x01,		/* Collection (Application) */
    0x75, 0x01,		/*   Report Size (1) */
    0x95, 0x08,		/*   Report Count (8) */
    0x05, 0x07,		/*   Usage Page (Key Codes) */
    0x19, 0xe0,		/*   Usage Minimum (224) */
    0x29, 0xe7,		/*   Usage Maximum (231) */
    0x15, 0x00,		/*   Logical Minimum (0) */
    0x25, 0x01,		/*   Logical Maximum (1) */
    0x81, 0x02,		/*   Input (Data, Variable, Absolute) */
    0x95, 0x01,		/*   Report Count (1) */
    0x75, 0x08,		/*   Report Size (8) */
    0x81, 0x01,		/*   Input (Constant) */
    0x95, 0x05,		/*   Report Count (5) */
    0x75, 0x01,		/*   Report Size (1) */
    0x05, 0x08,		/*   Usage Page (LEDs) */
    0x19, 0x01,		/*   Usage Minimum (1) */
    0x29, 0x05,		/*   Usage Maximum (5) */
    0x91, 0x02,		/*   Output (Data, Variable, Absolute) */
    0x95, 0x01,		/*   Report Count (1) */
    0x75, 0x03,		/*   Report Size (3) */
    0x91, 0x01,		/*   Output (Constant) */
    0x95, 0x06,		/*   Report Count (6) */
    0x75, 0x08,		/*   Report Size (8) */
    0x15, 0x00,		/*   Logical Minimum (0) */
    0x25, 0xff,		/*   Logical Maximum (255) */
    0x05, 0x07,		/*   Usage Page (Key Codes) */
    0x19, 0x00,		/*   Usage Minimum (0) */
    0x29, 0xff,		/*   Usage Maximum (255) */
    0x81, 0x00,		/*   Input (Data, Array) */
    0xc0,		/* End Collection */
};

static void usb_hid_changed(HIDState *hs)
{
    USBHIDState *us = container_of(hs, USBHIDState, hid);

    usb_wakeup(us->intr);
}

static void usb_hid_handle_reset(USBDevice *dev)
{
    USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);

    hid_reset(&us->hid);
}

static int usb_hid_handle_control(USBDevice *dev, USBPacket *p,
               int request, int value, int index, int length, uint8_t *data)
{
    USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);
    HIDState *hs = &us->hid;
    int ret;

    ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
    if (ret >= 0) {
        return ret;
    }

    ret = 0;
    switch (request) {
        /* hid specific requests */
    case InterfaceRequest | USB_REQ_GET_DESCRIPTOR:
        switch (value >> 8) {
        case 0x22:
            if (hs->kind == HID_MOUSE) {
		memcpy(data, qemu_mouse_hid_report_descriptor,
		       sizeof(qemu_mouse_hid_report_descriptor));
		ret = sizeof(qemu_mouse_hid_report_descriptor);
            } else if (hs->kind == HID_TABLET) {
                memcpy(data, qemu_tablet_hid_report_descriptor,
		       sizeof(qemu_tablet_hid_report_descriptor));
		ret = sizeof(qemu_tablet_hid_report_descriptor);
            } else if (hs->kind == HID_KEYBOARD) {
                memcpy(data, qemu_keyboard_hid_report_descriptor,
                       sizeof(qemu_keyboard_hid_report_descriptor));
                ret = sizeof(qemu_keyboard_hid_report_descriptor);
            }
            break;
        default:
            goto fail;
        }
        break;
    case GET_REPORT:
        if (hs->kind == HID_MOUSE || hs->kind == HID_TABLET) {
            ret = hid_pointer_poll(hs, data, length);
        } else if (hs->kind == HID_KEYBOARD) {
            ret = hid_keyboard_poll(hs, data, length);
        }
        break;
    case SET_REPORT:
        if (hs->kind == HID_KEYBOARD) {
            ret = hid_keyboard_write(hs, data, length);
        } else {
            goto fail;
        }
        break;
    case GET_PROTOCOL:
        if (hs->kind != HID_KEYBOARD && hs->kind != HID_MOUSE) {
            goto fail;
        }
        ret = 1;
        data[0] = hs->protocol;
        break;
    case SET_PROTOCOL:
        if (hs->kind != HID_KEYBOARD && hs->kind != HID_MOUSE) {
            goto fail;
        }
        ret = 0;
        hs->protocol = value;
        break;
    case GET_IDLE:
        ret = 1;
        data[0] = hs->idle;
        break;
    case SET_IDLE:
        hs->idle = (uint8_t) (value >> 8);
        hid_set_next_idle(hs, qemu_get_clock_ns(vm_clock));
        if (hs->kind == HID_MOUSE || hs->kind == HID_TABLET) {
            hid_pointer_activate(hs);
        }
        ret = 0;
        break;
    default:
    fail:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

static int usb_hid_handle_data(USBDevice *dev, USBPacket *p)
{
    USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);
    HIDState *hs = &us->hid;
    uint8_t buf[p->iov.size];
    int ret = 0;

    switch (p->pid) {
    case USB_TOKEN_IN:
        if (p->ep->nr == 1) {
            int64_t curtime = qemu_get_clock_ns(vm_clock);
            if (hs->kind == HID_MOUSE || hs->kind == HID_TABLET) {
                hid_pointer_activate(hs);
            }
            if (!hid_has_events(hs) &&
                (!hs->idle || hs->next_idle_clock - curtime > 0)) {
                return USB_RET_NAK;
            }
            hid_set_next_idle(hs, curtime);
            if (hs->kind == HID_MOUSE || hs->kind == HID_TABLET) {
                ret = hid_pointer_poll(hs, buf, p->iov.size);
            } else if (hs->kind == HID_KEYBOARD) {
                ret = hid_keyboard_poll(hs, buf, p->iov.size);
            }
            usb_packet_copy(p, buf, ret);
        } else {
            goto fail;
        }
        break;
    case USB_TOKEN_OUT:
    default:
    fail:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

static void usb_hid_handle_destroy(USBDevice *dev)
{
    USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);

    hid_free(&us->hid);
}

static int usb_hid_initfn(USBDevice *dev, int kind)
{
    USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);

    usb_desc_init(dev);
    us->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
    hid_init(&us->hid, kind, usb_hid_changed);
    return 0;
}

static int usb_tablet_initfn(USBDevice *dev)
{
    return usb_hid_initfn(dev, HID_TABLET);
}

static int usb_mouse_initfn(USBDevice *dev)
{
    return usb_hid_initfn(dev, HID_MOUSE);
}

static int usb_keyboard_initfn(USBDevice *dev)
{
    return usb_hid_initfn(dev, HID_KEYBOARD);
}

static int usb_ptr_post_load(void *opaque, int version_id)
{
    USBHIDState *s = opaque;

    if (s->dev.remote_wakeup) {
        hid_pointer_activate(&s->hid);
    }
    return 0;
}

static const VMStateDescription vmstate_usb_ptr = {
    .name = "usb-ptr",
    .version_id = 1,
    .minimum_version_id = 1,
    .post_load = usb_ptr_post_load,
    .fields = (VMStateField []) {
        VMSTATE_USB_DEVICE(dev, USBHIDState),
        VMSTATE_HID_POINTER_DEVICE(hid, USBHIDState),
        VMSTATE_END_OF_LIST()
    }
};

static const VMStateDescription vmstate_usb_kbd = {
    .name = "usb-kbd",
    .version_id = 1,
    .minimum_version_id = 1,
    .fields = (VMStateField []) {
        VMSTATE_USB_DEVICE(dev, USBHIDState),
        VMSTATE_HID_KEYBOARD_DEVICE(hid, USBHIDState),
        VMSTATE_END_OF_LIST()
    }
};

static void usb_hid_class_initfn(ObjectClass *klass, void *data)
{
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    uc->handle_reset   = usb_hid_handle_reset;
    uc->handle_control = usb_hid_handle_control;
    uc->handle_data    = usb_hid_handle_data;
    uc->handle_destroy = usb_hid_handle_destroy;
}

static void usb_tablet_class_initfn(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    usb_hid_class_initfn(klass, data);
    uc->init           = usb_tablet_initfn;
    uc->product_desc   = "QEMU USB Tablet";
    uc->usb_desc       = &desc_tablet;
    dc->vmsd = &vmstate_usb_ptr;
}

static TypeInfo usb_tablet_info = {
    .name          = "usb-tablet",
    .parent        = TYPE_USB_DEVICE,
    .instance_size = sizeof(USBHIDState),
    .class_init    = usb_tablet_class_initfn,
};

static void usb_mouse_class_initfn(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    usb_hid_class_initfn(klass, data);
    uc->init           = usb_mouse_initfn;
    uc->product_desc   = "QEMU USB Mouse";
    uc->usb_desc       = &desc_mouse;
    dc->vmsd = &vmstate_usb_ptr;
}

static TypeInfo usb_mouse_info = {
    .name          = "usb-mouse",
    .parent        = TYPE_USB_DEVICE,
    .instance_size = sizeof(USBHIDState),
    .class_init    = usb_mouse_class_initfn,
};

static void usb_keyboard_class_initfn(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    usb_hid_class_initfn(klass, data);
    uc->init           = usb_keyboard_initfn;
    uc->product_desc   = "QEMU USB Keyboard";
    uc->usb_desc       = &desc_keyboard;
    dc->vmsd = &vmstate_usb_kbd;
}

static TypeInfo usb_keyboard_info = {
    .name          = "usb-kbd",
    .parent        = TYPE_USB_DEVICE,
    .instance_size = sizeof(USBHIDState),
    .class_init    = usb_keyboard_class_initfn,
};

static void usb_hid_register_types(void)
{
    type_register_static(&usb_tablet_info);
    usb_legacy_register("usb-tablet", "tablet", NULL);
    type_register_static(&usb_mouse_info);
    usb_legacy_register("usb-mouse", "mouse", NULL);
    type_register_static(&usb_keyboard_info);
    usb_legacy_register("usb-kbd", "keyboard", NULL);
}

type_init(usb_hid_register_types)
Commit	Line	Data
59ae540c FB	1	/*
59ae540c FB	2	* QEMU USB HID devices
5fafdf24	3	*
59ae540c	4	* Copyright (c) 2005 Fabrice Bellard
47b2d338	5	* Copyright (c) 2007 OpenMoko, Inc. ([email protected])
5fafdf24	6	*
59ae540c FB	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	20	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	23	* THE SOFTWARE.
	24	*/
f1ae32a1	25	#include "hw/hw.h"
87ecb68b	26	#include "console.h"
f1ae32a1 GH	27	#include "hw/usb.h"
f1ae32a1 GH	28	#include "hw/usb/desc.h"
d8dfad9c	29	#include "qemu-timer.h"
f1ae32a1	30	#include "hw/hid.h"
59ae540c FB	31
	32	/* HID interface requests */
	33	#define GET_REPORT 0xa101
	34	#define GET_IDLE 0xa102
	35	#define GET_PROTOCOL 0xa103
47b2d338	36	#define SET_REPORT 0x2109
59ae540c FB	37	#define SET_IDLE 0x210a
	38	#define SET_PROTOCOL 0x210b
	39
47b2d338 AZ	40	/* HID descriptor types */
	41	#define USB_DT_HID 0x21
	42	#define USB_DT_REPORT 0x22
	43	#define USB_DT_PHY 0x23
	44
0d878eec GH	45	typedef struct USBHIDState {
0d878eec GH	46	USBDevice dev;
7567b51f	47	USBEndpoint *intr;
0d878eec	48	HIDState hid;
47b2d338 AZ	49	} USBHIDState;
47b2d338 AZ	50
0e4e9695 GH	51	enum {
	52	STR_MANUFACTURER = 1,
	53	STR_PRODUCT_MOUSE,
	54	STR_PRODUCT_TABLET,
	55	STR_PRODUCT_KEYBOARD,
	56	STR_SERIALNUMBER,
	57	STR_CONFIG_MOUSE,
	58	STR_CONFIG_TABLET,
	59	STR_CONFIG_KEYBOARD,
59ae540c FB	60	};
59ae540c FB	61
0e4e9695	62	static const USBDescStrings desc_strings = {
93bfef4c	63	[STR_MANUFACTURER] = "QEMU",
0e4e9695 GH	64	[STR_PRODUCT_MOUSE] = "QEMU USB Mouse",
	65	[STR_PRODUCT_TABLET] = "QEMU USB Tablet",
	66	[STR_PRODUCT_KEYBOARD] = "QEMU USB Keyboard",
7b074a22	67	[STR_SERIALNUMBER] = "42", /* == remote wakeup works */
0e4e9695 GH	68	[STR_CONFIG_MOUSE] = "HID Mouse",
	69	[STR_CONFIG_TABLET] = "HID Tablet",
	70	[STR_CONFIG_KEYBOARD] = "HID Keyboard",
09b26c5e FB	71	};
09b26c5e FB	72
0e4e9695 GH	73	static const USBDescIface desc_iface_mouse = {
	74	.bInterfaceNumber = 0,
	75	.bNumEndpoints = 1,
	76	.bInterfaceClass = USB_CLASS_HID,
	77	.bInterfaceSubClass = 0x01, /* boot */
	78	.bInterfaceProtocol = 0x02,
	79	.ndesc = 1,
	80	.descs = (USBDescOther[]) {
	81	{
	82	/* HID descriptor */
	83	.data = (uint8_t[]) {
	84	0x09, /* u8 bLength */
	85	USB_DT_HID, /* u8 bDescriptorType */
	86	0x01, 0x00, /* u16 HID_class */
	87	0x00, /* u8 country_code */
	88	0x01, /* u8 num_descriptors */
	89	USB_DT_REPORT, /* u8 type: Report */
	90	52, 0, /* u16 len */
	91	},
	92	},
	93	},
	94	.eps = (USBDescEndpoint[]) {
	95	{
	96	.bEndpointAddress = USB_DIR_IN \| 0x01,
	97	.bmAttributes = USB_ENDPOINT_XFER_INT,
	98	.wMaxPacketSize = 4,
	99	.bInterval = 0x0a,
	100	},
	101	},
59ae540c FB	102	};
59ae540c FB	103
0e4e9695 GH	104	static const USBDescIface desc_iface_tablet = {
	105	.bInterfaceNumber = 0,
	106	.bNumEndpoints = 1,
	107	.bInterfaceClass = USB_CLASS_HID,
0e4e9695 GH	108	.bInterfaceProtocol = 0x02,
	109	.ndesc = 1,
	110	.descs = (USBDescOther[]) {
	111	{
	112	/* HID descriptor */
	113	.data = (uint8_t[]) {
	114	0x09, /* u8 bLength */
	115	USB_DT_HID, /* u8 bDescriptorType */
	116	0x01, 0x00, /* u16 HID_class */
	117	0x00, /* u8 country_code */
	118	0x01, /* u8 num_descriptors */
	119	USB_DT_REPORT, /* u8 type: Report */
	120	74, 0, /* u16 len */
	121	},
	122	},
	123	},
	124	.eps = (USBDescEndpoint[]) {
	125	{
	126	.bEndpointAddress = USB_DIR_IN \| 0x01,
	127	.bmAttributes = USB_ENDPOINT_XFER_INT,
	128	.wMaxPacketSize = 8,
	129	.bInterval = 0x0a,
	130	},
	131	},
	132	};
	133
	134	static const USBDescIface desc_iface_keyboard = {
	135	.bInterfaceNumber = 0,
	136	.bNumEndpoints = 1,
	137	.bInterfaceClass = USB_CLASS_HID,
	138	.bInterfaceSubClass = 0x01, /* boot */
	139	.bInterfaceProtocol = 0x01, /* keyboard */
	140	.ndesc = 1,
	141	.descs = (USBDescOther[]) {
	142	{
	143	/* HID descriptor */
	144	.data = (uint8_t[]) {
	145	0x09, /* u8 bLength */
	146	USB_DT_HID, /* u8 bDescriptorType */
	147	0x11, 0x01, /* u16 HID_class */
	148	0x00, /* u8 country_code */
	149	0x01, /* u8 num_descriptors */
	150	USB_DT_REPORT, /* u8 type: Report */
	151	0x3f, 0, /* u16 len */
	152	},
	153	},
	154	},
	155	.eps = (USBDescEndpoint[]) {
	156	{
	157	.bEndpointAddress = USB_DIR_IN \| 0x01,
	158	.bmAttributes = USB_ENDPOINT_XFER_INT,
	159	.wMaxPacketSize = 8,
	160	.bInterval = 0x0a,
	161	},
	162	},
	163	};
	164
	165	static const USBDescDevice desc_device_mouse = {
	166	.bcdUSB = 0x0100,
	167	.bMaxPacketSize0 = 8,
	168	.bNumConfigurations = 1,
	169	.confs = (USBDescConfig[]) {
	170	{
	171	.bNumInterfaces = 1,
172	.bConfigurationValue = 1,
173	.iConfiguration = STR_CONFIG_MOUSE,
174	.bmAttributes = 0xa0,
175	.bMaxPower = 50,
add75088	176	.nif = 1,
0e4e9695 GH	177	.ifs = &desc_iface_mouse,
	178	},
	179	},
	180	};
	181
	182	static const USBDescDevice desc_device_tablet = {
	183	.bcdUSB = 0x0100,
	184	.bMaxPacketSize0 = 8,
	185	.bNumConfigurations = 1,
	186	.confs = (USBDescConfig[]) {
	187	{
	188	.bNumInterfaces = 1,
	189	.bConfigurationValue = 1,
	190	.iConfiguration = STR_CONFIG_TABLET,
	191	.bmAttributes = 0xa0,
	192	.bMaxPower = 50,
add75088	193	.nif = 1,
0e4e9695 GH	194	.ifs = &desc_iface_tablet,
	195	},
	196	},
	197	};
	198
	199	static const USBDescDevice desc_device_keyboard = {
	200	.bcdUSB = 0x0100,
	201	.bMaxPacketSize0 = 8,
	202	.bNumConfigurations = 1,
	203	.confs = (USBDescConfig[]) {
	204	{
	205	.bNumInterfaces = 1,
	206	.bConfigurationValue = 1,
	207	.iConfiguration = STR_CONFIG_KEYBOARD,
	208	.bmAttributes = 0xa0,
	209	.bMaxPower = 50,
add75088	210	.nif = 1,
0e4e9695 GH	211	.ifs = &desc_iface_keyboard,
	212	},
	213	},
	214	};
	215
	216	static const USBDesc desc_mouse = {
	217	.id = {
	218	.idVendor = 0x0627,
	219	.idProduct = 0x0001,
	220	.bcdDevice = 0,
	221	.iManufacturer = STR_MANUFACTURER,
	222	.iProduct = STR_PRODUCT_MOUSE,
	223	.iSerialNumber = STR_SERIALNUMBER,
	224	},
	225	.full = &desc_device_mouse,
	226	.str = desc_strings,
	227	};
	228
	229	static const USBDesc desc_tablet = {
	230	.id = {
	231	.idVendor = 0x0627,
	232	.idProduct = 0x0001,
	233	.bcdDevice = 0,
	234	.iManufacturer = STR_MANUFACTURER,
	235	.iProduct = STR_PRODUCT_TABLET,
	236	.iSerialNumber = STR_SERIALNUMBER,
	237	},
	238	.full = &desc_device_tablet,
	239	.str = desc_strings,
	240	};
	241
	242	static const USBDesc desc_keyboard = {
	243	.id = {
	244	.idVendor = 0x0627,
	245	.idProduct = 0x0001,
	246	.bcdDevice = 0,
	247	.iManufacturer = STR_MANUFACTURER,
	248	.iProduct = STR_PRODUCT_KEYBOARD,
	249	.iSerialNumber = STR_SERIALNUMBER,
	250	},
	251	.full = &desc_device_keyboard,
	252	.str = desc_strings,
47b2d338 AZ	253	};
47b2d338 AZ	254
59ae540c	255	static const uint8_t qemu_mouse_hid_report_descriptor[] = {
976f8eef AZ	256	0x05, 0x01, /* Usage Page (Generic Desktop) */
	257	0x09, 0x02, /* Usage (Mouse) */
	258	0xa1, 0x01, /* Collection (Application) */
	259	0x09, 0x01, /* Usage (Pointer) */
	260	0xa1, 0x00, /* Collection (Physical) */
	261	0x05, 0x09, /* Usage Page (Button) */
	262	0x19, 0x01, /* Usage Minimum (1) */
	263	0x29, 0x03, /* Usage Maximum (3) */
	264	0x15, 0x00, /* Logical Minimum (0) */
	265	0x25, 0x01, /* Logical Maximum (1) */
	266	0x95, 0x03, /* Report Count (3) */
	267	0x75, 0x01, /* Report Size (1) */
	268	0x81, 0x02, /* Input (Data, Variable, Absolute) */
	269	0x95, 0x01, /* Report Count (1) */
	270	0x75, 0x05, /* Report Size (5) */
	271	0x81, 0x01, /* Input (Constant) */
	272	0x05, 0x01, /* Usage Page (Generic Desktop) */
	273	0x09, 0x30, /* Usage (X) */
	274	0x09, 0x31, /* Usage (Y) */
	275	0x09, 0x38, /* Usage (Wheel) */
	276	0x15, 0x81, /* Logical Minimum (-0x7f) */
	277	0x25, 0x7f, /* Logical Maximum (0x7f) */
	278	0x75, 0x08, /* Report Size (8) */
	279	0x95, 0x03, /* Report Count (3) */
	280	0x81, 0x06, /* Input (Data, Variable, Relative) */
	281	0xc0, /* End Collection */
	282	0xc0, /* End Collection */
59ae540c FB	283	};
59ae540c FB	284
09b26c5e	285	static const uint8_t qemu_tablet_hid_report_descriptor[] = {
976f8eef AZ	286	0x05, 0x01, /* Usage Page (Generic Desktop) */
	287	0x09, 0x01, /* Usage (Pointer) */
	288	0xa1, 0x01, /* Collection (Application) */
	289	0x09, 0x01, /* Usage (Pointer) */
	290	0xa1, 0x00, /* Collection (Physical) */
	291	0x05, 0x09, /* Usage Page (Button) */
	292	0x19, 0x01, /* Usage Minimum (1) */
	293	0x29, 0x03, /* Usage Maximum (3) */
	294	0x15, 0x00, /* Logical Minimum (0) */
	295	0x25, 0x01, /* Logical Maximum (1) */
	296	0x95, 0x03, /* Report Count (3) */
	297	0x75, 0x01, /* Report Size (1) */
	298	0x81, 0x02, /* Input (Data, Variable, Absolute) */
	299	0x95, 0x01, /* Report Count (1) */
	300	0x75, 0x05, /* Report Size (5) */
	301	0x81, 0x01, /* Input (Constant) */
	302	0x05, 0x01, /* Usage Page (Generic Desktop) */
	303	0x09, 0x30, /* Usage (X) */
	304	0x09, 0x31, /* Usage (Y) */
	305	0x15, 0x00, /* Logical Minimum (0) */
de5c2d0a	306	0x26, 0xff, 0x7f, /* Logical Maximum (0x7fff) */
976f8eef	307	0x35, 0x00, /* Physical Minimum (0) */
de5c2d0a	308	0x46, 0xff, 0x7f, /* Physical Maximum (0x7fff) */
976f8eef AZ	309	0x75, 0x10, /* Report Size (16) */
	310	0x95, 0x02, /* Report Count (2) */
	311	0x81, 0x02, /* Input (Data, Variable, Absolute) */
	312	0x05, 0x01, /* Usage Page (Generic Desktop) */
	313	0x09, 0x38, /* Usage (Wheel) */
	314	0x15, 0x81, /* Logical Minimum (-0x7f) */
	315	0x25, 0x7f, /* Logical Maximum (0x7f) */
	316	0x35, 0x00, /* Physical Minimum (same as logical) */
	317	0x45, 0x00, /* Physical Maximum (same as logical) */
	318	0x75, 0x08, /* Report Size (8) */
	319	0x95, 0x01, /* Report Count (1) */
	320	0x81, 0x06, /* Input (Data, Variable, Relative) */
	321	0xc0, /* End Collection */
	322	0xc0, /* End Collection */
09b26c5e FB	323	};
09b26c5e FB	324
47b2d338 AZ	325	static const uint8_t qemu_keyboard_hid_report_descriptor[] = {
	326	0x05, 0x01, /* Usage Page (Generic Desktop) */
	327	0x09, 0x06, /* Usage (Keyboard) */
	328	0xa1, 0x01, /* Collection (Application) */
	329	0x75, 0x01, /* Report Size (1) */
	330	0x95, 0x08, /* Report Count (8) */
	331	0x05, 0x07, /* Usage Page (Key Codes) */
	332	0x19, 0xe0, /* Usage Minimum (224) */
	333	0x29, 0xe7, /* Usage Maximum (231) */
	334	0x15, 0x00, /* Logical Minimum (0) */
	335	0x25, 0x01, /* Logical Maximum (1) */
	336	0x81, 0x02, /* Input (Data, Variable, Absolute) */
	337	0x95, 0x01, /* Report Count (1) */
	338	0x75, 0x08, /* Report Size (8) */
	339	0x81, 0x01, /* Input (Constant) */
	340	0x95, 0x05, /* Report Count (5) */
	341	0x75, 0x01, /* Report Size (1) */
	342	0x05, 0x08, /* Usage Page (LEDs) */
	343	0x19, 0x01, /* Usage Minimum (1) */
	344	0x29, 0x05, /* Usage Maximum (5) */
	345	0x91, 0x02, /* Output (Data, Variable, Absolute) */
	346	0x95, 0x01, /* Report Count (1) */
	347	0x75, 0x03, /* Report Size (3) */
	348	0x91, 0x01, /* Output (Constant) */
	349	0x95, 0x06, /* Report Count (6) */
	350	0x75, 0x08, /* Report Size (8) */
	351	0x15, 0x00, /* Logical Minimum (0) */
	352	0x25, 0xff, /* Logical Maximum (255) */
	353	0x05, 0x07, /* Usage Page (Key Codes) */
	354	0x19, 0x00, /* Usage Minimum (0) */
	355	0x29, 0xff, /* Usage Maximum (255) */
	356	0x81, 0x00, /* Input (Data, Array) */
	357	0xc0, /* End Collection */
	358	};
	359
8bde6805	360	static void usb_hid_changed(HIDState *hs)
47e699dc	361	{
8bde6805	362	USBHIDState *us = container_of(hs, USBHIDState, hid);
47e699dc	363
7567b51f	364	usb_wakeup(us->intr);
47e699dc AZ	365	}
47e699dc AZ	366
8bde6805	367	static void usb_hid_handle_reset(USBDevice *dev)
47b2d338	368	{
0d878eec GH	369	USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);
0d878eec GH	370
dcfda673	371	hid_reset(&us->hid);
68735b6c KC	372	}
68735b6c KC	373
007fd62f HG	374	static int usb_hid_handle_control(USBDevice dev, USBPacket p,
007fd62f HG	375	int request, int value, int index, int length, uint8_t *data)
59ae540c	376	{
0d878eec GH	377	USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);
0d878eec GH	378	HIDState *hs = &us->hid;
0e4e9695	379	int ret;
59ae540c	380
007fd62f	381	ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
0e4e9695 GH	382	if (ret >= 0) {
	383	return ret;
	384	}
59ae540c	385
0e4e9695	386	ret = 0;
0d878eec	387	switch (request) {
59ae540c FB	388	/* hid specific requests */
59ae540c FB	389	case InterfaceRequest \| USB_REQ_GET_DESCRIPTOR:
0d878eec	390	switch (value >> 8) {
59ae540c	391	case 0x22:
0d878eec	392	if (hs->kind == HID_MOUSE) {
5fafdf24	393	memcpy(data, qemu_mouse_hid_report_descriptor,
09b26c5e FB	394	sizeof(qemu_mouse_hid_report_descriptor));
09b26c5e FB	395	ret = sizeof(qemu_mouse_hid_report_descriptor);
0d878eec GH	396	} else if (hs->kind == HID_TABLET) {
0d878eec GH	397	memcpy(data, qemu_tablet_hid_report_descriptor,
09b26c5e FB	398	sizeof(qemu_tablet_hid_report_descriptor));
09b26c5e FB	399	ret = sizeof(qemu_tablet_hid_report_descriptor);
0d878eec	400	} else if (hs->kind == HID_KEYBOARD) {
5fafdf24	401	memcpy(data, qemu_keyboard_hid_report_descriptor,
47b2d338 AZ	402	sizeof(qemu_keyboard_hid_report_descriptor));
	403	ret = sizeof(qemu_keyboard_hid_report_descriptor);
	404	}
	405	break;
59ae540c FB	406	default:
	407	goto fail;
	408	}
	409	break;
	410	case GET_REPORT:
0d878eec GH	411	if (hs->kind == HID_MOUSE \|\| hs->kind == HID_TABLET) {
	412	ret = hid_pointer_poll(hs, data, length);
	413	} else if (hs->kind == HID_KEYBOARD) {
	414	ret = hid_keyboard_poll(hs, data, length);
e7e73892	415	}
47b2d338 AZ	416	break;
47b2d338 AZ	417	case SET_REPORT:
0d878eec GH	418	if (hs->kind == HID_KEYBOARD) {
	419	ret = hid_keyboard_write(hs, data, length);
	420	} else {
47b2d338	421	goto fail;
0d878eec	422	}
47b2d338 AZ	423	break;
47b2d338 AZ	424	case GET_PROTOCOL:
0d878eec	425	if (hs->kind != HID_KEYBOARD && hs->kind != HID_MOUSE) {
47b2d338	426	goto fail;
0d878eec	427	}
47b2d338	428	ret = 1;
b069d348	429	data[0] = hs->protocol;
47b2d338 AZ	430	break;
47b2d338 AZ	431	case SET_PROTOCOL:
0d878eec	432	if (hs->kind != HID_KEYBOARD && hs->kind != HID_MOUSE) {
47b2d338	433	goto fail;
0d878eec	434	}
47b2d338	435	ret = 0;
b069d348	436	hs->protocol = value;
47b2d338 AZ	437	break;
	438	case GET_IDLE:
	439	ret = 1;
b069d348	440	data[0] = hs->idle;
59ae540c FB	441	break;
59ae540c FB	442	case SET_IDLE:
b069d348 GH	443	hs->idle = (uint8_t) (value >> 8);
b069d348 GH	444	hid_set_next_idle(hs, qemu_get_clock_ns(vm_clock));
21635e12 GH	445	if (hs->kind == HID_MOUSE \|\| hs->kind == HID_TABLET) {
	446	hid_pointer_activate(hs);
	447	}
59ae540c FB	448	ret = 0;
	449	break;
	450	default:
	451	fail:
	452	ret = USB_RET_STALL;
	453	break;
	454	}
	455	return ret;
	456	}
	457
47b2d338	458	static int usb_hid_handle_data(USBDevice dev, USBPacket p)
59ae540c	459	{
0d878eec GH	460	USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);
0d878eec GH	461	HIDState *hs = &us->hid;
4f4321c1	462	uint8_t buf[p->iov.size];
09b26c5e	463	int ret = 0;
59ae540c	464
0d878eec	465	switch (p->pid) {
59ae540c	466	case USB_TOKEN_IN:
079d0b7f	467	if (p->ep->nr == 1) {
74475455	468	int64_t curtime = qemu_get_clock_ns(vm_clock);
299aa1c6 GH	469	if (hs->kind == HID_MOUSE \|\| hs->kind == HID_TABLET) {
	470	hid_pointer_activate(hs);
	471	}
38931fa8	472	if (!hid_has_events(hs) &&
b069d348	473	(!hs->idle \|\| hs->next_idle_clock - curtime > 0)) {
117b3ae6	474	return USB_RET_NAK;
13f8b97a	475	}
b069d348	476	hid_set_next_idle(hs, curtime);
0d878eec GH	477	if (hs->kind == HID_MOUSE \|\| hs->kind == HID_TABLET) {
	478	ret = hid_pointer_poll(hs, buf, p->iov.size);
	479	} else if (hs->kind == HID_KEYBOARD) {
	480	ret = hid_keyboard_poll(hs, buf, p->iov.size);
13f8b97a	481	}
4f4321c1	482	usb_packet_copy(p, buf, ret);
59ae540c FB	483	} else {
	484	goto fail;
	485	}
	486	break;
	487	case USB_TOKEN_OUT:
	488	default:
	489	fail:
	490	ret = USB_RET_STALL;
	491	break;
	492	}
	493	return ret;
	494	}
	495
8bde6805	496	static void usb_hid_handle_destroy(USBDevice *dev)
09b26c5e	497	{
0d878eec	498	USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);
a980a065	499
8bde6805 GH	500	hid_free(&us->hid);
	501	}
	502
8bde6805 GH	503	static int usb_hid_initfn(USBDevice *dev, int kind)
	504	{
	505	USBHIDState *us = DO_UPCAST(USBHIDState, dev, dev);
	506
	507	usb_desc_init(dev);
7567b51f	508	us->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
8bde6805	509	hid_init(&us->hid, kind, usb_hid_changed);
806b6024	510	return 0;
09b26c5e FB	511	}
09b26c5e FB	512
806b6024	513	static int usb_tablet_initfn(USBDevice *dev)
59ae540c	514	{
0d878eec	515	return usb_hid_initfn(dev, HID_TABLET);
806b6024	516	}
59ae540c	517
806b6024 GH	518	static int usb_mouse_initfn(USBDevice *dev)
806b6024 GH	519	{
0d878eec	520	return usb_hid_initfn(dev, HID_MOUSE);
806b6024	521	}
59ae540c	522
806b6024 GH	523	static int usb_keyboard_initfn(USBDevice *dev)
806b6024 GH	524	{
0d878eec	525	return usb_hid_initfn(dev, HID_KEYBOARD);
806b6024	526	}
59ae540c	527
3a3286bf GH	528	static int usb_ptr_post_load(void *opaque, int version_id)
	529	{
	530	USBHIDState *s = opaque;
	531
	532	if (s->dev.remote_wakeup) {
	533	hid_pointer_activate(&s->hid);
	534	}
	535	return 0;
	536	}
	537
ee59e6b3 GH	538	static const VMStateDescription vmstate_usb_ptr = {
	539	.name = "usb-ptr",
	540	.version_id = 1,
	541	.minimum_version_id = 1,
3a3286bf	542	.post_load = usb_ptr_post_load,
ee59e6b3 GH	543	.fields = (VMStateField []) {
ee59e6b3 GH	544	VMSTATE_USB_DEVICE(dev, USBHIDState),
1f42d222	545	VMSTATE_HID_POINTER_DEVICE(hid, USBHIDState),
ee59e6b3 GH	546	VMSTATE_END_OF_LIST()
	547	}
	548	};
	549
	550	static const VMStateDescription vmstate_usb_kbd = {
	551	.name = "usb-kbd",
	552	.version_id = 1,
	553	.minimum_version_id = 1,
ee59e6b3 GH	554	.fields = (VMStateField []) {
ee59e6b3 GH	555	VMSTATE_USB_DEVICE(dev, USBHIDState),
1f42d222	556	VMSTATE_HID_KEYBOARD_DEVICE(hid, USBHIDState),
ee59e6b3 GH	557	VMSTATE_END_OF_LIST()
	558	}
	559	};
	560
7f595609	561	static void usb_hid_class_initfn(ObjectClass klass, void data)
62aed765 AL	562	{
	563	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
	564
62aed765 AL	565	uc->handle_reset = usb_hid_handle_reset;
	566	uc->handle_control = usb_hid_handle_control;
	567	uc->handle_data = usb_hid_handle_data;
	568	uc->handle_destroy = usb_hid_handle_destroy;
	569	}
	570
7f595609 AL	571	static void usb_tablet_class_initfn(ObjectClass klass, void data)
7f595609 AL	572	{
39bffca2	573	DeviceClass *dc = DEVICE_CLASS(klass);
7f595609 AL	574	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
	575
	576	usb_hid_class_initfn(klass, data);
	577	uc->init = usb_tablet_initfn;
	578	uc->product_desc = "QEMU USB Tablet";
	579	uc->usb_desc = &desc_tablet;
39bffca2	580	dc->vmsd = &vmstate_usb_ptr;
7f595609 AL	581	}
7f595609 AL	582
39bffca2 AL	583	static TypeInfo usb_tablet_info = {
	584	.name = "usb-tablet",
	585	.parent = TYPE_USB_DEVICE,
	586	.instance_size = sizeof(USBHIDState),
	587	.class_init = usb_tablet_class_initfn,
62aed765 AL	588	};
	589
	590	static void usb_mouse_class_initfn(ObjectClass klass, void data)
	591	{
39bffca2	592	DeviceClass *dc = DEVICE_CLASS(klass);
62aed765 AL	593	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
62aed765 AL	594
7f595609	595	usb_hid_class_initfn(klass, data);
62aed765 AL	596	uc->init = usb_mouse_initfn;
	597	uc->product_desc = "QEMU USB Mouse";
	598	uc->usb_desc = &desc_mouse;
39bffca2	599	dc->vmsd = &vmstate_usb_ptr;
62aed765 AL	600	}
62aed765 AL	601
39bffca2 AL	602	static TypeInfo usb_mouse_info = {
	603	.name = "usb-mouse",
	604	.parent = TYPE_USB_DEVICE,
	605	.instance_size = sizeof(USBHIDState),
	606	.class_init = usb_mouse_class_initfn,
62aed765 AL	607	};
	608
	609	static void usb_keyboard_class_initfn(ObjectClass klass, void data)
	610	{
39bffca2	611	DeviceClass *dc = DEVICE_CLASS(klass);
62aed765 AL	612	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
62aed765 AL	613
7f595609	614	usb_hid_class_initfn(klass, data);
62aed765 AL	615	uc->init = usb_keyboard_initfn;
	616	uc->product_desc = "QEMU USB Keyboard";
	617	uc->usb_desc = &desc_keyboard;
39bffca2	618	dc->vmsd = &vmstate_usb_kbd;
62aed765 AL	619	}
62aed765 AL	620
39bffca2 AL	621	static TypeInfo usb_keyboard_info = {
	622	.name = "usb-kbd",
	623	.parent = TYPE_USB_DEVICE,
	624	.instance_size = sizeof(USBHIDState),
	625	.class_init = usb_keyboard_class_initfn,
806b6024 GH	626	};
806b6024 GH	627
83f7d43a	628	static void usb_hid_register_types(void)
806b6024	629	{
39bffca2	630	type_register_static(&usb_tablet_info);
ba02430f	631	usb_legacy_register("usb-tablet", "tablet", NULL);
39bffca2	632	type_register_static(&usb_mouse_info);
ba02430f	633	usb_legacy_register("usb-mouse", "mouse", NULL);
39bffca2	634	type_register_static(&usb_keyboard_info);
ba02430f	635	usb_legacy_register("usb-kbd", "keyboard", NULL);
806b6024	636	}
83f7d43a AF	637
83f7d43a AF	638	type_init(usb_hid_register_types)