1 /* $NetBSD: usbhid.h,v 1.1 2001/12/28 17:45:27 augustss Exp $ */ 2 3 /* 4 * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 typedef struct report_desc *report_desc_t; 30 31 typedef struct hid_data *hid_data_t; 32 33 typedef enum hid_kind { 34 hid_input = 0, 35 hid_output = 1, 36 hid_feature = 2, 37 hid_collection, 38 hid_endcollection 39 } hid_kind_t; 40 41 typedef struct hid_item { 42 /* Global */ 43 int _usage_page; 44 int logical_minimum; 45 int logical_maximum; 46 int physical_minimum; 47 int physical_maximum; 48 int unit_exponent; 49 int unit; 50 int report_size; 51 int report_ID; 52 #define NO_REPORT_ID 0 53 int report_count; 54 /* Local */ 55 unsigned int usage; 56 int usage_minimum; 57 int usage_maximum; 58 int designator_index; 59 int designator_minimum; 60 int designator_maximum; 61 int string_index; 62 int string_minimum; 63 int string_maximum; 64 int set_delimiter; 65 /* Misc */ 66 int collection; 67 int collevel; 68 enum hid_kind kind; 69 unsigned int flags; 70 /* Absolute data position (bits) */ 71 unsigned int pos; 72 /* */ 73 struct hid_item *next; 74 } hid_item_t; 75 76 #define HID_PAGE(u) (((u) >> 16) & 0xffff) 77 #define HID_USAGE(u) ((u) & 0xffff) 78 79 /* Obtaining a report descriptor, descr.c: */ 80 report_desc_t hid_get_report_desc(int file); 81 report_desc_t hid_use_report_desc(unsigned char *data, unsigned int size); 82 void hid_dispose_report_desc(report_desc_t); 83 84 /* Parsing of a HID report descriptor, parse.c: */ 85 hid_data_t hid_start_parse(report_desc_t d, int kindset, int id); 86 void hid_end_parse(hid_data_t s); 87 int hid_get_item(hid_data_t s, hid_item_t *h); 88 int hid_report_size(report_desc_t d, enum hid_kind k, int id); 89 int hid_locate(report_desc_t d, unsigned int usage, enum hid_kind k, hid_item_t *h, int id); 90 91 /* Conversion to/from usage names, usage.c: */ 92 const char *hid_usage_page(int i); 93 const char *hid_usage_in_page(unsigned int u); 94 void hid_init(const char *file); 95 int hid_parse_usage_in_page(const char *name); 96 int hid_parse_usage_page(const char *name); 97 98 /* Extracting/insertion of data, data.c: */ 99 int hid_get_data(const void *p, const hid_item_t *h); 100 void hid_set_data(void *p, const hid_item_t *h, int data); 101