1/* $FreeBSD$ */
2/*-
3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 *
5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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.
15 *
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
26 * SUCH DAMAGE.
27 */
28
29#ifdef USB_GLOBAL_INCLUDE_FILE
30#include USB_GLOBAL_INCLUDE_FILE
31#else
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>
39#include <sys/bus.h>
40#include <sys/module.h>
41#include <sys/lock.h>
42#include <sys/mutex.h>
43#include <sys/condvar.h>
44#include <sys/sysctl.h>
45#include <sys/sx.h>
46#include <sys/unistd.h>
47#include <sys/callout.h>
48#include <sys/malloc.h>
49#include <sys/priv.h>
50#include <sys/limits.h>
51#include <sys/endian.h>
52
53#include <dev/usb/usb.h>
54#include <dev/usb/usbdi.h>
55#endif			/* USB_GLOBAL_INCLUDE_FILE */
56
57/*------------------------------------------------------------------------*
58 *	usbd_lookup_id_by_info
59 *
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".
62 *
63 * NOTE: The "sizeof_id" parameter must be a multiple of the
64 * usb_device_id structure size. Else the behaviour of this function
65 * is undefined.
66 *
67 * Return values:
68 * NULL: No match found.
69 * Else: Pointer to matching entry.
70 *------------------------------------------------------------------------*/
71const struct usb_device_id *
72usbd_lookup_id_by_info(const struct usb_device_id *id, usb_size_t sizeof_id,
73    const struct usbd_lookup_info *info)
74{
75	const struct usb_device_id *id_end;
76
77	if (id == NULL) {
78		goto done;
79	}
80	id_end = (const void *)(((const uint8_t *)id) + sizeof_id);
81
82	/*
83	 * Keep on matching array entries until we find a match or
84	 * until we reach the end of the matching array:
85	 */
86	for (; id != id_end; id++) {
87		if ((id->match_flag_vendor) &&
88		    (id->idVendor != info->idVendor)) {
89			continue;
90		}
91		if ((id->match_flag_product) &&
92		    (id->idProduct != info->idProduct)) {
93			continue;
94		}
95		if ((id->match_flag_dev_lo) &&
96		    (id->bcdDevice_lo > info->bcdDevice)) {
97			continue;
98		}
99		if ((id->match_flag_dev_hi) &&
100		    (id->bcdDevice_hi < info->bcdDevice)) {
101			continue;
102		}
103		if ((id->match_flag_dev_class) &&
104		    (id->bDeviceClass != info->bDeviceClass)) {
105			continue;
106		}
107		if ((id->match_flag_dev_subclass) &&
108		    (id->bDeviceSubClass != info->bDeviceSubClass)) {
109			continue;
110		}
111		if ((id->match_flag_dev_protocol) &&
112		    (id->bDeviceProtocol != info->bDeviceProtocol)) {
113			continue;
114		}
115		if ((id->match_flag_int_class) &&
116		    (id->bInterfaceClass != info->bInterfaceClass)) {
117			continue;
118		}
119		if ((id->match_flag_int_subclass) &&
120		    (id->bInterfaceSubClass != info->bInterfaceSubClass)) {
121			continue;
122		}
123		if ((id->match_flag_int_protocol) &&
124		    (id->bInterfaceProtocol != info->bInterfaceProtocol)) {
125			continue;
126		}
127		/* We found a match! */
128		return (id);
129	}
130
131done:
132	return (NULL);
133}
134
135/*------------------------------------------------------------------------*
136 *	usbd_lookup_id_by_uaa - factored out code
137 *
138 * Return values:
139 *    0: Success
140 * Else: Failure
141 *------------------------------------------------------------------------*/
142int
143usbd_lookup_id_by_uaa(const struct usb_device_id *id, usb_size_t sizeof_id,
144    struct usb_attach_arg *uaa)
145{
146	id = usbd_lookup_id_by_info(id, sizeof_id, &uaa->info);
147	if (id) {
148		/* copy driver info */
149		uaa->driver_info = id->driver_info;
150		return (0);
151	}
152	return (ENXIO);
153}
154