sys/dev/usb/hid.h

   1 /*      $NetBSD: hid.h,v 1.11 2006/07/26 10:40:50 tron Exp $    */
   2 /*      $FreeBSD: src/sys/dev/usb/hid.h,v 1.7 1999/11/17 22:33:40 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  *
  21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 enum hid_kind {
  35         hid_input,
  36         hid_output,
  37         hid_feature,
  38         hid_collection,
  39         hid_endcollection,
  40         hid_none
  41 };
  42
  43 struct hid_location {
  44         u_int32_t size;
  45         u_int32_t count;
  46         u_int32_t pos;
  47 };
  48
  49 struct hid_item {
  50         /* Global */
  51         int32_t _usage_page;
  52         int32_t logical_minimum;
  53         int32_t logical_maximum;
  54         int32_t physical_minimum;
  55         int32_t physical_maximum;
  56         int32_t unit_exponent;
  57         int32_t unit;
  58         int32_t report_ID;
  59         /* Local */
  60         int32_t usage;
  61         int32_t usage_minimum;
  62         int32_t usage_maximum;
  63         int32_t designator_index;
  64         int32_t designator_minimum;
  65         int32_t designator_maximum;
  66         int32_t string_index;
  67         int32_t string_minimum;
  68         int32_t string_maximum;
  69         int32_t set_delimiter;
  70         /* Misc */
  71         int32_t collection;
  72         int collevel;
  73         enum hid_kind kind;
  74         u_int32_t flags;
  75         /* Location */
  76         struct hid_location loc;
  77         /* */
  78         struct hid_item *next;
  79 };
  80
  81 struct hid_data *hid_start_parse(const void *, int, enum hid_kind);
  82 void hid_end_parse(struct hid_data *);
  83 int hid_get_item(struct hid_data *, struct hid_item *);
  84 int hid_report_size(const void *, int, enum hid_kind, u_int8_t);
  85 int hid_locate(const void *, int, u_int32_t, u_int8_t, enum hid_kind,
  86     struct hid_location *, u_int32_t *);
  87 u_long hid_get_data(u_char *, struct hid_location *);
  88 int hid_is_collection(const void *, int, u_int8_t, u_int32_t);