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 <linux/module.h>
30 #include <sound/core.h>
31 #include <sound/pcm.h>
32 #include <sound/asoundef.h>
33 #include <sound/info.h>
35 #include <sound/vx_core.h>
38 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
39 MODULE_DESCRIPTION("Common routines for Digigram VX drivers");
40 MODULE_LICENSE("GPL");
44 * vx_check_reg_bit - wait for the specified bit is set/reset on a register
45 * @reg: register to check
47 * @bit: resultant bit to be checked
48 * @time: time-out of loop in msec
50 * returns zero if a bit matches, or a negative error code.
52 int snd_vx_check_reg_bit(struct vx_core *chip, int reg, int mask, int bit, int time)
54 unsigned long end_time = jiffies + (time * HZ + 999) / 1000;
55 #ifdef CONFIG_SND_DEBUG
56 static char *reg_names[VX_REG_MAX] = {
57 "ICR", "CVR", "ISR", "IVR", "RXH", "RXM", "RXL",
58 "DMA", "CDSP", "RFREQ", "RUER/V2", "DATA", "MEMIRQ",
59 "ACQ", "BIT0", "BIT1", "MIC0", "MIC1", "MIC2",
60 "MIC3", "INTCSR", "CNTRL", "GPIOC",
61 "LOFREQ", "HIFREQ", "CSUER", "RUER"
65 if ((snd_vx_inb(chip, reg) & mask) == bit)
68 } while (time_after_eq(end_time, jiffies));
69 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));
73 EXPORT_SYMBOL(snd_vx_check_reg_bit);
76 * vx_send_irq_dsp - set command irq bit
77 * @num: the requested IRQ type, IRQ_XXX
79 * this triggers the specified IRQ request
80 * returns 0 if successful, or a negative error code.
83 static int vx_send_irq_dsp(struct vx_core *chip, int num)
88 if (snd_vx_check_reg_bit(chip, VX_CVR, CVR_HC, 0, 200) < 0)
92 if (vx_has_new_dsp(chip))
93 nirq += VXP_IRQ_OFFSET;
94 vx_outb(chip, CVR, (nirq >> 1) | CVR_HC);
100 * vx_reset_chk - reset CHK bit on ISR
102 * returns 0 if successful, or a negative error code.
104 static int vx_reset_chk(struct vx_core *chip)
107 if (vx_send_irq_dsp(chip, IRQ_RESET_CHK) < 0)
109 /* Wait until CHK = 0 */
110 if (vx_check_isr(chip, ISR_CHK, 0, 200) < 0)
116 * vx_transfer_end - terminate message transfer
117 * @cmd: IRQ message to send (IRQ_MESS_XXX_END)
119 * returns 0 if successful, or a negative error code.
120 * the error code can be VX-specific, retrieved via vx_get_error().
121 * NB: call with spinlock held!
123 static int vx_transfer_end(struct vx_core *chip, int cmd)
127 if ((err = vx_reset_chk(chip)) < 0)
130 /* irq MESS_READ/WRITE_END */
131 if ((err = vx_send_irq_dsp(chip, cmd)) < 0)
135 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
138 /* If error, Read RX */
139 if ((err = vx_inb(chip, ISR)) & ISR_ERR) {
140 if ((err = vx_wait_for_rx_full(chip)) < 0) {
141 snd_printd(KERN_DEBUG "transfer_end: error in rx_full\n");
144 err = vx_inb(chip, RXH) << 16;
145 err |= vx_inb(chip, RXM) << 8;
146 err |= vx_inb(chip, RXL);
147 snd_printd(KERN_DEBUG "transfer_end: error = 0x%x\n", err);
148 return -(VX_ERR_MASK | err);
154 * vx_read_status - return the status rmh
155 * @rmh: rmh record to store the status
157 * returns 0 if successful, or a negative error code.
158 * the error code can be VX-specific, retrieved via vx_get_error().
159 * NB: call with spinlock held!
161 static int vx_read_status(struct vx_core *chip, struct vx_rmh *rmh)
163 int i, err, val, size;
165 /* no read necessary? */
166 if (rmh->DspStat == RMH_SSIZE_FIXED && rmh->LgStat == 0)
169 /* Wait for RX full (with timeout protection)
170 * The first word of status is in RX
172 err = vx_wait_for_rx_full(chip);
177 val = vx_inb(chip, RXH) << 16;
178 val |= vx_inb(chip, RXM) << 8;
179 val |= vx_inb(chip, RXL);
181 /* If status given by DSP, let's decode its size */
182 switch (rmh->DspStat) {
185 rmh->Stat[0] = val & 0xffff00;
186 rmh->LgStat = size + 1;
189 /* Let's count the arg numbers from a mask */
197 rmh->LgStat = size + 1;
200 /* else retrieve the status length given by the driver */
202 rmh->Stat[0] = val; /* Val is the status 1st word */
203 size--; /* hence adjust remaining length */
209 if (snd_BUG_ON(size > SIZE_MAX_STATUS))
212 for (i = 1; i <= size; i++) {
213 /* trigger an irq MESS_WRITE_NEXT */
214 err = vx_send_irq_dsp(chip, IRQ_MESS_WRITE_NEXT);
217 /* Wait for RX full (with timeout protection) */
218 err = vx_wait_for_rx_full(chip);
221 rmh->Stat[i] = vx_inb(chip, RXH) << 16;
222 rmh->Stat[i] |= vx_inb(chip, RXM) << 8;
223 rmh->Stat[i] |= vx_inb(chip, RXL);
226 return vx_transfer_end(chip, IRQ_MESS_WRITE_END);
230 #define MASK_MORE_THAN_1_WORD_COMMAND 0x00008000
231 #define MASK_1_WORD_COMMAND 0x00ff7fff
234 * vx_send_msg_nolock - send a DSP message and read back the status
235 * @rmh: the rmh record to send and receive
237 * returns 0 if successful, or a negative error code.
238 * the error code can be VX-specific, retrieved via vx_get_error().
240 * this function doesn't call spinlock at all.
242 int vx_send_msg_nolock(struct vx_core *chip, struct vx_rmh *rmh)
246 if (chip->chip_status & VX_STAT_IS_STALE)
249 if ((err = vx_reset_chk(chip)) < 0) {
250 snd_printd(KERN_DEBUG "vx_send_msg: vx_reset_chk error\n");
255 printk(KERN_DEBUG "rmh: cmd = 0x%06x, length = %d, stype = %d\n",
256 rmh->Cmd[0], rmh->LgCmd, rmh->DspStat);
257 if (rmh->LgCmd > 1) {
258 printk(KERN_DEBUG " ");
259 for (i = 1; i < rmh->LgCmd; i++)
260 printk("0x%06x ", rmh->Cmd[i]);
264 /* Check bit M is set according to length of the command */
266 rmh->Cmd[0] |= MASK_MORE_THAN_1_WORD_COMMAND;
268 rmh->Cmd[0] &= MASK_1_WORD_COMMAND;
270 /* Wait for TX empty */
271 if ((err = vx_wait_isr_bit(chip, ISR_TX_EMPTY)) < 0) {
272 snd_printd(KERN_DEBUG "vx_send_msg: wait tx empty error\n");
277 vx_outb(chip, TXH, (rmh->Cmd[0] >> 16) & 0xff);
278 vx_outb(chip, TXM, (rmh->Cmd[0] >> 8) & 0xff);
279 vx_outb(chip, TXL, rmh->Cmd[0] & 0xff);
281 /* Trigger irq MESSAGE */
282 if ((err = vx_send_irq_dsp(chip, IRQ_MESSAGE)) < 0) {
283 snd_printd(KERN_DEBUG "vx_send_msg: send IRQ_MESSAGE error\n");
287 /* Wait for CHK = 1 */
288 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
291 /* If error, get error value from RX */
292 if (vx_inb(chip, ISR) & ISR_ERR) {
293 if ((err = vx_wait_for_rx_full(chip)) < 0) {
294 snd_printd(KERN_DEBUG "vx_send_msg: rx_full read error\n");
297 err = vx_inb(chip, RXH) << 16;
298 err |= vx_inb(chip, RXM) << 8;
299 err |= vx_inb(chip, RXL);
300 snd_printd(KERN_DEBUG "msg got error = 0x%x at cmd[0]\n", err);
301 err = -(VX_ERR_MASK | err);
305 /* Send the other words */
306 if (rmh->LgCmd > 1) {
307 for (i = 1; i < rmh->LgCmd; i++) {
308 /* Wait for TX ready */
309 if ((err = vx_wait_isr_bit(chip, ISR_TX_READY)) < 0) {
310 snd_printd(KERN_DEBUG "vx_send_msg: tx_ready error\n");
315 vx_outb(chip, TXH, (rmh->Cmd[i] >> 16) & 0xff);
316 vx_outb(chip, TXM, (rmh->Cmd[i] >> 8) & 0xff);
317 vx_outb(chip, TXL, rmh->Cmd[i] & 0xff);
319 /* Trigger irq MESS_READ_NEXT */
320 if ((err = vx_send_irq_dsp(chip, IRQ_MESS_READ_NEXT)) < 0) {
321 snd_printd(KERN_DEBUG "vx_send_msg: IRQ_READ_NEXT error\n");
325 /* Wait for TX empty */
326 if ((err = vx_wait_isr_bit(chip, ISR_TX_READY)) < 0) {
327 snd_printd(KERN_DEBUG "vx_send_msg: TX_READY error\n");
330 /* End of transfer */
331 err = vx_transfer_end(chip, IRQ_MESS_READ_END);
336 return vx_read_status(chip, rmh);
341 * vx_send_msg - send a DSP message with spinlock
342 * @rmh: the rmh record to send and receive
344 * returns 0 if successful, or a negative error code.
345 * see vx_send_msg_nolock().
347 int vx_send_msg(struct vx_core *chip, struct vx_rmh *rmh)
352 spin_lock_irqsave(&chip->lock, flags);
353 err = vx_send_msg_nolock(chip, rmh);
354 spin_unlock_irqrestore(&chip->lock, flags);
360 * vx_send_rih_nolock - send an RIH to xilinx
361 * @cmd: the command to send
363 * returns 0 if successful, or a negative error code.
364 * the error code can be VX-specific, retrieved via vx_get_error().
366 * this function doesn't call spinlock at all.
368 * unlike RMH, no command is sent to DSP.
370 int vx_send_rih_nolock(struct vx_core *chip, int cmd)
374 if (chip->chip_status & VX_STAT_IS_STALE)
378 printk(KERN_DEBUG "send_rih: cmd = 0x%x\n", cmd);
380 if ((err = vx_reset_chk(chip)) < 0)
383 if ((err = vx_send_irq_dsp(chip, cmd)) < 0)
386 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
388 /* If error, read RX */
389 if (vx_inb(chip, ISR) & ISR_ERR) {
390 if ((err = vx_wait_for_rx_full(chip)) < 0)
392 err = vx_inb(chip, RXH) << 16;
393 err |= vx_inb(chip, RXM) << 8;
394 err |= vx_inb(chip, RXL);
395 return -(VX_ERR_MASK | err);
402 * vx_send_rih - send an RIH with spinlock
403 * @cmd: the command to send
405 * see vx_send_rih_nolock().
407 int vx_send_rih(struct vx_core *chip, int cmd)
412 spin_lock_irqsave(&chip->lock, flags);
413 err = vx_send_rih_nolock(chip, cmd);
414 spin_unlock_irqrestore(&chip->lock, flags);
418 #define END_OF_RESET_WAIT_TIME 500 /* us */
421 * snd_vx_boot_xilinx - boot up the xilinx interface
422 * @boot: the boot record to load
424 int snd_vx_load_boot_image(struct vx_core *chip, const struct firmware *boot)
427 int no_fillup = vx_has_new_dsp(chip);
429 /* check the length of boot image */
436 /* more strict check */
437 unsigned int c = ((u32)boot->data[0] << 16) | ((u32)boot->data[1] << 8) | boot->data[2];
438 if (boot->size != (c + 2) * 3)
446 udelay(END_OF_RESET_WAIT_TIME); /* another wait? */
448 /* download boot strap */
449 for (i = 0; i < 0x600; i += 3) {
450 if (i >= boot->size) {
453 if (vx_wait_isr_bit(chip, ISR_TX_EMPTY) < 0) {
454 snd_printk(KERN_ERR "dsp boot failed at %d\n", i);
457 vx_outb(chip, TXH, 0);
458 vx_outb(chip, TXM, 0);
459 vx_outb(chip, TXL, 0);
461 const unsigned char *image = boot->data + i;
462 if (vx_wait_isr_bit(chip, ISR_TX_EMPTY) < 0) {
463 snd_printk(KERN_ERR "dsp boot failed at %d\n", i);
466 vx_outb(chip, TXH, image[0]);
467 vx_outb(chip, TXM, image[1]);
468 vx_outb(chip, TXL, image[2]);
474 EXPORT_SYMBOL(snd_vx_load_boot_image);
477 * vx_test_irq_src - query the source of interrupts
479 * called from irq handler only
481 static int vx_test_irq_src(struct vx_core *chip, unsigned int *ret)
485 vx_init_rmh(&chip->irq_rmh, CMD_TEST_IT);
486 spin_lock(&chip->lock);
487 err = vx_send_msg_nolock(chip, &chip->irq_rmh);
491 *ret = chip->irq_rmh.Stat[0];
492 spin_unlock(&chip->lock);
498 * vx_interrupt - soft irq handler
500 static void vx_interrupt(unsigned long private_data)
502 struct vx_core *chip = (struct vx_core *) private_data;
505 if (chip->chip_status & VX_STAT_IS_STALE)
508 if (vx_test_irq_src(chip, &events) < 0)
512 if (events & 0x000800)
513 printk(KERN_ERR "DSP Stream underrun ! IRQ events = 0x%x\n", events);
515 // printk(KERN_DEBUG "IRQ events = 0x%x\n", events);
517 /* We must prevent any application using this DSP
518 * and block any further request until the application
519 * either unregisters or reloads the DSP
521 if (events & FATAL_DSP_ERROR) {
522 snd_printk(KERN_ERR "vx_core: fatal DSP error!!\n");
526 /* The start on time code conditions are filled (ie the time code
527 * received by the board is equal to one of those given to it).
529 if (events & TIME_CODE_EVENT_PENDING)
530 ; /* so far, nothing to do yet */
532 /* The frequency has changed on the board (UER mode). */
533 if (events & FREQUENCY_CHANGE_EVENT_PENDING)
534 vx_change_frequency(chip);
536 /* update the pcm streams */
537 vx_pcm_update_intr(chip, events);
542 * snd_vx_irq_handler - interrupt handler
544 irqreturn_t snd_vx_irq_handler(int irq, void *dev)
546 struct vx_core *chip = dev;
548 if (! (chip->chip_status & VX_STAT_CHIP_INIT) ||
549 (chip->chip_status & VX_STAT_IS_STALE))
551 if (! vx_test_and_ack(chip))
552 tasklet_schedule(&chip->tq);
556 EXPORT_SYMBOL(snd_vx_irq_handler);
560 static void vx_reset_board(struct vx_core *chip, int cold_reset)
562 if (snd_BUG_ON(!chip->ops->reset_board))
565 /* current source, later sync'ed with target */
566 chip->audio_source = VX_AUDIO_SRC_LINE;
568 chip->audio_source_target = chip->audio_source;
569 chip->clock_source = INTERNAL_QUARTZ;
570 chip->clock_mode = VX_CLOCK_MODE_AUTO;
572 chip->uer_detected = VX_UER_MODE_NOT_PRESENT;
573 chip->uer_bits = SNDRV_PCM_DEFAULT_CON_SPDIF;
576 chip->ops->reset_board(chip, cold_reset);
578 vx_reset_codec(chip, cold_reset);
580 vx_set_internal_clock(chip, chip->freq);
585 if (vx_is_pcmcia(chip)) {
586 /* Acknowledge any pending IRQ and reset the MEMIRQ flag. */
587 vx_test_and_ack(chip);
588 vx_validate_irq(chip, 1);
592 vx_set_iec958_status(chip, chip->uer_bits);
600 static void vx_proc_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
602 struct vx_core *chip = entry->private_data;
603 static char *audio_src_vxp[] = { "Line", "Mic", "Digital" };
604 static char *audio_src_vx2[] = { "Analog", "Analog", "Digital" };
605 static char *clock_mode[] = { "Auto", "Internal", "External" };
606 static char *clock_src[] = { "Internal", "External" };
607 static char *uer_type[] = { "Consumer", "Professional", "Not Present" };
609 snd_iprintf(buffer, "%s\n", chip->card->longname);
610 snd_iprintf(buffer, "Xilinx Firmware: %s\n",
611 chip->chip_status & VX_STAT_XILINX_LOADED ? "Loaded" : "No");
612 snd_iprintf(buffer, "Device Initialized: %s\n",
613 chip->chip_status & VX_STAT_DEVICE_INIT ? "Yes" : "No");
614 snd_iprintf(buffer, "DSP audio info:");
615 if (chip->audio_info & VX_AUDIO_INFO_REAL_TIME)
616 snd_iprintf(buffer, " realtime");
617 if (chip->audio_info & VX_AUDIO_INFO_OFFLINE)
618 snd_iprintf(buffer, " offline");
619 if (chip->audio_info & VX_AUDIO_INFO_MPEG1)
620 snd_iprintf(buffer, " mpeg1");
621 if (chip->audio_info & VX_AUDIO_INFO_MPEG2)
622 snd_iprintf(buffer, " mpeg2");
623 if (chip->audio_info & VX_AUDIO_INFO_LINEAR_8)
624 snd_iprintf(buffer, " linear8");
625 if (chip->audio_info & VX_AUDIO_INFO_LINEAR_16)
626 snd_iprintf(buffer, " linear16");
627 if (chip->audio_info & VX_AUDIO_INFO_LINEAR_24)
628 snd_iprintf(buffer, " linear24");
629 snd_iprintf(buffer, "\n");
630 snd_iprintf(buffer, "Input Source: %s\n", vx_is_pcmcia(chip) ?
631 audio_src_vxp[chip->audio_source] :
632 audio_src_vx2[chip->audio_source]);
633 snd_iprintf(buffer, "Clock Mode: %s\n", clock_mode[chip->clock_mode]);
634 snd_iprintf(buffer, "Clock Source: %s\n", clock_src[chip->clock_source]);
635 snd_iprintf(buffer, "Frequency: %d\n", chip->freq);
636 snd_iprintf(buffer, "Detected Frequency: %d\n", chip->freq_detected);
637 snd_iprintf(buffer, "Detected UER type: %s\n", uer_type[chip->uer_detected]);
638 snd_iprintf(buffer, "Min/Max/Cur IBL: %d/%d/%d (granularity=%d)\n",
639 chip->ibl.min_size, chip->ibl.max_size, chip->ibl.size,
640 chip->ibl.granularity);
643 static void vx_proc_init(struct vx_core *chip)
645 struct snd_info_entry *entry;
647 if (! snd_card_proc_new(chip->card, "vx-status", &entry))
648 snd_info_set_text_ops(entry, chip, vx_proc_read);
653 * snd_vx_dsp_boot - load the DSP boot
655 int snd_vx_dsp_boot(struct vx_core *chip, const struct firmware *boot)
658 int cold_reset = !(chip->chip_status & VX_STAT_DEVICE_INIT);
660 vx_reset_board(chip, cold_reset);
661 vx_validate_irq(chip, 0);
663 if ((err = snd_vx_load_boot_image(chip, boot)) < 0)
670 EXPORT_SYMBOL(snd_vx_dsp_boot);
673 * snd_vx_dsp_load - load the DSP image
675 int snd_vx_dsp_load(struct vx_core *chip, const struct firmware *dsp)
679 unsigned int csum = 0;
680 const unsigned char *image, *cptr;
685 vx_toggle_dac_mute(chip, 1);
687 /* Transfert data buffer from PC to DSP */
688 for (i = 0; i < dsp->size; i += 3) {
689 image = dsp->data + i;
690 /* Wait DSP ready for a new read */
691 if ((err = vx_wait_isr_bit(chip, ISR_TX_EMPTY)) < 0) {
693 "dsp loading error at position %d\n", i);
698 csum = (csum >> 24) | (csum << 8);
699 vx_outb(chip, TXH, *cptr++);
701 csum = (csum >> 24) | (csum << 8);
702 vx_outb(chip, TXM, *cptr++);
704 csum = (csum >> 24) | (csum << 8);
705 vx_outb(chip, TXL, *cptr++);
707 snd_printdd(KERN_DEBUG "checksum = 0x%08x\n", csum);
711 if ((err = vx_wait_isr_bit(chip, ISR_CHK)) < 0)
714 vx_toggle_dac_mute(chip, 0);
716 vx_test_and_ack(chip);
717 vx_validate_irq(chip, 1);
722 EXPORT_SYMBOL(snd_vx_dsp_load);
728 int snd_vx_suspend(struct vx_core *chip)
732 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
733 chip->chip_status |= VX_STAT_IN_SUSPEND;
734 for (i = 0; i < chip->hw->num_codecs; i++)
735 snd_pcm_suspend_all(chip->pcm[i]);
740 EXPORT_SYMBOL(snd_vx_suspend);
745 int snd_vx_resume(struct vx_core *chip)
749 chip->chip_status &= ~VX_STAT_CHIP_INIT;
751 for (i = 0; i < 4; i++) {
752 if (! chip->firmware[i])
754 err = chip->ops->load_dsp(chip, i, chip->firmware[i]);
756 snd_printk(KERN_ERR "vx: firmware resume error at DSP %d\n", i);
761 chip->chip_status |= VX_STAT_CHIP_INIT;
762 chip->chip_status &= ~VX_STAT_IN_SUSPEND;
764 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
768 EXPORT_SYMBOL(snd_vx_resume);
772 * snd_vx_create - constructor for struct vx_core
773 * @hw: hardware specific record
775 * this function allocates the instance and prepare for the hardware
778 * return the instance pointer if successful, NULL in error.
780 struct vx_core *snd_vx_create(struct snd_card *card, struct snd_vx_hardware *hw,
781 struct snd_vx_ops *ops,
784 struct vx_core *chip;
786 if (snd_BUG_ON(!card || !hw || !ops))
789 chip = kzalloc(sizeof(*chip) + extra_size, GFP_KERNEL);
791 snd_printk(KERN_ERR "vx_core: no memory\n");
794 spin_lock_init(&chip->lock);
795 spin_lock_init(&chip->irq_lock);
798 chip->type = hw->type;
800 tasklet_init(&chip->tq, vx_interrupt, (unsigned long)chip);
801 mutex_init(&chip->mixer_mutex);
804 card->private_data = chip;
805 strcpy(card->driver, hw->name);
806 sprintf(card->shortname, "Digigram %s", hw->name);
813 EXPORT_SYMBOL(snd_vx_create);
818 static int __init alsa_vx_core_init(void)
823 static void __exit alsa_vx_core_exit(void)
827 module_init(alsa_vx_core_init)
828 module_exit(alsa_vx_core_exit)