/*      $OpenBSD: umidi_quirks.h,v 1.4 2008/06/26 05:42:19 ray Exp $    */
/*      $NetBSD: umidi_quirks.h,v 1.2 2001/09/29 22:00:47 tshiozak Exp $        */

/*
 * Copyright (c) 2001 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Takuya SHIOZAKI (tshiozak@netbsd.org).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/*
 * quirk code for UMIDI
 */

#ifndef _DEV_USB_UMIDI_QUIRKS_H_
#define _DEV_USB_UMIDI_QUIRKS_H_

struct umq_data {
        int             type;
#define UMQ_TYPE_FIXED_EP       1
#define UMQ_TYPE_YAMAHA         2
        void            *data;
};

struct umidi_quirk {
        int                     vendor;
        int                     product;
        int                     iface;
        struct umq_data         *quirks;
        u_int32_t               type_mask;
};
#define UMQ_ISTYPE(q, type) \
        ((q)->sc_quirk && ((q)->sc_quirk->type_mask & (1<<((type)-1))))

#define UMQ_TERMINATOR  { 0, }
#define UMQ_DEF(v, p, i)                                        \
static struct umq_data  umq_##v##_##p##_##i[]
#define UMQ_REG(v, p, i)                                        \
        { USB_VENDOR_##v, USB_PRODUCT_##p, i,                   \
          umq_##v##_##p##_##i, 0 }
#define ANYIFACE                        -1
#define ANYVENDOR                       -1
#define USB_VENDOR_ANYVENDOR            ANYVENDOR
#define ANYPRODUCT                      -1
#define USB_PRODUCT_ANYPRODUCT          ANYPRODUCT

/*
 * quirk - fixed port
 */

struct umq_fixed_ep_endpoint {
        int     ep;
        int     num_jacks;
};
struct umq_fixed_ep_desc {
        int                             num_out_ep;
        int                             num_in_ep;
        struct umq_fixed_ep_endpoint    *out_ep;
        struct umq_fixed_ep_endpoint    *in_ep;
};

#define UMQ_FIXED_EP_DEF(v, p, i, noep, niep)                           \
static struct umq_fixed_ep_endpoint                                     \
umq_##v##_##p##_##i##_fixed_ep_endpoints[noep+niep];                    \
static struct umq_fixed_ep_desc                                         \
umq_##v##_##p##_##i##_fixed_ep_desc = {                                 \
        noep, niep,                                                     \
        &umq_##v##_##p##_##i##_fixed_ep_endpoints[0],                   \
        &umq_##v##_##p##_##i##_fixed_ep_endpoints[noep],                \
};                                                                      \
static struct umq_fixed_ep_endpoint                                     \
umq_##v##_##p##_##i##_fixed_ep_endpoints[noep+niep]

#define UMQ_FIXED_EP_REG(v, p, i)                                       \
{ UMQ_TYPE_FIXED_EP, (void *)&umq_##v##_##p##_##i##_fixed_ep_desc }


/*
 * quirk - yamaha style midi I/F
 */
#define UMQ_YAMAHA_REG(v, p, i)                                         \
{ UMQ_TYPE_YAMAHA, NULL }


/* extern struct umidi_quirk umidi_quirklist[]; */
struct umidi_quirk *umidi_search_quirk(int, int, int);
void umidi_print_quirk(struct umidi_quirk *);
void *umidi_get_quirk_data_from_type(struct umidi_quirk *, u_int32_t);

#endif