NetBSD/sys/dev/isa/ad1848_isa.c

/*	$NetBSD: ad1848_isa.c,v 1.4 1998/11/26 21:45:13 hannken Exp $	*/

/*
 * Copyright (c) 1994 John Brezak
 * Copyright (c) 1991-1993 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the Computer Systems
 *	Engineering Group at Lawrence Berkeley Laboratory.
 * 4. Neither the name of the University nor of the Laboratory may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 */

/*
 * Copyright by Hannu Savolainen 1994
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer. 2.
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 */
/*
 * Portions of this code are from the VOXware support for the ad1848
 * by Hannu Savolainen <hannu@voxware.pp.fi>
 *
 * Portions also supplied from the SoundBlaster driver for NetBSD.
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/errno.h>
#include <sys/ioctl.h>
#include <sys/syslog.h>
#include <sys/device.h>
#include <sys/proc.h>
#include <sys/buf.h>

#include <machine/cpu.h>
#include <machine/bus.h>

#include <sys/audioio.h>
#include <vm/vm.h>

#include <dev/audio_if.h>
#include <dev/auconv.h>

#include <dev/isa/isavar.h>
#include <dev/isa/isadmavar.h>

#include <dev/ic/ad1848reg.h>
#include <dev/ic/cs4231reg.h>
#include <dev/isa/ad1848var.h>
#include <dev/isa/cs4231var.h>

#ifdef AUDIO_DEBUG
#define DPRINTF(x)	if (ad1848debug) printf x
extern int	ad1848debug;
#else
#define DPRINTF(x)
#endif

static int ad1848_isa_read __P(( struct ad1848_softc *, int));
static void ad1848_isa_write __P(( struct ad1848_softc *, int, int));

int
ad1848_isa_read(sc, index)
	struct ad1848_softc *sc;
	int index;
{
	struct ad1848_isa_softc *isc = (struct ad1848_isa_softc *)sc;
	return (bus_space_read_1((sc)->sc_iot, (sc)->sc_ioh,
				 (isc)->sc_iooffs+(index)));
}

void
ad1848_isa_write(sc, index, value)
	struct ad1848_softc *sc;
	int index;
	int value;
{
	struct ad1848_isa_softc *isc = (struct ad1848_isa_softc *)sc;
	bus_space_write_1((sc)->sc_iot, (sc)->sc_ioh,
			  (isc)->sc_iooffs+(index), value);
}

/*
 * Map and probe for the ad1848 chip
 */
int
ad1848_isa_mapprobe(isc, iobase)
	struct ad1848_isa_softc *isc;
	int iobase;
{
	struct ad1848_softc *sc = (struct ad1848_softc *)&isc->sc_ad1848;

	if (!AD1848_BASE_VALID(iobase)) {
#ifdef AUDIO_DEBUG
		printf("ad1848: configured iobase %04x invalid\n", iobase);
#endif
		return 0;
	}

	isc->sc_iooffs = 0;
	/* Map the AD1848 ports */
	if (bus_space_map(sc->sc_iot, iobase, AD1848_NPORT, 0, &sc->sc_ioh))
		return 0;

	if (!ad1848_isa_probe(isc)) {
		bus_space_unmap(sc->sc_iot, sc->sc_ioh, AD1848_NPORT);
		return 0;
	} else
		return 1;
}

/*
 * Probe for the ad1848 chip
 */
int
ad1848_isa_probe(isc)
	struct ad1848_isa_softc *isc;
{
	struct ad1848_softc *sc = (struct ad1848_softc *)&isc->sc_ad1848;
	u_char tmp, tmp1 = 0xff, tmp2 = 0xff;
	int i;

	sc->sc_readreg = ad1848_isa_read;
	sc->sc_writereg = ad1848_isa_write;

	/* Is there an ad1848 chip ? */
	sc->MCE_bit = MODE_CHANGE_ENABLE;
	sc->mode = 1;	/* MODE 1 = original ad1848/ad1846/cs4248 */

	/*
	 * Check that the I/O address is in use.
	 *
	 * The SP_IN_INIT bit of the base I/O port is known to be 0 after the
	 * chip has performed its power-on initialization. Just assume
	 * this has happened before the OS is starting.
	 *
	 * If the I/O address is unused, inb() typically returns 0xff.
	 */
	tmp = ADREAD(sc, AD1848_IADDR);
	if (tmp & SP_IN_INIT) { /* Not a AD1848 */
#if 0
		DPRINTF(("ad_detect_A %x\n", tmp));
#endif
		goto bad;
	}

	/*
	 * Test if it's possible to change contents of the indirect registers.
	 * Registers 0 and 1 are ADC volume registers. The bit 0x10 is read
	 * only so try to avoid using it.
	 */
	ad_write(sc, 0, 0xaa);
	ad_write(sc, 1, 0x45);	/* 0x55 with bit 0x10 clear */

	if ((tmp1 = ad_read(sc, 0)) != 0xaa ||
	    (tmp2 = ad_read(sc, 1)) != 0x45) {
		DPRINTF(("ad_detect_B (%x/%x)\n", tmp1, tmp2));
		goto bad;
	}

	ad_write(sc, 0, 0x45);
	ad_write(sc, 1, 0xaa);

	if ((tmp1 = ad_read(sc, 0)) != 0x45 ||
	    (tmp2 = ad_read(sc, 1)) != 0xaa) {
		DPRINTF(("ad_detect_C (%x/%x)\n", tmp1, tmp2));
		goto bad;
	}

	/*
	 * The indirect register I12 has some read only bits. Lets
	 * try to change them.
	 */
	tmp = ad_read(sc, SP_MISC_INFO);
	ad_write(sc, SP_MISC_INFO, (~tmp) & 0x0f);

	if ((tmp & 0x0f) != ((tmp1 = ad_read(sc, SP_MISC_INFO)) & 0x0f)) {
		DPRINTF(("ad_detect_D (%x)\n", tmp1));
		goto bad;
	}

	/*
	 * MSB and 4 LSBs of the reg I12 tell the chip revision.
	 *
	 * A preliminary version of the AD1846 data sheet stated that it
	 * used an ID field of 0x0B.  The current version, however,
	 * states that the AD1846 uses ID 0x0A, just like the AD1848K.
	 *
	 * this switch statement will need updating as newer clones arrive....
	 */
	switch (tmp1 & 0x8f) {
	case 0x09:
		sc->chip_name = "AD1848J";
		break;
	case 0x0A:
		sc->chip_name = "AD1848K";
		break;
#if 0	/* See above */
	case 0x0B:
		sc->chip_name = "AD1846";
		break;
#endif
	case 0x81:
		sc->chip_name = "CS4248revB"; /* or CS4231 rev B; see below */
		break;
	case 0x89:
		sc->chip_name = "CS4248";
		break;
	case 0x8A:
		sc->chip_name = "broken"; /* CS4231/AD1845; see below */
		break;
	default:
		sc->chip_name = "unknown";
		DPRINTF(("ad1848: unknown codec version 0x%02x\n",
			 tmp1 & 0x8f));
		break;
	}

	/*
	 * The original AD1848/CS4248 has just 16 indirect registers. This
	 * means that I0 and I16 should return the same value (etc.).
	 * Ensure that the Mode2 enable bit of I12 is 0. Otherwise this test
	 * fails with CS4231, AD1845, etc.
	 */
	ad_write(sc, SP_MISC_INFO, 0);	/* Mode2 = disabled */

	for (i = 0; i < 16; i++)
		if ((tmp1 = ad_read(sc, i)) != (tmp2 = ad_read(sc, i + 16))) {
			DPRINTF(("ad_detect_F(%d/%x/%x)\n", i, tmp1, tmp2));
			if (i != SP_TEST_AND_INIT) goto bad;
		}

	/*
	 * Try to switch the chip to mode2 (CS4231) by setting the MODE2 bit
	 * The bit 0x80 is always 1 in CS4248, CS4231, and AD1845.
	 */
	ad_write(sc, SP_MISC_INFO, MODE2);	/* Set mode2, clear 0x80 */

	tmp1 = ad_read(sc, SP_MISC_INFO);
	if ((tmp1 & 0xc0) == (0x80 | MODE2)) {
		/*
		 *      CS4231 or AD1845 detected - is it?
		 *
		 *	Verify that setting I2 doesn't change I18.
		 */
		ad_write(sc, 18, 0x88); /* Set I18 to known value */

		ad_write(sc, 2, 0x45);
		if ((tmp2 = ad_read(sc, 18)) != 0x45) { /* No change -> CS4231? */
			ad_write(sc, 2, 0xaa);
			if ((tmp2 = ad_read(sc, 18)) == 0xaa) {     /* Rotten bits? */
				DPRINTF(("ad_detect_H(%x)\n", tmp2));
				goto bad;
			}

			/*
			 *  It's a CS4231, or another clone with 32 registers.
			 *  Let's find out which by checking I25.
			 */
			if ((tmp1 & 0x8f) == 0x8a) {
				tmp1 = ad_read(sc, CS_VERSION_ID);
				switch (tmp1 & 0xe7) {
				case 0xA0:
					sc->chip_name = "CS4231A";
					break;
				case 0x80:
					/*  XXX I25 no good, AD1845 same as CS4231 */
					sc->chip_name = "CS4231 or AD1845";
					break;
				case 0x82:
					sc->chip_name = "CS4232";
					break;
				case 0x03:
				case 0x83:
					sc->chip_name = "CS4236/CS4236B";
					break;
				}
			}
			sc->mode = 2;
		}
	}

	/* Wait for 1848 to init */
	while(ADREAD(sc, AD1848_IADDR) & SP_IN_INIT)
		;

	/* Wait for 1848 to autocal */
	ADWRITE(sc, AD1848_IADDR, SP_TEST_AND_INIT);
	while(ADREAD(sc, AD1848_IDATA) & AUTO_CAL_IN_PROG)
		;

	return 1;
 bad:
	return 0;
}

/* Unmap the I/O ports */
void
ad1848_isa_unmap(isc)
	struct ad1848_isa_softc *isc;
{
	struct ad1848_softc *sc = (struct ad1848_softc *)&isc->sc_ad1848;
	bus_space_unmap(sc->sc_iot, sc->sc_ioh, AD1848_NPORT);
}

/*
 * Attach hardware to driver, attach hardware driver to audio
 * pseudo-device driver .
 */
void
ad1848_isa_attach(isc)
	struct ad1848_isa_softc *isc;
{
	struct ad1848_softc *sc = (struct ad1848_softc *)&isc->sc_ad1848;

	sc->sc_readreg = ad1848_isa_read;
	sc->sc_writereg = ad1848_isa_write;

	isc->sc_playrun = NOTRUNNING;
	isc->sc_recrun = NOTRUNNING;

	if (isc->sc_drq != -1) {
		if (isa_dmamap_create(isc->sc_ic, isc->sc_drq, MAX_ISADMA,
				      BUS_DMA_NOWAIT|BUS_DMA_ALLOCNOW)) {
			printf("ad1848_attach: can't create map for drq %d\n",
			       isc->sc_drq);
			return;
		}
	}
	if (isc->sc_recdrq != -1 && isc->sc_recdrq != isc->sc_drq) {
		if (isa_dmamap_create(isc->sc_ic, isc->sc_recdrq, MAX_ISADMA,
				      BUS_DMA_NOWAIT|BUS_DMA_ALLOCNOW)) {
			printf("ad1848_attach: can't create map for drq %d\n",
			       isc->sc_recdrq);
			return;
		}
	}

	ad1848_attach(sc);
}

int
ad1848_isa_round_blocksize(addr, blk)
	void *addr;
	int blk;
{
	struct ad1848_isa_softc *sc = addr;

	sc->sc_lastcc = -1;

	/* Round to a multiple of the biggest sample size. */
	return (blk &= -4);
}

int
ad1848_isa_open(addr, flags)
	void *addr;
	int flags;
{
	struct ad1848_isa_softc *sc = addr;

	DPRINTF(("ad1848_isa_open: sc=%p\n", sc));

	sc->sc_lastcc = -1;
	sc->sc_intr = 0;

	return (ad1848_open(&sc->sc_ad1848, flags));
}

/*
 * Close function is called at splaudio().
 */
void
ad1848_isa_close(addr)
	void *addr;
{
	struct ad1848_isa_softc *sc = addr;

	sc->sc_intr = 0;

	DPRINTF(("ad1848_isa_close: stop DMA\n"));
	if (sc->sc_playrun != NOTRUNNING) {
		isa_dmaabort(sc->sc_ic, sc->sc_drq);
		sc->sc_playrun = NOTRUNNING;
	}
	if (sc->sc_recrun != NOTRUNNING) {
		isa_dmaabort(sc->sc_ic, sc->sc_recdrq);
		sc->sc_recrun = NOTRUNNING;
	}
	ad1848_close(&sc->sc_ad1848);
}

int
ad1848_isa_dma_init_input(addr, buf, cc)
	void *addr;
	void *buf;
	int cc;
{
	struct ad1848_isa_softc *isc = addr;

	isc->sc_recrun = DMARUNNING;
	isc->sc_dma_flags = DMAMODE_READ | DMAMODE_LOOP;
	isc->sc_dma_bp = buf;
	isc->sc_dma_cnt = cc;
	isa_dmastart(isc->sc_ic, isc->sc_recdrq, buf, cc, NULL,
		     isc->sc_dma_flags, BUS_DMA_NOWAIT);
	DPRINTF(("ad1848_isa_dma_init_input: %p %d\n", buf, cc));
	return 0;
}

/*
 * DMA input/output are called at splaudio().
 */
int
ad1848_isa_dma_input(addr, p, cc, intr, arg)
	void *addr;
	void *p;
	int cc;
	void (*intr) __P((void *));
	void *arg;
{
	struct ad1848_isa_softc *isc = addr;
	struct ad1848_softc *sc = (struct ad1848_softc *)&isc->sc_ad1848;
	u_char reg;

	if (sc->sc_locked) {
		DPRINTF(("ad1848_isa_dma_input: locked\n"));
		return 0;
	}

#ifdef AUDIO_DEBUG
	if (ad1848debug > 1)
		printf("ad1848_isa_dma_input: cc=%d %p (%p)\n", cc, intr, arg);
#endif
	sc->sc_locked = 1;
	isc->sc_intr = intr;
	isc->sc_arg = arg;

	switch (isc->sc_recrun) {
	case NOTRUNNING:
		isc->sc_dma_flags = DMAMODE_READ;
		isc->sc_dma_bp = p;
		isc->sc_dma_cnt = cc;
		isa_dmastart(isc->sc_ic, isc->sc_recdrq, p, cc, NULL,
			     DMAMODE_READ, BUS_DMA_NOWAIT);
		goto startpcm;
	case DMARUNNING:
		isc->sc_recrun = PCMRUNNING;
	startpcm:
		if (sc->precision == 16)
			cc >>= 1;
		if (sc->channels == 2)
			cc >>= 1;
		cc--;

		if (isc->sc_lastcc != cc || sc->sc_mode != AUMODE_RECORD) {
			ad_write(sc, SP_LOWER_BASE_COUNT, cc & 0xff);
			ad_write(sc, SP_UPPER_BASE_COUNT, cc >> 8);

			if (sc->mode == 2) {
				ad_write(sc, CS_LOWER_REC_CNT, cc & 0xff);
				ad_write(sc, CS_UPPER_REC_CNT, cc >> 8);
			}

			reg = ad_read(sc, SP_INTERFACE_CONFIG);
			ad_write(sc, SP_INTERFACE_CONFIG, CAPTURE_ENABLE|reg);

			isc->sc_lastcc = cc;
			sc->sc_mode = AUMODE_RECORD;
#ifdef AUDIO_DEBUG
			if (ad1848debug > 1)
				printf("ad1848_dma_input: started capture\n");
#endif
		}
	case PCMRUNNING:
		break;
	}

	return 0;
}

int
ad1848_isa_dma_init_output(addr, buf, cc)
	void *addr;
	void *buf;
	int cc;
{
	struct ad1848_isa_softc *isc = addr;

	isc->sc_playrun = DMARUNNING;
	isc->sc_dma_flags = DMAMODE_WRITE | DMAMODE_LOOP;
	isc->sc_dma_bp = buf;
	isc->sc_dma_cnt = cc;
	isa_dmastart(isc->sc_ic, isc->sc_drq, buf, cc, NULL,
		     isc->sc_dma_flags, BUS_DMA_NOWAIT);
	DPRINTF(("ad1848_isa_dma_init_output: %p %d\n", buf, cc));
	return 0;
}

int
ad1848_isa_dma_output(addr, p, cc, intr, arg)
	void *addr;
	void *p;
	int cc;
	void (*intr) __P((void *));
	void *arg;
{
	struct ad1848_isa_softc *isc = addr;
	struct ad1848_softc *sc = (struct ad1848_softc *)&isc->sc_ad1848;
	u_char reg;

	if (sc->sc_locked) {
		DPRINTF(("ad1848_isa_dma_output: locked\n"));
		return 0;
	}

#ifdef AUDIO_DEBUG
	if (ad1848debug > 0)
		printf("ad1848_isa_dma_output: cc=%d at %p 0x%p (0x%p)\n",
		       cc, p, intr, arg);
#endif
	sc->sc_locked = 1;
	isc->sc_intr = intr;
	isc->sc_arg = arg;

	switch (isc->sc_playrun) {
	case NOTRUNNING:
		isc->sc_dma_flags = DMAMODE_WRITE;
		isc->sc_dma_bp = p;
		isc->sc_dma_cnt = cc;
		isa_dmastart(isc->sc_ic, isc->sc_drq, p, cc, NULL,
			     DMAMODE_WRITE, BUS_DMA_NOWAIT);
		goto startpcm;
	case DMARUNNING:
		isc->sc_playrun = PCMRUNNING;
	startpcm:
		if (sc->precision == 16)
			cc >>= 1;
		if (sc->channels == 2)
			cc >>= 1;
		cc--;

		if (isc->sc_lastcc != cc || sc->sc_mode != AUMODE_PLAY) {
			ad_write(sc, SP_LOWER_BASE_COUNT, cc & 0xff);
			ad_write(sc, SP_UPPER_BASE_COUNT, cc >> 8);

			reg = ad_read(sc, SP_INTERFACE_CONFIG);
			ad_write(sc, SP_INTERFACE_CONFIG, PLAYBACK_ENABLE|reg);

			isc->sc_lastcc = cc;
			sc->sc_mode = AUMODE_PLAY;
		}
		break;
	case PCMRUNNING:
		break;
	}

	return 0;
}

int
ad1848_isa_intr(arg)
	void *arg;
{
	struct ad1848_isa_softc *isc = arg;
	struct ad1848_softc *sc = (struct ad1848_softc *)&isc->sc_ad1848;
	int retval = 0;
	u_char status;

	/* Get intr status */
	status = ADREAD(sc, AD1848_STATUS);

#ifdef AUDIO_DEBUG
	if (ad1848debug > 1)
		printf("ad1848_isa_intr: intr=%p status=%x\n", isc->sc_intr, status);
#endif
	sc->sc_locked = 0;
	isc->sc_interrupts++;

	/* Handle interrupt */
	if (isc->sc_intr && (status & INTERRUPT_STATUS)) {
		/* ACK DMA read because it may be in a bounce buffer */
		/* XXX Do write to mask DMA ? */
		if ((isc->sc_dma_flags & DMAMODE_READ) &&
		    isc->sc_recrun == NOTRUNNING)
			isa_dmadone(isc->sc_ic, isc->sc_recdrq);
		(*isc->sc_intr)(isc->sc_arg);
		retval = 1;
	}

	/* clear interrupt */
	if (status & INTERRUPT_STATUS)
		ADWRITE(sc, AD1848_STATUS, 0);

	return(retval);
}

void *
ad1848_isa_malloc(addr, size, pool, flags)
	void *addr;
	unsigned long size;
	int pool;
	int flags;
{
	struct ad1848_isa_softc *isc = addr;

	return isa_malloc(isc->sc_ic, 4, size, pool, flags);
}

void
ad1848_isa_free(addr, ptr, pool)
	void *addr;
	void *ptr;
	int pool;
{
	isa_free(ptr, pool);
}

unsigned long
ad1848_isa_round(addr, size)
	void *addr;
	unsigned long size;
{
	if (size > MAX_ISADMA)
		size = MAX_ISADMA;
	return size;
}

int
ad1848_isa_mappage(addr, mem, off, prot)
	void *addr;
        void *mem;
        int off;
	int prot;
{
	return isa_mappage(mem, off, prot);
}

int
ad1848_isa_get_props(addr)
	void *addr;
{
	struct ad1848_isa_softc *isc = addr;

	return (AUDIO_PROP_MMAP |
		(isc->sc_drq != isc->sc_recdrq ? AUDIO_PROP_FULLDUPLEX : 0));
}