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: head/lib/libusbhid/usbhid.h 225839 2011-09-28 14:52:25Z mav $ 29 * 30 */ 31 32 #include <stdint.h> 33 34 typedef struct report_desc *report_desc_t; 35 36 typedef struct hid_data *hid_data_t; 37 38 typedef enum hid_kind { 39 hid_input, hid_output, hid_feature, hid_collection, hid_endcollection 40 } hid_kind_t; 41 42 typedef struct hid_item { 43 /* Global */ 44 uint32_t _usage_page; 45 int32_t logical_minimum; 46 int32_t logical_maximum; 47 int32_t physical_minimum; 48 int32_t physical_maximum; 49 int32_t unit_exponent; 50 int32_t unit; 51 int32_t report_size; 52 int32_t report_ID; 53 #define NO_REPORT_ID 0 54 int32_t report_count; 55 /* Local */ 56 uint32_t usage; 57 int32_t usage_minimum; 58 int32_t usage_maximum; 59 int32_t designator_index; 60 int32_t designator_minimum; 61 int32_t designator_maximum; 62 int32_t string_index; 63 int32_t string_minimum; 64 int32_t string_maximum; 65 int32_t set_delimiter; 66 /* Misc */ 67 int32_t collection; 68 int collevel; 69 enum hid_kind kind; 70 uint32_t flags; 71 /* Location */ 72 uint32_t pos; 73 /* unused */ 74 struct hid_item *next; 75 } hid_item_t; 76 77 #define HID_PAGE(u) (((u) >> 16) & 0xffff) 78 #define HID_USAGE(u) ((u) & 0xffff) 79 #define HID_HAS_GET_SET_REPORT 1 80 81 __BEGIN_DECLS 82 83 /* Obtaining a report descriptor, descr.c: */ 84 report_desc_t hid_get_report_desc(int file); 85 report_desc_t hid_use_report_desc(unsigned char *data, unsigned int size); 86 void hid_dispose_report_desc(report_desc_t); 87 int hid_get_report_id(int file); 88 int hid_set_immed(int fd, int enable); 89 90 /* Parsing of a HID report descriptor, parse.c: */ 91 hid_data_t hid_start_parse(report_desc_t d, int kindset, int id); 92 void hid_end_parse(hid_data_t s); 93 int hid_get_item(hid_data_t s, hid_item_t *h); 94 int hid_report_size(report_desc_t d, enum hid_kind k, int id); 95 int hid_locate(report_desc_t d, unsigned int usage, enum hid_kind k, 96 hid_item_t *h, int id); 97 98 /* Conversion to/from usage names, usage.c: */ 99 const char *hid_usage_page(int i); 100 const char *hid_usage_in_page(unsigned int u); 101 void hid_init(const char *file); 102 int hid_parse_usage_in_page(const char *name); 103 int hid_parse_usage_page(const char *name); 104 105 /* Extracting/insertion of data, data.c: */ 106 int32_t hid_get_data(const void *p, const hid_item_t *h); 107 void hid_set_data(void *p, const hid_item_t *h, int32_t data); 108 int hid_get_report(int fd, enum hid_kind k, 109 unsigned char *data, unsigned int size); 110 int hid_set_report(int fd, enum hid_kind k, 111 unsigned char *data, unsigned int size); 112 113 __END_DECLS 114