Home | History | Annotate | Line # | Download | only in isa
      1 /*	$NetBSD: pas.c,v 1.73 2019/12/27 09:22:20 msaitoh Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1991-1993 Regents of the University of California.
      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  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by the Computer Systems
     18  *	Engineering Group at Lawrence Berkeley Laboratory.
     19  * 4. Neither the name of the University nor of the Laboratory may be used
     20  *    to endorse or promote products derived from this software without
     21  *    specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  */
     36 /*
     37  * jfw 7/13/97 - The soundblaster code requires the generic bus-space
     38  * structures to be set up properly.  Rather than go to the effort of making
     39  * code for a dead line fully generic, properly set up the SB structures and
     40  * leave the rest x86/ISA/default-configuration specific.  If you have a
     41  * REAL computer, go buy a REAL sound card.
     42  */
     43 /*
     44  * Todo:
     45  *	- look at other PAS drivers (for PAS native support)
     46  *	- use common sb.c once emulation is setup
     47  */
     48 /*
     49  * jfw 6/21/98 - WARNING:  the PAS native IO ports are scattered all around
     50  * IO port space (0x0388, 0x738B, 0xBF88, 0x2789, ...) which will make proper
     51  * reservation a real pain, so I'm not going to do it (while fixing the
     52  * current reservation code to "work").  As a sanity check, I reserve the
     53  * 0x0388 base address, but you probably shouldn't even think of trying this
     54  * driver unless you're certain you have the hardware installed and it doesn't
     55  * conflict with other hardware...
     56  */
     57 
     58 
     59 #include <sys/cdefs.h>
     60 __KERNEL_RCSID(0, "$NetBSD: pas.c,v 1.73 2019/12/27 09:22:20 msaitoh Exp $");
     61 
     62 #include <sys/param.h>
     63 #include <sys/systm.h>
     64 #include <sys/errno.h>
     65 #include <sys/ioctl.h>
     66 #include <sys/syslog.h>
     67 #include <sys/device.h>
     68 #include <sys/proc.h>
     69 
     70 #include <sys/cpu.h>
     71 #include <sys/intr.h>
     72 #include <sys/bus.h>
     73 #include <machine/pio.h>
     74 
     75 #include <sys/audioio.h>
     76 #include <dev/audio/audio_if.h>
     77 #include <dev/midi_if.h>
     78 
     79 #include <dev/isa/isavar.h>
     80 #include <dev/isa/isadmavar.h>
     81 
     82 #include <dev/isa/sbdspvar.h>
     83 #include <dev/isa/sbreg.h>
     84 
     85 #define DEFINE_TRANSLATIONS
     86 #include <dev/isa/pasreg.h>
     87 
     88 #ifdef AUDIO_DEBUG
     89 #define DPRINTF(x)	if (pasdebug) printf x
     90 int	pasdebug = 0;
     91 #else
     92 #define DPRINTF(x)
     93 #endif
     94 
     95 /*
     96  * Software state, per SoundBlaster card.
     97  * The soundblaster has multiple functionality, which we must demultiplex.
     98  * One approach is to have one major device number for the soundblaster card,
     99  * and use different minor numbers to indicate which hardware function
    100  * we want.  This would make for one large driver.  Instead our approach
    101  * is to partition the design into a set of drivers that share an underlying
    102  * piece of hardware.  Most things are hard to share, for example, the audio
    103  * and midi ports.  For audio, we might want to mix two processes' signals,
    104  * and for midi we might want to merge streams (this is hard due to
    105  * running status).  Moreover, we should be able to re-use the high-level
    106  * modules with other kinds of hardware.  In this module, we only handle the
    107  * most basic communications with the sb card.
    108  */
    109 struct pas_softc {
    110 	struct sbdsp_softc sc_sbdsp;	/* base device, &c. */
    111 	bus_space_handle_t pas_port_handle;    /* the pas-specific port */
    112 
    113 	int model;
    114 	int rev;
    115 };
    116 
    117 int	pas_getdev(void *, struct audio_device *);
    118 void	pasconf(int, int, int, int);
    119 
    120 
    121 /*
    122  * Define our interface to the higher level audio driver.
    123  */
    124 
    125 const struct audio_hw_if pas_hw_if = {
    126 	.open			= sbdsp_open,
    127 	.close			= sbdsp_close,
    128 	.query_format		= sbdsp_query_format,
    129 	.set_format		= sbdsp_set_format,
    130 	.round_blocksize	= sbdsp_round_blocksize,
    131 	.halt_output		= sbdsp_halt_output,
    132 	.halt_input		= sbdsp_halt_input,
    133 	.speaker_ctl		= sbdsp_speaker_ctl,
    134 	.getdev			= pas_getdev,
    135 	.set_port		= sbdsp_mixer_set_port,
    136 	.get_port		= sbdsp_mixer_get_port,
    137 	.query_devinfo		= sbdsp_mixer_query_devinfo,
    138 	.allocm			= sb_malloc,
    139 	.freem			= sb_free,
    140 	.round_buffersize	= sb_round_buffersize,
    141 	.get_props		= sbdsp_get_props,
    142 	.trigger_output		= sbdsp_trigger_output,
    143 	.trigger_input		= sbdsp_trigger_input,
    144 	.get_locks		= sbdsp_get_locks,
    145 };
    146 
    147 /* The Address Translation code is used to convert I/O register addresses to
    148    be relative to the given base -register */
    149 
    150 static const char *pasnames[] = {
    151 	"",
    152 	"Plus",
    153 	"CDPC",
    154 	"16",
    155 	"16Basic"
    156 };
    157 
    158 static struct audio_device pas_device = {
    159 	"PAS,??",
    160 	"",
    161 	"pas"
    162 };
    163 
    164 /*XXX assume default I/O base address */
    165 #define pasread(p) inb((p))
    166 #define paswrite(d, p) outb((p), (d))
    167 
    168 void
    169 pasconf(int model, int sbbase, int sbirq, int sbdrq)
    170 {
    171 
    172 	paswrite(0x00, INTERRUPT_MASK);
    173 	/* Local timer control register */
    174 	paswrite(0x36, SAMPLE_COUNTER_CONTROL);
    175 	/* Sample rate timer (16 bit) */
    176 	paswrite(0x36, SAMPLE_RATE_TIMER);
    177 	paswrite(0, SAMPLE_RATE_TIMER);
    178 	/* Local timer control register */
    179 	paswrite(0x74, SAMPLE_COUNTER_CONTROL);
    180 	/* Sample count register (16 bit) */
    181 	paswrite(0x74, SAMPLE_BUFFER_COUNTER);
    182 	paswrite(0, SAMPLE_BUFFER_COUNTER);
    183 
    184 	paswrite(P_C_PCM_MONO | P_C_PCM_DAC_MODE |
    185 	    P_C_MIXER_CROSS_L_TO_L | P_C_MIXER_CROSS_R_TO_R,
    186 	    PCM_CONTROL);
    187 	paswrite(S_M_PCM_RESET | S_M_FM_RESET |
    188 	    S_M_SB_RESET | S_M_MIXER_RESET, SERIAL_MIXER);
    189 
    190 /*XXX*/
    191 	paswrite(I_C_1_BOOT_RESET_ENABLE|1, IO_CONFIGURATION_1);
    192 
    193 	paswrite(I_C_2_PCM_DMA_DISABLED, IO_CONFIGURATION_2);
    194 	paswrite(I_C_3_PCM_IRQ_DISABLED, IO_CONFIGURATION_3);
    195 
    196 #ifdef BROKEN_BUS_CLOCK
    197 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND |
    198 	    S_C_1_FM_EMULATE_CLOCK, SYSTEM_CONFIGURATION_1);
    199 #else
    200 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND,
    201 	    SYSTEM_CONFIGURATION_1);
    202 #endif
    203 
    204 	/*XXX*/
    205 	paswrite(0, SYSTEM_CONFIGURATION_2);
    206 	paswrite(0, SYSTEM_CONFIGURATION_3);
    207 
    208 	/* Sets mute off and selects filter rate of 17.897 kHz */
    209 	paswrite(F_F_MIXER_UNMUTE | 0x01, FILTER_FREQUENCY);
    210 
    211 	if (model == PAS_16 || model == PAS_16BASIC)
    212 		paswrite(8, PRESCALE_DIVIDER);
    213 	else
    214 		paswrite(0, PRESCALE_DIVIDER);
    215 
    216 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_PCM, PARALLEL_MIXER);
    217 	paswrite(5, PARALLEL_MIXER);
    218 
    219 	/*
    220 	 * Setup SoundBlaster emulation.
    221 	 */
    222 	paswrite((sbbase >> 4) & 0xf, EMULATION_ADDRESS);
    223 	paswrite(E_C_SB_IRQ_translate[sbirq] | E_C_SB_DMA_translate[sbdrq],
    224 	    EMULATION_CONFIGURATION);
    225 	paswrite(C_E_SB_ENABLE, COMPATIBILITY_ENABLE);
    226 
    227 	/*
    228 	 * Set mid-range levels.
    229 	 */
    230 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MODE, PARALLEL_MIXER);
    231 	paswrite(P_M_MV508_LOUDNESS | P_M_MV508_ENHANCE_NONE, PARALLEL_MIXER);
    232 
    233 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_A, PARALLEL_MIXER);
    234 	paswrite(50, PARALLEL_MIXER);
    235 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_B, PARALLEL_MIXER);
    236 	paswrite(50, PARALLEL_MIXER);
    237 
    238 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_SB,
    239 	    PARALLEL_MIXER);
    240 	paswrite(P_M_MV508_OUTPUTMIX | 30, PARALLEL_MIXER);
    241 
    242 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_MIC,
    243 	    PARALLEL_MIXER);
    244 	paswrite(P_M_MV508_INPUTMIX | 30, PARALLEL_MIXER);
    245 }
    246 
    247 int	pasprobe(device_t, cfdata_t, void *);
    248 void	pasattach(device_t, device_t, void *);
    249 static	int pasfind(cfdata_t, struct pas_softc *,
    250     struct isa_attach_args *, int);
    251 /* argument to pasfind */
    252 #define PASPROBE  1
    253 #define PASATTACH 0
    254 
    255 CFATTACH_DECL_NEW(pas, sizeof(struct pas_softc),
    256     pasprobe, pasattach, NULL, NULL);
    257 
    258 /*
    259  * Probe / attach routines.
    260  */
    261 
    262 int
    263 pasprobe(device_t parent, cfdata_t match, void *aux)
    264 {
    265 	struct isa_attach_args *ia;
    266 	struct pas_softc probesc, *sc;
    267 
    268 	ia = aux;
    269 	sc = &probesc;
    270 	if (ia->ia_nio < 1)
    271 		return 0;
    272 	if (ia->ia_nirq < 1)
    273 		return 0;
    274 	if (ia->ia_ndrq < 1)
    275 		return 0;
    276 
    277 	if (ISA_DIRECT_CONFIG(ia))
    278 		return 0;
    279 
    280 	memset(sc, 0, sizeof *sc);
    281 	return pasfind(match, sc, ia, PASPROBE);
    282 }
    283 
    284 /*
    285  * Probe for the soundblaster hardware.
    286  */
    287 static int
    288 pasfind(cfdata_t match, struct pas_softc *sc,
    289     struct isa_attach_args *ia, int probing)
    290 {
    291 	int iobase;
    292 	u_char id, t;
    293 	int rc;
    294 
    295 	rc = 0;			/* failure */
    296 	/* ensure we can set this up as a sound blaster */
    297 	if (!SB_BASE_VALID(ia->ia_io[0].ir_addr)) {
    298 		printf("pas: configured SB iobase 0x%x invalid\n",
    299 		    ia->ia_io[0].ir_addr);
    300 		return 0;
    301 	}
    302 
    303 	if (bus_space_map(ia->ia_iot, PAS_DEFAULT_BASE, 1, 0,
    304 	    &sc->pas_port_handle)) {
    305 		printf("pas: can't map base register %x in probe\n",
    306 		    PAS_DEFAULT_BASE);
    307 		return 0;
    308 	}
    309 
    310 	/*
    311 	 * WARNING: Setting an option like W:1 or so that disables
    312 	 * warm boot reset of the card will screw up this detect code
    313 	 * something fierce.  Adding code to handle this means possibly
    314 	 * interfering with other cards on the bus if you have something
    315 	 * on base port 0x388.  SO be forewarned.
    316 	 */
    317 	/* Talk to first board */
    318 	outb(MASTER_DECODE, 0xbc);
    319 	/* Set base address */
    320 
    321 #if 0
    322 	/* XXX Need to setup pseudo device */
    323 	/* XXX What are good io addrs ? */
    324 	if (iobase != PAS_DEFAULT_BASE) {
    325 		printf("pas: configured iobase %d invalid\n", iobase);
    326 		return 0;
    327 	}
    328 #else
    329 	/* Start out talking to native PAS */
    330 	iobase = PAS_DEFAULT_BASE;
    331 #endif
    332 
    333 	outb(MASTER_DECODE, iobase >> 2);
    334 	/* One wait-state */
    335 	paswrite(1, WAIT_STATE);
    336 
    337 	id = pasread(INTERRUPT_MASK);
    338 	if (id == 0xff || id == 0xfe) {
    339 		/* sanity */
    340 		DPRINTF(("pas: bogus card id\n"));
    341 		goto unmap1;
    342 	}
    343 	/*
    344 	 * We probably have a PAS-series board, now check for a
    345 	 * PAS2-series board by trying to change the board revision
    346 	 * bits.  PAS2-series hardware won't let you do this because
    347 	 * the bits are read-only.
    348 	 */
    349 	t = id ^ 0xe0;
    350 	paswrite(t, INTERRUPT_MASK);
    351 	t = inb(INTERRUPT_MASK);
    352 	paswrite(id, INTERRUPT_MASK);
    353 
    354 	if (t != id) {
    355 		/* Not a PAS2 */
    356 		printf("pas: detected card but PAS2 test failed\n");
    357 		goto unmap1;
    358 	}
    359 	/*XXX*/
    360 	t = pasread(OPERATION_MODE_1) & 0xf;
    361 	sc->model = O_M_1_to_card[t];
    362 	if (sc->model != 0) {
    363 		sc->rev = pasread(BOARD_REV_ID);
    364 	} else {
    365 		DPRINTF(("pas: bogus model id\n"));
    366 		goto unmap1;
    367 	}
    368 
    369 	if (sc->model >= 0) {
    370 		if (ia->ia_irq[0].ir_irq == ISA_UNKNOWN_IRQ) {
    371 			printf("pas: sb emulation requires known irq\n");
    372 			goto unmap1;
    373 		}
    374 		pasconf(sc->model, ia->ia_io[0].ir_addr,
    375 		    ia->ia_irq[0].ir_irq, 1);
    376 	} else {
    377 		DPRINTF(("pas: could not probe pas\n"));
    378 		goto unmap1;
    379 	}
    380 
    381 	/* Now a SoundBlaster, so set up proper bus-space hooks
    382          * appropriately
    383          */
    384 
    385 	sc->sc_sbdsp.sc_iobase = ia->ia_io[0].ir_addr;
    386 	sc->sc_sbdsp.sc_iot = ia->ia_iot;
    387 
    388 	/* Map i/o space [we map 24 ports which is the max of the sb and pro */
    389 	if (bus_space_map(ia->ia_iot, ia->ia_io[0].ir_addr,
    390 	    SBP_NPORT, 0, &sc->sc_sbdsp.sc_ioh)) {
    391 		printf("pas: can't map i/o space 0x%x/%d in probe\n",
    392 		    ia->ia_io[0].ir_addr, SBP_NPORT);
    393 		goto unmap1;
    394 	}
    395 
    396 	if (sbdsp_reset(&sc->sc_sbdsp) < 0) {
    397 		DPRINTF(("pas: couldn't reset card\n"));
    398 		goto unmap;
    399 	}
    400 
    401 	/*
    402 	 * Cannot auto-discover DMA channel.
    403 	 */
    404 	if (!SB_DRQ_VALID(ia->ia_drq[0].ir_drq)) {
    405 		printf("pas: configured DMA chan %d invalid\n",
    406 		    ia->ia_drq[0].ir_drq);
    407 		goto unmap;
    408 	}
    409 	if (!SB_IRQ_VALID(ia->ia_irq[0].ir_irq)) {
    410 		printf("pas: configured irq chan %d invalid\n",
    411 		    ia->ia_drq[0].ir_drq);
    412 		goto unmap;
    413 	}
    414 
    415 	sc->sc_sbdsp.sc_irq = ia->ia_irq[0].ir_irq;
    416 	sc->sc_sbdsp.sc_drq8 = ia->ia_drq[0].ir_drq;
    417 	sc->sc_sbdsp.sc_drq16 = -1; /* XXX */
    418 
    419 	if (sbdsp_probe(&sc->sc_sbdsp, match) == 0) {
    420 		DPRINTF(("pas: sbdsp probe failed\n"));
    421 		goto unmap;
    422 	}
    423 
    424 	rc = 1;
    425 
    426 	if (probing) {
    427 		ia->ia_nio = 1;
    428 		ia->ia_io[0].ir_size = SBP_NPORT;
    429 
    430 		ia->ia_nirq = 1;
    431 		ia->ia_ndrq = 1;
    432 
    433 		ia->ia_niomem = 0;
    434 	}
    435 
    436  unmap:
    437 	if (rc == 0 || probing)
    438 		bus_space_unmap(ia->ia_iot, sc->sc_sbdsp.sc_ioh,
    439 		    SBP_NPORT);
    440  unmap1:
    441 	if (rc == 0 || probing)
    442 		bus_space_unmap(ia->ia_iot, PAS_DEFAULT_BASE, 1);
    443 	return rc;
    444 }
    445 
    446 /*
    447  * Attach hardware to driver, attach hardware driver to audio
    448  * pseudo-device driver .
    449  */
    450 void
    451 pasattach(device_t parent, device_t self, void *aux)
    452 {
    453 	struct pas_softc *sc;
    454 	struct isa_attach_args *ia;
    455 	int iobase;
    456 
    457 	sc = device_private(self);
    458 	sc->sc_sbdsp.sc_dev = self;
    459 	ia = (struct isa_attach_args *)aux;
    460 	iobase = ia->ia_io[0].ir_addr;
    461 	if (!pasfind(device_cfdata(self), sc, ia, PASATTACH)) {
    462 		aprint_error_dev(self, "pasfind failed\n");
    463 		return;
    464 	}
    465 
    466 	mutex_init(&sc->sc_sbdsp.sc_lock, MUTEX_DEFAULT, IPL_NONE);
    467 	mutex_init(&sc->sc_sbdsp.sc_intr_lock, MUTEX_DEFAULT, IPL_AUDIO);
    468 
    469 	sc->sc_sbdsp.sc_ic = ia->ia_ic;
    470 	sc->sc_sbdsp.sc_iobase = iobase;
    471 	sc->sc_sbdsp.sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq[0].ir_irq,
    472 	    IST_EDGE, IPL_AUDIO, sbdsp_intr, &sc->sc_sbdsp);
    473 
    474 	aprint_normal(" ProAudio Spectrum %s [rev %d] ", pasnames[sc->model],
    475 	    sc->rev);
    476 
    477 	sbdsp_attach(&sc->sc_sbdsp);
    478 
    479 	snprintf(pas_device.name, sizeof(pas_device.name), "pas,%s",
    480 	    pasnames[sc->model]);
    481 	snprintf(pas_device.version, sizeof(pas_device.version), "%d",
    482 	    sc->rev);
    483 
    484 	audio_attach_mi(&pas_hw_if, &sc->sc_sbdsp, sc->sc_sbdsp.sc_dev);
    485 }
    486 
    487 int
    488 pas_getdev(void *addr, struct audio_device *retp)
    489 {
    490 
    491 	*retp = pas_device;
    492 	return 0;
    493 }
    494