2 * Driver for Digigram VX soundcards
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/delay.h>
24 #include <linux/slab.h>
25 #include <linux/interrupt.h>
26 #include <linux/init.h>
27 #include <linux/device.h>
28 #include <linux/firmware.h>
29 #include <sound/core.h>
30 #include <sound/pcm.h>
31 #include <sound/asoundef.h>
32 #include <sound/info.h>
34 #include <sound/vx_core.h>
37 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
38 MODULE_DESCRIPTION("Common routines for Digigram VX drivers");
39 MODULE_LICENSE("GPL");
43 * vx_check_reg_bit - wait for the specified bit is set/reset on a register
44 * @reg: register to check
46 * @bit: resultant bit to be checked
47 * @time: time-out of loop in msec
49 * returns zero if a bit matches, or a negative error code.
51 int snd_vx_check_reg_bit(struct vx_core *chip, int reg, int mask, int bit, int time)
53 unsigned long end_time = jiffies + (time * HZ + 999) / 1000;
54 #ifdef CONFIG_SND_DEBUG
55 static char *reg_names[VX_REG_MAX] = {
56 "ICR", "CVR", "ISR", "IVR", "RXH", "RXM", "RXL",
57 "DMA", "CDSP", "RFREQ", "RUER/V2", "DATA", "MEMIRQ",
58 "ACQ", "BIT0", "BIT1", "MIC0", "MIC1", "MIC2",
59 "MIC3", "INTCSR", "CNTRL", "GPIOC",
60 "LOFREQ", "HIFREQ", "CSUER", "RUER"
64 if ((snd_vx_inb(chip, reg) & mask) == bit)
67 } while (time_after_eq(end_time, jiffies));
68 snd_printd(KERN_DEBUG "vx_check_reg_bit: timeout, reg=%s, mask=0x%x, val=0x%x\n", reg_names[reg], mask, snd_vx_inb(chip, reg));
72 EXPORT_SYMBOL(snd_vx_check_reg_bit);
75 * vx_send_irq_dsp - set command irq bit
76 * @num: the requested IRQ type, IRQ_XXX
78 * this triggers the specified IRQ request
79 * returns 0 if successful, or a negative error code.
82 static int vx_send_irq_dsp(struct vx_core *chip, int num)
87 if (snd_vx_check_reg_bit(chip, VX_CVR, CVR_HC, 0, 200) < 0)
91 if (vx_has_new_dsp(chip))
92 nirq += VXP_IRQ_OFFSET;
93 vx_outb(chip, CVR, (nirq >> 1) | CVR_HC);
99 * vx_reset_chk - reset CHK bit on ISR
101 * returns 0 if successful, or a negative error code.
103 static int vx_reset_chk(struct vx_core *chip)
106 if (vx_send_irq_dsp(chip, IRQ_RESET_CHK) < 0)
108 /* Wait until CHK = 0 */
109 if (vx_check_isr(chip, ISR_CHK, 0, 200) < 0)
115 * vx_transfer_end - terminate message transfer
116 * @cmd: IRQ message to send (IRQ_MESS_XXX_END)
118 * returns 0 if successful, or a negative error code.
119 * the error code can be VX-specific, retrieved via vx_get_error().
120 * NB: call with spinlock held!
122 static int vx_transfer_end(struct vx_core *chip, int cmd)
126 if ((err = vx_reset_chk(chip)) < 0)
129 /* irq MESS_READ/WRITE_END */
130 if ((err = vx_send_irq_dsp(chip, cmd)) < 0)
134 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
137 /* If error, Read RX */
138 if ((err = vx_inb(chip, ISR)) & ISR_ERR) {
139 if ((err = vx_wait_for_rx_full(chip)) < 0) {
140 snd_printd(KERN_DEBUG "transfer_end: error in rx_full\n");
143 err = vx_inb(chip, RXH) << 16;
144 err |= vx_inb(chip, RXM) << 8;
145 err |= vx_inb(chip, RXL);
146 snd_printd(KERN_DEBUG "transfer_end: error = 0x%x\n", err);
147 return -(VX_ERR_MASK | err);
153 * vx_read_status - return the status rmh
154 * @rmh: rmh record to store the status
156 * returns 0 if successful, or a negative error code.
157 * the error code can be VX-specific, retrieved via vx_get_error().
158 * NB: call with spinlock held!
160 static int vx_read_status(struct vx_core *chip, struct vx_rmh *rmh)
162 int i, err, val, size;
164 /* no read necessary? */
165 if (rmh->DspStat == RMH_SSIZE_FIXED && rmh->LgStat == 0)
168 /* Wait for RX full (with timeout protection)
169 * The first word of status is in RX
171 err = vx_wait_for_rx_full(chip);
176 val = vx_inb(chip, RXH) << 16;
177 val |= vx_inb(chip, RXM) << 8;
178 val |= vx_inb(chip, RXL);
180 /* If status given by DSP, let's decode its size */
181 switch (rmh->DspStat) {
184 rmh->Stat[0] = val & 0xffff00;
185 rmh->LgStat = size + 1;
188 /* Let's count the arg numbers from a mask */
196 rmh->LgStat = size + 1;
199 /* else retrieve the status length given by the driver */
201 rmh->Stat[0] = val; /* Val is the status 1st word */
202 size--; /* hence adjust remaining length */
208 snd_assert(size <= SIZE_MAX_STATUS, return -EINVAL);
210 for (i = 1; i <= size; i++) {
211 /* trigger an irq MESS_WRITE_NEXT */
212 err = vx_send_irq_dsp(chip, IRQ_MESS_WRITE_NEXT);
215 /* Wait for RX full (with timeout protection) */
216 err = vx_wait_for_rx_full(chip);
219 rmh->Stat[i] = vx_inb(chip, RXH) << 16;
220 rmh->Stat[i] |= vx_inb(chip, RXM) << 8;
221 rmh->Stat[i] |= vx_inb(chip, RXL);
224 return vx_transfer_end(chip, IRQ_MESS_WRITE_END);
228 #define MASK_MORE_THAN_1_WORD_COMMAND 0x00008000
229 #define MASK_1_WORD_COMMAND 0x00ff7fff
232 * vx_send_msg_nolock - send a DSP message and read back the status
233 * @rmh: the rmh record to send and receive
235 * returns 0 if successful, or a negative error code.
236 * the error code can be VX-specific, retrieved via vx_get_error().
238 * this function doesn't call spinlock at all.
240 int vx_send_msg_nolock(struct vx_core *chip, struct vx_rmh *rmh)
244 if (chip->chip_status & VX_STAT_IS_STALE)
247 if ((err = vx_reset_chk(chip)) < 0) {
248 snd_printd(KERN_DEBUG "vx_send_msg: vx_reset_chk error\n");
253 printk(KERN_DEBUG "rmh: cmd = 0x%06x, length = %d, stype = %d\n",
254 rmh->Cmd[0], rmh->LgCmd, rmh->DspStat);
255 if (rmh->LgCmd > 1) {
256 printk(KERN_DEBUG " ");
257 for (i = 1; i < rmh->LgCmd; i++)
258 printk("0x%06x ", rmh->Cmd[i]);
262 /* Check bit M is set according to length of the command */
264 rmh->Cmd[0] |= MASK_MORE_THAN_1_WORD_COMMAND;
266 rmh->Cmd[0] &= MASK_1_WORD_COMMAND;
268 /* Wait for TX empty */
269 if ((err = vx_wait_isr_bit(chip, ISR_TX_EMPTY)) < 0) {
270 snd_printd(KERN_DEBUG "vx_send_msg: wait tx empty error\n");
275 vx_outb(chip, TXH, (rmh->Cmd[0] >> 16) & 0xff);
276 vx_outb(chip, TXM, (rmh->Cmd[0] >> 8) & 0xff);
277 vx_outb(chip, TXL, rmh->Cmd[0] & 0xff);
279 /* Trigger irq MESSAGE */
280 if ((err = vx_send_irq_dsp(chip, IRQ_MESSAGE)) < 0) {
281 snd_printd(KERN_DEBUG "vx_send_msg: send IRQ_MESSAGE error\n");
285 /* Wait for CHK = 1 */
286 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
289 /* If error, get error value from RX */
290 if (vx_inb(chip, ISR) & ISR_ERR) {
291 if ((err = vx_wait_for_rx_full(chip)) < 0) {
292 snd_printd(KERN_DEBUG "vx_send_msg: rx_full read error\n");
295 err = vx_inb(chip, RXH) << 16;
296 err |= vx_inb(chip, RXM) << 8;
297 err |= vx_inb(chip, RXL);
298 snd_printd(KERN_DEBUG "msg got error = 0x%x at cmd[0]\n", err);
299 err = -(VX_ERR_MASK | err);
303 /* Send the other words */
304 if (rmh->LgCmd > 1) {
305 for (i = 1; i < rmh->LgCmd; i++) {
306 /* Wait for TX ready */
307 if ((err = vx_wait_isr_bit(chip, ISR_TX_READY)) < 0) {
308 snd_printd(KERN_DEBUG "vx_send_msg: tx_ready error\n");
313 vx_outb(chip, TXH, (rmh->Cmd[i] >> 16) & 0xff);
314 vx_outb(chip, TXM, (rmh->Cmd[i] >> 8) & 0xff);
315 vx_outb(chip, TXL, rmh->Cmd[i] & 0xff);
317 /* Trigger irq MESS_READ_NEXT */
318 if ((err = vx_send_irq_dsp(chip, IRQ_MESS_READ_NEXT)) < 0) {
319 snd_printd(KERN_DEBUG "vx_send_msg: IRQ_READ_NEXT error\n");
323 /* Wait for TX empty */
324 if ((err = vx_wait_isr_bit(chip, ISR_TX_READY)) < 0) {
325 snd_printd(KERN_DEBUG "vx_send_msg: TX_READY error\n");
328 /* End of transfer */
329 err = vx_transfer_end(chip, IRQ_MESS_READ_END);
334 return vx_read_status(chip, rmh);
339 * vx_send_msg - send a DSP message with spinlock
340 * @rmh: the rmh record to send and receive
342 * returns 0 if successful, or a negative error code.
343 * see vx_send_msg_nolock().
345 int vx_send_msg(struct vx_core *chip, struct vx_rmh *rmh)
350 spin_lock_irqsave(&chip->lock, flags);
351 err = vx_send_msg_nolock(chip, rmh);
352 spin_unlock_irqrestore(&chip->lock, flags);
358 * vx_send_rih_nolock - send an RIH to xilinx
359 * @cmd: the command to send
361 * returns 0 if successful, or a negative error code.
362 * the error code can be VX-specific, retrieved via vx_get_error().
364 * this function doesn't call spinlock at all.
366 * unlike RMH, no command is sent to DSP.
368 int vx_send_rih_nolock(struct vx_core *chip, int cmd)
372 if (chip->chip_status & VX_STAT_IS_STALE)
376 printk(KERN_DEBUG "send_rih: cmd = 0x%x\n", cmd);
378 if ((err = vx_reset_chk(chip)) < 0)
381 if ((err = vx_send_irq_dsp(chip, cmd)) < 0)
384 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
386 /* If error, read RX */
387 if (vx_inb(chip, ISR) & ISR_ERR) {
388 if ((err = vx_wait_for_rx_full(chip)) < 0)
390 err = vx_inb(chip, RXH) << 16;
391 err |= vx_inb(chip, RXM) << 8;
392 err |= vx_inb(chip, RXL);
393 return -(VX_ERR_MASK | err);
400 * vx_send_rih - send an RIH with spinlock
401 * @cmd: the command to send
403 * see vx_send_rih_nolock().
405 int vx_send_rih(struct vx_core *chip, int cmd)
410 spin_lock_irqsave(&chip->lock, flags);
411 err = vx_send_rih_nolock(chip, cmd);
412 spin_unlock_irqrestore(&chip->lock, flags);
416 #define END_OF_RESET_WAIT_TIME 500 /* us */
419 * snd_vx_boot_xilinx - boot up the xilinx interface
420 * @boot: the boot record to load
422 int snd_vx_load_boot_image(struct vx_core *chip, const struct firmware *boot)
425 int no_fillup = vx_has_new_dsp(chip);
427 /* check the length of boot image */
428 snd_assert(boot->size > 0, return -EINVAL);
429 snd_assert(boot->size % 3 == 0, return -EINVAL);
432 /* more strict check */
433 unsigned int c = ((u32)boot->data[0] << 16) | ((u32)boot->data[1] << 8) | boot->data[2];
434 snd_assert(boot->size == (c + 2) * 3, return -EINVAL);
441 udelay(END_OF_RESET_WAIT_TIME); /* another wait? */
443 /* download boot strap */
444 for (i = 0; i < 0x600; i += 3) {
445 if (i >= boot->size) {
448 if (vx_wait_isr_bit(chip, ISR_TX_EMPTY) < 0) {
449 snd_printk(KERN_ERR "dsp boot failed at %d\n", i);
452 vx_outb(chip, TXH, 0);
453 vx_outb(chip, TXM, 0);
454 vx_outb(chip, TXL, 0);
456 const unsigned char *image = boot->data + i;
457 if (vx_wait_isr_bit(chip, ISR_TX_EMPTY) < 0) {
458 snd_printk(KERN_ERR "dsp boot failed at %d\n", i);
461 vx_outb(chip, TXH, image[0]);
462 vx_outb(chip, TXM, image[1]);
463 vx_outb(chip, TXL, image[2]);
469 EXPORT_SYMBOL(snd_vx_load_boot_image);
472 * vx_test_irq_src - query the source of interrupts
474 * called from irq handler only
476 static int vx_test_irq_src(struct vx_core *chip, unsigned int *ret)
480 vx_init_rmh(&chip->irq_rmh, CMD_TEST_IT);
481 spin_lock(&chip->lock);
482 err = vx_send_msg_nolock(chip, &chip->irq_rmh);
486 *ret = chip->irq_rmh.Stat[0];
487 spin_unlock(&chip->lock);
493 * vx_interrupt - soft irq handler
495 static void vx_interrupt(unsigned long private_data)
497 struct vx_core *chip = (struct vx_core *) private_data;
500 if (chip->chip_status & VX_STAT_IS_STALE)
503 if (vx_test_irq_src(chip, &events) < 0)
507 if (events & 0x000800)
508 printk(KERN_ERR "DSP Stream underrun ! IRQ events = 0x%x\n", events);
510 // printk(KERN_DEBUG "IRQ events = 0x%x\n", events);
512 /* We must prevent any application using this DSP
513 * and block any further request until the application
514 * either unregisters or reloads the DSP
516 if (events & FATAL_DSP_ERROR) {
517 snd_printk(KERN_ERR "vx_core: fatal DSP error!!\n");
521 /* The start on time code conditions are filled (ie the time code
522 * received by the board is equal to one of those given to it).
524 if (events & TIME_CODE_EVENT_PENDING)
525 ; /* so far, nothing to do yet */
527 /* The frequency has changed on the board (UER mode). */
528 if (events & FREQUENCY_CHANGE_EVENT_PENDING)
529 vx_change_frequency(chip);
531 /* update the pcm streams */
532 vx_pcm_update_intr(chip, events);
537 * snd_vx_irq_handler - interrupt handler
539 irqreturn_t snd_vx_irq_handler(int irq, void *dev)
541 struct vx_core *chip = dev;
543 if (! (chip->chip_status & VX_STAT_CHIP_INIT) ||
544 (chip->chip_status & VX_STAT_IS_STALE))
546 if (! vx_test_and_ack(chip))
547 tasklet_hi_schedule(&chip->tq);
551 EXPORT_SYMBOL(snd_vx_irq_handler);
555 static void vx_reset_board(struct vx_core *chip, int cold_reset)
557 snd_assert(chip->ops->reset_board, return);
559 /* current source, later sync'ed with target */
560 chip->audio_source = VX_AUDIO_SRC_LINE;
562 chip->audio_source_target = chip->audio_source;
563 chip->clock_source = INTERNAL_QUARTZ;
564 chip->clock_mode = VX_CLOCK_MODE_AUTO;
566 chip->uer_detected = VX_UER_MODE_NOT_PRESENT;
567 chip->uer_bits = SNDRV_PCM_DEFAULT_CON_SPDIF;
570 chip->ops->reset_board(chip, cold_reset);
572 vx_reset_codec(chip, cold_reset);
574 vx_set_internal_clock(chip, chip->freq);
579 if (vx_is_pcmcia(chip)) {
580 /* Acknowledge any pending IRQ and reset the MEMIRQ flag. */
581 vx_test_and_ack(chip);
582 vx_validate_irq(chip, 1);
586 vx_set_iec958_status(chip, chip->uer_bits);
594 static void vx_proc_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
596 struct vx_core *chip = entry->private_data;
597 static char *audio_src_vxp[] = { "Line", "Mic", "Digital" };
598 static char *audio_src_vx2[] = { "Analog", "Analog", "Digital" };
599 static char *clock_mode[] = { "Auto", "Internal", "External" };
600 static char *clock_src[] = { "Internal", "External" };
601 static char *uer_type[] = { "Consumer", "Professional", "Not Present" };
603 snd_iprintf(buffer, "%s\n", chip->card->longname);
604 snd_iprintf(buffer, "Xilinx Firmware: %s\n",
605 chip->chip_status & VX_STAT_XILINX_LOADED ? "Loaded" : "No");
606 snd_iprintf(buffer, "Device Initialized: %s\n",
607 chip->chip_status & VX_STAT_DEVICE_INIT ? "Yes" : "No");
608 snd_iprintf(buffer, "DSP audio info:");
609 if (chip->audio_info & VX_AUDIO_INFO_REAL_TIME)
610 snd_iprintf(buffer, " realtime");
611 if (chip->audio_info & VX_AUDIO_INFO_OFFLINE)
612 snd_iprintf(buffer, " offline");
613 if (chip->audio_info & VX_AUDIO_INFO_MPEG1)
614 snd_iprintf(buffer, " mpeg1");
615 if (chip->audio_info & VX_AUDIO_INFO_MPEG2)
616 snd_iprintf(buffer, " mpeg2");
617 if (chip->audio_info & VX_AUDIO_INFO_LINEAR_8)
618 snd_iprintf(buffer, " linear8");
619 if (chip->audio_info & VX_AUDIO_INFO_LINEAR_16)
620 snd_iprintf(buffer, " linear16");
621 if (chip->audio_info & VX_AUDIO_INFO_LINEAR_24)
622 snd_iprintf(buffer, " linear24");
623 snd_iprintf(buffer, "\n");
624 snd_iprintf(buffer, "Input Source: %s\n", vx_is_pcmcia(chip) ?
625 audio_src_vxp[chip->audio_source] :
626 audio_src_vx2[chip->audio_source]);
627 snd_iprintf(buffer, "Clock Mode: %s\n", clock_mode[chip->clock_mode]);
628 snd_iprintf(buffer, "Clock Source: %s\n", clock_src[chip->clock_source]);
629 snd_iprintf(buffer, "Frequency: %d\n", chip->freq);
630 snd_iprintf(buffer, "Detected Frequency: %d\n", chip->freq_detected);
631 snd_iprintf(buffer, "Detected UER type: %s\n", uer_type[chip->uer_detected]);
632 snd_iprintf(buffer, "Min/Max/Cur IBL: %d/%d/%d (granularity=%d)\n",
633 chip->ibl.min_size, chip->ibl.max_size, chip->ibl.size,
634 chip->ibl.granularity);
637 static void vx_proc_init(struct vx_core *chip)
639 struct snd_info_entry *entry;
641 if (! snd_card_proc_new(chip->card, "vx-status", &entry))
642 snd_info_set_text_ops(entry, chip, vx_proc_read);
647 * snd_vx_dsp_boot - load the DSP boot
649 int snd_vx_dsp_boot(struct vx_core *chip, const struct firmware *boot)
652 int cold_reset = !(chip->chip_status & VX_STAT_DEVICE_INIT);
654 vx_reset_board(chip, cold_reset);
655 vx_validate_irq(chip, 0);
657 if ((err = snd_vx_load_boot_image(chip, boot)) < 0)
664 EXPORT_SYMBOL(snd_vx_dsp_boot);
667 * snd_vx_dsp_load - load the DSP image
669 int snd_vx_dsp_load(struct vx_core *chip, const struct firmware *dsp)
673 unsigned int csum = 0;
674 const unsigned char *image, *cptr;
676 snd_assert(dsp->size % 3 == 0, return -EINVAL);
678 vx_toggle_dac_mute(chip, 1);
680 /* Transfert data buffer from PC to DSP */
681 for (i = 0; i < dsp->size; i += 3) {
682 image = dsp->data + i;
683 /* Wait DSP ready for a new read */
684 if ((err = vx_wait_isr_bit(chip, ISR_TX_EMPTY)) < 0) {
685 printk("dsp loading error at position %d\n", i);
690 csum = (csum >> 24) | (csum << 8);
691 vx_outb(chip, TXH, *cptr++);
693 csum = (csum >> 24) | (csum << 8);
694 vx_outb(chip, TXM, *cptr++);
696 csum = (csum >> 24) | (csum << 8);
697 vx_outb(chip, TXL, *cptr++);
699 snd_printdd(KERN_DEBUG "checksum = 0x%08x\n", csum);
703 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
706 vx_toggle_dac_mute(chip, 0);
708 vx_test_and_ack(chip);
709 vx_validate_irq(chip, 1);
714 EXPORT_SYMBOL(snd_vx_dsp_load);
720 int snd_vx_suspend(struct vx_core *chip, pm_message_t state)
724 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
725 chip->chip_status |= VX_STAT_IN_SUSPEND;
726 for (i = 0; i < chip->hw->num_codecs; i++)
727 snd_pcm_suspend_all(chip->pcm[i]);
732 EXPORT_SYMBOL(snd_vx_suspend);
737 int snd_vx_resume(struct vx_core *chip)
741 chip->chip_status &= ~VX_STAT_CHIP_INIT;
743 for (i = 0; i < 4; i++) {
744 if (! chip->firmware[i])
746 err = chip->ops->load_dsp(chip, i, chip->firmware[i]);
748 snd_printk(KERN_ERR "vx: firmware resume error at DSP %d\n", i);
753 chip->chip_status |= VX_STAT_CHIP_INIT;
754 chip->chip_status &= ~VX_STAT_IN_SUSPEND;
756 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
760 EXPORT_SYMBOL(snd_vx_resume);
764 * snd_vx_create - constructor for struct vx_core
765 * @hw: hardware specific record
767 * this function allocates the instance and prepare for the hardware
770 * return the instance pointer if successful, NULL in error.
772 struct vx_core *snd_vx_create(struct snd_card *card, struct snd_vx_hardware *hw,
773 struct snd_vx_ops *ops,
776 struct vx_core *chip;
778 snd_assert(card && hw && ops, return NULL);
780 chip = kzalloc(sizeof(*chip) + extra_size, GFP_KERNEL);
782 snd_printk(KERN_ERR "vx_core: no memory\n");
785 spin_lock_init(&chip->lock);
786 spin_lock_init(&chip->irq_lock);
789 chip->type = hw->type;
791 tasklet_init(&chip->tq, vx_interrupt, (unsigned long)chip);
792 mutex_init(&chip->mixer_mutex);
795 card->private_data = chip;
796 strcpy(card->driver, hw->name);
797 sprintf(card->shortname, "Digigram %s", hw->name);
804 EXPORT_SYMBOL(snd_vx_create);
809 static int __init alsa_vx_core_init(void)
814 static void __exit alsa_vx_core_exit(void)
818 module_init(alsa_vx_core_init)
819 module_exit(alsa_vx_core_exit)