blob: 7e950560e5912dc8e1b20dc58b31c795fb94d6e5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_SB16_CSP_H
2#define __SOUND_SB16_CSP_H
3
4/*
5 * Copyright (c) 1999 by Uros Bizjak <uros@kss-loka.si>
6 * Takashi Iwai <tiwai@suse.de>
7 *
8 * SB16ASP/AWE32 CSP control
9 *
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.
14 *
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.
19 *
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
23 *
24 */
25
26/* CSP modes */
27#define SNDRV_SB_CSP_MODE_NONE 0x00
28#define SNDRV_SB_CSP_MODE_DSP_READ 0x01 /* Record from DSP */
29#define SNDRV_SB_CSP_MODE_DSP_WRITE 0x02 /* Play to DSP */
30#define SNDRV_SB_CSP_MODE_QSOUND 0x04 /* QSound */
31
32/* CSP load flags */
33#define SNDRV_SB_CSP_LOAD_FROMUSER 0x01
34#define SNDRV_SB_CSP_LOAD_INITBLOCK 0x02
35
36/* CSP sample width */
37#define SNDRV_SB_CSP_SAMPLE_8BIT 0x01
38#define SNDRV_SB_CSP_SAMPLE_16BIT 0x02
39
40/* CSP channels */
41#define SNDRV_SB_CSP_MONO 0x01
42#define SNDRV_SB_CSP_STEREO 0x02
43
44/* CSP rates */
45#define SNDRV_SB_CSP_RATE_8000 0x01
46#define SNDRV_SB_CSP_RATE_11025 0x02
47#define SNDRV_SB_CSP_RATE_22050 0x04
48#define SNDRV_SB_CSP_RATE_44100 0x08
49#define SNDRV_SB_CSP_RATE_ALL 0x0f
50
51/* CSP running state */
52#define SNDRV_SB_CSP_ST_IDLE 0x00
53#define SNDRV_SB_CSP_ST_LOADED 0x01
54#define SNDRV_SB_CSP_ST_RUNNING 0x02
55#define SNDRV_SB_CSP_ST_PAUSED 0x04
56#define SNDRV_SB_CSP_ST_AUTO 0x08
57#define SNDRV_SB_CSP_ST_QSOUND 0x10
58
59/* maximum QSound value (180 degrees right) */
60#define SNDRV_SB_CSP_QSOUND_MAX_RIGHT 0x20
61
62/* maximum microcode RIFF file size */
63#define SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE 0x3000
64
65/* microcode header */
Takashi Iwai029d64b2005-11-17 14:34:36 +010066struct snd_sb_csp_mc_header {
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 char codec_name[16]; /* id name of codec */
68 unsigned short func_req; /* requested function */
Takashi Iwai029d64b2005-11-17 14:34:36 +010069};
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71/* microcode to be loaded */
Takashi Iwai029d64b2005-11-17 14:34:36 +010072struct snd_sb_csp_microcode {
73 struct snd_sb_csp_mc_header info;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 unsigned char data[SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE];
Takashi Iwai029d64b2005-11-17 14:34:36 +010075};
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77/* start CSP with sample_width in mono/stereo */
Takashi Iwai029d64b2005-11-17 14:34:36 +010078struct snd_sb_csp_start {
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 int sample_width; /* sample width, look above */
80 int channels; /* channels, look above */
Takashi Iwai029d64b2005-11-17 14:34:36 +010081};
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83/* CSP information */
Takashi Iwai029d64b2005-11-17 14:34:36 +010084struct snd_sb_csp_info {
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 char codec_name[16]; /* id name of codec */
86 unsigned short func_nr; /* function number */
87 unsigned int acc_format; /* accepted PCM formats */
88 unsigned short acc_channels; /* accepted channels */
89 unsigned short acc_width; /* accepted sample width */
90 unsigned short acc_rates; /* accepted sample rates */
91 unsigned short csp_mode; /* CSP mode, see above */
92 unsigned short run_channels; /* current channels */
93 unsigned short run_width; /* current sample width */
94 unsigned short version; /* version id: 0x10 - 0x1f */
95 unsigned short state; /* state bits */
Takashi Iwai029d64b2005-11-17 14:34:36 +010096};
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98/* HWDEP controls */
99/* get CSP information */
Takashi Iwai029d64b2005-11-17 14:34:36 +0100100#define SNDRV_SB_CSP_IOCTL_INFO _IOR('H', 0x10, struct snd_sb_csp_info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101/* load microcode to CSP */
Takashi Iwai4f3c7a12011-06-30 15:08:04 +0200102/* NOTE: struct snd_sb_csp_microcode overflows the max size (13 bits)
103 * defined for some architectures like MIPS, and it leads to build errors.
104 * (x86 and co have 14-bit size, thus it's valid, though.)
105 * As a workaround for skipping the size-limit check, here we don't use the
106 * normal _IOW() macro but _IOC() with the manual argument.
107 */
108#define SNDRV_SB_CSP_IOCTL_LOAD_CODE \
109 _IOC(_IOC_WRITE, 'H', 0x11, sizeof(struct snd_sb_csp_microcode))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110/* unload microcode from CSP */
111#define SNDRV_SB_CSP_IOCTL_UNLOAD_CODE _IO('H', 0x12)
112/* start CSP */
Takashi Iwai029d64b2005-11-17 14:34:36 +0100113#define SNDRV_SB_CSP_IOCTL_START _IOW('H', 0x13, struct snd_sb_csp_start)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/* stop CSP */
115#define SNDRV_SB_CSP_IOCTL_STOP _IO('H', 0x14)
116/* pause CSP and DMA transfer */
117#define SNDRV_SB_CSP_IOCTL_PAUSE _IO('H', 0x15)
118/* restart CSP and DMA transfer */
119#define SNDRV_SB_CSP_IOCTL_RESTART _IO('H', 0x16)
120
121#ifdef __KERNEL__
David Howellsa1ce3922012-10-02 18:01:25 +0100122#include <sound/sb.h>
123#include <sound/hwdep.h>
Clemens Ladischde66d532006-11-06 09:18:34 +0100124#include <linux/firmware.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Takashi Iwai029d64b2005-11-17 14:34:36 +0100126struct snd_sb_csp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Clemens Ladischde66d532006-11-06 09:18:34 +0100128/* indices for the known CSP programs */
129enum {
130 CSP_PROGRAM_MULAW,
131 CSP_PROGRAM_ALAW,
132 CSP_PROGRAM_ADPCM_INIT,
133 CSP_PROGRAM_ADPCM_PLAYBACK,
134 CSP_PROGRAM_ADPCM_CAPTURE,
135
136 CSP_PROGRAM_COUNT
137};
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139/*
140 * CSP operators
141 */
Takashi Iwai029d64b2005-11-17 14:34:36 +0100142struct snd_sb_csp_ops {
143 int (*csp_use) (struct snd_sb_csp * p);
144 int (*csp_unuse) (struct snd_sb_csp * p);
145 int (*csp_autoload) (struct snd_sb_csp * p, int pcm_sfmt, int play_rec_mode);
146 int (*csp_start) (struct snd_sb_csp * p, int sample_width, int channels);
147 int (*csp_stop) (struct snd_sb_csp * p);
148 int (*csp_qsound_transfer) (struct snd_sb_csp * p);
149};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151/*
152 * CSP private data
153 */
154struct snd_sb_csp {
Takashi Iwai029d64b2005-11-17 14:34:36 +0100155 struct snd_sb *chip; /* SB16 DSP */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 int used; /* usage flag - exclusive */
157 char codec_name[16]; /* name of codec */
158 unsigned short func_nr; /* function number */
159 unsigned int acc_format; /* accepted PCM formats */
160 int acc_channels; /* accepted channels */
161 int acc_width; /* accepted sample width */
162 int acc_rates; /* accepted sample rates */
163 int mode; /* MODE */
164 int run_channels; /* current CSP channels */
165 int run_width; /* current sample width */
166 int version; /* CSP version (0x10 - 0x1f) */
167 int running; /* running state */
168
Takashi Iwai029d64b2005-11-17 14:34:36 +0100169 struct snd_sb_csp_ops ops; /* operators */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 spinlock_t q_lock; /* locking */
172 int q_enabled; /* enabled flag */
173 int qpos_left; /* left position */
174 int qpos_right; /* right position */
175 int qpos_changed; /* position changed flag */
176
Takashi Iwai029d64b2005-11-17 14:34:36 +0100177 struct snd_kcontrol *qsound_switch;
178 struct snd_kcontrol *qsound_space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Ingo Molnar8b7547f2006-01-16 16:33:08 +0100180 struct mutex access_mutex; /* locking */
Clemens Ladischde66d532006-11-06 09:18:34 +0100181
182 const struct firmware *csp_programs[CSP_PROGRAM_COUNT];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183};
184
Takashi Iwai029d64b2005-11-17 14:34:36 +0100185int snd_sb_csp_new(struct snd_sb *chip, int device, struct snd_hwdep ** rhwdep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186#endif
187
188#endif /* __SOUND_SB16_CSP */