1 /* $NetBSD: usb.h,v 1.8 2000/08/13 22:22:02 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 * $FreeBSD$ 29 * 30 */ 31 32 typedef struct report_desc *report_desc_t; 33 34 typedef struct hid_data *hid_data_t; 35 36 typedef enum hid_kind { 37 hid_input, hid_output, hid_feature, hid_collection, hid_endcollection 38 } hid_kind_t; 39 40 typedef struct hid_item { 41 /* Global */ 42 int _usage_page; 43 int logical_minimum; 44 int logical_maximum; 45 int physical_minimum; 46 int physical_maximum; 47 int unit_exponent; 48 int unit; 49 int report_size; 50 int report_ID; 51 #define NO_REPORT_ID 0 52 int report_count; 53 /* Local */ 54 unsigned int usage; 55 int usage_minimum; 56 int usage_maximum; 57 int designator_index; 58 int designator_minimum; 59 int designator_maximum; 60 int string_index; 61 int string_minimum; 62 int string_maximum; 63 int set_delimiter; 64 /* Misc */ 65 int collection; 66 int collevel; 67 enum hid_kind kind; 68 unsigned int flags; 69 /* Absolute data position (bits) */ 70 unsigned int pos; 71 /* */ 72 struct hid_item *next; 73 } hid_item_t; 74 75 #define HID_PAGE(u) (((u) >> 16) & 0xffff) 76 #define HID_USAGE(u) ((u) & 0xffff) 77 78 /* Obtaining a report descriptor, descr.c: */ 79 report_desc_t hid_get_report_desc __P((int file)); 80 report_desc_t hid_use_report_desc __P((unsigned char *data, unsigned int size)); 81 void hid_dispose_report_desc __P((report_desc_t)); 82 83 /* Parsing of a HID report descriptor, parse.c: */ 84 hid_data_t hid_start_parse __P((report_desc_t d, int kindset)); 85 void hid_end_parse __P((hid_data_t s)); 86 int hid_get_item __P((hid_data_t s, hid_item_t *h)); 87 int hid_report_size __P((report_desc_t d, unsigned int id, enum hid_kind k)); 88 int hid_locate __P((report_desc_t d, unsigned int usage, enum hid_kind k, hid_item_t *h)); 89 90 /* Conversion to/from usage names, usage.c: */ 91 const char *hid_usage_page __P((int i)); 92 const char *hid_usage_in_page __P((unsigned int u)); 93 void hid_init __P((const char *file)); 94 95 /* Extracting/insertion of data, data.c: */ 96 int hid_get_data __P((const void *p, const hid_item_t *h)); 97 void hid_set_data __P((void *p, const hid_item_t *h, int data)); 98