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