1 /*****************************************************************************
3 * Copyright (C) 2008 Cedric Bregardis <cedric.bregardis@free.fr> and
4 * Jean-Christian Hassler <jhassler@free.fr>
6 * This file is part of the Audiowerk2 ALSA driver
8 * The Audiowerk2 ALSA driver is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2.
12 * The Audiowerk2 ALSA driver is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with the Audiowerk2 ALSA driver; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 *****************************************************************************/
23 #include <linux/init.h>
24 #include <linux/pci.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/slab.h>
27 #include <linux/interrupt.h>
28 #include <linux/delay.h>
30 #include <linux/module.h>
31 #include <sound/core.h>
32 #include <sound/initval.h>
33 #include <sound/pcm.h>
34 #include <sound/pcm_params.h>
35 #include <sound/control.h>
38 #include "aw2-saa7146.h"
40 MODULE_AUTHOR("Cedric Bregardis <cedric.bregardis@free.fr>, "
41 "Jean-Christian Hassler <jhassler@free.fr>");
42 MODULE_DESCRIPTION("Emagic Audiowerk 2 sound driver");
43 MODULE_LICENSE("GPL");
45 /*********************************
47 ********************************/
48 #define CTL_ROUTE_ANALOG 0
49 #define CTL_ROUTE_DIGITAL 1
51 /*********************************
53 ********************************/
54 /* hardware definition */
55 static struct snd_pcm_hardware snd_aw2_playback_hw = {
56 .info = (SNDRV_PCM_INFO_MMAP |
57 SNDRV_PCM_INFO_INTERLEAVED |
58 SNDRV_PCM_INFO_BLOCK_TRANSFER | SNDRV_PCM_INFO_MMAP_VALID),
59 .formats = SNDRV_PCM_FMTBIT_S16_LE,
60 .rates = SNDRV_PCM_RATE_44100,
65 .buffer_bytes_max = 32768,
66 .period_bytes_min = 4096,
67 .period_bytes_max = 32768,
72 static struct snd_pcm_hardware snd_aw2_capture_hw = {
73 .info = (SNDRV_PCM_INFO_MMAP |
74 SNDRV_PCM_INFO_INTERLEAVED |
75 SNDRV_PCM_INFO_BLOCK_TRANSFER | SNDRV_PCM_INFO_MMAP_VALID),
76 .formats = SNDRV_PCM_FMTBIT_S16_LE,
77 .rates = SNDRV_PCM_RATE_44100,
82 .buffer_bytes_max = 32768,
83 .period_bytes_min = 4096,
84 .period_bytes_max = 32768,
89 struct aw2_pcm_device {
91 unsigned int stream_number;
96 struct snd_aw2_saa7146 saa7146;
103 unsigned long iobase_phys;
104 void __iomem *iobase_virt;
106 struct snd_card *card;
108 struct aw2_pcm_device device_playback[NB_STREAM_PLAYBACK];
109 struct aw2_pcm_device device_capture[NB_STREAM_CAPTURE];
112 /*********************************
113 * FUNCTION DECLARATIONS
114 ********************************/
115 static int snd_aw2_dev_free(struct snd_device *device);
116 static int snd_aw2_create(struct snd_card *card,
117 struct pci_dev *pci, struct aw2 **rchip);
118 static int snd_aw2_probe(struct pci_dev *pci,
119 const struct pci_device_id *pci_id);
120 static void snd_aw2_remove(struct pci_dev *pci);
121 static int snd_aw2_pcm_playback_open(struct snd_pcm_substream *substream);
122 static int snd_aw2_pcm_playback_close(struct snd_pcm_substream *substream);
123 static int snd_aw2_pcm_capture_open(struct snd_pcm_substream *substream);
124 static int snd_aw2_pcm_capture_close(struct snd_pcm_substream *substream);
125 static int snd_aw2_pcm_hw_params(struct snd_pcm_substream *substream,
126 struct snd_pcm_hw_params *hw_params);
127 static int snd_aw2_pcm_hw_free(struct snd_pcm_substream *substream);
128 static int snd_aw2_pcm_prepare_playback(struct snd_pcm_substream *substream);
129 static int snd_aw2_pcm_prepare_capture(struct snd_pcm_substream *substream);
130 static int snd_aw2_pcm_trigger_playback(struct snd_pcm_substream *substream,
132 static int snd_aw2_pcm_trigger_capture(struct snd_pcm_substream *substream,
134 static snd_pcm_uframes_t snd_aw2_pcm_pointer_playback(struct snd_pcm_substream
136 static snd_pcm_uframes_t snd_aw2_pcm_pointer_capture(struct snd_pcm_substream
138 static int snd_aw2_new_pcm(struct aw2 *chip);
140 static int snd_aw2_control_switch_capture_info(struct snd_kcontrol *kcontrol,
141 struct snd_ctl_elem_info *uinfo);
142 static int snd_aw2_control_switch_capture_get(struct snd_kcontrol *kcontrol,
143 struct snd_ctl_elem_value
145 static int snd_aw2_control_switch_capture_put(struct snd_kcontrol *kcontrol,
146 struct snd_ctl_elem_value
149 /*********************************
151 ********************************/
152 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
153 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
154 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
156 module_param_array(index, int, NULL, 0444);
157 MODULE_PARM_DESC(index, "Index value for Audiowerk2 soundcard.");
158 module_param_array(id, charp, NULL, 0444);
159 MODULE_PARM_DESC(id, "ID string for the Audiowerk2 soundcard.");
160 module_param_array(enable, bool, NULL, 0444);
161 MODULE_PARM_DESC(enable, "Enable Audiowerk2 soundcard.");
163 static DEFINE_PCI_DEVICE_TABLE(snd_aw2_ids) = {
164 {PCI_VENDOR_ID_PHILIPS, PCI_DEVICE_ID_PHILIPS_SAA7146, 0, 0,
169 MODULE_DEVICE_TABLE(pci, snd_aw2_ids);
171 /* pci_driver definition */
172 static struct pci_driver aw2_driver = {
173 .name = KBUILD_MODNAME,
174 .id_table = snd_aw2_ids,
175 .probe = snd_aw2_probe,
176 .remove = snd_aw2_remove,
179 module_pci_driver(aw2_driver);
181 /* operators for playback PCM alsa interface */
182 static struct snd_pcm_ops snd_aw2_playback_ops = {
183 .open = snd_aw2_pcm_playback_open,
184 .close = snd_aw2_pcm_playback_close,
185 .ioctl = snd_pcm_lib_ioctl,
186 .hw_params = snd_aw2_pcm_hw_params,
187 .hw_free = snd_aw2_pcm_hw_free,
188 .prepare = snd_aw2_pcm_prepare_playback,
189 .trigger = snd_aw2_pcm_trigger_playback,
190 .pointer = snd_aw2_pcm_pointer_playback,
193 /* operators for capture PCM alsa interface */
194 static struct snd_pcm_ops snd_aw2_capture_ops = {
195 .open = snd_aw2_pcm_capture_open,
196 .close = snd_aw2_pcm_capture_close,
197 .ioctl = snd_pcm_lib_ioctl,
198 .hw_params = snd_aw2_pcm_hw_params,
199 .hw_free = snd_aw2_pcm_hw_free,
200 .prepare = snd_aw2_pcm_prepare_capture,
201 .trigger = snd_aw2_pcm_trigger_capture,
202 .pointer = snd_aw2_pcm_pointer_capture,
205 static struct snd_kcontrol_new aw2_control = {
206 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
207 .name = "PCM Capture Route",
209 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
210 .private_value = 0xffff,
211 .info = snd_aw2_control_switch_capture_info,
212 .get = snd_aw2_control_switch_capture_get,
213 .put = snd_aw2_control_switch_capture_put
216 /*********************************
217 * FUNCTION IMPLEMENTATIONS
218 ********************************/
220 /* component-destructor */
221 static int snd_aw2_dev_free(struct snd_device *device)
223 struct aw2 *chip = device->device_data;
226 snd_aw2_saa7146_free(&chip->saa7146);
228 /* release the irq */
230 free_irq(chip->irq, (void *)chip);
231 /* release the i/o ports & memory */
232 if (chip->iobase_virt)
233 iounmap(chip->iobase_virt);
235 pci_release_regions(chip->pci);
236 /* disable the PCI entry */
237 pci_disable_device(chip->pci);
238 /* release the data */
244 /* chip-specific constructor */
245 static int snd_aw2_create(struct snd_card *card,
246 struct pci_dev *pci, struct aw2 **rchip)
250 static struct snd_device_ops ops = {
251 .dev_free = snd_aw2_dev_free,
256 /* initialize the PCI entry */
257 err = pci_enable_device(pci);
262 /* check PCI availability (32bit DMA) */
263 if ((pci_set_dma_mask(pci, DMA_BIT_MASK(32)) < 0) ||
264 (pci_set_consistent_dma_mask(pci, DMA_BIT_MASK(32)) < 0)) {
265 printk(KERN_ERR "aw2: Impossible to set 32bit mask DMA\n");
266 pci_disable_device(pci);
269 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
271 pci_disable_device(pci);
275 /* initialize the stuff */
280 /* (1) PCI resource allocation */
281 err = pci_request_regions(pci, "Audiowerk2");
283 pci_disable_device(pci);
287 chip->iobase_phys = pci_resource_start(pci, 0);
289 ioremap_nocache(chip->iobase_phys,
290 pci_resource_len(pci, 0));
292 if (chip->iobase_virt == NULL) {
293 printk(KERN_ERR "aw2: unable to remap memory region");
294 pci_release_regions(pci);
295 pci_disable_device(pci);
300 /* (2) initialization of the chip hardware */
301 snd_aw2_saa7146_setup(&chip->saa7146, chip->iobase_virt);
303 if (request_irq(pci->irq, snd_aw2_saa7146_interrupt,
304 IRQF_SHARED, KBUILD_MODNAME, chip)) {
305 printk(KERN_ERR "aw2: Cannot grab irq %d\n", pci->irq);
307 iounmap(chip->iobase_virt);
308 pci_release_regions(chip->pci);
309 pci_disable_device(chip->pci);
313 chip->irq = pci->irq;
315 err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
317 free_irq(chip->irq, (void *)chip);
318 iounmap(chip->iobase_virt);
319 pci_release_regions(chip->pci);
320 pci_disable_device(chip->pci);
325 snd_card_set_dev(card, &pci->dev);
329 "Audiowerk 2 sound card (saa7146 chipset) detected and "
335 static int snd_aw2_probe(struct pci_dev *pci,
336 const struct pci_device_id *pci_id)
339 struct snd_card *card;
343 /* (1) Continue if device is not enabled, else inc dev */
344 if (dev >= SNDRV_CARDS)
351 /* (2) Create card instance */
352 err = snd_card_create(index[dev], id[dev], THIS_MODULE, 0, &card);
356 /* (3) Create main component */
357 err = snd_aw2_create(card, pci, &chip);
363 /* initialize mutex */
364 mutex_init(&chip->mtx);
366 spin_lock_init(&chip->reg_lock);
367 /* (4) Define driver ID and name string */
368 strcpy(card->driver, "aw2");
369 strcpy(card->shortname, "Audiowerk2");
371 sprintf(card->longname, "%s with SAA7146 irq %i",
372 card->shortname, chip->irq);
374 /* (5) Create other components */
375 snd_aw2_new_pcm(chip);
377 /* (6) Register card instance */
378 err = snd_card_register(card);
384 /* (7) Set PCI driver data */
385 pci_set_drvdata(pci, card);
392 static void snd_aw2_remove(struct pci_dev *pci)
394 snd_card_free(pci_get_drvdata(pci));
398 static int snd_aw2_pcm_playback_open(struct snd_pcm_substream *substream)
400 struct snd_pcm_runtime *runtime = substream->runtime;
402 snd_printdd(KERN_DEBUG "aw2: Playback_open\n");
403 runtime->hw = snd_aw2_playback_hw;
408 static int snd_aw2_pcm_playback_close(struct snd_pcm_substream *substream)
414 static int snd_aw2_pcm_capture_open(struct snd_pcm_substream *substream)
416 struct snd_pcm_runtime *runtime = substream->runtime;
418 snd_printdd(KERN_DEBUG "aw2: Capture_open\n");
419 runtime->hw = snd_aw2_capture_hw;
424 static int snd_aw2_pcm_capture_close(struct snd_pcm_substream *substream)
426 /* TODO: something to do ? */
430 /* hw_params callback */
431 static int snd_aw2_pcm_hw_params(struct snd_pcm_substream *substream,
432 struct snd_pcm_hw_params *hw_params)
434 return snd_pcm_lib_malloc_pages(substream,
435 params_buffer_bytes(hw_params));
438 /* hw_free callback */
439 static int snd_aw2_pcm_hw_free(struct snd_pcm_substream *substream)
441 return snd_pcm_lib_free_pages(substream);
444 /* prepare callback for playback */
445 static int snd_aw2_pcm_prepare_playback(struct snd_pcm_substream *substream)
447 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
448 struct aw2 *chip = pcm_device->chip;
449 struct snd_pcm_runtime *runtime = substream->runtime;
450 unsigned long period_size, buffer_size;
452 mutex_lock(&chip->mtx);
454 period_size = snd_pcm_lib_period_bytes(substream);
455 buffer_size = snd_pcm_lib_buffer_bytes(substream);
457 snd_aw2_saa7146_pcm_init_playback(&chip->saa7146,
458 pcm_device->stream_number,
459 runtime->dma_addr, period_size,
462 /* Define Interrupt callback */
463 snd_aw2_saa7146_define_it_playback_callback(pcm_device->stream_number,
464 (snd_aw2_saa7146_it_cb)
465 snd_pcm_period_elapsed,
468 mutex_unlock(&chip->mtx);
473 /* prepare callback for capture */
474 static int snd_aw2_pcm_prepare_capture(struct snd_pcm_substream *substream)
476 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
477 struct aw2 *chip = pcm_device->chip;
478 struct snd_pcm_runtime *runtime = substream->runtime;
479 unsigned long period_size, buffer_size;
481 mutex_lock(&chip->mtx);
483 period_size = snd_pcm_lib_period_bytes(substream);
484 buffer_size = snd_pcm_lib_buffer_bytes(substream);
486 snd_aw2_saa7146_pcm_init_capture(&chip->saa7146,
487 pcm_device->stream_number,
488 runtime->dma_addr, period_size,
491 /* Define Interrupt callback */
492 snd_aw2_saa7146_define_it_capture_callback(pcm_device->stream_number,
493 (snd_aw2_saa7146_it_cb)
494 snd_pcm_period_elapsed,
497 mutex_unlock(&chip->mtx);
502 /* playback trigger callback */
503 static int snd_aw2_pcm_trigger_playback(struct snd_pcm_substream *substream,
507 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
508 struct aw2 *chip = pcm_device->chip;
509 spin_lock(&chip->reg_lock);
511 case SNDRV_PCM_TRIGGER_START:
512 snd_aw2_saa7146_pcm_trigger_start_playback(&chip->saa7146,
516 case SNDRV_PCM_TRIGGER_STOP:
517 snd_aw2_saa7146_pcm_trigger_stop_playback(&chip->saa7146,
524 spin_unlock(&chip->reg_lock);
528 /* capture trigger callback */
529 static int snd_aw2_pcm_trigger_capture(struct snd_pcm_substream *substream,
533 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
534 struct aw2 *chip = pcm_device->chip;
535 spin_lock(&chip->reg_lock);
537 case SNDRV_PCM_TRIGGER_START:
538 snd_aw2_saa7146_pcm_trigger_start_capture(&chip->saa7146,
542 case SNDRV_PCM_TRIGGER_STOP:
543 snd_aw2_saa7146_pcm_trigger_stop_capture(&chip->saa7146,
550 spin_unlock(&chip->reg_lock);
554 /* playback pointer callback */
555 static snd_pcm_uframes_t snd_aw2_pcm_pointer_playback(struct snd_pcm_substream
558 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
559 struct aw2 *chip = pcm_device->chip;
560 unsigned int current_ptr;
562 /* get the current hardware pointer */
563 struct snd_pcm_runtime *runtime = substream->runtime;
565 snd_aw2_saa7146_get_hw_ptr_playback(&chip->saa7146,
566 pcm_device->stream_number,
568 runtime->buffer_size);
570 return bytes_to_frames(substream->runtime, current_ptr);
573 /* capture pointer callback */
574 static snd_pcm_uframes_t snd_aw2_pcm_pointer_capture(struct snd_pcm_substream
577 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
578 struct aw2 *chip = pcm_device->chip;
579 unsigned int current_ptr;
581 /* get the current hardware pointer */
582 struct snd_pcm_runtime *runtime = substream->runtime;
584 snd_aw2_saa7146_get_hw_ptr_capture(&chip->saa7146,
585 pcm_device->stream_number,
587 runtime->buffer_size);
589 return bytes_to_frames(substream->runtime, current_ptr);
592 /* create a pcm device */
593 static int snd_aw2_new_pcm(struct aw2 *chip)
595 struct snd_pcm *pcm_playback_ana;
596 struct snd_pcm *pcm_playback_num;
597 struct snd_pcm *pcm_capture;
598 struct aw2_pcm_device *pcm_device;
601 /* Create new Alsa PCM device */
603 err = snd_pcm_new(chip->card, "Audiowerk2 analog playback", 0, 1, 0,
606 printk(KERN_ERR "aw2: snd_pcm_new error (0x%X)\n", err);
611 pcm_device = &chip->device_playback[NUM_STREAM_PLAYBACK_ANA];
613 /* Set PCM device name */
614 strcpy(pcm_playback_ana->name, "Analog playback");
615 /* Associate private data to PCM device */
616 pcm_playback_ana->private_data = pcm_device;
617 /* set operators of PCM device */
618 snd_pcm_set_ops(pcm_playback_ana, SNDRV_PCM_STREAM_PLAYBACK,
619 &snd_aw2_playback_ops);
620 /* store PCM device */
621 pcm_device->pcm = pcm_playback_ana;
622 /* give base chip pointer to our internal pcm device
624 pcm_device->chip = chip;
625 /* Give stream number to PCM device */
626 pcm_device->stream_number = NUM_STREAM_PLAYBACK_ANA;
628 /* pre-allocation of buffers */
629 /* Preallocate continuous pages. */
630 err = snd_pcm_lib_preallocate_pages_for_all(pcm_playback_ana,
634 64 * 1024, 64 * 1024);
636 printk(KERN_ERR "aw2: snd_pcm_lib_preallocate_pages_for_all "
637 "error (0x%X)\n", err);
639 err = snd_pcm_new(chip->card, "Audiowerk2 digital playback", 1, 1, 0,
643 printk(KERN_ERR "aw2: snd_pcm_new error (0x%X)\n", err);
647 pcm_device = &chip->device_playback[NUM_STREAM_PLAYBACK_DIG];
649 /* Set PCM device name */
650 strcpy(pcm_playback_num->name, "Digital playback");
651 /* Associate private data to PCM device */
652 pcm_playback_num->private_data = pcm_device;
653 /* set operators of PCM device */
654 snd_pcm_set_ops(pcm_playback_num, SNDRV_PCM_STREAM_PLAYBACK,
655 &snd_aw2_playback_ops);
656 /* store PCM device */
657 pcm_device->pcm = pcm_playback_num;
658 /* give base chip pointer to our internal pcm device
660 pcm_device->chip = chip;
661 /* Give stream number to PCM device */
662 pcm_device->stream_number = NUM_STREAM_PLAYBACK_DIG;
664 /* pre-allocation of buffers */
665 /* Preallocate continuous pages. */
666 err = snd_pcm_lib_preallocate_pages_for_all(pcm_playback_num,
670 64 * 1024, 64 * 1024);
673 "aw2: snd_pcm_lib_preallocate_pages_for_all error "
678 err = snd_pcm_new(chip->card, "Audiowerk2 capture", 2, 0, 1,
682 printk(KERN_ERR "aw2: snd_pcm_new error (0x%X)\n", err);
687 pcm_device = &chip->device_capture[NUM_STREAM_CAPTURE_ANA];
689 /* Set PCM device name */
690 strcpy(pcm_capture->name, "Capture");
691 /* Associate private data to PCM device */
692 pcm_capture->private_data = pcm_device;
693 /* set operators of PCM device */
694 snd_pcm_set_ops(pcm_capture, SNDRV_PCM_STREAM_CAPTURE,
695 &snd_aw2_capture_ops);
696 /* store PCM device */
697 pcm_device->pcm = pcm_capture;
698 /* give base chip pointer to our internal pcm device
700 pcm_device->chip = chip;
701 /* Give stream number to PCM device */
702 pcm_device->stream_number = NUM_STREAM_CAPTURE_ANA;
704 /* pre-allocation of buffers */
705 /* Preallocate continuous pages. */
706 err = snd_pcm_lib_preallocate_pages_for_all(pcm_capture,
710 64 * 1024, 64 * 1024);
713 "aw2: snd_pcm_lib_preallocate_pages_for_all error "
718 err = snd_ctl_add(chip->card, snd_ctl_new1(&aw2_control, chip));
720 printk(KERN_ERR "aw2: snd_ctl_add error (0x%X)\n", err);
727 static int snd_aw2_control_switch_capture_info(struct snd_kcontrol *kcontrol,
728 struct snd_ctl_elem_info *uinfo)
730 static char *texts[2] = {
733 uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
735 uinfo->value.enumerated.items = 2;
736 if (uinfo->value.enumerated.item >= uinfo->value.enumerated.items) {
737 uinfo->value.enumerated.item =
738 uinfo->value.enumerated.items - 1;
740 strcpy(uinfo->value.enumerated.name,
741 texts[uinfo->value.enumerated.item]);
745 static int snd_aw2_control_switch_capture_get(struct snd_kcontrol *kcontrol,
746 struct snd_ctl_elem_value
749 struct aw2 *chip = snd_kcontrol_chip(kcontrol);
750 if (snd_aw2_saa7146_is_using_digital_input(&chip->saa7146))
751 ucontrol->value.enumerated.item[0] = CTL_ROUTE_DIGITAL;
753 ucontrol->value.enumerated.item[0] = CTL_ROUTE_ANALOG;
757 static int snd_aw2_control_switch_capture_put(struct snd_kcontrol *kcontrol,
758 struct snd_ctl_elem_value
761 struct aw2 *chip = snd_kcontrol_chip(kcontrol);
764 snd_aw2_saa7146_is_using_digital_input(&chip->saa7146);
766 if (((ucontrol->value.integer.value[0] == CTL_ROUTE_DIGITAL)
768 || ((ucontrol->value.integer.value[0] == CTL_ROUTE_ANALOG)
770 snd_aw2_saa7146_use_digital_input(&chip->saa7146, !is_disgital);