1 /* $NetBSD: umidi_quirks.h,v 1.5 2006/06/30 13:56:25 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@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 #define UMQ_TYPE_CN_FIXED 6 /* should be a joke, but isn't funny */ 55 #define UMQ_TYPE_MD_FIXED 7 /* in case CN_FIXED gives a weird order */ 56 void *data; 57 }; 58 59 struct umidi_quirk { 60 int vendor; 61 int product; 62 int iface; 63 struct umq_data *quirks; 64 u_int32_t type_mask; 65 }; 66 #define UMQ_ISTYPE(q, type) \ 67 ((q)->sc_quirk && ((q)->sc_quirk->type_mask & (1<<((type)-1)))) 68 69 #define UMQ_TERMINATOR { 0, } 70 #define UMQ_DEF(v, p, i) \ 71 static struct umq_data umq_##v##_##p##_##i[] 72 #define UMQ_REG(v, p, i) \ 73 { USB_VENDOR_##v, USB_PRODUCT_##p, i, \ 74 umq_##v##_##p##_##i, 0 } 75 #define ANYIFACE -1 76 #define ANYVENDOR -1 77 #define USB_VENDOR_ANYVENDOR ANYVENDOR 78 #define ANYPRODUCT -1 79 #define USB_PRODUCT_ANYPRODUCT ANYPRODUCT 80 81 /* 82 * quirk - fixed port. By the way, the ep field contains not the 83 * endpoint address, but the index of the endpoint descriptor. 84 */ 85 86 struct umq_fixed_ep_endpoint { 87 int ep; 88 int num_jacks; 89 }; 90 struct umq_fixed_ep_desc { 91 int num_out_ep; 92 int num_in_ep; 93 struct umq_fixed_ep_endpoint *out_ep; 94 struct umq_fixed_ep_endpoint *in_ep; 95 }; 96 97 #define UMQ_FIXED_EP_DEF(v, p, i, noep, niep) \ 98 static struct umq_fixed_ep_endpoint \ 99 umq_##v##_##p##_##i##_fixed_ep_endpoints[noep+niep]; \ 100 static struct umq_fixed_ep_desc \ 101 umq_##v##_##p##_##i##_fixed_ep_desc = { \ 102 noep, niep, \ 103 &umq_##v##_##p##_##i##_fixed_ep_endpoints[0], \ 104 &umq_##v##_##p##_##i##_fixed_ep_endpoints[noep], \ 105 }; \ 106 static struct umq_fixed_ep_endpoint \ 107 umq_##v##_##p##_##i##_fixed_ep_endpoints[noep+niep] 108 109 #define UMQ_FIXED_EP_REG(v, p, i) \ 110 { UMQ_TYPE_FIXED_EP, (void *)&umq_##v##_##p##_##i##_fixed_ep_desc } 111 112 /* 113 * quirk - fixed cable numbers. Supply as many values as there are jacks, 114 * in the same jack order implied by the FIXED_EP_DEF. Each value becomes 115 * the cable number of the corresponding jack. 116 */ 117 #if __STDC_VERSION__ >= 199901L 118 #define UMQ_CN_FIXED_REG(...) \ 119 { .type=UMQ_TYPE_CN_FIXED, .data=(unsigned char[]){__VA_ARGS__} } 120 #else /* assume gcc 2.95.3 */ 121 #define UMQ_CN_FIXED_REG(cns...) \ 122 { .type=UMQ_TYPE_CN_FIXED, .data=(unsigned char[]){cns} } 123 #endif 124 125 /* 126 * quirk - fixed mididev assignment. Supply pairs of numbers out, in, as 127 * many pairs as mididevs (that is, max(num_out_jack,num_in_jack)). The 128 * pairs, in order, correspond to the mididevs that will be created; in 129 * each pair, out is the index of the out_jack to bind and in is the 130 * index of the in_jack, both in the order implied by the FIXED_EP_DEF. 131 * Either out or in can be -1 to bind no out jack or in jack, respectively, 132 * to the corresponding mididev. 133 */ 134 #if __STDC_VERSION__ >= 199901L 135 #define UMQ_MD_FIXED_REG(...) \ 136 { .type=UMQ_TYPE_MD_FIXED, .data=(unsigned char[]){__VA_ARGS__} } 137 #else /* assume gcc 2.95.3 */ 138 #define UMQ_MD_FIXED_REG(mds...) \ 139 { .type=UMQ_TYPE_MD_FIXED, .data=(unsigned char[]){mds} } 140 #endif 141 142 /* 143 * generic boolean quirk, no data 144 */ 145 #define UMQ_TYPE(t) \ 146 { UMQ_TYPE_##t, NULL } 147 148 /* 149 * quirk - yamaha style midi I/F 150 */ 151 #define UMQ_YAMAHA_REG(v, p, i) \ 152 UMQ_TYPE(YAMAHA) 153 154 155 /* extern struct umidi_quirk umidi_quirklist[]; */ 156 struct umidi_quirk *umidi_search_quirk(int, int, int); 157 void umidi_print_quirk(struct umidi_quirk *); 158 void *umidi_get_quirk_data_from_type(struct umidi_quirk *, u_int32_t); 159 160 #endif 161