umidi_quirks.h revision 1.4.14.5 1 /* $NetBSD: umidi_quirks.h,v 1.4.14.5 2006/05/20 03:31:22 chap Exp $ */
2
3 /*
4 * Copyright (c) 2001 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Takuya SHIOZAKI (tshiozak (at) NetBSD.org).
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39
40 /*
41 * quirk code for UMIDI
42 */
43
44 #ifndef _DEV_USB_UMIDI_QUIRKS_H_
45 #define _DEV_USB_UMIDI_QUIRKS_H_
46
47 struct umq_data {
48 int type;
49 #define UMQ_TYPE_FIXED_EP 1
50 #define UMQ_TYPE_YAMAHA 2
51 #define UMQ_TYPE_MIDIMAN_GARBLE 3
52 #define UMQ_TYPE_CN_SEQ_PER_EP 4 /* should be default behavior, but isn't */
53 #define UMQ_TYPE_CN_SEQ_GLOBAL 5 /* shouldn't be default behavior, but is */
54 void *data;
55 };
56
57 struct umidi_quirk {
58 int vendor;
59 int product;
60 int iface;
61 struct umq_data *quirks;
62 u_int32_t type_mask;
63 };
64 #define UMQ_ISTYPE(q, type) \
65 ((q)->sc_quirk && ((q)->sc_quirk->type_mask & (1<<((type)-1))))
66
67 #define UMQ_TERMINATOR { 0, }
68 #define UMQ_DEF(v, p, i) \
69 static struct umq_data umq_##v##_##p##_##i[]
70 #define UMQ_REG(v, p, i) \
71 { USB_VENDOR_##v, USB_PRODUCT_##p, i, \
72 umq_##v##_##p##_##i, 0 }
73 #define ANYIFACE -1
74 #define ANYVENDOR -1
75 #define USB_VENDOR_ANYVENDOR ANYVENDOR
76 #define ANYPRODUCT -1
77 #define USB_PRODUCT_ANYPRODUCT ANYPRODUCT
78
79 /*
80 * quirk - fixed port. By the way, the ep field contains not the
81 * endpoint address, but the index of the endpoint descriptor.
82 */
83
84 struct umq_fixed_ep_endpoint {
85 int ep;
86 int num_jacks;
87 };
88 struct umq_fixed_ep_desc {
89 int num_out_ep;
90 int num_in_ep;
91 struct umq_fixed_ep_endpoint *out_ep;
92 struct umq_fixed_ep_endpoint *in_ep;
93 };
94
95 #define UMQ_FIXED_EP_DEF(v, p, i, noep, niep) \
96 static struct umq_fixed_ep_endpoint \
97 umq_##v##_##p##_##i##_fixed_ep_endpoints[noep+niep]; \
98 static struct umq_fixed_ep_desc \
99 umq_##v##_##p##_##i##_fixed_ep_desc = { \
100 noep, niep, \
101 &umq_##v##_##p##_##i##_fixed_ep_endpoints[0], \
102 &umq_##v##_##p##_##i##_fixed_ep_endpoints[noep], \
103 }; \
104 static struct umq_fixed_ep_endpoint \
105 umq_##v##_##p##_##i##_fixed_ep_endpoints[noep+niep]
106
107 #define UMQ_FIXED_EP_REG(v, p, i) \
108 { UMQ_TYPE_FIXED_EP, (void *)&umq_##v##_##p##_##i##_fixed_ep_desc }
109
110 /*
111 * generic boolean quirk, no data
112 */
113 #define UMQ_TYPE(t) \
114 { UMQ_TYPE_##t, NULL }
115
116 /*
117 * quirk - yamaha style midi I/F
118 */
119 #define UMQ_YAMAHA_REG(v, p, i) \
120 UMQ_TYPE(YAMAHA)
121
122
123 /* extern struct umidi_quirk umidi_quirklist[]; */
124 struct umidi_quirk *umidi_search_quirk(int, int, int);
125 void umidi_print_quirk(struct umidi_quirk *);
126 void *umidi_get_quirk_data_from_type(struct umidi_quirk *, u_int32_t);
127
128 #endif
129