source: mainline/uspace/lib/usbhid/src/hiddescriptor.c@ ee7e7c93

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since ee7e7c93 was ee7e7c93, checked in by Matej Klonfar <maklf@…>, 15 years ago

Bug fixes in report description construction
  • Property mode set to 100644
File size: 26.9 KB
Line 
1/*
2 * Copyright (c) 2011 Matej Klonfar
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 libusbhid
30 * @{
31 */
32/** @file
33 * HID report descriptor and report data parser implementation.
34 */
35#include <usb/hid/hidparser.h>
36#include <errno.h>
37#include <stdio.h>
38#include <malloc.h>
39#include <mem.h>
40#include <usb/debug.h>
41#include <assert.h>
42
43/*---------------------------------------------------------------------------*/
44/*
45 * Constants defining current parsing mode for correct parsing of the set of
46 * local tags (usage) enclosed in delimter tags.
47 */
48/**
49 * Second delimiter tag was read. The set of local items (usage) ended.
50 */
51#define OUTSIDE_DELIMITER_SET 0
52
53/**
54 * First delimiter tag was read. The set of local items (usage) started.
55 */
56#define START_DELIMITER_SET 1
57
58/**
59 * Parser is in the set of local items.
60 */
61#define INSIDE_DELIMITER_SET 2
62
63/*---------------------------------------------------------------------------*/
64
65/** The new report item flag. Used to determine when the item is completly
66 * configured and should be added to the report structure
67 */
68#define USB_HID_NEW_REPORT_ITEM 1
69
70/** No special action after the report descriptor tag is processed should be
71 * done
72 */
73#define USB_HID_NO_ACTION 2
74
75#define USB_HID_RESET_OFFSET 3
76
77/** Unknown tag was founded in report descriptor data*/
78#define USB_HID_UNKNOWN_TAG -99
79
80/*---------------------------------------------------------------------------*/
81/**
82 * Checks if given collection path is already present in report structure and
83 * inserts it if not.
84 *
85 * @param report Report structure
86 * @param cmp_path The collection path
87 * @return Pointer to the result collection path in report structure.
88 * @retval NULL If some error occurs
89 */
90usb_hid_report_path_t *usb_hid_report_path_try_insert(
91 usb_hid_report_t *report, usb_hid_report_path_t *cmp_path) {
92
93 link_t *path_it = report->collection_paths.prev->next;
94 usb_hid_report_path_t *path = NULL;
95
96 if((report == NULL) || (cmp_path == NULL)) {
97 return NULL;
98 }
99
100 while(path_it != &report->collection_paths) {
101 path = list_get_instance(path_it, usb_hid_report_path_t,
102 link);
103
104 if(usb_hid_report_compare_usage_path(path, cmp_path,
105 USB_HID_PATH_COMPARE_STRICT) == EOK){
106 break;
107 }
108 path_it = path_it->next;
109 }
110 if(path_it == &report->collection_paths) {
111 path = usb_hid_report_path_clone(cmp_path);
112 if(path == NULL) {
113 return NULL;
114 }
115 list_append(&path->link, &report->collection_paths);
116 report->collection_paths_count++;
117
118 return path;
119 }
120 else {
121 return list_get_instance(path_it, usb_hid_report_path_t,
122 link);
123 }
124}
125
126/*---------------------------------------------------------------------------*/
127/**
128 * Initialize the report descriptor parser structure
129 *
130 * @param parser Report descriptor parser structure
131 * @return Error code
132 * @retval EINVAL If no report structure was given
133 * @retval EOK If report structure was successfully initialized
134 */
135int usb_hid_report_init(usb_hid_report_t *report)
136{
137 if(report == NULL) {
138 return EINVAL;
139 }
140
141 memset(report, 0, sizeof(usb_hid_report_t));
142 list_initialize(&report->reports);
143 list_initialize(&report->collection_paths);
144
145 report->use_report_ids = 0;
146 return EOK;
147}
148
149/*---------------------------------------------------------------------------*/
150
151/**
152 *
153 *
154 * @param report Report structure in which the new report items should be
155 * stored
156 * @param report_item Current report descriptor's parsing state table
157 * @return Error code
158 * @retval EOK If all fields were successfully append to report
159 * @retval EINVAL If invalid parameters (NULL) was given
160 * @retval ENOMEM If there is no memmory to store new report description
161 *
162 */
163int usb_hid_report_append_fields(usb_hid_report_t *report,
164 usb_hid_report_item_t *report_item) {
165
166 usb_hid_report_field_t *field;
167 int i;
168
169 uint32_t *usages;
170 int usages_used=0;
171
172 if((report == NULL) || (report_item == NULL)) {
173 return EINVAL;
174 }
175
176 if(report_item->usages_count > 0){
177 usages = malloc(sizeof(int32_t) * report_item->usages_count);
178 memcpy(usages, report_item->usages, sizeof(int32_t) *
179 report_item->usages_count);
180 }
181 else {
182 usages = NULL;
183 }
184
185 usb_hid_report_path_t *path = report_item->usage_path;
186 for(i=0; i<report_item->count; i++){
187
188 field = malloc(sizeof(usb_hid_report_field_t));
189 if(field == NULL) {
190 return ENOMEM;
191 }
192
193 memset(field, 0, sizeof(usb_hid_report_field_t));
194 list_initialize(&field->link);
195
196 /* fill the attributes */
197 field->logical_minimum = report_item->logical_minimum;
198 field->logical_maximum = report_item->logical_maximum;
199 field->physical_minimum = report_item->physical_minimum;
200 field->physical_maximum = report_item->physical_maximum;
201
202 if(USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags) == 0){
203 /*
204 Store usage array. The Correct Usage Page and Usage is
205 depending on data in report and will be filled later
206 */
207 field->usage = 0;
208 field->usage_page = 0; //report_item->usage_page;
209
210 field->usages_count = report_item->usages_count;
211 field->usages = usages;
212 usages_used = 1;
213 }
214 else {
215
216 /* Fill the correct Usage and Usage Page */
217 int32_t usage;
218 if(i < report_item->usages_count) {
219 usage = report_item->usages[i];
220 }
221 else {
222 usage = report_item->usages[
223 report_item->usages_count- 1];
224 }
225
226 if(USB_HID_IS_EXTENDED_USAGE(usage)){
227 field->usage = USB_HID_EXTENDED_USAGE(usage);
228 field->usage_page =
229 USB_HID_EXTENDED_USAGE_PAGE(usage);
230 }
231 else {
232 // should not occur
233 field->usage = usage;
234 field->usage_page = report_item->usage_page;
235 }
236 }
237
238 usb_hid_report_set_last_item(path, USB_HID_TAG_CLASS_GLOBAL,
239 field->usage_page);
240 usb_hid_report_set_last_item(path, USB_HID_TAG_CLASS_LOCAL,
241 field->usage);
242
243 field->collection_path =
244 usb_hid_report_path_try_insert(report, path);
245
246 field->size = report_item->size;
247
248 if(report_item->type == USB_HID_REPORT_TYPE_INPUT) {
249 int offset = report_item->offset + report_item->size * i;
250 int field_offset = (offset/8)*8 + (offset/8 + 1) * 8 -
251 offset - report_item->size;
252 if(field_offset < 0) {
253 field->offset = 0;
254 }
255 else {
256 field->offset = field_offset;
257 }
258 }
259 else {
260 field->offset = report_item->offset + (i * report_item->size);
261 }
262
263
264 if(report->use_report_ids != 0) {
265 field->offset += 8;
266 report->use_report_ids = 1;
267 }
268
269 field->item_flags = report_item->item_flags;
270
271 /* find the right report list*/
272 usb_hid_report_description_t *report_des;
273 report_des = usb_hid_report_find_description(report,
274 report_item->id, report_item->type);
275
276 if(report_des == NULL){
277 report_des = malloc(
278 sizeof(usb_hid_report_description_t));
279 if(report_des == NULL) {
280 return ENOMEM;
281 }
282
283 memset(report_des, 0,
284 sizeof(usb_hid_report_description_t));
285
286 report_des->type = report_item->type;
287 report_des->report_id = report_item->id;
288 if(report_des->report_id != 0) {
289 /* set up the bit length by report_id field */
290 report_des->bit_length = 8;
291 }
292
293 list_initialize (&report_des->link);
294 list_initialize (&report_des->report_items);
295
296 list_append(&report_des->link, &report->reports);
297 report->report_count++;
298 }
299
300 /* append this field to the end of founded report list */
301 list_append (&field->link, &report_des->report_items);
302
303 /* update the sizes */
304 report_des->bit_length += field->size;
305 report_des->item_length++;
306
307 }
308
309 // free only when not used!!!
310 if(usages && usages_used == 0) {
311 free(usages);
312 }
313
314 return EOK;
315}
316/*---------------------------------------------------------------------------*/
317/**
318 * Finds description of report with given report_id and of given type in
319 * opaque report structure.
320 *
321 * @param report Opaque structure containing the parsed report descriptor
322 * @param report_id ReportId of report we are searching
323 * @param type Type of report we are searching
324 * @return Pointer to the particular report description
325 * @retval NULL If no description is founded
326 */
327usb_hid_report_description_t * usb_hid_report_find_description(
328 const usb_hid_report_t *report, uint8_t report_id,
329 usb_hid_report_type_t type) {
330
331 link_t *report_it = report->reports.next;
332 usb_hid_report_description_t *report_des = NULL;
333
334 while(report_it != &report->reports) {
335 report_des = list_get_instance(report_it,
336 usb_hid_report_description_t, link);
337
338 if((report_des->report_id == report_id) &&
339 (report_des->type == type)) {
340 return report_des;
341 }
342
343 report_it = report_it->next;
344 }
345
346 return NULL;
347}
348/*---------------------------------------------------------------------------*/
349
350/** Parse HID report descriptor.
351 *
352 * @param parser Opaque HID report parser structure.
353 * @param data Data describing the report.
354 * @return Error code.
355 * @retval ENOMEM If no more memmory is available
356 * @retval EINVAL If invalid data are founded
357 * @retval EOK If report descriptor is successfully parsed
358 */
359int usb_hid_parse_report_descriptor(usb_hid_report_t *report,
360 const uint8_t *data, size_t size)
361{
362 size_t i=0;
363 uint8_t tag=0;
364 uint8_t item_size=0;
365 int class=0;
366 int ret;
367 usb_hid_report_item_t *report_item=0;
368 usb_hid_report_item_t *new_report_item;
369 usb_hid_report_path_t *usage_path;
370
371 size_t offset_input=0;
372 size_t offset_output=0;
373 size_t offset_feature=0;
374
375 link_t stack;
376 list_initialize(&stack);
377
378 /* parser structure initialization*/
379 if(usb_hid_report_init(report) != EOK) {
380 return EINVAL;
381 }
382
383 /*report item initialization*/
384 if(!(report_item=malloc(sizeof(usb_hid_report_item_t)))){
385 return ENOMEM;
386 }
387 memset(report_item, 0, sizeof(usb_hid_report_item_t));
388 list_initialize(&(report_item->link));
389
390 /* usage path context initialization */
391 if(!(usage_path=usb_hid_report_path())){
392 return ENOMEM;
393 }
394 usb_hid_report_path_append_item(usage_path, 0, 0);
395
396 while(i<size){
397 if(!USB_HID_ITEM_IS_LONG(data[i])){
398
399 if((i+USB_HID_ITEM_SIZE(data[i]))>= size){
400 return EINVAL;
401 }
402
403 tag = USB_HID_ITEM_TAG(data[i]);
404 item_size = USB_HID_ITEM_SIZE(data[i]);
405 class = USB_HID_ITEM_TAG_CLASS(data[i]);
406
407 ret = usb_hid_report_parse_tag(tag,class,data+i+1,
408 item_size,report_item, usage_path);
409
410 switch(ret){
411 case USB_HID_NEW_REPORT_ITEM:
412 /* store report item to report and create the
413 * new one store current collection path
414 */
415 report_item->usage_path = usage_path;
416
417 usb_hid_report_path_set_report_id(
418 report_item->usage_path, report_item->id);
419
420 if(report_item->id != 0){
421 report->use_report_ids = 1;
422 }
423
424 switch(tag) {
425 case USB_HID_REPORT_TAG_INPUT:
426 report_item->type =
427 USB_HID_REPORT_TYPE_INPUT;
428
429 report_item->offset = offset_input;
430 offset_input += report_item->count *
431 report_item->size;
432 break;
433
434 case USB_HID_REPORT_TAG_OUTPUT:
435 report_item->type =
436 USB_HID_REPORT_TYPE_OUTPUT;
437
438 report_item->offset = offset_output;
439 offset_output += report_item->count *
440 report_item->size;
441 break;
442
443 case USB_HID_REPORT_TAG_FEATURE:
444 report_item->type =
445 USB_HID_REPORT_TYPE_FEATURE;
446
447 report_item->offset = offset_feature;
448 offset_feature += report_item->count *
449 report_item->size;
450 break;
451
452 default:
453 usb_log_debug2(
454 "\tjump over - tag %X\n", tag);
455 break;
456 }
457
458 /*
459 * append new fields to the report structure
460 */
461 usb_hid_report_append_fields(report,
462 report_item);
463
464 /* reset local items */
465 usb_hid_report_reset_local_items (report_item);
466 break;
467
468 case USB_HID_RESET_OFFSET:
469 offset_input = 0;
470 offset_output = 0;
471 offset_feature = 0;
472 usb_hid_report_path_set_report_id (usage_path,
473 report_item->id);
474 break;
475
476 case USB_HID_REPORT_TAG_PUSH:
477 // push current state to stack
478 new_report_item = usb_hid_report_item_clone(
479 report_item);
480
481 usb_hid_report_path_t *tmp_path =
482 usb_hid_report_path_clone(usage_path);
483
484 new_report_item->usage_path = tmp_path;
485
486 list_prepend (&new_report_item->link, &stack);
487 break;
488 case USB_HID_REPORT_TAG_POP:
489 // restore current state from stack
490 if(list_empty (&stack)) {
491 return EINVAL;
492 }
493 free(report_item);
494
495 report_item = list_get_instance(stack.next,
496 usb_hid_report_item_t, link);
497
498 usb_hid_report_usage_path_t *tmp_usage_path;
499 tmp_usage_path = list_get_instance(
500 report_item->usage_path->link.prev,
501 usb_hid_report_usage_path_t, link);
502
503 usb_hid_report_set_last_item(usage_path,
504 USB_HID_TAG_CLASS_GLOBAL, tmp_usage_path->usage_page);
505
506 usb_hid_report_set_last_item(usage_path,
507 USB_HID_TAG_CLASS_LOCAL, tmp_usage_path->usage);
508
509 usb_hid_report_path_free(report_item->usage_path);
510 list_initialize(&report_item->usage_path->link);
511 list_remove (stack.next);
512
513 break;
514
515 default:
516 // nothing special to do
517 break;
518 }
519
520 /* jump over the processed block */
521 i += 1 + USB_HID_ITEM_SIZE(data[i]);
522 }
523 else{
524 // TBD
525 i += 3 + USB_HID_ITEM_SIZE(data[i+1]);
526 }
527
528
529 }
530
531 return EOK;
532}
533
534/*---------------------------------------------------------------------------*/
535
536/**
537 * Parse one tag of the report descriptor
538 *
539 * @param Tag to parse
540 * @param Report descriptor buffer
541 * @param Size of data belongs to this tag
542 * @param Current report item structe
543 * @return Code of action to be done next
544 */
545int usb_hid_report_parse_tag(uint8_t tag, uint8_t class, const uint8_t *data,
546 size_t item_size, usb_hid_report_item_t *report_item,
547 usb_hid_report_path_t *usage_path) {
548
549 int ret;
550
551 switch(class){
552 case USB_HID_TAG_CLASS_MAIN:
553
554 if((ret=usb_hid_report_parse_main_tag(tag, data, item_size,
555 report_item, usage_path)) == EOK) {
556
557 return USB_HID_NEW_REPORT_ITEM;
558 }
559 else {
560 return ret;
561 }
562 break;
563
564 case USB_HID_TAG_CLASS_GLOBAL:
565 return usb_hid_report_parse_global_tag(tag, data, item_size,
566 report_item, usage_path);
567 break;
568
569 case USB_HID_TAG_CLASS_LOCAL:
570 return usb_hid_report_parse_local_tag(tag, data, item_size,
571 report_item, usage_path);
572 break;
573
574 default:
575 return USB_HID_NO_ACTION;
576 }
577}
578
579/**
580 * Parse main tags of report descriptor
581 *
582 * @param Tag identifier
583 * @param Data buffer
584 * @param Length of data buffer
585 * @param Current state table
586 * @return Error code
587 */
588
589int usb_hid_report_parse_main_tag(uint8_t tag, const uint8_t *data,
590 size_t item_size, usb_hid_report_item_t *report_item,
591 usb_hid_report_path_t *usage_path)
592{
593 usb_hid_report_usage_path_t *path_item;
594
595 switch(tag)
596 {
597 case USB_HID_REPORT_TAG_INPUT:
598 case USB_HID_REPORT_TAG_OUTPUT:
599 case USB_HID_REPORT_TAG_FEATURE:
600 report_item->item_flags = *data;
601 return EOK;
602 break;
603
604 case USB_HID_REPORT_TAG_COLLECTION:
605
606 /* store collection atributes */
607 path_item = list_get_instance(usage_path->head.prev,
608 usb_hid_report_usage_path_t, link);
609 path_item->flags = *data;
610
611 /* set last item */
612 usb_hid_report_set_last_item(usage_path,
613 USB_HID_TAG_CLASS_GLOBAL,
614 USB_HID_EXTENDED_USAGE_PAGE(report_item->usages[
615 report_item->usages_count-1]));
616
617 usb_hid_report_set_last_item(usage_path,
618 USB_HID_TAG_CLASS_LOCAL,
619 USB_HID_EXTENDED_USAGE(report_item->usages[
620 report_item->usages_count-1]));
621
622 /* append the new one which will be set by common usage/usage
623 * page */
624 usb_hid_report_path_append_item(usage_path,
625 report_item->usage_page,
626 report_item->usages[report_item->usages_count-1]);
627
628 usb_hid_report_reset_local_items (report_item);
629 return USB_HID_NO_ACTION;
630 break;
631
632 case USB_HID_REPORT_TAG_END_COLLECTION:
633 usb_hid_report_remove_last_item(usage_path);
634 return USB_HID_NO_ACTION;
635 break;
636
637 default:
638 return USB_HID_NO_ACTION;
639 }
640
641 return EOK;
642}
643
644/**
645 * Parse global tags of report descriptor
646 *
647 * @param Tag identifier
648 * @param Data buffer
649 * @param Length of data buffer
650 * @param Current state table
651 * @return Error code
652 */
653int usb_hid_report_parse_global_tag(uint8_t tag, const uint8_t *data,
654 size_t item_size, usb_hid_report_item_t *report_item,
655 usb_hid_report_path_t *usage_path) {
656
657 switch(tag)
658 {
659 case USB_HID_REPORT_TAG_USAGE_PAGE:
660 report_item->usage_page =
661 usb_hid_report_tag_data_uint32(data, item_size);
662 break;
663
664 case USB_HID_REPORT_TAG_LOGICAL_MINIMUM:
665 report_item->logical_minimum = USB_HID_UINT32_TO_INT32(
666 usb_hid_report_tag_data_uint32(data,item_size),
667 item_size * 8);
668 break;
669
670 case USB_HID_REPORT_TAG_LOGICAL_MAXIMUM:
671 report_item->logical_maximum = USB_HID_UINT32_TO_INT32(
672 usb_hid_report_tag_data_uint32(data,item_size),
673 item_size * 8);
674 break;
675
676 case USB_HID_REPORT_TAG_PHYSICAL_MINIMUM:
677 report_item->physical_minimum = USB_HID_UINT32_TO_INT32(
678 usb_hid_report_tag_data_uint32(data,item_size),
679 item_size * 8);
680 break;
681
682 case USB_HID_REPORT_TAG_PHYSICAL_MAXIMUM:
683 report_item->physical_maximum = USB_HID_UINT32_TO_INT32(
684 usb_hid_report_tag_data_uint32(data,item_size),
685 item_size * 8);
686 break;
687
688 case USB_HID_REPORT_TAG_UNIT_EXPONENT:
689 report_item->unit_exponent = usb_hid_report_tag_data_uint32(
690 data,item_size);
691 break;
692
693 case USB_HID_REPORT_TAG_UNIT:
694 report_item->unit = usb_hid_report_tag_data_uint32(
695 data,item_size);
696 break;
697
698 case USB_HID_REPORT_TAG_REPORT_SIZE:
699 report_item->size = usb_hid_report_tag_data_uint32(
700 data,item_size);
701 break;
702
703 case USB_HID_REPORT_TAG_REPORT_COUNT:
704 report_item->count = usb_hid_report_tag_data_uint32(
705 data,item_size);
706 break;
707
708 case USB_HID_REPORT_TAG_REPORT_ID:
709 report_item->id = usb_hid_report_tag_data_uint32(data,
710 item_size);
711 return USB_HID_RESET_OFFSET;
712 break;
713
714 case USB_HID_REPORT_TAG_PUSH:
715 case USB_HID_REPORT_TAG_POP:
716 /*
717 * stack operations are done in top level parsing
718 * function
719 */
720 return tag;
721 break;
722
723 default:
724 return USB_HID_NO_ACTION;
725 }
726
727 return EOK;
728}
729
730/**
731 * Parse local tags of report descriptor
732 *
733 * @param Tag identifier
734 * @param Data buffer
735 * @param Length of data buffer
736 * @param Current state table
737 * @return Error code
738 */
739int usb_hid_report_parse_local_tag(uint8_t tag, const uint8_t *data,
740 size_t item_size, usb_hid_report_item_t *report_item,
741 usb_hid_report_path_t *usage_path)
742{
743 int32_t extended_usage;
744
745 switch(tag) {
746 case USB_HID_REPORT_TAG_USAGE:
747 switch(report_item->in_delimiter) {
748 case INSIDE_DELIMITER_SET:
749 /* nothing to do
750 * we catch only the first one
751 */
752 break;
753
754 case START_DELIMITER_SET:
755 report_item->in_delimiter = INSIDE_DELIMITER_SET;
756 case OUTSIDE_DELIMITER_SET:
757 extended_usage = ((report_item->usage_page) << 16);
758 extended_usage += usb_hid_report_tag_data_uint32(
759 data,item_size);
760
761 report_item->usages[report_item->usages_count] =
762 extended_usage;
763
764 report_item->usages_count++;
765 break;
766 }
767 break;
768
769 case USB_HID_REPORT_TAG_USAGE_MINIMUM:
770 if (item_size == 3) {
771 // usage extended usages
772 report_item->extended_usage_page =
773 USB_HID_EXTENDED_USAGE_PAGE(
774 usb_hid_report_tag_data_uint32(data,item_size));
775
776
777 report_item->usage_minimum =
778 USB_HID_EXTENDED_USAGE(
779 usb_hid_report_tag_data_uint32(data,item_size));
780 }
781 else {
782 report_item->usage_minimum =
783 usb_hid_report_tag_data_uint32(data,item_size);
784 }
785 break;
786
787 case USB_HID_REPORT_TAG_USAGE_MAXIMUM:
788 if (item_size == 3) {
789 if(report_item->extended_usage_page !=
790 USB_HID_EXTENDED_USAGE_PAGE(
791 usb_hid_report_tag_data_uint32(data,item_size))) {
792
793 return EINVAL;
794 }
795
796 // usage extended usages
797 report_item->extended_usage_page =
798 USB_HID_EXTENDED_USAGE_PAGE(
799 usb_hid_report_tag_data_uint32(data,item_size));
800
801 report_item->usage_maximum =
802 USB_HID_EXTENDED_USAGE(
803 usb_hid_report_tag_data_uint32(data,item_size));
804 }
805 else {
806 report_item->usage_maximum =
807 usb_hid_report_tag_data_uint32(data,item_size);
808 }
809
810 // vlozit zaznamy do pole usages
811 int32_t i;
812 for(i = report_item->usage_minimum;
813 i <= report_item->usage_maximum; i++) {
814
815 if(report_item->extended_usage_page) {
816 report_item->usages[report_item->usages_count++] =
817 (report_item->extended_usage_page << 16) + i;
818 }
819 else {
820 report_item->usages[report_item->usages_count++] =
821 (report_item->usage_page << 16) + i;
822 }
823 }
824 report_item->extended_usage_page = 0;
825
826 break;
827
828 case USB_HID_REPORT_TAG_DESIGNATOR_INDEX:
829 report_item->designator_index =
830 usb_hid_report_tag_data_uint32(data,item_size);
831 break;
832
833 case USB_HID_REPORT_TAG_DESIGNATOR_MINIMUM:
834 report_item->designator_minimum =
835 usb_hid_report_tag_data_uint32(data,item_size);
836 break;
837
838 case USB_HID_REPORT_TAG_DESIGNATOR_MAXIMUM:
839 report_item->designator_maximum =
840 usb_hid_report_tag_data_uint32(data,item_size);
841 break;
842
843 case USB_HID_REPORT_TAG_STRING_INDEX:
844 report_item->string_index =
845 usb_hid_report_tag_data_uint32(data,item_size);
846 break;
847
848 case USB_HID_REPORT_TAG_STRING_MINIMUM:
849 report_item->string_minimum =
850 usb_hid_report_tag_data_uint32(data,item_size);
851 break;
852
853 case USB_HID_REPORT_TAG_STRING_MAXIMUM:
854 report_item->string_maximum =
855 usb_hid_report_tag_data_uint32(data,item_size);
856 break;
857
858 case USB_HID_REPORT_TAG_DELIMITER:
859 report_item->in_delimiter =
860 usb_hid_report_tag_data_uint32(data,item_size);
861 break;
862
863 default:
864 return USB_HID_NO_ACTION;
865 }
866
867 return EOK;
868}
869/*---------------------------------------------------------------------------*/
870
871/**
872 * Converts raw data to uint32 (thats the maximum length of short item data)
873 *
874 * @param Data buffer
875 * @param Size of buffer
876 * @return Converted int32 number
877 */
878uint32_t usb_hid_report_tag_data_uint32(const uint8_t *data, size_t size)
879{
880 unsigned int i;
881 uint32_t result;
882
883 result = 0;
884 for(i=0; i<size; i++) {
885 result = (result | (data[i]) << (i*8));
886 }
887
888 return result;
889}
890/*---------------------------------------------------------------------------*/
891
892/**
893 * Prints content of given list of report items.
894 *
895 * @param List of report items (usb_hid_report_item_t)
896 * @return void
897 */
898void usb_hid_descriptor_print_list(link_t *head)
899{
900 usb_hid_report_field_t *report_item;
901 link_t *item;
902
903
904 if(head == NULL || list_empty(head)) {
905 usb_log_debug("\tempty\n");
906 return;
907 }
908
909 for(item = head->next; item != head; item = item->next) {
910
911 report_item = list_get_instance(item, usb_hid_report_field_t,
912 link);
913
914 usb_log_debug("\t\tOFFSET: %X\n", report_item->offset);
915 usb_log_debug("\t\tSIZE: %zu\n", report_item->size);
916 usb_log_debug("\t\tLOGMIN: %d\n",
917 report_item->logical_minimum);
918 usb_log_debug("\t\tLOGMAX: %d\n",
919 report_item->logical_maximum);
920 usb_log_debug("\t\tPHYMIN: %d\n",
921 report_item->physical_minimum);
922 usb_log_debug("\t\tPHYMAX: %d\n",
923 report_item->physical_maximum);
924 usb_log_debug("\t\ttUSAGEMIN: %X\n",
925 report_item->usage_minimum);
926 usb_log_debug("\t\tUSAGEMAX: %X\n",
927 report_item->usage_maximum);
928 usb_log_debug("\t\tUSAGES COUNT: %zu\n",
929 report_item->usages_count);
930
931 usb_log_debug("\t\tVALUE: %X\n", report_item->value);
932 usb_log_debug("\t\ttUSAGE: %X\n", report_item->usage);
933 usb_log_debug("\t\tUSAGE PAGE: %X\n", report_item->usage_page);
934
935 usb_hid_print_usage_path(report_item->collection_path);
936
937 usb_log_debug("\n");
938
939 }
940
941}
942/*---------------------------------------------------------------------------*/
943
944/**
945 * Prints content of given report descriptor in human readable format.
946 *
947 * @param parser Parsed descriptor to print
948 * @return void
949 */
950void usb_hid_descriptor_print(usb_hid_report_t *report)
951{
952 if(report == NULL) {
953 return;
954 }
955
956 link_t *report_it = report->reports.next;
957 usb_hid_report_description_t *report_des;
958
959 while(report_it != &report->reports) {
960 report_des = list_get_instance(report_it,
961 usb_hid_report_description_t, link);
962 usb_log_debug("Report ID: %d\n", report_des->report_id);
963 usb_log_debug("\tType: %d\n", report_des->type);
964 usb_log_debug("\tLength: %zu\n", report_des->bit_length);
965 usb_log_debug("\tB Size: %zu\n",
966 usb_hid_report_byte_size(report,
967 report_des->report_id,
968 report_des->type));
969 usb_log_debug("\tItems: %zu\n", report_des->item_length);
970
971 usb_hid_descriptor_print_list(&report_des->report_items);
972
973 report_it = report_it->next;
974 }
975}
976/*---------------------------------------------------------------------------*/
977
978/**
979 * Releases whole linked list of report items
980 *
981 * @param head Head of list of report descriptor items (usb_hid_report_item_t)
982 * @return void
983 */
984void usb_hid_free_report_list(link_t *head)
985{
986 return;
987
988 usb_hid_report_item_t *report_item;
989 link_t *next;
990
991 if(head == NULL || list_empty(head)) {
992 return;
993 }
994
995 next = head->next;
996 while(next != head) {
997
998 report_item = list_get_instance(next, usb_hid_report_item_t, link);
999
1000 while(!list_empty(&report_item->usage_path->link)) {
1001 usb_hid_report_remove_last_item(report_item->usage_path);
1002 }
1003
1004
1005 next = next->next;
1006
1007 free(report_item);
1008 }
1009
1010 return;
1011
1012}
1013/*---------------------------------------------------------------------------*/
1014
1015/** Frees the HID report descriptor parser structure
1016 *
1017 * @param parser Opaque HID report parser structure
1018 * @return void
1019 */
1020void usb_hid_free_report(usb_hid_report_t *report)
1021{
1022 if(report == NULL){
1023 return;
1024 }
1025
1026 // free collection paths
1027 usb_hid_report_path_t *path;
1028 while(!list_empty(&report->collection_paths)) {
1029 path = list_get_instance(report->collection_paths.next,
1030 usb_hid_report_path_t, link);
1031
1032 usb_hid_report_path_free(path);
1033 }
1034
1035 // free report items
1036 usb_hid_report_description_t *report_des;
1037 usb_hid_report_field_t *field;
1038 while(!list_empty(&report->reports)) {
1039 report_des = list_get_instance(report->reports.next,
1040 usb_hid_report_description_t, link);
1041
1042 list_remove(&report_des->link);
1043
1044 while(!list_empty(&report_des->report_items)) {
1045 field = list_get_instance(
1046 report_des->report_items.next,
1047 usb_hid_report_field_t, link);
1048
1049 list_remove(&field->link);
1050
1051 free(field);
1052 }
1053
1054 free(report_des);
1055 }
1056
1057 return;
1058}
1059/*---------------------------------------------------------------------------*/
1060
1061/**
1062 * @}
1063 */
Note: See TracBrowser for help on using the repository browser.