3 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * This file contains the USB template for an USB Mouse Device.
31 #ifdef USB_GLOBAL_INCLUDE_FILE
32 #include USB_GLOBAL_INCLUDE_FILE
34 #include <sys/stdint.h>
35 #include <sys/stddef.h>
36 #include <sys/param.h>
37 #include <sys/queue.h>
38 #include <sys/types.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
42 #include <sys/module.h>
44 #include <sys/mutex.h>
45 #include <sys/condvar.h>
46 #include <sys/sysctl.h>
48 #include <sys/unistd.h>
49 #include <sys/callout.h>
50 #include <sys/malloc.h>
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usbdi.h>
55 #include <dev/usb/usb_core.h>
56 #include <dev/usb/usb_cdc.h>
58 #include <dev/usb/template/usb_template.h>
59 #endif /* USB_GLOBAL_INCLUDE_FILE */
68 #define STRING_PRODUCT \
69 "M\0o\0u\0s\0e\0 \0T\0e\0s\0t\0 \0D\0e\0v\0i\0c\0e"
71 #define STRING_MOUSE \
72 "M\0o\0u\0s\0e\0 \0i\0n\0t\0e\0r\0f\0a\0c\0e"
74 /* make the real string descriptors */
76 USB_MAKE_STRING_DESC(STRING_MOUSE, string_mouse);
77 USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product);
81 /* The following HID descriptor was dumped from a HP mouse. */
83 static uint8_t mouse_hid_descriptor[] = {
84 0x05, 0x01, 0x09, 0x02, 0xa1, 0x01, 0x09, 0x01,
85 0xa1, 0x00, 0x05, 0x09, 0x19, 0x01, 0x29, 0x03,
86 0x15, 0x00, 0x25, 0x01, 0x95, 0x03, 0x75, 0x01,
87 0x81, 0x02, 0x95, 0x05, 0x81, 0x03, 0x05, 0x01,
88 0x09, 0x30, 0x09, 0x31, 0x09, 0x38, 0x15, 0x81,
89 0x25, 0x7f, 0x75, 0x08, 0x95, 0x03, 0x81, 0x06,
93 static const struct usb_temp_packet_size mouse_intr_mps = {
94 .mps[USB_SPEED_LOW] = 8,
95 .mps[USB_SPEED_FULL] = 8,
96 .mps[USB_SPEED_HIGH] = 8,
99 static const struct usb_temp_interval mouse_intr_interval = {
100 .bInterval[USB_SPEED_LOW] = 2, /* 2ms */
101 .bInterval[USB_SPEED_FULL] = 2, /* 2ms */
102 .bInterval[USB_SPEED_HIGH] = 5, /* 2ms */
105 static const struct usb_temp_endpoint_desc mouse_ep_0 = {
106 .ppRawDesc = NULL, /* no raw descriptors */
107 .pPacketSize = &mouse_intr_mps,
108 .pIntervals = &mouse_intr_interval,
109 .bEndpointAddress = UE_DIR_IN,
110 .bmAttributes = UE_INTERRUPT,
113 static const struct usb_temp_endpoint_desc *mouse_endpoints[] = {
118 static const uint8_t mouse_raw_desc[] = {
119 0x09, 0x21, 0x10, 0x01, 0x00, 0x01, 0x22, sizeof(mouse_hid_descriptor),
123 static const void *mouse_iface_0_desc[] = {
128 static const struct usb_temp_interface_desc mouse_iface_0 = {
129 .ppRawDesc = mouse_iface_0_desc,
130 .ppEndpoints = mouse_endpoints,
131 .bInterfaceClass = 3,
132 .bInterfaceSubClass = 1,
133 .bInterfaceProtocol = 2,
134 .iInterface = INDEX_MOUSE,
137 static const struct usb_temp_interface_desc *mouse_interfaces[] = {
142 static const struct usb_temp_config_desc mouse_config_desc = {
143 .ppIfaceDesc = mouse_interfaces,
144 .bmAttributes = UC_BUS_POWERED,
145 .bMaxPower = 25, /* 50 mA */
146 .iConfiguration = INDEX_PRODUCT,
149 static const struct usb_temp_config_desc *mouse_configs[] = {
154 static usb_temp_get_string_desc_t mouse_get_string_desc;
155 static usb_temp_get_vendor_desc_t mouse_get_vendor_desc;
157 const struct usb_temp_device_desc usb_template_mouse = {
158 .getStringDesc = &mouse_get_string_desc,
159 .getVendorDesc = &mouse_get_vendor_desc,
160 .ppConfigDesc = mouse_configs,
161 .idVendor = USB_TEMPLATE_VENDOR,
164 .bDeviceClass = UDCLASS_COMM,
165 .bDeviceSubClass = 0,
166 .bDeviceProtocol = 0,
168 .iProduct = INDEX_PRODUCT,
172 /*------------------------------------------------------------------------*
173 * mouse_get_vendor_desc
176 * NULL: Failure. No such vendor descriptor.
177 * Else: Success. Pointer to vendor descriptor is returned.
178 *------------------------------------------------------------------------*/
180 mouse_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
182 if ((req->bmRequestType == 0x81) && (req->bRequest == 0x06) &&
183 (req->wValue[0] == 0x00) && (req->wValue[1] == 0x22) &&
184 (req->wIndex[1] == 0) && (req->wIndex[0] == 0)) {
186 *plen = sizeof(mouse_hid_descriptor);
187 return (mouse_hid_descriptor);
192 /*------------------------------------------------------------------------*
193 * mouse_get_string_desc
196 * NULL: Failure. No such string.
197 * Else: Success. Pointer to string descriptor is returned.
198 *------------------------------------------------------------------------*/
200 mouse_get_string_desc(uint16_t lang_id, uint8_t string_index)
202 static const void *ptr[INDEX_MAX] = {
203 [INDEX_LANG] = &usb_string_lang_en,
204 [INDEX_MOUSE] = &string_mouse,
205 [INDEX_PRODUCT] = &string_product,
208 if (string_index == 0) {
209 return (&usb_string_lang_en);
211 if (lang_id != 0x0409) {
214 if (string_index < INDEX_MAX) {
215 return (ptr[string_index]);