/*	$NetBSD: sbreg.h,v 1.23 1997/08/11 01:08:15 augustss Exp $	*/

/*
 * 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.
 *
 *	From: Header: sbreg.h,v 1.3 93/07/18 14:07:28 mccanne Exp (LBL)
 */

/*
 * SoundBlaster register definitions.
 * See "The Developer Kit for Sound Blaster Series, User's Guide" for more
 * complete information (avialable from Creative Labs, Inc.).  We refer
 * to this documentation as "SBK".
 *
 * We handle two types of cards: the basic SB version 2.0+, and
 * the SB PRO.  There are several distinct pieces of the hardware:
 *
 *   joystick port	(independent of I/O base address)
 *   FM synth		(stereo on PRO)
 *   mixer		(PRO only)
 *   DSP (sic)
 *   CD-ROM		(PRO only)
 *
 * The MIDI capabilities are handled by the DSP unit.
 */

/*
 * Address map.  The SoundBlaster can be configured (via jumpers) for
 * either base I/O address 0x220 or 0x240.  The encodings below give
 * the offsets to specific SB ports.  SBP stands for SB port offset.
 */
#define SBP_LFM_STATUS		0	/* R left FM status port */
#define SBP_LFM_ADDR		0	/* W left FM address register */
#define SBP_LFM_DATA		1	/* RW left FM data port */
#define SBP_RFM_STATUS		2	/* R right FM status port */
#define SBP_RFM_ADDR		2	/* W right FM address register */
#define SBP_RFM_DATA		3	/* RW right FM data port */

#define SBP_FM_STATUS		8	/* R FM status port */
#define SBP_FM_ADDR		8	/* W FM address register */
#define SBP_FM_DATA		9	/* RW FM data port */
#define SBP_MIXER_ADDR		4	/* W mixer address register */
#define SBP_MIXER_DATA		5	/* RW mixer data port */

#define	SBP_MIX_RESET		0x00	/* mixer reset port, value */
#define SBP_1335_MASTER_VOL	0x02
#define	SBP_1335_MIDI_VOL	0x06
#define	SBP_1335_CD_VOL		0x08
#define	SBP_1335_VOICE_VOL	0x0A

#define	SBP_VOICE_VOL		0x04
#define	SBP_MIC_VOL		0x0A	/* warning: only one channel of volume... */
#define	SBP_MASTER_VOL		0x22
#define	SBP_MIDI_VOL		0x26
#define	SBP_CD_VOL		0x28
#define	SBP_LINE_VOL		0x2E

#define	SBP_RECORD_SOURCE	0x0C
#define	SBP_STEREO		0x0E
#define		SBP_PLAYMODE_STEREO	0x2
#define		SBP_PLAYMODE_MONO	0x0
#define		SBP_PLAYMODE_MASK	0x2
#define	SBP_OUTFILTER		0x0E
#define	SBP_INFILTER		0x0C

#define	SBP_RECORD_FROM(src, filteron, high) ((src) | (filteron) | (high))
#define		SBP_FILTER_ON		0x0
#define		SBP_FILTER_OFF		0x20
#define		SBP_IFILTER_MASK	0x28
#define		SBP_OFILTER_MASK	0x20
#define		SBP_IFILTER_LOW		0
#define		SBP_IFILTER_HIGH	0x08
#define		SBP_FROM_MIC		0x00
#define		SBP_FROM_CD		0x02
#define		SBP_FROM_LINE		0x06

#define SBP_SET_IRQ		0x80	/* Soft-configured irq (SB16-) */
#define SBP_SET_DRQ		0x81	/* Soft-configured drq (SB16-) */
#define	SBP_IRQ_STATUS		0x82	/* Pending IRQ status (SB16-) */
#define		SBP_IRQ_MPU401	0x04
#define		SBP_IRQ_DMA16	0x02
#define		SBP_IRQ_DMA8	0x01

#define SB16P_MASTER_L		0x30
#define SB16P_VOICE_L		0x32
#define SB16P_MIDI_L		0x34
#define SB16P_CD_L		0x36
#define SB16P_LINE_L		0x38
#define SB16P_MIC_L		0x3a
#define SB16P_PCSPEAKER		0x3b
#define SB16P_INPUT_GAIN_L	0x3f
#define SB16P_OUTPUT_GAIN_L	0x41
#define SB16P_TREBLE_L		0x44
#define SB16P_BASS_L		0x46
#define SB16P_L_TO_R(l) ((l)+1)

#define SB16P_AGC		0x43

#define SBP_RECORD_SOURCE_L	0x3d
#define SBP_RECORD_SOURCE_R	0x3e
#define 	SBP_MIDI_SRC_R	0x20
#define 	SBP_LINE_SRC_R	0x08
#define 	SBP_CD_SRC_R	0x02
#define 	SBP_MIC_SRC	0x01
#define SB_SRC_R_TO_L(x) ((x) << 1)

#define SB_STEREO_GAIN(left, right) ((left) | ((right) >> 4))
#define SB_MIC_GAIN(v) ((v) >> 5)

#define SB_ADJUST_MIC_GAIN(sc, x) sbdsp_adjust((x), ISSB16CLASS(sc) ? 0xf8 : 0xc0)
#define SB_ADJUST_GAIN(sc, x)     sbdsp_adjust((x), ISSB16CLASS(sc) ? 0xf8 : 0xe0)
#define SB_ADJUST_2_GAIN(sc, x)   sbdsp_adjust((x), 0xc0)

#define SB_1335_GAIN(x) ((x) >> 4)
#define SB_1335_MASTER_GAIN(x) ((x) >> 5)

#define SBP_DSP_RESET		6	/* W reset port */
#define 	SB_MAGIC	0xaa	/* card outputs on successful reset */
#define SBP_DSP_READ		10 	/* R read port */
#define SBP_DSP_WRITE		12	/* W write port */
#define SBP_DSP_WSTAT		12	/* R write status */
#define SBP_DSP_RSTAT		14	/* R read status */
#define 	SB_DSP_BUSY	0x80
#define 	SB_DSP_READY	0x80
#define	SBP_DSP_IRQACK8		14	/* R acknowledge DSP IRQ, 8-bit */
#define	SBP_DSP_IRQACK16	15	/* R acknowledge DSP IRQ, 16-bit */
#define SBP_CDROM_DATA		16	/* RW send cmds/recv data */
#define SBP_CDROM_STATUS	17	/* R status port */
#define SBP_CDROM_RESET		18	/* W reset register */
#define SBP_CDROM_ENABLE	19	/* W enable register */

#define SBP_NPORT 24
#define SB_NPORT 16

/*
 * DSP commands.  This unit handles MIDI and audio capabilities.
 * The DSP can be reset, data/commands can be read or written to it,
 * and it can generate interrupts.  Interrupts are generated for MIDI
 * input or DMA completion.  They seem to have neglected the fact 
 * that it would be nice to have a MIDI transmission complete interrupt.
 * Worse, the DMA engine is half-duplex.  This means you need to do
 * (timed) programmed I/O to be able to record and play simulataneously.
 */
#define SB_DSP_DACWRITE		0x10	/* programmed I/O write to DAC */
#define SB_DSP_WDMA		0x14	/* begin 8-bit linear DMA output */
#define SB_DSP_WDMA_2		0x16	/* begin 2-bit ADPCM DMA output */
#define	SB_DSP_WDMA_LOOP	0x1C	/* begin 8-bit linear DMA output loop */
#define SB_DSP_ADCREAD		0x20	/* programmed I/O read from ADC */
#define SB_DSP_RDMA		0x24	/* begin 8-bit linear DMA input */
#define	SB_DSP_RDMA_LOOP	0x2C	/* begin 8-bit linear DMA input loop */
#define SB_MIDI_POLL		0x30	/* initiate a polling read for MIDI */
#define SB_MIDI_READ		0x31	/* read a MIDI byte on recv intr */
#define SB_MIDI_UART_POLL	0x34	/* enter UART mode w/ read polling */
#define SB_MIDI_UART_INTR	0x35	/* enter UART mode w/ read intrs */
#define SB_MIDI_WRITE		0x38	/* write a MIDI byte (non-UART mode) */
#define SB_DSP_TIMECONST	0x40	/* set ADAC time constant */
#define	SB_DSP16_OUTPUTRATE	0x41	/* set ADAC output rate */
#define	SB_DSP16_INPUTRATE	0x42	/* set ADAC input rate */
#define SB_DSP_BLOCKSIZE	0x48	/* set blk size for high speed xfer */
#define SB_DSP_WDMA_4		0x74	/* begin 4-bit ADPCM DMA output */
#define SB_DSP_WDMA_2_6		0x76	/* begin 2.6-bit ADPCM DMA output */
#define SB_DSP_SILENCE		0x80	/* send a block of silence */
#define SB_DSP_HS_OUTPUT	0x90	/* set high speed mode for wdma */
#define SB_DSP_HS_INPUT		0x98	/* set high speed mode for rdma */
#define SB_DSP_RECORD_MONO	0xA0	/* set mono recording */
#define SB_DSP_RECORD_STEREO	0xA8	/* set stereo recording */
#define	SB_DSP16_WDMA_16	0xB6	/* begin 16-bit linear output */
#define	SB_DSP16_RDMA_16	0xBE	/* begin 16-bit linear input */
#define	SB_DSP16_WDMA_8		0xC6	/* begin 8-bit linear output */
#define	SB_DSP16_RDMA_8		0xCE	/* begin 8-bit linear input */
#define SB_DSP_HALT		0xd0	/* temporarilty suspend DMA */
#define SB_DSP_SPKR_ON		0xd1	/* turn speaker on */
#define SB_DSP_SPKR_OFF		0xd3	/* turn speaker off */
#define SB_DSP_CONT		0xd4	/* continue suspended DMA */
#define SB_DSP_RD_SPKR		0xd8	/* get speaker status */
#define 	SB_SPKR_OFF	0x00
#define 	SB_SPKR_ON	0xff
#define SB_DSP_VERSION		0xe1	/* get version number */

#define SB_BMODE_UNSIGNED	0x00
#define SB_BMODE_SIGNED		0x10
#define SB_BMODE_STEREO		0x20

/* Some of these come from linux driver (It serves as convenient unencumbered
   documentation) */
#define	JAZZ16_READ_VER		0xFA	/* 0x12 means ProSonic/Jazz16? */
#define		JAZZ16_VER_JAZZ	0x12
#define	JAZZ16_SET_DMAINTR	0xFB

#define JAZZ16_CONFIG_PORT	0x201
#define	JAZZ16_WAKEUP		0xAF
#define	JAZZ16_SETBASE		0x50

#define	JAZZ16_RECORD_STEREO	0xAC	/* 16-bit record */
#define	JAZZ16_RECORD_MONO	0xA4	/* 16-bit record */

/*
 * These come from Jazz16 chipset documentation, which doesn't include
 * full register details, alas.  Their source code CD-ROM probably includes
 * details, but it has an NDA attached.
 */
#define	JAZZ16_DIR_PB 		0x10
#define	JAZZ16_SINGLE_PB	0x14
#define	JAZZ16_SINGLE_ALAW_PB 	0x17
#define	JAZZ16_CONT_PB		0x1C
#define	JAZZ16_CONT_ALAW_PB 	0x1F
#define	JAZZ16_DIR_PCM_REC	0x20
#define	JAZZ16_SINGLE_REC	0x24
#define	JAZZ16_SINGLE_ALAW_REC 	0x27
#define	JAZZ16_CONT_REC		0x2C
#define	JAZZ16_CONT_ALAW_REC 	0x2F
#define	JAZZ16_SINGLE_ADPCM_PB 	0x74
#define	JAZZ16_SINGLE_MULAW_PB 	0x77
#define	JAZZ16_CONT_ADPCM_PB 	0x7C
#define	JAZZ16_SINGLE_ADPCM_REC 0x84
#define	JAZZ16_SINGLE_MULAW_REC 0x87
#define	JAZZ16_CONT_ADPCM_REC 	0x8C
#define	JAZZ16_CONT_MULAW_REC 	0x8F
#define	JAZZ16_CONT_PB_XX 	0x90
#define	JAZZ16_SINGLE_PB_XX	0x91
#define	JAZZ16_SINGLE_REC_XX	0x98
#define	JAZZ16_CONT_REC_XX	0x99


/*
 * The ADPCM encodings are differential, meaning each sample represents
 * a difference to add to a running sum.  The inital value is called the
 * reference, or reference byte.  Any of the ADPCM DMA transfers can specify
 * that the given transfer begins with a reference byte by or'ing
 * in the bit below.
 */
#define SB_DSP_REFERENCE	1

/*
 * Macros to detect valid hardware configuration data.
 */
#define SBP_IRQ_VALID(irq)  ((irq) == 5 || (irq) == 7 || (irq) == 9 || (irq) == 10)
#define SB_IRQ_VALID(irq)   ((irq) == 3 || (irq) == 5 || (irq) == 7 || (irq) == 9)

#define SB16_DRQ_VALID(chan) ((chan) == 0 || (chan) == 1 || (chan) == 3 || \
			      (chan) == 5 || (chan) == 6 || (chan) == 7) 
#define SBP_DRQ_VALID(chan) ((chan) == 0 || (chan) == 1 || (chan) == 3)
#define SB_DRQ_VALID(chan)  ((chan) == 1)

#define SB_BASE_VALID(base) ((base) == 0x220 || (base) == 0x240)

#define SB_INPUT_RATE	0
#define SB_OUTPUT_RATE	1