source: mainline/uspace/drv/usbhid/usbhid.c@ 4939490

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 4939490 was d09f3720, checked in by Lubos Slovak <lubos.slovak@…>, 14 years ago

Development changes.
  • Property mode set to 100644
File size: 17.8 KB
Line 
1/*
2 * Copyright (c) 2011 Lubos Slovak
3 * 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 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup drvusbhid
30 * @{
31 */
32/**
33 * @file
34 * USB HID driver API.
35 */
36
37#include <usb/debug.h>
38#include <usb/classes/classes.h>
39#include <usb/hid/hid.h>
40#include <usb/hid/hidparser.h>
41#include <usb/hid/hidreport.h>
42#include <usb/hid/request.h>
43#include <errno.h>
44#include <str_error.h>
45
46#include "usbhid.h"
47
48#include "kbd/kbddev.h"
49#include "generic/hiddev.h"
50#include "mouse/mousedev.h"
51#include "subdrivers.h"
52
53/*----------------------------------------------------------------------------*/
54
55/* Array of endpoints expected on the device, NULL terminated. */
56usb_endpoint_description_t *usb_hid_endpoints[USB_HID_POLL_EP_COUNT + 1] = {
57 &usb_hid_kbd_poll_endpoint_description,
58 &usb_hid_mouse_poll_endpoint_description,
59 &usb_hid_generic_poll_endpoint_description,
60 NULL
61};
62
63static const int USB_HID_MAX_SUBDRIVERS = 10;
64
65static fibril_local bool report_received;
66
67/*----------------------------------------------------------------------------*/
68
69static int usb_hid_set_boot_kbd_subdriver(usb_hid_dev_t *hid_dev)
70{
71 assert(hid_dev != NULL && hid_dev->subdriver_count == 0);
72
73 hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc(
74 sizeof(usb_hid_subdriver_t));
75 if (hid_dev->subdrivers == NULL) {
76 return ENOMEM;
77 }
78
79 // set the init callback
80 hid_dev->subdrivers[0].init = usb_kbd_init;
81
82 // set the polling callback
83 hid_dev->subdrivers[0].poll = usb_kbd_polling_callback;
84
85 // set the polling ended callback
86 hid_dev->subdrivers[0].poll_end = NULL;
87
88 // set the deinit callback
89 hid_dev->subdrivers[0].deinit = usb_kbd_deinit;
90
91 // set subdriver count
92 hid_dev->subdriver_count = 1;
93
94 return EOK;
95}
96
97/*----------------------------------------------------------------------------*/
98
99static int usb_hid_set_boot_mouse_subdriver(usb_hid_dev_t *hid_dev)
100{
101 assert(hid_dev != NULL && hid_dev->subdriver_count == 0);
102
103 hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc(
104 sizeof(usb_hid_subdriver_t));
105 if (hid_dev->subdrivers == NULL) {
106 return ENOMEM;
107 }
108
109 // set the init callback
110 hid_dev->subdrivers[0].init = usb_mouse_init;
111
112 // set the polling callback
113 hid_dev->subdrivers[0].poll = usb_mouse_polling_callback;
114
115 // set the polling ended callback
116 hid_dev->subdrivers[0].poll_end = NULL;
117
118 // set the deinit callback
119 hid_dev->subdrivers[0].deinit = usb_mouse_deinit;
120
121 // set subdriver count
122 hid_dev->subdriver_count = 1;
123
124 return EOK;
125}
126
127/*----------------------------------------------------------------------------*/
128
129static int usb_hid_set_generic_hid_subdriver(usb_hid_dev_t *hid_dev)
130{
131 assert(hid_dev != NULL && hid_dev->subdriver_count == 0);
132
133 hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc(
134 sizeof(usb_hid_subdriver_t));
135 if (hid_dev->subdrivers == NULL) {
136 return ENOMEM;
137 }
138
139 // set the init callback
140 hid_dev->subdrivers[0].init = usb_generic_hid_init;
141
142 // set the polling callback
143 hid_dev->subdrivers[0].poll = usb_generic_hid_polling_callback;
144
145 // set the polling ended callback
146 hid_dev->subdrivers[0].poll_end = NULL;
147
148 // set the deinit callback
149 hid_dev->subdrivers[0].deinit = NULL;
150
151 // set subdriver count
152 hid_dev->subdriver_count = 1;
153
154 return EOK;
155}
156
157/*----------------------------------------------------------------------------*/
158
159static bool usb_hid_ids_match(usb_hid_dev_t *hid_dev,
160 const usb_hid_subdriver_mapping_t *mapping)
161{
162 assert(hid_dev != NULL);
163 assert(hid_dev->usb_dev != NULL);
164
165 return (hid_dev->usb_dev->descriptors.device.vendor_id
166 == mapping->vendor_id
167 && hid_dev->usb_dev->descriptors.device.product_id
168 == mapping->product_id);
169}
170
171/*----------------------------------------------------------------------------*/
172
173static bool usb_hid_path_matches(usb_hid_dev_t *hid_dev,
174 const usb_hid_subdriver_mapping_t *mapping)
175{
176 assert(hid_dev != NULL);
177 assert(mapping != NULL);
178
179 usb_hid_report_path_t *usage_path = usb_hid_report_path();
180 if (usage_path == NULL) {
181 usb_log_debug("Failed to create usage path.\n");
182 return false;
183 }
184 int i = 0;
185 while (mapping->usage_path[i].usage != 0
186 || mapping->usage_path[i].usage_page != 0) {
187 if (usb_hid_report_path_append_item(usage_path,
188 mapping->usage_path[i].usage_page,
189 mapping->usage_path[i].usage) != EOK) {
190 usb_log_debug("Failed to append to usage path.\n");
191 usb_hid_report_path_free(usage_path);
192 return false;
193 }
194 ++i;
195 }
196
197 if (mapping->report_id >= 0) {
198 usb_hid_report_path_set_report_id(usage_path,
199 mapping->report_id);
200 }
201
202 assert(hid_dev->report != NULL);
203
204 usb_log_debug("Compare flags: %d\n", mapping->compare);
205// size_t size = usb_hid_report_size(hid_dev->report, 0,
206// USB_HID_REPORT_TYPE_INPUT);
207 size_t size = 0;
208 usb_hid_report_field_t *field = usb_hid_report_get_sibling (hid_dev->report,
209 NULL, usage_path, mapping->compare, USB_HID_REPORT_TYPE_INPUT);
210 while(field != NULL) {
211 size++;
212 field = usb_hid_report_get_sibling (hid_dev->report,
213 field, usage_path, mapping->compare,
214 USB_HID_REPORT_TYPE_INPUT);
215 }
216
217 usb_log_debug("Size of the input report: %zuB\n", size);
218 usb_hid_report_path_free(usage_path);
219
220 return (size > 0);
221}
222
223/*----------------------------------------------------------------------------*/
224
225static int usb_hid_save_subdrivers(usb_hid_dev_t *hid_dev,
226 const usb_hid_subdriver_t **subdrivers, int count)
227{
228 int i;
229
230 if (count <= 0) {
231 hid_dev->subdriver_count = 0;
232 hid_dev->subdrivers = NULL;
233 return EOK;
234 }
235
236 // add one generic HID subdriver per device
237
238 hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc((count + 1) *
239 sizeof(usb_hid_subdriver_t));
240 if (hid_dev->subdrivers == NULL) {
241 return ENOMEM;
242 }
243
244 for (i = 0; i < count; ++i) {
245 hid_dev->subdrivers[i].init = subdrivers[i]->init;
246 hid_dev->subdrivers[i].deinit = subdrivers[i]->deinit;
247 hid_dev->subdrivers[i].poll = subdrivers[i]->poll;
248 hid_dev->subdrivers[i].poll_end = subdrivers[i]->poll_end;
249 }
250
251 hid_dev->subdrivers[count].init = usb_generic_hid_init;
252 hid_dev->subdrivers[count].poll = usb_generic_hid_polling_callback;
253 hid_dev->subdrivers[count].deinit = NULL;
254 hid_dev->subdrivers[count].poll_end = NULL;
255
256 hid_dev->subdriver_count = count + 1;
257
258 return EOK;
259}
260
261/*----------------------------------------------------------------------------*/
262
263static int usb_hid_find_subdrivers(usb_hid_dev_t *hid_dev)
264{
265 assert(hid_dev != NULL);
266
267 const usb_hid_subdriver_t *subdrivers[USB_HID_MAX_SUBDRIVERS];
268
269 int i = 0, count = 0;
270 const usb_hid_subdriver_mapping_t *mapping = &usb_hid_subdrivers[i];
271
272 bool ids_matched;
273 bool matched;
274
275 while (count < USB_HID_MAX_SUBDRIVERS &&
276 (mapping->usage_path != NULL
277 || mapping->vendor_id >= 0 || mapping->product_id >= 0)) {
278 // check the vendor & product ID
279 if (mapping->vendor_id >= 0 && mapping->product_id < 0) {
280 usb_log_warning("Missing Product ID for Vendor ID %d\n",
281 mapping->vendor_id);
282 return EINVAL;
283 }
284 if (mapping->product_id >= 0 && mapping->vendor_id < 0) {
285 usb_log_warning("Missing Vendor ID for Product ID %d\n",
286 mapping->product_id);
287 return EINVAL;
288 }
289
290 ids_matched = false;
291 matched = false;
292
293 if (mapping->vendor_id >= 0) {
294 assert(mapping->product_id >= 0);
295 usb_log_debug("Comparing device against vendor ID %u"
296 " and product ID %u.\n", mapping->vendor_id,
297 mapping->product_id);
298 if (usb_hid_ids_match(hid_dev, mapping)) {
299 usb_log_debug("IDs matched.\n");
300 ids_matched = true;
301 }
302 }
303
304 if (mapping->usage_path != NULL) {
305 usb_log_debug("Comparing device against usage path.\n");
306 if (usb_hid_path_matches(hid_dev, mapping)) {
307 // does not matter if IDs were matched
308 matched = true;
309 }
310 } else {
311 // matched only if IDs were matched and there is no path
312 matched = ids_matched;
313 }
314
315 if (matched) {
316 subdrivers[count++] = &mapping->subdriver;
317 }
318
319 mapping = &usb_hid_subdrivers[++i];
320 }
321
322 // we have all subdrivers determined, save them into the hid device
323 return usb_hid_save_subdrivers(hid_dev, subdrivers, count);
324}
325
326/*----------------------------------------------------------------------------*/
327
328static int usb_hid_check_pipes(usb_hid_dev_t *hid_dev, usb_device_t *dev)
329{
330 assert(hid_dev != NULL && dev != NULL);
331
332 int rc = EOK;
333
334 if (dev->pipes[USB_HID_KBD_POLL_EP_NO].present) {
335 usb_log_debug("Found keyboard endpoint.\n");
336 // save the pipe index
337 hid_dev->poll_pipe_index = USB_HID_KBD_POLL_EP_NO;
338 } else if (dev->pipes[USB_HID_MOUSE_POLL_EP_NO].present) {
339 usb_log_debug("Found mouse endpoint.\n");
340 // save the pipe index
341 hid_dev->poll_pipe_index = USB_HID_MOUSE_POLL_EP_NO;
342 } else if (dev->pipes[USB_HID_GENERIC_POLL_EP_NO].present) {
343 usb_log_debug("Found generic HID endpoint.\n");
344 // save the pipe index
345 hid_dev->poll_pipe_index = USB_HID_GENERIC_POLL_EP_NO;
346 } else {
347 usb_log_error("None of supported endpoints found - probably"
348 " not a supported device.\n");
349 rc = ENOTSUP;
350 }
351
352 return rc;
353}
354
355/*----------------------------------------------------------------------------*/
356
357usb_hid_dev_t *usb_hid_new(void)
358{
359 usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)calloc(1,
360 sizeof(usb_hid_dev_t));
361
362 if (hid_dev == NULL) {
363 usb_log_fatal("No memory!\n");
364 return NULL;
365 }
366
367 hid_dev->report = (usb_hid_report_t *)(malloc(sizeof(
368 usb_hid_report_t)));
369 if (hid_dev->report == NULL) {
370 usb_log_fatal("No memory!\n");
371 free(hid_dev);
372 return NULL;
373 }
374
375 hid_dev->poll_pipe_index = -1;
376
377 return hid_dev;
378}
379
380/*----------------------------------------------------------------------------*/
381
382int usb_hid_init(usb_hid_dev_t *hid_dev, usb_device_t *dev)
383{
384 int rc, i;
385
386 usb_log_debug("Initializing HID structure...\n");
387
388 if (hid_dev == NULL) {
389 usb_log_error("Failed to init HID structure: no structure given"
390 ".\n");
391 return EINVAL;
392 }
393
394 if (dev == NULL) {
395 usb_log_error("Failed to init HID structure: no USB device"
396 " given.\n");
397 return EINVAL;
398 }
399
400 /* The USB device should already be initialized, save it in structure */
401 hid_dev->usb_dev = dev;
402
403 rc = usb_hid_check_pipes(hid_dev, dev);
404 if (rc != EOK) {
405 //usb_hid_free(&hid_dev);
406 return rc;
407 }
408
409 /* Get the report descriptor and parse it. */
410 rc = usb_hid_process_report_descriptor(hid_dev->usb_dev,
411 hid_dev->report);
412
413 bool fallback = false;
414
415 if (rc == EOK) {
416 // try to find subdrivers that may want to handle this device
417 rc = usb_hid_find_subdrivers(hid_dev);
418 if (rc != EOK || hid_dev->subdriver_count == 0) {
419 // try to fall back to the boot protocol if available
420 usb_log_info("No subdrivers found to handle this"
421 " device.\n");
422 fallback = true;
423 assert(hid_dev->subdrivers == NULL);
424 assert(hid_dev->subdriver_count == 0);
425 }
426 } else {
427 usb_log_error("Failed to parse Report descriptor.\n");
428 // try to fall back to the boot protocol if available
429 fallback = true;
430 }
431
432 if (fallback) {
433 // fall back to boot protocol
434 switch (hid_dev->poll_pipe_index) {
435 case USB_HID_KBD_POLL_EP_NO:
436 usb_log_info("Falling back to kbd boot protocol.\n");
437 rc = usb_kbd_set_boot_protocol(hid_dev);
438 if (rc == EOK) {
439 rc = usb_hid_set_boot_kbd_subdriver(hid_dev);
440 }
441 break;
442 case USB_HID_MOUSE_POLL_EP_NO:
443 usb_log_info("Falling back to mouse boot protocol.\n");
444 rc = usb_mouse_set_boot_protocol(hid_dev);
445 if (rc == EOK) {
446 rc = usb_hid_set_boot_mouse_subdriver(hid_dev);
447 }
448 break;
449 default:
450 assert(hid_dev->poll_pipe_index
451 == USB_HID_GENERIC_POLL_EP_NO);
452
453 /* TODO: this has no meaning if the report descriptor
454 is not parsed */
455 usb_log_info("Falling back to generic HID driver.\n");
456 rc = usb_hid_set_generic_hid_subdriver(hid_dev);
457 }
458 }
459
460 if (rc != EOK) {
461 usb_log_error("No subdriver for handling this device could be"
462 " initialized: %s.\n", str_error(rc));
463 usb_log_debug("Subdriver count: %d\n",
464 hid_dev->subdriver_count);
465 //usb_hid_free(&hid_dev);
466 } else {
467 bool ok = false;
468
469 usb_log_debug("Subdriver count: %d\n",
470 hid_dev->subdriver_count);
471
472 for (i = 0; i < hid_dev->subdriver_count; ++i) {
473 if (hid_dev->subdrivers[i].init != NULL) {
474 usb_log_debug("Initializing subdriver %d.\n",i);
475 rc = hid_dev->subdrivers[i].init(hid_dev,
476 &hid_dev->subdrivers[i].data);
477 if (rc != EOK) {
478 usb_log_warning("Failed to initialize"
479 " HID subdriver structure.\n");
480 } else {
481 // at least one subdriver initialized
482 ok = true;
483 }
484 } else {
485 ok = true;
486 }
487 }
488
489 rc = (ok) ? EOK : -1; // what error to report
490 }
491
492 return rc;
493}
494
495/*----------------------------------------------------------------------------*/
496
497bool usb_hid_polling_callback(usb_device_t *dev, uint8_t *buffer,
498 size_t buffer_size, void *arg)
499{
500 int i;
501
502 if (dev == NULL || arg == NULL || buffer == NULL) {
503 usb_log_error("Missing arguments to polling callback.\n");
504 return false;
505 }
506
507 usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)arg;
508
509 int allocated = (hid_dev->input_report != NULL);
510
511 if (!allocated
512 || hid_dev->input_report_size < buffer_size) {
513 uint8_t *input_old = hid_dev->input_report;
514 uint8_t *input_new = (uint8_t *)malloc(buffer_size);
515
516 if (input_new == NULL) {
517 usb_log_error("Failed to allocate space for input "
518 "buffer. This event may not be reported\n");
519 memset(hid_dev->input_report, 0,
520 hid_dev->input_report_size);
521 } else {
522 memcpy(input_new, input_old,
523 hid_dev->input_report_size);
524 hid_dev->input_report = input_new;
525 if (allocated) {
526 free(input_old);
527 }
528 usb_hid_new_report();
529 }
530 }
531
532 /*! @todo This should probably be atomic. */
533 memcpy(hid_dev->input_report, buffer, buffer_size);
534 hid_dev->input_report_size = buffer_size;
535
536 bool cont = false;
537
538 // continue if at least one of the subdrivers want to continue
539 for (i = 0; i < hid_dev->subdriver_count; ++i) {
540 if (hid_dev->subdrivers[i].poll != NULL
541 && hid_dev->subdrivers[i].poll(hid_dev,
542 hid_dev->subdrivers[i].data, buffer, buffer_size)) {
543 cont = true;
544 }
545 }
546
547 return cont;
548}
549
550/*----------------------------------------------------------------------------*/
551
552void usb_hid_polling_ended_callback(usb_device_t *dev, bool reason,
553 void *arg)
554{
555 int i;
556
557 if (dev == NULL || arg == NULL) {
558 return;
559 }
560
561 usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)arg;
562
563 for (i = 0; i < hid_dev->subdriver_count; ++i) {
564 if (hid_dev->subdrivers[i].poll_end != NULL) {
565 hid_dev->subdrivers[i].poll_end(hid_dev,
566 hid_dev->subdrivers[i].data, reason);
567 }
568 }
569
570 usb_hid_free(&hid_dev);
571}
572
573/*----------------------------------------------------------------------------*/
574
575//const char *usb_hid_get_function_name(const usb_hid_dev_t *hid_dev)
576//{
577// switch (hid_dev->poll_pipe_index) {
578// case USB_HID_KBD_POLL_EP_NO:
579// return HID_KBD_FUN_NAME;
580// break;
581// case USB_HID_MOUSE_POLL_EP_NO:
582// return HID_MOUSE_FUN_NAME;
583// break;
584// default:
585// return HID_GENERIC_FUN_NAME;
586// }
587//}
588
589/*----------------------------------------------------------------------------*/
590
591//const char *usb_hid_get_class_name(const usb_hid_dev_t *hid_dev)
592//{
593// // this means that only boot protocol keyboards will be connected
594// // to the console; there is probably no better way to do this
595
596// switch (hid_dev->poll_pipe_index) {
597// case USB_HID_KBD_POLL_EP_NO:
598// return HID_KBD_CLASS_NAME;
599// break;
600// case USB_HID_MOUSE_POLL_EP_NO:
601// return HID_MOUSE_CLASS_NAME;
602// break;
603// default:
604// return HID_GENERIC_CLASS_NAME;
605// }
606//}
607
608/*----------------------------------------------------------------------------*/
609
610void usb_hid_new_report(void)
611{
612 report_received = false;
613}
614
615/*----------------------------------------------------------------------------*/
616
617void usb_hid_report_received(void)
618{
619 report_received = true;
620}
621
622/*----------------------------------------------------------------------------*/
623
624bool usb_hid_report_ready(void)
625{
626 return !report_received;
627}
628
629/*----------------------------------------------------------------------------*/
630
631void usb_hid_free(usb_hid_dev_t **hid_dev)
632{
633 int i;
634
635 if (hid_dev == NULL || *hid_dev == NULL) {
636 return;
637 }
638
639 usb_log_debug("Subdrivers: %p, subdriver count: %d\n",
640 (*hid_dev)->subdrivers, (*hid_dev)->subdriver_count);
641
642 assert((*hid_dev)->subdrivers != NULL
643 || (*hid_dev)->subdriver_count == 0);
644
645 for (i = 0; i < (*hid_dev)->subdriver_count; ++i) {
646 if ((*hid_dev)->subdrivers[i].deinit != NULL) {
647 (*hid_dev)->subdrivers[i].deinit(*hid_dev,
648 (*hid_dev)->subdrivers[i].data);
649 }
650 }
651
652 // free the subdrivers info
653 if ((*hid_dev)->subdrivers != NULL) {
654 free((*hid_dev)->subdrivers);
655 }
656
657 // destroy the parser
658 if ((*hid_dev)->report != NULL) {
659 usb_hid_free_report((*hid_dev)->report);
660 }
661
662 if ((*hid_dev)->report_desc != NULL) {
663 free((*hid_dev)->report_desc);
664 }
665
666 free(*hid_dev);
667 *hid_dev = NULL;
668}
669
670/**
671 * @}
672 */
Note: See TracBrowser for help on using the repository browser.