sys/dev/sound/isa/sb.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1997,1998 Luigi Rizzo
   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  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef SB_H
  32 #define SB_H
  33
  34 struct sbc_softc;
  35 void sbc_lock(struct sbc_softc *);
  36 void sbc_lockassert(struct sbc_softc *);
  37 void sbc_unlock(struct sbc_softc *);
  38
  39 /*
  40  * sound blaster registers
  41  */
  42
  43 #define SBDSP_RST       0x6
  44 #define DSP_READ        0xA
  45 #define DSP_WRITE       0xC
  46 #define SBDSP_CMD       0xC
  47 #define SBDSP_STATUS    0xC
  48 #define DSP_DATA_AVAIL  0xE
  49 #define DSP_DATA_AVL16  0xF
  50
  51 #define SB_MIX_ADDR     0x4
  52 #define SB_MIX_DATA     0x5
  53 #if 0
  54 #define OPL3_LEFT       (io_base + 0x0)
  55 #define OPL3_RIGHT      (io_base + 0x2)
  56 #define OPL3_BOTH       (io_base + 0x8)
  57 #endif
  58
  59 /*
  60  * DSP Commands. There are many, and in many cases they are used explicitly
  61  */
  62
  63 /* these are not used except for programmed I/O (not in this driver) */
  64 #define DSP_DAC8                0x10    /* direct DAC output */
  65 #define DSP_ADC8                0x20    /* direct ADC input */
  66
  67 /* these should be used in the SB 1.0 */
  68 #define DSP_CMD_DAC8            0x14    /* single cycle 8-bit dma out */
  69 #define DSP_CMD_ADC8            0x24    /* single cycle 8-bit dma in */
  70
  71 /* these should be used in the SB 2.0 and 2.01 */
  72 #define DSP_CMD_DAC8_AUTO       0x1c    /* auto 8-bit dma out */
  73 #define DSP_CMD_ADC8_AUTO       0x2c    /* auto 8-bit dma out */
  74
  75 #define DSP_CMD_HSSIZE          0x48    /* high speed dma count */
  76 #define DSP_CMD_HSDAC_AUTO      0x90    /* high speed dac, auto */
  77 #define DSP_CMD_HSADC_AUTO      0x98    /* high speed adc, auto */
  78
  79 /* SBPro commands. Some cards (JAZZ, SMW) also support 16 bits */
  80
  81         /* prepare for dma input */
  82 #define DSP_CMD_DMAMODE(stereo, bit16) (0xA0 | (stereo ? 8:0) | (bit16 ? 4:0))
  83
  84 #define DSP_CMD_DAC2            0x16    /* 2-bit adpcm dma out (cont) */
  85 #define DSP_CMD_DAC2S           0x17    /* 2-bit adpcm dma out (start) */
  86
  87 #define DSP_CMD_DAC2S_AUTO      0x1f    /* auto 2-bit adpcm dma out (start) */
  88
  89
  90 /* SB16 commands */
  91 #define DSP_CMD_O16             0xb0
  92 #define DSP_CMD_I16             0xb8
  93 #define DSP_CMD_O8              0xc0
  94 #define DSP_CMD_I8              0xc8
  95
  96 #define DSP_MODE_U8MONO         0x00
  97 #define DSP_MODE_U8STEREO       0x20
  98 #define DSP_MODE_S16MONO        0x10
  99 #define DSP_MODE_S16STEREO      0x30
 100
 101 #define DSP_CMD_SPKON           0xD1
 102 #define DSP_CMD_SPKOFF          0xD3
 103 #define DSP_CMD_SPKR(on)        (0xD1 | (on ? 0:2))
 104
 105 #define DSP_CMD_DMAPAUSE_8      0xD0
 106 #define DSP_CMD_DMAPAUSE_16     0xD5
 107 #define DSP_CMD_DMAEXIT_8       0xDA
 108 #define DSP_CMD_DMAEXIT_16      0xD9
 109 #define DSP_CMD_TCONST          0x40    /* set time constant */
 110 #define DSP_CMD_HSDAC           0x91    /* high speed dac */
 111 #define DSP_CMD_HSADC           0x99    /* high speed adc */
 112
 113 #define DSP_CMD_GETVER          0xE1
 114 #define DSP_CMD_GETID           0xE7    /* return id bytes */
 115
 116
 117 #define DSP_CMD_OUT16           0x41    /* send parms for dma out on sb16 */
 118 #define DSP_CMD_IN16            0x42    /* send parms for dma in on sb16 */
 119 #if 0 /*** unknown ***/
 120 #define DSP_CMD_FA              0xFA    /* get version from prosonic*/
 121 #define DSP_CMD_FB              0xFB    /* set irq/dma for prosonic*/
 122 #endif
 123
 124 /*
 125  * in fact, for the SB16, dma commands are as follows:
 126  *
 127  *  cmd, mode, len_low, len_high.
 128  *
 129  * cmd is a combination of DSP_DMA16 or DSP_DMA8 and
 130  */
 131
 132 #define DSP_DMA16               0xb0
 133 #define DSP_DMA8                0xc0
 134 #   define DSP_F16_DAC          0x00
 135 #   define DSP_F16_ADC          0x08
 136 #   define DSP_F16_AUTO         0x04
 137 #   define DSP_F16_FIFO_ON      0x02
 138
 139 /*
 140  * mode is a combination of the following:
 141  */
 142 #define DSP_F16_STEREO  0x20
 143 #define DSP_F16_SIGNED  0x10
 144
 145 #define IMODE_NONE              0
 146 #define IMODE_OUTPUT            PCM_ENABLE_OUTPUT
 147 #define IMODE_INPUT             PCM_ENABLE_INPUT
 148 #define IMODE_INIT              3
 149 #define IMODE_MIDI              4
 150
 151 #define NORMAL_MIDI     0
 152 #define UART_MIDI       1
 153
 154 /*
 155  * values used for bd_flags in SoundBlaster driver
 156  */
 157 #define BD_F_HISPEED    0x0001  /* doing high speed ... */
 158
 159 #if 0
 160 #define BD_F_JAZZ16     0x0002  /* jazz16 detected */
 161 #define BD_F_JAZZ16_2   0x0004  /* jazz16 type 2 */
 162 #endif
 163
 164 #define BD_F_DUP_MIDI   0x0008  /* duplex midi */
 165
 166 #define BD_F_MIX_MASK   0x0070  /* up to 8 mixers (I know of 3) */
 167 #define BD_F_MIX_CT1335 0x0010  /* CT1335               */
 168 #define BD_F_MIX_CT1345 0x0020  /* CT1345               */
 169 #define BD_F_MIX_CT1745 0x0030  /* CT1745               */
 170
 171 #define BD_F_SB16       0x0100  /* this is a SB16 */
 172 #define BD_F_SB16X      0x0200  /* this is a vibra16X or clone */
 173 #if 0
 174 #define BD_F_MIDIBUSY   0x0400  /* midi busy */
 175 #endif
 176 #define BD_F_ESS        0x0800  /* this is an ESS chip */
 177 #define BD_F_DMARUN     0x2000
 178 #define BD_F_DMARUN2    0x4000
 179
 180 /*
 181  * Mixer registers of SB Pro
 182  */
 183 #define VOC_VOL         0x04
 184 #define MIC_VOL         0x0A
 185 #define MIC_MIX         0x0A
 186 #define RECORD_SRC      0x0C
 187 #define IN_FILTER       0x0C
 188 #define OUT_FILTER      0x0E
 189 #define MASTER_VOL      0x22
 190 #define FM_VOL          0x26
 191 #define CD_VOL          0x28
 192 #define LINE_VOL        0x2E
 193 #define IRQ_NR          0x80
 194 #define DMA_NR          0x81
 195 #define IRQ_STAT        0x82
 196
 197 /*
 198  * Additional registers on the SG NX Pro
 199  */
 200 #define COVOX_VOL       0x42
 201 #define TREBLE_LVL      0x44
 202 #define BASS_LVL        0x46
 203
 204 #define FREQ_HI         (1 << 3)/* Use High-frequency ANFI filters */
 205 #define FREQ_LOW        0       /* Use Low-frequency ANFI filters */
 206 #define FILT_ON         0       /* Yes, 0 to turn it on, 1 for off */
 207 #define FILT_OFF        (1 << 5)
 208
 209 #define MONO_DAC        0x00
 210 #define STEREO_DAC      0x02
 211
 212 /*
 213  * Mixer registers of SB16
 214  */
 215 #define SB16_IMASK_L    0x3d
 216 #define SB16_IMASK_R    0x3e
 217 #define SB16_OMASK      0x3c
 218 #endif