1/*	$NetBSD: usb.h,v 1.8 2000/08/13 22:22:02 augustss Exp $	*/
2
3/*-
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
5 *
6 * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 *
32 */
33
34#include <stdint.h>
35
36typedef struct report_desc *report_desc_t;
37
38typedef struct hid_data *hid_data_t;
39
40typedef enum hid_kind {
41	hid_input, hid_output, hid_feature, hid_collection, hid_endcollection
42} hid_kind_t;
43
44typedef struct hid_item {
45	/* Global */
46	uint32_t _usage_page;
47	int32_t logical_minimum;
48	int32_t logical_maximum;
49	int32_t physical_minimum;
50	int32_t physical_maximum;
51	int32_t unit_exponent;
52	int32_t unit;
53	int32_t report_size;
54	int32_t report_ID;
55#define NO_REPORT_ID 0
56	int32_t report_count;
57	/* Local */
58	uint32_t usage;
59	int32_t usage_minimum;
60	int32_t usage_maximum;
61	int32_t designator_index;
62	int32_t designator_minimum;
63	int32_t designator_maximum;
64	int32_t string_index;
65	int32_t string_minimum;
66	int32_t string_maximum;
67	int32_t set_delimiter;
68	/* Misc */
69	int32_t collection;
70	int	collevel;
71	enum hid_kind kind;
72	uint32_t flags;
73	/* Location */
74	uint32_t pos;
75	/* unused */
76	struct hid_item *next;
77} hid_item_t;
78
79#define HID_PAGE(u) (((u) >> 16) & 0xffff)
80#define HID_USAGE(u) ((u) & 0xffff)
81#define HID_HAS_GET_SET_REPORT 1
82
83__BEGIN_DECLS
84
85/* Obtaining a report descriptor, descr.c: */
86report_desc_t hid_get_report_desc(int file);
87report_desc_t hid_use_report_desc(unsigned char *data, unsigned int size);
88void hid_dispose_report_desc(report_desc_t);
89int hid_get_report_id(int file);
90int hid_set_immed(int fd, int enable);
91
92/* Parsing of a HID report descriptor, parse.c: */
93hid_data_t hid_start_parse(report_desc_t d, int kindset, int id);
94void hid_end_parse(hid_data_t s);
95int hid_get_item(hid_data_t s, hid_item_t *h);
96int hid_report_size(report_desc_t d, enum hid_kind k, int id);
97int hid_locate(report_desc_t d, unsigned int usage, enum hid_kind k,
98    hid_item_t *h, int id);
99
100/* Conversion to/from usage names, usage.c: */
101const char *hid_usage_page(int i);
102const char *hid_usage_in_page(unsigned int u);
103void hid_init(const char *file);
104int hid_parse_usage_in_page(const char *name);
105int hid_parse_usage_page(const char *name);
106
107/* Extracting/insertion of data, data.c: */
108int32_t hid_get_data(const void *p, const hid_item_t *h);
109void hid_set_data(void *p, const hid_item_t *h, int32_t data);
110int hid_get_report(int fd, enum hid_kind k,
111    unsigned char *data, unsigned int size);
112int hid_set_report(int fd, enum hid_kind k,
113    unsigned char *data, unsigned int size);
114
115__END_DECLS
116