2 * card-als4000.c - driver for Avance Logic ALS4000 based soundcards.
3 * Copyright (C) 2000 by Bart Hartgers <bart@etpmod.phys.tue.nl>,
4 * Jaroslav Kysela <perex@perex.cz>
5 * Copyright (C) 2002, 2008 by Andreas Mohr <hw7oshyuv3001@sneakemail.com>
7 * Framework borrowed from Massimo Piccioni's card-als100.c.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 * Since Avance does not provide any meaningful documentation, and I
27 * bought an ALS4000 based soundcard, I was forced to base this driver
28 * on reverse engineering.
30 * Note: this is no longer true (thank you!):
31 * pretty verbose chip docu (ALS4000a.PDF) can be found on the ALSA web site.
32 * Page numbers stated anywhere below with the "SPECS_PAGE:" tag
33 * refer to: ALS4000a.PDF specs Ver 1.0, May 28th, 1998.
35 * The ALS4000 seems to be the PCI-cousin of the ALS100. It contains an
36 * ALS100-like SB DSP/mixer, an OPL3 synth, a MPU401 and a gameport
37 * interface. These subsystems can be mapped into ISA io-port space,
38 * using the PCI-interface. In addition, the PCI-bit provides DMA and IRQ
39 * services to the subsystems.
41 * While ALS4000 is very similar to a SoundBlaster, the differences in
42 * DMA and capturing require more changes to the SoundBlaster than
43 * desirable, so I made this separate driver.
45 * The ALS4000 can do real full duplex playback/capture.
51 * Enable/disable 3D sound:
53 * - change bit 6 (0x40) of port 0x15
58 * 0x3e (mode 3), 0x3c (mode 2), 0x3a (mode 1), 0x38 (mode 0)
61 * - value -> some port 0x0c0d
64 * - by default, don't enable legacy game and use PCI game I/O
65 * - power management? (card can do voice wakeup according to datasheet!!)
69 #include <linux/init.h>
70 #include <linux/pci.h>
71 #include <linux/slab.h>
72 #include <linux/gameport.h>
73 #include <linux/moduleparam.h>
74 #include <linux/dma-mapping.h>
75 #include <sound/core.h>
76 #include <sound/pcm.h>
77 #include <sound/rawmidi.h>
78 #include <sound/mpu401.h>
79 #include <sound/opl3.h>
81 #include <sound/initval.h>
83 MODULE_AUTHOR("Bart Hartgers <bart@etpmod.phys.tue.nl>, Andreas Mohr");
84 MODULE_DESCRIPTION("Avance Logic ALS4000");
85 MODULE_LICENSE("GPL");
86 MODULE_SUPPORTED_DEVICE("{{Avance Logic,ALS4000}}");
88 #if defined(CONFIG_GAMEPORT) || (defined(MODULE) && defined(CONFIG_GAMEPORT_MODULE))
89 #define SUPPORT_JOYSTICK 1
92 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
93 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
94 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
95 #ifdef SUPPORT_JOYSTICK
96 static int joystick_port[SNDRV_CARDS];
99 module_param_array(index, int, NULL, 0444);
100 MODULE_PARM_DESC(index, "Index value for ALS4000 soundcard.");
101 module_param_array(id, charp, NULL, 0444);
102 MODULE_PARM_DESC(id, "ID string for ALS4000 soundcard.");
103 module_param_array(enable, bool, NULL, 0444);
104 MODULE_PARM_DESC(enable, "Enable ALS4000 soundcard.");
105 #ifdef SUPPORT_JOYSTICK
106 module_param_array(joystick_port, int, NULL, 0444);
107 MODULE_PARM_DESC(joystick_port, "Joystick port address for ALS4000 soundcard. (0 = disabled)");
110 struct snd_card_als4000 {
111 /* most frequent access first */
112 unsigned long iobase;
115 #ifdef SUPPORT_JOYSTICK
116 struct gameport *gameport;
120 static DEFINE_PCI_DEVICE_TABLE(snd_als4000_ids) = {
121 { 0x4005, 0x4000, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0, }, /* ALS4000 */
125 MODULE_DEVICE_TABLE(pci, snd_als4000_ids);
127 enum als4k_iobase_t {
128 /* IOx: B == Byte, W = Word, D = DWord; SPECS_PAGE: 37 */
129 ALS4K_IOD_00_AC97_ACCESS = 0x00,
130 ALS4K_IOW_04_AC97_READ = 0x04,
131 ALS4K_IOB_06_AC97_STATUS = 0x06,
132 ALS4K_IOB_07_IRQSTATUS = 0x07,
133 ALS4K_IOD_08_GCR_DATA = 0x08,
134 ALS4K_IOB_0C_GCR_INDEX = 0x0c,
135 ALS4K_IOB_0E_IRQTYPE_SB_CR1E_MPU = 0x0e,
136 ALS4K_IOB_10_ADLIB_ADDR0 = 0x10,
137 ALS4K_IOB_11_ADLIB_ADDR1 = 0x11,
138 ALS4K_IOB_12_ADLIB_ADDR2 = 0x12,
139 ALS4K_IOB_13_ADLIB_ADDR3 = 0x13,
140 ALS4K_IOB_14_MIXER_INDEX = 0x14,
141 ALS4K_IOB_15_MIXER_DATA = 0x15,
142 ALS4K_IOB_16_ESP_RESET = 0x16,
143 ALS4K_IOB_16_ACK_FOR_CR1E = 0x16, /* 2nd function */
144 ALS4K_IOB_18_OPL_ADDR0 = 0x18,
145 ALS4K_IOB_19_OPL_ADDR1 = 0x19,
146 ALS4K_IOB_1A_ESP_RD_DATA = 0x1a,
147 ALS4K_IOB_1C_ESP_CMD_DATA = 0x1c,
148 ALS4K_IOB_1C_ESP_WR_STATUS = 0x1c, /* 2nd function */
149 ALS4K_IOB_1E_ESP_RD_STATUS8 = 0x1e,
150 ALS4K_IOB_1F_ESP_RD_STATUS16 = 0x1f,
151 ALS4K_IOB_20_ESP_GAMEPORT_200 = 0x20,
152 ALS4K_IOB_21_ESP_GAMEPORT_201 = 0x21,
153 ALS4K_IOB_30_MIDI_DATA = 0x30,
154 ALS4K_IOB_31_MIDI_STATUS = 0x31,
155 ALS4K_IOB_31_MIDI_COMMAND = 0x31, /* 2nd function */
158 enum als4k_iobase_0e_t {
159 ALS4K_IOB_0E_MPU_IRQ = 0x10,
160 ALS4K_IOB_0E_CR1E_IRQ = 0x40,
161 ALS4K_IOB_0E_SB_DMA_IRQ = 0x80,
164 enum als4k_gcr_t { /* all registers 32bit wide; SPECS_PAGE: 38 to 42 */
165 ALS4K_GCR8C_MISC_CTRL = 0x8c,
166 ALS4K_GCR90_TEST_MODE_REG = 0x90,
167 ALS4K_GCR91_DMA0_ADDR = 0x91,
168 ALS4K_GCR92_DMA0_MODE_COUNT = 0x92,
169 ALS4K_GCR93_DMA1_ADDR = 0x93,
170 ALS4K_GCR94_DMA1_MODE_COUNT = 0x94,
171 ALS4K_GCR95_DMA3_ADDR = 0x95,
172 ALS4K_GCR96_DMA3_MODE_COUNT = 0x96,
173 ALS4K_GCR99_DMA_EMULATION_CTRL = 0x99,
174 ALS4K_GCRA0_FIFO1_CURRENT_ADDR = 0xa0,
175 ALS4K_GCRA1_FIFO1_STATUS_BYTECOUNT = 0xa1,
176 ALS4K_GCRA2_FIFO2_PCIADDR = 0xa2,
177 ALS4K_GCRA3_FIFO2_COUNT = 0xa3,
178 ALS4K_GCRA4_FIFO2_CURRENT_ADDR = 0xa4,
179 ALS4K_GCRA5_FIFO1_STATUS_BYTECOUNT = 0xa5,
180 ALS4K_GCRA6_PM_CTRL = 0xa6,
181 ALS4K_GCRA7_PCI_ACCESS_STORAGE = 0xa7,
182 ALS4K_GCRA8_LEGACY_CFG1 = 0xa8,
183 ALS4K_GCRA9_LEGACY_CFG2 = 0xa9,
184 ALS4K_GCRFF_DUMMY_SCRATCH = 0xff,
188 ALS4K_GCR8C_IRQ_MASK_CTRL_ENABLE = 0x8000,
189 ALS4K_GCR8C_CHIP_REV_MASK = 0xf0000
192 static inline void snd_als4k_iobase_writeb(unsigned long iobase,
193 enum als4k_iobase_t reg,
196 outb(val, iobase + reg);
199 static inline void snd_als4k_iobase_writel(unsigned long iobase,
200 enum als4k_iobase_t reg,
203 outl(val, iobase + reg);
206 static inline u8 snd_als4k_iobase_readb(unsigned long iobase,
207 enum als4k_iobase_t reg)
209 return inb(iobase + reg);
212 static inline u32 snd_als4k_iobase_readl(unsigned long iobase,
213 enum als4k_iobase_t reg)
215 return inl(iobase + reg);
218 static inline void snd_als4k_gcr_write_addr(unsigned long iobase,
219 enum als4k_gcr_t reg,
222 snd_als4k_iobase_writeb(iobase, ALS4K_IOB_0C_GCR_INDEX, reg);
223 snd_als4k_iobase_writel(iobase, ALS4K_IOD_08_GCR_DATA, val);
226 static inline void snd_als4k_gcr_write(struct snd_sb *sb,
227 enum als4k_gcr_t reg,
230 snd_als4k_gcr_write_addr(sb->alt_port, reg, val);
233 static inline u32 snd_als4k_gcr_read_addr(unsigned long iobase,
234 enum als4k_gcr_t reg)
236 /* SPECS_PAGE: 37/38 */
237 snd_als4k_iobase_writeb(iobase, ALS4K_IOB_0C_GCR_INDEX, reg);
238 return snd_als4k_iobase_readl(iobase, ALS4K_IOD_08_GCR_DATA);
241 static inline u32 snd_als4k_gcr_read(struct snd_sb *sb, enum als4k_gcr_t reg)
243 return snd_als4k_gcr_read_addr(sb->alt_port, reg);
246 enum als4k_cr_t { /* all registers 8bit wide; SPECS_PAGE: 20 to 23 */
247 ALS4K_CR0_SB_CONFIG = 0x00,
248 ALS4K_CR2_MISC_CONTROL = 0x02,
249 ALS4K_CR3_CONFIGURATION = 0x03,
250 ALS4K_CR17_FIFO_STATUS = 0x17,
251 ALS4K_CR18_ESP_MAJOR_VERSION = 0x18,
252 ALS4K_CR19_ESP_MINOR_VERSION = 0x19,
253 ALS4K_CR1A_MPU401_UART_MODE_CONTROL = 0x1a,
254 ALS4K_CR1C_FIFO2_BLOCK_LENGTH_LO = 0x1c,
255 ALS4K_CR1D_FIFO2_BLOCK_LENGTH_HI = 0x1d,
256 ALS4K_CR1E_FIFO2_CONTROL = 0x1e, /* secondary PCM FIFO (recording) */
257 ALS4K_CR3A_MISC_CONTROL = 0x3a,
258 ALS4K_CR3B_CRC32_BYTE0 = 0x3b, /* for testing, activate via CR3A */
259 ALS4K_CR3C_CRC32_BYTE1 = 0x3c,
260 ALS4K_CR3D_CRC32_BYTE2 = 0x3d,
261 ALS4K_CR3E_CRC32_BYTE3 = 0x3e,
265 ALS4K_CR0_DMA_CONTIN_MODE_CTRL = 0x02, /* IRQ/FIFO controlled for 0/1 */
266 ALS4K_CR0_DMA_90H_MODE_CTRL = 0x04, /* IRQ/FIFO controlled for 0/1 */
267 ALS4K_CR0_MX80_81_REG_WRITE_ENABLE = 0x80,
270 static inline void snd_als4_cr_write(struct snd_sb *chip,
274 /* Control Register is reg | 0xc0 (bit 7, 6 set) on sbmixer_index
275 * NOTE: assumes chip->mixer_lock to be locked externally already!
277 snd_sbmixer_write(chip, reg | 0xc0, data);
280 static inline u8 snd_als4_cr_read(struct snd_sb *chip,
283 /* NOTE: assumes chip->mixer_lock to be locked externally already! */
284 return snd_sbmixer_read(chip, reg | 0xc0);
289 static void snd_als4000_set_rate(struct snd_sb *chip, unsigned int rate)
291 if (!(chip->mode & SB_RATE_LOCK)) {
292 snd_sbdsp_command(chip, SB_DSP_SAMPLE_RATE_OUT);
293 snd_sbdsp_command(chip, rate>>8);
294 snd_sbdsp_command(chip, rate);
298 static inline void snd_als4000_set_capture_dma(struct snd_sb *chip,
299 dma_addr_t addr, unsigned size)
302 snd_als4k_gcr_write(chip, ALS4K_GCRA2_FIFO2_PCIADDR, addr);
303 snd_als4k_gcr_write(chip, ALS4K_GCRA3_FIFO2_COUNT, (size-1));
306 static inline void snd_als4000_set_playback_dma(struct snd_sb *chip,
311 snd_als4k_gcr_write(chip, ALS4K_GCR91_DMA0_ADDR, addr);
312 snd_als4k_gcr_write(chip, ALS4K_GCR92_DMA0_MODE_COUNT,
316 #define ALS4000_FORMAT_SIGNED (1<<0)
317 #define ALS4000_FORMAT_16BIT (1<<1)
318 #define ALS4000_FORMAT_STEREO (1<<2)
320 static int snd_als4000_get_format(struct snd_pcm_runtime *runtime)
325 if (snd_pcm_format_signed(runtime->format))
326 result |= ALS4000_FORMAT_SIGNED;
327 if (snd_pcm_format_physical_width(runtime->format) == 16)
328 result |= ALS4000_FORMAT_16BIT;
329 if (runtime->channels > 1)
330 result |= ALS4000_FORMAT_STEREO;
334 /* structure for setting up playback */
335 static const struct {
336 unsigned char dsp_cmd, dma_on, dma_off, format;
337 } playback_cmd_vals[]={
338 /* ALS4000_FORMAT_U8_MONO */
339 { SB_DSP4_OUT8_AI, SB_DSP_DMA8_ON, SB_DSP_DMA8_OFF, SB_DSP4_MODE_UNS_MONO },
340 /* ALS4000_FORMAT_S8_MONO */
341 { SB_DSP4_OUT8_AI, SB_DSP_DMA8_ON, SB_DSP_DMA8_OFF, SB_DSP4_MODE_SIGN_MONO },
342 /* ALS4000_FORMAT_U16L_MONO */
343 { SB_DSP4_OUT16_AI, SB_DSP_DMA16_ON, SB_DSP_DMA16_OFF, SB_DSP4_MODE_UNS_MONO },
344 /* ALS4000_FORMAT_S16L_MONO */
345 { SB_DSP4_OUT16_AI, SB_DSP_DMA16_ON, SB_DSP_DMA16_OFF, SB_DSP4_MODE_SIGN_MONO },
346 /* ALS4000_FORMAT_U8_STEREO */
347 { SB_DSP4_OUT8_AI, SB_DSP_DMA8_ON, SB_DSP_DMA8_OFF, SB_DSP4_MODE_UNS_STEREO },
348 /* ALS4000_FORMAT_S8_STEREO */
349 { SB_DSP4_OUT8_AI, SB_DSP_DMA8_ON, SB_DSP_DMA8_OFF, SB_DSP4_MODE_SIGN_STEREO },
350 /* ALS4000_FORMAT_U16L_STEREO */
351 { SB_DSP4_OUT16_AI, SB_DSP_DMA16_ON, SB_DSP_DMA16_OFF, SB_DSP4_MODE_UNS_STEREO },
352 /* ALS4000_FORMAT_S16L_STEREO */
353 { SB_DSP4_OUT16_AI, SB_DSP_DMA16_ON, SB_DSP_DMA16_OFF, SB_DSP4_MODE_SIGN_STEREO },
355 #define playback_cmd(chip) (playback_cmd_vals[(chip)->playback_format])
357 /* structure for setting up capture */
358 enum { CMD_WIDTH8=0x04, CMD_SIGNED=0x10, CMD_MONO=0x80, CMD_STEREO=0xA0 };
359 static const unsigned char capture_cmd_vals[]=
361 CMD_WIDTH8|CMD_MONO, /* ALS4000_FORMAT_U8_MONO */
362 CMD_WIDTH8|CMD_SIGNED|CMD_MONO, /* ALS4000_FORMAT_S8_MONO */
363 CMD_MONO, /* ALS4000_FORMAT_U16L_MONO */
364 CMD_SIGNED|CMD_MONO, /* ALS4000_FORMAT_S16L_MONO */
365 CMD_WIDTH8|CMD_STEREO, /* ALS4000_FORMAT_U8_STEREO */
366 CMD_WIDTH8|CMD_SIGNED|CMD_STEREO, /* ALS4000_FORMAT_S8_STEREO */
367 CMD_STEREO, /* ALS4000_FORMAT_U16L_STEREO */
368 CMD_SIGNED|CMD_STEREO, /* ALS4000_FORMAT_S16L_STEREO */
370 #define capture_cmd(chip) (capture_cmd_vals[(chip)->capture_format])
372 static int snd_als4000_hw_params(struct snd_pcm_substream *substream,
373 struct snd_pcm_hw_params *hw_params)
375 return snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params));
378 static int snd_als4000_hw_free(struct snd_pcm_substream *substream)
380 snd_pcm_lib_free_pages(substream);
384 static int snd_als4000_capture_prepare(struct snd_pcm_substream *substream)
386 struct snd_sb *chip = snd_pcm_substream_chip(substream);
387 struct snd_pcm_runtime *runtime = substream->runtime;
391 chip->capture_format = snd_als4000_get_format(runtime);
393 size = snd_pcm_lib_buffer_bytes(substream);
394 count = snd_pcm_lib_period_bytes(substream);
396 if (chip->capture_format & ALS4000_FORMAT_16BIT)
400 spin_lock_irq(&chip->reg_lock);
401 snd_als4000_set_rate(chip, runtime->rate);
402 snd_als4000_set_capture_dma(chip, runtime->dma_addr, size);
403 spin_unlock_irq(&chip->reg_lock);
404 spin_lock_irq(&chip->mixer_lock);
405 snd_als4_cr_write(chip, ALS4K_CR1C_FIFO2_BLOCK_LENGTH_LO, count & 0xff);
406 snd_als4_cr_write(chip, ALS4K_CR1D_FIFO2_BLOCK_LENGTH_HI, count >> 8);
407 spin_unlock_irq(&chip->mixer_lock);
411 static int snd_als4000_playback_prepare(struct snd_pcm_substream *substream)
413 struct snd_sb *chip = snd_pcm_substream_chip(substream);
414 struct snd_pcm_runtime *runtime = substream->runtime;
418 chip->playback_format = snd_als4000_get_format(runtime);
420 size = snd_pcm_lib_buffer_bytes(substream);
421 count = snd_pcm_lib_period_bytes(substream);
423 if (chip->playback_format & ALS4000_FORMAT_16BIT)
427 /* FIXME: from second playback on, there's a lot more clicks and pops
428 * involved here than on first playback. Fiddling with
429 * tons of different settings didn't help (DMA, speaker on/off,
430 * reordering, ...). Something seems to get enabled on playback
431 * that I haven't found out how to disable again, which then causes
432 * the switching pops to reach the speakers the next time here. */
433 spin_lock_irq(&chip->reg_lock);
434 snd_als4000_set_rate(chip, runtime->rate);
435 snd_als4000_set_playback_dma(chip, runtime->dma_addr, size);
437 /* SPEAKER_ON not needed, since dma_on seems to also enable speaker */
438 /* snd_sbdsp_command(chip, SB_DSP_SPEAKER_ON); */
439 snd_sbdsp_command(chip, playback_cmd(chip).dsp_cmd);
440 snd_sbdsp_command(chip, playback_cmd(chip).format);
441 snd_sbdsp_command(chip, count & 0xff);
442 snd_sbdsp_command(chip, count >> 8);
443 snd_sbdsp_command(chip, playback_cmd(chip).dma_off);
444 spin_unlock_irq(&chip->reg_lock);
449 static int snd_als4000_capture_trigger(struct snd_pcm_substream *substream, int cmd)
451 struct snd_sb *chip = snd_pcm_substream_chip(substream);
454 /* FIXME race condition in here!!!
455 chip->mode non-atomic update gets consistently protected
456 by reg_lock always, _except_ for this place!!
457 Probably need to take reg_lock as outer (or inner??) lock, too.
458 (or serialize both lock operations? probably not, though... - racy?)
460 spin_lock(&chip->mixer_lock);
462 case SNDRV_PCM_TRIGGER_START:
463 case SNDRV_PCM_TRIGGER_RESUME:
464 chip->mode |= SB_RATE_LOCK_CAPTURE;
465 snd_als4_cr_write(chip, ALS4K_CR1E_FIFO2_CONTROL,
468 case SNDRV_PCM_TRIGGER_STOP:
469 case SNDRV_PCM_TRIGGER_SUSPEND:
470 chip->mode &= ~SB_RATE_LOCK_CAPTURE;
471 snd_als4_cr_write(chip, ALS4K_CR1E_FIFO2_CONTROL,
478 spin_unlock(&chip->mixer_lock);
482 static int snd_als4000_playback_trigger(struct snd_pcm_substream *substream, int cmd)
484 struct snd_sb *chip = snd_pcm_substream_chip(substream);
487 spin_lock(&chip->reg_lock);
489 case SNDRV_PCM_TRIGGER_START:
490 case SNDRV_PCM_TRIGGER_RESUME:
491 chip->mode |= SB_RATE_LOCK_PLAYBACK;
492 snd_sbdsp_command(chip, playback_cmd(chip).dma_on);
494 case SNDRV_PCM_TRIGGER_STOP:
495 case SNDRV_PCM_TRIGGER_SUSPEND:
496 snd_sbdsp_command(chip, playback_cmd(chip).dma_off);
497 chip->mode &= ~SB_RATE_LOCK_PLAYBACK;
503 spin_unlock(&chip->reg_lock);
507 static snd_pcm_uframes_t snd_als4000_capture_pointer(struct snd_pcm_substream *substream)
509 struct snd_sb *chip = snd_pcm_substream_chip(substream);
512 spin_lock(&chip->reg_lock);
513 result = snd_als4k_gcr_read(chip, ALS4K_GCRA4_FIFO2_CURRENT_ADDR);
514 spin_unlock(&chip->reg_lock);
516 return bytes_to_frames( substream->runtime, result );
519 static snd_pcm_uframes_t snd_als4000_playback_pointer(struct snd_pcm_substream *substream)
521 struct snd_sb *chip = snd_pcm_substream_chip(substream);
524 spin_lock(&chip->reg_lock);
525 result = snd_als4k_gcr_read(chip, ALS4K_GCRA0_FIFO1_CURRENT_ADDR);
526 spin_unlock(&chip->reg_lock);
528 return bytes_to_frames( substream->runtime, result );
531 /* FIXME: this IRQ routine doesn't really support IRQ sharing (we always
532 * return IRQ_HANDLED no matter whether we actually had an IRQ flag or not).
533 * ALS4000a.PDF writes that while ACKing IRQ in PCI block will *not* ACK
534 * the IRQ in the SB core, ACKing IRQ in SB block *will* ACK the PCI IRQ
535 * register (alt_port + ALS4K_IOB_0E_IRQTYPE_SB_CR1E_MPU). Probably something
536 * could be optimized here to query/write one register only...
537 * And even if both registers need to be queried, then there's still the
538 * question of whether it's actually correct to ACK PCI IRQ before reading
539 * SB IRQ like we do now, since ALS4000a.PDF mentions that PCI IRQ will *clear*
541 * (hmm, SPECS_PAGE: 38 mentions it the other way around!)
542 * And do we *really* need the lock here for *reading* SB_DSP4_IRQSTATUS??
544 static irqreturn_t snd_als4000_interrupt(int irq, void *dev_id)
546 struct snd_sb *chip = dev_id;
547 unsigned pci_irqstatus;
548 unsigned sb_irqstatus;
550 /* find out which bit of the ALS4000 PCI block produced the interrupt,
552 pci_irqstatus = snd_als4k_iobase_readb(chip->alt_port,
553 ALS4K_IOB_0E_IRQTYPE_SB_CR1E_MPU);
554 if ((pci_irqstatus & ALS4K_IOB_0E_SB_DMA_IRQ)
555 && (chip->playback_substream)) /* playback */
556 snd_pcm_period_elapsed(chip->playback_substream);
557 if ((pci_irqstatus & ALS4K_IOB_0E_CR1E_IRQ)
558 && (chip->capture_substream)) /* capturing */
559 snd_pcm_period_elapsed(chip->capture_substream);
560 if ((pci_irqstatus & ALS4K_IOB_0E_MPU_IRQ)
561 && (chip->rmidi)) /* MPU401 interrupt */
562 snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
563 /* ACK the PCI block IRQ */
564 snd_als4k_iobase_writeb(chip->alt_port,
565 ALS4K_IOB_0E_IRQTYPE_SB_CR1E_MPU, pci_irqstatus);
567 spin_lock(&chip->mixer_lock);
569 sb_irqstatus = snd_sbmixer_read(chip, SB_DSP4_IRQSTATUS);
570 spin_unlock(&chip->mixer_lock);
572 if (sb_irqstatus & SB_IRQTYPE_8BIT)
573 snd_sb_ack_8bit(chip);
574 if (sb_irqstatus & SB_IRQTYPE_16BIT)
575 snd_sb_ack_16bit(chip);
576 if (sb_irqstatus & SB_IRQTYPE_MPUIN)
578 if (sb_irqstatus & ALS4K_IRQTYPE_CR1E_DMA)
579 snd_als4k_iobase_readb(chip->alt_port,
580 ALS4K_IOB_16_ACK_FOR_CR1E);
582 /* printk(KERN_INFO "als4000: irq 0x%04x 0x%04x\n",
583 pci_irqstatus, sb_irqstatus); */
585 /* only ack the things we actually handled above */
587 (pci_irqstatus & (ALS4K_IOB_0E_SB_DMA_IRQ|ALS4K_IOB_0E_CR1E_IRQ|
588 ALS4K_IOB_0E_MPU_IRQ))
589 || (sb_irqstatus & (SB_IRQTYPE_8BIT|SB_IRQTYPE_16BIT|
590 SB_IRQTYPE_MPUIN|ALS4K_IRQTYPE_CR1E_DMA))
594 /*****************************************************************/
596 static struct snd_pcm_hardware snd_als4000_playback =
598 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
599 SNDRV_PCM_INFO_MMAP_VALID),
600 .formats = SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_U8 |
601 SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_U16_LE, /* formats */
602 .rates = SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
607 .buffer_bytes_max = 65536,
608 .period_bytes_min = 64,
609 .period_bytes_max = 65536,
615 static struct snd_pcm_hardware snd_als4000_capture =
617 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
618 SNDRV_PCM_INFO_MMAP_VALID),
619 .formats = SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_U8 |
620 SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_U16_LE, /* formats */
621 .rates = SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
626 .buffer_bytes_max = 65536,
627 .period_bytes_min = 64,
628 .period_bytes_max = 65536,
634 /*****************************************************************/
636 static int snd_als4000_playback_open(struct snd_pcm_substream *substream)
638 struct snd_sb *chip = snd_pcm_substream_chip(substream);
639 struct snd_pcm_runtime *runtime = substream->runtime;
641 chip->playback_substream = substream;
642 runtime->hw = snd_als4000_playback;
646 static int snd_als4000_playback_close(struct snd_pcm_substream *substream)
648 struct snd_sb *chip = snd_pcm_substream_chip(substream);
650 chip->playback_substream = NULL;
651 snd_pcm_lib_free_pages(substream);
655 static int snd_als4000_capture_open(struct snd_pcm_substream *substream)
657 struct snd_sb *chip = snd_pcm_substream_chip(substream);
658 struct snd_pcm_runtime *runtime = substream->runtime;
660 chip->capture_substream = substream;
661 runtime->hw = snd_als4000_capture;
665 static int snd_als4000_capture_close(struct snd_pcm_substream *substream)
667 struct snd_sb *chip = snd_pcm_substream_chip(substream);
669 chip->capture_substream = NULL;
670 snd_pcm_lib_free_pages(substream);
674 /******************************************************************/
676 static struct snd_pcm_ops snd_als4000_playback_ops = {
677 .open = snd_als4000_playback_open,
678 .close = snd_als4000_playback_close,
679 .ioctl = snd_pcm_lib_ioctl,
680 .hw_params = snd_als4000_hw_params,
681 .hw_free = snd_als4000_hw_free,
682 .prepare = snd_als4000_playback_prepare,
683 .trigger = snd_als4000_playback_trigger,
684 .pointer = snd_als4000_playback_pointer
687 static struct snd_pcm_ops snd_als4000_capture_ops = {
688 .open = snd_als4000_capture_open,
689 .close = snd_als4000_capture_close,
690 .ioctl = snd_pcm_lib_ioctl,
691 .hw_params = snd_als4000_hw_params,
692 .hw_free = snd_als4000_hw_free,
693 .prepare = snd_als4000_capture_prepare,
694 .trigger = snd_als4000_capture_trigger,
695 .pointer = snd_als4000_capture_pointer
698 static int __devinit snd_als4000_pcm(struct snd_sb *chip, int device)
703 err = snd_pcm_new(chip->card, "ALS4000 DSP", device, 1, 1, &pcm);
706 pcm->private_data = chip;
707 pcm->info_flags = SNDRV_PCM_INFO_JOINT_DUPLEX;
708 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_als4000_playback_ops);
709 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_als4000_capture_ops);
711 snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(chip->pci),
719 /******************************************************************/
721 static void snd_als4000_set_addr(unsigned long iobase,
725 unsigned int game_io)
731 cfg2 |= (mpu_io | 1) << 16;
735 cfg1 |= (game_io | 1) << 16;
737 cfg1 |= (opl_io | 1);
738 snd_als4k_gcr_write_addr(iobase, ALS4K_GCRA8_LEGACY_CFG1, cfg1);
739 snd_als4k_gcr_write_addr(iobase, ALS4K_GCRA9_LEGACY_CFG2, cfg2);
742 static void snd_als4000_configure(struct snd_sb *chip)
747 /* do some more configuration */
748 spin_lock_irq(&chip->mixer_lock);
749 tmp = snd_als4_cr_read(chip, ALS4K_CR0_SB_CONFIG);
750 snd_als4_cr_write(chip, ALS4K_CR0_SB_CONFIG,
751 tmp|ALS4K_CR0_MX80_81_REG_WRITE_ENABLE);
752 /* always select DMA channel 0, since we do not actually use DMA
753 * SPECS_PAGE: 19/20 */
754 snd_sbmixer_write(chip, SB_DSP4_DMASETUP, SB_DMASETUP_DMA0);
755 snd_als4_cr_write(chip, ALS4K_CR0_SB_CONFIG,
756 tmp & ~ALS4K_CR0_MX80_81_REG_WRITE_ENABLE);
757 spin_unlock_irq(&chip->mixer_lock);
759 spin_lock_irq(&chip->reg_lock);
760 /* enable interrupts */
761 snd_als4k_gcr_write(chip, ALS4K_GCR8C_MISC_CTRL,
762 ALS4K_GCR8C_IRQ_MASK_CTRL_ENABLE);
765 for (i = ALS4K_GCR91_DMA0_ADDR; i <= ALS4K_GCR96_DMA3_MODE_COUNT; ++i)
766 snd_als4k_gcr_write(chip, i, 0);
768 snd_als4k_gcr_write(chip, ALS4K_GCR99_DMA_EMULATION_CTRL,
769 snd_als4k_gcr_read(chip, ALS4K_GCR99_DMA_EMULATION_CTRL));
770 spin_unlock_irq(&chip->reg_lock);
773 #ifdef SUPPORT_JOYSTICK
774 static int __devinit snd_als4000_create_gameport(struct snd_card_als4000 *acard, int dev)
780 if (joystick_port[dev] == 0)
783 if (joystick_port[dev] == 1) { /* auto-detect */
784 for (io_port = 0x200; io_port <= 0x218; io_port += 8) {
785 r = request_region(io_port, 8, "ALS4000 gameport");
790 io_port = joystick_port[dev];
791 r = request_region(io_port, 8, "ALS4000 gameport");
795 printk(KERN_WARNING "als4000: cannot reserve joystick ports\n");
799 acard->gameport = gp = gameport_allocate_port();
801 printk(KERN_ERR "als4000: cannot allocate memory for gameport\n");
802 release_and_free_resource(r);
806 gameport_set_name(gp, "ALS4000 Gameport");
807 gameport_set_phys(gp, "pci%s/gameport0", pci_name(acard->pci));
808 gameport_set_dev_parent(gp, &acard->pci->dev);
810 gameport_set_port_data(gp, r);
812 /* Enable legacy joystick port */
813 snd_als4000_set_addr(acard->iobase, 0, 0, 0, 1);
815 gameport_register_port(acard->gameport);
820 static void snd_als4000_free_gameport(struct snd_card_als4000 *acard)
822 if (acard->gameport) {
823 struct resource *r = gameport_get_port_data(acard->gameport);
825 gameport_unregister_port(acard->gameport);
826 acard->gameport = NULL;
828 /* disable joystick */
829 snd_als4000_set_addr(acard->iobase, 0, 0, 0, 0);
831 release_and_free_resource(r);
835 static inline int snd_als4000_create_gameport(struct snd_card_als4000 *acard, int dev) { return -ENOSYS; }
836 static inline void snd_als4000_free_gameport(struct snd_card_als4000 *acard) { }
839 static void snd_card_als4000_free( struct snd_card *card )
841 struct snd_card_als4000 *acard = card->private_data;
843 /* make sure that interrupts are disabled */
844 snd_als4k_gcr_write_addr(acard->iobase, ALS4K_GCR8C_MISC_CTRL, 0);
846 snd_als4000_free_gameport(acard);
847 pci_release_regions(acard->pci);
848 pci_disable_device(acard->pci);
851 static int __devinit snd_card_als4000_probe(struct pci_dev *pci,
852 const struct pci_device_id *pci_id)
855 struct snd_card *card;
856 struct snd_card_als4000 *acard;
857 unsigned long iobase;
859 struct snd_opl3 *opl3;
863 if (dev >= SNDRV_CARDS)
870 /* enable PCI device */
871 if ((err = pci_enable_device(pci)) < 0) {
874 /* check, if we can restrict PCI DMA transfers to 24 bits */
875 if (pci_set_dma_mask(pci, DMA_BIT_MASK(24)) < 0 ||
876 pci_set_consistent_dma_mask(pci, DMA_BIT_MASK(24)) < 0) {
877 snd_printk(KERN_ERR "architecture does not support 24bit PCI busmaster DMA\n");
878 pci_disable_device(pci);
882 if ((err = pci_request_regions(pci, "ALS4000")) < 0) {
883 pci_disable_device(pci);
886 iobase = pci_resource_start(pci, 0);
888 pci_read_config_word(pci, PCI_COMMAND, &word);
889 pci_write_config_word(pci, PCI_COMMAND, word | PCI_COMMAND_IO);
892 err = snd_card_create(index[dev], id[dev], THIS_MODULE,
893 sizeof(*acard) /* private_data: acard */,
896 pci_release_regions(pci);
897 pci_disable_device(pci);
901 acard = card->private_data;
903 acard->iobase = iobase;
904 card->private_free = snd_card_als4000_free;
906 /* disable all legacy ISA stuff */
907 snd_als4000_set_addr(acard->iobase, 0, 0, 0, 0);
909 if ((err = snd_sbdsp_create(card,
910 iobase + ALS4K_IOB_10_ADLIB_ADDR0,
912 /* internally registered as IRQF_SHARED in case of ALS4000 SB */
913 snd_als4000_interrupt,
923 chip->alt_port = iobase;
924 snd_card_set_dev(card, &pci->dev);
926 snd_als4000_configure(chip);
928 strcpy(card->driver, "ALS4000");
929 strcpy(card->shortname, "Avance Logic ALS4000");
930 sprintf(card->longname, "%s at 0x%lx, irq %i",
931 card->shortname, chip->alt_port, chip->irq);
933 if ((err = snd_mpu401_uart_new( card, 0, MPU401_HW_ALS4000,
934 iobase + ALS4K_IOB_30_MIDI_DATA,
935 MPU401_INFO_INTEGRATED,
936 pci->irq, 0, &chip->rmidi)) < 0) {
937 printk(KERN_ERR "als4000: no MPU-401 device at 0x%lx?\n",
938 iobase + ALS4K_IOB_30_MIDI_DATA);
941 /* FIXME: ALS4000 has interesting MPU401 configuration features
942 * at ALS4K_CR1A_MPU401_UART_MODE_CONTROL
943 * (pass-thru / UART switching, fast MIDI clock, etc.),
944 * however there doesn't seem to be an ALSA API for this...
947 if ((err = snd_als4000_pcm(chip, 0)) < 0) {
950 if ((err = snd_sbmixer_new(chip)) < 0) {
954 if (snd_opl3_create(card,
955 iobase + ALS4K_IOB_10_ADLIB_ADDR0,
956 iobase + ALS4K_IOB_12_ADLIB_ADDR2,
957 OPL3_HW_AUTO, 1, &opl3) < 0) {
958 printk(KERN_ERR "als4000: no OPL device at 0x%lx-0x%lx?\n",
959 iobase + ALS4K_IOB_10_ADLIB_ADDR0,
960 iobase + ALS4K_IOB_12_ADLIB_ADDR2);
962 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, NULL)) < 0) {
967 snd_als4000_create_gameport(acard, dev);
969 if ((err = snd_card_register(card)) < 0) {
972 pci_set_drvdata(pci, card);
984 static void __devexit snd_card_als4000_remove(struct pci_dev *pci)
986 snd_card_free(pci_get_drvdata(pci));
987 pci_set_drvdata(pci, NULL);
991 static int snd_als4000_suspend(struct pci_dev *pci, pm_message_t state)
993 struct snd_card *card = pci_get_drvdata(pci);
994 struct snd_card_als4000 *acard = card->private_data;
995 struct snd_sb *chip = acard->chip;
997 snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
999 snd_pcm_suspend_all(chip->pcm);
1000 snd_sbmixer_suspend(chip);
1002 pci_disable_device(pci);
1003 pci_save_state(pci);
1004 pci_set_power_state(pci, pci_choose_state(pci, state));
1008 static int snd_als4000_resume(struct pci_dev *pci)
1010 struct snd_card *card = pci_get_drvdata(pci);
1011 struct snd_card_als4000 *acard = card->private_data;
1012 struct snd_sb *chip = acard->chip;
1014 pci_set_power_state(pci, PCI_D0);
1015 pci_restore_state(pci);
1016 if (pci_enable_device(pci) < 0) {
1017 printk(KERN_ERR "als4000: pci_enable_device failed, "
1018 "disabling device\n");
1019 snd_card_disconnect(card);
1022 pci_set_master(pci);
1024 snd_als4000_configure(chip);
1025 snd_sbdsp_reset(chip);
1026 snd_sbmixer_resume(chip);
1028 #ifdef SUPPORT_JOYSTICK
1029 if (acard->gameport)
1030 snd_als4000_set_addr(acard->iobase, 0, 0, 0, 1);
1033 snd_power_change_state(card, SNDRV_CTL_POWER_D0);
1036 #endif /* CONFIG_PM */
1039 static struct pci_driver driver = {
1041 .id_table = snd_als4000_ids,
1042 .probe = snd_card_als4000_probe,
1043 .remove = __devexit_p(snd_card_als4000_remove),
1045 .suspend = snd_als4000_suspend,
1046 .resume = snd_als4000_resume,
1050 static int __init alsa_card_als4000_init(void)
1052 return pci_register_driver(&driver);
1055 static void __exit alsa_card_als4000_exit(void)
1057 pci_unregister_driver(&driver);
1060 module_init(alsa_card_als4000_init)
1061 module_exit(alsa_card_als4000_exit)