deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* $NetBSD: usb.h,v 1.5 1999/07/02 15:46:53 simonb Exp $ */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * All rights reserved.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Redistribution and use in source and binary forms, with or without
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * modification, are permitted provided that the following conditions
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * are met:
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * 1. Redistributions of source code must retain the above copyright
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * notice, this list of conditions and the following disclaimer.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * 2. Redistributions in binary form must reproduce the above copyright
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * notice, this list of conditions and the following disclaimer in the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * documentation and/or other materials provided with the distribution.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * SUCH DAMAGE.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define _DIAGASSERT(e) assert(e)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct report_desc *report_desc_t;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct hid_data *hid_data_t;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef enum hid_kind {
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync hid_input, hid_output, hid_feature, hid_collection, hid_endcollection
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}hid_kind_t;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct hid_item {
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Global */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int _usage_page;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int logical_minimum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int logical_maximum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int physical_minimum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int physical_maximum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int unit_exponent;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int unit;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int report_size;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int report_ID;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int report_count;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Local */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned int usage;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int usage_minimum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int usage_maximum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int designator_index;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int designator_minimum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int designator_maximum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int string_index;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int string_minimum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int string_maximum;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int set_delimiter;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Misc */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int collection;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int collevel;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync enum hid_kind kind;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned int flags;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Absolute data position (bits) */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned int pos;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync struct hid_item *next;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} hid_item_t;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define HID_PAGE(u) ((u) >> 16)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define HID_USAGE(u) ((u) & 0xffff)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Obtaining a report descriptor, descr.c: */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncreport_desc_t hid_get_report_desc __P((int file));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncvoid hid_dispose_report_desc __P((report_desc_t));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Parsing of a HID report descriptor, parse.c: */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynchid_data_t hid_start_parse __P((report_desc_t d, int kindset));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncvoid hid_end_parse __P((hid_data_t s));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncint hid_get_item __P((hid_data_t s, hid_item_t *h));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncint hid_report_size __P((report_desc_t d, enum hid_kind k, int *idp));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncint hid_locate __P((report_desc_t d, unsigned int usage, enum hid_kind k, hid_item_t *h));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Conversion to/from usage names, usage.c: */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncchar *hid_usage_page __P((int i));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncchar *hid_usage_in_page __P((unsigned int u));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncvoid hid_init __P((char *file));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Extracting/insertion of data, data.c: */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncint hid_get_data __P((void *p, hid_item_t *h));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncvoid hid_set_data __P((void *p, hid_item_t *h, int data));