The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/midi_if.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: midi_if.h,v 1.21 2008/04/28 20:23:47 martin 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@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 struct midi_info {
   36         const char *name;               /* Name of MIDI hardware */
   37         int     props;
   38 };
   39 #define MIDI_PROP_OUT_INTR  1
   40 #define MIDI_PROP_CAN_INPUT 2
   41 #define MIDI_PROP_NO_OUTPUT 4
   42 
   43 struct midi_softc;
   44 
   45 struct midi_hw_if {
   46         int     (*open)(void *, int,    /* open hardware */
   47                         void (*)(void *, int), /* input callback */
   48                         void (*)(void *), /* output callback */
   49                         void *);
   50         void    (*close)(void *);               /* close hardware */
   51         int     (*output)(void *, int); /* output a byte */
   52         void    (*getinfo)(void *, struct midi_info *);
   53         int     (*ioctl)(void *, u_long, void *, int, struct lwp *);
   54 };
   55 
   56 /*
   57  * The extended hardware interface is for use by drivers that are better off
   58  * getting messages whole to transmit, rather than byte-by-byte through
   59  * output().  Two examples are midisyn (which interprets MIDI messages in
   60  * software to drive synth chips) and umidi (which has to send messages in the
   61  * packet-based USB MIDI protocol).  It is silly for them to have to reassemble
   62  * messages midi had to split up to poke through the single-byte interface.
   63  *
   64  * To register use of the extended interface, a driver will call back midi's
   65  * midi_register_hw_if_ext() function during getinfo(); thereafter midi will
   66  * deliver channel messages, system common messages other than sysex, and sysex
   67  * messages, respectively, through these methods, and use the original output
   68  * method only for system realtime messages (all of which are single byte).
   69  * Other drivers that have no reason to change from the single-byte interface
   70  * simply don't call the register function, and nothing changes for them.
   71  *
   72  * IMPORTANT: any code that provides a midi_hw_if_ext struct MUST initialize
   73  * its members BY NAME (typically with a C99-style initializer with designators)
   74  * and assure that any unused members contain zeroes (which is what C99
   75  * initializers will do), and make no assumptions about the size or order of
   76  * the struct, to allow for further extension of this interface as needed.
   77  */
   78 struct midi_hw_if_ext {
   79         int     (*channel)(void *, int, int, u_char *, int);
   80         int     (*common)(void *, int, u_char *, int);
   81         int     (*sysex)(void *, u_char *, int);
   82         int     compress:1; /* if hw wants channel msgs in compressed form */
   83 };
   84 void midi_register_hw_if_ext(struct midi_hw_if_ext *);
   85 
   86 void    midi_attach(struct midi_softc *, device_t);
   87 device_t midi_attach_mi(const struct midi_hw_if *, void *, device_t);
   88 
   89 int     midi_unit_count(void);
   90 void    midi_getinfo(dev_t, struct midi_info *);
   91 int     midi_writebytes(int, u_char *, int);
   92 
   93 #if !defined(IPL_AUDIO)
   94 #define splaudio splbio         /* XXX */
   95 #define IPL_AUDIO IPL_BIO       /* XXX */
   96 #endif
   97 
   98 #endif /* _SYS_DEV_MIDI_IF_H_ */

Cache object: a3f485f4df400da4b96d18870d713b50


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.