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