Home | History | Annotate | Line # | Download | only in dev 
      1 /*	$NetBSD: midi_if.h,v 1.27 2015/03/01 00:34:14 mrg 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  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _SYS_DEV_MIDI_IF_H_
     33 #define _SYS_DEV_MIDI_IF_H_
     34 
     35 #include <sys/mutex.h>
     36 
     37 struct midi_info {
     38 	const char *name;		/* Name of MIDI hardware */
     39 	int	props;
     40 };
     41 #define MIDI_PROP_OUT_INTR  1
     42 #define MIDI_PROP_CAN_INPUT 2
     43 #define MIDI_PROP_NO_OUTPUT 4
     44 
     45 /*
     46  * XXX expand
     47  *
     48  * List of hardware interface methods, and when locks are held by each
     49  * called by this module:
     50  *
     51  *	METHOD			INTR	NOTES
     52  *	----------------------- ------- -------------------------
     53  *	open 			-
     54  *	close 			-
     55  *	output 			-
     56  *	getinfo 		-	Called at attach time
     57  *	ioctl 			-
     58  *	get_locks 		-	Called at attach time
     59  */
     60 
     61 struct midi_softc;
     62 
     63 struct midi_hw_if {
     64 	int	(*open)(void *, int, 	/* open hardware */
     65 			void (*)(void *, int), /* input callback */
     66 			void (*)(void *), /* output callback */
     67 			void *);
     68 	void	(*close)(void *);		/* close hardware */
     69 	int	(*output)(void *, int);	/* output a byte */
     70 	void	(*getinfo)(void *, struct midi_info *);
     71 	int	(*ioctl)(void *, u_long, void *, int, struct lwp *);
     72 	void	(*get_locks)(void *, kmutex_t **, kmutex_t **);
     73 };
     74 
     75 /*
     76  * The extended hardware interface is for use by drivers that are better off
     77  * getting messages whole to transmit, rather than byte-by-byte through
     78  * output().  Two examples are midisyn (which interprets MIDI messages in
     79  * software to drive synth chips) and umidi (which has to send messages in the
     80  * packet-based USB MIDI protocol).  It is silly for them to have to reassemble
     81  * messages midi had to split up to poke through the single-byte interface.
     82  *
     83  * To register use of the extended interface, a driver will call back midi's
     84  * midi_register_hw_if_ext() function during getinfo(); thereafter midi will
     85  * deliver channel messages, system common messages other than sysex, and sysex
     86  * messages, respectively, through these methods, and use the original output
     87  * method only for system realtime messages (all of which are single byte).
     88  * Other drivers that have no reason to change from the single-byte interface
     89  * simply don't call the register function, and nothing changes for them.
     90  *
     91  * IMPORTANT: any code that provides a midi_hw_if_ext struct MUST initialize
     92  * its members BY NAME (typically with a C99-style initializer with designators)
     93  * and assure that any unused members contain zeroes (which is what C99
     94  * initializers will do), and make no assumptions about the size or order of
     95  * the struct, to allow for further extension of this interface as needed.
     96  */
     97 struct midi_hw_if_ext {
     98 	int	(*channel)(void *, int, int, u_char *, int);
     99 	int	(*common)(void *, int, u_char *, int);
    100 	int	(*sysex)(void *, u_char *, int);
    101 	int	compress:1; /* if hw wants channel msgs in compressed form */
    102 };
    103 void midi_register_hw_if_ext(struct midi_hw_if_ext *);
    104 
    105 void	midi_attach(struct midi_softc *);
    106 int	mididetach(device_t, int);
    107 device_t midi_attach_mi(const struct midi_hw_if *, void *, device_t);
    108 
    109 int	midi_unit_count(void);
    110 void	midi_getinfo(dev_t, struct midi_info *);
    111 int	midi_writebytes(int, u_char *, int);
    112 
    113 #if !defined(IPL_AUDIO)
    114 #define splaudio splbio		/* XXX */
    115 #define IPL_AUDIO IPL_BIO	/* XXX */
    116 #endif
    117 
    118 #endif /* _SYS_DEV_MIDI_IF_H_ */
    119