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