1 /* $FreeBSD$ */
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 Keyboard 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 
61 enum {
62 	INDEX_LANG,
63 	INDEX_KEYBOARD,
64 	INDEX_PRODUCT,
65 	INDEX_MAX,
66 };
67 
68 #define	STRING_PRODUCT \
69   "K\0e\0y\0b\0o\0a\0r\0d\0 \0T\0e\0s\0t\0 \0D\0e\0v\0i\0c\0e"
70 
71 #define	STRING_KEYBOARD \
72   "K\0e\0y\0b\0o\0a\0r\0d\0 \0i\0n\0t\0e\0r\0f\0a\0c\0e"
73 
74 /* make the real string descriptors */
75 
76 USB_MAKE_STRING_DESC(STRING_KEYBOARD, string_keyboard);
77 USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product);
78 
79 /* prototypes */
80 
81 static const struct usb_temp_packet_size keyboard_intr_mps = {
82 	.mps[USB_SPEED_LOW] = 16,
83 	.mps[USB_SPEED_FULL] = 16,
84 	.mps[USB_SPEED_HIGH] = 16,
85 };
86 
87 static const struct usb_temp_interval keyboard_intr_interval = {
88 	.bInterval[USB_SPEED_LOW] = 2,	/* 2 ms */
89 	.bInterval[USB_SPEED_FULL] = 2,	/* 2 ms */
90 	.bInterval[USB_SPEED_HIGH] = 5,	/* 2 ms */
91 };
92 
93 /* The following HID descriptor was dumped from a HP keyboard. */
94 
95 static uint8_t keyboard_hid_descriptor[] = {
96 	0x05, 0x01, 0x09, 0x06, 0xa1, 0x01, 0x05, 0x07,
97 	0x19, 0xe0, 0x29, 0xe7, 0x15, 0x00, 0x25, 0x01,
98 	0x75, 0x01, 0x95, 0x08, 0x81, 0x02, 0x95, 0x01,
99 	0x75, 0x08, 0x81, 0x01, 0x95, 0x03, 0x75, 0x01,
100 	0x05, 0x08, 0x19, 0x01, 0x29, 0x03, 0x91, 0x02,
101 	0x95, 0x05, 0x75, 0x01, 0x91, 0x01, 0x95, 0x06,
102 	0x75, 0x08, 0x15, 0x00, 0x26, 0xff, 0x00, 0x05,
103 	0x07, 0x19, 0x00, 0x2a, 0xff, 0x00, 0x81, 0x00,
104 	0xc0
105 };
106 
107 static const struct usb_temp_endpoint_desc keyboard_ep_0 = {
108 	.ppRawDesc = NULL,		/* no raw descriptors */
109 	.pPacketSize = &keyboard_intr_mps,
110 	.pIntervals = &keyboard_intr_interval,
111 	.bEndpointAddress = UE_DIR_IN,
112 	.bmAttributes = UE_INTERRUPT,
113 };
114 
115 static const struct usb_temp_endpoint_desc *keyboard_endpoints[] = {
116 	&keyboard_ep_0,
117 	NULL,
118 };
119 
120 static const uint8_t keyboard_raw_desc[] = {
121 	0x09, 0x21, 0x10, 0x01, 0x00, 0x01, 0x22, sizeof(keyboard_hid_descriptor),
122 	0x00
123 };
124 
125 static const void *keyboard_iface_0_desc[] = {
126 	keyboard_raw_desc,
127 	NULL,
128 };
129 
130 static const struct usb_temp_interface_desc keyboard_iface_0 = {
131 	.ppRawDesc = keyboard_iface_0_desc,
132 	.ppEndpoints = keyboard_endpoints,
133 	.bInterfaceClass = 3,
134 	.bInterfaceSubClass = 1,
135 	.bInterfaceProtocol = 1,
136 	.iInterface = INDEX_KEYBOARD,
137 };
138 
139 static const struct usb_temp_interface_desc *keyboard_interfaces[] = {
140 	&keyboard_iface_0,
141 	NULL,
142 };
143 
144 static const struct usb_temp_config_desc keyboard_config_desc = {
145 	.ppIfaceDesc = keyboard_interfaces,
146 	.bmAttributes = UC_BUS_POWERED,
147 	.bMaxPower = 25,		/* 50 mA */
148 	.iConfiguration = INDEX_PRODUCT,
149 };
150 
151 static const struct usb_temp_config_desc *keyboard_configs[] = {
152 	&keyboard_config_desc,
153 	NULL,
154 };
155 
156 static usb_temp_get_string_desc_t keyboard_get_string_desc;
157 static usb_temp_get_vendor_desc_t keyboard_get_vendor_desc;
158 
159 const struct usb_temp_device_desc usb_template_kbd = {
160 	.getStringDesc = &keyboard_get_string_desc,
161 	.getVendorDesc = &keyboard_get_vendor_desc,
162 	.ppConfigDesc = keyboard_configs,
163 	.idVendor = USB_TEMPLATE_VENDOR,
164 	.idProduct = 0x00CB,
165 	.bcdDevice = 0x0100,
166 	.bDeviceClass = UDCLASS_COMM,
167 	.bDeviceSubClass = 0,
168 	.bDeviceProtocol = 0,
169 	.iManufacturer = 0,
170 	.iProduct = INDEX_PRODUCT,
171 	.iSerialNumber = 0,
172 };
173 
174 /*------------------------------------------------------------------------*
175  *      keyboard_get_vendor_desc
176  *
177  * Return values:
178  * NULL: Failure. No such vendor descriptor.
179  * Else: Success. Pointer to vendor descriptor is returned.
180  *------------------------------------------------------------------------*/
181 static const void *
182 keyboard_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
183 {
184 	if ((req->bmRequestType == 0x81) && (req->bRequest == 0x06) &&
185 	    (req->wValue[0] == 0x00) && (req->wValue[1] == 0x22) &&
186 	    (req->wIndex[1] == 0) && (req->wIndex[0] == 0)) {
187 
188 		*plen = sizeof(keyboard_hid_descriptor);
189 		return (keyboard_hid_descriptor);
190 	}
191 	return (NULL);
192 }
193 
194 /*------------------------------------------------------------------------*
195  *	keyboard_get_string_desc
196  *
197  * Return values:
198  * NULL: Failure. No such string.
199  * Else: Success. Pointer to string descriptor is returned.
200  *------------------------------------------------------------------------*/
201 static const void *
202 keyboard_get_string_desc(uint16_t lang_id, uint8_t string_index)
203 {
204 	static const void *ptr[INDEX_MAX] = {
205 		[INDEX_LANG] = &usb_string_lang_en,
206 		[INDEX_KEYBOARD] = &string_keyboard,
207 		[INDEX_PRODUCT] = &string_product,
208 	};
209 
210 	if (string_index == 0) {
211 		return (&usb_string_lang_en);
212 	}
213 	if (lang_id != 0x0409) {
214 		return (NULL);
215 	}
216 	if (string_index < INDEX_MAX) {
217 		return (ptr[string_index]);
218 	}
219 	return (NULL);
220 }
221