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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since e141281 was e141281, checked in by Martin Decky <martin@…>, 8 years ago

cstyle (no change in functionality)
  • Property mode set to 100644
File size: 10.7 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 list_foreach(path->items, rpath_items_link,
179 usb_hid_report_usage_path_t, path_item) {
180
181 usb_log_debug("\tUSAGE_PAGE: %X\n", path_item->usage_page);
182 usb_log_debug("\tUSAGE: %X\n", path_item->usage);
183 usb_log_debug("\tFLAGS: %d\n", path_item->flags);
184 }
185}
186
187/** Compare two usage paths structures
188 *
189 * @param report_path Usage path structure to compare with @path
190 * @param path Usage patrh structure to compare
191 * @param flags Flags determining the mode of comparison
192 *
193 * @return EOK if both paths are identical, non zero number otherwise
194 *
195 */
196int usb_hid_report_compare_usage_path(usb_hid_report_path_t *report_path,
197 usb_hid_report_path_t *path, int flags)
198{
199 usb_hid_report_usage_path_t *report_item;
200 usb_hid_report_usage_path_t *path_item;
201
202 link_t *report_link;
203 link_t *path_link;
204
205 int only_page;
206
207 if (report_path->report_id != path->report_id) {
208 if (path->report_id != 0) {
209 return 1;
210 }
211 }
212
213 // Empty path match all others
214 if (path->depth == 0) {
215 return EOK;
216 }
217
218 if ((only_page = flags & USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY) != 0) {
219 flags -= USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY;
220 }
221
222 switch (flags) {
223 /* Path is somewhere in report_path */
224 case USB_HID_PATH_COMPARE_ANYWHERE:
225 if (path->depth != 1) {
226 return 1;
227 }
228
229 path_link = list_first(&path->items);
230 path_item = list_get_instance(path_link,
231 usb_hid_report_usage_path_t, rpath_items_link);
232
233 list_foreach(report_path->items, rpath_items_link,
234 usb_hid_report_usage_path_t, report_item) {
235 if (USB_HID_SAME_USAGE_PAGE(report_item->usage_page,
236 path_item->usage_page)) {
237
238 if (only_page == 0) {
239 if (USB_HID_SAME_USAGE(report_item->usage,
240 path_item->usage))
241 return EOK;
242 } else {
243 return EOK;
244 }
245 }
246 }
247
248 return 1;
249 break;
250
251 /* The paths must be identical */
252 case USB_HID_PATH_COMPARE_STRICT:
253 if (report_path->depth != path->depth) {
254 return 1;
255 }
256 /* Fallthrough */
257
258 /* Path is prefix of the report_path */
259 case USB_HID_PATH_COMPARE_BEGIN:
260 report_link = report_path->items.head.next;
261 path_link = path->items.head.next;
262
263 while ((report_link != &report_path->items.head) &&
264 (path_link != &path->items.head)) {
265
266 report_item = list_get_instance(report_link,
267 usb_hid_report_usage_path_t, rpath_items_link);
268
269 path_item = list_get_instance(path_link,
270 usb_hid_report_usage_path_t, rpath_items_link);
271
272 if (!USB_HID_SAME_USAGE_PAGE(report_item->usage_page,
273 path_item->usage_page) || ((only_page == 0) &&
274 !USB_HID_SAME_USAGE(report_item->usage,
275 path_item->usage))) {
276 return 1;
277 } else {
278 report_link = report_link->next;
279 path_link = path_link->next;
280 }
281 }
282
283 if ((((flags & USB_HID_PATH_COMPARE_BEGIN) != 0) &&
284 (path_link == &path->items.head)) ||
285 ((report_link == &report_path->items.head) &&
286 (path_link == &path->items.head))) {
287 return EOK;
288 } else {
289 return 1;
290 }
291 break;
292
293 /* Path is suffix of report_path */
294 case USB_HID_PATH_COMPARE_END:
295 report_link = report_path->items.head.prev;
296 path_link = path->items.head.prev;
297
298 if (list_empty(&path->items)) {
299 return EOK;
300 }
301
302 while ((report_link != &report_path->items.head) &&
303 (path_link != &path->items.head)) {
304 report_item = list_get_instance(report_link,
305 usb_hid_report_usage_path_t, rpath_items_link);
306
307 path_item = list_get_instance(path_link,
308 usb_hid_report_usage_path_t, rpath_items_link);
309
310 if (!USB_HID_SAME_USAGE_PAGE(report_item->usage_page,
311 path_item->usage_page) || ((only_page == 0) &&
312 !USB_HID_SAME_USAGE(report_item->usage,
313 path_item->usage))) {
314 return 1;
315 } else {
316 report_link = report_link->prev;
317 path_link = path_link->prev;
318 }
319 }
320
321 if (path_link == &path->items.head) {
322 return EOK;
323 } else {
324 return 1;
325 }
326 break;
327
328 default:
329 return EINVAL;
330 }
331}
332
333/**
334 * Allocates and initializes new usage path structure.
335 *
336 * @return Initialized usage path structure
337 */
338usb_hid_report_path_t *usb_hid_report_path(void)
339{
340 usb_hid_report_path_t *path;
341 path = malloc(sizeof(usb_hid_report_path_t));
342 if(path == NULL){
343 return NULL;
344 }
345 else {
346 path->depth = 0;
347 path->report_id = 0;
348 link_initialize(&path->cpath_link);
349 list_initialize(&path->items);
350 return path;
351 }
352}
353
354
355/**
356 * Releases given usage path structure.
357 *
358 * @param path usage path structure to release
359 * @return void
360 */
361void usb_hid_report_path_free(usb_hid_report_path_t *path)
362{
363 if (path == NULL)
364 return;
365 while(!list_empty(&path->items)){
366 usb_hid_report_remove_last_item(path);
367 }
368
369 assert_link_not_used(&path->cpath_link);
370 free(path);
371}
372
373
374/**
375 * Clone content of given usage path to the new one
376 *
377 * @param usage_path Usage path structure to clone
378 * @return New copy of given usage path structure
379 */
380usb_hid_report_path_t *usb_hid_report_path_clone(
381 usb_hid_report_path_t *usage_path)
382{
383 usb_hid_report_usage_path_t *new_path_item;
384 usb_hid_report_path_t *new_usage_path = usb_hid_report_path ();
385
386 if(new_usage_path == NULL){
387 return NULL;
388 }
389
390 new_usage_path->report_id = usage_path->report_id;
391
392 if(list_empty(&usage_path->items)){
393 return new_usage_path;
394 }
395
396 list_foreach(usage_path->items, rpath_items_link,
397 usb_hid_report_usage_path_t, path_item) {
398
399 new_path_item = malloc(sizeof(usb_hid_report_usage_path_t));
400 if(new_path_item == NULL) {
401 return NULL;
402 }
403
404 link_initialize(&new_path_item->rpath_items_link);
405 new_path_item->usage_page = path_item->usage_page;
406 new_path_item->usage = path_item->usage;
407 new_path_item->flags = path_item->flags;
408
409 list_append(&new_path_item->rpath_items_link,
410 &new_usage_path->items);
411 new_usage_path->depth++;
412 }
413
414 return new_usage_path;
415}
416
417
418/**
419 * Sets report id in usage path structure
420 *
421 * @param path Usage path structure
422 * @param report_id Report id to set
423 * @return Error code
424 */
425int usb_hid_report_path_set_report_id(usb_hid_report_path_t *path,
426 uint8_t report_id)
427{
428 if(path == NULL){
429 return EINVAL;
430 }
431
432 path->report_id = report_id;
433 return EOK;
434}
435
436/**
437 * @}
438 */
Note: See TracBrowser for help on using the repository browser.