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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 02246b8 was 6ff23ff, checked in by Jiri Svoboda <jiri@…>, 7 years ago

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