usbhid.c revision 1.30 1 1.30 mrg /* $NetBSD: usbhid.c,v 1.30 2006/05/10 21:53:48 mrg Exp $ */
2 1.1 augustss
3 1.1 augustss /*
4 1.18 augustss * Copyright (c) 2001 The NetBSD Foundation, Inc.
5 1.1 augustss * All rights reserved.
6 1.1 augustss *
7 1.5 augustss * This code is derived from software contributed to The NetBSD Foundation
8 1.15 augustss * by David Sainty <David.Sainty (at) dtsp.co.nz>
9 1.1 augustss *
10 1.1 augustss * Redistribution and use in source and binary forms, with or without
11 1.1 augustss * modification, are permitted provided that the following conditions
12 1.1 augustss * are met:
13 1.1 augustss * 1. Redistributions of source code must retain the above copyright
14 1.1 augustss * notice, this list of conditions and the following disclaimer.
15 1.1 augustss * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 augustss * notice, this list of conditions and the following disclaimer in the
17 1.1 augustss * documentation and/or other materials provided with the distribution.
18 1.1 augustss * 3. All advertising materials mentioning features or use of this software
19 1.1 augustss * must display the following acknowledgement:
20 1.1 augustss * This product includes software developed by the NetBSD
21 1.1 augustss * Foundation, Inc. and its contributors.
22 1.1 augustss * 4. Neither the name of The NetBSD Foundation nor the names of its
23 1.1 augustss * contributors may be used to endorse or promote products derived
24 1.1 augustss * from this software without specific prior written permission.
25 1.1 augustss *
26 1.1 augustss * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 1.1 augustss * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 1.1 augustss * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 1.1 augustss * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 1.1 augustss * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 1.1 augustss * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 1.1 augustss * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 1.1 augustss * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 1.1 augustss * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 1.1 augustss * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 1.1 augustss * POSSIBILITY OF SUCH DAMAGE.
37 1.1 augustss */
38 1.23 agc #include <sys/cdefs.h>
39 1.23 agc
40 1.23 agc #ifndef lint
41 1.30 mrg __RCSID("$NetBSD: usbhid.c,v 1.30 2006/05/10 21:53:48 mrg Exp $");
42 1.23 agc #endif
43 1.1 augustss
44 1.15 augustss #include <sys/types.h>
45 1.15 augustss
46 1.15 augustss #include <dev/usb/usb.h>
47 1.15 augustss #include <dev/usb/usbhid.h>
48 1.15 augustss
49 1.15 augustss #include <ctype.h>
50 1.15 augustss #include <err.h>
51 1.15 augustss #include <errno.h>
52 1.15 augustss #include <fcntl.h>
53 1.15 augustss #include <limits.h>
54 1.1 augustss #include <stdio.h>
55 1.1 augustss #include <stdlib.h>
56 1.14 matt #include <string.h>
57 1.1 augustss #include <unistd.h>
58 1.20 augustss #include <usbhid.h>
59 1.20 augustss
60 1.20 augustss /*
61 1.20 augustss * Zero if not in a verbose mode. Greater levels of verbosity
62 1.20 augustss * are indicated by values larger than one.
63 1.20 augustss */
64 1.20 augustss unsigned int verbose;
65 1.1 augustss
66 1.15 augustss /* Parser tokens */
67 1.15 augustss #define DELIM_USAGE '.'
68 1.15 augustss #define DELIM_PAGE ':'
69 1.15 augustss #define DELIM_SET '='
70 1.15 augustss
71 1.20 augustss static int reportid;
72 1.20 augustss
73 1.15 augustss struct Susbvar {
74 1.15 augustss /* Variable name, not NUL terminated */
75 1.15 augustss char const *variable;
76 1.15 augustss size_t varlen;
77 1.15 augustss
78 1.15 augustss char const *value; /* Value to set variable to */
79 1.15 augustss
80 1.15 augustss #define MATCH_ALL (1 << 0)
81 1.15 augustss #define MATCH_COLLECTIONS (1 << 1)
82 1.15 augustss #define MATCH_NODATA (1 << 2)
83 1.15 augustss #define MATCH_CONSTANTS (1 << 3)
84 1.15 augustss #define MATCH_WASMATCHED (1 << 4)
85 1.15 augustss #define MATCH_SHOWPAGENAME (1 << 5)
86 1.15 augustss #define MATCH_SHOWNUMERIC (1 << 6)
87 1.15 augustss #define MATCH_WRITABLE (1 << 7)
88 1.18 augustss #define MATCH_SHOWVALUES (1 << 8)
89 1.15 augustss unsigned int mflags;
90 1.15 augustss
91 1.15 augustss /* Workspace for hidmatch() */
92 1.15 augustss ssize_t matchindex;
93 1.15 augustss
94 1.15 augustss int (*opfunc)(struct hid_item *item, struct Susbvar *var,
95 1.15 augustss u_int32_t const *collist, size_t collen, u_char *buf);
96 1.15 augustss };
97 1.15 augustss
98 1.15 augustss struct Sreport {
99 1.15 augustss struct usb_ctl_report *buffer;
100 1.15 augustss
101 1.15 augustss enum {srs_uninit, srs_clean, srs_dirty} status;
102 1.15 augustss int report_id;
103 1.15 augustss size_t size;
104 1.15 augustss };
105 1.15 augustss
106 1.15 augustss static struct {
107 1.15 augustss int uhid_report;
108 1.15 augustss hid_kind_t hid_kind;
109 1.15 augustss char const *name;
110 1.15 augustss } const reptoparam[] = {
111 1.15 augustss #define REPORT_INPUT 0
112 1.15 augustss { UHID_INPUT_REPORT, hid_input, "input" },
113 1.15 augustss #define REPORT_OUTPUT 1
114 1.15 augustss { UHID_OUTPUT_REPORT, hid_output, "output" },
115 1.15 augustss #define REPORT_FEATURE 2
116 1.15 augustss { UHID_FEATURE_REPORT, hid_feature, "feature" }
117 1.15 augustss #define REPORT_MAXVAL 2
118 1.15 augustss };
119 1.15 augustss
120 1.18 augustss /*
121 1.18 augustss * Extract 16-bit unsigned usage ID from a numeric string. Returns -1
122 1.18 augustss * if string failed to parse correctly.
123 1.18 augustss */
124 1.18 augustss static int
125 1.18 augustss strtousage(const char *nptr, size_t nlen)
126 1.18 augustss {
127 1.18 augustss char *endptr;
128 1.18 augustss long result;
129 1.18 augustss char numstr[16];
130 1.18 augustss
131 1.18 augustss if (nlen >= sizeof(numstr) || !isdigit((unsigned char)*nptr))
132 1.18 augustss return -1;
133 1.18 augustss
134 1.18 augustss /*
135 1.18 augustss * We use strtol() here, but unfortunately strtol() requires a
136 1.18 augustss * NUL terminated string - which we don't have - at least not
137 1.18 augustss * officially.
138 1.18 augustss */
139 1.18 augustss memcpy(numstr, nptr, nlen);
140 1.18 augustss numstr[nlen] = '\0';
141 1.18 augustss
142 1.18 augustss result = strtol(numstr, &endptr, 0);
143 1.18 augustss
144 1.18 augustss if (result < 0 || result > 0xffff || endptr != &numstr[nlen])
145 1.18 augustss return -1;
146 1.18 augustss
147 1.18 augustss return result;
148 1.18 augustss }
149 1.18 augustss
150 1.18 augustss struct usagedata {
151 1.18 augustss char const *page_name;
152 1.18 augustss char const *usage_name;
153 1.18 augustss size_t page_len;
154 1.18 augustss size_t usage_len;
155 1.18 augustss int isfinal;
156 1.18 augustss u_int32_t usage_id;
157 1.18 augustss };
158 1.18 augustss
159 1.18 augustss /*
160 1.18 augustss * Test a rule against the current usage data. Returns -1 on no
161 1.18 augustss * match, 0 on partial match and 1 on complete match.
162 1.18 augustss */
163 1.18 augustss static int
164 1.18 augustss hidtestrule(struct Susbvar *var, struct usagedata *cache)
165 1.18 augustss {
166 1.18 augustss char const *varname;
167 1.18 augustss ssize_t matchindex, pagesplit;
168 1.18 augustss size_t strind, varlen;
169 1.18 augustss int numusage;
170 1.18 augustss u_int32_t usage_id;
171 1.18 augustss
172 1.18 augustss matchindex = var->matchindex;
173 1.18 augustss varname = var->variable;
174 1.18 augustss varlen = var->varlen;
175 1.18 augustss
176 1.18 augustss usage_id = cache->usage_id;
177 1.18 augustss
178 1.18 augustss /*
179 1.18 augustss * Parse the current variable name, locating the end of the
180 1.18 augustss * current 'usage', and possibly where the usage page name
181 1.18 augustss * ends.
182 1.18 augustss */
183 1.18 augustss pagesplit = -1;
184 1.18 augustss for (strind = matchindex; strind < varlen; strind++) {
185 1.18 augustss if (varname[strind] == DELIM_USAGE)
186 1.18 augustss break;
187 1.18 augustss if (varname[strind] == DELIM_PAGE)
188 1.18 augustss pagesplit = strind;
189 1.18 augustss }
190 1.18 augustss
191 1.18 augustss if (cache->isfinal && strind != varlen)
192 1.18 augustss /*
193 1.18 augustss * Variable name is too long (hit delimiter instead of
194 1.18 augustss * end-of-variable).
195 1.18 augustss */
196 1.18 augustss return -1;
197 1.18 augustss
198 1.18 augustss if (pagesplit >= 0) {
199 1.18 augustss /*
200 1.18 augustss * Page name was specified, determine whether it was
201 1.18 augustss * symbolic or numeric.
202 1.18 augustss */
203 1.18 augustss char const *strstart;
204 1.18 augustss int numpage;
205 1.18 augustss
206 1.18 augustss strstart = &varname[matchindex];
207 1.18 augustss
208 1.18 augustss numpage = strtousage(strstart, pagesplit - matchindex);
209 1.18 augustss
210 1.18 augustss if (numpage >= 0) {
211 1.18 augustss /* Valid numeric */
212 1.18 augustss
213 1.18 augustss if (numpage != HID_PAGE(usage_id))
214 1.18 augustss /* Numeric didn't match page ID */
215 1.18 augustss return -1;
216 1.18 augustss } else {
217 1.18 augustss /* Not a valid numeric */
218 1.18 augustss
219 1.18 augustss /*
220 1.18 augustss * Load and cache the page name if and only if
221 1.18 augustss * it hasn't already been loaded (it's a
222 1.18 augustss * fairly expensive operation).
223 1.18 augustss */
224 1.18 augustss if (cache->page_name == NULL) {
225 1.18 augustss cache->page_name = hid_usage_page(HID_PAGE(usage_id));
226 1.18 augustss cache->page_len = strlen(cache->page_name);
227 1.18 augustss }
228 1.18 augustss
229 1.18 augustss /*
230 1.18 augustss * Compare specified page name to actual page
231 1.18 augustss * name.
232 1.18 augustss */
233 1.18 augustss if (cache->page_len !=
234 1.18 augustss (size_t)(pagesplit - matchindex) ||
235 1.18 augustss memcmp(cache->page_name,
236 1.18 augustss &varname[matchindex],
237 1.18 augustss cache->page_len) != 0)
238 1.18 augustss /* Mismatch, page name wrong */
239 1.18 augustss return -1;
240 1.18 augustss }
241 1.18 augustss
242 1.18 augustss /* Page matches, discard page name */
243 1.18 augustss matchindex = pagesplit + 1;
244 1.18 augustss }
245 1.18 augustss
246 1.18 augustss numusage = strtousage(&varname[matchindex], strind - matchindex);
247 1.18 augustss
248 1.18 augustss if (numusage >= 0) {
249 1.18 augustss /* Valid numeric */
250 1.18 augustss
251 1.18 augustss if (numusage != HID_USAGE(usage_id))
252 1.18 augustss /* Numeric didn't match usage ID */
253 1.18 augustss return -1;
254 1.18 augustss } else {
255 1.18 augustss /* Not a valid numeric */
256 1.18 augustss
257 1.18 augustss /* Load and cache the usage name */
258 1.18 augustss if (cache->usage_name == NULL) {
259 1.18 augustss cache->usage_name = hid_usage_in_page(usage_id);
260 1.18 augustss cache->usage_len = strlen(cache->usage_name);
261 1.18 augustss }
262 1.18 augustss
263 1.18 augustss /*
264 1.18 augustss * Compare specified usage name to actual usage name
265 1.18 augustss */
266 1.18 augustss if (cache->usage_len != (size_t)(strind - matchindex) ||
267 1.18 augustss memcmp(cache->usage_name, &varname[matchindex],
268 1.18 augustss cache->usage_len) != 0)
269 1.18 augustss /* Mismatch, usage name wrong */
270 1.18 augustss return -1;
271 1.18 augustss }
272 1.18 augustss
273 1.18 augustss if (cache->isfinal)
274 1.18 augustss /* Match */
275 1.18 augustss return 1;
276 1.18 augustss
277 1.18 augustss /*
278 1.18 augustss * Partial match: Move index past this usage string +
279 1.18 augustss * delimiter
280 1.18 augustss */
281 1.18 augustss var->matchindex = strind + 1;
282 1.18 augustss
283 1.18 augustss return 0;
284 1.18 augustss }
285 1.18 augustss
286 1.18 augustss /*
287 1.18 augustss * hidmatch() determines whether the item specified in 'item', and
288 1.25 dsainty * nested within a hierarchy of collections specified in 'collist'
289 1.18 augustss * matches any of the rules in the list 'varlist'. Returns the
290 1.18 augustss * matching rule on success, or NULL on no match.
291 1.18 augustss */
292 1.15 augustss static struct Susbvar*
293 1.15 augustss hidmatch(u_int32_t const *collist, size_t collen, struct hid_item *item,
294 1.15 augustss struct Susbvar *varlist, size_t vlsize)
295 1.15 augustss {
296 1.18 augustss size_t colind, vlactive, vlind;
297 1.15 augustss int iscollection;
298 1.15 augustss
299 1.15 augustss /*
300 1.15 augustss * Keep track of how many variables are still "active". When
301 1.15 augustss * the active count reaches zero, don't bother to continue
302 1.15 augustss * looking for matches.
303 1.15 augustss */
304 1.15 augustss vlactive = vlsize;
305 1.15 augustss
306 1.15 augustss iscollection = item->kind == hid_collection ||
307 1.15 augustss item->kind == hid_endcollection;
308 1.15 augustss
309 1.15 augustss for (vlind = 0; vlind < vlsize; vlind++) {
310 1.15 augustss struct Susbvar *var;
311 1.15 augustss
312 1.15 augustss var = &varlist[vlind];
313 1.15 augustss
314 1.15 augustss var->matchindex = 0;
315 1.15 augustss
316 1.15 augustss if (!(var->mflags & MATCH_COLLECTIONS) && iscollection) {
317 1.15 augustss /* Don't match collections for this variable */
318 1.15 augustss var->matchindex = -1;
319 1.15 augustss vlactive--;
320 1.15 augustss } else if (!iscollection && !(var->mflags & MATCH_CONSTANTS) &&
321 1.15 augustss (item->flags & HIO_CONST)) {
322 1.15 augustss /*
323 1.15 augustss * Don't match constants for this variable,
324 1.15 augustss * but ignore the constant bit on collections.
325 1.15 augustss */
326 1.15 augustss var->matchindex = -1;
327 1.15 augustss vlactive--;
328 1.15 augustss } else if ((var->mflags & MATCH_WRITABLE) &&
329 1.15 augustss ((item->kind != hid_output &&
330 1.15 augustss item->kind != hid_feature) ||
331 1.15 augustss (item->flags & HIO_CONST))) {
332 1.15 augustss /*
333 1.15 augustss * If we are only matching writable items, if
334 1.15 augustss * this is not an output or feature kind, or
335 1.15 augustss * it is a constant, reject it.
336 1.15 augustss */
337 1.15 augustss var->matchindex = -1;
338 1.15 augustss vlactive--;
339 1.15 augustss } else if (var->mflags & MATCH_ALL) {
340 1.15 augustss /* Match immediately */
341 1.15 augustss return &varlist[vlind];
342 1.15 augustss }
343 1.15 augustss }
344 1.15 augustss
345 1.18 augustss /*
346 1.18 augustss * Loop through each usage in the collection list, including
347 1.18 augustss * the 'item' itself on the final iteration. For each usage,
348 1.18 augustss * test which variables named in the rule list are still
349 1.18 augustss * applicable - if any.
350 1.18 augustss */
351 1.15 augustss for (colind = 0; vlactive > 0 && colind <= collen; colind++) {
352 1.18 augustss struct usagedata cache;
353 1.15 augustss
354 1.30 mrg cache.page_len = 0; /* XXX gcc */
355 1.30 mrg cache.usage_len = 0; /* XXX gcc */
356 1.30 mrg
357 1.18 augustss cache.isfinal = (colind == collen);
358 1.18 augustss if (cache.isfinal)
359 1.18 augustss cache.usage_id = item->usage;
360 1.15 augustss else
361 1.18 augustss cache.usage_id = collist[colind];
362 1.15 augustss
363 1.18 augustss cache.usage_name = NULL;
364 1.18 augustss cache.page_name = NULL;
365 1.15 augustss
366 1.18 augustss /*
367 1.18 augustss * Loop through each rule, testing whether the rule is
368 1.18 augustss * still applicable or not. For each rule,
369 1.18 augustss * 'matchindex' retains the current match state as an
370 1.18 augustss * index into the variable name string, or -1 if this
371 1.18 augustss * rule has been proven not to match.
372 1.18 augustss */
373 1.15 augustss for (vlind = 0; vlind < vlsize; vlind++) {
374 1.15 augustss struct Susbvar *var;
375 1.18 augustss int matchres;
376 1.15 augustss
377 1.15 augustss var = &varlist[vlind];
378 1.15 augustss
379 1.18 augustss if (var->matchindex < 0)
380 1.15 augustss /* Mismatch at a previous level */
381 1.15 augustss continue;
382 1.15 augustss
383 1.18 augustss matchres = hidtestrule(var, &cache);
384 1.15 augustss
385 1.18 augustss if (matchres < 0) {
386 1.18 augustss /* Bad match */
387 1.15 augustss var->matchindex = -1;
388 1.15 augustss vlactive--;
389 1.15 augustss continue;
390 1.18 augustss } else if (matchres > 0) {
391 1.18 augustss /* Complete match */
392 1.18 augustss return var;
393 1.15 augustss }
394 1.15 augustss }
395 1.15 augustss }
396 1.15 augustss
397 1.15 augustss return NULL;
398 1.15 augustss }
399 1.15 augustss
400 1.15 augustss static void
401 1.15 augustss allocreport(struct Sreport *report, report_desc_t rd, int repindex)
402 1.15 augustss {
403 1.15 augustss int reptsize;
404 1.15 augustss
405 1.20 augustss reptsize = hid_report_size(rd, reptoparam[repindex].hid_kind, reportid);
406 1.15 augustss if (reptsize < 0)
407 1.15 augustss errx(1, "Negative report size");
408 1.15 augustss report->size = reptsize;
409 1.15 augustss
410 1.15 augustss if (report->size > 0) {
411 1.15 augustss /*
412 1.15 augustss * Allocate a buffer with enough space for the
413 1.15 augustss * report in the variable-sized data field.
414 1.15 augustss */
415 1.15 augustss report->buffer = malloc(sizeof(*report->buffer) -
416 1.22 christos sizeof(report->buffer->ucr_data) +
417 1.15 augustss report->size);
418 1.15 augustss if (report->buffer == NULL)
419 1.15 augustss err(1, NULL);
420 1.15 augustss } else
421 1.15 augustss report->buffer = NULL;
422 1.3 augustss
423 1.15 augustss report->status = srs_clean;
424 1.15 augustss }
425 1.15 augustss
426 1.15 augustss static void
427 1.15 augustss freereport(struct Sreport *report)
428 1.15 augustss {
429 1.15 augustss if (report->buffer != NULL)
430 1.15 augustss free(report->buffer);
431 1.15 augustss report->status = srs_uninit;
432 1.15 augustss }
433 1.15 augustss
434 1.15 augustss static void
435 1.15 augustss getreport(struct Sreport *report, int hidfd, report_desc_t rd, int repindex)
436 1.15 augustss {
437 1.15 augustss if (report->status == srs_uninit) {
438 1.15 augustss allocreport(report, rd, repindex);
439 1.15 augustss if (report->size == 0)
440 1.15 augustss return;
441 1.15 augustss
442 1.22 christos report->buffer->ucr_report = reptoparam[repindex].uhid_report;
443 1.15 augustss if (ioctl(hidfd, USB_GET_REPORT, report->buffer) < 0)
444 1.26 dsainty err(1, "USB_GET_REPORT(%s) [probably not supported by "
445 1.26 dsainty "device]",
446 1.26 dsainty reptoparam[repindex].name);
447 1.15 augustss }
448 1.15 augustss }
449 1.15 augustss
450 1.15 augustss static void
451 1.15 augustss setreport(struct Sreport *report, int hidfd, int repindex)
452 1.3 augustss {
453 1.15 augustss if (report->status == srs_dirty) {
454 1.22 christos report->buffer->ucr_report = reptoparam[repindex].uhid_report;
455 1.3 augustss
456 1.15 augustss if (ioctl(hidfd, USB_SET_REPORT, report->buffer) < 0)
457 1.15 augustss err(1, "USB_SET_REPORT(%s)",
458 1.15 augustss reptoparam[repindex].name);
459 1.15 augustss
460 1.15 augustss report->status = srs_clean;
461 1.15 augustss }
462 1.15 augustss }
463 1.15 augustss
464 1.15 augustss /* ARGSUSED1 */
465 1.15 augustss static int
466 1.15 augustss varop_value(struct hid_item *item, struct Susbvar *var,
467 1.15 augustss u_int32_t const *collist, size_t collen, u_char *buf)
468 1.15 augustss {
469 1.15 augustss printf("%d\n", hid_get_data(buf, item));
470 1.3 augustss return 0;
471 1.3 augustss }
472 1.1 augustss
473 1.15 augustss /* ARGSUSED1 */
474 1.15 augustss static int
475 1.15 augustss varop_display(struct hid_item *item, struct Susbvar *var,
476 1.15 augustss u_int32_t const *collist, size_t collen, u_char *buf)
477 1.1 augustss {
478 1.15 augustss size_t colitem;
479 1.21 augustss int val, i;
480 1.1 augustss
481 1.21 augustss for (i = 0; i < item->report_count; i++) {
482 1.21 augustss for (colitem = 0; colitem < collen; colitem++) {
483 1.21 augustss if (var->mflags & MATCH_SHOWPAGENAME)
484 1.21 augustss printf("%s:",
485 1.21 augustss hid_usage_page(HID_PAGE(collist[colitem])));
486 1.21 augustss printf("%s.", hid_usage_in_page(collist[colitem]));
487 1.21 augustss }
488 1.15 augustss if (var->mflags & MATCH_SHOWPAGENAME)
489 1.21 augustss printf("%s:", hid_usage_page(HID_PAGE(item->usage)));
490 1.21 augustss val = hid_get_data(buf, item);
491 1.21 augustss item->pos += item->report_size;
492 1.21 augustss if (item->usage_minimum != 0 || item->usage_maximum != 0) {
493 1.21 augustss val += item->usage_minimum;
494 1.21 augustss printf("%s=1", hid_usage_in_page(val));
495 1.21 augustss } else {
496 1.21 augustss printf("%s=%d%s", hid_usage_in_page(item->usage),
497 1.21 augustss val, item->flags & HIO_CONST ? " (const)" : "");
498 1.21 augustss }
499 1.21 augustss if (item->report_count > 1)
500 1.21 augustss printf(" [%d]", i);
501 1.21 augustss printf("\n");
502 1.15 augustss }
503 1.15 augustss return 0;
504 1.1 augustss }
505 1.1 augustss
506 1.15 augustss /* ARGSUSED1 */
507 1.15 augustss static int
508 1.15 augustss varop_modify(struct hid_item *item, struct Susbvar *var,
509 1.15 augustss u_int32_t const *collist, size_t collen, u_char *buf)
510 1.1 augustss {
511 1.15 augustss u_int dataval;
512 1.15 augustss
513 1.15 augustss dataval = (u_int)strtol(var->value, NULL, 10);
514 1.15 augustss
515 1.15 augustss hid_set_data(buf, item, dataval);
516 1.15 augustss
517 1.18 augustss if (var->mflags & MATCH_SHOWVALUES)
518 1.18 augustss /* Display set value */
519 1.15 augustss varop_display(item, var, collist, collen, buf);
520 1.1 augustss
521 1.15 augustss return 1;
522 1.1 augustss }
523 1.1 augustss
524 1.15 augustss static void
525 1.15 augustss reportitem(char const *label, struct hid_item const *item, unsigned int mflags)
526 1.8 augustss {
527 1.20 augustss int isconst = item->flags & HIO_CONST,
528 1.20 augustss isvar = item->flags & HIO_VARIABLE;
529 1.20 augustss printf("%s size=%d count=%d%s%s page=%s", label,
530 1.15 augustss item->report_size, item->report_count,
531 1.20 augustss isconst ? " Const" : "",
532 1.20 augustss !isvar && !isconst ? " Array" : "",
533 1.20 augustss hid_usage_page(HID_PAGE(item->usage)));
534 1.20 augustss if (item->usage_minimum != 0 || item->usage_maximum != 0) {
535 1.20 augustss printf(" usage=%s..%s", hid_usage_in_page(item->usage_minimum),
536 1.20 augustss hid_usage_in_page(item->usage_maximum));
537 1.20 augustss if (mflags & MATCH_SHOWNUMERIC)
538 1.20 augustss printf(" (%u:0x%x..%u:0x%x)",
539 1.20 augustss HID_PAGE(item->usage_minimum),
540 1.20 augustss HID_USAGE(item->usage_minimum),
541 1.20 augustss HID_PAGE(item->usage_maximum),
542 1.20 augustss HID_USAGE(item->usage_maximum));
543 1.20 augustss } else {
544 1.20 augustss printf(" usage=%s", hid_usage_in_page(item->usage));
545 1.20 augustss if (mflags & MATCH_SHOWNUMERIC)
546 1.20 augustss printf(" (%u:0x%x)",
547 1.20 augustss HID_PAGE(item->usage), HID_USAGE(item->usage));
548 1.20 augustss }
549 1.8 augustss printf(", logical range %d..%d",
550 1.15 augustss item->logical_minimum, item->logical_maximum);
551 1.15 augustss if (item->physical_minimum != item->physical_maximum)
552 1.8 augustss printf(", physical range %d..%d",
553 1.15 augustss item->physical_minimum, item->physical_maximum);
554 1.15 augustss if (item->unit)
555 1.15 augustss printf(", unit=0x%02x exp=%d", item->unit,
556 1.15 augustss item->unit_exponent);
557 1.8 augustss printf("\n");
558 1.8 augustss }
559 1.8 augustss
560 1.15 augustss /* ARGSUSED1 */
561 1.15 augustss static int
562 1.15 augustss varop_report(struct hid_item *item, struct Susbvar *var,
563 1.15 augustss u_int32_t const *collist, size_t collen, u_char *buf)
564 1.1 augustss {
565 1.15 augustss switch (item->kind) {
566 1.15 augustss case hid_collection:
567 1.18 augustss printf("Collection page=%s usage=%s",
568 1.15 augustss hid_usage_page(HID_PAGE(item->usage)),
569 1.15 augustss hid_usage_in_page(item->usage));
570 1.18 augustss if (var->mflags & MATCH_SHOWNUMERIC)
571 1.18 augustss printf(" (%u:0x%x)\n",
572 1.18 augustss HID_PAGE(item->usage), HID_USAGE(item->usage));
573 1.18 augustss else
574 1.18 augustss printf("\n");
575 1.15 augustss break;
576 1.15 augustss case hid_endcollection:
577 1.15 augustss printf("End collection\n");
578 1.15 augustss break;
579 1.15 augustss case hid_input:
580 1.15 augustss reportitem("Input ", item, var->mflags);
581 1.15 augustss break;
582 1.15 augustss case hid_output:
583 1.15 augustss reportitem("Output ", item, var->mflags);
584 1.15 augustss break;
585 1.15 augustss case hid_feature:
586 1.15 augustss reportitem("Feature", item, var->mflags);
587 1.15 augustss break;
588 1.15 augustss }
589 1.15 augustss
590 1.15 augustss return 0;
591 1.15 augustss }
592 1.15 augustss
593 1.15 augustss static void
594 1.15 augustss devloop(int hidfd, report_desc_t rd, struct Susbvar *varlist, size_t vlsize)
595 1.15 augustss {
596 1.18 augustss u_char *dbuf;
597 1.15 augustss struct hid_data *hdata;
598 1.18 augustss size_t collind, dlen;
599 1.15 augustss struct hid_item hitem;
600 1.28 jdolecek u_int32_t colls[256];
601 1.15 augustss struct Sreport inreport;
602 1.15 augustss
603 1.15 augustss allocreport(&inreport, rd, REPORT_INPUT);
604 1.15 augustss
605 1.15 augustss if (inreport.size <= 0)
606 1.15 augustss errx(1, "Input report descriptor invalid length");
607 1.15 augustss
608 1.15 augustss dlen = inreport.size;
609 1.22 christos dbuf = inreport.buffer->ucr_data;
610 1.15 augustss
611 1.15 augustss for (;;) {
612 1.15 augustss ssize_t readlen;
613 1.15 augustss
614 1.15 augustss readlen = read(hidfd, dbuf, dlen);
615 1.19 augustss if (readlen < 0)
616 1.19 augustss err(1, "Device read error");
617 1.19 augustss if (dlen != (size_t)readlen)
618 1.19 augustss errx(1, "Unexpected response length: %lu != %lu",
619 1.19 augustss (unsigned long)readlen, (unsigned long)dlen);
620 1.15 augustss
621 1.15 augustss collind = 0;
622 1.20 augustss hdata = hid_start_parse(rd, 1 << hid_input, reportid);
623 1.15 augustss if (hdata == NULL)
624 1.15 augustss errx(1, "Failed to start parser");
625 1.15 augustss
626 1.15 augustss while (hid_get_item(hdata, &hitem)) {
627 1.15 augustss struct Susbvar *matchvar;
628 1.15 augustss
629 1.15 augustss switch (hitem.kind) {
630 1.15 augustss case hid_collection:
631 1.15 augustss if (collind >= (sizeof(colls) / sizeof(*colls)))
632 1.15 augustss errx(1, "Excessive nested collections");
633 1.15 augustss colls[collind++] = hitem.usage;
634 1.15 augustss break;
635 1.15 augustss case hid_endcollection:
636 1.15 augustss if (collind == 0)
637 1.15 augustss errx(1, "Excessive collection ends");
638 1.15 augustss collind--;
639 1.15 augustss break;
640 1.15 augustss case hid_input:
641 1.15 augustss break;
642 1.15 augustss case hid_output:
643 1.15 augustss case hid_feature:
644 1.15 augustss errx(1, "Unexpected non-input item returned");
645 1.15 augustss }
646 1.15 augustss
647 1.20 augustss if (reportid != -1 && hitem.report_ID != reportid)
648 1.20 augustss continue;
649 1.20 augustss
650 1.15 augustss matchvar = hidmatch(colls, collind, &hitem,
651 1.15 augustss varlist, vlsize);
652 1.15 augustss
653 1.15 augustss if (matchvar != NULL)
654 1.15 augustss matchvar->opfunc(&hitem, matchvar,
655 1.15 augustss colls, collind,
656 1.22 christos inreport.buffer->ucr_data);
657 1.15 augustss }
658 1.15 augustss hid_end_parse(hdata);
659 1.15 augustss printf("\n");
660 1.15 augustss }
661 1.15 augustss /* NOTREACHED */
662 1.15 augustss }
663 1.15 augustss
664 1.15 augustss static void
665 1.15 augustss devshow(int hidfd, report_desc_t rd, struct Susbvar *varlist, size_t vlsize,
666 1.15 augustss int kindset)
667 1.15 augustss {
668 1.15 augustss struct hid_data *hdata;
669 1.18 augustss size_t collind, repind, vlind;
670 1.15 augustss struct hid_item hitem;
671 1.28 jdolecek u_int32_t colls[256];
672 1.15 augustss struct Sreport reports[REPORT_MAXVAL + 1];
673 1.1 augustss
674 1.15 augustss
675 1.15 augustss for (repind = 0; repind < (sizeof(reports) / sizeof(*reports));
676 1.15 augustss repind++) {
677 1.15 augustss reports[repind].status = srs_uninit;
678 1.15 augustss reports[repind].buffer = NULL;
679 1.15 augustss }
680 1.15 augustss
681 1.15 augustss collind = 0;
682 1.20 augustss hdata = hid_start_parse(rd, kindset, reportid);
683 1.15 augustss if (hdata == NULL)
684 1.15 augustss errx(1, "Failed to start parser");
685 1.15 augustss
686 1.15 augustss while (hid_get_item(hdata, &hitem)) {
687 1.15 augustss struct Susbvar *matchvar;
688 1.15 augustss int repindex;
689 1.15 augustss
690 1.20 augustss if (verbose > 3)
691 1.20 augustss printf("item: kind=%d repid=%d usage=0x%x\n",
692 1.20 augustss hitem.kind, hitem.report_ID, hitem.usage);
693 1.15 augustss repindex = -1;
694 1.15 augustss switch (hitem.kind) {
695 1.1 augustss case hid_collection:
696 1.15 augustss if (collind >= (sizeof(colls) / sizeof(*colls)))
697 1.15 augustss errx(1, "Excessive nested collections");
698 1.15 augustss colls[collind++] = hitem.usage;
699 1.1 augustss break;
700 1.1 augustss case hid_endcollection:
701 1.15 augustss if (collind == 0)
702 1.15 augustss errx(1, "Excessive collection ends");
703 1.15 augustss collind--;
704 1.1 augustss break;
705 1.1 augustss case hid_input:
706 1.15 augustss repindex = REPORT_INPUT;
707 1.1 augustss break;
708 1.1 augustss case hid_output:
709 1.15 augustss repindex = REPORT_OUTPUT;
710 1.1 augustss break;
711 1.1 augustss case hid_feature:
712 1.15 augustss repindex = REPORT_FEATURE;
713 1.1 augustss break;
714 1.1 augustss }
715 1.15 augustss
716 1.20 augustss if (reportid != -1 && hitem.report_ID != reportid)
717 1.20 augustss continue;
718 1.20 augustss
719 1.15 augustss matchvar = hidmatch(colls, collind, &hitem, varlist, vlsize);
720 1.15 augustss
721 1.15 augustss if (matchvar != NULL) {
722 1.15 augustss u_char *bufdata;
723 1.15 augustss struct Sreport *repptr;
724 1.15 augustss
725 1.15 augustss matchvar->mflags |= MATCH_WASMATCHED;
726 1.15 augustss
727 1.15 augustss if (repindex >= 0)
728 1.15 augustss repptr = &reports[repindex];
729 1.15 augustss else
730 1.15 augustss repptr = NULL;
731 1.15 augustss
732 1.15 augustss if (repptr != NULL &&
733 1.15 augustss !(matchvar->mflags & MATCH_NODATA))
734 1.15 augustss getreport(repptr, hidfd, rd, repindex);
735 1.15 augustss
736 1.15 augustss bufdata = (repptr == NULL || repptr->buffer == NULL) ?
737 1.22 christos NULL : repptr->buffer->ucr_data;
738 1.15 augustss
739 1.15 augustss if (matchvar->opfunc(&hitem, matchvar, colls, collind,
740 1.29 christos bufdata) && repptr)
741 1.15 augustss repptr->status = srs_dirty;
742 1.15 augustss }
743 1.1 augustss }
744 1.15 augustss hid_end_parse(hdata);
745 1.15 augustss
746 1.15 augustss for (repind = 0; repind < (sizeof(reports) / sizeof(*reports));
747 1.15 augustss repind++) {
748 1.15 augustss setreport(&reports[repind], hidfd, repind);
749 1.15 augustss freereport(&reports[repind]);
750 1.15 augustss }
751 1.15 augustss
752 1.15 augustss /* Warn about any items that we couldn't find a match for */
753 1.15 augustss for (vlind = 0; vlind < vlsize; vlind++) {
754 1.15 augustss struct Susbvar *var;
755 1.15 augustss
756 1.15 augustss var = &varlist[vlind];
757 1.15 augustss
758 1.15 augustss if (var->variable != NULL &&
759 1.15 augustss !(var->mflags & MATCH_WASMATCHED))
760 1.15 augustss warnx("Failed to match: %.*s", (int)var->varlen,
761 1.15 augustss var->variable);
762 1.1 augustss }
763 1.1 augustss }
764 1.1 augustss
765 1.15 augustss static void
766 1.15 augustss usage(void)
767 1.1 augustss {
768 1.16 cgd const char *progname = getprogname();
769 1.1 augustss
770 1.24 jmmv fprintf(stderr, "usage: %s -f device [-t tablefile] [-l] [-v] -a\n",
771 1.17 simonb progname);
772 1.17 simonb fprintf(stderr, " %s -f device [-t tablefile] [-v] -r\n",
773 1.17 simonb progname);
774 1.17 simonb fprintf(stderr,
775 1.17 simonb " %s -f device [-t tablefile] [-l] [-n] [-v] name ...\n",
776 1.17 simonb progname);
777 1.17 simonb fprintf(stderr,
778 1.17 simonb " %s -f device [-t tablefile] -w name=value ...\n",
779 1.17 simonb progname);
780 1.15 augustss exit(1);
781 1.1 augustss }
782 1.1 augustss
783 1.1 augustss int
784 1.1 augustss main(int argc, char **argv)
785 1.1 augustss {
786 1.18 augustss char const *dev;
787 1.18 augustss char const *table;
788 1.18 augustss size_t varnum;
789 1.18 augustss int aflag, lflag, nflag, rflag, wflag;
790 1.18 augustss int ch, hidfd;
791 1.15 augustss report_desc_t repdesc;
792 1.15 augustss char devnamebuf[PATH_MAX];
793 1.15 augustss struct Susbvar variables[128];
794 1.15 augustss
795 1.15 augustss wflag = aflag = nflag = verbose = rflag = lflag = 0;
796 1.15 augustss dev = NULL;
797 1.15 augustss table = NULL;
798 1.15 augustss while ((ch = getopt(argc, argv, "?af:lnrt:vw")) != -1) {
799 1.15 augustss switch (ch) {
800 1.3 augustss case 'a':
801 1.15 augustss aflag = 1;
802 1.3 augustss break;
803 1.1 augustss case 'f':
804 1.1 augustss dev = optarg;
805 1.1 augustss break;
806 1.1 augustss case 'l':
807 1.15 augustss lflag = 1;
808 1.1 augustss break;
809 1.1 augustss case 'n':
810 1.15 augustss nflag = 1;
811 1.1 augustss break;
812 1.1 augustss case 'r':
813 1.15 augustss rflag = 1;
814 1.1 augustss break;
815 1.1 augustss case 't':
816 1.1 augustss table = optarg;
817 1.1 augustss break;
818 1.1 augustss case 'v':
819 1.1 augustss verbose++;
820 1.1 augustss break;
821 1.15 augustss case 'w':
822 1.15 augustss wflag = 1;
823 1.15 augustss break;
824 1.1 augustss case '?':
825 1.1 augustss default:
826 1.1 augustss usage();
827 1.15 augustss /* NOTREACHED */
828 1.1 augustss }
829 1.1 augustss }
830 1.1 augustss argc -= optind;
831 1.1 augustss argv += optind;
832 1.15 augustss if (dev == NULL || (lflag && (wflag || rflag))) {
833 1.15 augustss /*
834 1.15 augustss * No device specified, or attempting to loop and set
835 1.15 augustss * or dump report at the same time
836 1.15 augustss */
837 1.1 augustss usage();
838 1.15 augustss /* NOTREACHED */
839 1.15 augustss }
840 1.15 augustss
841 1.15 augustss for (varnum = 0; varnum < (size_t)argc; varnum++) {
842 1.15 augustss char const *name, *valuesep;
843 1.15 augustss struct Susbvar *svar;
844 1.15 augustss
845 1.15 augustss svar = &variables[varnum];
846 1.15 augustss name = argv[varnum];
847 1.15 augustss valuesep = strchr(name, DELIM_SET);
848 1.15 augustss
849 1.15 augustss svar->variable = name;
850 1.15 augustss svar->mflags = 0;
851 1.15 augustss
852 1.15 augustss if (valuesep == NULL) {
853 1.15 augustss /* Read variable */
854 1.15 augustss if (wflag)
855 1.15 augustss errx(1, "Must not specify -w to read variables");
856 1.15 augustss svar->value = NULL;
857 1.15 augustss svar->varlen = strlen(name);
858 1.15 augustss
859 1.15 augustss if (nflag) {
860 1.15 augustss /* Display value of variable only */
861 1.15 augustss svar->opfunc = varop_value;
862 1.15 augustss } else {
863 1.15 augustss /* Display name and value of variable */
864 1.15 augustss svar->opfunc = varop_display;
865 1.15 augustss
866 1.15 augustss if (verbose >= 1)
867 1.15 augustss /* Show page names in verbose modes */
868 1.15 augustss svar->mflags |= MATCH_SHOWPAGENAME;
869 1.15 augustss }
870 1.15 augustss } else {
871 1.15 augustss /* Write variable */
872 1.15 augustss if (!wflag)
873 1.15 augustss errx(2, "Must specify -w to set variables");
874 1.15 augustss svar->mflags |= MATCH_WRITABLE;
875 1.18 augustss if (verbose >= 1)
876 1.18 augustss /*
877 1.18 augustss * Allow displaying of set value in
878 1.18 augustss * verbose mode. This isn't
879 1.18 augustss * particularly useful though, so
880 1.18 augustss * don't bother documenting it.
881 1.18 augustss */
882 1.18 augustss svar->mflags |= MATCH_SHOWVALUES;
883 1.15 augustss svar->varlen = valuesep - name;
884 1.15 augustss svar->value = valuesep + 1;
885 1.15 augustss svar->opfunc = varop_modify;
886 1.15 augustss }
887 1.15 augustss }
888 1.6 augustss
889 1.15 augustss if (aflag || rflag) {
890 1.15 augustss struct Susbvar *svar;
891 1.15 augustss
892 1.15 augustss svar = &variables[varnum++];
893 1.15 augustss
894 1.15 augustss svar->variable = NULL;
895 1.15 augustss svar->mflags = MATCH_ALL;
896 1.15 augustss
897 1.15 augustss if (rflag) {
898 1.15 augustss /*
899 1.15 augustss * Dump report descriptor. Do dump collection
900 1.15 augustss * items also, and hint that it won't be
901 1.15 augustss * necessary to get the item status.
902 1.15 augustss */
903 1.15 augustss svar->opfunc = varop_report;
904 1.15 augustss svar->mflags |= MATCH_COLLECTIONS | MATCH_NODATA;
905 1.15 augustss
906 1.15 augustss switch (verbose) {
907 1.15 augustss default:
908 1.15 augustss /* Level 2: Show item numerics and constants */
909 1.15 augustss svar->mflags |= MATCH_SHOWNUMERIC;
910 1.15 augustss /* FALLTHROUGH */
911 1.15 augustss case 1:
912 1.15 augustss /* Level 1: Just show constants */
913 1.15 augustss svar->mflags |= MATCH_CONSTANTS;
914 1.15 augustss /* FALLTHROUGH */
915 1.15 augustss case 0:
916 1.15 augustss break;
917 1.15 augustss }
918 1.15 augustss } else {
919 1.15 augustss /* Display name and value of variable */
920 1.15 augustss svar->opfunc = varop_display;
921 1.15 augustss
922 1.15 augustss switch (verbose) {
923 1.15 augustss default:
924 1.15 augustss /* Level 2: Show constants and page names */
925 1.15 augustss svar->mflags |= MATCH_CONSTANTS;
926 1.15 augustss /* FALLTHROUGH */
927 1.15 augustss case 1:
928 1.15 augustss /* Level 1: Just show page names */
929 1.15 augustss svar->mflags |= MATCH_SHOWPAGENAME;
930 1.15 augustss /* FALLTHROUGH */
931 1.15 augustss case 0:
932 1.15 augustss break;
933 1.15 augustss }
934 1.15 augustss }
935 1.15 augustss }
936 1.15 augustss
937 1.15 augustss if (varnum == 0) {
938 1.15 augustss /* Nothing to do... Display usage information. */
939 1.6 augustss usage();
940 1.15 augustss /* NOTREACHED */
941 1.15 augustss }
942 1.15 augustss
943 1.15 augustss hid_init(table);
944 1.4 augustss
945 1.4 augustss if (dev[0] != '/') {
946 1.15 augustss snprintf(devnamebuf, sizeof(devnamebuf), "/dev/%s%s",
947 1.27 dsl isdigit((unsigned char)dev[0]) ? "uhid" : "", dev);
948 1.15 augustss dev = devnamebuf;
949 1.4 augustss }
950 1.1 augustss
951 1.15 augustss hidfd = open(dev, O_RDWR);
952 1.15 augustss if (hidfd < 0)
953 1.1 augustss err(1, "%s", dev);
954 1.1 augustss
955 1.20 augustss if (ioctl(hidfd, USB_GET_REPORT_ID, &reportid) < 0)
956 1.20 augustss reportid = -1;
957 1.20 augustss if (verbose > 1)
958 1.20 augustss printf("report ID=%d\n", reportid);
959 1.15 augustss repdesc = hid_get_report_desc(hidfd);
960 1.15 augustss if (repdesc == 0)
961 1.1 augustss errx(1, "USB_GET_REPORT_DESC");
962 1.15 augustss
963 1.15 augustss if (lflag) {
964 1.15 augustss devloop(hidfd, repdesc, variables, varnum);
965 1.15 augustss /* NOTREACHED */
966 1.15 augustss }
967 1.15 augustss
968 1.15 augustss if (rflag)
969 1.15 augustss /* Report mode header */
970 1.9 augustss printf("Report descriptor:\n");
971 1.15 augustss
972 1.15 augustss devshow(hidfd, repdesc, variables, varnum,
973 1.15 augustss 1 << hid_input |
974 1.15 augustss 1 << hid_output |
975 1.15 augustss 1 << hid_feature);
976 1.15 augustss
977 1.15 augustss if (rflag) {
978 1.15 augustss /* Report mode trailer */
979 1.15 augustss size_t repindex;
980 1.15 augustss for (repindex = 0;
981 1.15 augustss repindex < (sizeof(reptoparam) / sizeof(*reptoparam));
982 1.15 augustss repindex++) {
983 1.20 augustss int size;
984 1.15 augustss size = hid_report_size(repdesc,
985 1.15 augustss reptoparam[repindex].hid_kind,
986 1.20 augustss reportid);
987 1.20 augustss printf("Total %7s size %d bytes\n",
988 1.20 augustss reptoparam[repindex].name, size);
989 1.15 augustss }
990 1.1 augustss }
991 1.1 augustss
992 1.15 augustss hid_dispose_report_desc(repdesc);
993 1.1 augustss exit(0);
994 1.15 augustss /* NOTREACHED */
995 1.1 augustss }
996