hidparser.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2011 Matej Klonfar
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  *
00009  * - Redistributions of source code must retain the above copyright
00010  *   notice, this list of conditions and the following disclaimer.
00011  * - Redistributions in binary form must reproduce the above copyright
00012  *   notice, this list of conditions and the following disclaimer in the
00013  *   documentation and/or other materials provided with the distribution.
00014  * - The name of the author may not be used to endorse or promote products
00015  *   derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00019  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00020  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00022  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00023  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00024  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00025  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00026  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  */
00028 
00035 #ifndef LIBUSBHID_HIDPARSER_H_
00036 #define LIBUSBHID_HIDPARSER_H_
00037 
00038 #include <stdint.h>
00039 #include <adt/list.h>
00040 #include <usb/hid/hid_report_items.h>
00041 #include <usb/hid/hidpath.h>
00042 #include <usb/hid/hidtypes.h>
00043 #include <usb/hid/hiddescriptor.h>
00044 
00045 
00046 /*
00047  * Input report parser functions
00048  */
00049 int usb_hid_parse_report(const usb_hid_report_t *report, const uint8_t *data,
00050                 size_t size, uint8_t *report_id);
00051 
00052 /*
00053  * Output report parser functions
00054  */
00055 uint8_t *usb_hid_report_output(usb_hid_report_t *report, size_t *size, 
00056                 uint8_t report_id);
00057 
00058 void usb_hid_report_output_free(uint8_t *output);
00059 
00060 size_t usb_hid_report_size(usb_hid_report_t *report, uint8_t report_id,
00061                 usb_hid_report_type_t type);
00062 
00063 size_t usb_hid_report_byte_size(usb_hid_report_t *report, uint8_t report_id,
00064                 usb_hid_report_type_t type);
00065 
00066 
00067 int usb_hid_report_output_translate(usb_hid_report_t *report, 
00068                 uint8_t report_id, uint8_t *buffer, size_t size);
00069 
00070 
00071 /*
00072  * Report descriptor structure observing functions
00073  */
00074 usb_hid_report_field_t *usb_hid_report_get_sibling(usb_hid_report_t *report,
00075                 usb_hid_report_field_t *field, usb_hid_report_path_t *path,
00076                 int flags, usb_hid_report_type_t type);
00077 
00078 uint8_t usb_hid_get_next_report_id(usb_hid_report_t *report, 
00079                 uint8_t report_id, usb_hid_report_type_t type);
00080 
00081 #endif
00082 

Generated on Thu Jun 2 07:45:48 2011 for HelenOS/USB by  doxygen 1.4.7