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