xref: /openbsd/sys/dev/usb/umidi_quirks.c (revision cca36db2)
1 /*	$OpenBSD: umidi_quirks.c,v 1.10 2012/02/28 23:53:02 jsg 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/malloc.h>
37 #include <sys/device.h>
38 #include <sys/ioctl.h>
39 #include <sys/conf.h>
40 #include <sys/file.h>
41 #include <sys/selinfo.h>
42 #include <sys/proc.h>
43 #include <sys/vnode.h>
44 #include <sys/poll.h>
45 
46 #include <dev/usb/usb.h>
47 #include <dev/usb/usbdi.h>
48 #include <dev/usb/usbdi_util.h>
49 
50 #include <dev/usb/usbdevs.h>
51 #include <dev/usb/uaudioreg.h>
52 #include <dev/usb/umidireg.h>
53 #include <dev/usb/umidivar.h>
54 #include <dev/usb/umidi_quirks.h>
55 
56 /*
57  * quirk codes for UMIDI
58  */
59 
60 #ifdef UMIDIQUIRK_DEBUG
61 #define DPRINTF(x)	if (umidiquirkdebug) printf x
62 #define DPRINTFN(n,x)	if (umidiquirkdebug >= (n)) printf x
63 int	umidiquirkdebug = 1;
64 #else
65 #define DPRINTF(x)
66 #define DPRINTFN(n,x)
67 #endif
68 
69 
70 /*
71  * YAMAHA UX-256
72  *  --- this is a typical yamaha device, but has a broken descriptor :-<
73  */
74 
75 UMQ_FIXED_EP_DEF(YAMAHA, YAMAHA_UX256, ANYIFACE, 1, 1) = {
76 	/* out */
77 	{ 0, 16 },
78 	/* in */
79 	{ 1, 8 }
80 };
81 
82 UMQ_DEF(YAMAHA, YAMAHA_UX256, ANYIFACE) = {
83 	UMQ_FIXED_EP_REG(YAMAHA, YAMAHA_UX256, ANYIFACE),
84 #if 0
85 	UMQ_YAMAHA_REG(YAMAHA, ANYPRODUCT, ANYIFACE),
86 #endif
87 	UMQ_TERMINATOR
88 };
89 
90 
91 /*
92  * YAMAHA generic
93  */
94 UMQ_DEF(YAMAHA, ANYPRODUCT, ANYIFACE) = {
95 	UMQ_YAMAHA_REG(YAMAHA, ANYPRODUCT, ANYIFACE),
96 	UMQ_TERMINATOR
97 };
98 
99 
100 /*
101  * ROLAND UM-1
102  */
103 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM1, 2, 1, 1) = {
104 	/* out */
105 	{ 0, 1 },
106 	/* in */
107 	{ 1, 1 }
108 };
109 
110 UMQ_DEF(ROLAND, ROLAND_UM1, 2) = {
111 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM1, 2),
112 	UMQ_TERMINATOR
113 };
114 
115 /*
116  * ROLAND SC-8850
117  */
118 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SC8850, 2, 1, 1) = {
119 	/* out */
120 	{ 0, 6 },
121 	/* in */
122 	{ 1, 6 }
123 };
124 
125 UMQ_DEF(ROLAND, ROLAND_SC8850, 2) = {
126 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_SC8850, 2),
127 	UMQ_TERMINATOR
128 };
129 
130 /*
131  * ROLAND SD-90
132  */
133 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SD90, 2, 1, 1) = {
134 	/* out */
135 	{ 0, 4 },
136 	/* in */
137 	{ 1, 4 }
138 };
139 
140 UMQ_DEF(ROLAND, ROLAND_SD90, 2) = {
141 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_SD90, 2),
142 	UMQ_TERMINATOR
143 };
144 
145 
146 /*
147  * ROLAND UM-880 (native mode)
148  */
149 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM880N, 0, 1, 1) = {
150 	/* out */
151 	{ 0, 9 },
152 	/* in */
153 	{ 1, 9 }
154 };
155 
156 UMQ_DEF(ROLAND, ROLAND_UM880N, 0) = {
157 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM880N, 0),
158 	UMQ_TERMINATOR
159 };
160 
161 /*
162  * ROLAND UA-100
163  */
164 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UA100, 2, 1, 1) = {
165 	/* out */
166 	{ 0, 3 },
167 	/* in */
168 	{ 1, 3 }
169 };
170 
171 UMQ_DEF(ROLAND, ROLAND_UA100, 2) = {
172 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UA100, 2),
173 	UMQ_TERMINATOR
174 };
175 
176 /*
177  * ROLAND UM-4
178  */
179 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM4, 2, 1, 1) = {
180 	/* out */
181 	{ 0, 4 },
182 	/* in */
183 	{ 1, 4 }
184 };
185 
186 UMQ_DEF(ROLAND, ROLAND_UM4, 2) = {
187 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM4, 2),
188 	UMQ_TERMINATOR
189 };
190 
191 /*
192  * ROLAND U-8
193  */
194 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_U8, 2, 1, 1) = {
195 	/* out */
196 	{ 0, 2 },
197 	/* in */
198 	{ 1, 2 }
199 };
200 
201 UMQ_DEF(ROLAND, ROLAND_U8, 2) = {
202 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_U8, 2),
203 	UMQ_TERMINATOR
204 };
205 
206 /*
207  * ROLAND UM-2
208  */
209 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM2, 2, 1, 1) = {
210 	/* out */
211 	{ 0, 2 },
212 	/* in */
213 	{ 1, 2 }
214 };
215 
216 UMQ_DEF(ROLAND, ROLAND_UM2, 2) = {
217 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM2, 2),
218 	UMQ_TERMINATOR
219 };
220 
221 /*
222  * ROLAND SC-8820
223  */
224 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SC8820, 2, 1, 1) = {
225 	/* out */
226 	{ 0, 5 }, /* cables 0, 1, 4 only */
227 	/* in */
228 	{ 1, 5 } /* do. */
229 };
230 
231 UMQ_DEF(ROLAND, ROLAND_SC8820, 2) = {
232 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_SC8820, 2),
233 	UMQ_TERMINATOR
234 };
235 
236 /*
237  * ROLAND PC-300
238  */
239 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_PC300, 2, 1, 1) = {
240 	/* out */
241 	{ 0, 1 },
242 	/* in */
243 	{ 1, 1 }
244 };
245 
246 UMQ_DEF(ROLAND, ROLAND_PC300, 2) = {
247 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_PC300, 2),
248 	UMQ_TERMINATOR
249 };
250 
251 /*
252  * ROLAND SK-500
253  */
254 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SK500, 2, 1, 1) = {
255 	/* out */
256 	{ 0, 5 }, /* cables 0, 1, 4 only */
257 	/* in */
258 	{ 1, 5 } /* do. */
259 };
260 
261 UMQ_DEF(ROLAND, ROLAND_SK500, 2) = {
262 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_SK500, 2),
263 	UMQ_TERMINATOR
264 };
265 
266 /*
267  * ROLAND SC-D70
268  */
269 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SCD70, 2, 1, 1) = {
270 	/* out */
271 	{ 0, 3 },
272 	/* in */
273 	{ 1, 3 }
274 };
275 
276 UMQ_DEF(ROLAND, ROLAND_SCD70, 2) = {
277 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_SCD70, 2),
278 	UMQ_TERMINATOR
279 };
280 
281 /*
282  * ROLAND UM-550
283  */
284 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UM550, 0, 1, 1) = {
285 	/* out */
286 	{ 0, 6 },
287 	/* in */
288 	{ 1, 6 }
289 };
290 
291 UMQ_DEF(ROLAND, ROLAND_UM550, 0) = {
292 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UM550, 0),
293 	UMQ_TERMINATOR
294 };
295 
296 /*
297  * ROLAND SD-20
298  */
299 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SD20, 0, 1, 1) = {
300 	/* out */
301 	{ 0, 2 },
302 	/* in */
303 	{ 1, 3 }
304 };
305 
306 UMQ_DEF(ROLAND, ROLAND_SD20, 0) = {
307 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_SD20, 0),
308 	UMQ_TERMINATOR
309 };
310 
311 /*
312  * ROLAND SD-80
313  */
314 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_SD80, 0, 1, 1) = {
315 	/* out */
316 	{ 0, 4 },
317 	/* in */
318 	{ 1, 4 }
319 };
320 
321 UMQ_DEF(ROLAND, ROLAND_SD80, 0) = {
322 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_SD80, 0),
323 	UMQ_TERMINATOR
324 };
325 
326 /*
327  * ROLAND UA-700
328  */
329 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UA700, 3, 1, 1) = {
330 	/* out */
331 	{ 0, 2 },
332 	/* in */
333 	{ 1, 2 }
334 };
335 
336 UMQ_DEF(ROLAND, ROLAND_UA700, 3) = {
337 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UA700, 3),
338 	UMQ_TERMINATOR
339 };
340 
341 /*
342  * ROLAND UM-ONE
343  */
344 UMQ_FIXED_EP_DEF(ROLAND, ROLAND_UMONE, ANYIFACE, 1, 1) = {
345 	/* out */
346 	{ 0, 1 },
347 	/* in */
348 	{ 1, 1 }
349 };
350 
351 UMQ_DEF(ROLAND, ROLAND_UMONE, ANYIFACE) = {
352 	UMQ_FIXED_EP_REG(ROLAND, ROLAND_UMONE, ANYIFACE),
353 	UMQ_TERMINATOR
354 };
355 
356 /*
357  * quirk list
358  */
359 struct umidi_quirk umidi_quirklist[] = {
360 	UMQ_REG(YAMAHA, YAMAHA_UX256, ANYIFACE),
361 	UMQ_REG(YAMAHA, ANYPRODUCT, ANYIFACE),
362 	UMQ_REG(ROLAND, ROLAND_UM1, 2),
363 	UMQ_REG(ROLAND, ROLAND_SC8850, 2),
364 	UMQ_REG(ROLAND, ROLAND_SD90, 2),
365 	UMQ_REG(ROLAND, ROLAND_UM880N, 0),
366 	UMQ_REG(ROLAND, ROLAND_UA100, 2),
367 	UMQ_REG(ROLAND, ROLAND_UM4, 2),
368 	UMQ_REG(ROLAND, ROLAND_U8, 2),
369 	UMQ_REG(ROLAND, ROLAND_UM2, 2),
370 	UMQ_REG(ROLAND, ROLAND_SC8820, 2),
371 	UMQ_REG(ROLAND, ROLAND_PC300, 2),
372 	UMQ_REG(ROLAND, ROLAND_SK500, 2),
373 	UMQ_REG(ROLAND, ROLAND_SCD70, 2),
374 	UMQ_REG(ROLAND, ROLAND_UM550, 0),
375 	UMQ_REG(ROLAND, ROLAND_SD20, 0),
376 	UMQ_REG(ROLAND, ROLAND_SD80, 0),
377 	UMQ_REG(ROLAND, ROLAND_UA700, 3),
378 	UMQ_REG(ROLAND, ROLAND_UMONE, ANYIFACE),
379 	UMQ_TERMINATOR
380 };
381 
382 
383 /*
384  * quirk utilities
385  */
386 
387 struct umidi_quirk *
388 umidi_search_quirk(int vendor, int product, int ifaceno)
389 {
390 	struct umidi_quirk *p;
391 	struct umq_data *q;
392 
393 	DPRINTF(("umidi_search_quirk: v=%d, p=%d, i=%d\n",
394 		 vendor, product, ifaceno));
395 
396 	for (p=&umidi_quirklist[0]; p->vendor; p++) {
397 		DPRINTFN(10, ("\tv=%d, p=%d, i=%d",
398 			      p->vendor, p->product, p->iface));
399 		if ((p->vendor==vendor || p->vendor==ANYVENDOR) &&
400 		    (p->product==product || p->product==ANYPRODUCT) &&
401 		    (p->iface==ifaceno || p->iface==ANYIFACE)) {
402 			DPRINTFN(10, (" found\n"));
403 			if (!p->type_mask)
404 				/* make quirk mask */
405 				for (q=p->quirks; q->type; q++)
406 					p->type_mask |= 1<<(q->type-1);
407 			return p;
408                 }
409 		DPRINTFN(10, ("\n"));
410 	}
411 
412 	return NULL;
413 }
414 
415 static char *quirk_name[] = {
416 	"NULL",
417 	"Fixed Endpoint",
418 	"Yamaha Specific",
419 };
420 
421 void
422 umidi_print_quirk(struct umidi_quirk *q)
423 {
424 	struct umq_data *qd;
425 	if (q) {
426 		printf("(");
427 		for (qd=q->quirks; qd->type; qd++)
428 			printf("%s%s", quirk_name[qd->type],
429 			       (qd+1)->type?", ":")\n");
430 	} else {
431 		printf("(genuine USB-MIDI)\n");
432 	}
433 }
434 
435 void *
436 umidi_get_quirk_data_from_type(struct umidi_quirk *q, u_int32_t type)
437 {
438 	struct umq_data *qd;
439 	if (q) {
440 		for (qd=q->quirks; qd->type; qd++)
441 			if (qd->type == type)
442 				return qd->data;
443 	}
444 	return NULL;
445 }
446