xref: /dflybsd-src/sys/dev/sound/pci/emu10kx-midi.c (revision 17975de10935ff2c43fe8eb641c048974acb07c0)
16c94880fSSascha Wildner /*-
26c94880fSSascha Wildner  * Copyright (c) 1999 Seigo Tanimura
36c94880fSSascha Wildner  * Copyright (c) 2003 Mathew Kanner
46c94880fSSascha Wildner  * Copyright (c) 2003-2006 Yuriy Tsibizov <yuriy.tsibizov@gfk.ru>
56c94880fSSascha Wildner  * All rights reserved
66c94880fSSascha Wildner  *
76c94880fSSascha Wildner  * Redistribution and use in source and binary forms, with or without
86c94880fSSascha Wildner  * modification, are permitted provided that the following conditions
96c94880fSSascha Wildner  * are met:
106c94880fSSascha Wildner  * 1. Redistributions of source code must retain the above copyright
116c94880fSSascha Wildner  *    notice, this list of conditions and the following disclaimer.
126c94880fSSascha Wildner  * 2. Redistributions in binary form must reproduce the above copyright
136c94880fSSascha Wildner  *    notice, this list of conditions and the following disclaimer in the
146c94880fSSascha Wildner  *    documentation and/or other materials provided with the distribution.
156c94880fSSascha Wildner  *
166c94880fSSascha Wildner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
176c94880fSSascha Wildner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
186c94880fSSascha Wildner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
196c94880fSSascha Wildner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
206c94880fSSascha Wildner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
216c94880fSSascha Wildner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
226c94880fSSascha Wildner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
236c94880fSSascha Wildner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
246c94880fSSascha Wildner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
256c94880fSSascha Wildner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
266c94880fSSascha Wildner  * SUCH DAMAGE.
276c94880fSSascha Wildner  *
286c94880fSSascha Wildner  * $FreeBSD: head/sys/dev/sound/pci/emu10kx-midi.c 246128 2013-01-30 18:01:20Z sbz $
296c94880fSSascha Wildner  */
306c94880fSSascha Wildner 
316c94880fSSascha Wildner #include <sys/param.h>
326c94880fSSascha Wildner #include <sys/types.h>
336c94880fSSascha Wildner #include <sys/bus.h>
346c94880fSSascha Wildner #include <sys/rman.h>
356c94880fSSascha Wildner #include <sys/systm.h>
366c94880fSSascha Wildner #include <sys/sbuf.h>
376c94880fSSascha Wildner #include <sys/queue.h>
386c94880fSSascha Wildner #include <sys/lock.h>
396c94880fSSascha Wildner 
406c94880fSSascha Wildner #ifdef HAVE_KERNEL_OPTION_HEADERS
416c94880fSSascha Wildner #include "opt_snd.h"
426c94880fSSascha Wildner #endif
436c94880fSSascha Wildner 
446c94880fSSascha Wildner #include <dev/sound/chip.h>
456c94880fSSascha Wildner #include <dev/sound/pcm/sound.h>
466c94880fSSascha Wildner 
476c94880fSSascha Wildner #include <dev/sound/midi/midi.h>
486c94880fSSascha Wildner #include <dev/sound/midi/mpu401.h>
496c94880fSSascha Wildner #include "mpufoi_if.h"
506c94880fSSascha Wildner 
516c94880fSSascha Wildner #include <dev/sound/pci/emuxkireg.h>
526c94880fSSascha Wildner #include <dev/sound/pci/emu10kx.h>
536c94880fSSascha Wildner 
546c94880fSSascha Wildner struct emu_midi_softc {
55af11d9eeSSascha Wildner 	struct lock	lock;
566c94880fSSascha Wildner 	device_t	dev;
576c94880fSSascha Wildner 	struct mpu401	*mpu;
586c94880fSSascha Wildner 	mpu401_intr_t	*mpu_intr;
596c94880fSSascha Wildner 	struct emu_sc_info *card;
606c94880fSSascha Wildner 	int		port;			/* I/O port or I/O ptr reg */
616c94880fSSascha Wildner 	int		is_emu10k1;
626c94880fSSascha Wildner 	int		fflags;			/* File flags */
636c94880fSSascha Wildner 	int		ihandle;		/* interrupt manager handle */
646c94880fSSascha Wildner };
656c94880fSSascha Wildner 
666c94880fSSascha Wildner static uint32_t	emu_midi_card_intr(void *p, uint32_t arg);
676c94880fSSascha Wildner static devclass_t emu_midi_devclass;
686c94880fSSascha Wildner 
696c94880fSSascha Wildner static unsigned char
emu_mread(struct mpu401 * arg __unused,void * cookie,int reg)706c94880fSSascha Wildner emu_mread(struct mpu401 *arg __unused, void *cookie, int reg)
716c94880fSSascha Wildner {
726c94880fSSascha Wildner 	struct emu_midi_softc *sc = cookie;
736c94880fSSascha Wildner 	unsigned int d;
746c94880fSSascha Wildner 
756c94880fSSascha Wildner 	d = 0;
766c94880fSSascha Wildner 	if (sc->is_emu10k1)
776c94880fSSascha Wildner 		d = emu_rd(sc->card, 0x18 + reg, 1);
786c94880fSSascha Wildner 	else
796c94880fSSascha Wildner 		d = emu_rdptr(sc->card, 0, sc->port + reg);
806c94880fSSascha Wildner 
816c94880fSSascha Wildner 	return (d);
826c94880fSSascha Wildner }
836c94880fSSascha Wildner 
846c94880fSSascha Wildner static void
emu_mwrite(struct mpu401 * arg __unused,void * cookie,int reg,unsigned char b)856c94880fSSascha Wildner emu_mwrite(struct mpu401 *arg __unused, void *cookie, int reg, unsigned char b)
866c94880fSSascha Wildner {
876c94880fSSascha Wildner 	struct emu_midi_softc *sc = cookie;
886c94880fSSascha Wildner 
896c94880fSSascha Wildner 	if (sc->is_emu10k1)
906c94880fSSascha Wildner 		emu_wr(sc->card, 0x18 + reg, b, 1);
916c94880fSSascha Wildner 	else
926c94880fSSascha Wildner 		emu_wrptr(sc->card, 0, sc->port + reg, b);
936c94880fSSascha Wildner }
946c94880fSSascha Wildner 
956c94880fSSascha Wildner static int
emu_muninit(struct mpu401 * arg __unused,void * cookie)966c94880fSSascha Wildner emu_muninit(struct mpu401 *arg __unused, void *cookie)
976c94880fSSascha Wildner {
986c94880fSSascha Wildner 	struct emu_midi_softc *sc = cookie;
996c94880fSSascha Wildner 
100af11d9eeSSascha Wildner 	lockmgr(&sc->lock, LK_EXCLUSIVE);
1016c94880fSSascha Wildner 	sc->mpu_intr = NULL;
102af11d9eeSSascha Wildner 	lockmgr(&sc->lock, LK_RELEASE);
1036c94880fSSascha Wildner 
1046c94880fSSascha Wildner 	return (0);
1056c94880fSSascha Wildner }
1066c94880fSSascha Wildner 
1076c94880fSSascha Wildner static kobj_method_t emu_mpu_methods[] = {
1086c94880fSSascha Wildner 	KOBJMETHOD(mpufoi_read, emu_mread),
1096c94880fSSascha Wildner 	KOBJMETHOD(mpufoi_write, emu_mwrite),
1106c94880fSSascha Wildner 	KOBJMETHOD(mpufoi_uninit, emu_muninit),
1116c94880fSSascha Wildner 	KOBJMETHOD_END
1126c94880fSSascha Wildner };
1136c94880fSSascha Wildner static DEFINE_CLASS(emu_mpu, emu_mpu_methods, 0);
1146c94880fSSascha Wildner 
1156c94880fSSascha Wildner static uint32_t
emu_midi_card_intr(void * p,uint32_t intr_status)1166c94880fSSascha Wildner emu_midi_card_intr(void *p, uint32_t intr_status)
1176c94880fSSascha Wildner {
1186c94880fSSascha Wildner 	struct emu_midi_softc *sc = (struct emu_midi_softc *)p;
1196c94880fSSascha Wildner 	if (sc->mpu_intr)
1206c94880fSSascha Wildner 		(sc->mpu_intr) (sc->mpu);
1216c94880fSSascha Wildner 	if (sc->mpu_intr == NULL) {
1226c94880fSSascha Wildner 		/* We should read MIDI event to unlock card after
1236c94880fSSascha Wildner 		 * interrupt. XXX - check, why this happens.  */
1246c94880fSSascha Wildner 		if (bootverbose)
1256c94880fSSascha Wildner 			device_printf(sc->dev, "midi interrupt %08x without interrupt handler, force mread!\n", intr_status);
1266c94880fSSascha Wildner 		(void)emu_mread((void *)(NULL), sc, 0);
1276c94880fSSascha Wildner 	}
1286c94880fSSascha Wildner 	return (intr_status); /* Acknowledge everything */
1296c94880fSSascha Wildner }
1306c94880fSSascha Wildner 
1316c94880fSSascha Wildner static void
emu_midi_intr(void * p)1326c94880fSSascha Wildner emu_midi_intr(void *p)
1336c94880fSSascha Wildner {
1346c94880fSSascha Wildner 	(void)emu_midi_card_intr(p, 0);
1356c94880fSSascha Wildner }
1366c94880fSSascha Wildner 
1376c94880fSSascha Wildner static int
emu_midi_probe(device_t dev)1386c94880fSSascha Wildner emu_midi_probe(device_t dev)
1396c94880fSSascha Wildner {
1406c94880fSSascha Wildner 	struct emu_midi_softc *scp;
1416c94880fSSascha Wildner 	uintptr_t func, r, is_emu10k1;
1426c94880fSSascha Wildner 
1436c94880fSSascha Wildner 	r = BUS_READ_IVAR(device_get_parent(dev), dev, 0, &func);
1446c94880fSSascha Wildner 	if (func != SCF_MIDI)
1456c94880fSSascha Wildner 		return (ENXIO);
1466c94880fSSascha Wildner 
1476c94880fSSascha Wildner 	scp = device_get_softc(dev);
1486c94880fSSascha Wildner 	bzero(scp, sizeof(*scp));
1496c94880fSSascha Wildner 	r = BUS_READ_IVAR(device_get_parent(dev), dev, EMU_VAR_ISEMU10K1, &is_emu10k1);
1506c94880fSSascha Wildner 	scp->is_emu10k1 = is_emu10k1 ? 1 : 0;
1516c94880fSSascha Wildner 
1526c94880fSSascha Wildner 	device_set_desc(dev, "EMU10Kx MIDI Interface");
1536c94880fSSascha Wildner 	return (0);
1546c94880fSSascha Wildner }
1556c94880fSSascha Wildner 
1566c94880fSSascha Wildner static int
emu_midi_attach(device_t dev)1576c94880fSSascha Wildner emu_midi_attach(device_t dev)
1586c94880fSSascha Wildner {
1596c94880fSSascha Wildner 	struct emu_midi_softc * scp;
1606c94880fSSascha Wildner 	struct sndcard_func *func;
1616c94880fSSascha Wildner 	struct emu_midiinfo *midiinfo;
1626c94880fSSascha Wildner 	uint32_t inte_val, ipr_val;
1636c94880fSSascha Wildner 
1646c94880fSSascha Wildner 	scp = device_get_softc(dev);
1656c94880fSSascha Wildner 	func = device_get_ivars(dev);
1666c94880fSSascha Wildner 
1676c94880fSSascha Wildner 	scp->dev = dev;
1686c94880fSSascha Wildner 	midiinfo = (struct emu_midiinfo *)func->varinfo;
1696c94880fSSascha Wildner 	scp->port = midiinfo->port;
1706c94880fSSascha Wildner 	scp->card = midiinfo->card;
1716c94880fSSascha Wildner 
172af11d9eeSSascha Wildner 	lockinit(&scp->lock, device_get_nameunit(dev), 0, LK_CANRECURSE);
1736c94880fSSascha Wildner 
1746c94880fSSascha Wildner 	if (scp->is_emu10k1) {
1756c94880fSSascha Wildner 		/* SB Live! - only one MIDI device here */
1766c94880fSSascha Wildner 		inte_val = 0;
1776c94880fSSascha Wildner 		/* inte_val |= EMU_INTE_MIDITXENABLE;*/
1786c94880fSSascha Wildner 		inte_val |= EMU_INTE_MIDIRXENABLE;
1796c94880fSSascha Wildner 		ipr_val = EMU_IPR_MIDITRANSBUFE;
1806c94880fSSascha Wildner 		ipr_val |= EMU_IPR_MIDIRECVBUFE;
1816c94880fSSascha Wildner 	} else {
1826c94880fSSascha Wildner 		if (scp->port == EMU_A_MUDATA1) {
1836c94880fSSascha Wildner 			/* EXTERNAL MIDI (AudigyDrive) */
1846c94880fSSascha Wildner 			inte_val = 0;
1856c94880fSSascha Wildner 			/* inte_val |= A_EMU_INTE_MIDITXENABLE1;*/
1866c94880fSSascha Wildner 			inte_val |= EMU_INTE_MIDIRXENABLE;
1876c94880fSSascha Wildner 			ipr_val = EMU_IPR_MIDITRANSBUFE;
1886c94880fSSascha Wildner 			ipr_val |= EMU_IPR_MIDIRECVBUFE;
1896c94880fSSascha Wildner 		} else {
1906c94880fSSascha Wildner 			/* MIDI hw config port 2 */
1916c94880fSSascha Wildner 			inte_val = 0;
1926c94880fSSascha Wildner 			/* inte_val |= A_EMU_INTE_MIDITXENABLE2;*/
1936c94880fSSascha Wildner 			inte_val |= EMU_INTE_A_MIDIRXENABLE2;
1946c94880fSSascha Wildner 			ipr_val = EMU_IPR_A_MIDITRANSBUFE2;
1956c94880fSSascha Wildner 			ipr_val |= EMU_IPR_A_MIDIRECBUFE2;
1966c94880fSSascha Wildner 		}
1976c94880fSSascha Wildner 	}
1986c94880fSSascha Wildner 
1996c94880fSSascha Wildner 	scp->ihandle = emu_intr_register(scp->card, inte_val, ipr_val, &emu_midi_card_intr, scp);
2006c94880fSSascha Wildner 	/* Init the interface. */
2016c94880fSSascha Wildner 	scp->mpu = mpu401_init(&emu_mpu_class, scp, emu_midi_intr, &scp->mpu_intr);
2026c94880fSSascha Wildner 	if (scp->mpu == NULL) {
2036c94880fSSascha Wildner 		emu_intr_unregister(scp->card, scp->ihandle);
204af11d9eeSSascha Wildner 		lockuninit(&scp->lock);
2056c94880fSSascha Wildner 		return (ENOMEM);
2066c94880fSSascha Wildner 	}
2076c94880fSSascha Wildner 	/*
2086c94880fSSascha Wildner 	 * XXX I don't know how to check for Live!Drive / AudigyDrive
2096c94880fSSascha Wildner 	 * presence. Let's hope that IR enabling code will not harm if
2106c94880fSSascha Wildner 	 * it is not present.
2116c94880fSSascha Wildner 	 */
2126c94880fSSascha Wildner 	if (scp->is_emu10k1)
2136c94880fSSascha Wildner 		emu_enable_ir(scp->card);
2146c94880fSSascha Wildner 	else {
2156c94880fSSascha Wildner 		if (scp->port == EMU_A_MUDATA1)
2166c94880fSSascha Wildner 			emu_enable_ir(scp->card);
2176c94880fSSascha Wildner 	}
2186c94880fSSascha Wildner 
2196c94880fSSascha Wildner 	return (0);
2206c94880fSSascha Wildner }
2216c94880fSSascha Wildner 
2226c94880fSSascha Wildner 
2236c94880fSSascha Wildner static int
emu_midi_detach(device_t dev)2246c94880fSSascha Wildner emu_midi_detach(device_t dev)
2256c94880fSSascha Wildner {
2266c94880fSSascha Wildner 	struct emu_midi_softc *scp;
2276c94880fSSascha Wildner 
2286c94880fSSascha Wildner 	scp = device_get_softc(dev);
2296c94880fSSascha Wildner 	mpu401_uninit(scp->mpu);
2306c94880fSSascha Wildner 	emu_intr_unregister(scp->card, scp->ihandle);
231af11d9eeSSascha Wildner 	lockuninit(&scp->lock);
2326c94880fSSascha Wildner 	return (0);
2336c94880fSSascha Wildner }
2346c94880fSSascha Wildner 
2356c94880fSSascha Wildner static device_method_t emu_midi_methods[] = {
2366c94880fSSascha Wildner 	DEVMETHOD(device_probe, emu_midi_probe),
2376c94880fSSascha Wildner 	DEVMETHOD(device_attach, emu_midi_attach),
2386c94880fSSascha Wildner 	DEVMETHOD(device_detach, emu_midi_detach),
2396c94880fSSascha Wildner 
2406c94880fSSascha Wildner 	DEVMETHOD_END
2416c94880fSSascha Wildner };
2426c94880fSSascha Wildner 
2436c94880fSSascha Wildner static driver_t emu_midi_driver = {
2446c94880fSSascha Wildner 	"midi",
2456c94880fSSascha Wildner 	emu_midi_methods,
2466c94880fSSascha Wildner 	sizeof(struct emu_midi_softc),
2476c94880fSSascha Wildner };
248*17975de1SSascha Wildner DRIVER_MODULE(snd_emu10kx_midi, emu10kx, emu_midi_driver, emu_midi_devclass,
249*17975de1SSascha Wildner     NULL, NULL);
2506c94880fSSascha Wildner MODULE_DEPEND(snd_emu10kx_midi, snd_emu10kx, SND_EMU10KX_MINVER, SND_EMU10KX_PREFVER, SND_EMU10KX_MAXVER);
2516c94880fSSascha Wildner MODULE_DEPEND(snd_emu10kx_midi, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
2526c94880fSSascha Wildner MODULE_VERSION(snd_emu10kx_midi, SND_EMU10KX_PREFVER);
253