1 /* $FreeBSD$ */ 2 /*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #include <sys/stdint.h> 28 #include <sys/param.h> 29 #include <sys/queue.h> 30 #include <sys/types.h> 31 #include <sys/systm.h> 32 #include <sys/kernel.h> 33 #include <sys/bus.h> 34 #include <sys/module.h> 35 #include <sys/lock.h> 36 #include <sys/mutex.h> 37 #include <sys/condvar.h> 38 #include <sys/sysctl.h> 39 #include <sys/unistd.h> 40 #include <sys/callout.h> 41 #include <sys/malloc.h> 42 #include <sys/priv.h> 43 #include <sys/limits.h> 44 #include <sys/endian.h> 45 46 #include <bus/u4b/usb.h> 47 #include <bus/u4b/usbdi.h> 48 49 /*------------------------------------------------------------------------* 50 * usbd_lookup_id_by_info 51 * 52 * This functions takes an array of "struct usb_device_id" and tries 53 * to match the entries with the information in "struct usbd_lookup_info". 54 * 55 * NOTE: The "sizeof_id" parameter must be a multiple of the 56 * usb_device_id structure size. Else the behaviour of this function 57 * is undefined. 58 * 59 * Return values: 60 * NULL: No match found. 61 * Else: Pointer to matching entry. 62 *------------------------------------------------------------------------*/ 63 const struct usb_device_id * 64 usbd_lookup_id_by_info(const struct usb_device_id *id, usb_size_t sizeof_id, 65 const struct usbd_lookup_info *info) 66 { 67 const struct usb_device_id *id_end; 68 69 if (id == NULL) { 70 goto done; 71 } 72 id_end = (const void *)(((const uint8_t *)id) + sizeof_id); 73 74 /* 75 * Keep on matching array entries until we find a match or 76 * until we reach the end of the matching array: 77 */ 78 for (; id != id_end; id++) { 79 80 if ((id->match_flag_vendor) && 81 (id->idVendor != info->idVendor)) { 82 continue; 83 } 84 if ((id->match_flag_product) && 85 (id->idProduct != info->idProduct)) { 86 continue; 87 } 88 if ((id->match_flag_dev_lo) && 89 (id->bcdDevice_lo > info->bcdDevice)) { 90 continue; 91 } 92 if ((id->match_flag_dev_hi) && 93 (id->bcdDevice_hi < info->bcdDevice)) { 94 continue; 95 } 96 if ((id->match_flag_dev_class) && 97 (id->bDeviceClass != info->bDeviceClass)) { 98 continue; 99 } 100 if ((id->match_flag_dev_subclass) && 101 (id->bDeviceSubClass != info->bDeviceSubClass)) { 102 continue; 103 } 104 if ((id->match_flag_dev_protocol) && 105 (id->bDeviceProtocol != info->bDeviceProtocol)) { 106 continue; 107 } 108 if ((id->match_flag_int_class) && 109 (id->bInterfaceClass != info->bInterfaceClass)) { 110 continue; 111 } 112 if ((id->match_flag_int_subclass) && 113 (id->bInterfaceSubClass != info->bInterfaceSubClass)) { 114 continue; 115 } 116 if ((id->match_flag_int_protocol) && 117 (id->bInterfaceProtocol != info->bInterfaceProtocol)) { 118 continue; 119 } 120 /* We found a match! */ 121 return (id); 122 } 123 124 done: 125 return (NULL); 126 } 127 128 /*------------------------------------------------------------------------* 129 * usbd_lookup_id_by_uaa - factored out code 130 * 131 * Return values: 132 * 0: Success 133 * Else: Failure 134 *------------------------------------------------------------------------*/ 135 int 136 usbd_lookup_id_by_uaa(const struct usb_device_id *id, usb_size_t sizeof_id, 137 struct usb_attach_arg *uaa) 138 { 139 id = usbd_lookup_id_by_info(id, sizeof_id, &uaa->info); 140 if (id) { 141 /* copy driver info */ 142 uaa->driver_info = id->driver_info; 143 return (0); 144 } 145 return (ENXIO); 146 } 147 148 /*------------------------------------------------------------------------* 149 * Export the USB device ID format we use to userspace tools. 150 *------------------------------------------------------------------------*/ 151 #if BYTE_ORDER == BIG_ENDIAN 152 #define U16_XOR "8" 153 #define U32_XOR "12" 154 #define U64_XOR "56" 155 #define U8_BITFIELD_XOR "7" 156 #define U16_BITFIELD_XOR "15" 157 #define U32_BITFIELD_XOR "31" 158 #define U64_BITFIELD_XOR "63" 159 #else 160 #define U16_XOR "0" 161 #define U32_XOR "0" 162 #define U64_XOR "0" 163 #define U8_BITFIELD_XOR "0" 164 #define U16_BITFIELD_XOR "0" 165 #define U32_BITFIELD_XOR "0" 166 #define U64_BITFIELD_XOR "0" 167 #endif 168 169 #if USB_HAVE_COMPAT_LINUX 170 #define MFL_SIZE "1" 171 #else 172 #define MFL_SIZE "0" 173 #endif 174 175 #if defined(KLD_MODULE) && (USB_HAVE_ID_SECTION != 0) 176 static const char __section("bus_autoconf_format") __used usb_id_format[] = { 177 178 /* Declare that three different sections use the same format */ 179 180 "usb_host_id{256,:}" 181 "usb_device_id{256,:}" 182 "usb_dual_id{256,:}" 183 184 /* List size of fields in the usb_device_id structure */ 185 186 #if ULONG_MAX >= 0xFFFFFFFFUL 187 "unused{0,8}" 188 "unused{0,8}" 189 "unused{0,8}" 190 "unused{0,8}" 191 #if ULONG_MAX >= 0xFFFFFFFFFFFFFFFFULL 192 "unused{0,8}" 193 "unused{0,8}" 194 "unused{0,8}" 195 "unused{0,8}" 196 #endif 197 #else 198 #error "Please update code." 199 #endif 200 201 "idVendor[0]{" U16_XOR ",8}" 202 "idVendor[1]{" U16_XOR ",8}" 203 "idProduct[0]{" U16_XOR ",8}" 204 "idProduct[1]{" U16_XOR ",8}" 205 "bcdDevice_lo[0]{" U16_XOR ",8}" 206 "bcdDevice_lo[1]{" U16_XOR ",8}" 207 "bcdDevice_hi[0]{" U16_XOR ",8}" 208 "bcdDevice_hi[1]{" U16_XOR ",8}" 209 210 "bDeviceClass{0,8}" 211 "bDeviceSubClass{0,8}" 212 "bDeviceProtocol{0,8}" 213 "bInterfaceClass{0,8}" 214 "bInterfaceSubClass{0,8}" 215 "bInterfaceProtocol{0,8}" 216 217 "mf_vendor{" U8_BITFIELD_XOR ",1}" 218 "mf_product{" U8_BITFIELD_XOR ",1}" 219 "mf_dev_lo{" U8_BITFIELD_XOR ",1}" 220 "mf_dev_hi{" U8_BITFIELD_XOR ",1}" 221 222 "mf_dev_class{" U8_BITFIELD_XOR ",1}" 223 "mf_dev_subclass{" U8_BITFIELD_XOR ",1}" 224 "mf_dev_protocol{" U8_BITFIELD_XOR ",1}" 225 "mf_int_class{" U8_BITFIELD_XOR ",1}" 226 227 "mf_int_subclass{" U8_BITFIELD_XOR ",1}" 228 "mf_int_protocol{" U8_BITFIELD_XOR ",1}" 229 "unused{" U8_BITFIELD_XOR ",6}" 230 231 "mfl_vendor{" U16_XOR "," MFL_SIZE "}" 232 "mfl_product{" U16_XOR "," MFL_SIZE "}" 233 "mfl_dev_lo{" U16_XOR "," MFL_SIZE "}" 234 "mfl_dev_hi{" U16_XOR "," MFL_SIZE "}" 235 236 "mfl_dev_class{" U16_XOR "," MFL_SIZE "}" 237 "mfl_dev_subclass{" U16_XOR "," MFL_SIZE "}" 238 "mfl_dev_protocol{" U16_XOR "," MFL_SIZE "}" 239 "mfl_int_class{" U16_XOR "," MFL_SIZE "}" 240 241 "mfl_int_subclass{" U16_XOR "," MFL_SIZE "}" 242 "mfl_int_protocol{" U16_XOR "," MFL_SIZE "}" 243 "unused{" U16_XOR "," MFL_SIZE "}" 244 "unused{" U16_XOR "," MFL_SIZE "}" 245 246 "unused{" U16_XOR "," MFL_SIZE "}" 247 "unused{" U16_XOR "," MFL_SIZE "}" 248 "unused{" U16_XOR "," MFL_SIZE "}" 249 "unused{" U16_XOR "," MFL_SIZE "}" 250 }; 251 #endif 252