18930c119SMarkus Pfeiffer /* $FreeBSD: head/sys/dev/usb/usb_lookup.c 246194 2013-02-01 07:05:43Z hselasky $ */
212bd3c8bSSascha Wildner /*-
312bd3c8bSSascha Wildner * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
412bd3c8bSSascha Wildner *
512bd3c8bSSascha Wildner * Redistribution and use in source and binary forms, with or without
612bd3c8bSSascha Wildner * modification, are permitted provided that the following conditions
712bd3c8bSSascha Wildner * are met:
812bd3c8bSSascha Wildner * 1. Redistributions of source code must retain the above copyright
912bd3c8bSSascha Wildner * notice, this list of conditions and the following disclaimer.
1012bd3c8bSSascha Wildner * 2. Redistributions in binary form must reproduce the above copyright
1112bd3c8bSSascha Wildner * notice, this list of conditions and the following disclaimer in the
1212bd3c8bSSascha Wildner * documentation and/or other materials provided with the distribution.
1312bd3c8bSSascha Wildner *
1412bd3c8bSSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1512bd3c8bSSascha Wildner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1612bd3c8bSSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1712bd3c8bSSascha Wildner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1812bd3c8bSSascha Wildner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1912bd3c8bSSascha Wildner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2012bd3c8bSSascha Wildner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2112bd3c8bSSascha Wildner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2212bd3c8bSSascha Wildner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2312bd3c8bSSascha Wildner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2412bd3c8bSSascha Wildner * SUCH DAMAGE.
2512bd3c8bSSascha Wildner */
2612bd3c8bSSascha Wildner
2712bd3c8bSSascha Wildner #include <sys/stdint.h>
2812bd3c8bSSascha Wildner #include <sys/param.h>
2912bd3c8bSSascha Wildner #include <sys/queue.h>
3012bd3c8bSSascha Wildner #include <sys/types.h>
3112bd3c8bSSascha Wildner #include <sys/systm.h>
3212bd3c8bSSascha Wildner #include <sys/kernel.h>
3312bd3c8bSSascha Wildner #include <sys/bus.h>
3412bd3c8bSSascha Wildner #include <sys/module.h>
3512bd3c8bSSascha Wildner #include <sys/lock.h>
3612bd3c8bSSascha Wildner #include <sys/condvar.h>
3712bd3c8bSSascha Wildner #include <sys/sysctl.h>
3812bd3c8bSSascha Wildner #include <sys/unistd.h>
3912bd3c8bSSascha Wildner #include <sys/callout.h>
4012bd3c8bSSascha Wildner #include <sys/malloc.h>
41*2b3f93eaSMatthew Dillon #include <sys/caps.h>
4212bd3c8bSSascha Wildner #include <sys/limits.h>
4312bd3c8bSSascha Wildner #include <sys/endian.h>
4412bd3c8bSSascha Wildner
45722d05c3SSascha Wildner #include <bus/u4b/usb.h>
46722d05c3SSascha Wildner #include <bus/u4b/usbdi.h>
4712bd3c8bSSascha Wildner
4812bd3c8bSSascha Wildner /*------------------------------------------------------------------------*
4912bd3c8bSSascha Wildner * usbd_lookup_id_by_info
5012bd3c8bSSascha Wildner *
5112bd3c8bSSascha Wildner * This functions takes an array of "struct usb_device_id" and tries
5212bd3c8bSSascha Wildner * to match the entries with the information in "struct usbd_lookup_info".
5312bd3c8bSSascha Wildner *
5412bd3c8bSSascha Wildner * NOTE: The "sizeof_id" parameter must be a multiple of the
5512bd3c8bSSascha Wildner * usb_device_id structure size. Else the behaviour of this function
5612bd3c8bSSascha Wildner * is undefined.
5712bd3c8bSSascha Wildner *
5812bd3c8bSSascha Wildner * Return values:
5912bd3c8bSSascha Wildner * NULL: No match found.
6012bd3c8bSSascha Wildner * Else: Pointer to matching entry.
6112bd3c8bSSascha Wildner *------------------------------------------------------------------------*/
6212bd3c8bSSascha Wildner const struct usb_device_id *
usbd_lookup_id_by_info(const struct usb_device_id * id,usb_size_t sizeof_id,const struct usbd_lookup_info * info)6312bd3c8bSSascha Wildner usbd_lookup_id_by_info(const struct usb_device_id *id, usb_size_t sizeof_id,
6412bd3c8bSSascha Wildner const struct usbd_lookup_info *info)
6512bd3c8bSSascha Wildner {
6612bd3c8bSSascha Wildner const struct usb_device_id *id_end;
6712bd3c8bSSascha Wildner
6812bd3c8bSSascha Wildner if (id == NULL) {
6912bd3c8bSSascha Wildner goto done;
7012bd3c8bSSascha Wildner }
7112bd3c8bSSascha Wildner id_end = (const void *)(((const uint8_t *)id) + sizeof_id);
7212bd3c8bSSascha Wildner
7312bd3c8bSSascha Wildner /*
7412bd3c8bSSascha Wildner * Keep on matching array entries until we find a match or
7512bd3c8bSSascha Wildner * until we reach the end of the matching array:
7612bd3c8bSSascha Wildner */
7712bd3c8bSSascha Wildner for (; id != id_end; id++) {
7812bd3c8bSSascha Wildner
7912bd3c8bSSascha Wildner if ((id->match_flag_vendor) &&
8012bd3c8bSSascha Wildner (id->idVendor != info->idVendor)) {
8112bd3c8bSSascha Wildner continue;
8212bd3c8bSSascha Wildner }
8312bd3c8bSSascha Wildner if ((id->match_flag_product) &&
8412bd3c8bSSascha Wildner (id->idProduct != info->idProduct)) {
8512bd3c8bSSascha Wildner continue;
8612bd3c8bSSascha Wildner }
8712bd3c8bSSascha Wildner if ((id->match_flag_dev_lo) &&
8812bd3c8bSSascha Wildner (id->bcdDevice_lo > info->bcdDevice)) {
8912bd3c8bSSascha Wildner continue;
9012bd3c8bSSascha Wildner }
9112bd3c8bSSascha Wildner if ((id->match_flag_dev_hi) &&
9212bd3c8bSSascha Wildner (id->bcdDevice_hi < info->bcdDevice)) {
9312bd3c8bSSascha Wildner continue;
9412bd3c8bSSascha Wildner }
9512bd3c8bSSascha Wildner if ((id->match_flag_dev_class) &&
9612bd3c8bSSascha Wildner (id->bDeviceClass != info->bDeviceClass)) {
9712bd3c8bSSascha Wildner continue;
9812bd3c8bSSascha Wildner }
9912bd3c8bSSascha Wildner if ((id->match_flag_dev_subclass) &&
10012bd3c8bSSascha Wildner (id->bDeviceSubClass != info->bDeviceSubClass)) {
10112bd3c8bSSascha Wildner continue;
10212bd3c8bSSascha Wildner }
10312bd3c8bSSascha Wildner if ((id->match_flag_dev_protocol) &&
10412bd3c8bSSascha Wildner (id->bDeviceProtocol != info->bDeviceProtocol)) {
10512bd3c8bSSascha Wildner continue;
10612bd3c8bSSascha Wildner }
10712bd3c8bSSascha Wildner if ((id->match_flag_int_class) &&
10812bd3c8bSSascha Wildner (id->bInterfaceClass != info->bInterfaceClass)) {
10912bd3c8bSSascha Wildner continue;
11012bd3c8bSSascha Wildner }
11112bd3c8bSSascha Wildner if ((id->match_flag_int_subclass) &&
11212bd3c8bSSascha Wildner (id->bInterfaceSubClass != info->bInterfaceSubClass)) {
11312bd3c8bSSascha Wildner continue;
11412bd3c8bSSascha Wildner }
11512bd3c8bSSascha Wildner if ((id->match_flag_int_protocol) &&
11612bd3c8bSSascha Wildner (id->bInterfaceProtocol != info->bInterfaceProtocol)) {
11712bd3c8bSSascha Wildner continue;
11812bd3c8bSSascha Wildner }
11912bd3c8bSSascha Wildner /* We found a match! */
12012bd3c8bSSascha Wildner return (id);
12112bd3c8bSSascha Wildner }
12212bd3c8bSSascha Wildner
12312bd3c8bSSascha Wildner done:
12412bd3c8bSSascha Wildner return (NULL);
12512bd3c8bSSascha Wildner }
12612bd3c8bSSascha Wildner
12712bd3c8bSSascha Wildner /*------------------------------------------------------------------------*
12812bd3c8bSSascha Wildner * usbd_lookup_id_by_uaa - factored out code
12912bd3c8bSSascha Wildner *
13012bd3c8bSSascha Wildner * Return values:
13112bd3c8bSSascha Wildner * 0: Success
13212bd3c8bSSascha Wildner * Else: Failure
13312bd3c8bSSascha Wildner *------------------------------------------------------------------------*/
13412bd3c8bSSascha Wildner int
usbd_lookup_id_by_uaa(const struct usb_device_id * id,usb_size_t sizeof_id,struct usb_attach_arg * uaa)13512bd3c8bSSascha Wildner usbd_lookup_id_by_uaa(const struct usb_device_id *id, usb_size_t sizeof_id,
13612bd3c8bSSascha Wildner struct usb_attach_arg *uaa)
13712bd3c8bSSascha Wildner {
13812bd3c8bSSascha Wildner id = usbd_lookup_id_by_info(id, sizeof_id, &uaa->info);
13912bd3c8bSSascha Wildner if (id) {
14012bd3c8bSSascha Wildner /* copy driver info */
14112bd3c8bSSascha Wildner uaa->driver_info = id->driver_info;
14212bd3c8bSSascha Wildner return (0);
14312bd3c8bSSascha Wildner }
14412bd3c8bSSascha Wildner return (ENXIO);
14512bd3c8bSSascha Wildner }
14612bd3c8bSSascha Wildner
14712bd3c8bSSascha Wildner /*------------------------------------------------------------------------*
14812bd3c8bSSascha Wildner * Export the USB device ID format we use to userspace tools.
14912bd3c8bSSascha Wildner *------------------------------------------------------------------------*/
15012bd3c8bSSascha Wildner #if BYTE_ORDER == BIG_ENDIAN
15112bd3c8bSSascha Wildner #define U16_XOR "8"
15212bd3c8bSSascha Wildner #define U32_XOR "12"
15312bd3c8bSSascha Wildner #define U64_XOR "56"
15412bd3c8bSSascha Wildner #define U8_BITFIELD_XOR "7"
15512bd3c8bSSascha Wildner #define U16_BITFIELD_XOR "15"
15612bd3c8bSSascha Wildner #define U32_BITFIELD_XOR "31"
15712bd3c8bSSascha Wildner #define U64_BITFIELD_XOR "63"
15812bd3c8bSSascha Wildner #else
15912bd3c8bSSascha Wildner #define U16_XOR "0"
16012bd3c8bSSascha Wildner #define U32_XOR "0"
16112bd3c8bSSascha Wildner #define U64_XOR "0"
16212bd3c8bSSascha Wildner #define U8_BITFIELD_XOR "0"
16312bd3c8bSSascha Wildner #define U16_BITFIELD_XOR "0"
16412bd3c8bSSascha Wildner #define U32_BITFIELD_XOR "0"
16512bd3c8bSSascha Wildner #define U64_BITFIELD_XOR "0"
16612bd3c8bSSascha Wildner #endif
16712bd3c8bSSascha Wildner
16812bd3c8bSSascha Wildner #if USB_HAVE_COMPAT_LINUX
16912bd3c8bSSascha Wildner #define MFL_SIZE "1"
17012bd3c8bSSascha Wildner #else
17112bd3c8bSSascha Wildner #define MFL_SIZE "0"
17212bd3c8bSSascha Wildner #endif
17312bd3c8bSSascha Wildner
17457bed822SMarkus Pfeiffer #if defined(KLD_MODULE) && (USB_HAVE_ID_SECTION != 0)
17512bd3c8bSSascha Wildner static const char __section("bus_autoconf_format") __used usb_id_format[] = {
17612bd3c8bSSascha Wildner
17712bd3c8bSSascha Wildner /* Declare that three different sections use the same format */
17812bd3c8bSSascha Wildner
17912bd3c8bSSascha Wildner "usb_host_id{256,:}"
18012bd3c8bSSascha Wildner "usb_device_id{256,:}"
18112bd3c8bSSascha Wildner "usb_dual_id{256,:}"
18212bd3c8bSSascha Wildner
18312bd3c8bSSascha Wildner /* List size of fields in the usb_device_id structure */
18412bd3c8bSSascha Wildner
18512bd3c8bSSascha Wildner #if ULONG_MAX >= 0xFFFFFFFFUL
18612bd3c8bSSascha Wildner "unused{0,8}"
18712bd3c8bSSascha Wildner "unused{0,8}"
18812bd3c8bSSascha Wildner "unused{0,8}"
18912bd3c8bSSascha Wildner "unused{0,8}"
19012bd3c8bSSascha Wildner #if ULONG_MAX >= 0xFFFFFFFFFFFFFFFFULL
19112bd3c8bSSascha Wildner "unused{0,8}"
19212bd3c8bSSascha Wildner "unused{0,8}"
19312bd3c8bSSascha Wildner "unused{0,8}"
19412bd3c8bSSascha Wildner "unused{0,8}"
19512bd3c8bSSascha Wildner #endif
19612bd3c8bSSascha Wildner #else
19712bd3c8bSSascha Wildner #error "Please update code."
19812bd3c8bSSascha Wildner #endif
19912bd3c8bSSascha Wildner
20012bd3c8bSSascha Wildner "idVendor[0]{" U16_XOR ",8}"
20112bd3c8bSSascha Wildner "idVendor[1]{" U16_XOR ",8}"
20212bd3c8bSSascha Wildner "idProduct[0]{" U16_XOR ",8}"
20312bd3c8bSSascha Wildner "idProduct[1]{" U16_XOR ",8}"
20412bd3c8bSSascha Wildner "bcdDevice_lo[0]{" U16_XOR ",8}"
20512bd3c8bSSascha Wildner "bcdDevice_lo[1]{" U16_XOR ",8}"
20612bd3c8bSSascha Wildner "bcdDevice_hi[0]{" U16_XOR ",8}"
20712bd3c8bSSascha Wildner "bcdDevice_hi[1]{" U16_XOR ",8}"
20812bd3c8bSSascha Wildner
20912bd3c8bSSascha Wildner "bDeviceClass{0,8}"
21012bd3c8bSSascha Wildner "bDeviceSubClass{0,8}"
21112bd3c8bSSascha Wildner "bDeviceProtocol{0,8}"
21212bd3c8bSSascha Wildner "bInterfaceClass{0,8}"
21312bd3c8bSSascha Wildner "bInterfaceSubClass{0,8}"
21412bd3c8bSSascha Wildner "bInterfaceProtocol{0,8}"
21512bd3c8bSSascha Wildner
21612bd3c8bSSascha Wildner "mf_vendor{" U8_BITFIELD_XOR ",1}"
21712bd3c8bSSascha Wildner "mf_product{" U8_BITFIELD_XOR ",1}"
21812bd3c8bSSascha Wildner "mf_dev_lo{" U8_BITFIELD_XOR ",1}"
21912bd3c8bSSascha Wildner "mf_dev_hi{" U8_BITFIELD_XOR ",1}"
22012bd3c8bSSascha Wildner
22112bd3c8bSSascha Wildner "mf_dev_class{" U8_BITFIELD_XOR ",1}"
22212bd3c8bSSascha Wildner "mf_dev_subclass{" U8_BITFIELD_XOR ",1}"
22312bd3c8bSSascha Wildner "mf_dev_protocol{" U8_BITFIELD_XOR ",1}"
22412bd3c8bSSascha Wildner "mf_int_class{" U8_BITFIELD_XOR ",1}"
22512bd3c8bSSascha Wildner
22612bd3c8bSSascha Wildner "mf_int_subclass{" U8_BITFIELD_XOR ",1}"
22712bd3c8bSSascha Wildner "mf_int_protocol{" U8_BITFIELD_XOR ",1}"
22812bd3c8bSSascha Wildner "unused{" U8_BITFIELD_XOR ",6}"
22912bd3c8bSSascha Wildner
23012bd3c8bSSascha Wildner "mfl_vendor{" U16_XOR "," MFL_SIZE "}"
23112bd3c8bSSascha Wildner "mfl_product{" U16_XOR "," MFL_SIZE "}"
23212bd3c8bSSascha Wildner "mfl_dev_lo{" U16_XOR "," MFL_SIZE "}"
23312bd3c8bSSascha Wildner "mfl_dev_hi{" U16_XOR "," MFL_SIZE "}"
23412bd3c8bSSascha Wildner
23512bd3c8bSSascha Wildner "mfl_dev_class{" U16_XOR "," MFL_SIZE "}"
23612bd3c8bSSascha Wildner "mfl_dev_subclass{" U16_XOR "," MFL_SIZE "}"
23712bd3c8bSSascha Wildner "mfl_dev_protocol{" U16_XOR "," MFL_SIZE "}"
23812bd3c8bSSascha Wildner "mfl_int_class{" U16_XOR "," MFL_SIZE "}"
23912bd3c8bSSascha Wildner
24012bd3c8bSSascha Wildner "mfl_int_subclass{" U16_XOR "," MFL_SIZE "}"
24112bd3c8bSSascha Wildner "mfl_int_protocol{" U16_XOR "," MFL_SIZE "}"
24212bd3c8bSSascha Wildner "unused{" U16_XOR "," MFL_SIZE "}"
24312bd3c8bSSascha Wildner "unused{" U16_XOR "," MFL_SIZE "}"
24412bd3c8bSSascha Wildner
24512bd3c8bSSascha Wildner "unused{" U16_XOR "," MFL_SIZE "}"
24612bd3c8bSSascha Wildner "unused{" U16_XOR "," MFL_SIZE "}"
24712bd3c8bSSascha Wildner "unused{" U16_XOR "," MFL_SIZE "}"
24812bd3c8bSSascha Wildner "unused{" U16_XOR "," MFL_SIZE "}"
24912bd3c8bSSascha Wildner };
25012bd3c8bSSascha Wildner #endif
251