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 const struct pci_device_id 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 iounmap(chip->iobase_virt);
233 pci_release_regions(chip->pci);
234 /* disable the PCI entry */
235 pci_disable_device(chip->pci);
236 /* release the data */
242 /* chip-specific constructor */
243 static int snd_aw2_create(struct snd_card *card,
244 struct pci_dev *pci, struct aw2 **rchip)
248 static struct snd_device_ops ops = {
249 .dev_free = snd_aw2_dev_free,
254 /* initialize the PCI entry */
255 err = pci_enable_device(pci);
260 /* check PCI availability (32bit DMA) */
261 if ((dma_set_mask(&pci->dev, DMA_BIT_MASK(32)) < 0) ||
262 (dma_set_coherent_mask(&pci->dev, DMA_BIT_MASK(32)) < 0)) {
263 dev_err(card->dev, "Impossible to set 32bit mask DMA\n");
264 pci_disable_device(pci);
267 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
269 pci_disable_device(pci);
273 /* initialize the stuff */
278 /* (1) PCI resource allocation */
279 err = pci_request_regions(pci, "Audiowerk2");
281 pci_disable_device(pci);
285 chip->iobase_phys = pci_resource_start(pci, 0);
287 ioremap_nocache(chip->iobase_phys,
288 pci_resource_len(pci, 0));
290 if (chip->iobase_virt == NULL) {
291 dev_err(card->dev, "unable to remap memory region");
292 pci_release_regions(pci);
293 pci_disable_device(pci);
298 /* (2) initialization of the chip hardware */
299 snd_aw2_saa7146_setup(&chip->saa7146, chip->iobase_virt);
301 if (request_irq(pci->irq, snd_aw2_saa7146_interrupt,
302 IRQF_SHARED, KBUILD_MODNAME, chip)) {
303 dev_err(card->dev, "Cannot grab irq %d\n", pci->irq);
305 iounmap(chip->iobase_virt);
306 pci_release_regions(chip->pci);
307 pci_disable_device(chip->pci);
311 chip->irq = pci->irq;
313 err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
315 free_irq(chip->irq, (void *)chip);
316 iounmap(chip->iobase_virt);
317 pci_release_regions(chip->pci);
318 pci_disable_device(chip->pci);
326 "Audiowerk 2 sound card (saa7146 chipset) detected and managed\n");
331 static int snd_aw2_probe(struct pci_dev *pci,
332 const struct pci_device_id *pci_id)
335 struct snd_card *card;
339 /* (1) Continue if device is not enabled, else inc dev */
340 if (dev >= SNDRV_CARDS)
347 /* (2) Create card instance */
348 err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
353 /* (3) Create main component */
354 err = snd_aw2_create(card, pci, &chip);
360 /* initialize mutex */
361 mutex_init(&chip->mtx);
363 spin_lock_init(&chip->reg_lock);
364 /* (4) Define driver ID and name string */
365 strcpy(card->driver, "aw2");
366 strcpy(card->shortname, "Audiowerk2");
368 sprintf(card->longname, "%s with SAA7146 irq %i",
369 card->shortname, chip->irq);
371 /* (5) Create other components */
372 snd_aw2_new_pcm(chip);
374 /* (6) Register card instance */
375 err = snd_card_register(card);
381 /* (7) Set PCI driver data */
382 pci_set_drvdata(pci, card);
389 static void snd_aw2_remove(struct pci_dev *pci)
391 snd_card_free(pci_get_drvdata(pci));
395 static int snd_aw2_pcm_playback_open(struct snd_pcm_substream *substream)
397 struct snd_pcm_runtime *runtime = substream->runtime;
399 dev_dbg(substream->pcm->card->dev, "Playback_open\n");
400 runtime->hw = snd_aw2_playback_hw;
405 static int snd_aw2_pcm_playback_close(struct snd_pcm_substream *substream)
411 static int snd_aw2_pcm_capture_open(struct snd_pcm_substream *substream)
413 struct snd_pcm_runtime *runtime = substream->runtime;
415 dev_dbg(substream->pcm->card->dev, "Capture_open\n");
416 runtime->hw = snd_aw2_capture_hw;
421 static int snd_aw2_pcm_capture_close(struct snd_pcm_substream *substream)
423 /* TODO: something to do ? */
427 /* hw_params callback */
428 static int snd_aw2_pcm_hw_params(struct snd_pcm_substream *substream,
429 struct snd_pcm_hw_params *hw_params)
431 return snd_pcm_lib_malloc_pages(substream,
432 params_buffer_bytes(hw_params));
435 /* hw_free callback */
436 static int snd_aw2_pcm_hw_free(struct snd_pcm_substream *substream)
438 return snd_pcm_lib_free_pages(substream);
441 /* prepare callback for playback */
442 static int snd_aw2_pcm_prepare_playback(struct snd_pcm_substream *substream)
444 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
445 struct aw2 *chip = pcm_device->chip;
446 struct snd_pcm_runtime *runtime = substream->runtime;
447 unsigned long period_size, buffer_size;
449 mutex_lock(&chip->mtx);
451 period_size = snd_pcm_lib_period_bytes(substream);
452 buffer_size = snd_pcm_lib_buffer_bytes(substream);
454 snd_aw2_saa7146_pcm_init_playback(&chip->saa7146,
455 pcm_device->stream_number,
456 runtime->dma_addr, period_size,
459 /* Define Interrupt callback */
460 snd_aw2_saa7146_define_it_playback_callback(pcm_device->stream_number,
461 (snd_aw2_saa7146_it_cb)
462 snd_pcm_period_elapsed,
465 mutex_unlock(&chip->mtx);
470 /* prepare callback for capture */
471 static int snd_aw2_pcm_prepare_capture(struct snd_pcm_substream *substream)
473 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
474 struct aw2 *chip = pcm_device->chip;
475 struct snd_pcm_runtime *runtime = substream->runtime;
476 unsigned long period_size, buffer_size;
478 mutex_lock(&chip->mtx);
480 period_size = snd_pcm_lib_period_bytes(substream);
481 buffer_size = snd_pcm_lib_buffer_bytes(substream);
483 snd_aw2_saa7146_pcm_init_capture(&chip->saa7146,
484 pcm_device->stream_number,
485 runtime->dma_addr, period_size,
488 /* Define Interrupt callback */
489 snd_aw2_saa7146_define_it_capture_callback(pcm_device->stream_number,
490 (snd_aw2_saa7146_it_cb)
491 snd_pcm_period_elapsed,
494 mutex_unlock(&chip->mtx);
499 /* playback trigger callback */
500 static int snd_aw2_pcm_trigger_playback(struct snd_pcm_substream *substream,
504 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
505 struct aw2 *chip = pcm_device->chip;
506 spin_lock(&chip->reg_lock);
508 case SNDRV_PCM_TRIGGER_START:
509 snd_aw2_saa7146_pcm_trigger_start_playback(&chip->saa7146,
513 case SNDRV_PCM_TRIGGER_STOP:
514 snd_aw2_saa7146_pcm_trigger_stop_playback(&chip->saa7146,
521 spin_unlock(&chip->reg_lock);
525 /* capture trigger callback */
526 static int snd_aw2_pcm_trigger_capture(struct snd_pcm_substream *substream,
530 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
531 struct aw2 *chip = pcm_device->chip;
532 spin_lock(&chip->reg_lock);
534 case SNDRV_PCM_TRIGGER_START:
535 snd_aw2_saa7146_pcm_trigger_start_capture(&chip->saa7146,
539 case SNDRV_PCM_TRIGGER_STOP:
540 snd_aw2_saa7146_pcm_trigger_stop_capture(&chip->saa7146,
547 spin_unlock(&chip->reg_lock);
551 /* playback pointer callback */
552 static snd_pcm_uframes_t snd_aw2_pcm_pointer_playback(struct snd_pcm_substream
555 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
556 struct aw2 *chip = pcm_device->chip;
557 unsigned int current_ptr;
559 /* get the current hardware pointer */
560 struct snd_pcm_runtime *runtime = substream->runtime;
562 snd_aw2_saa7146_get_hw_ptr_playback(&chip->saa7146,
563 pcm_device->stream_number,
565 runtime->buffer_size);
567 return bytes_to_frames(substream->runtime, current_ptr);
570 /* capture pointer callback */
571 static snd_pcm_uframes_t snd_aw2_pcm_pointer_capture(struct snd_pcm_substream
574 struct aw2_pcm_device *pcm_device = snd_pcm_substream_chip(substream);
575 struct aw2 *chip = pcm_device->chip;
576 unsigned int current_ptr;
578 /* get the current hardware pointer */
579 struct snd_pcm_runtime *runtime = substream->runtime;
581 snd_aw2_saa7146_get_hw_ptr_capture(&chip->saa7146,
582 pcm_device->stream_number,
584 runtime->buffer_size);
586 return bytes_to_frames(substream->runtime, current_ptr);
589 /* create a pcm device */
590 static int snd_aw2_new_pcm(struct aw2 *chip)
592 struct snd_pcm *pcm_playback_ana;
593 struct snd_pcm *pcm_playback_num;
594 struct snd_pcm *pcm_capture;
595 struct aw2_pcm_device *pcm_device;
598 /* Create new Alsa PCM device */
600 err = snd_pcm_new(chip->card, "Audiowerk2 analog playback", 0, 1, 0,
603 dev_err(chip->card->dev, "snd_pcm_new error (0x%X)\n", err);
608 pcm_device = &chip->device_playback[NUM_STREAM_PLAYBACK_ANA];
610 /* Set PCM device name */
611 strcpy(pcm_playback_ana->name, "Analog playback");
612 /* Associate private data to PCM device */
613 pcm_playback_ana->private_data = pcm_device;
614 /* set operators of PCM device */
615 snd_pcm_set_ops(pcm_playback_ana, SNDRV_PCM_STREAM_PLAYBACK,
616 &snd_aw2_playback_ops);
617 /* store PCM device */
618 pcm_device->pcm = pcm_playback_ana;
619 /* give base chip pointer to our internal pcm device
621 pcm_device->chip = chip;
622 /* Give stream number to PCM device */
623 pcm_device->stream_number = NUM_STREAM_PLAYBACK_ANA;
625 /* pre-allocation of buffers */
626 /* Preallocate continuous pages. */
627 err = snd_pcm_lib_preallocate_pages_for_all(pcm_playback_ana,
631 64 * 1024, 64 * 1024);
633 dev_err(chip->card->dev,
634 "snd_pcm_lib_preallocate_pages_for_all error (0x%X)\n",
637 err = snd_pcm_new(chip->card, "Audiowerk2 digital playback", 1, 1, 0,
641 dev_err(chip->card->dev, "snd_pcm_new error (0x%X)\n", err);
645 pcm_device = &chip->device_playback[NUM_STREAM_PLAYBACK_DIG];
647 /* Set PCM device name */
648 strcpy(pcm_playback_num->name, "Digital playback");
649 /* Associate private data to PCM device */
650 pcm_playback_num->private_data = pcm_device;
651 /* set operators of PCM device */
652 snd_pcm_set_ops(pcm_playback_num, SNDRV_PCM_STREAM_PLAYBACK,
653 &snd_aw2_playback_ops);
654 /* store PCM device */
655 pcm_device->pcm = pcm_playback_num;
656 /* give base chip pointer to our internal pcm device
658 pcm_device->chip = chip;
659 /* Give stream number to PCM device */
660 pcm_device->stream_number = NUM_STREAM_PLAYBACK_DIG;
662 /* pre-allocation of buffers */
663 /* Preallocate continuous pages. */
664 err = snd_pcm_lib_preallocate_pages_for_all(pcm_playback_num,
668 64 * 1024, 64 * 1024);
670 dev_err(chip->card->dev,
671 "snd_pcm_lib_preallocate_pages_for_all error (0x%X)\n",
674 err = snd_pcm_new(chip->card, "Audiowerk2 capture", 2, 0, 1,
678 dev_err(chip->card->dev, "snd_pcm_new error (0x%X)\n", err);
683 pcm_device = &chip->device_capture[NUM_STREAM_CAPTURE_ANA];
685 /* Set PCM device name */
686 strcpy(pcm_capture->name, "Capture");
687 /* Associate private data to PCM device */
688 pcm_capture->private_data = pcm_device;
689 /* set operators of PCM device */
690 snd_pcm_set_ops(pcm_capture, SNDRV_PCM_STREAM_CAPTURE,
691 &snd_aw2_capture_ops);
692 /* store PCM device */
693 pcm_device->pcm = pcm_capture;
694 /* give base chip pointer to our internal pcm device
696 pcm_device->chip = chip;
697 /* Give stream number to PCM device */
698 pcm_device->stream_number = NUM_STREAM_CAPTURE_ANA;
700 /* pre-allocation of buffers */
701 /* Preallocate continuous pages. */
702 err = snd_pcm_lib_preallocate_pages_for_all(pcm_capture,
706 64 * 1024, 64 * 1024);
708 dev_err(chip->card->dev,
709 "snd_pcm_lib_preallocate_pages_for_all error (0x%X)\n",
714 err = snd_ctl_add(chip->card, snd_ctl_new1(&aw2_control, chip));
716 dev_err(chip->card->dev, "snd_ctl_add error (0x%X)\n", err);
723 static int snd_aw2_control_switch_capture_info(struct snd_kcontrol *kcontrol,
724 struct snd_ctl_elem_info *uinfo)
726 static const char * const texts[2] = {
729 return snd_ctl_enum_info(uinfo, 1, 2, texts);
732 static int snd_aw2_control_switch_capture_get(struct snd_kcontrol *kcontrol,
733 struct snd_ctl_elem_value
736 struct aw2 *chip = snd_kcontrol_chip(kcontrol);
737 if (snd_aw2_saa7146_is_using_digital_input(&chip->saa7146))
738 ucontrol->value.enumerated.item[0] = CTL_ROUTE_DIGITAL;
740 ucontrol->value.enumerated.item[0] = CTL_ROUTE_ANALOG;
744 static int snd_aw2_control_switch_capture_put(struct snd_kcontrol *kcontrol,
745 struct snd_ctl_elem_value
748 struct aw2 *chip = snd_kcontrol_chip(kcontrol);
751 snd_aw2_saa7146_is_using_digital_input(&chip->saa7146);
753 if (((ucontrol->value.integer.value[0] == CTL_ROUTE_DIGITAL)
755 || ((ucontrol->value.integer.value[0] == CTL_ROUTE_ANALOG)
757 snd_aw2_saa7146_use_digital_input(&chip->saa7146, !is_disgital);