usb_template_mouse.c revision 246123 
1/* $FreeBSD: head/sys/dev/usb/template/usb_template_mouse.c 246123 2013-01-30 15:46:26Z hselasky $ */
2/*-
3 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 */
26
27/*
28 * This file contains the USB template for an USB Mouse Device.
29 */
30
31#ifdef USB_GLOBAL_INCLUDE_FILE
32#include USB_GLOBAL_INCLUDE_FILE
33#else
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>
41#include <sys/bus.h>
42#include <sys/module.h>
43#include <sys/lock.h>
44#include <sys/mutex.h>
45#include <sys/condvar.h>
46#include <sys/sysctl.h>
47#include <sys/sx.h>
48#include <sys/unistd.h>
49#include <sys/callout.h>
50#include <sys/malloc.h>
51#include <sys/priv.h>
52
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>
57
58#include <dev/usb/template/usb_template.h>
59#endif			/* USB_GLOBAL_INCLUDE_FILE */
60
61enum {
62	INDEX_LANG,
63	INDEX_MOUSE,
64	INDEX_PRODUCT,
65	INDEX_MAX,
66};
67
68#define	STRING_PRODUCT \
69  'M', 0, 'o', 0, 'u', 0, 's', 0, 'e', 0, ' ', 0, \
70  'T', 0, 'e', 0, 's', 0, 't', 0, ' ', 0, \
71  'D', 0, 'e', 0, 'v', 0, 'i', 0, 'c', 0, 'e', 0,
72
73#define	STRING_MOUSE \
74  'M', 0, 'o', 0, 'u', 0, 's', 0, 'e', 0, ' ', 0, \
75  'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
76
77/* make the real string descriptors */
78
79USB_MAKE_STRING_DESC(STRING_MOUSE, string_mouse);
80USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product);
81
82/* prototypes */
83
84/* The following HID descriptor was dumped from a HP mouse. */
85
86static uint8_t mouse_hid_descriptor[] = {
87	0x05, 0x01, 0x09, 0x02, 0xa1, 0x01, 0x09, 0x01,
88	0xa1, 0x00, 0x05, 0x09, 0x19, 0x01, 0x29, 0x03,
89	0x15, 0x00, 0x25, 0x01, 0x95, 0x03, 0x75, 0x01,
90	0x81, 0x02, 0x95, 0x05, 0x81, 0x03, 0x05, 0x01,
91	0x09, 0x30, 0x09, 0x31, 0x09, 0x38, 0x15, 0x81,
92	0x25, 0x7f, 0x75, 0x08, 0x95, 0x03, 0x81, 0x06,
93	0xc0, 0xc0
94};
95
96static const struct usb_temp_packet_size mouse_intr_mps = {
97	.mps[USB_SPEED_LOW] = 8,
98	.mps[USB_SPEED_FULL] = 8,
99	.mps[USB_SPEED_HIGH] = 8,
100};
101
102static const struct usb_temp_interval mouse_intr_interval = {
103	.bInterval[USB_SPEED_LOW] = 2,		/* 2ms */
104	.bInterval[USB_SPEED_FULL] = 2,		/* 2ms */
105	.bInterval[USB_SPEED_HIGH] = 5,		/* 2ms */
106};
107
108static const struct usb_temp_endpoint_desc mouse_ep_0 = {
109	.ppRawDesc = NULL,		/* no raw descriptors */
110	.pPacketSize = &mouse_intr_mps,
111	.pIntervals = &mouse_intr_interval,
112	.bEndpointAddress = UE_DIR_IN,
113	.bmAttributes = UE_INTERRUPT,
114};
115
116static const struct usb_temp_endpoint_desc *mouse_endpoints[] = {
117	&mouse_ep_0,
118	NULL,
119};
120
121static const uint8_t mouse_raw_desc[] = {
122	0x09, 0x21, 0x10, 0x01, 0x00, 0x01, 0x22, sizeof(mouse_hid_descriptor),
123	0x00
124};
125
126static const void *mouse_iface_0_desc[] = {
127	mouse_raw_desc,
128	NULL,
129};
130
131static const struct usb_temp_interface_desc mouse_iface_0 = {
132	.ppRawDesc = mouse_iface_0_desc,
133	.ppEndpoints = mouse_endpoints,
134	.bInterfaceClass = 3,
135	.bInterfaceSubClass = 1,
136	.bInterfaceProtocol = 2,
137	.iInterface = INDEX_MOUSE,
138};
139
140static const struct usb_temp_interface_desc *mouse_interfaces[] = {
141	&mouse_iface_0,
142	NULL,
143};
144
145static const struct usb_temp_config_desc mouse_config_desc = {
146	.ppIfaceDesc = mouse_interfaces,
147	.bmAttributes = UC_BUS_POWERED,
148	.bMaxPower = 25,		/* 50 mA */
149	.iConfiguration = INDEX_PRODUCT,
150};
151
152static const struct usb_temp_config_desc *mouse_configs[] = {
153	&mouse_config_desc,
154	NULL,
155};
156
157static usb_temp_get_string_desc_t mouse_get_string_desc;
158static usb_temp_get_vendor_desc_t mouse_get_vendor_desc;
159
160const struct usb_temp_device_desc usb_template_mouse = {
161	.getStringDesc = &mouse_get_string_desc,
162	.getVendorDesc = &mouse_get_vendor_desc,
163	.ppConfigDesc = mouse_configs,
164	.idVendor = USB_TEMPLATE_VENDOR,
165	.idProduct = 0x00AE,
166	.bcdDevice = 0x0100,
167	.bDeviceClass = UDCLASS_COMM,
168	.bDeviceSubClass = 0,
169	.bDeviceProtocol = 0,
170	.iManufacturer = 0,
171	.iProduct = INDEX_PRODUCT,
172	.iSerialNumber = 0,
173};
174
175/*------------------------------------------------------------------------*
176 *      mouse_get_vendor_desc
177 *
178 * Return values:
179 * NULL: Failure. No such vendor descriptor.
180 * Else: Success. Pointer to vendor descriptor is returned.
181 *------------------------------------------------------------------------*/
182static const void *
183mouse_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
184{
185	if ((req->bmRequestType == 0x81) && (req->bRequest == 0x06) &&
186	    (req->wValue[0] == 0x00) && (req->wValue[1] == 0x22) &&
187	    (req->wIndex[1] == 0) && (req->wIndex[0] == 0)) {
188
189		*plen = sizeof(mouse_hid_descriptor);
190		return (mouse_hid_descriptor);
191	}
192	return (NULL);
193}
194
195/*------------------------------------------------------------------------*
196 *	mouse_get_string_desc
197 *
198 * Return values:
199 * NULL: Failure. No such string.
200 * Else: Success. Pointer to string descriptor is returned.
201 *------------------------------------------------------------------------*/
202static const void *
203mouse_get_string_desc(uint16_t lang_id, uint8_t string_index)
204{
205	static const void *ptr[INDEX_MAX] = {
206		[INDEX_LANG] = &usb_string_lang_en,
207		[INDEX_MOUSE] = &string_mouse,
208		[INDEX_PRODUCT] = &string_product,
209	};
210
211	if (string_index == 0) {
212		return (&usb_string_lang_en);
213	}
214	if (lang_id != 0x0409) {
215		return (NULL);
216	}
217	if (string_index < INDEX_MAX) {
218		return (ptr[string_index]);
219	}
220	return (NULL);
221}
222