2 * Driver for Digigram VXpocket soundcards
4 * lowlevel routines for VXpocket 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 <sound/driver.h>
24 #include <linux/delay.h>
25 #include <sound/core.h>
29 #define chip_t vx_core_t
32 static int vxp_reg_offset[VX_REG_MAX] = {
33 [VX_ICR] = 0x00, // ICR
34 [VX_CVR] = 0x01, // CVR
35 [VX_ISR] = 0x02, // ISR
36 [VX_IVR] = 0x03, // IVR
37 [VX_RXH] = 0x05, // RXH
38 [VX_RXM] = 0x06, // RXM
39 [VX_RXL] = 0x07, // RXL
40 [VX_DMA] = 0x04, // DMA
41 [VX_CDSP] = 0x08, // CDSP
42 [VX_LOFREQ] = 0x09, // LFREQ
43 [VX_HIFREQ] = 0x0a, // HFREQ
44 [VX_DATA] = 0x0b, // DATA
45 [VX_MICRO] = 0x0c, // MICRO
46 [VX_DIALOG] = 0x0d, // DIALOG
47 [VX_CSUER] = 0x0e, // CSUER
48 [VX_RUER] = 0x0f, // RUER
52 inline static unsigned long vxp_reg_addr(vx_core_t *_chip, int reg)
54 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
55 return chip->port + vxp_reg_offset[reg];
59 * snd_vx_inb - read a byte from the register
60 * @offset: register offset
62 static unsigned char vxp_inb(vx_core_t *chip, int offset)
64 return inb(vxp_reg_addr(chip, offset));
68 * snd_vx_outb - write a byte on the register
69 * @offset: the register offset
70 * @val: the value to write
72 static void vxp_outb(vx_core_t *chip, int offset, unsigned char val)
74 outb(val, vxp_reg_addr(chip, offset));
78 * redefine macros to call directly
81 #define vx_inb(chip,reg) vxp_inb((vx_core_t*)(chip), VX_##reg)
83 #define vx_outb(chip,reg,val) vxp_outb((vx_core_t*)(chip), VX_##reg,val)
87 * vx_check_magic - check the magic word on xilinx
89 * returns zero if a magic word is detected, or a negative error code.
91 static int vx_check_magic(vx_core_t *chip)
93 unsigned long end_time = jiffies + HZ / 5;
96 c = vx_inb(chip, CDSP);
99 snd_vx_delay(chip, 10);
100 } while (time_after_eq(end_time, jiffies));
101 snd_printk(KERN_ERR "cannot find xilinx magic word (%x)\n", c);
107 * vx_reset_dsp - reset the DSP
110 #define XX_DSP_RESET_WAIT_TIME 2 /* ms */
112 static void vxp_reset_dsp(vx_core_t *_chip)
114 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
116 /* set the reset dsp bit to 1 */
117 vx_outb(chip, CDSP, chip->regCDSP | VXP_CDSP_DSP_RESET_MASK);
119 mdelay(XX_DSP_RESET_WAIT_TIME);
121 chip->regCDSP &= ~VXP_CDSP_DSP_RESET_MASK;
122 vx_outb(chip, CDSP, chip->regCDSP);
124 mdelay(XX_DSP_RESET_WAIT_TIME);
130 static void vxp_reset_codec(vx_core_t *_chip)
132 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
134 /* Set the reset CODEC bit to 1. */
135 vx_outb(chip, CDSP, chip->regCDSP | VXP_CDSP_CODEC_RESET_MASK);
137 snd_vx_delay(_chip, 10);
138 /* Set the reset CODEC bit to 0. */
139 chip->regCDSP &= ~VXP_CDSP_CODEC_RESET_MASK;
140 vx_outb(chip, CDSP, chip->regCDSP);
142 snd_vx_delay(_chip, 1);
146 * vx_load_xilinx_binary - load the xilinx binary image
147 * the binary image is the binary array converted from the bitstream file.
149 static int vxp_load_xilinx_binary(vx_core_t *_chip, const snd_hwdep_dsp_image_t *xilinx)
151 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
154 int regCSUER, regRUER;
155 unsigned char __user *image;
158 /* Switch to programmation mode */
159 chip->regDIALOG |= VXP_DLG_XILINX_REPROG_MASK;
160 vx_outb(chip, DIALOG, chip->regDIALOG);
162 /* Save register CSUER and RUER */
163 regCSUER = vx_inb(chip, CSUER);
164 regRUER = vx_inb(chip, RUER);
166 /* reset HF0 and HF1 */
167 vx_outb(chip, ICR, 0);
169 /* Wait for answer HF2 equal to 1 */
170 snd_printdd(KERN_DEBUG "check ISR_HF2\n");
171 if (vx_check_isr(_chip, ISR_HF2, ISR_HF2, 20) < 0)
174 /* set HF1 for loading xilinx binary */
175 vx_outb(chip, ICR, ICR_HF1);
176 image = xilinx->image;
177 for (i = 0; i < xilinx->length; i++, image++) {
178 __get_user(data, image);
179 if (vx_wait_isr_bit(_chip, ISR_TX_EMPTY) < 0)
181 vx_outb(chip, TXL, data);
182 /* wait for reading */
183 if (vx_wait_for_rx_full(_chip) < 0)
185 c = vx_inb(chip, RXL);
187 snd_printk(KERN_ERR "vxpocket: load xilinx mismatch at %d: 0x%x != 0x%x\n", i, c, (int)data);
191 vx_outb(chip, ICR, 0);
194 if (vx_check_isr(_chip, ISR_HF3, ISR_HF3, 20) < 0)
197 /* read the number of bytes received */
198 if (vx_wait_for_rx_full(_chip) < 0)
201 c = (int)vx_inb(chip, RXH) << 16;
202 c |= (int)vx_inb(chip, RXM) << 8;
203 c |= vx_inb(chip, RXL);
205 snd_printdd(KERN_DEBUG "xilinx: dsp size received 0x%x, orig 0x%x\n", c, xilinx->length);
207 vx_outb(chip, ICR, ICR_HF0);
209 /* TEMPO 250ms : wait until Xilinx is downloaded */
210 snd_vx_delay(_chip, 300);
212 /* test magical word */
213 if (vx_check_magic(_chip) < 0)
216 /* Restore register 0x0E and 0x0F (thus replacing COR and FCSR) */
217 vx_outb(chip, CSUER, regCSUER);
218 vx_outb(chip, RUER, regRUER);
220 /* Reset the Xilinx's signal enabling IO access */
221 chip->regDIALOG |= VXP_DLG_XILINX_REPROG_MASK;
222 vx_outb(chip, DIALOG, chip->regDIALOG);
223 vx_inb(chip, DIALOG);
224 snd_vx_delay(_chip, 10);
225 chip->regDIALOG &= ~VXP_DLG_XILINX_REPROG_MASK;
226 vx_outb(chip, DIALOG, chip->regDIALOG);
227 vx_inb(chip, DIALOG);
229 /* Reset of the Codec */
230 vxp_reset_codec(_chip);
236 vx_outb(chip, CSUER, regCSUER);
237 vx_outb(chip, RUER, regRUER);
238 chip->regDIALOG &= ~VXP_DLG_XILINX_REPROG_MASK;
239 vx_outb(chip, DIALOG, chip->regDIALOG);
245 * vxp_load_dsp - load_dsp callback
247 static int vxp_load_dsp(vx_core_t *vx, const snd_hwdep_dsp_image_t *dsp)
252 snd_printdd("loading dsp [%d] %s, size = %d\n", dsp->index, dsp->name, dsp->length);
254 switch (dsp->index) {
257 if ((err = vx_check_magic(vx)) < 0)
259 if ((err = snd_vx_load_boot_image(vx, dsp)) < 0)
264 return vxp_load_xilinx_binary(vx, dsp);
267 return snd_vx_dsp_boot(vx, dsp);
270 return snd_vx_dsp_load(vx, dsp);
279 * vx_test_and_ack - test and acknowledge interrupt
281 * called from irq hander, too
285 static int vxp_test_and_ack(vx_core_t *_chip)
287 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
289 /* not booted yet? */
290 if (! (_chip->chip_status & VX_STAT_XILINX_LOADED))
293 if (! (vx_inb(chip, DIALOG) & VXP_DLG_MEMIRQ_MASK))
296 /* ok, interrupts generated, now ack it */
297 /* set ACQUIT bit up and down */
298 vx_outb(chip, DIALOG, chip->regDIALOG | VXP_DLG_ACK_MEMIRQ_MASK);
299 /* useless read just to spend some time and maintain
300 * the ACQUIT signal up for a while ( a bus cycle )
302 vx_inb(chip, DIALOG);
303 vx_outb(chip, DIALOG, chip->regDIALOG & ~VXP_DLG_ACK_MEMIRQ_MASK);
310 * vx_validate_irq - enable/disable IRQ
312 static void vxp_validate_irq(vx_core_t *_chip, int enable)
314 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
316 /* Set the interrupt enable bit to 1 in CDSP register */
318 chip->regCDSP |= VXP_CDSP_VALID_IRQ_MASK;
320 chip->regCDSP &= ~VXP_CDSP_VALID_IRQ_MASK;
321 vx_outb(chip, CDSP, chip->regCDSP);
325 * vx_setup_pseudo_dma - set up the pseudo dma read/write mode.
326 * @do_write: 0 = read, 1 = set up for DMA write
328 static void vx_setup_pseudo_dma(vx_core_t *_chip, int do_write)
330 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
332 /* Interrupt mode and HREQ pin enabled for host transmit / receive data transfers */
333 vx_outb(chip, ICR, do_write ? ICR_TREQ : ICR_RREQ);
334 /* Reset the pseudo-dma register */
336 vx_outb(chip, ISR, 0);
338 /* Select DMA in read/write transfer mode and in 16-bit accesses */
339 chip->regDIALOG |= VXP_DLG_DMA16_SEL_MASK;
340 chip->regDIALOG |= do_write ? VXP_DLG_DMAWRITE_SEL_MASK : VXP_DLG_DMAREAD_SEL_MASK;
341 vx_outb(chip, DIALOG, chip->regDIALOG);
346 * vx_release_pseudo_dma - disable the pseudo-DMA mode
348 static void vx_release_pseudo_dma(vx_core_t *_chip)
350 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
352 /* Disable DMA and 16-bit accesses */
353 chip->regDIALOG &= ~(VXP_DLG_DMAWRITE_SEL_MASK|
354 VXP_DLG_DMAREAD_SEL_MASK|
355 VXP_DLG_DMA16_SEL_MASK);
356 vx_outb(chip, DIALOG, chip->regDIALOG);
357 /* HREQ pin disabled. */
358 vx_outb(chip, ICR, 0);
362 * vx_pseudo_dma_write - write bulk data on pseudo-DMA mode
363 * @count: data length to transfer in bytes
365 * data size must be aligned to 6 bytes to ensure the 24bit alignment on DSP.
366 * NB: call with a certain lock!
368 static void vxp_dma_write(vx_core_t *chip, snd_pcm_runtime_t *runtime,
369 vx_pipe_t *pipe, int count)
371 long port = vxp_reg_addr(chip, VX_DMA);
372 int offset = pipe->hw_ptr;
373 unsigned short *addr = (unsigned short *)(runtime->dma_area + offset);
375 vx_setup_pseudo_dma(chip, 1);
376 if (offset + count > pipe->buffer_bytes) {
377 int length = pipe->buffer_bytes - offset;
379 length >>= 1; /* in 16bit words */
380 /* Transfer using pseudo-dma. */
381 while (length-- > 0) {
382 outw(cpu_to_le16(*addr), port);
385 addr = (unsigned short *)runtime->dma_area;
388 pipe->hw_ptr += count;
389 count >>= 1; /* in 16bit words */
390 /* Transfer using pseudo-dma. */
391 while (count-- > 0) {
392 outw(cpu_to_le16(*addr), port);
395 vx_release_pseudo_dma(chip);
400 * vx_pseudo_dma_read - read bulk data on pseudo DMA mode
401 * @offset: buffer offset in bytes
402 * @count: data length to transfer in bytes
404 * the read length must be aligned to 6 bytes, as well as write.
405 * NB: call with a certain lock!
407 static void vxp_dma_read(vx_core_t *chip, snd_pcm_runtime_t *runtime,
408 vx_pipe_t *pipe, int count)
410 struct snd_vxpocket *pchip = (struct snd_vxpocket *)chip;
411 long port = vxp_reg_addr(chip, VX_DMA);
412 int offset = pipe->hw_ptr;
413 unsigned short *addr = (unsigned short *)(runtime->dma_area + offset);
415 snd_assert(count % 2 == 0, return);
416 vx_setup_pseudo_dma(chip, 0);
417 if (offset + count > pipe->buffer_bytes) {
418 int length = pipe->buffer_bytes - offset;
420 length >>= 1; /* in 16bit words */
421 /* Transfer using pseudo-dma. */
423 *addr++ = le16_to_cpu(inw(port));
424 addr = (unsigned short *)runtime->dma_area;
427 pipe->hw_ptr += count;
428 count >>= 1; /* in 16bit words */
429 /* Transfer using pseudo-dma. */
431 *addr++ = le16_to_cpu(inw(port));
433 pchip->regDIALOG &= ~VXP_DLG_DMAREAD_SEL_MASK;
434 vx_outb(chip, DIALOG, pchip->regDIALOG);
435 /* Read the last word (16 bits) */
436 *addr = le16_to_cpu(inw(port));
437 /* Disable 16-bit accesses */
438 pchip->regDIALOG &= ~VXP_DLG_DMA16_SEL_MASK;
439 vx_outb(chip, DIALOG, pchip->regDIALOG);
440 /* HREQ pin disabled. */
441 vx_outb(chip, ICR, 0);
446 * write a codec data (24bit)
448 static void vxp_write_codec_reg(vx_core_t *chip, int codec, unsigned int data)
452 /* Activate access to the corresponding codec register */
454 vx_inb(chip, LOFREQ);
456 vx_inb(chip, CODEC2);
458 /* We have to send 24 bits (3 x 8 bits). Start with most signif. Bit */
459 for (i = 0; i < 24; i++, data <<= 1)
460 vx_outb(chip, DATA, ((data & 0x800000) ? VX_DATA_CODEC_MASK : 0));
462 /* Terminate access to codec registers */
463 vx_inb(chip, HIFREQ);
468 * vx_set_mic_boost - set mic boost level (on vxp440 only)
469 * @boost: 0 = 20dB, 1 = +38dB
471 void vx_set_mic_boost(vx_core_t *chip, int boost)
473 struct snd_vxpocket *pchip = (struct snd_vxpocket *)chip;
476 if (chip->chip_status & VX_STAT_IS_STALE)
479 spin_lock_irqsave(&chip->lock, flags);
480 if (pchip->regCDSP & P24_CDSP_MICS_SEL_MASK) {
483 pchip->regCDSP &= ~P24_CDSP_MIC20_SEL_MASK;
484 pchip->regCDSP |= P24_CDSP_MIC38_SEL_MASK;
486 /* minimum value: 20 dB */
487 pchip->regCDSP |= P24_CDSP_MIC20_SEL_MASK;
488 pchip->regCDSP &= ~P24_CDSP_MIC38_SEL_MASK;
490 vx_outb(chip, CDSP, pchip->regCDSP);
492 spin_unlock_irqrestore(&chip->lock, flags);
496 * remap the linear value (0-8) to the actual value (0-15)
498 static int vx_compute_mic_level(int level)
501 case 5: level = 6 ; break;
502 case 6: level = 8 ; break;
503 case 7: level = 11; break;
504 case 8: level = 15; break;
511 * vx_set_mic_level - set mic level (on vxpocket only)
512 * @level: the mic level = 0 - 8 (max)
514 void vx_set_mic_level(vx_core_t *chip, int level)
516 struct snd_vxpocket *pchip = (struct snd_vxpocket *)chip;
519 if (chip->chip_status & VX_STAT_IS_STALE)
522 spin_lock_irqsave(&chip->lock, flags);
523 if (pchip->regCDSP & VXP_CDSP_MIC_SEL_MASK) {
524 level = vx_compute_mic_level(level);
525 vx_outb(chip, MICRO, level);
527 spin_unlock_irqrestore(&chip->lock, flags);
532 * change the input audio source
534 static void vxp_change_audio_source(vx_core_t *_chip, int src)
536 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
539 case VX_AUDIO_SRC_DIGITAL:
540 chip->regCDSP |= VXP_CDSP_DATAIN_SEL_MASK;
541 vx_outb(chip, CDSP, chip->regCDSP);
543 case VX_AUDIO_SRC_LINE:
544 chip->regCDSP &= ~VXP_CDSP_DATAIN_SEL_MASK;
545 if (_chip->type == VX_TYPE_VXP440)
546 chip->regCDSP &= ~P24_CDSP_MICS_SEL_MASK;
548 chip->regCDSP &= ~VXP_CDSP_MIC_SEL_MASK;
549 vx_outb(chip, CDSP, chip->regCDSP);
551 case VX_AUDIO_SRC_MIC:
552 chip->regCDSP &= ~VXP_CDSP_DATAIN_SEL_MASK;
553 /* reset mic levels */
554 if (_chip->type == VX_TYPE_VXP440) {
555 chip->regCDSP &= ~P24_CDSP_MICS_SEL_MASK;
557 chip->regCDSP |= P24_CDSP_MIC38_SEL_MASK;
559 chip->regCDSP |= P24_CDSP_MIC20_SEL_MASK;
560 vx_outb(chip, CDSP, chip->regCDSP);
562 chip->regCDSP |= VXP_CDSP_MIC_SEL_MASK;
563 vx_outb(chip, CDSP, chip->regCDSP);
564 vx_outb(chip, MICRO, vx_compute_mic_level(chip->mic_level));
571 * change the clock source
572 * source = INTERNAL_QUARTZ or UER_SYNC
574 static void vxp_set_clock_source(vx_core_t *_chip, int source)
576 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
578 if (source == INTERNAL_QUARTZ)
579 chip->regCDSP &= ~VXP_CDSP_CLOCKIN_SEL_MASK;
581 chip->regCDSP |= VXP_CDSP_CLOCKIN_SEL_MASK;
582 vx_outb(chip, CDSP, chip->regCDSP);
589 static void vxp_reset_board(vx_core_t *_chip, int cold_reset)
591 struct snd_vxpocket *chip = (struct snd_vxpocket *)_chip;
602 struct snd_vx_ops snd_vxpocket_ops = {
605 .test_and_ack = vxp_test_and_ack,
606 .validate_irq = vxp_validate_irq,
607 .write_codec = vxp_write_codec_reg,
608 .reset_codec = vxp_reset_codec,
609 .change_audio_source = vxp_change_audio_source,
610 .set_clock_source = vxp_set_clock_source,
611 .load_dsp = vxp_load_dsp,
612 .add_controls = vxp_add_mic_controls,
613 .reset_dsp = vxp_reset_dsp,
614 .reset_board = vxp_reset_board,
615 .dma_write = vxp_dma_write,
616 .dma_read = vxp_dma_read,