source: mainline/uspace/lib/usb/src/hidparser.c@ dc4c19e

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since dc4c19e was 64dbc83, checked in by Matej Klonfar <maklf@…>, 14 years ago
  • Report ID implementation
  • Push and Pop report descriptor instructions

both need testing
  • Property mode set to 100644
File size: 35.0 KB
Line 
1/*
2 * Copyright (c) 2010 Vojtech Horky
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 libusb
30 * @{
31 */
32/** @file
33 * HID report descriptor and report data parser implementation.
34 */
35#include <usb/classes/hidparser.h>
36#include <errno.h>
37#include <stdio.h>
38#include <malloc.h>
39#include <mem.h>
40#include <usb/debug.h>
41
42/** */
43#define USB_HID_NEW_REPORT_ITEM 1
44
45/** */
46#define USB_HID_NO_ACTION 2
47
48/** */
49#define USB_HID_UNKNOWN_TAG -99
50
51/*
52 * Private descriptor parser functions
53 */
54int usb_hid_report_parse_tag(uint8_t tag, uint8_t class, const uint8_t *data, size_t item_size,
55 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path);
56int usb_hid_report_parse_main_tag(uint8_t tag, const uint8_t *data, size_t item_size,
57 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path);
58int usb_hid_report_parse_global_tag(uint8_t tag, const uint8_t *data, size_t item_size,
59 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path);
60int usb_hid_report_parse_local_tag(uint8_t tag, const uint8_t *data, size_t item_size,
61 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path);
62
63void usb_hid_descriptor_print_list(link_t *head);
64int usb_hid_report_reset_local_items();
65void usb_hid_free_report_list(link_t *head);
66usb_hid_report_item_t *usb_hid_report_item_clone(const usb_hid_report_item_t *item);
67/*
68 * Data translation private functions
69 */
70int32_t usb_hid_report_tag_data_int32(const uint8_t *data, size_t size);
71inline size_t usb_hid_count_item_offset(usb_hid_report_item_t * report_item, size_t offset);
72int usb_hid_translate_data(usb_hid_report_item_t *item, const uint8_t *data, size_t j);
73int32_t usb_hid_translate_data_reverse(usb_hid_report_item_t *item, int32_t value);
74int usb_pow(int a, int b);
75
76// TODO: tohle ma bejt asi jinde
77int usb_pow(int a, int b)
78{
79 switch(b) {
80 case 0:
81 return 1;
82 break;
83 case 1:
84 return a;
85 break;
86 default:
87 return a * usb_pow(a, b-1);
88 break;
89 }
90}
91
92/**
93 * Initialize the report descriptor parser structure
94 *
95 * @param parser Report descriptor parser structure
96 * @return Error code
97 */
98int usb_hid_parser_init(usb_hid_report_parser_t *parser)
99{
100 if(parser == NULL) {
101 return EINVAL;
102 }
103
104 list_initialize(&(parser->input));
105 list_initialize(&(parser->output));
106 list_initialize(&(parser->feature));
107
108 list_initialize(&(parser->stack));
109
110 parser->use_report_id = 0;
111 return EOK;
112}
113
114
115/** Parse HID report descriptor.
116 *
117 * @param parser Opaque HID report parser structure.
118 * @param data Data describing the report.
119 * @return Error code.
120 */
121int usb_hid_parse_report_descriptor(usb_hid_report_parser_t *parser,
122 const uint8_t *data, size_t size)
123{
124 size_t i=0;
125 uint8_t tag=0;
126 uint8_t item_size=0;
127 int class=0;
128 int ret;
129 usb_hid_report_item_t *report_item=0;
130 usb_hid_report_item_t *new_report_item;
131 usb_hid_report_path_t *usage_path;
132 usb_hid_report_path_t *tmp_usage_path;
133
134 size_t offset_input=0;
135 size_t offset_output=0;
136 size_t offset_feature=0;
137
138
139 /* parser structure initialization*/
140 if(usb_hid_parser_init(parser) != EOK) {
141 return EINVAL;
142 }
143
144
145 /*report item initialization*/
146 if(!(report_item=malloc(sizeof(usb_hid_report_item_t)))){
147 return ENOMEM;
148 }
149 memset(report_item, 0, sizeof(usb_hid_report_item_t));
150 list_initialize(&(report_item->link));
151
152 /* usage path context initialization */
153 if(!(usage_path=usb_hid_report_path())){
154 return ENOMEM;
155 }
156
157 while(i<size){
158 if(!USB_HID_ITEM_IS_LONG(data[i])){
159
160 if((i+USB_HID_ITEM_SIZE(data[i]))>= size){
161 return EINVAL; // TODO ERROR CODE
162 }
163
164 tag = USB_HID_ITEM_TAG(data[i]);
165 item_size = USB_HID_ITEM_SIZE(data[i]);
166 class = USB_HID_ITEM_TAG_CLASS(data[i]);
167
168 usb_log_debug2(
169 "i(%u) data(%X) value(%X): TAG %u, class %u, size %u - ", i,
170 data[i], usb_hid_report_tag_data_int32(data+i+1,item_size),
171 tag, class, item_size);
172
173 ret = usb_hid_report_parse_tag(tag,class,data+i+1,
174 item_size,report_item, usage_path);
175 usb_log_debug2("ret: %u\n", ret);
176 switch(ret){
177 case USB_HID_NEW_REPORT_ITEM:
178 // store report item to report and create the new one
179 usb_log_debug("\nNEW REPORT ITEM: %X",ret);
180
181 // store current usage path
182 report_item->usage_path = usage_path;
183
184 // clone path to the new one
185 tmp_usage_path = usb_hid_report_path_clone(usage_path);
186
187 // swap
188 usage_path = tmp_usage_path;
189 tmp_usage_path = NULL;
190
191 usb_hid_report_path_set_report_id(report_item->usage_path, report_item->id);
192 if(report_item->id != 0){
193 parser->use_report_id = 1;
194 }
195
196 switch(tag) {
197 case USB_HID_REPORT_TAG_INPUT:
198 report_item->offset = offset_input;
199 offset_input += report_item->count * report_item->size;
200 usb_log_debug(" - INPUT\n");
201 list_append(&(report_item->link), &(parser->input));
202 break;
203 case USB_HID_REPORT_TAG_OUTPUT:
204 report_item->offset = offset_output;
205 offset_output += report_item->count * report_item->size;
206 usb_log_debug(" - OUTPUT\n");
207 list_append(&(report_item->link), &(parser->output));
208
209 break;
210 case USB_HID_REPORT_TAG_FEATURE:
211 report_item->offset = offset_feature;
212 offset_feature += report_item->count * report_item->size;
213 usb_log_debug(" - FEATURE\n");
214 list_append(&(report_item->link), &(parser->feature));
215 break;
216 default:
217 usb_log_debug("\tjump over - tag %X\n", tag);
218 break;
219 }
220
221 /* clone current state table to the new item */
222 if(!(new_report_item = malloc(sizeof(usb_hid_report_item_t)))) {
223 return ENOMEM;
224 }
225 memcpy(new_report_item,report_item, sizeof(usb_hid_report_item_t));
226 link_initialize(&(new_report_item->link));
227
228 /* reset local items */
229 new_report_item->usage_minimum = 0;
230 new_report_item->usage_maximum = 0;
231 new_report_item->designator_index = 0;
232 new_report_item->designator_minimum = 0;
233 new_report_item->designator_maximum = 0;
234 new_report_item->string_index = 0;
235 new_report_item->string_minimum = 0;
236 new_report_item->string_maximum = 0;
237
238 /* reset usage from current usage path */
239 usb_hid_report_usage_path_t *path = list_get_instance(&usage_path->link, usb_hid_report_usage_path_t, link);
240 path->usage = 0;
241
242 report_item = new_report_item;
243
244 break;
245 case USB_HID_REPORT_TAG_PUSH:
246 // push current state to stack
247 new_report_item = usb_hid_report_item_clone(report_item);
248 list_prepend (&parser->stack, &new_report_item->link);
249
250 break;
251 case USB_HID_REPORT_TAG_POP:
252 // restore current state from stack
253 if(list_empty (&parser->stack)) {
254 return EINVAL;
255 }
256
257 report_item = list_get_instance(&parser->stack, usb_hid_report_item_t, link);
258 list_remove (parser->stack.next);
259
260 break;
261
262 default:
263 // nothing special to do
264 break;
265 }
266
267 /* jump over the processed block */
268 i += 1 + USB_HID_ITEM_SIZE(data[i]);
269 }
270 else{
271 // TBD
272 i += 3 + USB_HID_ITEM_SIZE(data[i+1]);
273 }
274
275
276 }
277
278 return EOK;
279}
280
281
282/**
283 * Parse input report.
284 *
285 * @param data Data for report
286 * @param size Size of report
287 * @param callbacks Callbacks for report actions
288 * @param arg Custom arguments
289 *
290 * @return Error code
291 */
292int usb_hid_boot_keyboard_input_report(const uint8_t *data, size_t size,
293 const usb_hid_report_in_callbacks_t *callbacks, void *arg)
294{
295 int i;
296 usb_hid_report_item_t item;
297
298 /* fill item due to the boot protocol report descriptor */
299 // modifier keys are in the first byte
300 uint8_t modifiers = data[0];
301
302 item.offset = 2; /* second byte is reserved */
303 item.size = 8;
304 item.count = 6;
305 item.usage_minimum = 0;
306 item.usage_maximum = 255;
307 item.logical_minimum = 0;
308 item.logical_maximum = 255;
309
310 if (size != 8) {
311 return -1; //ERANGE;
312 }
313
314 uint8_t keys[6];
315 for (i = 0; i < item.count; i++) {
316 keys[i] = data[i + item.offset];
317 }
318
319 callbacks->keyboard(keys, 6, modifiers, arg);
320 return EOK;
321}
322
323/**
324 * Makes output report for keyboard boot protocol
325 *
326 * @param leds
327 * @param output Output report data buffer
328 * @param size Size of the output buffer
329 * @return Error code
330 */
331int usb_hid_boot_keyboard_output_report(uint8_t leds, uint8_t *data, size_t size)
332{
333 if(size != 1){
334 return -1;
335 }
336
337 /* used only first five bits, others are only padding*/
338 *data = leds;
339 return EOK;
340}
341
342/**
343 * Parse one tag of the report descriptor
344 *
345 * @param Tag to parse
346 * @param Report descriptor buffer
347 * @param Size of data belongs to this tag
348 * @param Current report item structe
349 * @return Code of action to be done next
350 */
351int usb_hid_report_parse_tag(uint8_t tag, uint8_t class, const uint8_t *data, size_t item_size,
352 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path)
353{
354 int ret;
355
356 switch(class){
357 case USB_HID_TAG_CLASS_MAIN:
358
359 if((ret=usb_hid_report_parse_main_tag(tag,data,item_size,report_item, usage_path)) == EOK) {
360 return USB_HID_NEW_REPORT_ITEM;
361 }
362 else {
363 /*TODO process the error */
364 return ret;
365 }
366 break;
367
368 case USB_HID_TAG_CLASS_GLOBAL:
369 return usb_hid_report_parse_global_tag(tag,data,item_size,report_item, usage_path);
370 break;
371
372 case USB_HID_TAG_CLASS_LOCAL:
373 return usb_hid_report_parse_local_tag(tag,data,item_size,report_item, usage_path);
374 break;
375 default:
376 return USB_HID_NO_ACTION;
377 }
378}
379
380/**
381 * Parse main tags of report descriptor
382 *
383 * @param Tag identifier
384 * @param Data buffer
385 * @param Length of data buffer
386 * @param Current state table
387 * @return Error code
388 */
389
390int usb_hid_report_parse_main_tag(uint8_t tag, const uint8_t *data, size_t item_size,
391 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path)
392{
393 switch(tag)
394 {
395 case USB_HID_REPORT_TAG_INPUT:
396 case USB_HID_REPORT_TAG_OUTPUT:
397 case USB_HID_REPORT_TAG_FEATURE:
398 report_item->item_flags = *data;
399 return EOK;
400 break;
401
402 case USB_HID_REPORT_TAG_COLLECTION:
403 usb_hid_report_path_append_item(usage_path, 0, 0);
404
405 return USB_HID_NO_ACTION;
406 break;
407
408 case USB_HID_REPORT_TAG_END_COLLECTION:
409 // TODO
410 // znici posledni uroven ve vsech usage paths
411 // otazka jestli nema nicit dve, respektive novou posledni vynulovat?
412 usb_hid_report_remove_last_item(usage_path);
413 return USB_HID_NO_ACTION;
414 break;
415 default:
416 return USB_HID_NO_ACTION;
417 }
418
419 return EOK;
420}
421
422/**
423 * Parse global tags of report descriptor
424 *
425 * @param Tag identifier
426 * @param Data buffer
427 * @param Length of data buffer
428 * @param Current state table
429 * @return Error code
430 */
431int usb_hid_report_parse_global_tag(uint8_t tag, const uint8_t *data, size_t item_size,
432 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path)
433{
434 // TODO take care about the bit length of data
435 switch(tag)
436 {
437 case USB_HID_REPORT_TAG_USAGE_PAGE:
438 // zmeni to jenom v poslednim poli aktualni usage path
439 usb_hid_report_set_last_item(usage_path, USB_HID_TAG_CLASS_GLOBAL,
440 usb_hid_report_tag_data_int32(data,item_size));
441 break;
442 case USB_HID_REPORT_TAG_LOGICAL_MINIMUM:
443 report_item->logical_minimum = usb_hid_report_tag_data_int32(data,item_size);
444 break;
445 case USB_HID_REPORT_TAG_LOGICAL_MAXIMUM:
446 report_item->logical_maximum = usb_hid_report_tag_data_int32(data,item_size);
447 break;
448 case USB_HID_REPORT_TAG_PHYSICAL_MINIMUM:
449 report_item->physical_minimum = usb_hid_report_tag_data_int32(data,item_size);
450 break;
451 case USB_HID_REPORT_TAG_PHYSICAL_MAXIMUM:
452 report_item->physical_maximum = usb_hid_report_tag_data_int32(data,item_size);
453 break;
454 case USB_HID_REPORT_TAG_UNIT_EXPONENT:
455 report_item->unit_exponent = usb_hid_report_tag_data_int32(data,item_size);
456 break;
457 case USB_HID_REPORT_TAG_UNIT:
458 report_item->unit = usb_hid_report_tag_data_int32(data,item_size);
459 break;
460 case USB_HID_REPORT_TAG_REPORT_SIZE:
461 report_item->size = usb_hid_report_tag_data_int32(data,item_size);
462 break;
463 case USB_HID_REPORT_TAG_REPORT_COUNT:
464 report_item->count = usb_hid_report_tag_data_int32(data,item_size);
465 break;
466 case USB_HID_REPORT_TAG_REPORT_ID:
467 report_item->id = usb_hid_report_tag_data_int32(data,item_size);
468 break;
469 case USB_HID_REPORT_TAG_PUSH:
470 case USB_HID_REPORT_TAG_POP:
471 return tag;
472 break;
473
474 default:
475 return USB_HID_NO_ACTION;
476 }
477
478 return EOK;
479}
480
481/**
482 * Parse local tags of report descriptor
483 *
484 * @param Tag identifier
485 * @param Data buffer
486 * @param Length of data buffer
487 * @param Current state table
488 * @return Error code
489 */
490int usb_hid_report_parse_local_tag(uint8_t tag, const uint8_t *data, size_t item_size,
491 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path)
492{
493 switch(tag)
494 {
495 case USB_HID_REPORT_TAG_USAGE:
496 usb_hid_report_set_last_item(usage_path, USB_HID_TAG_CLASS_LOCAL,
497 usb_hid_report_tag_data_int32(data,item_size));
498 break;
499 case USB_HID_REPORT_TAG_USAGE_MINIMUM:
500 report_item->usage_minimum = usb_hid_report_tag_data_int32(data,item_size);
501 break;
502 case USB_HID_REPORT_TAG_USAGE_MAXIMUM:
503 report_item->usage_maximum = usb_hid_report_tag_data_int32(data,item_size);
504 break;
505 case USB_HID_REPORT_TAG_DESIGNATOR_INDEX:
506 report_item->designator_index = usb_hid_report_tag_data_int32(data,item_size);
507 break;
508 case USB_HID_REPORT_TAG_DESIGNATOR_MINIMUM:
509 report_item->designator_minimum = usb_hid_report_tag_data_int32(data,item_size);
510 break;
511 case USB_HID_REPORT_TAG_DESIGNATOR_MAXIMUM:
512 report_item->designator_maximum = usb_hid_report_tag_data_int32(data,item_size);
513 break;
514 case USB_HID_REPORT_TAG_STRING_INDEX:
515 report_item->string_index = usb_hid_report_tag_data_int32(data,item_size);
516 break;
517 case USB_HID_REPORT_TAG_STRING_MINIMUM:
518 report_item->string_minimum = usb_hid_report_tag_data_int32(data,item_size);
519 break;
520 case USB_HID_REPORT_TAG_STRING_MAXIMUM:
521 report_item->string_maximum = usb_hid_report_tag_data_int32(data,item_size);
522 break;
523 case USB_HID_REPORT_TAG_DELIMITER:
524 report_item->delimiter = usb_hid_report_tag_data_int32(data,item_size);
525 break;
526
527 default:
528 return USB_HID_NO_ACTION;
529 }
530
531 return EOK;
532}
533
534/**
535 * Converts raw data to int32 (thats the maximum length of short item data)
536 *
537 * @param Data buffer
538 * @param Size of buffer
539 * @return Converted int32 number
540 */
541int32_t usb_hid_report_tag_data_int32(const uint8_t *data, size_t size)
542{
543 unsigned int i;
544 int32_t result;
545
546 result = 0;
547 for(i=0; i<size; i++) {
548 result = (result | (data[i]) << (i*8));
549 }
550
551 return result;
552}
553
554
555
556/**
557 * Prints content of given list of report items.
558 *
559 * @param List of report items (usb_hid_report_item_t)
560 * @return void
561 */
562void usb_hid_descriptor_print_list(link_t *head)
563{
564 usb_hid_report_item_t *report_item;
565 usb_hid_report_usage_path_t *path_item;
566 link_t *path;
567 link_t *item;
568
569 if(head == NULL || list_empty(head)) {
570 usb_log_debug("\tempty\n");
571 return;
572 }
573
574 for(item = head->next; item != head; item = item->next) {
575
576 report_item = list_get_instance(item, usb_hid_report_item_t, link);
577
578 usb_log_debug("\tOFFSET: %X\n", report_item->offset);
579 usb_log_debug("\tCOUNT: %X\n", report_item->count);
580 usb_log_debug("\tSIZE: %X\n", report_item->size);
581 usb_log_debug("\tCONSTANT/VAR: %X\n", USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags));
582 usb_log_debug("\tVARIABLE/ARRAY: %X\n", USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags));
583 usb_log_debug("\tUSAGE PATH:\n");
584
585 path = report_item->usage_path->link.next;
586 while(path != &report_item->usage_path->link) {
587 path_item = list_get_instance(path, usb_hid_report_usage_path_t, link);
588 usb_log_debug("\t\tUSAGE PAGE: %X, USAGE: %X\n", path_item->usage_page, path_item->usage);
589 path = path->next;
590 }
591
592 usb_log_debug("\tLOGMIN: %X\n", report_item->logical_minimum);
593 usb_log_debug("\tLOGMAX: %X\n", report_item->logical_maximum);
594 usb_log_debug("\tPHYMIN: %X\n", report_item->physical_minimum);
595 usb_log_debug("\tPHYMAX: %X\n", report_item->physical_maximum);
596 usb_log_debug("\tUSAGEMIN: %X\n", report_item->usage_minimum);
597 usb_log_debug("\tUSAGEMAX: %X\n", report_item->usage_maximum);
598
599 usb_log_debug("\n");
600
601 }
602
603
604}
605/**
606 * Prints content of given report descriptor in human readable format.
607 *
608 * @param parser Parsed descriptor to print
609 * @return void
610 */
611void usb_hid_descriptor_print(usb_hid_report_parser_t *parser)
612{
613 if(parser == NULL) {
614 return;
615 }
616
617 usb_log_debug("INPUT:\n");
618 usb_hid_descriptor_print_list(&parser->input);
619
620 usb_log_debug("OUTPUT: \n");
621 usb_hid_descriptor_print_list(&parser->output);
622
623 usb_log_debug("FEATURE:\n");
624 usb_hid_descriptor_print_list(&parser->feature);
625
626}
627
628/**
629 * Releases whole linked list of report items
630 *
631 * @param head Head of list of report descriptor items (usb_hid_report_item_t)
632 * @return void
633 */
634void usb_hid_free_report_list(link_t *head)
635{
636 return;
637
638 usb_hid_report_item_t *report_item;
639 link_t *next;
640
641 if(head == NULL || list_empty(head)) {
642 return;
643 }
644
645 next = head->next;
646 while(next != head) {
647
648 report_item = list_get_instance(next, usb_hid_report_item_t, link);
649
650 while(!list_empty(&report_item->usage_path->link)) {
651 usb_hid_report_remove_last_item(report_item->usage_path);
652 }
653
654
655 next = next->next;
656
657 free(report_item);
658 }
659
660 return;
661
662}
663
664/** Frees the HID report descriptor parser structure
665 *
666 * @param parser Opaque HID report parser structure
667 * @return void
668 */
669void usb_hid_free_report_parser(usb_hid_report_parser_t *parser)
670{
671 if(parser == NULL){
672 return;
673 }
674
675 parser->use_report_id = 0;
676
677 usb_hid_free_report_list(&parser->input);
678 usb_hid_free_report_list(&parser->output);
679 usb_hid_free_report_list(&parser->feature);
680
681 return;
682}
683
684/** Parse and act upon a HID report.
685 *
686 * @see usb_hid_parse_report_descriptor
687 *
688 * @param parser Opaque HID report parser structure.
689 * @param data Data for the report.
690 * @param callbacks Callbacks for report actions.
691 * @param arg Custom argument (passed through to the callbacks).
692 * @return Error code.
693 */
694int usb_hid_parse_report(const usb_hid_report_parser_t *parser,
695 const uint8_t *data, size_t size,
696 usb_hid_report_path_t *path, int flags,
697 const usb_hid_report_in_callbacks_t *callbacks, void *arg)
698{
699 link_t *list_item;
700 usb_hid_report_item_t *item;
701 uint8_t *keys;
702 uint8_t item_value;
703 size_t key_count=0;
704 size_t i=0;
705 size_t j=0;
706 uint8_t report_id = 0;
707
708 if(parser == NULL) {
709 return EINVAL;
710 }
711
712 /* get the size of result array */
713 key_count = usb_hid_report_input_length(parser, path, flags);
714
715 if(!(keys = malloc(sizeof(uint8_t) * key_count))){
716 return ENOMEM;
717 }
718
719 if(parser->use_report_id != 0) {
720 report_id = data[0];
721 usb_hid_report_path_set_report_id(path, report_id);
722 }
723
724 /* read data */
725 list_item = parser->input.next;
726 while(list_item != &(parser->input)) {
727
728 item = list_get_instance(list_item, usb_hid_report_item_t, link);
729
730 if(!USB_HID_ITEM_FLAG_CONSTANT(item->item_flags) &&
731 (usb_hid_report_compare_usage_path(item->usage_path, path, flags) == EOK)) {
732 for(j=0; j<(size_t)(item->count); j++) {
733 if((USB_HID_ITEM_FLAG_VARIABLE(item->item_flags) == 0) ||
734 ((item->usage_minimum == 0) && (item->usage_maximum == 0))) {
735 // variable item
736 keys[i++] = usb_hid_translate_data(item, data,j);
737 }
738 else {
739 // bitmapa
740 if((item_value = usb_hid_translate_data(item, data, j)) != 0) {
741 keys[i++] = (item->count - 1 - j) + item->usage_minimum;
742 }
743 else {
744 keys[i++] = 0;
745 }
746 }
747 }
748 }
749 list_item = list_item->next;
750 }
751
752 callbacks->keyboard(keys, key_count, report_id, arg);
753
754 free(keys);
755 return EOK;
756
757}
758
759/**
760 * Translate data from the report as specified in report descriptor
761 *
762 * @param item Report descriptor item with definition of translation
763 * @param data Data to translate
764 * @param j Index of processed field in report descriptor item
765 * @return Translated data
766 */
767int usb_hid_translate_data(usb_hid_report_item_t *item, const uint8_t *data, size_t j)
768{
769 int resolution;
770 int offset;
771 int part_size;
772
773 int32_t value;
774 int32_t mask;
775 const uint8_t *foo;
776
777 // now only common numbers llowed
778 if(item->size > 32) {
779 return 0;
780 }
781
782 if((item->physical_minimum == 0) && (item->physical_maximum == 0)) {
783 item->physical_minimum = item->logical_minimum;
784 item->physical_maximum = item->logical_maximum;
785 }
786
787 if(item->physical_maximum == item->physical_minimum){
788 resolution = 1;
789 }
790 else {
791 resolution = (item->logical_maximum - item->logical_minimum) /
792 ((item->physical_maximum - item->physical_minimum) *
793 (usb_pow(10,(item->unit_exponent))));
794 }
795
796 offset = item->offset + (j * item->size);
797 if(item->id != 0) {
798 offset += 8;
799 usb_log_debug("MOVED OFFSET BY 1Byte, REPORT_ID(%d)\n", item->id);
800 }
801
802 // FIXME
803 if((offset/8) != ((offset+item->size)/8)) {
804 usb_log_debug2("offset %d\n", offset);
805
806 part_size = ((offset+item->size)%8);
807 usb_log_debug2("part size %d\n",part_size);
808
809 // the higher one
810 foo = data+(offset/8);
811 mask = ((1 << (item->size-part_size))-1);
812 value = (*foo & mask) << part_size;
813
814 usb_log_debug2("hfoo %x\n", *foo);
815 usb_log_debug2("hmaska %x\n", mask);
816 usb_log_debug2("hval %d\n", value);
817
818 // the lower one
819 foo = data+((offset+item->size)/8);
820 mask = ((1 << part_size)-1) << (8-part_size);
821 value += ((*foo & mask) >> (8-part_size));
822
823 usb_log_debug2("lfoo %x\n", *foo);
824 usb_log_debug2("lmaska %x\n", mask);
825 usb_log_debug2("lval %d\n", ((*foo & mask) >> (8-(item->size-part_size))));
826 usb_log_debug2("val %d\n", value);
827
828
829 }
830 else {
831 foo = data+(offset/8);
832 mask = ((1 << item->size)-1) << (8-((offset%8)+item->size));
833 value = (*foo & mask) >> (8-((offset%8)+item->size));
834
835 usb_log_debug2("offset %d\n", offset);
836
837 usb_log_debug2("foo %x\n", *foo);
838 usb_log_debug2("maska %x\n", mask);
839 usb_log_debug2("val %d\n", value);
840 }
841
842 usb_log_debug2("---\n\n");
843
844 return (int)(((value - item->logical_minimum) / resolution) + item->physical_minimum);
845
846}
847
848/**
849 *
850 *
851 * @param parser
852 * @param path
853 * @param flags
854 * @return
855 */
856size_t usb_hid_report_input_length(const usb_hid_report_parser_t *parser,
857 usb_hid_report_path_t *path, int flags)
858{
859 size_t ret = 0;
860 link_t *item;
861 usb_hid_report_item_t *report_item;
862
863 if(parser == NULL) {
864 return 0;
865 }
866
867 item = parser->input.next;
868 while(&parser->input != item) {
869 report_item = list_get_instance(item, usb_hid_report_item_t, link);
870 if(!USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags) &&
871 (usb_hid_report_compare_usage_path(report_item->usage_path, path, flags) == EOK)) {
872 ret += report_item->count;
873 }
874
875 item = item->next;
876 }
877
878 return ret;
879}
880
881
882/**
883 *
884 * @param usage_path
885 * @param usage_page
886 * @param usage
887 * @return
888 */
889int usb_hid_report_path_append_item(usb_hid_report_path_t *usage_path,
890 int32_t usage_page, int32_t usage)
891{
892 usb_hid_report_usage_path_t *item;
893
894 if(!(item=malloc(sizeof(usb_hid_report_usage_path_t)))) {
895 return ENOMEM;
896 }
897 list_initialize(&item->link);
898
899 item->usage = usage;
900 item->usage_page = usage_page;
901
902 list_append (&usage_path->link, &item->link);
903 usage_path->depth++;
904 return EOK;
905}
906
907/**
908 *
909 * @param usage_path
910 * @return
911 */
912void usb_hid_report_remove_last_item(usb_hid_report_path_t *usage_path)
913{
914 usb_hid_report_usage_path_t *item;
915
916 if(!list_empty(&usage_path->link)){
917 item = list_get_instance(usage_path->link.prev, usb_hid_report_usage_path_t, link);
918 list_remove(usage_path->link.prev);
919 usage_path->depth--;
920 free(item);
921 }
922}
923
924/**
925 *
926 * @param usage_path
927 * @return
928 */
929void usb_hid_report_null_last_item(usb_hid_report_path_t *usage_path)
930{
931 usb_hid_report_usage_path_t *item;
932
933 if(!list_empty(&usage_path->link)){
934 item = list_get_instance(usage_path->link.prev, usb_hid_report_usage_path_t, link);
935 memset(item, 0, sizeof(usb_hid_report_usage_path_t));
936 }
937}
938
939/**
940 *
941 * @param usage_path
942 * @param tag
943 * @param data
944 * @return
945 */
946void usb_hid_report_set_last_item(usb_hid_report_path_t *usage_path, int32_t tag, int32_t data)
947{
948 usb_hid_report_usage_path_t *item;
949
950 if(!list_empty(&usage_path->link)){
951 item = list_get_instance(usage_path->link.prev, usb_hid_report_usage_path_t, link);
952
953 switch(tag) {
954 case USB_HID_TAG_CLASS_GLOBAL:
955 item->usage_page = data;
956 break;
957 case USB_HID_TAG_CLASS_LOCAL:
958 item->usage = data;
959 break;
960 }
961 }
962
963}
964
965/**
966 *
967 *
968 * @param report_path
969 * @param path
970 * @param flags
971 * @return
972 */
973int usb_hid_report_compare_usage_path(usb_hid_report_path_t *report_path,
974 usb_hid_report_path_t *path,
975 int flags)
976{
977 usb_hid_report_usage_path_t *report_item;
978 usb_hid_report_usage_path_t *path_item;
979
980 link_t *report_link;
981 link_t *path_link;
982
983 int only_page;
984
985 if(report_path->report_id != path->report_id) {
986 return 1;
987 }
988
989 if(path->depth == 0){
990 return EOK;
991 }
992
993
994 if((only_page = flags & USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY) != 0){
995 flags -= USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY;
996 }
997
998 switch(flags){
999 /* path must be completly identical */
1000 case USB_HID_PATH_COMPARE_STRICT:
1001 if(report_path->depth != path->depth){
1002 return 1;
1003 }
1004
1005 report_link = report_path->link.next;
1006 path_link = path->link.next;
1007
1008 while((report_link != &report_path->link) && (path_link != &path->link)) {
1009 report_item = list_get_instance(report_link, usb_hid_report_usage_path_t, link);
1010 path_item = list_get_instance(path_link, usb_hid_report_usage_path_t, link);
1011
1012 if((report_item->usage_page != path_item->usage_page) ||
1013 ((only_page == 0) && (report_item->usage != path_item->usage))) {
1014 return 1;
1015 } else {
1016 report_link = report_link->next;
1017 path_link = path_link->next;
1018 }
1019
1020 }
1021
1022 if((report_link == &report_path->link) && (path_link == &path->link)) {
1023 return EOK;
1024 }
1025 else {
1026 return 1;
1027 }
1028 break;
1029
1030 /* compare with only the end of path*/
1031 case USB_HID_PATH_COMPARE_END:
1032 report_link = report_path->link.prev;
1033 path_link = path->link.prev;
1034
1035 if(list_empty(&path->link)){
1036 return EOK;
1037 }
1038
1039 while((report_link != &report_path->link) && (path_link != &path->link)) {
1040 report_item = list_get_instance(report_link, usb_hid_report_usage_path_t, link);
1041 path_item = list_get_instance(path_link, usb_hid_report_usage_path_t, link);
1042
1043 if((report_item->usage_page != path_item->usage_page) ||
1044 ((only_page == 0) && (report_item->usage != path_item->usage))) {
1045 return 1;
1046 } else {
1047 report_link = report_link->prev;
1048 path_link = path_link->prev;
1049 }
1050
1051 }
1052
1053 if(path_link == &path->link) {
1054 return EOK;
1055 }
1056 else {
1057 return 1;
1058 }
1059
1060 break;
1061
1062 default:
1063 return EINVAL;
1064 }
1065
1066
1067
1068
1069}
1070
1071/**
1072 *
1073 * @return
1074 */
1075usb_hid_report_path_t *usb_hid_report_path(void)
1076{
1077 usb_hid_report_path_t *path;
1078 path = malloc(sizeof(usb_hid_report_path_t));
1079 if(!path){
1080 return NULL;
1081 }
1082 else {
1083 path->depth = 0;
1084 path->report_id = 0;
1085 list_initialize(&path->link);
1086 return path;
1087 }
1088}
1089
1090/**
1091 *
1092 * @param path
1093 * @return void
1094 */
1095void usb_hid_report_path_free(usb_hid_report_path_t *path)
1096{
1097 while(!list_empty(&path->link)){
1098 usb_hid_report_remove_last_item(path);
1099 }
1100}
1101
1102
1103/**
1104 * Clone content of given usage path to the new one
1105 *
1106 * @param usage_path
1107 * @return
1108 */
1109usb_hid_report_path_t *usb_hid_report_path_clone(usb_hid_report_path_t *usage_path)
1110{
1111 usb_hid_report_usage_path_t *path_item;
1112 link_t *path_link;
1113 usb_hid_report_path_t *new_usage_path = usb_hid_report_path ();
1114
1115 if(new_usage_path == NULL){
1116 return NULL;
1117 }
1118
1119 if(list_empty(&usage_path->link)){
1120 return new_usage_path;
1121 }
1122
1123 path_link = usage_path->link.next;
1124 while(path_link != &usage_path->link) {
1125 path_item = list_get_instance(path_link, usb_hid_report_usage_path_t, link);
1126 usb_hid_report_path_append_item (new_usage_path, path_item->usage_page, path_item->usage);
1127
1128 path_link = path_link->next;
1129 }
1130
1131 return new_usage_path;
1132}
1133
1134
1135/*** OUTPUT API **/
1136
1137/** Allocates output report buffer
1138 *
1139 * @param parser
1140 * @param size
1141 * @return
1142 */
1143uint8_t *usb_hid_report_output(usb_hid_report_parser_t *parser, size_t *size)
1144{
1145 if(parser == NULL) {
1146 *size = 0;
1147 return NULL;
1148 }
1149
1150 // read the last output report item
1151 usb_hid_report_item_t *last;
1152 link_t *link;
1153
1154 link = parser->output.prev;
1155 if(link != &parser->output) {
1156 last = list_get_instance(link, usb_hid_report_item_t, link);
1157 *size = (last->offset + (last->size * last->count)) / 8;
1158
1159 uint8_t *buffer = malloc(sizeof(uint8_t) * (*size));
1160 memset(buffer, 0, sizeof(uint8_t) * (*size));
1161 usb_log_debug("output buffer: %s\n", usb_debug_str_buffer(buffer, *size, 0));
1162
1163 return buffer;
1164 }
1165 else {
1166 *size = 0;
1167 return NULL;
1168 }
1169}
1170
1171
1172/** Frees output report buffer
1173 *
1174 * @param output Output report buffer
1175 * @return
1176 */
1177void usb_hid_report_output_free(uint8_t *output)
1178
1179{
1180 if(output != NULL) {
1181 free (output);
1182 }
1183}
1184
1185/** Returns size of output for given usage path
1186 *
1187 * @param parser
1188 * @param path
1189 * @param flags
1190 * @return
1191 */
1192size_t usb_hid_report_output_size(usb_hid_report_parser_t *parser,
1193 usb_hid_report_path_t *path, int flags)
1194{
1195 size_t ret = 0;
1196 link_t *item;
1197 usb_hid_report_item_t *report_item;
1198
1199 if(parser == NULL) {
1200 return 0;
1201 }
1202
1203 item = parser->output.next;
1204 while(&parser->output != item) {
1205 report_item = list_get_instance(item, usb_hid_report_item_t, link);
1206 if(!USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags) &&
1207 (usb_hid_report_compare_usage_path(report_item->usage_path, path, flags) == EOK)) {
1208 ret += report_item->count;
1209 }
1210
1211 item = item->next;
1212 }
1213
1214 return ret;
1215
1216}
1217
1218/** Updates the output report buffer by translated given data
1219 *
1220 * @param parser
1221 * @param path
1222 * @param flags
1223 * @param buffer
1224 * @param size
1225 * @param data
1226 * @param data_size
1227 * @return
1228 */
1229int usb_hid_report_output_translate(usb_hid_report_parser_t *parser,
1230 usb_hid_report_path_t *path, int flags,
1231 uint8_t *buffer, size_t size,
1232 int32_t *data, size_t data_size)
1233{
1234 usb_hid_report_item_t *report_item;
1235 link_t *item;
1236 size_t idx=0;
1237 int i=0;
1238 int32_t value=0;
1239 int offset;
1240 int length;
1241 int32_t tmp_value;
1242 size_t offset_prefix = 0;
1243
1244 if(parser == NULL) {
1245 return EINVAL;
1246 }
1247
1248 if(parser->use_report_id != 0) {
1249 buffer[0] = path->report_id;
1250 offset_prefix = 8;
1251 }
1252
1253 usb_log_debug("OUTPUT BUFFER: %s\n", usb_debug_str_buffer(buffer,size, 0));
1254 usb_log_debug("OUTPUT DATA[0]: %d, DATA[1]: %d, DATA[2]: %d\n", data[0], data[1], data[2]);
1255
1256 item = parser->output.next;
1257 while(item != &parser->output) {
1258 report_item = list_get_instance(item, usb_hid_report_item_t, link);
1259
1260 for(i=0; i<report_item->count; i++) {
1261
1262 if(idx >= data_size) {
1263 break;
1264 }
1265
1266 if((USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags) == 0) ||
1267 ((report_item->usage_minimum == 0) && (report_item->usage_maximum == 0))) {
1268
1269// // variable item
1270 value = usb_hid_translate_data_reverse(report_item, data[idx++]);
1271 offset = report_item->offset + (i * report_item->size) + offset_prefix;
1272 length = report_item->size;
1273 }
1274 else {
1275 //bitmap
1276 value += usb_hid_translate_data_reverse(report_item, data[idx++]);
1277 offset = report_item->offset + offset_prefix;
1278 length = report_item->size * report_item->count;
1279 }
1280
1281 if((offset/8) == ((offset+length-1)/8)) {
1282 // je to v jednom bytu
1283 if(((size_t)(offset/8) >= size) || ((size_t)(offset+length-1)/8) >= size) {
1284 break; // TODO ErrorCode
1285 }
1286
1287 size_t shift = offset%8;
1288
1289 value = value << shift;
1290 value = value & (((1 << length)-1) << shift);
1291
1292 uint8_t mask = 0;
1293 mask = 0xff - (((1 << length) - 1) << shift);
1294 buffer[offset/8] = (buffer[offset/8] & mask) | value;
1295 }
1296 else {
1297 // je to ve dvou!! FIXME: melo by to umet delsi jak 2
1298
1299 // konec prvniho -- dolni x bitu
1300 tmp_value = value;
1301 tmp_value = tmp_value & ((1 << (8-(offset%8)))-1);
1302 tmp_value = tmp_value << (offset%8);
1303
1304 uint8_t mask = 0;
1305 mask = ~(((1 << (8-(offset%8)))-1) << (offset%8));
1306 buffer[offset/8] = (buffer[offset/8] & mask) | tmp_value;
1307
1308 // a ted druhej -- hornich length-x bitu
1309 value = value >> (8 - (offset % 8));
1310 value = value & ((1 << (length - (8 - (offset % 8)))) - 1);
1311
1312 mask = ((1 << (length - (8 - (offset % 8)))) - 1);
1313 buffer[(offset+length-1)/8] = (buffer[(offset+length-1)/8] & mask) | value;
1314 }
1315
1316 }
1317
1318 item = item->next;
1319 }
1320
1321 usb_log_debug("OUTPUT BUFFER: %s\n", usb_debug_str_buffer(buffer,size, 0));
1322
1323 return EOK;
1324}
1325
1326/**
1327 *
1328 * @param item
1329 * @param value
1330 * @return
1331 */
1332int32_t usb_hid_translate_data_reverse(usb_hid_report_item_t *item, int value)
1333{
1334 int ret=0;
1335 int resolution;
1336
1337 if(USB_HID_ITEM_FLAG_CONSTANT(item->item_flags)) {
1338 ret = item->logical_minimum;
1339 }
1340
1341 if((USB_HID_ITEM_FLAG_VARIABLE(item->item_flags) == 0)) {
1342
1343 // variable item
1344 if((item->physical_minimum == 0) && (item->physical_maximum == 0)) {
1345 item->physical_minimum = item->logical_minimum;
1346 item->physical_maximum = item->logical_maximum;
1347 }
1348
1349 if(item->physical_maximum == item->physical_minimum){
1350 resolution = 1;
1351 }
1352 else {
1353 resolution = (item->logical_maximum - item->logical_minimum) /
1354 ((item->physical_maximum - item->physical_minimum) *
1355 (usb_pow(10,(item->unit_exponent))));
1356 }
1357
1358 ret = ((value - item->physical_minimum) * resolution) + item->logical_minimum;
1359 }
1360 else {
1361 // bitmapa
1362 if(value == 0) {
1363 ret = 0;
1364 }
1365 else {
1366 size_t bitmap_idx = (value - item->usage_minimum);
1367 ret = 1 << bitmap_idx;
1368 }
1369 }
1370
1371
1372 return ret;
1373}
1374
1375
1376int usb_hid_report_path_set_report_id(usb_hid_report_path_t *path, uint8_t report_id)
1377{
1378 if(path == NULL){
1379 return EINVAL;
1380 }
1381
1382 path->report_id = report_id;
1383 return EOK;
1384}
1385
1386
1387usb_hid_report_item_t *usb_hid_report_item_clone(const usb_hid_report_item_t *item)
1388{
1389 usb_hid_report_item_t *new_report_item;
1390
1391 if(!(new_report_item = malloc(sizeof(usb_hid_report_item_t)))) {
1392 return NULL;
1393 }
1394 memcpy(new_report_item,item, sizeof(usb_hid_report_item_t));
1395 link_initialize(&(new_report_item->link));
1396
1397 return new_report_item;
1398}
1399
1400/**
1401 * @}
1402 */
Note: See TracBrowser for help on using the repository browser.