1 /* $OpenBSD: umidi_quirks.c,v 1.17 2022/07/02 08:50:42 visa Exp $ */ 2 /* $NetBSD: umidi_quirks.c,v 1.4 2002/06/19 13:55:30 tshiozak Exp $ */ 3 4 /* 5 * Copyright (c) 2001 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Takuya SHIOZAKI (tshiozak@netbsd.org). 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #include <sys/param.h> 34 #include <sys/systm.h> 35 #include <sys/kernel.h> 36 #include <sys/device.h> 37 #include <sys/ioctl.h> 38 #include <sys/conf.h> 39 40 #include <dev/usb/usb.h> 41 #include <dev/usb/usbdi.h> 42 #include <dev/usb/usbdi_util.h> 43 44 #include <dev/usb/usbdevs.h> 45 #include <dev/usb/umidireg.h> 46 #include <dev/usb/umidivar.h> 47 #include <dev/usb/umidi_quirks.h> 48 49 /* 50 * quirk codes for UMIDI 51 */ 52 53 #ifdef UMIDIQUIRK_DEBUG 54 #define DPRINTF(x) if (umidiquirkdebug) printf x 55 #define DPRINTFN(n,x) if (umidiquirkdebug >= (n)) printf x 56 int umidiquirkdebug = 1; 57 #else 58 #define DPRINTF(x) 59 #define DPRINTFN(n,x) 60 #endif 61 62 63 /* 64 * YAMAHA UX-256 65 * --- this is a typical yamaha device, but has a broken descriptor :-< 66 */ 67 68 UMQ_FIXED_EP_DEF(YAMAHA, YAMAHA_UX256, ANYIFACE, 1, 1) = { 69 /* out */ 70 { 0, 16 }, 71 /* in */ 72 { 1, 8 } 73 }; 74 75 UMQ_DEF(YAMAHA, YAMAHA_UX256, ANYIFACE) = { 76 UMQ_FIXED_EP_REG(YAMAHA, YAMAHA_UX256, ANYIFACE), 77 UMQ_TERMINATOR 78 }; 79 80 /* 81 * ROLAND UM-1 82 */ 83 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM1, 2, 1, 1) = { 84 /* out */ 85 { 0, 1 }, 86 /* in */ 87 { 1, 1 } 88 }; 89 90 UMQ_DEF(ROLAND, ROLAND_UM1, 2) = { 91 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM1, 2), 92 UMQ_TERMINATOR 93 }; 94 95 /* 96 * ROLAND SC-8850 97 */ 98 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SC8850, 2, 1, 1) = { 99 /* out */ 100 { 0, 6 }, 101 /* in */ 102 { 1, 6 } 103 }; 104 105 UMQ_DEF(ROLAND, ROLAND_SC8850, 2) = { 106 UMQ_FIXED_EP_REG(ROLAND, ROLAND_SC8850, 2), 107 UMQ_TERMINATOR 108 }; 109 110 /* 111 * ROLAND SD-90 112 */ 113 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SD90, 2, 1, 1) = { 114 /* out */ 115 { 0, 4 }, 116 /* in */ 117 { 1, 4 } 118 }; 119 120 UMQ_DEF(ROLAND, ROLAND_SD90, 2) = { 121 UMQ_FIXED_EP_REG(ROLAND, ROLAND_SD90, 2), 122 UMQ_TERMINATOR 123 }; 124 125 126 /* 127 * ROLAND UM-880 (native mode) 128 */ 129 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM880N, 0, 1, 1) = { 130 /* out */ 131 { 0, 9 }, 132 /* in */ 133 { 1, 9 } 134 }; 135 136 UMQ_DEF(ROLAND, ROLAND_UM880N, 0) = { 137 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM880N, 0), 138 UMQ_TERMINATOR 139 }; 140 141 /* 142 * ROLAND UA-100 143 */ 144 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UA100, 2, 1, 1) = { 145 /* out */ 146 { 0, 3 }, 147 /* in */ 148 { 1, 3 } 149 }; 150 151 UMQ_DEF(ROLAND, ROLAND_UA100, 2) = { 152 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UA100, 2), 153 UMQ_TERMINATOR 154 }; 155 156 /* 157 * ROLAND UM-4 158 */ 159 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM4, 2, 1, 1) = { 160 /* out */ 161 { 0, 4 }, 162 /* in */ 163 { 1, 4 } 164 }; 165 166 UMQ_DEF(ROLAND, ROLAND_UM4, 2) = { 167 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM4, 2), 168 UMQ_TERMINATOR 169 }; 170 171 /* 172 * ROLAND U-8 173 */ 174 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_U8, 2, 1, 1) = { 175 /* out */ 176 { 0, 2 }, 177 /* in */ 178 { 1, 2 } 179 }; 180 181 UMQ_DEF(ROLAND, ROLAND_U8, 2) = { 182 UMQ_FIXED_EP_REG(ROLAND, ROLAND_U8, 2), 183 UMQ_TERMINATOR 184 }; 185 186 /* 187 * ROLAND UM-2 188 */ 189 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM2, 2, 1, 1) = { 190 /* out */ 191 { 0, 2 }, 192 /* in */ 193 { 1, 2 } 194 }; 195 196 UMQ_DEF(ROLAND, ROLAND_UM2, 2) = { 197 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM2, 2), 198 UMQ_TERMINATOR 199 }; 200 201 /* 202 * ROLAND SC-8820 203 */ 204 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SC8820, 2, 1, 1) = { 205 /* out */ 206 { 0, 5 }, /* cables 0, 1, 4 only */ 207 /* in */ 208 { 1, 5 } /* do. */ 209 }; 210 211 UMQ_DEF(ROLAND, ROLAND_SC8820, 2) = { 212 UMQ_FIXED_EP_REG(ROLAND, ROLAND_SC8820, 2), 213 UMQ_TERMINATOR 214 }; 215 216 /* 217 * ROLAND PC-300 218 */ 219 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_PC300, 2, 1, 1) = { 220 /* out */ 221 { 0, 1 }, 222 /* in */ 223 { 1, 1 } 224 }; 225 226 UMQ_DEF(ROLAND, ROLAND_PC300, 2) = { 227 UMQ_FIXED_EP_REG(ROLAND, ROLAND_PC300, 2), 228 UMQ_TERMINATOR 229 }; 230 231 /* 232 * ROLAND SK-500 233 */ 234 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SK500, 2, 1, 1) = { 235 /* out */ 236 { 0, 5 }, /* cables 0, 1, 4 only */ 237 /* in */ 238 { 1, 5 } /* do. */ 239 }; 240 241 UMQ_DEF(ROLAND, ROLAND_SK500, 2) = { 242 UMQ_FIXED_EP_REG(ROLAND, ROLAND_SK500, 2), 243 UMQ_TERMINATOR 244 }; 245 246 /* 247 * ROLAND SC-D70 248 */ 249 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SCD70, 2, 1, 1) = { 250 /* out */ 251 { 0, 3 }, 252 /* in */ 253 { 1, 3 } 254 }; 255 256 UMQ_DEF(ROLAND, ROLAND_SCD70, 2) = { 257 UMQ_FIXED_EP_REG(ROLAND, ROLAND_SCD70, 2), 258 UMQ_TERMINATOR 259 }; 260 261 /* 262 * ROLAND UM-550 263 */ 264 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM550, 0, 1, 1) = { 265 /* out */ 266 { 0, 6 }, 267 /* in */ 268 { 1, 6 } 269 }; 270 271 UMQ_DEF(ROLAND, ROLAND_UM550, 0) = { 272 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM550, 0), 273 UMQ_TERMINATOR 274 }; 275 276 /* 277 * ROLAND SD-20 278 */ 279 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SD20, 0, 1, 1) = { 280 /* out */ 281 { 0, 2 }, 282 /* in */ 283 { 1, 3 } 284 }; 285 286 UMQ_DEF(ROLAND, ROLAND_SD20, 0) = { 287 UMQ_FIXED_EP_REG(ROLAND, ROLAND_SD20, 0), 288 UMQ_TERMINATOR 289 }; 290 291 /* 292 * ROLAND SD-80 293 */ 294 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SD80, 0, 1, 1) = { 295 /* out */ 296 { 0, 4 }, 297 /* in */ 298 { 1, 4 } 299 }; 300 301 UMQ_DEF(ROLAND, ROLAND_SD80, 0) = { 302 UMQ_FIXED_EP_REG(ROLAND, ROLAND_SD80, 0), 303 UMQ_TERMINATOR 304 }; 305 306 /* 307 * ROLAND UA-700 308 */ 309 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UA700, 3, 1, 1) = { 310 /* out */ 311 { 0, 2 }, 312 /* in */ 313 { 1, 2 } 314 }; 315 316 UMQ_DEF(ROLAND, ROLAND_UA700, 3) = { 317 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UA700, 3), 318 UMQ_TERMINATOR 319 }; 320 321 /* 322 * ROLAND UM-ONE 323 */ 324 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UMONE, ANYIFACE, 1, 1) = { 325 /* out */ 326 { 0, 1 }, 327 /* in */ 328 { 1, 1 } 329 }; 330 331 UMQ_DEF(ROLAND, ROLAND_UMONE, ANYIFACE) = { 332 UMQ_FIXED_EP_REG(ROLAND, ROLAND_UMONE, ANYIFACE), 333 UMQ_TERMINATOR 334 }; 335 336 /* 337 * quirk list 338 */ 339 struct umidi_quirk umidi_quirklist[] = { 340 UMQ_REG(YAMAHA, YAMAHA_UX256, ANYIFACE), 341 UMQ_REG(ROLAND, ROLAND_UM1, 2), 342 UMQ_REG(ROLAND, ROLAND_SC8850, 2), 343 UMQ_REG(ROLAND, ROLAND_SD90, 2), 344 UMQ_REG(ROLAND, ROLAND_UM880N, 0), 345 UMQ_REG(ROLAND, ROLAND_UA100, 2), 346 UMQ_REG(ROLAND, ROLAND_UM4, 2), 347 UMQ_REG(ROLAND, ROLAND_U8, 2), 348 UMQ_REG(ROLAND, ROLAND_UM2, 2), 349 UMQ_REG(ROLAND, ROLAND_SC8820, 2), 350 UMQ_REG(ROLAND, ROLAND_PC300, 2), 351 UMQ_REG(ROLAND, ROLAND_SK500, 2), 352 UMQ_REG(ROLAND, ROLAND_SCD70, 2), 353 UMQ_REG(ROLAND, ROLAND_UM550, 0), 354 UMQ_REG(ROLAND, ROLAND_SD20, 0), 355 UMQ_REG(ROLAND, ROLAND_SD80, 0), 356 UMQ_REG(ROLAND, ROLAND_UA700, 3), 357 UMQ_REG(ROLAND, ROLAND_UMONE, ANYIFACE), 358 UMQ_TERMINATOR 359 }; 360 361 362 /* 363 * quirk utilities 364 */ 365 366 struct umidi_quirk * 367 umidi_search_quirk(int vendor, int product, int ifaceno) 368 { 369 struct umidi_quirk *p; 370 struct umq_data *q; 371 372 DPRINTF(("umidi_search_quirk: v=%d, p=%d, i=%d\n", 373 vendor, product, ifaceno)); 374 375 for (p=&umidi_quirklist[0]; p->vendor; p++) { 376 DPRINTFN(10, ("\tv=%d, p=%d, i=%d", 377 p->vendor, p->product, p->iface)); 378 if ((p->vendor==vendor || p->vendor==ANYVENDOR) && 379 (p->product==product || p->product==ANYPRODUCT) && 380 (p->iface==ifaceno || p->iface==ANYIFACE)) { 381 DPRINTFN(10, (" found\n")); 382 if (!p->type_mask) 383 /* make quirk mask */ 384 for (q=p->quirks; q->type; q++) 385 p->type_mask |= 1<<(q->type-1); 386 return p; 387 } 388 DPRINTFN(10, ("\n")); 389 } 390 391 return NULL; 392 } 393 394 static char *quirk_name[] = { 395 "NULL", 396 "Fixed Endpoint", 397 "Yamaha Specific", 398 }; 399 400 void 401 umidi_print_quirk(struct umidi_quirk *q) 402 { 403 struct umq_data *qd; 404 if (q) { 405 printf("("); 406 for (qd=q->quirks; qd->type; qd++) 407 printf("%s%s", quirk_name[qd->type], 408 (qd+1)->type?", ":")\n"); 409 } else { 410 printf("(genuine USB-MIDI)\n"); 411 } 412 } 413 414 void * 415 umidi_get_quirk_data_from_type(struct umidi_quirk *q, u_int32_t type) 416 { 417 struct umq_data *qd; 418 if (q) { 419 for (qd=q->quirks; qd->type; qd++) 420 if (qd->type == type) 421 return qd->data; 422 } 423 return NULL; 424 } 425