2 * Copyright (c) 1999 by Uros Bizjak <uros@kss-loka.si>
3 * Takashi Iwai <tiwai@suse.de>
5 * SB16ASP/AWE32 CSP control
7 * CSP microcode loader:
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <linux/delay.h>
27 #include <linux/init.h>
28 #include <linux/slab.h>
29 #include <sound/core.h>
30 #include <sound/control.h>
31 #include <sound/info.h>
32 #include <sound/sb16_csp.h>
33 #include <sound/initval.h>
35 MODULE_AUTHOR("Uros Bizjak <uros@kss-loka.si>");
36 MODULE_DESCRIPTION("ALSA driver for SB16 Creative Signal Processor");
37 MODULE_LICENSE("GPL");
38 MODULE_FIRMWARE("sb16/mulaw_main.csp");
39 MODULE_FIRMWARE("sb16/alaw_main.csp");
40 MODULE_FIRMWARE("sb16/ima_adpcm_init.csp");
41 MODULE_FIRMWARE("sb16/ima_adpcm_playback.csp");
42 MODULE_FIRMWARE("sb16/ima_adpcm_capture.csp");
44 #ifdef SNDRV_LITTLE_ENDIAN
45 #define CSP_HDR_VALUE(a,b,c,d) ((a) | ((b)<<8) | ((c)<<16) | ((d)<<24))
47 #define CSP_HDR_VALUE(a,b,c,d) ((d) | ((c)<<8) | ((b)<<16) | ((a)<<24))
50 #define RIFF_HEADER CSP_HDR_VALUE('R', 'I', 'F', 'F')
51 #define CSP__HEADER CSP_HDR_VALUE('C', 'S', 'P', ' ')
52 #define LIST_HEADER CSP_HDR_VALUE('L', 'I', 'S', 'T')
53 #define FUNC_HEADER CSP_HDR_VALUE('f', 'u', 'n', 'c')
54 #define CODE_HEADER CSP_HDR_VALUE('c', 'o', 'd', 'e')
55 #define INIT_HEADER CSP_HDR_VALUE('i', 'n', 'i', 't')
56 #define MAIN_HEADER CSP_HDR_VALUE('m', 'a', 'i', 'n')
67 struct riff_header info
;
71 __u16 flags_16bit_8bit
;
72 __u16 flags_stereo_mono
;
79 static void snd_sb_csp_free(struct snd_hwdep
*hw
);
80 static int snd_sb_csp_open(struct snd_hwdep
* hw
, struct file
*file
);
81 static int snd_sb_csp_ioctl(struct snd_hwdep
* hw
, struct file
*file
, unsigned int cmd
, unsigned long arg
);
82 static int snd_sb_csp_release(struct snd_hwdep
* hw
, struct file
*file
);
84 static int csp_detect(struct snd_sb
*chip
, int *version
);
85 static int set_codec_parameter(struct snd_sb
*chip
, unsigned char par
, unsigned char val
);
86 static int set_register(struct snd_sb
*chip
, unsigned char reg
, unsigned char val
);
87 static int read_register(struct snd_sb
*chip
, unsigned char reg
);
88 static int set_mode_register(struct snd_sb
*chip
, unsigned char mode
);
89 static int get_version(struct snd_sb
*chip
);
91 static int snd_sb_csp_riff_load(struct snd_sb_csp
* p
,
92 struct snd_sb_csp_microcode __user
* code
);
93 static int snd_sb_csp_unload(struct snd_sb_csp
* p
);
94 static int snd_sb_csp_load_user(struct snd_sb_csp
* p
, const unsigned char __user
*buf
, int size
, int load_flags
);
95 static int snd_sb_csp_autoload(struct snd_sb_csp
* p
, int pcm_sfmt
, int play_rec_mode
);
96 static int snd_sb_csp_check_version(struct snd_sb_csp
* p
);
98 static int snd_sb_csp_use(struct snd_sb_csp
* p
);
99 static int snd_sb_csp_unuse(struct snd_sb_csp
* p
);
100 static int snd_sb_csp_start(struct snd_sb_csp
* p
, int sample_width
, int channels
);
101 static int snd_sb_csp_stop(struct snd_sb_csp
* p
);
102 static int snd_sb_csp_pause(struct snd_sb_csp
* p
);
103 static int snd_sb_csp_restart(struct snd_sb_csp
* p
);
105 static int snd_sb_qsound_build(struct snd_sb_csp
* p
);
106 static void snd_sb_qsound_destroy(struct snd_sb_csp
* p
);
107 static int snd_sb_csp_qsound_transfer(struct snd_sb_csp
* p
);
109 static int init_proc_entry(struct snd_sb_csp
* p
, int device
);
110 static void info_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
);
113 * Detect CSP chip and create a new instance
115 int snd_sb_csp_new(struct snd_sb
*chip
, int device
, struct snd_hwdep
** rhwdep
)
117 struct snd_sb_csp
*p
;
118 int uninitialized_var(version
);
120 struct snd_hwdep
*hw
;
125 if (csp_detect(chip
, &version
))
128 if ((err
= snd_hwdep_new(chip
->card
, "SB16-CSP", device
, &hw
)) < 0)
131 if ((p
= kzalloc(sizeof(*p
), GFP_KERNEL
)) == NULL
) {
132 snd_device_free(chip
->card
, hw
);
136 p
->version
= version
;
139 p
->ops
.csp_use
= snd_sb_csp_use
;
140 p
->ops
.csp_unuse
= snd_sb_csp_unuse
;
141 p
->ops
.csp_autoload
= snd_sb_csp_autoload
;
142 p
->ops
.csp_start
= snd_sb_csp_start
;
143 p
->ops
.csp_stop
= snd_sb_csp_stop
;
144 p
->ops
.csp_qsound_transfer
= snd_sb_csp_qsound_transfer
;
146 mutex_init(&p
->access_mutex
);
147 sprintf(hw
->name
, "CSP v%d.%d", (version
>> 4), (version
& 0x0f));
148 hw
->iface
= SNDRV_HWDEP_IFACE_SB16CSP
;
149 hw
->private_data
= p
;
150 hw
->private_free
= snd_sb_csp_free
;
152 /* operators - only write/ioctl */
153 hw
->ops
.open
= snd_sb_csp_open
;
154 hw
->ops
.ioctl
= snd_sb_csp_ioctl
;
155 hw
->ops
.release
= snd_sb_csp_release
;
157 /* create a proc entry */
158 init_proc_entry(p
, device
);
165 * free_private for hwdep instance
167 static void snd_sb_csp_free(struct snd_hwdep
*hwdep
)
170 struct snd_sb_csp
*p
= hwdep
->private_data
;
172 if (p
->running
& SNDRV_SB_CSP_ST_RUNNING
)
174 for (i
= 0; i
< ARRAY_SIZE(p
->csp_programs
); ++i
)
175 release_firmware(p
->csp_programs
[i
]);
180 /* ------------------------------ */
183 * open the device exclusively
185 static int snd_sb_csp_open(struct snd_hwdep
* hw
, struct file
*file
)
187 struct snd_sb_csp
*p
= hw
->private_data
;
188 return (snd_sb_csp_use(p
));
192 * ioctl for hwdep device:
194 static int snd_sb_csp_ioctl(struct snd_hwdep
* hw
, struct file
*file
, unsigned int cmd
, unsigned long arg
)
196 struct snd_sb_csp
*p
= hw
->private_data
;
197 struct snd_sb_csp_info info
;
198 struct snd_sb_csp_start start_info
;
204 if (snd_sb_csp_check_version(p
))
208 /* get information */
209 case SNDRV_SB_CSP_IOCTL_INFO
:
210 *info
.codec_name
= *p
->codec_name
;
211 info
.func_nr
= p
->func_nr
;
212 info
.acc_format
= p
->acc_format
;
213 info
.acc_channels
= p
->acc_channels
;
214 info
.acc_width
= p
->acc_width
;
215 info
.acc_rates
= p
->acc_rates
;
216 info
.csp_mode
= p
->mode
;
217 info
.run_channels
= p
->run_channels
;
218 info
.run_width
= p
->run_width
;
219 info
.version
= p
->version
;
220 info
.state
= p
->running
;
221 if (copy_to_user((void __user
*)arg
, &info
, sizeof(info
)))
227 /* load CSP microcode */
228 case SNDRV_SB_CSP_IOCTL_LOAD_CODE
:
229 err
= (p
->running
& SNDRV_SB_CSP_ST_RUNNING
?
230 -EBUSY
: snd_sb_csp_riff_load(p
, (struct snd_sb_csp_microcode __user
*) arg
));
232 case SNDRV_SB_CSP_IOCTL_UNLOAD_CODE
:
233 err
= (p
->running
& SNDRV_SB_CSP_ST_RUNNING
?
234 -EBUSY
: snd_sb_csp_unload(p
));
237 /* change CSP running state */
238 case SNDRV_SB_CSP_IOCTL_START
:
239 if (copy_from_user(&start_info
, (void __user
*) arg
, sizeof(start_info
)))
242 err
= snd_sb_csp_start(p
, start_info
.sample_width
, start_info
.channels
);
244 case SNDRV_SB_CSP_IOCTL_STOP
:
245 err
= snd_sb_csp_stop(p
);
247 case SNDRV_SB_CSP_IOCTL_PAUSE
:
248 err
= snd_sb_csp_pause(p
);
250 case SNDRV_SB_CSP_IOCTL_RESTART
:
251 err
= snd_sb_csp_restart(p
);
264 static int snd_sb_csp_release(struct snd_hwdep
* hw
, struct file
*file
)
266 struct snd_sb_csp
*p
= hw
->private_data
;
267 return (snd_sb_csp_unuse(p
));
270 /* ------------------------------ */
275 static int snd_sb_csp_use(struct snd_sb_csp
* p
)
277 mutex_lock(&p
->access_mutex
);
279 mutex_unlock(&p
->access_mutex
);
283 mutex_unlock(&p
->access_mutex
);
292 static int snd_sb_csp_unuse(struct snd_sb_csp
* p
)
294 mutex_lock(&p
->access_mutex
);
296 mutex_unlock(&p
->access_mutex
);
302 * load microcode via ioctl:
303 * code is user-space pointer
305 static int snd_sb_csp_riff_load(struct snd_sb_csp
* p
,
306 struct snd_sb_csp_microcode __user
* mcode
)
308 struct snd_sb_csp_mc_header info
;
310 unsigned char __user
*data_ptr
;
311 unsigned char __user
*data_end
;
312 unsigned short func_nr
= 0;
314 struct riff_header file_h
, item_h
, code_h
;
316 struct desc_header funcdesc_h
;
321 if (copy_from_user(&info
, mcode
, sizeof(info
)))
323 data_ptr
= mcode
->data
;
325 if (copy_from_user(&file_h
, data_ptr
, sizeof(file_h
)))
327 if ((file_h
.name
!= RIFF_HEADER
) ||
328 (le32_to_cpu(file_h
.len
) >= SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE
- sizeof(file_h
))) {
329 snd_printd("%s: Invalid RIFF header\n", __func__
);
332 data_ptr
+= sizeof(file_h
);
333 data_end
= data_ptr
+ le32_to_cpu(file_h
.len
);
335 if (copy_from_user(&item_type
, data_ptr
, sizeof(item_type
)))
337 if (item_type
!= CSP__HEADER
) {
338 snd_printd("%s: Invalid RIFF file type\n", __func__
);
341 data_ptr
+= sizeof (item_type
);
343 for (; data_ptr
< data_end
; data_ptr
+= le32_to_cpu(item_h
.len
)) {
344 if (copy_from_user(&item_h
, data_ptr
, sizeof(item_h
)))
346 data_ptr
+= sizeof(item_h
);
347 if (item_h
.name
!= LIST_HEADER
)
350 if (copy_from_user(&item_type
, data_ptr
, sizeof(item_type
)))
354 if (copy_from_user(&funcdesc_h
, data_ptr
+ sizeof(item_type
), sizeof(funcdesc_h
)))
356 func_nr
= le16_to_cpu(funcdesc_h
.func_nr
);
359 if (func_nr
!= info
.func_req
)
360 break; /* not required function, try next */
361 data_ptr
+= sizeof(item_type
);
363 /* destroy QSound mixer element */
364 if (p
->mode
== SNDRV_SB_CSP_MODE_QSOUND
) {
365 snd_sb_qsound_destroy(p
);
367 /* Clear all flags */
371 /* load microcode blocks */
373 if (data_ptr
>= data_end
)
375 if (copy_from_user(&code_h
, data_ptr
, sizeof(code_h
)))
378 /* init microcode blocks */
379 if (code_h
.name
!= INIT_HEADER
)
381 data_ptr
+= sizeof(code_h
);
382 err
= snd_sb_csp_load_user(p
, data_ptr
, le32_to_cpu(code_h
.len
),
383 SNDRV_SB_CSP_LOAD_INITBLOCK
);
386 data_ptr
+= le32_to_cpu(code_h
.len
);
388 /* main microcode block */
389 if (copy_from_user(&code_h
, data_ptr
, sizeof(code_h
)))
392 if (code_h
.name
!= MAIN_HEADER
) {
393 snd_printd("%s: Missing 'main' microcode\n", __func__
);
396 data_ptr
+= sizeof(code_h
);
397 err
= snd_sb_csp_load_user(p
, data_ptr
,
398 le32_to_cpu(code_h
.len
), 0);
402 /* fill in codec header */
403 strlcpy(p
->codec_name
, info
.codec_name
, sizeof(p
->codec_name
));
404 p
->func_nr
= func_nr
;
405 p
->mode
= le16_to_cpu(funcdesc_h
.flags_play_rec
);
406 switch (le16_to_cpu(funcdesc_h
.VOC_type
)) {
407 case 0x0001: /* QSound decoder */
408 if (le16_to_cpu(funcdesc_h
.flags_play_rec
) == SNDRV_SB_CSP_MODE_DSP_WRITE
) {
409 if (snd_sb_qsound_build(p
) == 0)
410 /* set QSound flag and clear all other mode flags */
411 p
->mode
= SNDRV_SB_CSP_MODE_QSOUND
;
415 case 0x0006: /* A Law codec */
416 p
->acc_format
= SNDRV_PCM_FMTBIT_A_LAW
;
418 case 0x0007: /* Mu Law codec */
419 p
->acc_format
= SNDRV_PCM_FMTBIT_MU_LAW
;
421 case 0x0011: /* what Creative thinks is IMA ADPCM codec */
422 case 0x0200: /* Creative ADPCM codec */
423 p
->acc_format
= SNDRV_PCM_FMTBIT_IMA_ADPCM
;
425 case 201: /* Text 2 Speech decoder */
426 /* TODO: Text2Speech handling routines */
429 case 0x0202: /* Fast Speech 8 codec */
430 case 0x0203: /* Fast Speech 10 codec */
431 p
->acc_format
= SNDRV_PCM_FMTBIT_SPECIAL
;
433 default: /* other codecs are unsupported */
434 p
->acc_format
= p
->acc_width
= p
->acc_rates
= 0;
436 snd_printd("%s: Unsupported CSP codec type: 0x%04x\n",
438 le16_to_cpu(funcdesc_h
.VOC_type
));
441 p
->acc_channels
= le16_to_cpu(funcdesc_h
.flags_stereo_mono
);
442 p
->acc_width
= le16_to_cpu(funcdesc_h
.flags_16bit_8bit
);
443 p
->acc_rates
= le16_to_cpu(funcdesc_h
.flags_rates
);
445 /* Decouple CSP from IRQ and DMAREQ lines */
446 spin_lock_irqsave(&p
->chip
->reg_lock
, flags
);
447 set_mode_register(p
->chip
, 0xfc);
448 set_mode_register(p
->chip
, 0x00);
449 spin_unlock_irqrestore(&p
->chip
->reg_lock
, flags
);
451 /* finished loading successfully */
452 p
->running
= SNDRV_SB_CSP_ST_LOADED
; /* set LOADED flag */
456 snd_printd("%s: Function #%d not found\n", __func__
, info
.func_req
);
461 * unload CSP microcode
463 static int snd_sb_csp_unload(struct snd_sb_csp
* p
)
465 if (p
->running
& SNDRV_SB_CSP_ST_RUNNING
)
467 if (!(p
->running
& SNDRV_SB_CSP_ST_LOADED
))
470 /* clear supported formats */
472 p
->acc_channels
= p
->acc_width
= p
->acc_rates
= 0;
473 /* destroy QSound mixer element */
474 if (p
->mode
== SNDRV_SB_CSP_MODE_QSOUND
) {
475 snd_sb_qsound_destroy(p
);
477 /* clear all flags */
484 * send command sequence to DSP
486 static inline int command_seq(struct snd_sb
*chip
, const unsigned char *seq
, int size
)
489 for (i
= 0; i
< size
; i
++) {
490 if (!snd_sbdsp_command(chip
, seq
[i
]))
497 * set CSP codec parameter
499 static int set_codec_parameter(struct snd_sb
*chip
, unsigned char par
, unsigned char val
)
501 unsigned char dsp_cmd
[3];
503 dsp_cmd
[0] = 0x05; /* CSP set codec parameter */
504 dsp_cmd
[1] = val
; /* Parameter value */
505 dsp_cmd
[2] = par
; /* Parameter */
506 command_seq(chip
, dsp_cmd
, 3);
507 snd_sbdsp_command(chip
, 0x03); /* DSP read? */
508 if (snd_sbdsp_get_byte(chip
) != par
)
516 static int set_register(struct snd_sb
*chip
, unsigned char reg
, unsigned char val
)
518 unsigned char dsp_cmd
[3];
520 dsp_cmd
[0] = 0x0e; /* CSP set register */
521 dsp_cmd
[1] = reg
; /* CSP Register */
522 dsp_cmd
[2] = val
; /* value */
523 return command_seq(chip
, dsp_cmd
, 3);
528 * return < 0 -> error
530 static int read_register(struct snd_sb
*chip
, unsigned char reg
)
532 unsigned char dsp_cmd
[2];
534 dsp_cmd
[0] = 0x0f; /* CSP read register */
535 dsp_cmd
[1] = reg
; /* CSP Register */
536 command_seq(chip
, dsp_cmd
, 2);
537 return snd_sbdsp_get_byte(chip
); /* Read DSP value */
541 * set CSP mode register
543 static int set_mode_register(struct snd_sb
*chip
, unsigned char mode
)
545 unsigned char dsp_cmd
[2];
547 dsp_cmd
[0] = 0x04; /* CSP set mode register */
548 dsp_cmd
[1] = mode
; /* mode */
549 return command_seq(chip
, dsp_cmd
, 2);
554 * return 0 if CSP exists.
556 static int csp_detect(struct snd_sb
*chip
, int *version
)
558 unsigned char csp_test1
, csp_test2
;
560 int result
= -ENODEV
;
562 spin_lock_irqsave(&chip
->reg_lock
, flags
);
564 set_codec_parameter(chip
, 0x00, 0x00);
565 set_mode_register(chip
, 0xfc); /* 0xfc = ?? */
567 csp_test1
= read_register(chip
, 0x83);
568 set_register(chip
, 0x83, ~csp_test1
);
569 csp_test2
= read_register(chip
, 0x83);
570 if (csp_test2
!= (csp_test1
^ 0xff))
573 set_register(chip
, 0x83, csp_test1
);
574 csp_test2
= read_register(chip
, 0x83);
575 if (csp_test2
!= csp_test1
)
578 set_mode_register(chip
, 0x00); /* 0x00 = ? */
580 *version
= get_version(chip
);
581 snd_sbdsp_reset(chip
); /* reset DSP after getversion! */
582 if (*version
>= 0x10 && *version
<= 0x1f)
583 result
= 0; /* valid version id */
586 spin_unlock_irqrestore(&chip
->reg_lock
, flags
);
591 * get CSP version number
593 static int get_version(struct snd_sb
*chip
)
595 unsigned char dsp_cmd
[2];
597 dsp_cmd
[0] = 0x08; /* SB_DSP_!something! */
598 dsp_cmd
[1] = 0x03; /* get chip version id? */
599 command_seq(chip
, dsp_cmd
, 2);
601 return (snd_sbdsp_get_byte(chip
));
605 * check if the CSP version is valid
607 static int snd_sb_csp_check_version(struct snd_sb_csp
* p
)
609 if (p
->version
< 0x10 || p
->version
> 0x1f) {
610 snd_printd("%s: Invalid CSP version: 0x%x\n", __func__
, p
->version
);
617 * download microcode to CSP (microcode should have one "main" block).
619 static int snd_sb_csp_load(struct snd_sb_csp
* p
, const unsigned char *buf
, int size
, int load_flags
)
626 spin_lock_irqsave(&p
->chip
->reg_lock
, flags
);
627 snd_sbdsp_command(p
->chip
, 0x01); /* CSP download command */
628 if (snd_sbdsp_get_byte(p
->chip
)) {
629 snd_printd("%s: Download command failed\n", __func__
);
632 /* Send CSP low byte (size - 1) */
633 snd_sbdsp_command(p
->chip
, (unsigned char)(size
- 1));
635 snd_sbdsp_command(p
->chip
, (unsigned char)((size
- 1) >> 8));
636 /* send microcode sequence */
637 /* load from kernel space */
639 if (!snd_sbdsp_command(p
->chip
, *buf
++))
642 if (snd_sbdsp_get_byte(p
->chip
))
645 if (load_flags
& SNDRV_SB_CSP_LOAD_INITBLOCK
) {
647 /* some codecs (FastSpeech) take some time to initialize */
649 snd_sbdsp_command(p
->chip
, 0x03);
650 status
= snd_sbdsp_get_byte(p
->chip
);
651 if (status
== 0x55 || ++i
>= 10)
655 if (status
!= 0x55) {
656 snd_printd("%s: Microcode initialization failed\n", __func__
);
661 * Read mixer register SB_DSP4_DMASETUP after loading 'main' code.
662 * Start CSP chip if no 16bit DMA channel is set - some kind
663 * of autorun or perhaps a bugfix?
665 spin_lock(&p
->chip
->mixer_lock
);
666 status
= snd_sbmixer_read(p
->chip
, SB_DSP4_DMASETUP
);
667 spin_unlock(&p
->chip
->mixer_lock
);
668 if (!(status
& (SB_DMASETUP_DMA7
| SB_DMASETUP_DMA6
| SB_DMASETUP_DMA5
))) {
669 err
= (set_codec_parameter(p
->chip
, 0xaa, 0x00) ||
670 set_codec_parameter(p
->chip
, 0xff, 0x00));
671 snd_sbdsp_reset(p
->chip
); /* really! */
674 set_mode_register(p
->chip
, 0xc0); /* c0 = STOP */
675 set_mode_register(p
->chip
, 0x70); /* 70 = RUN */
681 spin_unlock_irqrestore(&p
->chip
->reg_lock
, flags
);
685 static int snd_sb_csp_load_user(struct snd_sb_csp
* p
, const unsigned char __user
*buf
, int size
, int load_flags
)
690 kbuf
= memdup_user(buf
, size
);
692 return PTR_ERR(kbuf
);
694 err
= snd_sb_csp_load(p
, kbuf
, size
, load_flags
);
700 static int snd_sb_csp_firmware_load(struct snd_sb_csp
*p
, int index
, int flags
)
702 static const char *const names
[] = {
703 "sb16/mulaw_main.csp",
704 "sb16/alaw_main.csp",
705 "sb16/ima_adpcm_init.csp",
706 "sb16/ima_adpcm_playback.csp",
707 "sb16/ima_adpcm_capture.csp",
709 const struct firmware
*program
;
711 BUILD_BUG_ON(ARRAY_SIZE(names
) != CSP_PROGRAM_COUNT
);
712 program
= p
->csp_programs
[index
];
714 int err
= request_firmware(&program
, names
[index
],
718 p
->csp_programs
[index
] = program
;
720 return snd_sb_csp_load(p
, program
->data
, program
->size
, flags
);
724 * autoload hardware codec if necessary
725 * return 0 if CSP is loaded and ready to run (p->running != 0)
727 static int snd_sb_csp_autoload(struct snd_sb_csp
* p
, int pcm_sfmt
, int play_rec_mode
)
732 /* if CSP is running or manually loaded then exit */
733 if (p
->running
& (SNDRV_SB_CSP_ST_RUNNING
| SNDRV_SB_CSP_ST_LOADED
))
736 /* autoload microcode only if requested hardware codec is not already loaded */
737 if (((1 << pcm_sfmt
) & p
->acc_format
) && (play_rec_mode
& p
->mode
)) {
738 p
->running
= SNDRV_SB_CSP_ST_AUTO
;
741 case SNDRV_PCM_FORMAT_MU_LAW
:
742 err
= snd_sb_csp_firmware_load(p
, CSP_PROGRAM_MULAW
, 0);
743 p
->acc_format
= SNDRV_PCM_FMTBIT_MU_LAW
;
744 p
->mode
= SNDRV_SB_CSP_MODE_DSP_READ
| SNDRV_SB_CSP_MODE_DSP_WRITE
;
746 case SNDRV_PCM_FORMAT_A_LAW
:
747 err
= snd_sb_csp_firmware_load(p
, CSP_PROGRAM_ALAW
, 0);
748 p
->acc_format
= SNDRV_PCM_FMTBIT_A_LAW
;
749 p
->mode
= SNDRV_SB_CSP_MODE_DSP_READ
| SNDRV_SB_CSP_MODE_DSP_WRITE
;
751 case SNDRV_PCM_FORMAT_IMA_ADPCM
:
752 err
= snd_sb_csp_firmware_load(p
, CSP_PROGRAM_ADPCM_INIT
,
753 SNDRV_SB_CSP_LOAD_INITBLOCK
);
756 if (play_rec_mode
== SNDRV_SB_CSP_MODE_DSP_WRITE
) {
757 err
= snd_sb_csp_firmware_load
758 (p
, CSP_PROGRAM_ADPCM_PLAYBACK
, 0);
759 p
->mode
= SNDRV_SB_CSP_MODE_DSP_WRITE
;
761 err
= snd_sb_csp_firmware_load
762 (p
, CSP_PROGRAM_ADPCM_CAPTURE
, 0);
763 p
->mode
= SNDRV_SB_CSP_MODE_DSP_READ
;
765 p
->acc_format
= SNDRV_PCM_FMTBIT_IMA_ADPCM
;
768 /* Decouple CSP from IRQ and DMAREQ lines */
769 if (p
->running
& SNDRV_SB_CSP_ST_AUTO
) {
770 spin_lock_irqsave(&p
->chip
->reg_lock
, flags
);
771 set_mode_register(p
->chip
, 0xfc);
772 set_mode_register(p
->chip
, 0x00);
773 spin_unlock_irqrestore(&p
->chip
->reg_lock
, flags
);
774 p
->running
= 0; /* clear autoloaded flag */
780 p
->acc_channels
= p
->acc_width
= p
->acc_rates
= 0;
782 p
->running
= 0; /* clear autoloaded flag */
786 p
->running
= SNDRV_SB_CSP_ST_AUTO
; /* set autoloaded flag */
787 p
->acc_width
= SNDRV_SB_CSP_SAMPLE_16BIT
; /* only 16 bit data */
788 p
->acc_channels
= SNDRV_SB_CSP_MONO
| SNDRV_SB_CSP_STEREO
;
789 p
->acc_rates
= SNDRV_SB_CSP_RATE_ALL
; /* HW codecs accept all rates */
793 return (p
->running
& SNDRV_SB_CSP_ST_AUTO
) ? 0 : -ENXIO
;
799 static int snd_sb_csp_start(struct snd_sb_csp
* p
, int sample_width
, int channels
)
801 unsigned char s_type
; /* sample type */
802 unsigned char mixL
, mixR
;
806 if (!(p
->running
& (SNDRV_SB_CSP_ST_LOADED
| SNDRV_SB_CSP_ST_AUTO
))) {
807 snd_printd("%s: Microcode not loaded\n", __func__
);
810 if (p
->running
& SNDRV_SB_CSP_ST_RUNNING
) {
811 snd_printd("%s: CSP already running\n", __func__
);
814 if (!(sample_width
& p
->acc_width
)) {
815 snd_printd("%s: Unsupported PCM sample width\n", __func__
);
818 if (!(channels
& p
->acc_channels
)) {
819 snd_printd("%s: Invalid number of channels\n", __func__
);
823 /* Mute PCM volume */
824 spin_lock_irqsave(&p
->chip
->mixer_lock
, flags
);
825 mixL
= snd_sbmixer_read(p
->chip
, SB_DSP4_PCM_DEV
);
826 mixR
= snd_sbmixer_read(p
->chip
, SB_DSP4_PCM_DEV
+ 1);
827 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
, mixL
& 0x7);
828 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
+ 1, mixR
& 0x7);
830 spin_lock(&p
->chip
->reg_lock
);
831 set_mode_register(p
->chip
, 0xc0); /* c0 = STOP */
832 set_mode_register(p
->chip
, 0x70); /* 70 = RUN */
835 if (channels
== SNDRV_SB_CSP_MONO
)
836 s_type
= 0x11; /* 000n 000n (n = 1 if mono) */
837 if (sample_width
== SNDRV_SB_CSP_SAMPLE_8BIT
)
838 s_type
|= 0x22; /* 00dX 00dX (d = 1 if 8 bit samples) */
840 if (set_codec_parameter(p
->chip
, 0x81, s_type
)) {
841 snd_printd("%s: Set sample type command failed\n", __func__
);
844 if (set_codec_parameter(p
->chip
, 0x80, 0x00)) {
845 snd_printd("%s: Codec start command failed\n", __func__
);
848 p
->run_width
= sample_width
;
849 p
->run_channels
= channels
;
851 p
->running
|= SNDRV_SB_CSP_ST_RUNNING
;
853 if (p
->mode
& SNDRV_SB_CSP_MODE_QSOUND
) {
854 set_codec_parameter(p
->chip
, 0xe0, 0x01);
855 /* enable QSound decoder */
856 set_codec_parameter(p
->chip
, 0x00, 0xff);
857 set_codec_parameter(p
->chip
, 0x01, 0xff);
858 p
->running
|= SNDRV_SB_CSP_ST_QSOUND
;
859 /* set QSound startup value */
860 snd_sb_csp_qsound_transfer(p
);
865 spin_unlock(&p
->chip
->reg_lock
);
867 /* restore PCM volume */
868 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
, mixL
);
869 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
+ 1, mixR
);
870 spin_unlock_irqrestore(&p
->chip
->mixer_lock
, flags
);
878 static int snd_sb_csp_stop(struct snd_sb_csp
* p
)
881 unsigned char mixL
, mixR
;
884 if (!(p
->running
& SNDRV_SB_CSP_ST_RUNNING
))
887 /* Mute PCM volume */
888 spin_lock_irqsave(&p
->chip
->mixer_lock
, flags
);
889 mixL
= snd_sbmixer_read(p
->chip
, SB_DSP4_PCM_DEV
);
890 mixR
= snd_sbmixer_read(p
->chip
, SB_DSP4_PCM_DEV
+ 1);
891 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
, mixL
& 0x7);
892 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
+ 1, mixR
& 0x7);
894 spin_lock(&p
->chip
->reg_lock
);
895 if (p
->running
& SNDRV_SB_CSP_ST_QSOUND
) {
896 set_codec_parameter(p
->chip
, 0xe0, 0x01);
897 /* disable QSound decoder */
898 set_codec_parameter(p
->chip
, 0x00, 0x00);
899 set_codec_parameter(p
->chip
, 0x01, 0x00);
901 p
->running
&= ~SNDRV_SB_CSP_ST_QSOUND
;
903 result
= set_mode_register(p
->chip
, 0xc0); /* c0 = STOP */
904 spin_unlock(&p
->chip
->reg_lock
);
906 /* restore PCM volume */
907 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
, mixL
);
908 snd_sbmixer_write(p
->chip
, SB_DSP4_PCM_DEV
+ 1, mixR
);
909 spin_unlock_irqrestore(&p
->chip
->mixer_lock
, flags
);
912 p
->running
&= ~(SNDRV_SB_CSP_ST_PAUSED
| SNDRV_SB_CSP_ST_RUNNING
);
917 * pause CSP codec and hold DMA transfer
919 static int snd_sb_csp_pause(struct snd_sb_csp
* p
)
924 if (!(p
->running
& SNDRV_SB_CSP_ST_RUNNING
))
927 spin_lock_irqsave(&p
->chip
->reg_lock
, flags
);
928 result
= set_codec_parameter(p
->chip
, 0x80, 0xff);
929 spin_unlock_irqrestore(&p
->chip
->reg_lock
, flags
);
931 p
->running
|= SNDRV_SB_CSP_ST_PAUSED
;
937 * restart CSP codec and resume DMA transfer
939 static int snd_sb_csp_restart(struct snd_sb_csp
* p
)
944 if (!(p
->running
& SNDRV_SB_CSP_ST_PAUSED
))
947 spin_lock_irqsave(&p
->chip
->reg_lock
, flags
);
948 result
= set_codec_parameter(p
->chip
, 0x80, 0x00);
949 spin_unlock_irqrestore(&p
->chip
->reg_lock
, flags
);
951 p
->running
&= ~SNDRV_SB_CSP_ST_PAUSED
;
956 /* ------------------------------ */
959 * QSound mixer control for PCM
962 #define snd_sb_qsound_switch_info snd_ctl_boolean_mono_info
964 static int snd_sb_qsound_switch_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
966 struct snd_sb_csp
*p
= snd_kcontrol_chip(kcontrol
);
968 ucontrol
->value
.integer
.value
[0] = p
->q_enabled
? 1 : 0;
972 static int snd_sb_qsound_switch_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
974 struct snd_sb_csp
*p
= snd_kcontrol_chip(kcontrol
);
979 nval
= ucontrol
->value
.integer
.value
[0] & 0x01;
980 spin_lock_irqsave(&p
->q_lock
, flags
);
981 change
= p
->q_enabled
!= nval
;
983 spin_unlock_irqrestore(&p
->q_lock
, flags
);
987 static int snd_sb_qsound_space_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
989 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
991 uinfo
->value
.integer
.min
= 0;
992 uinfo
->value
.integer
.max
= SNDRV_SB_CSP_QSOUND_MAX_RIGHT
;
996 static int snd_sb_qsound_space_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
998 struct snd_sb_csp
*p
= snd_kcontrol_chip(kcontrol
);
1001 spin_lock_irqsave(&p
->q_lock
, flags
);
1002 ucontrol
->value
.integer
.value
[0] = p
->qpos_left
;
1003 ucontrol
->value
.integer
.value
[1] = p
->qpos_right
;
1004 spin_unlock_irqrestore(&p
->q_lock
, flags
);
1008 static int snd_sb_qsound_space_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1010 struct snd_sb_csp
*p
= snd_kcontrol_chip(kcontrol
);
1011 unsigned long flags
;
1013 unsigned char nval1
, nval2
;
1015 nval1
= ucontrol
->value
.integer
.value
[0];
1016 if (nval1
> SNDRV_SB_CSP_QSOUND_MAX_RIGHT
)
1017 nval1
= SNDRV_SB_CSP_QSOUND_MAX_RIGHT
;
1018 nval2
= ucontrol
->value
.integer
.value
[1];
1019 if (nval2
> SNDRV_SB_CSP_QSOUND_MAX_RIGHT
)
1020 nval2
= SNDRV_SB_CSP_QSOUND_MAX_RIGHT
;
1021 spin_lock_irqsave(&p
->q_lock
, flags
);
1022 change
= p
->qpos_left
!= nval1
|| p
->qpos_right
!= nval2
;
1023 p
->qpos_left
= nval1
;
1024 p
->qpos_right
= nval2
;
1025 p
->qpos_changed
= change
;
1026 spin_unlock_irqrestore(&p
->q_lock
, flags
);
1030 static struct snd_kcontrol_new snd_sb_qsound_switch
= {
1031 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1032 .name
= "3D Control - Switch",
1033 .info
= snd_sb_qsound_switch_info
,
1034 .get
= snd_sb_qsound_switch_get
,
1035 .put
= snd_sb_qsound_switch_put
1038 static struct snd_kcontrol_new snd_sb_qsound_space
= {
1039 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1040 .name
= "3D Control - Space",
1041 .info
= snd_sb_qsound_space_info
,
1042 .get
= snd_sb_qsound_space_get
,
1043 .put
= snd_sb_qsound_space_put
1046 static int snd_sb_qsound_build(struct snd_sb_csp
* p
)
1048 struct snd_card
*card
;
1054 card
= p
->chip
->card
;
1055 p
->qpos_left
= p
->qpos_right
= SNDRV_SB_CSP_QSOUND_MAX_RIGHT
/ 2;
1056 p
->qpos_changed
= 0;
1058 spin_lock_init(&p
->q_lock
);
1060 if ((err
= snd_ctl_add(card
, p
->qsound_switch
= snd_ctl_new1(&snd_sb_qsound_switch
, p
))) < 0)
1062 if ((err
= snd_ctl_add(card
, p
->qsound_space
= snd_ctl_new1(&snd_sb_qsound_space
, p
))) < 0)
1068 snd_sb_qsound_destroy(p
);
1072 static void snd_sb_qsound_destroy(struct snd_sb_csp
* p
)
1074 struct snd_card
*card
;
1075 unsigned long flags
;
1080 card
= p
->chip
->card
;
1082 down_write(&card
->controls_rwsem
);
1083 if (p
->qsound_switch
)
1084 snd_ctl_remove(card
, p
->qsound_switch
);
1085 if (p
->qsound_space
)
1086 snd_ctl_remove(card
, p
->qsound_space
);
1087 up_write(&card
->controls_rwsem
);
1089 /* cancel pending transfer of QSound parameters */
1090 spin_lock_irqsave (&p
->q_lock
, flags
);
1091 p
->qpos_changed
= 0;
1092 spin_unlock_irqrestore (&p
->q_lock
, flags
);
1096 * Transfer qsound parameters to CSP,
1097 * function should be called from interrupt routine
1099 static int snd_sb_csp_qsound_transfer(struct snd_sb_csp
* p
)
1103 spin_lock(&p
->q_lock
);
1104 if (p
->running
& SNDRV_SB_CSP_ST_QSOUND
) {
1105 set_codec_parameter(p
->chip
, 0xe0, 0x01);
1107 set_codec_parameter(p
->chip
, 0x00, p
->qpos_left
);
1108 set_codec_parameter(p
->chip
, 0x02, 0x00);
1110 set_codec_parameter(p
->chip
, 0x00, p
->qpos_right
);
1111 set_codec_parameter(p
->chip
, 0x03, 0x00);
1114 p
->qpos_changed
= 0;
1115 spin_unlock(&p
->q_lock
);
1119 /* ------------------------------ */
1124 static int init_proc_entry(struct snd_sb_csp
* p
, int device
)
1127 struct snd_info_entry
*entry
;
1128 sprintf(name
, "cspD%d", device
);
1129 if (! snd_card_proc_new(p
->chip
->card
, name
, &entry
))
1130 snd_info_set_text_ops(entry
, p
, info_read
);
1134 static void info_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
1136 struct snd_sb_csp
*p
= entry
->private_data
;
1138 snd_iprintf(buffer
, "Creative Signal Processor [v%d.%d]\n", (p
->version
>> 4), (p
->version
& 0x0f));
1139 snd_iprintf(buffer
, "State: %cx%c%c%c\n", ((p
->running
& SNDRV_SB_CSP_ST_QSOUND
) ? 'Q' : '-'),
1140 ((p
->running
& SNDRV_SB_CSP_ST_PAUSED
) ? 'P' : '-'),
1141 ((p
->running
& SNDRV_SB_CSP_ST_RUNNING
) ? 'R' : '-'),
1142 ((p
->running
& SNDRV_SB_CSP_ST_LOADED
) ? 'L' : '-'));
1143 if (p
->running
& SNDRV_SB_CSP_ST_LOADED
) {
1144 snd_iprintf(buffer
, "Codec: %s [func #%d]\n", p
->codec_name
, p
->func_nr
);
1145 snd_iprintf(buffer
, "Sample rates: ");
1146 if (p
->acc_rates
== SNDRV_SB_CSP_RATE_ALL
) {
1147 snd_iprintf(buffer
, "All\n");
1149 snd_iprintf(buffer
, "%s%s%s%s\n",
1150 ((p
->acc_rates
& SNDRV_SB_CSP_RATE_8000
) ? "8000Hz " : ""),
1151 ((p
->acc_rates
& SNDRV_SB_CSP_RATE_11025
) ? "11025Hz " : ""),
1152 ((p
->acc_rates
& SNDRV_SB_CSP_RATE_22050
) ? "22050Hz " : ""),
1153 ((p
->acc_rates
& SNDRV_SB_CSP_RATE_44100
) ? "44100Hz" : ""));
1155 if (p
->mode
== SNDRV_SB_CSP_MODE_QSOUND
) {
1156 snd_iprintf(buffer
, "QSound decoder %sabled\n",
1157 p
->q_enabled
? "en" : "dis");
1159 snd_iprintf(buffer
, "PCM format ID: 0x%x (%s/%s) [%s/%s] [%s/%s]\n",
1161 ((p
->acc_width
& SNDRV_SB_CSP_SAMPLE_16BIT
) ? "16bit" : "-"),
1162 ((p
->acc_width
& SNDRV_SB_CSP_SAMPLE_8BIT
) ? "8bit" : "-"),
1163 ((p
->acc_channels
& SNDRV_SB_CSP_MONO
) ? "mono" : "-"),
1164 ((p
->acc_channels
& SNDRV_SB_CSP_STEREO
) ? "stereo" : "-"),
1165 ((p
->mode
& SNDRV_SB_CSP_MODE_DSP_WRITE
) ? "playback" : "-"),
1166 ((p
->mode
& SNDRV_SB_CSP_MODE_DSP_READ
) ? "capture" : "-"));
1169 if (p
->running
& SNDRV_SB_CSP_ST_AUTO
) {
1170 snd_iprintf(buffer
, "Autoloaded Mu-Law, A-Law or Ima-ADPCM hardware codec\n");
1172 if (p
->running
& SNDRV_SB_CSP_ST_RUNNING
) {
1173 snd_iprintf(buffer
, "Processing %dbit %s PCM samples\n",
1174 ((p
->run_width
& SNDRV_SB_CSP_SAMPLE_16BIT
) ? 16 : 8),
1175 ((p
->run_channels
& SNDRV_SB_CSP_MONO
) ? "mono" : "stereo"));
1177 if (p
->running
& SNDRV_SB_CSP_ST_QSOUND
) {
1178 snd_iprintf(buffer
, "Qsound position: left = 0x%x, right = 0x%x\n",
1179 p
->qpos_left
, p
->qpos_right
);
1185 EXPORT_SYMBOL(snd_sb_csp_new
);
1191 static int __init
alsa_sb_csp_init(void)
1196 static void __exit
alsa_sb_csp_exit(void)
1200 module_init(alsa_sb_csp_init
)
1201 module_exit(alsa_sb_csp_exit
)