| 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 | * USB HID report descriptor and report data parser
|
|---|
| 34 | */
|
|---|
| 35 | #ifndef LIBUSBHID_HIDPARSER_H_
|
|---|
| 36 | #define LIBUSBHID_HIDPARSER_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <stdint.h>
|
|---|
| 39 | #include <adt/list.h>
|
|---|
| 40 | #include <usb/hid/hid_report_items.h>
|
|---|
| 41 | #include <usb/hid/hidpath.h>
|
|---|
| 42 | #include <usb/hid/hidtypes.h>
|
|---|
| 43 | #include <usb/hid/hiddescriptor.h>
|
|---|
| 44 |
|
|---|
| 45 | /*
|
|---|
| 46 | * Input report parser functions
|
|---|
| 47 | */
|
|---|
| 48 | errno_t usb_hid_parse_report(const usb_hid_report_t *report, const uint8_t *data,
|
|---|
| 49 | size_t size, uint8_t *report_id);
|
|---|
| 50 |
|
|---|
| 51 | /*
|
|---|
| 52 | * Output report parser functions
|
|---|
| 53 | */
|
|---|
| 54 | uint8_t *usb_hid_report_output(usb_hid_report_t *report, size_t *size,
|
|---|
| 55 | uint8_t report_id);
|
|---|
| 56 |
|
|---|
| 57 | void usb_hid_report_output_free(uint8_t *output);
|
|---|
| 58 |
|
|---|
| 59 | size_t usb_hid_report_size(usb_hid_report_t *report, uint8_t report_id,
|
|---|
| 60 | usb_hid_report_type_t type);
|
|---|
| 61 |
|
|---|
| 62 | size_t usb_hid_report_byte_size(usb_hid_report_t *report, uint8_t report_id,
|
|---|
| 63 | usb_hid_report_type_t type);
|
|---|
| 64 |
|
|---|
| 65 | errno_t usb_hid_report_output_translate(usb_hid_report_t *report,
|
|---|
| 66 | uint8_t report_id, uint8_t *buffer, size_t size);
|
|---|
| 67 |
|
|---|
| 68 | /*
|
|---|
| 69 | * Report descriptor structure observing functions
|
|---|
| 70 | */
|
|---|
| 71 | usb_hid_report_field_t *usb_hid_report_get_sibling(usb_hid_report_t *report,
|
|---|
| 72 | usb_hid_report_field_t *field, usb_hid_report_path_t *path,
|
|---|
| 73 | int flags, usb_hid_report_type_t type);
|
|---|
| 74 |
|
|---|
| 75 | uint8_t usb_hid_get_next_report_id(usb_hid_report_t *report,
|
|---|
| 76 | uint8_t report_id, usb_hid_report_type_t type);
|
|---|
| 77 |
|
|---|
| 78 | #endif
|
|---|
| 79 | /**
|
|---|
| 80 | * @}
|
|---|
| 81 | */
|
|---|
