blob: ef440e4723ee3b69ac3937041a00697f59461607 [file] [log] [blame]
wdenkaffae2b2002-08-17 09:36:01 +00001/*
2 * (C) Copyright 2001
3 * Denis Peter, MPL AG Switzerland
4 *
5 * Part of this source has been derived from the Linux USB
6 * project.
7 *
8 * See file CREDITS for list of people who contributed to this
9 * project.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of
14 * the License, or (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
24 * MA 02111-1307 USA
25 *
26 */
27#include <common.h>
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +020028#include <stdio_dev.h>
Christian Eggersc9182612008-05-21 22:12:00 +020029#include <asm/byteorder.h>
wdenkaffae2b2002-08-17 09:36:01 +000030
wdenkaffae2b2002-08-17 09:36:01 +000031#include <usb.h>
32
33#undef USB_KBD_DEBUG
34/*
Marek Vasut00b7d6e2011-10-10 05:34:25 +000035 * If overwrite_console returns 1, the stdin, stderr and stdout
wdenkaffae2b2002-08-17 09:36:01 +000036 * are switched to the serial port, else the settings in the
37 * environment are used
38 */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020039#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
Marek Vasut00b7d6e2011-10-10 05:34:25 +000040extern int overwrite_console(void);
wdenkaffae2b2002-08-17 09:36:01 +000041#else
Marek Vasut00b7d6e2011-10-10 05:34:25 +000042int overwrite_console(void)
wdenkaffae2b2002-08-17 09:36:01 +000043{
Marek Vasut00b7d6e2011-10-10 05:34:25 +000044 return 0;
wdenkaffae2b2002-08-17 09:36:01 +000045}
46#endif
47
Marek Vasut00b7d6e2011-10-10 05:34:25 +000048#ifdef USB_KBD_DEBUG
49#define USB_KBD_PRINTF(fmt, args...) printf(fmt, ##args)
wdenkaffae2b2002-08-17 09:36:01 +000050#else
Marek Vasut00b7d6e2011-10-10 05:34:25 +000051#define USB_KBD_PRINTF(fmt, args...)
wdenkaffae2b2002-08-17 09:36:01 +000052#endif
53
54
Marek Vasut00b7d6e2011-10-10 05:34:25 +000055#define REPEAT_RATE (40/4) /* 40msec -> 25cps */
56#define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */
wdenkaffae2b2002-08-17 09:36:01 +000057
58#define NUM_LOCK 0x53
Marek Vasut00b7d6e2011-10-10 05:34:25 +000059#define CAPS_LOCK 0x39
60#define SCROLL_LOCK 0x47
wdenkaffae2b2002-08-17 09:36:01 +000061
62
63/* Modifier bits */
64#define LEFT_CNTR 0
Marek Vasut00b7d6e2011-10-10 05:34:25 +000065#define LEFT_SHIFT 1
wdenkaffae2b2002-08-17 09:36:01 +000066#define LEFT_ALT 2
67#define LEFT_GUI 3
Marek Vasut00b7d6e2011-10-10 05:34:25 +000068#define RIGHT_CNTR 4
69#define RIGHT_SHIFT 5
wdenkaffae2b2002-08-17 09:36:01 +000070#define RIGHT_ALT 6
71#define RIGHT_GUI 7
72
Marek Vasut00b7d6e2011-10-10 05:34:25 +000073#define USB_KBD_BUFFER_LEN 0x20 /* size of the keyboardbuffer */
wdenkaffae2b2002-08-17 09:36:01 +000074
Marek Vasut00b7d6e2011-10-10 05:34:25 +000075static char usb_kbd_buffer[USB_KBD_BUFFER_LEN];
76static int usb_in_pointer;
77static int usb_out_pointer;
wdenkaffae2b2002-08-17 09:36:01 +000078
79unsigned char new[8];
80unsigned char old[8];
81int repeat_delay;
Marek Vasut00b7d6e2011-10-10 05:34:25 +000082#define DEVNAME "usbkbd"
83static unsigned char num_lock;
84static unsigned char caps_lock;
85static unsigned char scroll_lock;
86static unsigned char ctrl;
wdenkaffae2b2002-08-17 09:36:01 +000087
Marek Vasut00b7d6e2011-10-10 05:34:25 +000088static unsigned char leds __attribute__((aligned(0x4)));
wdenkaffae2b2002-08-17 09:36:01 +000089
90static unsigned char usb_kbd_numkey[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000091 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
92 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
93 '\\', '#', ';', '\'', '`', ',', '.', '/'
wdenkaffae2b2002-08-17 09:36:01 +000094};
95static unsigned char usb_kbd_numkey_shifted[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000096 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
97 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
98 '|', '~', ':', '"', '~', '<', '>', '?'
wdenkaffae2b2002-08-17 09:36:01 +000099};
100
Marek Vasut48c80732011-09-25 20:00:37 +0100101static int usb_kbd_irq_worker(struct usb_device *dev);
102
103/******************************************************************
104 * Interrupt polling
105 ******************************************************************/
106static inline void usb_kbd_poll_for_event(struct usb_device *dev)
107{
108#if defined(CONFIG_SYS_USB_EVENT_POLL)
109 usb_event_poll();
110 usb_kbd_irq_worker(dev);
111#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
112 struct usb_interface *iface;
113 iface = &dev->config.if_desc[0];
114 usb_get_report(dev, iface->desc.bInterfaceNumber,
115 1, 1, new, sizeof(new));
116 if (memcmp(old, new, sizeof(new)))
117 usb_kbd_irq_worker(dev);
118#endif
119}
120
wdenkaffae2b2002-08-17 09:36:01 +0000121/******************************************************************
122 * Queue handling
123 ******************************************************************/
124/* puts character in the queue and sets up the in and out pointer */
125static void usb_kbd_put_queue(char data)
126{
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000127 if ((usb_in_pointer+1) == USB_KBD_BUFFER_LEN) {
128 if (usb_out_pointer == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000129 return; /* buffer full */
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000130 else
131 usb_in_pointer = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000132 } else {
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000133 if ((usb_in_pointer+1) == usb_out_pointer)
wdenkaffae2b2002-08-17 09:36:01 +0000134 return; /* buffer full */
135 usb_in_pointer++;
136 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000137 usb_kbd_buffer[usb_in_pointer] = data;
wdenkaffae2b2002-08-17 09:36:01 +0000138 return;
139}
140
141/* test if a character is in the queue */
142static int usb_kbd_testc(void)
143{
Marek Vasut48c80732011-09-25 20:00:37 +0100144 struct stdio_dev *dev;
145 struct usb_device *usb_kbd_dev;
146
147 dev = stdio_get_by_name("usbkbd");
148 usb_kbd_dev = (struct usb_device *)dev->priv;
149
150 usb_kbd_poll_for_event(usb_kbd_dev);
151
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000152 if (usb_in_pointer == usb_out_pointer)
153 return 0; /* no data */
wdenkaffae2b2002-08-17 09:36:01 +0000154 else
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000155 return 1;
wdenkaffae2b2002-08-17 09:36:01 +0000156}
157/* gets the character from the queue */
158static int usb_kbd_getc(void)
159{
160 char c;
Marek Vasut48c80732011-09-25 20:00:37 +0100161
162 struct stdio_dev *dev;
163 struct usb_device *usb_kbd_dev;
164
165 dev = stdio_get_by_name("usbkbd");
166 usb_kbd_dev = (struct usb_device *)dev->priv;
167
168 while (usb_in_pointer == usb_out_pointer)
169 usb_kbd_poll_for_event(usb_kbd_dev);
170
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000171 if ((usb_out_pointer+1) == USB_KBD_BUFFER_LEN)
172 usb_out_pointer = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000173 else
174 usb_out_pointer++;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000175 c = usb_kbd_buffer[usb_out_pointer];
wdenkaffae2b2002-08-17 09:36:01 +0000176 return (int)c;
177
178}
179
180/* forward decleration */
181static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum);
182
183/* search for keyboard and register it if found */
184int drv_usb_kbd_init(void)
185{
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000186 int error, i;
187 struct stdio_dev usb_kbd_dev, *old_dev;
wdenkaffae2b2002-08-17 09:36:01 +0000188 struct usb_device *dev;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000189 char *stdinname = getenv("stdin");
wdenkaffae2b2002-08-17 09:36:01 +0000190
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000191 usb_in_pointer = 0;
192 usb_out_pointer = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000193 /* scan all USB Devices */
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000194 for (i = 0 ; i < USB_MAX_DEVICE ; i++) {
195 dev = usb_get_dev_index(i); /* get device */
196 if (dev == NULL)
Ryan CHEN3b20fd82008-08-20 13:00:17 -0400197 return -1;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000198 if (dev->devnum != -1) {
199 /* Ok, we found a keyboard */
200 if (usb_kbd_probe(dev, 0) == 1) {
wdenkaffae2b2002-08-17 09:36:01 +0000201 /* check, if it is already registered */
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000202 USB_KBD_PRINTF("USB KBD found set up "
203 "device.\n");
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +0200204 old_dev = stdio_get_by_name(DEVNAME);
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000205 if (old_dev) {
206 /* already registered, just return ok */
207 USB_KBD_PRINTF("USB KBD is already "
208 "registered.\n");
Jean-Christophe PLAGNIOL-VILLARDc1de7a62008-08-31 04:24:55 +0200209 return 1;
wdenkaffae2b2002-08-17 09:36:01 +0000210 }
211 /* register the keyboard */
212 USB_KBD_PRINTF("USB KBD register.\n");
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000213 memset(&usb_kbd_dev, 0,
214 sizeof(struct stdio_dev));
wdenkaffae2b2002-08-17 09:36:01 +0000215 strcpy(usb_kbd_dev.name, DEVNAME);
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000216 usb_kbd_dev.flags = DEV_FLAGS_INPUT |
217 DEV_FLAGS_SYSTEM;
wdenkaffae2b2002-08-17 09:36:01 +0000218 usb_kbd_dev.putc = NULL;
219 usb_kbd_dev.puts = NULL;
220 usb_kbd_dev.getc = usb_kbd_getc;
221 usb_kbd_dev.tstc = usb_kbd_testc;
Thomas Abraham1eb734f2009-01-04 12:15:35 +0530222 usb_kbd_dev.priv = (void *)dev;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000223 error = stdio_register(&usb_kbd_dev);
224 if (error == 0) {
225 /*
226 * check if this is the standard
227 * input device
228 */
229 if (strcmp(stdinname, DEVNAME) == 0) {
wdenkaffae2b2002-08-17 09:36:01 +0000230 /* reassign the console */
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000231 if (overwrite_console())
wdenkaffae2b2002-08-17 09:36:01 +0000232 return 1;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000233 error = console_assign(stdin,
234 DEVNAME);
235 if (error == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000236 return 1;
237 else
238 return error;
239 }
240 return 1;
241 }
242 return error;
243 }
244 }
245 }
246 /* no USB Keyboard found */
247 return -1;
248}
249
250
251/* deregistering the keyboard */
252int usb_kbd_deregister(void)
253{
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +0200254#ifdef CONFIG_SYS_STDIO_DEREGISTER
255 return stdio_deregister(DEVNAME);
Jean-Christophe PLAGNIOL-VILLARDfea91ed2008-12-02 21:58:04 +0100256#else
257 return 1;
258#endif
wdenkaffae2b2002-08-17 09:36:01 +0000259}
260
261/**************************************************************************
262 * Low Level drivers
263 */
264
265/* set the LEDs. Since this is used in the irq routine, the control job
266 is issued with a timeout of 0. This means, that the job is queued without
267 waiting for job completion */
268
269static void usb_kbd_setled(struct usb_device *dev)
270{
Tom Rix8f8bd562009-10-31 12:37:38 -0500271 struct usb_interface *iface;
wdenkaffae2b2002-08-17 09:36:01 +0000272 iface = &dev->config.if_desc[0];
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000273 leds = 0;
274 if (scroll_lock != 0)
275 leds |= 1;
276 leds <<= 1;
277 if (caps_lock != 0)
278 leds |= 1;
279 leds <<= 1;
280 if (num_lock != 0)
281 leds |= 1;
wdenkaffae2b2002-08-17 09:36:01 +0000282 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
283 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Tom Rix8f8bd562009-10-31 12:37:38 -0500284 0x200, iface->desc.bInterfaceNumber, (void *)&leds, 1, 0);
wdenkaffae2b2002-08-17 09:36:01 +0000285
286}
287
288
289#define CAPITAL_MASK 0x20
290/* Translate the scancode in ASCII */
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000291static int usb_kbd_translate(unsigned char scancode, unsigned char modifier,
292 int pressed)
wdenkaffae2b2002-08-17 09:36:01 +0000293{
294 unsigned char keycode;
295
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000296 if (pressed == 0) {
wdenkaffae2b2002-08-17 09:36:01 +0000297 /* key released */
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000298 repeat_delay = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000299 return 0;
300 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000301 if (pressed == 2) {
wdenkaffae2b2002-08-17 09:36:01 +0000302 repeat_delay++;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000303 if (repeat_delay < REPEAT_DELAY)
wdenkaffae2b2002-08-17 09:36:01 +0000304 return 0;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000305 repeat_delay = REPEAT_DELAY;
wdenkaffae2b2002-08-17 09:36:01 +0000306 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000307 keycode = 0;
308 if ((scancode > 3) && (scancode <= 0x1d)) { /* alpha numeric values */
309 keycode = scancode - 4 + 0x61;
310 if (caps_lock)
311 /* switch to capital Letters */
312 keycode &= ~CAPITAL_MASK;
313 if (((modifier&(1 << LEFT_SHIFT)) != 0) ||
314 ((modifier&(1 << RIGHT_SHIFT)) != 0)) {
315 if (keycode & CAPITAL_MASK)
316 /* switch to capital Letters */
317 keycode &= ~CAPITAL_MASK;
wdenkaffae2b2002-08-17 09:36:01 +0000318 else
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000319 /* switch to non capital Letters */
320 keycode |= CAPITAL_MASK;
wdenkaffae2b2002-08-17 09:36:01 +0000321 }
322 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000323 if ((scancode > 0x1d) && (scancode < 0x3A)) {
324 if (((modifier&(1 << LEFT_SHIFT)) != 0) ||
325 ((modifier&(1 << RIGHT_SHIFT)) != 0)) /* shifted */
326 keycode = usb_kbd_numkey_shifted[scancode-0x1e];
wdenkaffae2b2002-08-17 09:36:01 +0000327 else /* non shifted */
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000328 keycode = usb_kbd_numkey[scancode-0x1e];
wdenkaffae2b2002-08-17 09:36:01 +0000329 }
Zhang Wei4785a692008-01-03 10:51:15 +0800330
331 if (ctrl)
332 keycode = scancode - 0x3;
333
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000334 if (pressed == 1) {
335 if (scancode == NUM_LOCK) {
336 num_lock = ~num_lock;
wdenkaffae2b2002-08-17 09:36:01 +0000337 return 1;
338 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000339 if (scancode == CAPS_LOCK) {
340 caps_lock = ~caps_lock;
wdenkaffae2b2002-08-17 09:36:01 +0000341 return 1;
342 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000343 if (scancode == SCROLL_LOCK) {
344 scroll_lock = ~scroll_lock;
wdenkaffae2b2002-08-17 09:36:01 +0000345 return 1;
346 }
347 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000348 if (keycode != 0) {
349 USB_KBD_PRINTF("%c", keycode);
wdenkaffae2b2002-08-17 09:36:01 +0000350 usb_kbd_put_queue(keycode);
351 }
352 return 0;
353}
354
355/* Interrupt service routine */
Marek Vasut48c80732011-09-25 20:00:37 +0100356static int usb_kbd_irq_worker(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000357{
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000358 int i, res;
wdenkaffae2b2002-08-17 09:36:01 +0000359
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000360 res = 0;
Zhang Wei4785a692008-01-03 10:51:15 +0800361
362 switch (new[0]) {
363 case 0x0: /* No combo key pressed */
364 ctrl = 0;
365 break;
366 case 0x01: /* Left Ctrl pressed */
367 case 0x10: /* Right Ctrl pressed */
368 ctrl = 1;
369 break;
370 }
371
wdenkaffae2b2002-08-17 09:36:01 +0000372 for (i = 2; i < 8; i++) {
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000373 if (old[i] > 3 && memscan(&new[2], old[i], 6) == &new[8])
374 res |= usb_kbd_translate(old[i], new[0], 0);
375
376 if (new[i] > 3 && memscan(&old[2], new[i], 6) == &old[8])
377 res |= usb_kbd_translate(new[i], new[0], 1);
wdenkaffae2b2002-08-17 09:36:01 +0000378 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000379
380 if ((new[2] > 3) && (old[2] == new[2])) /* still pressed */
381 res |= usb_kbd_translate(new[2], new[0], 2);
382 if (res == 1)
wdenkaffae2b2002-08-17 09:36:01 +0000383 usb_kbd_setled(dev);
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000384
385 memcpy(&old[0], &new[0], 8);
386
wdenkaffae2b2002-08-17 09:36:01 +0000387 return 1; /* install IRQ Handler again */
388}
389
Marek Vasut48c80732011-09-25 20:00:37 +0100390static int usb_kbd_irq(struct usb_device *dev)
391{
392 if ((dev->irq_status != 0) || (dev->irq_act_len != 8)) {
393 USB_KBD_PRINTF("usb_keyboard Error %lX, len %d\n",
394 dev->irq_status, dev->irq_act_len);
395 return 1;
396 }
397
398 return usb_kbd_irq_worker(dev);
399}
400
wdenkaffae2b2002-08-17 09:36:01 +0000401/* probes the USB device dev for keyboard type */
402static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
403{
Tom Rix8f8bd562009-10-31 12:37:38 -0500404 struct usb_interface *iface;
wdenkaffae2b2002-08-17 09:36:01 +0000405 struct usb_endpoint_descriptor *ep;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000406 int pipe, maxp;
wdenkaffae2b2002-08-17 09:36:01 +0000407
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000408 if (dev->descriptor.bNumConfigurations != 1)
409 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000410 iface = &dev->config.if_desc[ifnum];
411
Tom Rix8f8bd562009-10-31 12:37:38 -0500412 if (iface->desc.bInterfaceClass != 3)
413 return 0;
414 if (iface->desc.bInterfaceSubClass != 1)
415 return 0;
416 if (iface->desc.bInterfaceProtocol != 1)
417 return 0;
418 if (iface->desc.bNumEndpoints != 1)
419 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000420
421 ep = &iface->ep_desc[0];
422
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000423 if (!(ep->bEndpointAddress & 0x80))
424 return 0;
425 if ((ep->bmAttributes & 3) != 3)
426 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000427 USB_KBD_PRINTF("USB KBD found set protocol...\n");
428 /* ok, we found a USB Keyboard, install it */
429 /* usb_kbd_get_hid_desc(dev); */
Tom Rix8f8bd562009-10-31 12:37:38 -0500430 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
wdenkaffae2b2002-08-17 09:36:01 +0000431 USB_KBD_PRINTF("USB KBD found set idle...\n");
Tom Rix8f8bd562009-10-31 12:37:38 -0500432 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);
wdenkaffae2b2002-08-17 09:36:01 +0000433 memset(&new[0], 0, 8);
434 memset(&old[0], 0, 8);
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000435 repeat_delay = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000436 pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
437 maxp = usb_maxpacket(dev, pipe);
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000438 dev->irq_handle = usb_kbd_irq;
wdenkaffae2b2002-08-17 09:36:01 +0000439 USB_KBD_PRINTF("USB KBD enable interrupt pipe...\n");
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000440 usb_submit_int_msg(dev, pipe, &new[0], maxp > 8 ? 8 : maxp,
441 ep->bInterval);
wdenkaffae2b2002-08-17 09:36:01 +0000442 return 1;
443}
444
445
446#if 0
447struct usb_hid_descriptor {
448 unsigned char bLength;
449 unsigned char bDescriptorType; /* 0x21 for HID */
450 unsigned short bcdHID; /* release number */
451 unsigned char bCountryCode;
452 unsigned char bNumDescriptors;
453 unsigned char bReportDescriptorType;
454 unsigned short wDescriptorLength;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000455} __packed;
wdenkaffae2b2002-08-17 09:36:01 +0000456
457/*
458 * We parse each description item into this structure. Short items data
459 * values are expanded to 32-bit signed int, long items contain a pointer
460 * into the data area.
461 */
462
463struct hid_item {
464 unsigned char format;
465 unsigned char size;
466 unsigned char type;
467 unsigned char tag;
468 union {
469 unsigned char u8;
470 char s8;
471 unsigned short u16;
472 short s16;
473 unsigned long u32;
474 long s32;
475 unsigned char *longdata;
476 } data;
477};
478
479/*
480 * HID report item format
481 */
482
483#define HID_ITEM_FORMAT_SHORT 0
484#define HID_ITEM_FORMAT_LONG 1
485
486/*
487 * Special tag indicating long items
488 */
489
490#define HID_ITEM_TAG_LONG 15
491
492
wdenkaffae2b2002-08-17 09:36:01 +0000493static struct usb_hid_descriptor usb_kbd_hid_desc;
494
495void usb_kbd_display_hid(struct usb_hid_descriptor *hid)
496{
497 printf("USB_HID_DESC:\n");
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000498 printf(" bLenght 0x%x\n", hid->bLength);
499 printf(" bcdHID 0x%x\n", hid->bcdHID);
500 printf(" bCountryCode %d\n", hid->bCountryCode);
501 printf(" bNumDescriptors 0x%x\n", hid->bNumDescriptors);
502 printf(" bReportDescriptorType 0x%x\n", hid->bReportDescriptorType);
503 printf(" wDescriptorLength 0x%x\n", hid->wDescriptorLength);
wdenkaffae2b2002-08-17 09:36:01 +0000504}
505
506
507/*
508 * Fetch a report description item from the data stream. We support long
509 * items, though they are not used yet.
510 */
511
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000512static int fetch_item(unsigned char *start, unsigned char *end,
513 struct hid_item *item)
wdenkaffae2b2002-08-17 09:36:01 +0000514{
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000515 if ((end - start) > 0) {
wdenkaffae2b2002-08-17 09:36:01 +0000516 unsigned char b = *start++;
517 item->type = (b >> 2) & 3;
518 item->tag = (b >> 4) & 15;
519 if (item->tag == HID_ITEM_TAG_LONG) {
520 item->format = HID_ITEM_FORMAT_LONG;
521 if ((end - start) >= 2) {
522 item->size = *start++;
523 item->tag = *start++;
524 if ((end - start) >= item->size) {
525 item->data.longdata = start;
526 start += item->size;
527 return item->size;
528 }
529 }
530 } else {
531 item->format = HID_ITEM_FORMAT_SHORT;
532 item->size = b & 3;
533 switch (item->size) {
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000534 case 0:
535 return item->size;
536 case 1:
537 if ((end - start) >= 1) {
538 item->data.u8 = *start++;
wdenkaffae2b2002-08-17 09:36:01 +0000539 return item->size;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000540 }
541 break;
542 case 2:
543 if ((end - start) >= 2) {
544 item->data.u16 = le16_to_cpu(
545 (unsigned short *)start);
546 start += 2;
547 return item->size;
548 }
549 case 3:
550 item->size++;
551 if ((end - start) >= 4) {
552 item->data.u32 = le32_to_cpu(
553 (unsigned long *)start);
554 start += 4;
555 return item->size;
556 }
wdenkaffae2b2002-08-17 09:36:01 +0000557 }
558 }
559 }
560 return -1;
561}
562
563/*
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000564 * HID report descriptor item type (prefix bit 2, 3)
wdenkaffae2b2002-08-17 09:36:01 +0000565 */
566
567#define HID_ITEM_TYPE_MAIN 0
568#define HID_ITEM_TYPE_GLOBAL 1
569#define HID_ITEM_TYPE_LOCAL 2
570#define HID_ITEM_TYPE_RESERVED 3
571/*
572 * HID report descriptor main item tags
573 */
574
575#define HID_MAIN_ITEM_TAG_INPUT 8
576#define HID_MAIN_ITEM_TAG_OUTPUT 9
577#define HID_MAIN_ITEM_TAG_FEATURE 11
578#define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
579#define HID_MAIN_ITEM_TAG_END_COLLECTION 12
580/*
581 * HID report descriptor main item contents
582 */
583
584#define HID_MAIN_ITEM_CONSTANT 0x001
585#define HID_MAIN_ITEM_VARIABLE 0x002
586#define HID_MAIN_ITEM_RELATIVE 0x004
587#define HID_MAIN_ITEM_WRAP 0x008
588#define HID_MAIN_ITEM_NONLINEAR 0x010
589#define HID_MAIN_ITEM_NO_PREFERRED 0x020
590#define HID_MAIN_ITEM_NULL_STATE 0x040
591#define HID_MAIN_ITEM_VOLATILE 0x080
592#define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
593
594/*
595 * HID report descriptor collection item types
596 */
597
598#define HID_COLLECTION_PHYSICAL 0
599#define HID_COLLECTION_APPLICATION 1
600#define HID_COLLECTION_LOGICAL 2
601/*
602 * HID report descriptor global item tags
603 */
604
605#define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
606#define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
607#define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
608#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
609#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
610#define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
611#define HID_GLOBAL_ITEM_TAG_UNIT 6
612#define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
613#define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
614#define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
615#define HID_GLOBAL_ITEM_TAG_PUSH 10
616#define HID_GLOBAL_ITEM_TAG_POP 11
617
618/*
619 * HID report descriptor local item tags
620 */
621
622#define HID_LOCAL_ITEM_TAG_USAGE 0
623#define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
624#define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
625#define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
626#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
627#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
628#define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
629#define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
630#define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
631#define HID_LOCAL_ITEM_TAG_DELIMITER 10
632
633
wdenkaffae2b2002-08-17 09:36:01 +0000634static void usb_kbd_show_item(struct hid_item *item)
635{
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000636 switch (item->type) {
637 case HID_ITEM_TYPE_MAIN:
638 switch (item->tag) {
639 case HID_MAIN_ITEM_TAG_INPUT:
640 printf("Main Input");
wdenkaffae2b2002-08-17 09:36:01 +0000641 break;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000642 case HID_MAIN_ITEM_TAG_OUTPUT:
643 printf("Main Output");
wdenkaffae2b2002-08-17 09:36:01 +0000644 break;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000645 case HID_MAIN_ITEM_TAG_FEATURE:
646 printf("Main Feature");
647 break;
648 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
649 printf("Main Begin Collection");
650 break;
651 case HID_MAIN_ITEM_TAG_END_COLLECTION:
652 printf("Main End Collection");
wdenkaffae2b2002-08-17 09:36:01 +0000653 break;
654 default:
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000655 printf("Main reserved %d", item->tag);
wdenkaffae2b2002-08-17 09:36:01 +0000656 break;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000657 }
658 break;
659 case HID_ITEM_TYPE_GLOBAL:
660 switch (item->tag) {
661 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
662 printf("- Global Usage Page");
663 break;
664 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
665 printf("- Global Logical Minimum");
666 break;
667 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
668 printf("- Global Logical Maximum");
669 break;
670 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
671 printf("- Global physical Minimum");
672 break;
673 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
674 printf("- Global physical Maximum");
675 break;
676 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
677 printf("- Global Unit Exponent");
678 break;
679 case HID_GLOBAL_ITEM_TAG_UNIT:
680 printf("- Global Unit");
681 break;
682 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
683 printf("- Global Report Size");
684 break;
685 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
686 printf("- Global Report ID");
687 break;
688 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
689 printf("- Global Report Count");
690 break;
691 case HID_GLOBAL_ITEM_TAG_PUSH:
692 printf("- Global Push");
693 break;
694 case HID_GLOBAL_ITEM_TAG_POP:
695 printf("- Global Pop");
696 break;
697 default:
698 printf("- Global reserved %d", item->tag);
699 break;
700 }
701 break;
702 case HID_ITEM_TYPE_LOCAL:
703 switch (item->tag) {
704 case HID_LOCAL_ITEM_TAG_USAGE:
705 printf("-- Local Usage");
706 break;
707 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
708 printf("-- Local Usage Minimum");
709 break;
710 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
711 printf("-- Local Usage Maximum");
712 break;
713 case HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX:
714 printf("-- Local Designator Index");
715 break;
716 case HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM:
717 printf("-- Local Designator Minimum");
718 break;
719 case HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM:
720 printf("-- Local Designator Maximum");
721 break;
722 case HID_LOCAL_ITEM_TAG_STRING_INDEX:
723 printf("-- Local String Index");
724 break;
725 case HID_LOCAL_ITEM_TAG_STRING_MINIMUM:
726 printf("-- Local String Minimum");
727 break;
728 case HID_LOCAL_ITEM_TAG_STRING_MAXIMUM:
729 printf("-- Local String Maximum");
730 break;
731 case HID_LOCAL_ITEM_TAG_DELIMITER:
732 printf("-- Local Delimiter");
733 break;
734 default:
735 printf("-- Local reserved %d", item->tag);
736 break;
737 }
738 break;
739 default:
740 printf("--- reserved %d", item->type);
741 break;
wdenkaffae2b2002-08-17 09:36:01 +0000742 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000743 switch (item->size) {
744 case 1:
745 printf(" %d", item->data.u8);
746 break;
747 case 2:
748 printf(" %d", item->data.u16);
749 break;
750 case 4:
751 printf(" %ld", item->data.u32);
752 break;
wdenkaffae2b2002-08-17 09:36:01 +0000753 }
754 printf("\n");
755}
756
757
wdenkaffae2b2002-08-17 09:36:01 +0000758static int usb_kbd_get_hid_desc(struct usb_device *dev)
759{
760 unsigned char buffer[256];
761 struct usb_descriptor_header *head;
762 struct usb_config_descriptor *config;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000763 int index, len, i;
wdenkaffae2b2002-08-17 09:36:01 +0000764 unsigned char *start, *end;
765 struct hid_item item;
766
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000767 if (usb_get_configuration_no(dev, &buffer[0], 0) == -1)
wdenkaffae2b2002-08-17 09:36:01 +0000768 return -1;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000769 head = (struct usb_descriptor_header *)&buffer[0];
770 if (head->bDescriptorType != USB_DT_CONFIG) {
771 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
772 head->bDescriptorType);
wdenkaffae2b2002-08-17 09:36:01 +0000773 return -1;
774 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000775 index = head->bLength;
776 config = (struct usb_config_descriptor *)&buffer[0];
777 len = le16_to_cpu(config->wTotalLength);
778 /*
779 * Ok the first entry must be a configuration entry,
780 * now process the others
781 */
782 head = (struct usb_descriptor_header *)&buffer[index];
783 while (index+1 < len) {
784 if (head->bDescriptorType == USB_DT_HID) {
wdenkaffae2b2002-08-17 09:36:01 +0000785 printf("HID desc found\n");
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000786 memcpy(&usb_kbd_hid_desc, &buffer[index],
787 buffer[index]);
Christian Eggersc9182612008-05-21 22:12:00 +0200788 le16_to_cpus(&usb_kbd_hid_desc.bcdHID);
789 le16_to_cpus(&usb_kbd_hid_desc.wDescriptorLength);
wdenkaffae2b2002-08-17 09:36:01 +0000790 usb_kbd_display_hid(&usb_kbd_hid_desc);
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000791 len = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000792 break;
793 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000794 index += head->bLength;
795 head = (struct usb_descriptor_header *)&buffer[index];
wdenkaffae2b2002-08-17 09:36:01 +0000796 }
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000797 if (len > 0)
wdenkaffae2b2002-08-17 09:36:01 +0000798 return -1;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000799 len = usb_kbd_hid_desc.wDescriptorLength;
800 index = usb_get_class_descriptor(dev, 0, USB_DT_REPORT, 0, &buffer[0],
801 len);
802 if (index < 0) {
wdenkaffae2b2002-08-17 09:36:01 +0000803 printf("reading report descriptor failed\n");
804 return -1;
805 }
806 printf(" report descriptor (size %u, read %d)\n", len, index);
Wolfgang Denkd0ff51b2008-07-14 15:19:07 +0200807 start = &buffer[0];
808 end = &buffer[len];
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000809 i = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000810 do {
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000811 index = fetch_item(start, end, &item);
812 i += index;
wdenkaffae2b2002-08-17 09:36:01 +0000813 i++;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000814 if (index >= 0)
wdenkaffae2b2002-08-17 09:36:01 +0000815 usb_kbd_show_item(&item);
816
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000817 start += index;
wdenkaffae2b2002-08-17 09:36:01 +0000818 start++;
Marek Vasut00b7d6e2011-10-10 05:34:25 +0000819 } while (index >= 0);
wdenkaffae2b2002-08-17 09:36:01 +0000820
821}
822
wdenkaffae2b2002-08-17 09:36:01 +0000823#endif