5 * $Id: hiddev.h,v 1.2 2001/04/26 11:26:09 vojtech Exp $
7 * Copyright (c) 1999-2000 Vojtech Pavlik
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 * Should you need to contact me, the author, you can do so either by
28 * e-mail - mail your message to <vojtech@suse.cz>, or by paper mail:
29 * Vojtech Pavlik, Ucitelska 1576, Prague 8, 182 00 Czech Republic
33 * The event structure itself
41 struct hiddev_devinfo
{
49 __u32 num_applications
;
52 struct hiddev_collection_info
{
59 #define HID_STRING_SIZE 256
60 struct hiddev_string_descriptor
{
62 char value
[HID_STRING_SIZE
];
65 struct hiddev_report_info
{
71 /* To do a GUSAGE/SUSAGE, fill in at least usage_code, report_type and
72 * report_id. Set report_id to REPORT_ID_UNKNOWN if the rest of the fields
73 * are unknown. Otherwise use a usage_ref struct filled in from a previous
74 * successful GUSAGE call to save time. To actually send a value to the
75 * device, perform a SUSAGE first, followed by a SREPORT. An INITREPORT or a
76 * GREPORT isn't necessary for a GUSAGE to return valid data.
78 #define HID_REPORT_ID_UNKNOWN 0xffffffff
79 #define HID_REPORT_ID_FIRST 0x00000100
80 #define HID_REPORT_ID_NEXT 0x00000200
81 #define HID_REPORT_ID_MASK 0x000000ff
82 #define HID_REPORT_ID_MAX 0x000000ff
84 #define HID_REPORT_TYPE_INPUT 1
85 #define HID_REPORT_TYPE_OUTPUT 2
86 #define HID_REPORT_TYPE_FEATURE 3
87 #define HID_REPORT_TYPE_MIN 1
88 #define HID_REPORT_TYPE_MAX 3
90 struct hiddev_field_info
{
96 __u32 physical
; /* physical usage for this field */
97 __u32 logical
; /* logical usage for this field */
98 __u32 application
; /* application usage for this field */
99 __s32 logical_minimum
;
100 __s32 logical_maximum
;
101 __s32 physical_minimum
;
102 __s32 physical_maximum
;
107 /* Fill in report_type, report_id and field_index to get the information on a
110 #define HID_FIELD_CONSTANT 0x001
111 #define HID_FIELD_VARIABLE 0x002
112 #define HID_FIELD_RELATIVE 0x004
113 #define HID_FIELD_WRAP 0x008
114 #define HID_FIELD_NONLINEAR 0x010
115 #define HID_FIELD_NO_PREFERRED 0x020
116 #define HID_FIELD_NULL_STATE 0x040
117 #define HID_FIELD_VOLATILE 0x080
118 #define HID_FIELD_BUFFERED_BYTE 0x100
120 struct hiddev_usage_ref
{
129 /* hiddev_usage_ref_multi is used for sending multiple bytes to a control.
130 * It really manifests itself as setting the value of consecutive usages */
131 #define HID_MAX_MULTI_USAGES 1024
132 struct hiddev_usage_ref_multi
{
133 struct hiddev_usage_ref uref
;
135 __s32 values
[HID_MAX_MULTI_USAGES
];
138 /* FIELD_INDEX_NONE is returned in read() data from the kernel when flags
139 * is set to (HIDDEV_FLAG_UREF | HIDDEV_FLAG_REPORT) and a new report has
140 * been sent by the device
142 #define HID_FIELD_INDEX_NONE 0xffffffff
148 #define HID_VERSION 0x010004
151 * IOCTLs (0x00 - 0x7f)
154 #define HIDIOCGVERSION _IOR('H', 0x01, int)
155 #define HIDIOCAPPLICATION _IO('H', 0x02)
156 #define HIDIOCGDEVINFO _IOR('H', 0x03, struct hiddev_devinfo)
157 #define HIDIOCGSTRING _IOR('H', 0x04, struct hiddev_string_descriptor)
158 #define HIDIOCINITREPORT _IO('H', 0x05)
159 #define HIDIOCGNAME(len) _IOC(_IOC_READ, 'H', 0x06, len)
160 #define HIDIOCGREPORT _IOW('H', 0x07, struct hiddev_report_info)
161 #define HIDIOCSREPORT _IOW('H', 0x08, struct hiddev_report_info)
162 #define HIDIOCGREPORTINFO _IOWR('H', 0x09, struct hiddev_report_info)
163 #define HIDIOCGFIELDINFO _IOWR('H', 0x0A, struct hiddev_field_info)
164 #define HIDIOCGUSAGE _IOWR('H', 0x0B, struct hiddev_usage_ref)
165 #define HIDIOCSUSAGE _IOW('H', 0x0C, struct hiddev_usage_ref)
166 #define HIDIOCGUCODE _IOWR('H', 0x0D, struct hiddev_usage_ref)
167 #define HIDIOCGFLAG _IOR('H', 0x0E, int)
168 #define HIDIOCSFLAG _IOW('H', 0x0F, int)
169 #define HIDIOCGCOLLECTIONINDEX _IOW('H', 0x10, struct hiddev_usage_ref)
170 #define HIDIOCGCOLLECTIONINFO _IOWR('H', 0x11, struct hiddev_collection_info)
171 #define HIDIOCGPHYS(len) _IOC(_IOC_READ, 'H', 0x12, len)
173 /* For writing/reading to multiple/consecutive usages */
174 #define HIDIOCGUSAGES _IOWR('H', 0x13, struct hiddev_usage_ref_multi)
175 #define HIDIOCSUSAGES _IOW('H', 0x14, struct hiddev_usage_ref_multi)
178 * Flags to be used in HIDIOCSFLAG
180 #define HIDDEV_FLAG_UREF 0x1
181 #define HIDDEV_FLAG_REPORT 0x2
182 #define HIDDEV_FLAGS 0x3
184 /* To traverse the input report descriptor info for a HID device, perform the
187 * rinfo.report_type = HID_REPORT_TYPE_INPUT;
188 * rinfo.report_id = HID_REPORT_ID_FIRST;
189 * ret = ioctl(fd, HIDIOCGREPORTINFO, &rinfo);
192 * for (i = 0; i < rinfo.num_fields; i++) {
193 * finfo.report_type = rinfo.report_type;
194 * finfo.report_id = rinfo.report_id;
195 * finfo.field_index = i;
196 * ioctl(fd, HIDIOCGFIELDINFO, &finfo);
197 * for (j = 0; j < finfo.maxusage; j++) {
198 * uref.field_index = i;
199 * uref.usage_index = j;
200 * ioctl(fd, HIDIOCGUCODE, &uref);
201 * ioctl(fd, HIDIOCGUSAGE, &uref);
204 * rinfo.report_id |= HID_REPORT_ID_NEXT;
205 * ret = ioctl(fd, HIDIOCGREPORTINFO, &rinfo);
213 * In-kernel definitions.
221 #ifdef CONFIG_USB_HIDDEV
222 int hiddev_connect(struct hid_device
*);
223 void hiddev_disconnect(struct hid_device
*);
224 void hiddev_hid_event(struct hid_device
*hid
, struct hid_field
*field
,
225 struct hid_usage
*usage
, __s32 value
);
226 void hiddev_report_event(struct hid_device
*hid
, struct hid_report
*report
);
227 int __init
hiddev_init(void);
228 void hiddev_exit(void);
230 static inline int hiddev_connect(struct hid_device
*hid
) { return -1; }
231 static inline void hiddev_disconnect(struct hid_device
*hid
) { }
232 static inline void hiddev_hid_event(struct hid_device
*hid
, struct hid_field
*field
,
233 struct hid_usage
*usage
, __s32 value
) { }
234 static inline void hiddev_report_event(struct hid_device
*hid
, struct hid_report
*report
) { }
235 static inline int hiddev_init(void) { return 0; }
236 static inline void hiddev_exit(void) { }
This page took 0.035655 seconds and 5 git commands to generate.