1/*	$NetBSD: usbhid.h,v 1.4 2007/03/23 21:37:45 drochner 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
29typedef struct report_desc *report_desc_t;
30
31typedef struct hid_data *hid_data_t;
32
33typedef enum hid_kind {
34	hid_input = 0,
35	hid_output = 1,
36	hid_feature = 2,
37	hid_collection,
38	hid_endcollection
39} hid_kind_t;
40
41typedef struct hid_item {
42	/* Global */
43	int _usage_page;
44	int logical_minimum;
45	int logical_maximum;
46	int physical_minimum;
47	int physical_maximum;
48	int unit_exponent;
49	int unit;
50	int report_size;
51	int report_ID;
52#define NO_REPORT_ID 0
53	int report_count;
54	/* Local */
55	unsigned int usage;
56	int usage_minimum;
57	int usage_maximum;
58	int designator_index;
59	int designator_minimum;
60	int designator_maximum;
61	int string_index;
62	int string_minimum;
63	int string_maximum;
64	int set_delimiter;
65	/* Misc */
66	int collection;
67	int collevel;
68	enum hid_kind kind;
69	unsigned int flags;
70	/* Absolute data position (bits) */
71	unsigned int pos;
72	/* */
73	struct hid_item *next;
74} hid_item_t;
75
76#define HID_PAGE(u) (((uint32_t)(u) >> 16) & 0xffff)
77#define HID_USAGE(u) ((u) & 0xffff)
78
79__BEGIN_DECLS
80
81/* Obtaining a report descriptor, descr.c: */
82report_desc_t hid_get_report_desc(int file);
83report_desc_t hid_use_report_desc(const uint8_t *data, unsigned int size);
84void hid_dispose_report_desc(report_desc_t);
85
86/* Parsing of a HID report descriptor, parse.c: */
87hid_data_t hid_start_parse(report_desc_t d, int kindset, int id);
88void hid_end_parse(hid_data_t s);
89int hid_get_item(hid_data_t s, hid_item_t *h);
90int hid_report_size(report_desc_t d, enum hid_kind k, int id);
91int hid_locate(report_desc_t d, unsigned int usage, enum hid_kind k, hid_item_t *h, int id);
92
93/* Conversion to/from usage names, usage.c: */
94const char *hid_usage_page(int i);
95const char *hid_usage_in_page(unsigned int u);
96void hid_init(const char *file);
97int hid_parse_usage_in_page(const char *name);
98int hid_parse_usage_page(const char *name);
99
100/* Extracting/insertion of data, data.c: */
101int hid_get_data(const void *p, const hid_item_t *h);
102void hid_set_data(void *p, const hid_item_t *h, int data);
103
104__END_DECLS
105