Home | History | Annotate | Line # | Download | only in dev
midi_if.h revision 1.18.12.1 
      1 /*	$NetBSD: midi_if.h,v 1.18.12.1 2007/02/27 14:15:59 ad Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Lennart Augustsson (augustss (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 #ifndef _SYS_DEV_MIDI_IF_H_
     40 #define _SYS_DEV_MIDI_IF_H_
     41 
     42 #include <sys/mutex.h>
     43 
     44 struct midi_info {
     45 	const char *name;		/* Name of MIDI hardware */
     46 	int	props;
     47 };
     48 #define MIDI_PROP_OUT_INTR  1
     49 #define MIDI_PROP_CAN_INPUT 2
     50 #define MIDI_PROP_NO_OUTPUT 4
     51 
     52 struct midi_softc;
     53 
     54 struct midi_hw_if {
     55 	int	(*open)(void *, int, 	/* open hardware */
     56 			void (*)(void *, int), /* input callback */
     57 			void (*)(void *), /* output callback */
     58 			void *);
     59 	void	(*close)(void *);		/* close hardware */
     60 	int	(*output)(void *, int);	/* output a byte */
     61 	void	(*getinfo)(void *, struct midi_info *);
     62 	int	(*ioctl)(void *, u_long, caddr_t, int, struct lwp *);
     63 	void	(*get_locks)(void *, kmutex_t **, kmutex_t **);
     64 };
     65 
     66 /*
     67  * The extended hardware interface is for use by drivers that are better off
     68  * getting messages whole to transmit, rather than byte-by-byte through
     69  * output().  Two examples are midisyn (which interprets MIDI messages in
     70  * software to drive synth chips) and umidi (which has to send messages in the
     71  * packet-based USB MIDI protocol).  It is silly for them to have to reassemble
     72  * messages midi had to split up to poke through the single-byte interface.
     73  *
     74  * To register use of the extended interface, a driver will call back midi's
     75  * midi_register_hw_if_ext() function during getinfo(); thereafter midi will
     76  * deliver channel messages, system common messages other than sysex, and sysex
     77  * messages, respectively, through these methods, and use the original output
     78  * method only for system realtime messages (all of which are single byte).
     79  * Other drivers that have no reason to change from the single-byte interface
     80  * simply don't call the register function, and nothing changes for them.
     81  *
     82  * IMPORTANT: any code that provides a midi_hw_if_ext struct MUST initialize
     83  * its members BY NAME (typically with a C99-style initializer with designators)
     84  * and assure that any unused members contain zeroes (which is what C99
     85  * initializers will do), and make no assumptions about the size or order of
     86  * the struct, to allow for further extension of this interface as needed.
     87  */
     88 struct midi_hw_if_ext {
     89 	int	(*channel)(void *, int, int, u_char *, int);
     90 	int	(*common)(void *, int, u_char *, int);
     91 	int	(*sysex)(void *, u_char *, int);
     92 	int	compress:1; /* if hw wants channel msgs in compressed form */
     93 };
     94 void midi_register_hw_if_ext(struct midi_hw_if_ext *);
     95 
     96 void	midi_attach(struct midi_softc *, struct device *);
     97 struct device *midi_attach_mi(const struct midi_hw_if *, void *,
     98 				   struct device *);
     99 
    100 int	midi_unit_count(void);
    101 void	midi_getinfo(dev_t, struct midi_info *);
    102 int	midi_writebytes(int, u_char *, int);
    103 
    104 #if !defined(IPL_AUDIO)
    105 #define splaudio splbio		/* XXX */
    106 #define IPL_AUDIO IPL_BIO	/* XXX */
    107 #endif
    108 
    109 #endif /* _SYS_DEV_MIDI_IF_H_ */
    110