lib/libusbhid/descr.c

   1 /*      $NetBSD: descr.c,v 1.9 2000/09/24 02:13:24 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
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/types.h>
  35
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <stdlib.h>
  39 #include <string.h>
  40 #include <unistd.h>
  41 #include <sys/time.h>
  42 #include <sys/ioctl.h>
  43 #include <dev/usb/usb_ioctl.h>
  44
  45 #include "usbhid.h"
  46 #include "usbvar.h"
  47
  48 int
  49 hid_set_immed(int fd, int enable)
  50 {
  51         int ret;
  52         ret = ioctl(fd, USB_SET_IMMED, &enable);
  53 #ifdef HID_COMPAT7
  54         if (ret < 0)
  55                 ret = hid_set_immed_compat7(fd, enable);
  56 #endif
  57         return (ret);
  58 }
  59
  60 int
  61 hid_get_report_id(int fd)
  62 {
  63         report_desc_t rep;
  64         hid_data_t d;
  65         hid_item_t h;
  66         int kindset;
  67         int temp = -1;
  68         int ret;
  69
  70         if ((rep = hid_get_report_desc(fd)) == NULL)
  71                 goto use_ioctl;
  72         kindset = 1 << hid_input | 1 << hid_output | 1 << hid_feature;
  73         for (d = hid_start_parse(rep, kindset, -1); hid_get_item(d, &h); ) {
  74                 /* Return the first report ID we met. */
  75                 if (h.report_ID != 0) {
  76                         temp = h.report_ID;
  77                         break;
  78                 }
  79         }
  80         hid_end_parse(d);
  81         hid_dispose_report_desc(rep);
  82
  83         if (temp > 0)
  84                 return (temp);
  85
  86 use_ioctl:
  87         ret = ioctl(fd, USB_GET_REPORT_ID, &temp);
  88 #ifdef HID_COMPAT7
  89         if (ret < 0)
  90                 ret = hid_get_report_id_compat7(fd);
  91         else
  92 #endif
  93                 ret = temp;
  94
  95         return (ret);
  96 }
  97
  98 report_desc_t
  99 hid_get_report_desc(int fd)
 100 {
 101         struct usb_gen_descriptor ugd;
 102         report_desc_t rep;
 103         void *data;
 104
 105         memset(&ugd, 0, sizeof(ugd));
 106
 107         /* get actual length first */
 108         ugd.ugd_data = hid_pass_ptr(NULL);
 109         ugd.ugd_maxlen = 65535;
 110         if (ioctl(fd, USB_GET_REPORT_DESC, &ugd) < 0) {
 111 #ifdef HID_COMPAT7
 112                 /* could not read descriptor */
 113                 /* try FreeBSD 7 compat code */
 114                 return (hid_get_report_desc_compat7(fd));
 115 #else
 116                 return (NULL);
 117 #endif
 118         }
 119
 120         /*
 121          * NOTE: The kernel will return a failure if
 122          * "ugd_actlen" is zero.
 123          */
 124         data = malloc(ugd.ugd_actlen);
 125         if (data == NULL)
 126                 return (NULL);
 127
 128         /* fetch actual descriptor */
 129         ugd.ugd_data = hid_pass_ptr(data);
 130         ugd.ugd_maxlen = ugd.ugd_actlen;
 131         if (ioctl(fd, USB_GET_REPORT_DESC, &ugd) < 0) {
 132                 /* could not read descriptor */
 133                 free(data);
 134                 return (NULL);
 135         }
 136
 137         /* sanity check */
 138         if (ugd.ugd_actlen < 1) {
 139                 /* invalid report descriptor */
 140                 free(data);
 141                 return (NULL);
 142         }
 143
 144         /* check END_COLLECTION */
 145         if (((unsigned char *)data)[ugd.ugd_actlen -1] != 0xC0) {
 146                 /* invalid end byte */
 147                 free(data);
 148                 return (NULL);
 149         }
 150
 151         rep = hid_use_report_desc(data, ugd.ugd_actlen);
 152
 153         free(data);
 154
 155         return (rep);
 156 }
 157
 158 report_desc_t
 159 hid_use_report_desc(unsigned char *data, unsigned int size)
 160 {
 161         report_desc_t r;
 162
 163         r = malloc(sizeof(*r) + size);
 164         if (r == NULL) {
 165                 errno = ENOMEM;
 166                 return (NULL);
 167         }
 168         r->size = size;
 169         memcpy(r->data, data, size);
 170         return (r);
 171 }
 172
 173 void
 174 hid_dispose_report_desc(report_desc_t r)
 175 {
 176
 177         free(r);
 178 }