source: mainline/uspace/lib/usbhid/src/hidpath.c@ 8c62a71

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 8c62a71 was 0cda600, checked in by Jan Vesely <jano.vesely@…>, 14 years ago

libusbhid: Make usb_hid_report_path_free NULL safe.
  • Property mode set to 100644
File size: 11.8 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 * Compares two usages if they are same or not or one of the usages is not
46 * set.
47 *
48 * @param usage1
49 * @param usage2
50 * @return boolean
51 */
52#define USB_HID_SAME_USAGE(usage1, usage2) \
53 ((usage1 == usage2) || (usage1 == 0) || (usage2 == 0))
54
55/**
56 * Compares two usage pages if they are same or not or one of them is not set.
57 *
58 * @param page1
59 * @param page2
60 * @return boolean
61 */
62#define USB_HID_SAME_USAGE_PAGE(page1, page2) \
63 ((page1 == page2) || (page1 == 0) || (page2 == 0))
64
65/*---------------------------------------------------------------------------*/
66/**
67 * Appends one item (couple of usage_path and usage) into the usage path
68 * structure
69 *
70 * @param usage_path Usage path structure
71 * @param usage_page Usage page constant
72 * @param usage Usage constant
73 * @return Error code
74 */
75int usb_hid_report_path_append_item(usb_hid_report_path_t *usage_path,
76 int32_t usage_page, int32_t usage)
77{
78 usb_hid_report_usage_path_t *item
79 = malloc(sizeof(usb_hid_report_usage_path_t));
80
81 if (item == NULL) {
82 return ENOMEM;
83 }
84 link_initialize(&item->rpath_items_link);
85
86 item->usage = usage;
87 item->usage_page = usage_page;
88 item->flags = 0;
89
90 list_append (&item->rpath_items_link, &usage_path->items);
91 usage_path->depth++;
92 return EOK;
93}
94
95/*---------------------------------------------------------------------------*/
96/**
97 * Removes last item from the usage path structure
98 * @param usage_path
99 * @return void
100 */
101void usb_hid_report_remove_last_item(usb_hid_report_path_t *usage_path)
102{
103 link_t *item_link;
104 usb_hid_report_usage_path_t *item;
105
106 if(!list_empty(&usage_path->items)){
107 item_link = list_last(&usage_path->items);
108 item = list_get_instance(item_link,
109 usb_hid_report_usage_path_t, rpath_items_link);
110 list_remove(item_link);
111 usage_path->depth--;
112 free(item);
113 }
114}
115
116/*---------------------------------------------------------------------------*/
117/**
118 * Nulls last item of the usage path structure.
119 *
120 * @param usage_path
121 * @return void
122 */
123void usb_hid_report_null_last_item(usb_hid_report_path_t *usage_path)
124{
125 usb_hid_report_usage_path_t *item;
126
127 if(!list_empty(&usage_path->items)){
128 item = list_get_instance(list_last(&usage_path->items),
129 usb_hid_report_usage_path_t, rpath_items_link);
130
131 memset(item, 0, sizeof(usb_hid_report_usage_path_t));
132 }
133}
134
135/*---------------------------------------------------------------------------*/
136/**
137 * Modifies last item of usage path structure by given usage page or usage
138 *
139 * @param usage_path Opaque usage path structure
140 * @param tag Class of currently processed tag (Usage page tag falls into Global
141 * class but Usage tag into the Local)
142 * @param data Value of the processed tag
143 * @return void
144 */
145void usb_hid_report_set_last_item(usb_hid_report_path_t *usage_path,
146 int32_t tag, int32_t data)
147{
148 usb_hid_report_usage_path_t *item;
149
150 if(!list_empty(&usage_path->items)){
151 item = list_get_instance(list_last(&usage_path->items),
152 usb_hid_report_usage_path_t, rpath_items_link);
153
154 switch(tag) {
155 case USB_HID_TAG_CLASS_GLOBAL:
156 item->usage_page = data;
157 break;
158 case USB_HID_TAG_CLASS_LOCAL:
159 item->usage = data;
160 break;
161 }
162 }
163
164}
165
166/*---------------------------------------------------------------------------*/
167/**
168 *
169 *
170 *
171 *
172 */
173void usb_hid_print_usage_path(usb_hid_report_path_t *path)
174{
175 usb_log_debug("USAGE_PATH FOR RId(%d):\n", path->report_id);
176 usb_log_debug("\tLENGTH: %d\n", path->depth);
177
178 usb_hid_report_usage_path_t *path_item;
179
180 list_foreach(path->items, item) {
181 path_item = list_get_instance(item, usb_hid_report_usage_path_t,
182 rpath_items_link);
183
184 usb_log_debug("\tUSAGE_PAGE: %X\n", path_item->usage_page);
185 usb_log_debug("\tUSAGE: %X\n", path_item->usage);
186 usb_log_debug("\tFLAGS: %d\n", path_item->flags);
187 }
188}
189
190/*---------------------------------------------------------------------------*/
191/**
192 * Compares two usage paths structures
193 *
194 *
195 * @param report_path usage path structure to compare with @path
196 * @param path usage patrh structure to compare
197 * @param flags Flags determining the mode of comparison
198 * @return EOK if both paths are identical, non zero number otherwise
199 */
200int usb_hid_report_compare_usage_path(usb_hid_report_path_t *report_path,
201 usb_hid_report_path_t *path,
202 int flags)
203{
204 usb_hid_report_usage_path_t *report_item;
205 usb_hid_report_usage_path_t *path_item;
206
207 link_t *report_link;
208 link_t *path_link;
209
210 int only_page;
211
212 if(report_path->report_id != path->report_id) {
213 if(path->report_id != 0) {
214 return 1;
215 }
216 }
217
218 // Empty path match all others
219 if(path->depth == 0){
220 return EOK;
221 }
222
223
224 if((only_page = flags & USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY) != 0){
225 flags -= USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY;
226 }
227
228 switch(flags){
229 /* path is somewhere in report_path */
230 case USB_HID_PATH_COMPARE_ANYWHERE:
231 if(path->depth != 1){
232 return 1;
233 }
234
235 path_link = list_first(&path->items);
236 path_item = list_get_instance(path_link,
237 usb_hid_report_usage_path_t, rpath_items_link);
238
239 list_foreach(report_path->items, report_link) {
240 report_item = list_get_instance(report_link,
241 usb_hid_report_usage_path_t, rpath_items_link);
242
243 if(USB_HID_SAME_USAGE_PAGE(report_item->usage_page,
244 path_item->usage_page)){
245
246 if(only_page == 0){
247 if(USB_HID_SAME_USAGE(
248 report_item->usage,
249 path_item->usage)) {
250
251 return EOK;
252 }
253 }
254 else {
255 return EOK;
256 }
257 }
258 }
259
260 return 1;
261 break;
262
263 /* the paths must be identical */
264 case USB_HID_PATH_COMPARE_STRICT:
265 if(report_path->depth != path->depth){
266 return 1;
267 }
268
269 /* path is prefix of the report_path */
270 case USB_HID_PATH_COMPARE_BEGIN:
271
272 report_link = report_path->items.head.next;
273 path_link = path->items.head.next;
274
275 while((report_link != &report_path->items.head) &&
276 (path_link != &path->items.head)) {
277
278 report_item = list_get_instance(report_link,
279 usb_hid_report_usage_path_t, rpath_items_link);
280
281 path_item = list_get_instance(path_link,
282 usb_hid_report_usage_path_t, rpath_items_link);
283
284 if(!USB_HID_SAME_USAGE_PAGE(report_item->usage_page,
285 path_item->usage_page) || ((only_page == 0) &&
286 !USB_HID_SAME_USAGE(report_item->usage,
287 path_item->usage))) {
288
289 return 1;
290 }
291 else {
292 report_link = report_link->next;
293 path_link = path_link->next;
294 }
295
296 }
297
298 if((((flags & USB_HID_PATH_COMPARE_BEGIN) != 0) &&
299 (path_link == &path->items.head)) ||
300 ((report_link == &report_path->items.head) &&
301 (path_link == &path->items.head))) {
302
303 return EOK;
304 }
305 else {
306 return 1;
307 }
308 break;
309
310 /* path is suffix of report_path */
311 case USB_HID_PATH_COMPARE_END:
312
313 report_link = report_path->items.head.prev;
314 path_link = path->items.head.prev;
315
316 if(list_empty(&path->items)){
317 return EOK;
318 }
319
320 while((report_link != &report_path->items.head) &&
321 (path_link != &path->items.head)) {
322
323 report_item = list_get_instance(report_link,
324 usb_hid_report_usage_path_t, rpath_items_link);
325
326 path_item = list_get_instance(path_link,
327 usb_hid_report_usage_path_t, rpath_items_link);
328
329 if(!USB_HID_SAME_USAGE_PAGE(report_item->usage_page,
330 path_item->usage_page) || ((only_page == 0) &&
331 !USB_HID_SAME_USAGE(report_item->usage,
332 path_item->usage))) {
333
334 return 1;
335 } else {
336 report_link = report_link->prev;
337 path_link = path_link->prev;
338 }
339
340 }
341
342 if(path_link == &path->items.head) {
343 return EOK;
344 }
345 else {
346 return 1;
347 }
348
349 break;
350
351 default:
352 return EINVAL;
353 }
354}
355
356/*---------------------------------------------------------------------------*/
357/**
358 * Allocates and initializes new usage path structure.
359 *
360 * @return Initialized usage path structure
361 */
362usb_hid_report_path_t *usb_hid_report_path(void)
363{
364 usb_hid_report_path_t *path;
365 path = malloc(sizeof(usb_hid_report_path_t));
366 if(path == NULL){
367 return NULL;
368 }
369 else {
370 path->depth = 0;
371 path->report_id = 0;
372 link_initialize(&path->cpath_link);
373 list_initialize(&path->items);
374 return path;
375 }
376}
377
378/*---------------------------------------------------------------------------*/
379/**
380 * Releases given usage path structure.
381 *
382 * @param path usage path structure to release
383 * @return void
384 */
385void usb_hid_report_path_free(usb_hid_report_path_t *path)
386{
387 if (path == NULL)
388 return;
389 while(!list_empty(&path->items)){
390 usb_hid_report_remove_last_item(path);
391 }
392
393 assert_link_not_used(&path->cpath_link);
394 free(path);
395}
396
397/*---------------------------------------------------------------------------*/
398/**
399 * Clone content of given usage path to the new one
400 *
401 * @param usage_path Usage path structure to clone
402 * @return New copy of given usage path structure
403 */
404usb_hid_report_path_t *usb_hid_report_path_clone(
405 usb_hid_report_path_t *usage_path)
406{
407 usb_hid_report_usage_path_t *path_item;
408 usb_hid_report_usage_path_t *new_path_item;
409 usb_hid_report_path_t *new_usage_path = usb_hid_report_path ();
410
411 if(new_usage_path == NULL){
412 return NULL;
413 }
414
415 new_usage_path->report_id = usage_path->report_id;
416
417 if(list_empty(&usage_path->items)){
418 return new_usage_path;
419 }
420
421 list_foreach(usage_path->items, path_link) {
422 path_item = list_get_instance(path_link,
423 usb_hid_report_usage_path_t, rpath_items_link);
424
425 new_path_item = malloc(sizeof(usb_hid_report_usage_path_t));
426 if(new_path_item == NULL) {
427 return NULL;
428 }
429
430 link_initialize(&new_path_item->rpath_items_link);
431 new_path_item->usage_page = path_item->usage_page;
432 new_path_item->usage = path_item->usage;
433 new_path_item->flags = path_item->flags;
434
435 list_append(&new_path_item->rpath_items_link,
436 &new_usage_path->items);
437 new_usage_path->depth++;
438 }
439
440 return new_usage_path;
441}
442
443/*---------------------------------------------------------------------------*/
444/**
445 * Sets report id in usage path structure
446 *
447 * @param path Usage path structure
448 * @param report_id Report id to set
449 * @return Error code
450 */
451int usb_hid_report_path_set_report_id(usb_hid_report_path_t *path,
452 uint8_t report_id)
453{
454 if(path == NULL){
455 return EINVAL;
456 }
457
458 path->report_id = report_id;
459 return EOK;
460}
461
462/**
463 * @}
464 */
Note: See TracBrowser for help on using the repository browser.