sys/bus/usb/hid.h

   1 /*      $NetBSD: hid.h,v 1.5 2000/04/27 15:26:46 augustss Exp $ */
   2 /*      $FreeBSD: src/sys/dev/usb/hid.h,v 1.7.2.3 2000/10/31 23:23:29 n_hibma Exp $ */
   3 /*      $DragonFly: src/sys/bus/usb/hid.h,v 1.2 2003/06/17 04:28:32 dillon Exp $ */
   4
   5 /*
   6  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to The NetBSD Foundation
  10  * by Lennart Augustsson (lennart@augustsson.net) at
  11  * Carlstedt Research & Technology.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. All advertising materials mentioning features or use of this software
  22  *    must display the following acknowledgement:
  23  *        This product includes software developed by the NetBSD
  24  *        Foundation, Inc. and its contributors.
  25  * 4. Neither the name of The NetBSD Foundation nor the names of its
  26  *    contributors may be used to endorse or promote products derived
  27  *    from this software without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  30  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  31  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  32  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  33  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  34  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  35  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  36  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  37  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39  * POSSIBILITY OF SUCH DAMAGE.
  40  */
  41
  42 enum hid_kind {
  43         hid_input, hid_output, hid_feature, hid_collection, hid_endcollection
  44 };
  45
  46 struct hid_location {
  47         u_int32_t size;
  48         u_int32_t count;
  49         u_int32_t pos;
  50 };
  51
  52 struct hid_item {
  53         /* Global */
  54         int32_t _usage_page;
  55         int32_t logical_minimum;
  56         int32_t logical_maximum;
  57         int32_t physical_minimum;
  58         int32_t physical_maximum;
  59         int32_t unit_exponent;
  60         int32_t unit;
  61         int32_t report_ID;
  62         /* Local */
  63         int32_t usage;
  64         int32_t usage_minimum;
  65         int32_t usage_maximum;
  66         int32_t designator_index;
  67         int32_t designator_minimum;
  68         int32_t designator_maximum;
  69         int32_t string_index;
  70         int32_t string_minimum;
  71         int32_t string_maximum;
  72         int32_t set_delimiter;
  73         /* Misc */
  74         int32_t collection;
  75         int collevel;
  76         enum hid_kind kind;
  77         u_int32_t flags;
  78         /* Location */
  79         struct hid_location loc;
  80         /* */
  81         struct hid_item *next;
  82 };
  83
  84 struct hid_data *hid_start_parse(void *d, int len, int kindset);
  85 void hid_end_parse(struct hid_data *s);
  86 int hid_get_item(struct hid_data *s, struct hid_item *h);
  87 int hid_report_size(void *buf, int len, enum hid_kind k, u_int8_t *id);
  88 int hid_locate(void *desc, int size, u_int32_t usage,
  89                     enum hid_kind kind, struct hid_location *loc,
  90                     u_int32_t *flags);
  91 u_long hid_get_data(u_char *buf, struct hid_location *loc);
  92 int hid_is_collection(void *desc, int size, u_int32_t usage);