Changes in / [a8ac368:fc883bb] in mainline
- Location:
- uspace/lib/usb
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
uspace/lib/usb/include/usb/classes/hidparser.h
ra8ac368 rfc883bb 31 31 */ 32 32 /** @file 33 * @brief USB HID parser.33 * USB HID report descriptor and report data parser 34 34 */ 35 35 #ifndef LIBUSB_HIDPARSER_H_ … … 74 74 #define USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY 4 75 75 76 /** */ 76 77 typedef struct { 78 /** */ 77 79 int32_t usage_page; 80 /** */ 78 81 int32_t usage; 79 82 /** */ 80 83 link_t link; 81 84 } usb_hid_report_usage_path_t; 82 85 86 /** */ 83 87 typedef struct { 88 /** */ 84 89 int depth; 90 91 /** */ 85 92 link_t link; 86 93 } usb_hid_report_path_t; … … 90 97 */ 91 98 typedef struct { 99 /** */ 92 100 int32_t id; 101 /** */ 93 102 int32_t usage_minimum; 103 /** */ 94 104 int32_t usage_maximum; 105 /** */ 95 106 int32_t logical_minimum; 107 /** */ 96 108 int32_t logical_maximum; 109 /** */ 97 110 int32_t size; 111 /** */ 98 112 int32_t count; 113 /** */ 99 114 size_t offset; 115 /** */ 100 116 int32_t delimiter; 101 117 /** */ 102 118 int32_t unit_exponent; 119 /** */ 103 120 int32_t unit; 104 121 105 /* 106 * some not yet used fields 107 */ 122 /** */ 108 123 int32_t string_index; 124 /** */ 109 125 int32_t string_minimum; 126 /** */ 110 127 int32_t string_maximum; 128 /** */ 111 129 int32_t designator_index; 130 /** */ 112 131 int32_t designator_minimum; 132 /** */ 113 133 int32_t designator_maximum; 134 /** */ 114 135 int32_t physical_minimum; 136 /** */ 115 137 int32_t physical_maximum; 116 138 139 /** */ 117 140 uint8_t item_flags; 118 141 142 /** */ 119 143 usb_hid_report_path_t *usage_path; 144 /** */ 120 145 link_t link; 121 146 } usb_hid_report_item_t; … … 124 149 /** HID report parser structure. */ 125 150 typedef struct { 151 /** */ 126 152 link_t input; 153 /** */ 127 154 link_t output; 155 /** */ 128 156 link_t feature; 129 157 } usb_hid_report_parser_t; … … 190 218 191 219 /* 192 * modifiers definitions 193 */ 194 220 * Descriptor parser functions 221 */ 222 /** */ 223 int usb_hid_parser_init(usb_hid_report_parser_t *parser); 224 225 /** */ 226 int usb_hid_parse_report_descriptor(usb_hid_report_parser_t *parser, 227 const uint8_t *data, size_t size); 228 229 /** */ 230 void usb_hid_free_report_parser(usb_hid_report_parser_t *parser); 231 232 /** */ 233 void usb_hid_descriptor_print(usb_hid_report_parser_t *parser); 234 235 /* 236 * Boot protocol functions 237 */ 238 /** */ 195 239 int usb_hid_boot_keyboard_input_report(const uint8_t *data, size_t size, 196 240 const usb_hid_report_in_callbacks_t *callbacks, void *arg); 197 241 242 /** */ 198 243 int usb_hid_boot_keyboard_output_report(uint8_t leds, uint8_t *data, size_t size); 199 244 200 int usb_hid_parser_init(usb_hid_report_parser_t *parser); 201 int usb_hid_parse_report_descriptor(usb_hid_report_parser_t *parser, 202 const uint8_t *data, size_t size); 203 245 246 /* 247 * Input report parser functions 248 */ 249 /** */ 204 250 int usb_hid_parse_report(const usb_hid_report_parser_t *parser, 205 251 const uint8_t *data, size_t size, … … 207 253 const usb_hid_report_in_callbacks_t *callbacks, void *arg); 208 254 209 int usb_hid_report_input_length(const usb_hid_report_parser_t *parser, 255 /** */ 256 size_t usb_hid_report_input_length(const usb_hid_report_parser_t *parser, 210 257 usb_hid_report_path_t *path, int flags); 211 258 212 259 213 void usb_hid_free_report_parser(usb_hid_report_parser_t *parser); 214 215 void usb_hid_descriptor_print(usb_hid_report_parser_t *parser); 216 217 /* usage path functions*/260 261 /* 262 * usage path functions 263 */ 264 /** */ 218 265 usb_hid_report_path_t *usb_hid_report_path(void); 266 267 /** */ 219 268 void usb_hid_report_path_free(usb_hid_report_path_t *path); 269 270 /** */ 220 271 int usb_hid_report_path_append_item(usb_hid_report_path_t *usage_path, int32_t usage_page, int32_t usage); 272 273 /** */ 221 274 void usb_hid_report_remove_last_item(usb_hid_report_path_t *usage_path); 275 276 /** */ 222 277 void usb_hid_report_null_last_item(usb_hid_report_path_t *usage_path); 278 279 /** */ 223 280 void usb_hid_report_set_last_item(usb_hid_report_path_t *usage_path, int32_t tag, int32_t data); 281 282 /** */ 224 283 int usb_hid_report_compare_usage_path(usb_hid_report_path_t *report_path, usb_hid_report_path_t *path, int flags); 225 int usb_hid_report_path_clone(usb_hid_report_path_t *new_usage_path, usb_hid_report_path_t *usage_path); 226 227 228 // output 229 // - funkce co vrati cesty poli v output reportu 230 // - funkce co pro danou cestu nastavi data 231 // - finalize 232 284 285 /** */ 286 usb_hid_report_path_t *usb_hid_report_path_clone(usb_hid_report_path_t *usage_path); 287 288 289 /* 290 * Output report parser functions 291 */ 292 /** Allocates output report buffer*/ 293 uint8_t *usb_hid_report_output(usb_hid_report_parser_t *parser, size_t *size); 294 295 /** Frees output report buffer*/ 296 void usb_hid_report_output_free(uint8_t *output); 297 298 /** Returns size of output for given usage path */ 299 size_t usb_hid_report_output_size(usb_hid_report_parser_t *parser, 300 usb_hid_report_path_t *path, int flags); 301 302 /** Updates the output report buffer by translated given data */ 303 int usb_hid_report_output_translate(usb_hid_report_parser_t *parser, 304 usb_hid_report_path_t *path, int flags, 305 uint8_t *buffer, size_t size, 306 int32_t *data, size_t data_size); 233 307 #endif 234 308 /** -
uspace/lib/usb/src/hidparser.c
ra8ac368 rfc883bb 31 31 */ 32 32 /** @file 33 * @brief HIDparser implementation.33 * HID report descriptor and report data parser implementation. 34 34 */ 35 35 #include <usb/classes/hidparser.h> … … 40 40 #include <usb/debug.h> 41 41 42 /** */ 42 43 #define USB_HID_NEW_REPORT_ITEM 1 44 45 /** */ 43 46 #define USB_HID_NO_ACTION 2 47 48 /** */ 44 49 #define USB_HID_UNKNOWN_TAG -99 45 50 46 #define BAD_HACK_USAGE_PAGE 0x07 47 51 /* 52 * Private descriptor parser functions 53 */ 48 54 int usb_hid_report_parse_tag(uint8_t tag, uint8_t class, const uint8_t *data, size_t item_size, 49 55 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path); … … 58 64 int usb_hid_report_reset_local_items(); 59 65 void usb_hid_free_report_list(link_t *head); 66 67 /* 68 * Data translation private functions 69 */ 60 70 int32_t usb_hid_report_tag_data_int32(const uint8_t *data, size_t size); 61 71 inline size_t usb_hid_count_item_offset(usb_hid_report_item_t * report_item, size_t offset); 62 72 int usb_hid_translate_data(usb_hid_report_item_t *item, const uint8_t *data, size_t j); 73 int32_t usb_hid_translate_data_reverse(usb_hid_report_item_t *item, int32_t value); 63 74 int usb_pow(int a, int b); 64 75 65 76 // TODO: tohle ma bejt asi jinde 66 77 int usb_pow(int a, int b) 67 78 { … … 80 91 81 92 /** 82 * 93 * Initialize the report descriptor parser structure 94 * 95 * @param parser Report descriptor parser structure 96 * @return Error code 83 97 */ 84 98 int usb_hid_parser_init(usb_hid_report_parser_t *parser) 85 99 { 86 87 return EINVAL;88 89 90 100 if(parser == NULL) { 101 return EINVAL; 102 } 103 104 list_initialize(&(parser->input)); 91 105 list_initialize(&(parser->output)); 92 106 list_initialize(&(parser->feature)); … … 164 178 // store current usage path 165 179 report_item->usage_path = usage_path; 166 167 // new current usage path168 tmp_usage_path = usb_hid_report_path();169 180 170 // c opy oldpath to the new one171 usb_hid_report_path_clone(tmp_usage_path,usage_path);181 // clone path to the new one 182 tmp_usage_path = usb_hid_report_path_clone(usage_path); 172 183 173 184 // swap … … 304 315 305 316 /** 317 * Parse one tag of the report descriptor 306 318 * 307 319 * @param Tag to parse … … 391 403 * @return Error code 392 404 */ 393 394 405 int usb_hid_report_parse_global_tag(uint8_t tag, const uint8_t *data, size_t item_size, 395 406 usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path) … … 520 531 * Prints content of given list of report items. 521 532 * 522 * @param List of report items 533 * @param List of report items (usb_hid_report_item_t) 523 534 * @return void 524 535 */ … … 552 563 path = path->next; 553 564 } 554 555 556 // usb_log_debug("\tUSAGE: %X\n", report_item->usage); 557 // usb_log_debug("\tUSAGE PAGE: %X\n", report_item->usage_page); 565 558 566 usb_log_debug("\tLOGMIN: %X\n", report_item->logical_minimum); 559 567 usb_log_debug("\tLOGMAX: %X\n", report_item->logical_maximum); … … 570 578 } 571 579 /** 572 * Prints content of given descriptor in human readable format.573 * 574 * @param Parsed descriptor to print580 * Prints content of given report descriptor in human readable format. 581 * 582 * @param parser Parsed descriptor to print 575 583 * @return void 576 584 */ … … 595 603 * Releases whole linked list of report items 596 604 * 597 * 605 * @param head Head of list of report descriptor items (usb_hid_report_item_t) 606 * @return void 598 607 */ 599 608 void usb_hid_free_report_list(link_t *head) … … 627 636 } 628 637 629 /** Free the HID reportparser structure638 /** Frees the HID report descriptor parser structure 630 639 * 631 640 * @param parser Opaque HID report parser structure 632 * @return Error code641 * @return void 633 642 */ 634 643 void usb_hid_free_report_parser(usb_hid_report_parser_t *parser) … … 660 669 const usb_hid_report_in_callbacks_t *callbacks, void *arg) 661 670 { 662 /*663 *664 * only key codes (usage page 0x07) will be processed665 * other usages will be ignored666 */667 671 link_t *list_item; 668 672 usb_hid_report_item_t *item; … … 676 680 return EINVAL; 677 681 } 678 679 680 // get the size of result keycodes array 682 683 /* get the size of result array */ 681 684 key_count = usb_hid_report_input_length(parser, path, flags); 682 685 … … 685 688 } 686 689 687 / / read data690 /* read data */ 688 691 list_item = parser->input.next; 689 692 while(list_item != &(parser->input)) { … … 719 722 } 720 723 721 724 /** 725 * Translate data from the report as specified in report descriptor 726 * 727 * @param item Report descriptor item with definition of translation 728 * @param data Data to translate 729 * @param j Index of processed field in report descriptor item 730 * @return Translated data 731 */ 722 732 int usb_hid_translate_data(usb_hid_report_item_t *item, const uint8_t *data, size_t j) 723 733 { … … 796 806 } 797 807 798 int usb_hid_report_input_length(const usb_hid_report_parser_t *parser, 808 /** 809 * 810 * 811 * @param parser 812 * @param path 813 * @param flags 814 * @return 815 */ 816 size_t usb_hid_report_input_length(const usb_hid_report_parser_t *parser, 799 817 usb_hid_report_path_t *path, int flags) 800 818 { 801 int ret = 0;819 size_t ret = 0; 802 820 link_t *item; 803 821 usb_hid_report_item_t *report_item; 804 822 805 823 if(parser == NULL) { 806 return EINVAL;807 } 808 809 item = (&parser->input)->next;824 return 0; 825 } 826 827 item = parser->input.next; 810 828 while(&parser->input != item) { 811 829 report_item = list_get_instance(item, usb_hid_report_item_t, link); … … 824 842 /** 825 843 * 844 * @param usage_path 845 * @param usage_page 846 * @param usage 847 * @return 826 848 */ 827 849 int usb_hid_report_path_append_item(usb_hid_report_path_t *usage_path, … … 845 867 /** 846 868 * 869 * @param usage_path 870 * @return 847 871 */ 848 872 void usb_hid_report_remove_last_item(usb_hid_report_path_t *usage_path) … … 860 884 /** 861 885 * 886 * @param usage_path 887 * @return 862 888 */ 863 889 void usb_hid_report_null_last_item(usb_hid_report_path_t *usage_path) … … 873 899 /** 874 900 * 901 * @param usage_path 902 * @param tag 903 * @param data 904 * @return 875 905 */ 876 906 void usb_hid_report_set_last_item(usb_hid_report_path_t *usage_path, int32_t tag, int32_t data) … … 894 924 895 925 /** 896 * 926 * 927 * 928 * @param report_path 929 * @param path 930 * @param flags 931 * @return 897 932 */ 898 933 int usb_hid_report_compare_usage_path(usb_hid_report_path_t *report_path, … … 949 984 break; 950 985 951 /* given path must be the end of the report one*/986 /* compare with only the end of path*/ 952 987 case USB_HID_PATH_COMPARE_END: 953 988 report_link = report_path->link.prev; … … 992 1027 /** 993 1028 * 1029 * @return 994 1030 */ 995 1031 usb_hid_report_path_t *usb_hid_report_path(void) … … 1009 1045 /** 1010 1046 * 1047 * @param path 1048 * @return void 1011 1049 */ 1012 1050 void usb_hid_report_path_free(usb_hid_report_path_t *path) … … 1019 1057 1020 1058 /** 1021 * 1022 */ 1023 int usb_hid_report_path_clone(usb_hid_report_path_t *new_usage_path, usb_hid_report_path_t *usage_path) 1059 * Clone content of given usage path to the new one 1060 * 1061 * @param usage_path 1062 * @return 1063 */ 1064 usb_hid_report_path_t *usb_hid_report_path_clone(usb_hid_report_path_t *usage_path) 1024 1065 { 1025 1066 usb_hid_report_usage_path_t *path_item; 1026 1067 link_t *path_link; 1027 1068 usb_hid_report_path_t *new_usage_path = usb_hid_report_path (); 1069 1070 if(new_usage_path == NULL){ 1071 return NULL; 1072 } 1028 1073 1029 1074 if(list_empty(&usage_path->link)){ 1030 return EOK;1075 return new_usage_path; 1031 1076 } 1032 1077 … … 1039 1084 } 1040 1085 1086 return new_usage_path; 1087 } 1088 1089 1090 /*** OUTPUT API **/ 1091 1092 /** Allocates output report buffer 1093 * 1094 * @param parser 1095 * @param size 1096 * @return 1097 */ 1098 uint8_t *usb_hid_report_output(usb_hid_report_parser_t *parser, size_t *size) 1099 { 1100 if(parser == NULL) { 1101 *size = 0; 1102 return NULL; 1103 } 1104 1105 // read the last output report item 1106 usb_hid_report_item_t *last; 1107 link_t *link; 1108 1109 link = parser->output.prev; 1110 if(link != &parser->output) { 1111 last = list_get_instance(link, usb_hid_report_item_t, link); 1112 *size = (last->offset + (last->size * last->count)) / 8; 1113 1114 uint8_t *buffer = malloc(sizeof(uint8_t) * (*size)); 1115 memset(buffer, 0, sizeof(uint8_t) * (*size)); 1116 usb_log_debug("output buffer: %s\n", usb_debug_str_buffer(buffer, *size, 0)); 1117 1118 return buffer; 1119 } 1120 else { 1121 *size = 0; 1122 return NULL; 1123 } 1124 } 1125 1126 1127 /** Frees output report buffer 1128 * 1129 * @param output Output report buffer 1130 * @return 1131 */ 1132 void usb_hid_report_output_free(uint8_t *output) 1133 1134 { 1135 if(output != NULL) { 1136 free (output); 1137 } 1138 } 1139 1140 /** Returns size of output for given usage path 1141 * 1142 * @param parser 1143 * @param path 1144 * @param flags 1145 * @return 1146 */ 1147 size_t usb_hid_report_output_size(usb_hid_report_parser_t *parser, 1148 usb_hid_report_path_t *path, int flags) 1149 { 1150 size_t ret = 0; 1151 link_t *item; 1152 usb_hid_report_item_t *report_item; 1153 1154 if(parser == NULL) { 1155 return 0; 1156 } 1157 1158 item = parser->output.next; 1159 while(&parser->output != item) { 1160 report_item = list_get_instance(item, usb_hid_report_item_t, link); 1161 if(!USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags) && 1162 (usb_hid_report_compare_usage_path(report_item->usage_path, path, flags) == EOK)) { 1163 ret += report_item->count; 1164 } 1165 1166 item = item->next; 1167 } 1168 1169 return ret; 1170 1171 } 1172 1173 /** Updates the output report buffer by translated given data 1174 * 1175 * @param parser 1176 * @param path 1177 * @param flags 1178 * @param buffer 1179 * @param size 1180 * @param data 1181 * @param data_size 1182 * @return 1183 */ 1184 int usb_hid_report_output_translate(usb_hid_report_parser_t *parser, 1185 usb_hid_report_path_t *path, int flags, 1186 uint8_t *buffer, size_t size, 1187 int32_t *data, size_t data_size) 1188 { 1189 usb_hid_report_item_t *report_item; 1190 link_t *item; 1191 size_t idx=0; 1192 int i=0; 1193 int32_t value=0; 1194 int offset; 1195 int length; 1196 int32_t tmp_value; 1197 1198 if(parser == NULL) { 1199 return EINVAL; 1200 } 1201 1202 item = parser->output.next; 1203 while(item != &parser->output) { 1204 report_item = list_get_instance(item, usb_hid_report_item_t, link); 1205 1206 for(i=0; i<report_item->count; i++) { 1207 1208 if(idx >= data_size) { 1209 break; 1210 } 1211 1212 // translate data 1213 if(USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags)) { 1214 value = report_item->logical_minimum; 1215 } 1216 else { 1217 //variable item 1218 value = usb_hid_translate_data_reverse(report_item, data[idx]); 1219 idx++; 1220 } 1221 1222 if((USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags) == 0) || 1223 ((report_item->usage_minimum == 0) && (report_item->usage_maximum == 0))) { 1224 1225 // // variable item 1226 offset = report_item->offset + (i * report_item->size); 1227 length = report_item->size; 1228 } 1229 else { 1230 //bitmap 1231 offset = report_item->offset; 1232 length = report_item->size * report_item->count; 1233 } 1234 1235 if((offset/8) == ((offset+length-1)/8)) { 1236 // je to v jednom bytu 1237 if(((size_t)(offset/8) >= size) || ((size_t)(offset+length-1)/8) >= size) { 1238 break; // TODO ErrorCode 1239 } 1240 1241 size_t shift=0; 1242 if(((offset+length)%8) > 0) { 1243 shift = (8- ((offset+length)%8)); 1244 } 1245 1246 value = value << shift; 1247 value = value & (((1 << length)-1) << shift); 1248 buffer[offset/8] = buffer[offset/8] | value; 1249 } 1250 else { 1251 // je to ve dvou!! FIXME: melo by to umet delsi jak 2 1252 1253 // konec prvniho 1254 tmp_value = value; 1255 tmp_value = tmp_value >> (8 - (offset%8) - 1); 1256 tmp_value = tmp_value & ((1 << (8-(offset%8)))-1); 1257 1258 buffer[offset/8] = buffer[offset/8] | tmp_value; 1259 1260 // a ted druhej 1261 value = value & ((1 << (length - (8 - (offset%8))))-1); 1262 value = value << (8 - (length - (8 - (offset%8)))); 1263 1264 buffer[(offset+length-1)/8] = buffer[(offset+length-1)/8] | value; 1265 } 1266 1267 } 1268 1269 item = item->next; 1270 } 1271 1272 1041 1273 return EOK; 1042 1274 } 1043 1275 1276 /** 1277 * 1278 * @param item 1279 * @param value 1280 * @return 1281 */ 1282 int32_t usb_hid_translate_data_reverse(usb_hid_report_item_t *item, int value) 1283 { 1284 int ret=0; 1285 int resolution; 1286 1287 if((USB_HID_ITEM_FLAG_VARIABLE(item->item_flags) == 0)) { 1288 1289 // variable item 1290 if((item->physical_minimum == 0) && (item->physical_maximum == 0)) { 1291 item->physical_minimum = item->logical_minimum; 1292 item->physical_maximum = item->logical_maximum; 1293 } 1294 1295 if(item->physical_maximum == item->physical_minimum){ 1296 resolution = 1; 1297 } 1298 else { 1299 resolution = (item->logical_maximum - item->logical_minimum) / 1300 ((item->physical_maximum - item->physical_minimum) * 1301 (usb_pow(10,(item->unit_exponent)))); 1302 } 1303 1304 ret = ((value - item->physical_minimum) * resolution) + item->logical_minimum; 1305 } 1306 else { 1307 // bitmapa 1308 if(value == 0) { 1309 ret = 0; 1310 } 1311 else { 1312 size_t bitmap_idx = (value - item->usage_minimum); 1313 ret = 1 << bitmap_idx; 1314 } 1315 } 1316 1317 1318 return ret; 1319 } 1320 1044 1321 1045 1322 /**
Note:
See TracChangeset
for help on using the changeset viewer.