include/sound/sb.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 #ifndef __SOUND_SB_H
0003 #define __SOUND_SB_H
0004
0005 /*
0006  *  Header file for SoundBlaster cards
0007  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
0008  */
0009
0010 #include <sound/pcm.h>
0011 #include <sound/rawmidi.h>
0012 #include <linux/interrupt.h>
0013 #include <linux/io.h>
0014
0015 enum sb_hw_type {
0016     SB_HW_AUTO,
0017     SB_HW_10,
0018     SB_HW_20,
0019     SB_HW_201,
0020     SB_HW_PRO,
0021     SB_HW_JAZZ16,       /* Media Vision Jazz16 */
0022     SB_HW_16,
0023     SB_HW_16CSP,        /* SB16 with CSP chip */
0024     SB_HW_ALS100,       /* Avance Logic ALS100 chip */
0025     SB_HW_ALS4000,      /* Avance Logic ALS4000 chip */
0026     SB_HW_DT019X,       /* Diamond Tech. DT-019X / Avance Logic ALS-007 */
0027     SB_HW_CS5530,       /* Cyrix/NatSemi 5530 VSA1 */
0028 };
0029
0030 #define SB_OPEN_PCM         0x01
0031 #define SB_OPEN_MIDI_INPUT      0x02
0032 #define SB_OPEN_MIDI_OUTPUT     0x04
0033 #define SB_OPEN_MIDI_INPUT_TRIGGER  0x08
0034 #define SB_OPEN_MIDI_OUTPUT_TRIGGER 0x10
0035
0036 #define SB_MODE_HALT        0x00
0037 #define SB_MODE_PLAYBACK_8  0x01
0038 #define SB_MODE_PLAYBACK_16 0x02
0039 #define SB_MODE_PLAYBACK    (SB_MODE_PLAYBACK_8 | SB_MODE_PLAYBACK_16)
0040 #define SB_MODE_CAPTURE_8   0x04
0041 #define SB_MODE_CAPTURE_16  0x08
0042 #define SB_MODE_CAPTURE     (SB_MODE_CAPTURE_8 | SB_MODE_CAPTURE_16)
0043
0044 #define SB_RATE_LOCK_PLAYBACK   0x10
0045 #define SB_RATE_LOCK_CAPTURE    0x20
0046 #define SB_RATE_LOCK        (SB_RATE_LOCK_PLAYBACK | SB_RATE_LOCK_CAPTURE)
0047
0048 #define SB_MPU_INPUT        1
0049
0050 struct snd_sb {
0051     unsigned long port;     /* base port of DSP chip */
0052     struct resource *res_port;
0053     unsigned long mpu_port;     /* MPU port for SB DSP 4.0+ */
0054     int irq;            /* IRQ number of DSP chip */
0055     int dma8;           /* 8-bit DMA */
0056     int dma16;          /* 16-bit DMA */
0057     unsigned short version;     /* version of DSP chip */
0058     enum sb_hw_type hardware;   /* see to SB_HW_XXXX */
0059
0060     unsigned long alt_port;     /* alternate port (ALS4000) */
0061     struct pci_dev *pci;        /* ALS4000 */
0062
0063     unsigned int open;      /* see to SB_OPEN_XXXX for sb8 */
0064                     /* also SNDRV_SB_CSP_MODE_XXX for sb16_csp */
0065     unsigned int mode;      /* current mode of stream */
0066     unsigned int force_mode16;  /* force 16-bit mode of streams */
0067     unsigned int locked_rate;   /* sb16 duplex */
0068     unsigned int playback_format;
0069     unsigned int capture_format;
0070     struct timer_list midi_timer;
0071     unsigned int p_dma_size;
0072     unsigned int p_period_size;
0073     unsigned int c_dma_size;
0074     unsigned int c_period_size;
0075
0076     spinlock_t mixer_lock;
0077
0078     char name[32];
0079
0080     void *csp; /* used only when CONFIG_SND_SB16_CSP is set */
0081
0082     struct snd_card *card;
0083     struct snd_pcm *pcm;
0084     struct snd_pcm_substream *playback_substream;
0085     struct snd_pcm_substream *capture_substream;
0086
0087     struct snd_rawmidi *rmidi;
0088     struct snd_rawmidi_substream *midi_substream_input;
0089     struct snd_rawmidi_substream *midi_substream_output;
0090     irq_handler_t rmidi_callback;
0091
0092     spinlock_t reg_lock;
0093     spinlock_t open_lock;
0094     spinlock_t midi_input_lock;
0095
0096     struct snd_info_entry *proc_entry;
0097
0098 #ifdef CONFIG_PM
0099     unsigned char saved_regs[0x20];
0100 #endif
0101 };
0102
0103 /* I/O ports */
0104
0105 #define SBP(chip, x)        ((chip)->port + s_b_SB_##x)
0106 #define SBP1(port, x)       ((port) + s_b_SB_##x)
0107
0108 #define s_b_SB_RESET        0x6
0109 #define s_b_SB_READ     0xa
0110 #define s_b_SB_WRITE        0xc
0111 #define s_b_SB_COMMAND      0xc
0112 #define s_b_SB_STATUS       0xc
0113 #define s_b_SB_DATA_AVAIL   0xe
0114 #define s_b_SB_DATA_AVAIL_16    0xf
0115 #define s_b_SB_MIXER_ADDR   0x4
0116 #define s_b_SB_MIXER_DATA   0x5
0117 #define s_b_SB_OPL3_LEFT    0x0
0118 #define s_b_SB_OPL3_RIGHT   0x2
0119 #define s_b_SB_OPL3_BOTH    0x8
0120
0121 #define SB_DSP_OUTPUT       0x14
0122 #define SB_DSP_INPUT        0x24
0123 #define SB_DSP_BLOCK_SIZE   0x48
0124 #define SB_DSP_HI_OUTPUT    0x91
0125 #define SB_DSP_HI_INPUT     0x99
0126 #define SB_DSP_LO_OUTPUT_AUTO   0x1c
0127 #define SB_DSP_LO_INPUT_AUTO    0x2c
0128 #define SB_DSP_HI_OUTPUT_AUTO   0x90
0129 #define SB_DSP_HI_INPUT_AUTO    0x98
0130 #define SB_DSP_IMMED_INT    0xf2
0131 #define SB_DSP_GET_VERSION  0xe1
0132 #define SB_DSP_SPEAKER_ON   0xd1
0133 #define SB_DSP_SPEAKER_OFF  0xd3
0134 #define SB_DSP_DMA8_OFF     0xd0
0135 #define SB_DSP_DMA8_ON      0xd4
0136 #define SB_DSP_DMA8_EXIT    0xda
0137 #define SB_DSP_DMA16_OFF    0xd5
0138 #define SB_DSP_DMA16_ON     0xd6
0139 #define SB_DSP_DMA16_EXIT   0xd9
0140 #define SB_DSP_SAMPLE_RATE  0x40
0141 #define SB_DSP_SAMPLE_RATE_OUT  0x41
0142 #define SB_DSP_SAMPLE_RATE_IN   0x42
0143 #define SB_DSP_MONO_8BIT    0xa0
0144 #define SB_DSP_MONO_16BIT   0xa4
0145 #define SB_DSP_STEREO_8BIT  0xa8
0146 #define SB_DSP_STEREO_16BIT 0xac
0147
0148 #define SB_DSP_MIDI_INPUT_IRQ   0x31
0149 #define SB_DSP_MIDI_UART_IRQ    0x35
0150 #define SB_DSP_MIDI_OUTPUT  0x38
0151
0152 #define SB_DSP4_OUT8_AI     0xc6
0153 #define SB_DSP4_IN8_AI      0xce
0154 #define SB_DSP4_OUT16_AI    0xb6
0155 #define SB_DSP4_IN16_AI     0xbe
0156 #define SB_DSP4_MODE_UNS_MONO   0x00
0157 #define SB_DSP4_MODE_SIGN_MONO  0x10
0158 #define SB_DSP4_MODE_UNS_STEREO 0x20
0159 #define SB_DSP4_MODE_SIGN_STEREO 0x30
0160
0161 #define SB_DSP4_OUTPUT      0x3c
0162 #define SB_DSP4_INPUT_LEFT  0x3d
0163 #define SB_DSP4_INPUT_RIGHT 0x3e
0164
0165 /* registers for SB 2.0 mixer */
0166 #define SB_DSP20_MASTER_DEV 0x02
0167 #define SB_DSP20_PCM_DEV    0x0A
0168 #define SB_DSP20_CD_DEV     0x08
0169 #define SB_DSP20_FM_DEV     0x06
0170
0171 /* registers for SB PRO mixer */
0172 #define SB_DSP_MASTER_DEV   0x22
0173 #define SB_DSP_PCM_DEV      0x04
0174 #define SB_DSP_LINE_DEV     0x2e
0175 #define SB_DSP_CD_DEV       0x28
0176 #define SB_DSP_FM_DEV       0x26
0177 #define SB_DSP_MIC_DEV      0x0a
0178 #define SB_DSP_CAPTURE_SOURCE   0x0c
0179 #define SB_DSP_CAPTURE_FILT 0x0c
0180 #define SB_DSP_PLAYBACK_FILT    0x0e
0181 #define SB_DSP_STEREO_SW    0x0e
0182
0183 #define SB_DSP_MIXS_MIC0    0x00    /* same as MIC */
0184 #define SB_DSP_MIXS_CD      0x01
0185 #define SB_DSP_MIXS_MIC     0x02
0186 #define SB_DSP_MIXS_LINE    0x03
0187
0188 /* registers (only for left channel) for SB 16 mixer */
0189 #define SB_DSP4_MASTER_DEV  0x30
0190 #define SB_DSP4_BASS_DEV    0x46
0191 #define SB_DSP4_TREBLE_DEV  0x44
0192 #define SB_DSP4_SYNTH_DEV   0x34
0193 #define SB_DSP4_PCM_DEV     0x32
0194 #define SB_DSP4_SPEAKER_DEV 0x3b
0195 #define SB_DSP4_LINE_DEV    0x38
0196 #define SB_DSP4_MIC_DEV     0x3a
0197 #define SB_DSP4_OUTPUT_SW   0x3c
0198 #define SB_DSP4_CD_DEV      0x36
0199 #define SB_DSP4_IGAIN_DEV   0x3f
0200 #define SB_DSP4_OGAIN_DEV   0x41
0201 #define SB_DSP4_MIC_AGC     0x43
0202
0203 /* additional registers for SB 16 mixer */
0204 #define SB_DSP4_IRQSETUP    0x80
0205 #define SB_DSP4_DMASETUP    0x81
0206 #define SB_DSP4_IRQSTATUS   0x82
0207 #define SB_DSP4_MPUSETUP    0x84
0208
0209 #define SB_DSP4_3DSE        0x90
0210
0211 /* Registers for DT-019x / ALS-007 mixer */
0212 #define SB_DT019X_MASTER_DEV    0x62
0213 #define SB_DT019X_PCM_DEV   0x64
0214 #define SB_DT019X_SYNTH_DEV 0x66
0215 #define SB_DT019X_CD_DEV    0x68
0216 #define SB_DT019X_MIC_DEV   0x6a
0217 #define SB_DT019X_SPKR_DEV  0x6a
0218 #define SB_DT019X_LINE_DEV  0x6e
0219 #define SB_DT019X_OUTPUT_SW2    0x4c
0220 #define SB_DT019X_CAPTURE_SW    0x6c
0221
0222 #define SB_DT019X_CAP_CD    0x02
0223 #define SB_DT019X_CAP_MIC   0x04
0224 #define SB_DT019X_CAP_LINE  0x06
0225 #define SB_DT019X_CAP_SYNTH 0x07
0226 #define SB_DT019X_CAP_MAIN  0x07
0227
0228 #define SB_ALS4000_MONO_IO_CTRL 0x4b
0229 #define SB_ALS4000_OUT_MIXER_CTRL_2 0x4c
0230 #define SB_ALS4000_MIC_IN_GAIN  0x4d
0231 #define SB_ALS4000_ANALOG_REFRNC_VOLT_CTRL 0x4e
0232 #define SB_ALS4000_FMDAC    0x4f
0233 #define SB_ALS4000_3D_SND_FX    0x50
0234 #define SB_ALS4000_3D_TIME_DELAY    0x51
0235 #define SB_ALS4000_3D_AUTO_MUTE 0x52
0236 #define SB_ALS4000_ANALOG_BLOCK_CTRL 0x53
0237 #define SB_ALS4000_3D_DELAYLINE_PATTERN 0x54
0238 #define SB_ALS4000_CR3_CONFIGURATION    0xc3 /* bit 7 is Digital Loop Enable */
0239 #define SB_ALS4000_QSOUND   0xdb
0240
0241 /* IRQ setting bitmap */
0242 #define SB_IRQSETUP_IRQ9    0x01
0243 #define SB_IRQSETUP_IRQ5    0x02
0244 #define SB_IRQSETUP_IRQ7    0x04
0245 #define SB_IRQSETUP_IRQ10   0x08
0246
0247 /* IRQ types */
0248 #define SB_IRQTYPE_8BIT     0x01
0249 #define SB_IRQTYPE_16BIT    0x02
0250 #define SB_IRQTYPE_MPUIN    0x04
0251 #define ALS4K_IRQTYPE_CR1E_DMA  0x20
0252
0253 /* DMA setting bitmap */
0254 #define SB_DMASETUP_DMA0    0x01
0255 #define SB_DMASETUP_DMA1    0x02
0256 #define SB_DMASETUP_DMA3    0x08
0257 #define SB_DMASETUP_DMA5    0x20
0258 #define SB_DMASETUP_DMA6    0x40
0259 #define SB_DMASETUP_DMA7    0x80
0260
0261 /*
0262  *
0263  */
0264
0265 static inline void snd_sb_ack_8bit(struct snd_sb *chip)
0266 {
0267     inb(SBP(chip, DATA_AVAIL));
0268 }
0269
0270 static inline void snd_sb_ack_16bit(struct snd_sb *chip)
0271 {
0272     inb(SBP(chip, DATA_AVAIL_16));
0273 }
0274
0275 /* sb_common.c */
0276 int snd_sbdsp_command(struct snd_sb *chip, unsigned char val);
0277 int snd_sbdsp_get_byte(struct snd_sb *chip);
0278 int snd_sbdsp_reset(struct snd_sb *chip);
0279 int snd_sbdsp_create(struct snd_card *card,
0280              unsigned long port,
0281              int irq,
0282              irq_handler_t irq_handler,
0283              int dma8, int dma16,
0284              unsigned short hardware,
0285              struct snd_sb **r_chip);
0286 /* sb_mixer.c */
0287 void snd_sbmixer_write(struct snd_sb *chip, unsigned char reg, unsigned char data);
0288 unsigned char snd_sbmixer_read(struct snd_sb *chip, unsigned char reg);
0289 int snd_sbmixer_new(struct snd_sb *chip);
0290 #ifdef CONFIG_PM
0291 void snd_sbmixer_suspend(struct snd_sb *chip);
0292 void snd_sbmixer_resume(struct snd_sb *chip);
0293 #endif
0294
0295 /* sb8_init.c */
0296 int snd_sb8dsp_pcm(struct snd_sb *chip, int device);
0297 /* sb8.c */
0298 irqreturn_t snd_sb8dsp_interrupt(struct snd_sb *chip);
0299 int snd_sb8_playback_open(struct snd_pcm_substream *substream);
0300 int snd_sb8_capture_open(struct snd_pcm_substream *substream);
0301 int snd_sb8_playback_close(struct snd_pcm_substream *substream);
0302 int snd_sb8_capture_close(struct snd_pcm_substream *substream);
0303 /* midi8.c */
0304 irqreturn_t snd_sb8dsp_midi_interrupt(struct snd_sb *chip);
0305 int snd_sb8dsp_midi(struct snd_sb *chip, int device);
0306
0307 /* sb16_init.c */
0308 int snd_sb16dsp_pcm(struct snd_sb *chip, int device);
0309 const struct snd_pcm_ops *snd_sb16dsp_get_pcm_ops(int direction);
0310 int snd_sb16dsp_configure(struct snd_sb *chip);
0311 /* sb16.c */
0312 irqreturn_t snd_sb16dsp_interrupt(int irq, void *dev_id);
0313
0314 /* exported mixer stuffs */
0315 enum {
0316     SB_MIX_SINGLE,
0317     SB_MIX_DOUBLE,
0318     SB_MIX_INPUT_SW,
0319     SB_MIX_CAPTURE_PRO,
0320     SB_MIX_CAPTURE_DT019X,
0321     SB_MIX_MONO_CAPTURE_ALS4K
0322 };
0323
0324 #define SB_MIXVAL_DOUBLE(left_reg, right_reg, left_shift, right_shift, mask) \
0325   ((left_reg) | ((right_reg) << 8) | ((left_shift) << 16) | ((right_shift) << 19) | ((mask) << 24))
0326 #define SB_MIXVAL_SINGLE(reg, shift, mask) \
0327   ((reg) | ((shift) << 16) | ((mask) << 24))
0328 #define SB_MIXVAL_INPUT_SW(reg1, reg2, left_shift, right_shift) \
0329   ((reg1) | ((reg2) << 8) | ((left_shift) << 16) | ((right_shift) << 24))
0330
0331 int snd_sbmixer_add_ctl(struct snd_sb *chip, const char *name, int index, int type, unsigned long value);
0332
0333 /* for ease of use */
0334 struct sbmix_elem {
0335     const char *name;
0336     int type;
0337     unsigned long private_value;
0338 };
0339
0340 #define SB_SINGLE(xname, reg, shift, mask) \
0341 { .name = xname, \
0342   .type = SB_MIX_SINGLE, \
0343   .private_value = SB_MIXVAL_SINGLE(reg, shift, mask) }
0344
0345 #define SB_DOUBLE(xname, left_reg, right_reg, left_shift, right_shift, mask) \
0346 { .name = xname, \
0347   .type = SB_MIX_DOUBLE, \
0348   .private_value = SB_MIXVAL_DOUBLE(left_reg, right_reg, left_shift, right_shift, mask) }
0349
0350 #define SB16_INPUT_SW(xname, reg1, reg2, left_shift, right_shift) \
0351 { .name = xname, \
0352   .type = SB_MIX_INPUT_SW, \
0353   .private_value = SB_MIXVAL_INPUT_SW(reg1, reg2, left_shift, right_shift) }
0354
0355 static inline int snd_sbmixer_add_ctl_elem(struct snd_sb *chip, const struct sbmix_elem *c)
0356 {
0357     return snd_sbmixer_add_ctl(chip, c->name, 0, c->type, c->private_value);
0358 }
0359
0360 #endif /* __SOUND_SB_H */