1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * als300.c - driver for Avance Logic ALS300/ALS300+ soundcards.
4 * Copyright (C) 2005 by Ash Willis <ashwillis@programmer.net>
7 * 4 channel playback for ALS300+
13 * The BLOCK_COUNTER registers for the ALS300(+) return a figure related to
14 * the position in the current period, NOT the whole buffer. It is important
15 * to know which period we are in so we can calculate the correct pointer.
16 * This is why we always use 2 periods. We can then use a flip-flop variable
17 * to keep track of what period we are in.
20 #include <linux/delay.h>
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/pci.h>
24 #include <linux/dma-mapping.h>
25 #include <linux/interrupt.h>
26 #include <linux/slab.h>
29 #include <sound/core.h>
30 #include <sound/control.h>
31 #include <sound/initval.h>
32 #include <sound/pcm.h>
33 #include <sound/pcm_params.h>
34 #include <sound/ac97_codec.h>
35 #include <sound/opl3.h>
37 /* snd_als300_set_irq_flag */
42 #define AC97_ACCESS 0x00
43 #define AC97_READ 0x04
44 #define AC97_STATUS 0x06
45 #define AC97_DATA_AVAIL (1<<6)
46 #define AC97_BUSY (1<<7)
47 #define ALS300_IRQ_STATUS 0x07 /* ALS300 Only */
48 #define IRQ_PLAYBACK (1<<3)
49 #define IRQ_CAPTURE (1<<2)
51 #define GCR_INDEX 0x0C
52 #define ALS300P_DRAM_IRQ_STATUS 0x0D /* ALS300+ Only */
53 #define MPU_IRQ_STATUS 0x0E /* ALS300 Rev. E+, ALS300+ */
54 #define ALS300P_IRQ_STATUS 0x0F /* ALS300+ Only */
56 /* General Control Registers */
57 #define PLAYBACK_START 0x80
58 #define PLAYBACK_END 0x81
59 #define PLAYBACK_CONTROL 0x82
60 #define TRANSFER_START (1<<16)
61 #define FIFO_PAUSE (1<<17)
62 #define RECORD_START 0x83
63 #define RECORD_END 0x84
64 #define RECORD_CONTROL 0x85
65 #define DRAM_WRITE_CONTROL 0x8B
66 #define WRITE_TRANS_START (1<<16)
67 #define DRAM_MODE_2 (1<<17)
68 #define MISC_CONTROL 0x8C
69 #define IRQ_SET_BIT (1<<15)
70 #define VMUTE_NORMAL (1<<20)
71 #define MMUTE_NORMAL (1<<21)
72 #define MUS_VOC_VOL 0x8E
73 #define PLAYBACK_BLOCK_COUNTER 0x9A
74 #define RECORD_BLOCK_COUNTER 0x9B
76 #define DEBUG_PLAY_REC 0
79 #define snd_als300_dbgplay(format, args...) printk(KERN_ERR format, ##args)
81 #define snd_als300_dbgplay(format, args...)
84 enum {DEVICE_ALS300, DEVICE_ALS300_PLUS};
86 MODULE_AUTHOR("Ash Willis <ashwillis@programmer.net>");
87 MODULE_DESCRIPTION("Avance Logic ALS300");
88 MODULE_LICENSE("GPL");
90 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
91 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
92 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
94 module_param_array(index, int, NULL, 0444);
95 MODULE_PARM_DESC(index, "Index value for ALS300 sound card.");
96 module_param_array(id, charp, NULL, 0444);
97 MODULE_PARM_DESC(id, "ID string for ALS300 sound card.");
98 module_param_array(enable, bool, NULL, 0444);
99 MODULE_PARM_DESC(enable, "Enable ALS300 sound card.");
104 struct snd_card *card;
108 struct snd_pcm_substream *playback_substream;
109 struct snd_pcm_substream *capture_substream;
111 struct snd_ac97 *ac97;
112 struct snd_opl3 *opl3;
114 struct resource *res_port;
118 int chip_type; /* ALS300 or ALS300+ */
123 struct snd_als300_substream_data {
125 int control_register;
126 int block_counter_register;
129 static const struct pci_device_id snd_als300_ids[] = {
130 { 0x4005, 0x0300, PCI_ANY_ID, PCI_ANY_ID, 0, 0, DEVICE_ALS300 },
131 { 0x4005, 0x0308, PCI_ANY_ID, PCI_ANY_ID, 0, 0, DEVICE_ALS300_PLUS },
135 MODULE_DEVICE_TABLE(pci, snd_als300_ids);
137 static inline u32 snd_als300_gcr_read(unsigned long port, unsigned short reg)
139 outb(reg, port+GCR_INDEX);
140 return inl(port+GCR_DATA);
143 static inline void snd_als300_gcr_write(unsigned long port,
144 unsigned short reg, u32 val)
146 outb(reg, port+GCR_INDEX);
147 outl(val, port+GCR_DATA);
150 /* Enable/Disable Interrupts */
151 static void snd_als300_set_irq_flag(struct snd_als300 *chip, int cmd)
153 u32 tmp = snd_als300_gcr_read(chip->port, MISC_CONTROL);
155 /* boolean XOR check, since old vs. new hardware have
156 directly reversed bit setting for ENABLE and DISABLE.
157 ALS300+ acts like newer versions of ALS300 */
158 if (((chip->revision > 5 || chip->chip_type == DEVICE_ALS300_PLUS) ^
159 (cmd == IRQ_ENABLE)) == 0)
163 snd_als300_gcr_write(chip->port, MISC_CONTROL, tmp);
166 static void snd_als300_free(struct snd_card *card)
168 struct snd_als300 *chip = card->private_data;
170 snd_als300_set_irq_flag(chip, IRQ_DISABLE);
173 static irqreturn_t snd_als300_interrupt(int irq, void *dev_id)
176 struct snd_als300 *chip = dev_id;
177 struct snd_als300_substream_data *data;
179 status = inb(chip->port+ALS300_IRQ_STATUS);
180 if (!status) /* shared IRQ, for different device?? Exit ASAP! */
183 /* ACK everything ASAP */
184 outb(status, chip->port+ALS300_IRQ_STATUS);
185 if (status & IRQ_PLAYBACK) {
186 if (chip->pcm && chip->playback_substream) {
187 data = chip->playback_substream->runtime->private_data;
188 data->period_flipflop ^= 1;
189 snd_pcm_period_elapsed(chip->playback_substream);
190 snd_als300_dbgplay("IRQ_PLAYBACK\n");
193 if (status & IRQ_CAPTURE) {
194 if (chip->pcm && chip->capture_substream) {
195 data = chip->capture_substream->runtime->private_data;
196 data->period_flipflop ^= 1;
197 snd_pcm_period_elapsed(chip->capture_substream);
198 snd_als300_dbgplay("IRQ_CAPTURE\n");
204 static irqreturn_t snd_als300plus_interrupt(int irq, void *dev_id)
206 u8 general, mpu, dram;
207 struct snd_als300 *chip = dev_id;
208 struct snd_als300_substream_data *data;
210 general = inb(chip->port+ALS300P_IRQ_STATUS);
211 mpu = inb(chip->port+MPU_IRQ_STATUS);
212 dram = inb(chip->port+ALS300P_DRAM_IRQ_STATUS);
214 /* shared IRQ, for different device?? Exit ASAP! */
215 if ((general == 0) && ((mpu & 0x80) == 0) && ((dram & 0x01) == 0))
218 if (general & IRQ_PLAYBACK) {
219 if (chip->pcm && chip->playback_substream) {
220 outb(IRQ_PLAYBACK, chip->port+ALS300P_IRQ_STATUS);
221 data = chip->playback_substream->runtime->private_data;
222 data->period_flipflop ^= 1;
223 snd_pcm_period_elapsed(chip->playback_substream);
224 snd_als300_dbgplay("IRQ_PLAYBACK\n");
227 if (general & IRQ_CAPTURE) {
228 if (chip->pcm && chip->capture_substream) {
229 outb(IRQ_CAPTURE, chip->port+ALS300P_IRQ_STATUS);
230 data = chip->capture_substream->runtime->private_data;
231 data->period_flipflop ^= 1;
232 snd_pcm_period_elapsed(chip->capture_substream);
233 snd_als300_dbgplay("IRQ_CAPTURE\n");
236 /* FIXME: Ack other interrupt types. Not important right now as
237 * those other devices aren't enabled. */
241 static unsigned short snd_als300_ac97_read(struct snd_ac97 *ac97,
245 struct snd_als300 *chip = ac97->private_data;
247 for (i = 0; i < 1000; i++) {
248 if ((inb(chip->port+AC97_STATUS) & (AC97_BUSY)) == 0)
252 outl((reg << 24) | (1 << 31), chip->port+AC97_ACCESS);
254 for (i = 0; i < 1000; i++) {
255 if ((inb(chip->port+AC97_STATUS) & (AC97_DATA_AVAIL)) != 0)
259 return inw(chip->port+AC97_READ);
262 static void snd_als300_ac97_write(struct snd_ac97 *ac97,
263 unsigned short reg, unsigned short val)
266 struct snd_als300 *chip = ac97->private_data;
268 for (i = 0; i < 1000; i++) {
269 if ((inb(chip->port+AC97_STATUS) & (AC97_BUSY)) == 0)
273 outl((reg << 24) | val, chip->port+AC97_ACCESS);
276 static int snd_als300_ac97(struct snd_als300 *chip)
278 struct snd_ac97_bus *bus;
279 struct snd_ac97_template ac97;
281 static const struct snd_ac97_bus_ops ops = {
282 .write = snd_als300_ac97_write,
283 .read = snd_als300_ac97_read,
286 err = snd_ac97_bus(chip->card, 0, &ops, NULL, &bus);
290 memset(&ac97, 0, sizeof(ac97));
291 ac97.private_data = chip;
293 return snd_ac97_mixer(bus, &ac97, &chip->ac97);
296 /* hardware definition
298 * In AC97 mode, we always use 48k/16bit/stereo.
299 * Any request to change data type is ignored by
300 * the card when it is running outside of legacy
303 static const struct snd_pcm_hardware snd_als300_playback_hw =
305 .info = (SNDRV_PCM_INFO_MMAP |
306 SNDRV_PCM_INFO_INTERLEAVED |
307 SNDRV_PCM_INFO_PAUSE |
308 SNDRV_PCM_INFO_MMAP_VALID),
309 .formats = SNDRV_PCM_FMTBIT_S16,
310 .rates = SNDRV_PCM_RATE_48000,
315 .buffer_bytes_max = 64 * 1024,
316 .period_bytes_min = 64,
317 .period_bytes_max = 32 * 1024,
322 static const struct snd_pcm_hardware snd_als300_capture_hw =
324 .info = (SNDRV_PCM_INFO_MMAP |
325 SNDRV_PCM_INFO_INTERLEAVED |
326 SNDRV_PCM_INFO_PAUSE |
327 SNDRV_PCM_INFO_MMAP_VALID),
328 .formats = SNDRV_PCM_FMTBIT_S16,
329 .rates = SNDRV_PCM_RATE_48000,
334 .buffer_bytes_max = 64 * 1024,
335 .period_bytes_min = 64,
336 .period_bytes_max = 32 * 1024,
341 static int snd_als300_playback_open(struct snd_pcm_substream *substream)
343 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
344 struct snd_pcm_runtime *runtime = substream->runtime;
345 struct snd_als300_substream_data *data = kzalloc(sizeof(*data),
350 chip->playback_substream = substream;
351 runtime->hw = snd_als300_playback_hw;
352 runtime->private_data = data;
353 data->control_register = PLAYBACK_CONTROL;
354 data->block_counter_register = PLAYBACK_BLOCK_COUNTER;
358 static int snd_als300_playback_close(struct snd_pcm_substream *substream)
360 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
361 struct snd_als300_substream_data *data;
363 data = substream->runtime->private_data;
365 chip->playback_substream = NULL;
369 static int snd_als300_capture_open(struct snd_pcm_substream *substream)
371 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
372 struct snd_pcm_runtime *runtime = substream->runtime;
373 struct snd_als300_substream_data *data = kzalloc(sizeof(*data),
378 chip->capture_substream = substream;
379 runtime->hw = snd_als300_capture_hw;
380 runtime->private_data = data;
381 data->control_register = RECORD_CONTROL;
382 data->block_counter_register = RECORD_BLOCK_COUNTER;
386 static int snd_als300_capture_close(struct snd_pcm_substream *substream)
388 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
389 struct snd_als300_substream_data *data;
391 data = substream->runtime->private_data;
393 chip->capture_substream = NULL;
397 static int snd_als300_playback_prepare(struct snd_pcm_substream *substream)
400 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
401 struct snd_pcm_runtime *runtime = substream->runtime;
402 unsigned short period_bytes = snd_pcm_lib_period_bytes(substream);
403 unsigned short buffer_bytes = snd_pcm_lib_buffer_bytes(substream);
405 spin_lock_irq(&chip->reg_lock);
406 tmp = snd_als300_gcr_read(chip->port, PLAYBACK_CONTROL);
407 tmp &= ~TRANSFER_START;
409 snd_als300_dbgplay("Period bytes: %d Buffer bytes %d\n",
410 period_bytes, buffer_bytes);
414 tmp |= period_bytes - 1;
415 snd_als300_gcr_write(chip->port, PLAYBACK_CONTROL, tmp);
418 snd_als300_gcr_write(chip->port, PLAYBACK_START,
420 snd_als300_gcr_write(chip->port, PLAYBACK_END,
421 runtime->dma_addr + buffer_bytes - 1);
422 spin_unlock_irq(&chip->reg_lock);
426 static int snd_als300_capture_prepare(struct snd_pcm_substream *substream)
429 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
430 struct snd_pcm_runtime *runtime = substream->runtime;
431 unsigned short period_bytes = snd_pcm_lib_period_bytes(substream);
432 unsigned short buffer_bytes = snd_pcm_lib_buffer_bytes(substream);
434 spin_lock_irq(&chip->reg_lock);
435 tmp = snd_als300_gcr_read(chip->port, RECORD_CONTROL);
436 tmp &= ~TRANSFER_START;
438 snd_als300_dbgplay("Period bytes: %d Buffer bytes %d\n", period_bytes,
443 tmp |= period_bytes - 1;
446 snd_als300_gcr_write(chip->port, RECORD_CONTROL, tmp);
447 snd_als300_gcr_write(chip->port, RECORD_START,
449 snd_als300_gcr_write(chip->port, RECORD_END,
450 runtime->dma_addr + buffer_bytes - 1);
451 spin_unlock_irq(&chip->reg_lock);
455 static int snd_als300_trigger(struct snd_pcm_substream *substream, int cmd)
457 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
459 struct snd_als300_substream_data *data;
463 data = substream->runtime->private_data;
464 reg = data->control_register;
466 spin_lock(&chip->reg_lock);
468 case SNDRV_PCM_TRIGGER_START:
469 case SNDRV_PCM_TRIGGER_RESUME:
470 tmp = snd_als300_gcr_read(chip->port, reg);
471 data->period_flipflop = 1;
472 snd_als300_gcr_write(chip->port, reg, tmp | TRANSFER_START);
473 snd_als300_dbgplay("TRIGGER START\n");
475 case SNDRV_PCM_TRIGGER_STOP:
476 case SNDRV_PCM_TRIGGER_SUSPEND:
477 tmp = snd_als300_gcr_read(chip->port, reg);
478 snd_als300_gcr_write(chip->port, reg, tmp & ~TRANSFER_START);
479 snd_als300_dbgplay("TRIGGER STOP\n");
481 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
482 tmp = snd_als300_gcr_read(chip->port, reg);
483 snd_als300_gcr_write(chip->port, reg, tmp | FIFO_PAUSE);
484 snd_als300_dbgplay("TRIGGER PAUSE\n");
486 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
487 tmp = snd_als300_gcr_read(chip->port, reg);
488 snd_als300_gcr_write(chip->port, reg, tmp & ~FIFO_PAUSE);
489 snd_als300_dbgplay("TRIGGER RELEASE\n");
492 snd_als300_dbgplay("TRIGGER INVALID\n");
495 spin_unlock(&chip->reg_lock);
499 static snd_pcm_uframes_t snd_als300_pointer(struct snd_pcm_substream *substream)
502 struct snd_als300 *chip = snd_pcm_substream_chip(substream);
503 struct snd_als300_substream_data *data;
504 unsigned short period_bytes;
506 data = substream->runtime->private_data;
507 period_bytes = snd_pcm_lib_period_bytes(substream);
509 spin_lock(&chip->reg_lock);
510 current_ptr = (u16) snd_als300_gcr_read(chip->port,
511 data->block_counter_register) + 4;
512 spin_unlock(&chip->reg_lock);
513 if (current_ptr > period_bytes)
516 current_ptr = period_bytes - current_ptr;
518 if (data->period_flipflop == 0)
519 current_ptr += period_bytes;
520 snd_als300_dbgplay("Pointer (bytes): %d\n", current_ptr);
521 return bytes_to_frames(substream->runtime, current_ptr);
524 static const struct snd_pcm_ops snd_als300_playback_ops = {
525 .open = snd_als300_playback_open,
526 .close = snd_als300_playback_close,
527 .prepare = snd_als300_playback_prepare,
528 .trigger = snd_als300_trigger,
529 .pointer = snd_als300_pointer,
532 static const struct snd_pcm_ops snd_als300_capture_ops = {
533 .open = snd_als300_capture_open,
534 .close = snd_als300_capture_close,
535 .prepare = snd_als300_capture_prepare,
536 .trigger = snd_als300_trigger,
537 .pointer = snd_als300_pointer,
540 static int snd_als300_new_pcm(struct snd_als300 *chip)
545 err = snd_pcm_new(chip->card, "ALS300", 0, 1, 1, &pcm);
548 pcm->private_data = chip;
549 strcpy(pcm->name, "ALS300");
553 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
554 &snd_als300_playback_ops);
555 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE,
556 &snd_als300_capture_ops);
558 /* pre-allocation of buffers */
559 snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV, &chip->pci->dev,
564 static void snd_als300_init(struct snd_als300 *chip)
569 spin_lock_irqsave(&chip->reg_lock, flags);
570 chip->revision = (snd_als300_gcr_read(chip->port, MISC_CONTROL) >> 16)
573 tmp = snd_als300_gcr_read(chip->port, DRAM_WRITE_CONTROL);
574 snd_als300_gcr_write(chip->port, DRAM_WRITE_CONTROL,
576 & ~WRITE_TRANS_START);
578 /* Enable IRQ output */
579 snd_als300_set_irq_flag(chip, IRQ_ENABLE);
581 /* Unmute hardware devices so their outputs get routed to
582 * the onboard mixer */
583 tmp = snd_als300_gcr_read(chip->port, MISC_CONTROL);
584 snd_als300_gcr_write(chip->port, MISC_CONTROL,
585 tmp | VMUTE_NORMAL | MMUTE_NORMAL);
588 snd_als300_gcr_write(chip->port, MUS_VOC_VOL, 0);
590 /* Make sure playback transfer is stopped */
591 tmp = snd_als300_gcr_read(chip->port, PLAYBACK_CONTROL);
592 snd_als300_gcr_write(chip->port, PLAYBACK_CONTROL,
593 tmp & ~TRANSFER_START);
594 spin_unlock_irqrestore(&chip->reg_lock, flags);
597 static int snd_als300_create(struct snd_card *card,
598 struct pci_dev *pci, int chip_type)
600 struct snd_als300 *chip = card->private_data;
604 err = pcim_enable_device(pci);
608 if (dma_set_mask_and_coherent(&pci->dev, DMA_BIT_MASK(28))) {
609 dev_err(card->dev, "error setting 28bit DMA mask\n");
617 chip->chip_type = chip_type;
618 spin_lock_init(&chip->reg_lock);
620 err = pci_request_regions(pci, "ALS300");
624 chip->port = pci_resource_start(pci, 0);
626 if (chip->chip_type == DEVICE_ALS300_PLUS)
627 irq_handler = snd_als300plus_interrupt;
629 irq_handler = snd_als300_interrupt;
631 if (devm_request_irq(&pci->dev, pci->irq, irq_handler, IRQF_SHARED,
632 KBUILD_MODNAME, chip)) {
633 dev_err(card->dev, "unable to grab IRQ %d\n", pci->irq);
636 chip->irq = pci->irq;
637 card->sync_irq = chip->irq;
638 card->private_free = snd_als300_free;
640 snd_als300_init(chip);
642 err = snd_als300_ac97(chip);
644 dev_err(card->dev, "Could not create ac97\n");
648 err = snd_als300_new_pcm(chip);
650 dev_err(card->dev, "Could not create PCM\n");
657 #ifdef CONFIG_PM_SLEEP
658 static int snd_als300_suspend(struct device *dev)
660 struct snd_card *card = dev_get_drvdata(dev);
661 struct snd_als300 *chip = card->private_data;
663 snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
664 snd_ac97_suspend(chip->ac97);
668 static int snd_als300_resume(struct device *dev)
670 struct snd_card *card = dev_get_drvdata(dev);
671 struct snd_als300 *chip = card->private_data;
673 snd_als300_init(chip);
674 snd_ac97_resume(chip->ac97);
676 snd_power_change_state(card, SNDRV_CTL_POWER_D0);
680 static SIMPLE_DEV_PM_OPS(snd_als300_pm, snd_als300_suspend, snd_als300_resume);
681 #define SND_ALS300_PM_OPS &snd_als300_pm
683 #define SND_ALS300_PM_OPS NULL
686 static int snd_als300_probe(struct pci_dev *pci,
687 const struct pci_device_id *pci_id)
690 struct snd_card *card;
691 struct snd_als300 *chip;
694 if (dev >= SNDRV_CARDS)
701 err = snd_devm_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
702 sizeof(*chip), &card);
705 chip = card->private_data;
707 chip_type = pci_id->driver_data;
709 err = snd_als300_create(card, pci, chip_type);
713 strcpy(card->driver, "ALS300");
714 if (chip->chip_type == DEVICE_ALS300_PLUS)
715 /* don't know much about ALS300+ yet
716 * print revision number for now */
717 sprintf(card->shortname, "ALS300+ (Rev. %d)", chip->revision);
719 sprintf(card->shortname, "ALS300 (Rev. %c)", 'A' +
721 sprintf(card->longname, "%s at 0x%lx irq %i",
722 card->shortname, chip->port, chip->irq);
724 err = snd_card_register(card);
728 pci_set_drvdata(pci, card);
733 static struct pci_driver als300_driver = {
734 .name = KBUILD_MODNAME,
735 .id_table = snd_als300_ids,
736 .probe = snd_als300_probe,
738 .pm = SND_ALS300_PM_OPS,
742 module_pci_driver(als300_driver);