lib/libusbhid/usbhid.h

   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: src/lib/libusbhid/usbhid.h,v 1.11 2004/06/03 15:04:24 des Exp $
  29  * $DragonFly: src/lib/libusbhid/usbhid.h,v 1.1 2008/11/24 17:15:17 hasso Exp $
  30  */
  31
  32 #include <sys/cdefs.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 = 0,
  40         hid_output = 1,
  41         hid_feature = 2,
  42         hid_collection,
  43         hid_endcollection
  44 } hid_kind_t;
  45
  46 typedef struct hid_item {
  47         /* Global */
  48         unsigned int _usage_page;
  49         int logical_minimum;
  50         int logical_maximum;
  51         int physical_minimum;
  52         int physical_maximum;
  53         int unit_exponent;
  54         int unit;
  55         int report_size;
  56         int report_ID;
  57 #define NO_REPORT_ID 0
  58         int report_count;
  59         /* Local */
  60         unsigned int usage;
  61         int usage_minimum;
  62         int usage_maximum;
  63         int designator_index;
  64         int designator_minimum;
  65         int designator_maximum;
  66         int string_index;
  67         int string_minimum;
  68         int string_maximum;
  69         int set_delimiter;
  70         /* Misc */
  71         int collection;
  72         int collevel;
  73         enum hid_kind kind;
  74         unsigned int flags;
  75         /* Absolute data position (bits) */
  76         unsigned int pos;
  77         /* */
  78         struct hid_item *next;
  79 } hid_item_t;
  80
  81 #define HID_PAGE(u) (((u) >> 16) & 0xffff)
  82 #define HID_USAGE(u) ((u) & 0xffff)
  83
  84 __BEGIN_DECLS
  85
  86 /* Obtaining a report descriptor, descr.c: */
  87 report_desc_t hid_get_report_desc(int file);
  88 report_desc_t hid_use_report_desc(unsigned char *data, unsigned int size);
  89 void hid_dispose_report_desc(report_desc_t);
  90
  91 /* Parsing of a HID report descriptor, parse.c: */
  92 hid_data_t hid_start_parse(report_desc_t d, int kindset, int id);
  93 void hid_end_parse(hid_data_t s);
  94 int hid_get_item(hid_data_t s, hid_item_t *h);
  95 int hid_report_size(report_desc_t d, enum hid_kind k, int id);
  96 int hid_locate(report_desc_t d, unsigned int usage, enum hid_kind k, 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 int hid_get_data(const void *p, const hid_item_t *h);
 107 void hid_set_data(void *p, const hid_item_t *h, int data);
 108
 109 __END_DECLS