sys/dev/sound/pci/emu10kx-midi.c

   1 /*-
   2  * Copyright (c) 1999 Seigo Tanimura
   3  * Copyright (c) 2003 Mathew Kanner
   4  * Copyright (c) 2003-2006 Yuriy Tsibizov <yuriy.tsibizov@gfk.ru>
   5  * All rights reserved
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #include <sys/param.h>
  32 #include <sys/types.h>
  33 #include <sys/bus.h>
  34 #include <machine/bus.h>
  35 #include <sys/rman.h>
  36 #include <sys/systm.h>
  37 #include <sys/sbuf.h>
  38 #include <sys/queue.h>
  39 #include <sys/lock.h>
  40 #include <sys/mutex.h>
  41
  42 #ifdef HAVE_KERNEL_OPTION_HEADERS
  43 #include "opt_snd.h"
  44 #endif
  45
  46 #include <dev/sound/chip.h>
  47 #include <dev/sound/pcm/sound.h>
  48
  49 #include <dev/sound/midi/midi.h>
  50 #include <dev/sound/midi/mpu401.h>
  51 #include "mpufoi_if.h"
  52
  53 #include <dev/sound/pci/emuxkireg.h>
  54 #include <dev/sound/pci/emu10kx.h>
  55
  56 struct emu_midi_softc {
  57         struct mtx      mtx;
  58         device_t        dev;
  59         struct mpu401   *mpu;
  60         mpu401_intr_t   *mpu_intr;
  61         struct emu_sc_info *card;
  62         int             port;                   /* I/O port or I/O ptr reg */
  63         int             is_emu10k1;
  64         int             fflags;                 /* File flags */
  65         int             ihandle;                /* interrupt manager handle */
  66 };
  67
  68 static uint32_t emu_midi_card_intr(void *p, uint32_t arg);
  69 static devclass_t emu_midi_devclass;
  70
  71 static unsigned char
  72 emu_mread(struct mpu401 *arg __unused, void *cookie, int reg)
  73 {
  74         struct emu_midi_softc *sc = cookie;
  75         unsigned int d;
  76
  77         d = 0;
  78         if (sc->is_emu10k1)
  79                 d = emu_rd(sc->card, 0x18 + reg, 1);
  80         else
  81                 d = emu_rdptr(sc->card, 0, sc->port + reg);
  82
  83         return (d);
  84 }
  85
  86 static void
  87 emu_mwrite(struct mpu401 *arg __unused, void *cookie, int reg, unsigned char b)
  88 {
  89         struct emu_midi_softc *sc = cookie;
  90
  91         if (sc->is_emu10k1)
  92                 emu_wr(sc->card, 0x18 + reg, b, 1);
  93         else
  94                 emu_wrptr(sc->card, 0, sc->port + reg, b);
  95 }
  96
  97 static int
  98 emu_muninit(struct mpu401 *arg __unused, void *cookie)
  99 {
 100         struct emu_midi_softc *sc = cookie;
 101
 102         mtx_lock(&sc->mtx);
 103         sc->mpu_intr = NULL;
 104         mtx_unlock(&sc->mtx);
 105
 106         return (0);
 107 }
 108
 109 static kobj_method_t emu_mpu_methods[] = {
 110         KOBJMETHOD(mpufoi_read, emu_mread),
 111         KOBJMETHOD(mpufoi_write, emu_mwrite),
 112         KOBJMETHOD(mpufoi_uninit, emu_muninit),
 113         KOBJMETHOD_END
 114 };
 115 static DEFINE_CLASS(emu_mpu, emu_mpu_methods, 0);
 116
 117 static uint32_t
 118 emu_midi_card_intr(void *p, uint32_t intr_status)
 119 {
 120         struct emu_midi_softc *sc = (struct emu_midi_softc *)p;
 121         if (sc->mpu_intr)
 122                 (sc->mpu_intr) (sc->mpu);
 123         if (sc->mpu_intr == NULL) {
 124                 /* We should read MIDI event to unlock card after
 125                  * interrupt. XXX - check, why this happens.  */
 126                 if (bootverbose)
 127                         device_printf(sc->dev, "midi interrupt %08x without interrupt handler, force mread!\n", intr_status);
 128                 (void)emu_mread((void *)(NULL), sc, 0);
 129         }
 130         return (intr_status); /* Acknowledge everything */
 131 }
 132
 133 static void
 134 emu_midi_intr(void *p)
 135 {
 136         (void)emu_midi_card_intr(p, 0);
 137 }
 138
 139 static int
 140 emu_midi_probe(device_t dev)
 141 {
 142         struct emu_midi_softc *scp;
 143         uintptr_t func, r, is_emu10k1;
 144
 145         r = BUS_READ_IVAR(device_get_parent(dev), dev, 0, &func);
 146         if (func != SCF_MIDI)
 147                 return (ENXIO);
 148
 149         scp = device_get_softc(dev);
 150         bzero(scp, sizeof(*scp));
 151         r = BUS_READ_IVAR(device_get_parent(dev), dev, EMU_VAR_ISEMU10K1, &is_emu10k1);
 152         scp->is_emu10k1 = is_emu10k1 ? 1 : 0;
 153
 154         device_set_desc(dev, "EMU10Kx MIDI Interface");
 155         return (0);
 156 }
 157
 158 static int
 159 emu_midi_attach(device_t dev)
 160 {
 161         struct emu_midi_softc * scp;
 162         struct sndcard_func *func;
 163         struct emu_midiinfo *midiinfo;
 164         uint32_t inte_val, ipr_val;
 165
 166         scp = device_get_softc(dev);
 167         func = device_get_ivars(dev);
 168
 169         scp->dev = dev;
 170         midiinfo = (struct emu_midiinfo *)func->varinfo;
 171         scp->port = midiinfo->port;
 172         scp->card = midiinfo->card;
 173
 174         mtx_init(&scp->mtx, device_get_nameunit(dev), "midi softc", MTX_DEF);
 175
 176         if (scp->is_emu10k1) {
 177                 /* SB Live! - only one MIDI device here */
 178                 inte_val = 0;
 179                 /* inte_val |= EMU_INTE_MIDITXENABLE;*/
 180                 inte_val |= EMU_INTE_MIDIRXENABLE;
 181                 ipr_val = EMU_IPR_MIDITRANSBUFE;
 182                 ipr_val |= EMU_IPR_MIDIRECVBUFE;
 183         } else {
 184                 if (scp->port == EMU_A_MUDATA1) {
 185                         /* EXTERNAL MIDI (AudigyDrive) */
 186                         inte_val = 0;
 187                         /* inte_val |= A_EMU_INTE_MIDITXENABLE1;*/
 188                         inte_val |= EMU_INTE_MIDIRXENABLE;
 189                         ipr_val = EMU_IPR_MIDITRANSBUFE;
 190                         ipr_val |= EMU_IPR_MIDIRECVBUFE;
 191                 } else {
 192                         /* MIDI hw config port 2 */
 193                         inte_val = 0;
 194                         /* inte_val |= A_EMU_INTE_MIDITXENABLE2;*/
 195                         inte_val |= EMU_INTE_A_MIDIRXENABLE2;
 196                         ipr_val = EMU_IPR_A_MIDITRANSBUFE2;
 197                         ipr_val |= EMU_IPR_A_MIDIRECBUFE2;
 198                 }
 199         }
 200
 201         scp->ihandle = emu_intr_register(scp->card, inte_val, ipr_val, &emu_midi_card_intr, scp);
 202         /* Init the interface. */
 203         scp->mpu = mpu401_init(&emu_mpu_class, scp, emu_midi_intr, &scp->mpu_intr);
 204         if (scp->mpu == NULL) {
 205                 emu_intr_unregister(scp->card, scp->ihandle);
 206                 mtx_destroy(&scp->mtx);
 207                 return (ENOMEM);
 208         }
 209         /*
 210          * XXX I don't know how to check for Live!Drive / AudigyDrive
 211          * presence. Let's hope that IR enabling code will not harm if
 212          * it is not present.
 213          */
 214         if (scp->is_emu10k1)
 215                 emu_enable_ir(scp->card);
 216         else {
 217                 if (scp->port == EMU_A_MUDATA1)
 218                         emu_enable_ir(scp->card);
 219         }
 220
 221         return (0);
 222 }
 223
 224
 225 static int
 226 emu_midi_detach(device_t dev)
 227 {
 228         struct emu_midi_softc *scp;
 229
 230         scp = device_get_softc(dev);
 231         mpu401_uninit(scp->mpu);
 232         emu_intr_unregister(scp->card, scp->ihandle);
 233         mtx_destroy(&scp->mtx);
 234         return (0);
 235 }
 236
 237 static device_method_t emu_midi_methods[] = {
 238         DEVMETHOD(device_probe, emu_midi_probe),
 239         DEVMETHOD(device_attach, emu_midi_attach),
 240         DEVMETHOD(device_detach, emu_midi_detach),
 241
 242         {0, 0},
 243 };
 244
 245 static driver_t emu_midi_driver = {
 246         "midi",
 247         emu_midi_methods,
 248         sizeof(struct emu_midi_softc),
 249 };
 250 DRIVER_MODULE(snd_emu10kx_midi, emu10kx, emu_midi_driver, emu_midi_devclass, 0, 0);
 251 MODULE_DEPEND(snd_emu10kx_midi, snd_emu10kx, SND_EMU10KX_MINVER, SND_EMU10KX_PREFVER, SND_EMU10KX_MAXVER);
 252 MODULE_DEPEND(snd_emu10kx_midi, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
 253 MODULE_VERSION(snd_emu10kx_midi, SND_EMU10KX_PREFVER);