ac6a5d8820888c1926c92c052c74add01c3f30a3
[linux-2.6.git] / include / sound / cs4231.h
1 #ifndef __SOUND_CS4231_H
2 #define __SOUND_CS4231_H
3
4 /*
5  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
6  *  Definitions for CS4231 & InterWave chips & compatible chips
7  *
8  *
9  *   This program is free software; you can redistribute it and/or modify
10  *   it under the terms of the GNU General Public License as published by
11  *   the Free Software Foundation; either version 2 of the License, or
12  *   (at your option) any later version.
13  *
14  *   This program is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with this program; if not, write to the Free Software
21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22  *
23  */
24
25 #include "control.h"
26 #include "pcm.h"
27 #include "timer.h"
28
29 /* IO ports */
30
31 #define CS4231P(x)              (c_d_c_CS4231##x)
32
33 #define c_d_c_CS4231REGSEL      0
34 #define c_d_c_CS4231REG         1
35 #define c_d_c_CS4231STATUS      2
36 #define c_d_c_CS4231PIO         3
37
38 /* codec registers */
39
40 #define CS4231_LEFT_INPUT       0x00    /* left input control */
41 #define CS4231_RIGHT_INPUT      0x01    /* right input control */
42 #define CS4231_AUX1_LEFT_INPUT  0x02    /* left AUX1 input control */
43 #define CS4231_AUX1_RIGHT_INPUT 0x03    /* right AUX1 input control */
44 #define CS4231_AUX2_LEFT_INPUT  0x04    /* left AUX2 input control */
45 #define CS4231_AUX2_RIGHT_INPUT 0x05    /* right AUX2 input control */
46 #define CS4231_LEFT_OUTPUT      0x06    /* left output control register */
47 #define CS4231_RIGHT_OUTPUT     0x07    /* right output control register */
48 #define CS4231_PLAYBK_FORMAT    0x08    /* clock and data format - playback - bits 7-0 MCE */
49 #define CS4231_IFACE_CTRL       0x09    /* interface control - bits 7-2 MCE */
50 #define CS4231_PIN_CTRL         0x0a    /* pin control */
51 #define CS4231_TEST_INIT        0x0b    /* test and initialization */
52 #define CS4231_MISC_INFO        0x0c    /* miscellaneaous information */
53 #define CS4231_LOOPBACK         0x0d    /* loopback control */
54 #define CS4231_PLY_UPR_CNT      0x0e    /* playback upper base count */
55 #define CS4231_PLY_LWR_CNT      0x0f    /* playback lower base count */
56 #define CS4231_ALT_FEATURE_1    0x10    /* alternate #1 feature enable */
57 #define AD1845_AF1_MIC_LEFT     0x10    /* alternate #1 feature + MIC left */
58 #define CS4231_ALT_FEATURE_2    0x11    /* alternate #2 feature enable */
59 #define AD1845_AF2_MIC_RIGHT    0x11    /* alternate #2 feature + MIC right */
60 #define CS4231_LEFT_LINE_IN     0x12    /* left line input control */
61 #define CS4231_RIGHT_LINE_IN    0x13    /* right line input control */
62 #define CS4231_TIMER_LOW        0x14    /* timer low byte */
63 #define CS4231_TIMER_HIGH       0x15    /* timer high byte */
64 #define CS4231_LEFT_MIC_INPUT   0x16    /* left MIC input control register (InterWave only) */
65 #define AD1845_UPR_FREQ_SEL     0x16    /* upper byte of frequency select */
66 #define CS4231_RIGHT_MIC_INPUT  0x17    /* right MIC input control register (InterWave only) */
67 #define AD1845_LWR_FREQ_SEL     0x17    /* lower byte of frequency select */
68 #define CS4236_EXT_REG          0x17    /* extended register access */
69 #define CS4231_IRQ_STATUS       0x18    /* irq status register */
70 #define CS4231_LINE_LEFT_OUTPUT 0x19    /* left line output control register (InterWave only) */
71 #define CS4231_VERSION          0x19    /* CS4231(A) - version values */
72 #define CS4231_MONO_CTRL        0x1a    /* mono input/output control */
73 #define CS4231_LINE_RIGHT_OUTPUT 0x1b   /* right line output control register (InterWave only) */
74 #define AD1845_PWR_DOWN         0x1b    /* power down control */
75 #define CS4235_LEFT_MASTER      0x1b    /* left master output control */
76 #define CS4231_REC_FORMAT       0x1c    /* clock and data format - record - bits 7-0 MCE */
77 #define CS4231_PLY_VAR_FREQ     0x1d    /* playback variable frequency */
78 #define AD1845_CLOCK            0x1d    /* crystal clock select and total power down */
79 #define CS4235_RIGHT_MASTER     0x1d    /* right master output control */
80 #define CS4231_REC_UPR_CNT      0x1e    /* record upper count */
81 #define CS4231_REC_LWR_CNT      0x1f    /* record lower count */
82
83 /* definitions for codec register select port - CODECP( REGSEL ) */
84
85 #define CS4231_INIT             0x80    /* CODEC is initializing */
86 #define CS4231_MCE              0x40    /* mode change enable */
87 #define CS4231_TRD              0x20    /* transfer request disable */
88
89 /* definitions for codec status register - CODECP( STATUS ) */
90
91 #define CS4231_GLOBALIRQ        0x01    /* IRQ is active */
92
93 /* definitions for codec irq status */
94
95 #define CS4231_PLAYBACK_IRQ     0x10
96 #define CS4231_RECORD_IRQ       0x20
97 #define CS4231_TIMER_IRQ        0x40
98 #define CS4231_ALL_IRQS         0x70
99 #define CS4231_REC_UNDERRUN     0x08
100 #define CS4231_REC_OVERRUN      0x04
101 #define CS4231_PLY_OVERRUN      0x02
102 #define CS4231_PLY_UNDERRUN     0x01
103
104 /* definitions for CS4231_LEFT_INPUT and CS4231_RIGHT_INPUT registers */
105
106 #define CS4231_ENABLE_MIC_GAIN  0x20
107
108 #define CS4231_MIXS_LINE        0x00
109 #define CS4231_MIXS_AUX1        0x40
110 #define CS4231_MIXS_MIC         0x80
111 #define CS4231_MIXS_ALL         0xc0
112
113 /* definitions for clock and data format register - CS4231_PLAYBK_FORMAT */
114
115 #define CS4231_LINEAR_8         0x00    /* 8-bit unsigned data */
116 #define CS4231_ALAW_8           0x60    /* 8-bit A-law companded */
117 #define CS4231_ULAW_8           0x20    /* 8-bit U-law companded */
118 #define CS4231_LINEAR_16        0x40    /* 16-bit twos complement data - little endian */
119 #define CS4231_LINEAR_16_BIG    0xc0    /* 16-bit twos complement data - big endian */
120 #define CS4231_ADPCM_16         0xa0    /* 16-bit ADPCM */
121 #define CS4231_STEREO           0x10    /* stereo mode */
122 /* bits 3-1 define frequency divisor */
123 #define CS4231_XTAL1            0x00    /* 24.576 crystal */
124 #define CS4231_XTAL2            0x01    /* 16.9344 crystal */
125
126 /* definitions for interface control register - CS4231_IFACE_CTRL */
127
128 #define CS4231_RECORD_PIO       0x80    /* record PIO enable */
129 #define CS4231_PLAYBACK_PIO     0x40    /* playback PIO enable */
130 #define CS4231_CALIB_MODE       0x18    /* calibration mode bits */
131 #define CS4231_AUTOCALIB        0x08    /* auto calibrate */
132 #define CS4231_SINGLE_DMA       0x04    /* use single DMA channel */
133 #define CS4231_RECORD_ENABLE    0x02    /* record enable */
134 #define CS4231_PLAYBACK_ENABLE  0x01    /* playback enable */
135
136 /* definitions for pin control register - CS4231_PIN_CTRL */
137
138 #define CS4231_IRQ_ENABLE       0x02    /* enable IRQ */
139 #define CS4231_XCTL1            0x40    /* external control #1 */
140 #define CS4231_XCTL0            0x80    /* external control #0 */
141
142 /* definitions for test and init register - CS4231_TEST_INIT */
143
144 #define CS4231_CALIB_IN_PROGRESS 0x20   /* auto calibrate in progress */
145 #define CS4231_DMA_REQUEST      0x10    /* DMA request in progress */
146
147 /* definitions for misc control register - CS4231_MISC_INFO */
148
149 #define CS4231_MODE2            0x40    /* MODE 2 */
150 #define CS4231_IW_MODE3         0x6c    /* MODE 3 - InterWave enhanced mode */
151 #define CS4231_4236_MODE3       0xe0    /* MODE 3 - CS4236+ enhanced mode */
152
153 /* definitions for alternate feature 1 register - CS4231_ALT_FEATURE_1 */
154
155 #define CS4231_DACZ             0x01    /* zero DAC when underrun */
156 #define CS4231_TIMER_ENABLE     0x40    /* codec timer enable */
157 #define CS4231_OLB              0x80    /* output level bit */
158
159 /* definitions for Extended Registers - CS4236+ */
160
161 #define CS4236_REG(i23val)      (((i23val << 2) & 0x10) | ((i23val >> 4) & 0x0f))
162 #define CS4236_I23VAL(reg)      ((((reg)&0xf) << 4) | (((reg)&0x10) >> 2) | 0x8)
163
164 #define CS4236_LEFT_LINE        0x08    /* left LINE alternate volume */
165 #define CS4236_RIGHT_LINE       0x18    /* right LINE alternate volume */
166 #define CS4236_LEFT_MIC         0x28    /* left MIC volume */
167 #define CS4236_RIGHT_MIC        0x38    /* right MIC volume */
168 #define CS4236_LEFT_MIX_CTRL    0x48    /* synthesis and left input mixer control */
169 #define CS4236_RIGHT_MIX_CTRL   0x58    /* right input mixer control */
170 #define CS4236_LEFT_FM          0x68    /* left FM volume */
171 #define CS4236_RIGHT_FM         0x78    /* right FM volume */
172 #define CS4236_LEFT_DSP         0x88    /* left DSP serial port volume */
173 #define CS4236_RIGHT_DSP        0x98    /* right DSP serial port volume */
174 #define CS4236_RIGHT_LOOPBACK   0xa8    /* right loopback monitor volume */
175 #define CS4236_DAC_MUTE         0xb8    /* DAC mute and IFSE enable */
176 #define CS4236_ADC_RATE         0xc8    /* indenpendent ADC sample frequency */
177 #define CS4236_DAC_RATE         0xd8    /* indenpendent DAC sample frequency */
178 #define CS4236_LEFT_MASTER      0xe8    /* left master digital audio volume */
179 #define CS4236_RIGHT_MASTER     0xf8    /* right master digital audio volume */
180 #define CS4236_LEFT_WAVE        0x0c    /* left wavetable serial port volume */
181 #define CS4236_RIGHT_WAVE       0x1c    /* right wavetable serial port volume */
182 #define CS4236_VERSION          0x9c    /* chip version and ID */
183
184 /* defines for codec.mode */
185
186 #define CS4231_MODE_NONE        0x0000
187 #define CS4231_MODE_PLAY        0x0001
188 #define CS4231_MODE_RECORD      0x0002
189 #define CS4231_MODE_TIMER       0x0004
190 #define CS4231_MODE_OPEN        (CS4231_MODE_PLAY|CS4231_MODE_RECORD|CS4231_MODE_TIMER)
191
192 /* defines for codec.hardware */
193
194 #define CS4231_HW_DETECT        0x0000  /* let CS4231 driver detect chip */
195 #define CS4231_HW_DETECT3       0x0001  /* allow mode 3 */
196 #define CS4231_HW_TYPE_MASK     0xff00  /* type mask */
197 #define CS4231_HW_CS4231_MASK   0x0100  /* CS4231 serie */
198 #define CS4231_HW_CS4231        0x0100  /* CS4231 chip */
199 #define CS4231_HW_CS4231A       0x0101  /* CS4231A chip */
200 #define CS4231_HW_AD1845        0x0102  /* AD1845 chip */
201 #define CS4231_HW_CS4232_MASK   0x0200  /* CS4232 serie (has control ports) */
202 #define CS4231_HW_CS4232        0x0200  /* CS4232 */
203 #define CS4231_HW_CS4232A       0x0201  /* CS4232A */
204 #define CS4231_HW_CS4236        0x0202  /* CS4236 */
205 #define CS4231_HW_CS4236B_MASK  0x0400  /* CS4236B serie (has extended control regs) */
206 #define CS4231_HW_CS4235        0x0400  /* CS4235 - Crystal Clear (tm) stereo enhancement */
207 #define CS4231_HW_CS4236B       0x0401  /* CS4236B */
208 #define CS4231_HW_CS4237B       0x0402  /* CS4237B - SRS 3D */
209 #define CS4231_HW_CS4238B       0x0403  /* CS4238B - QSOUND 3D */
210 #define CS4231_HW_CS4239        0x0404  /* CS4239 - Crystal Clear (tm) stereo enhancement */
211 /* compatible, but clones */
212 #define CS4231_HW_INTERWAVE     0x1000  /* InterWave chip */
213 #define CS4231_HW_OPL3SA2       0x1001  /* OPL3-SA2 chip */
214
215 /* defines for codec.hwshare */
216 #define CS4231_HWSHARE_IRQ      (1<<0)
217 #define CS4231_HWSHARE_DMA1     (1<<1)
218 #define CS4231_HWSHARE_DMA2     (1<<2)
219
220 struct snd_cs4231 {
221         unsigned long port;             /* base i/o port */
222         struct resource *res_port;
223         unsigned long cport;            /* control base i/o port (CS4236) */
224         struct resource *res_cport;
225         int irq;                        /* IRQ line */
226         int dma1;                       /* playback DMA */
227         int dma2;                       /* record DMA */
228         unsigned short version;         /* version of CODEC chip */
229         unsigned short mode;            /* see to CS4231_MODE_XXXX */
230         unsigned short hardware;        /* see to CS4231_HW_XXXX */
231         unsigned short hwshare;         /* shared resources */
232         unsigned short single_dma:1,    /* forced single DMA mode (GUS 16-bit daughter board) or dma1 == dma2 */
233                        ebus_flag:1;     /* SPARC: EBUS present */
234
235         struct snd_card *card;
236         struct snd_pcm *pcm;
237         struct snd_pcm_substream *playback_substream;
238         struct snd_pcm_substream *capture_substream;
239         struct snd_timer *timer;
240
241         unsigned char image[32];        /* registers image */
242         unsigned char eimage[32];       /* extended registers image */
243         unsigned char cimage[16];       /* control registers image */
244         int mce_bit;
245         int calibrate_mute;
246         int sw_3d_bit;
247         unsigned int p_dma_size;
248         unsigned int c_dma_size;
249
250         spinlock_t reg_lock;
251         struct semaphore mce_mutex;
252         struct semaphore open_mutex;
253
254         int (*rate_constraint) (struct snd_pcm_runtime *runtime);
255         void (*set_playback_format) (struct snd_cs4231 *chip, struct snd_pcm_hw_params *hw_params, unsigned char pdfr);
256         void (*set_capture_format) (struct snd_cs4231 *chip, struct snd_pcm_hw_params *hw_params, unsigned char cdfr);
257         void (*trigger) (struct snd_cs4231 *chip, unsigned int what, int start);
258 #ifdef CONFIG_PM
259         void (*suspend) (struct snd_cs4231 *chip);
260         void (*resume) (struct snd_cs4231 *chip);
261 #endif
262         void *dma_private_data;
263         int (*claim_dma) (struct snd_cs4231 *chip, void *dma_private_data, int dma);
264         int (*release_dma) (struct snd_cs4231 *chip, void *dma_private_data, int dma);
265 };
266
267 /* exported functions */
268
269 void snd_cs4231_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
270 unsigned char snd_cs4231_in(struct snd_cs4231 *chip, unsigned char reg);
271 void snd_cs4236_ext_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
272 unsigned char snd_cs4236_ext_in(struct snd_cs4231 *chip, unsigned char reg);
273 void snd_cs4231_mce_up(struct snd_cs4231 *chip);
274 void snd_cs4231_mce_down(struct snd_cs4231 *chip);
275
276 irqreturn_t snd_cs4231_interrupt(int irq, void *dev_id, struct pt_regs *regs);
277
278 const char *snd_cs4231_chip_id(struct snd_cs4231 *chip);
279
280 int snd_cs4231_create(struct snd_card *card,
281                       unsigned long port,
282                       unsigned long cport,
283                       int irq, int dma1, int dma2,
284                       unsigned short hardware,
285                       unsigned short hwshare,
286                       struct snd_cs4231 ** rchip);
287 int snd_cs4231_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
288 int snd_cs4231_timer(struct snd_cs4231 * chip, int device, struct snd_timer **rtimer);
289 int snd_cs4231_mixer(struct snd_cs4231 * chip);
290
291 int snd_cs4236_create(struct snd_card *card,
292                       unsigned long port,
293                       unsigned long cport,
294                       int irq, int dma1, int dma2,
295                       unsigned short hardware,
296                       unsigned short hwshare,
297                       struct snd_cs4231 ** rchip);
298 int snd_cs4236_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
299 int snd_cs4236_mixer(struct snd_cs4231 * chip);
300
301 /*
302  *  mixer library
303  */
304
305 #define CS4231_SINGLE(xname, xindex, reg, shift, mask, invert) \
306 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
307   .info = snd_cs4231_info_single, \
308   .get = snd_cs4231_get_single, .put = snd_cs4231_put_single, \
309   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
310
311 int snd_cs4231_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
312 int snd_cs4231_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
313 int snd_cs4231_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
314
315 #define CS4231_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
316 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
317   .info = snd_cs4231_info_double, \
318   .get = snd_cs4231_get_double, .put = snd_cs4231_put_double, \
319   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
320
321 int snd_cs4231_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
322 int snd_cs4231_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
323 int snd_cs4231_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
324
325 #endif /* __SOUND_CS4231_H */