3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifdef USB_GLOBAL_INCLUDE_FILE
30 #include USB_GLOBAL_INCLUDE_FILE
32 #include <sys/stdint.h>
33 #include <sys/stddef.h>
34 #include <sys/param.h>
35 #include <sys/queue.h>
36 #include <sys/types.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
40 #include <sys/module.h>
42 #include <sys/mutex.h>
43 #include <sys/condvar.h>
44 #include <sys/sysctl.h>
46 #include <sys/unistd.h>
47 #include <sys/callout.h>
48 #include <sys/malloc.h>
50 #include <sys/limits.h>
51 #include <sys/endian.h>
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usbdi.h>
55 #endif /* USB_GLOBAL_INCLUDE_FILE */
57 /*------------------------------------------------------------------------*
58 * usbd_lookup_id_by_info
60 * This functions takes an array of "struct usb_device_id" and tries
61 * to match the entries with the information in "struct usbd_lookup_info".
63 * NOTE: The "sizeof_id" parameter must be a multiple of the
64 * usb_device_id structure size. Else the behaviour of this function
68 * NULL: No match found.
69 * Else: Pointer to matching entry.
70 *------------------------------------------------------------------------*/
71 const struct usb_device_id *
72 usbd_lookup_id_by_info(const struct usb_device_id *id, usb_size_t sizeof_id,
73 const struct usbd_lookup_info *info)
75 const struct usb_device_id *id_end;
80 id_end = (const void *)(((const uint8_t *)id) + sizeof_id);
83 * Keep on matching array entries until we find a match or
84 * until we reach the end of the matching array:
86 for (; id != id_end; id++) {
88 if ((id->match_flag_vendor) &&
89 (id->idVendor != info->idVendor)) {
92 if ((id->match_flag_product) &&
93 (id->idProduct != info->idProduct)) {
96 if ((id->match_flag_dev_lo) &&
97 (id->bcdDevice_lo > info->bcdDevice)) {
100 if ((id->match_flag_dev_hi) &&
101 (id->bcdDevice_hi < info->bcdDevice)) {
104 if ((id->match_flag_dev_class) &&
105 (id->bDeviceClass != info->bDeviceClass)) {
108 if ((id->match_flag_dev_subclass) &&
109 (id->bDeviceSubClass != info->bDeviceSubClass)) {
112 if ((id->match_flag_dev_protocol) &&
113 (id->bDeviceProtocol != info->bDeviceProtocol)) {
116 if ((id->match_flag_int_class) &&
117 (id->bInterfaceClass != info->bInterfaceClass)) {
120 if ((id->match_flag_int_subclass) &&
121 (id->bInterfaceSubClass != info->bInterfaceSubClass)) {
124 if ((id->match_flag_int_protocol) &&
125 (id->bInterfaceProtocol != info->bInterfaceProtocol)) {
128 /* We found a match! */
136 /*------------------------------------------------------------------------*
137 * usbd_lookup_id_by_uaa - factored out code
142 *------------------------------------------------------------------------*/
144 usbd_lookup_id_by_uaa(const struct usb_device_id *id, usb_size_t sizeof_id,
145 struct usb_attach_arg *uaa)
147 id = usbd_lookup_id_by_info(id, sizeof_id, &uaa->info);
149 /* copy driver info */
150 uaa->driver_info = id->driver_info;
156 /*------------------------------------------------------------------------*
157 * Export the USB device ID format we use to userspace tools.
158 *------------------------------------------------------------------------*/
159 #if BYTE_ORDER == LITTLE_ENDIAN
165 #if defined(KLD_MODULE) && (USB_HAVE_ID_SECTION != 0)
166 static const char __section("bus_autoconf_format") __used usb_id_format[] = {
168 /* Declare that three different sections use the same format */
171 "usb_device_id{256,:}"
174 /* List size of fields in the usb_device_id structure */
176 "mf_vendor{" U16_XOR ",1}"
177 "mf_product{" U16_XOR ",1}"
178 "mf_dev_lo{" U16_XOR ",1}"
179 "mf_dev_hi{" U16_XOR ",1}"
181 "mf_dev_class{" U16_XOR ",1}"
182 "mf_dev_subclass{" U16_XOR ",1}"
183 "mf_dev_protocol{" U16_XOR ",1}"
184 "mf_int_class{" U16_XOR ",1}"
186 "mf_int_subclass{" U16_XOR ",1}"
187 "mf_int_protocol{" U16_XOR ",1}"
188 "unused{" U16_XOR ",6}"
190 "idVendor[0]{" U16_XOR ",8}"
191 "idVendor[1]{" U16_XOR ",8}"
192 "idProduct[0]{" U16_XOR ",8}"
193 "idProduct[1]{" U16_XOR ",8}"
194 "bcdDevice_lo[0]{" U16_XOR ",8}"
195 "bcdDevice_lo[1]{" U16_XOR ",8}"
196 "bcdDevice_hi[0]{" U16_XOR ",8}"
197 "bcdDevice_hi[1]{" U16_XOR ",8}"
200 "bDeviceSubClass{0,8}"
201 "bDeviceProtocol{0,8}"
202 "bInterfaceClass{0,8}"
203 "bInterfaceSubClass{0,8}"
204 "bInterfaceProtocol{0,8}"
206 #if USB_HAVE_COMPAT_LINUX
207 "mfl_vendor{" U16_XOR ",1}"
208 "mfl_product{" U16_XOR ",1}"
209 "mfl_dev_lo{" U16_XOR ",1}"
210 "mfl_dev_hi{" U16_XOR ",1}"
212 "mfl_dev_class{" U16_XOR ",1}"
213 "mfl_dev_subclass{" U16_XOR ",1}"
214 "mfl_dev_protocol{" U16_XOR ",1}"
215 "mfl_int_class{" U16_XOR ",1}"
217 "mfl_int_subclass{" U16_XOR ",1}"
218 "mfl_int_protocol{" U16_XOR ",1}"
219 "unused{" U16_XOR ",6}"