blob: 6d65f322f1d556f7e5d50af18cd24c153bb2bfe7 [file] [log] [blame]
Krzysztof Helt7779f752008-07-31 21:03:41 +02001#ifndef __SOUND_WSS_H
2#define __SOUND_WSS_H
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
4/*
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02005 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * 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
Krzysztof Heltf5457142007-09-04 13:24:14 +020029#include "cs4231-regs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31/* defines for codec.mode */
32
Krzysztof Helt7779f752008-07-31 21:03:41 +020033#define WSS_MODE_NONE 0x0000
34#define WSS_MODE_PLAY 0x0001
35#define WSS_MODE_RECORD 0x0002
36#define WSS_MODE_TIMER 0x0004
37#define WSS_MODE_OPEN (WSS_MODE_PLAY|WSS_MODE_RECORD|WSS_MODE_TIMER)
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39/* defines for codec.hardware */
40
Krzysztof Helt7779f752008-07-31 21:03:41 +020041#define WSS_HW_DETECT 0x0000 /* let CS4231 driver detect chip */
42#define WSS_HW_DETECT3 0x0001 /* allow mode 3 */
43#define WSS_HW_TYPE_MASK 0xff00 /* type mask */
44#define WSS_HW_CS4231_MASK 0x0100 /* CS4231 serie */
45#define WSS_HW_CS4231 0x0100 /* CS4231 chip */
46#define WSS_HW_CS4231A 0x0101 /* CS4231A chip */
47#define WSS_HW_AD1845 0x0102 /* AD1845 chip */
48#define WSS_HW_CS4232_MASK 0x0200 /* CS4232 serie (has control ports) */
49#define WSS_HW_CS4232 0x0200 /* CS4232 */
50#define WSS_HW_CS4232A 0x0201 /* CS4232A */
51#define WSS_HW_CS4236 0x0202 /* CS4236 */
52#define WSS_HW_CS4236B_MASK 0x0400 /* CS4236B serie (has extended control regs) */
53#define WSS_HW_CS4235 0x0400 /* CS4235 - Crystal Clear (tm) stereo enhancement */
54#define WSS_HW_CS4236B 0x0401 /* CS4236B */
55#define WSS_HW_CS4237B 0x0402 /* CS4237B - SRS 3D */
56#define WSS_HW_CS4238B 0x0403 /* CS4238B - QSOUND 3D */
57#define WSS_HW_CS4239 0x0404 /* CS4239 - Crystal Clear (tm) stereo enhancement */
Krzysztof Heltece11c92008-07-31 21:05:44 +020058#define WSS_HW_AD1848_MASK 0x0800 /* AD1848 serie (half duplex) */
59#define WSS_HW_AD1847 0x0801 /* AD1847 chip */
60#define WSS_HW_AD1848 0x0802 /* AD1848 chip */
61#define WSS_HW_CS4248 0x0803 /* CS4248 chip */
62#define WSS_HW_CMI8330 0x0804 /* CMI8330 chip */
63#define WSS_HW_THINKPAD 0x0805 /* Thinkpad 360/750/755 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070064/* compatible, but clones */
Krzysztof Helt7779f752008-07-31 21:03:41 +020065#define WSS_HW_INTERWAVE 0x1000 /* InterWave chip */
66#define WSS_HW_OPL3SA2 0x1101 /* OPL3-SA2 chip, similar to cs4231 */
67#define WSS_HW_OPTI93X 0x1102 /* Opti 930/931/933 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69/* defines for codec.hwshare */
Krzysztof Helt7779f752008-07-31 21:03:41 +020070#define WSS_HWSHARE_IRQ (1<<0)
71#define WSS_HWSHARE_DMA1 (1<<1)
72#define WSS_HWSHARE_DMA2 (1<<2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Krzysztof Heltead893c2008-07-31 21:09:32 +020074/* IBM Thinkpad specific stuff */
75#define AD1848_THINKPAD_CTL_PORT1 0x15e8
76#define AD1848_THINKPAD_CTL_PORT2 0x15e9
77#define AD1848_THINKPAD_CS4248_ENABLE_BIT 0x02
78
Krzysztof Helt7779f752008-07-31 21:03:41 +020079struct snd_wss {
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 unsigned long port; /* base i/o port */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 struct resource *res_port;
82 unsigned long cport; /* control base i/o port (CS4236) */
83 struct resource *res_cport;
84 int irq; /* IRQ line */
85 int dma1; /* playback DMA */
86 int dma2; /* record DMA */
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 unsigned short version; /* version of CODEC chip */
Krzysztof Helt7779f752008-07-31 21:03:41 +020088 unsigned short mode; /* see to WSS_MODE_XXXX */
89 unsigned short hardware; /* see to WSS_HW_XXXX */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 unsigned short hwshare; /* shared resources */
Krzysztof Helt241b3ee2008-07-31 21:04:37 +020091 unsigned short single_dma:1, /* forced single DMA mode (GUS 16-bit */
92 /* daughter board) or dma1 == dma2 */
93 ebus_flag:1, /* SPARC: EBUS present */
94 thinkpad_flag:1; /* Thinkpad CS4248 needs extra help */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Takashi Iwaiba2375a2005-11-17 14:30:42 +010096 struct snd_card *card;
97 struct snd_pcm *pcm;
98 struct snd_pcm_substream *playback_substream;
99 struct snd_pcm_substream *capture_substream;
100 struct snd_timer *timer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102 unsigned char image[32]; /* registers image */
103 unsigned char eimage[32]; /* extended registers image */
104 unsigned char cimage[16]; /* control registers image */
105 int mce_bit;
106 int calibrate_mute;
107 int sw_3d_bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 unsigned int p_dma_size;
109 unsigned int c_dma_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111 spinlock_t reg_lock;
Ingo Molnar8b7547f2006-01-16 16:33:08 +0100112 struct mutex mce_mutex;
113 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100115 int (*rate_constraint) (struct snd_pcm_runtime *runtime);
Krzysztof Helt7779f752008-07-31 21:03:41 +0200116 void (*set_playback_format) (struct snd_wss *chip,
117 struct snd_pcm_hw_params *hw_params,
118 unsigned char pdfr);
119 void (*set_capture_format) (struct snd_wss *chip,
120 struct snd_pcm_hw_params *hw_params,
121 unsigned char cdfr);
122 void (*trigger) (struct snd_wss *chip, unsigned int what, int start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123#ifdef CONFIG_PM
Krzysztof Helt7779f752008-07-31 21:03:41 +0200124 void (*suspend) (struct snd_wss *chip);
125 void (*resume) (struct snd_wss *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126#endif
127 void *dma_private_data;
Krzysztof Helt7779f752008-07-31 21:03:41 +0200128 int (*claim_dma) (struct snd_wss *chip,
129 void *dma_private_data, int dma);
130 int (*release_dma) (struct snd_wss *chip,
131 void *dma_private_data, int dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132};
133
134/* exported functions */
135
Krzysztof Helt7779f752008-07-31 21:03:41 +0200136void snd_wss_out(struct snd_wss *chip, unsigned char reg, unsigned char val);
137unsigned char snd_wss_in(struct snd_wss *chip, unsigned char reg);
138void snd_cs4236_ext_out(struct snd_wss *chip,
139 unsigned char reg, unsigned char val);
140unsigned char snd_cs4236_ext_in(struct snd_wss *chip, unsigned char reg);
141void snd_wss_mce_up(struct snd_wss *chip);
142void snd_wss_mce_down(struct snd_wss *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Krzysztof Helt7779f752008-07-31 21:03:41 +0200144void snd_wss_overrange(struct snd_wss *chip);
Krzysztof Heltabf1f5a2008-06-09 23:07:28 +0200145
Krzysztof Helt7779f752008-07-31 21:03:41 +0200146irqreturn_t snd_wss_interrupt(int irq, void *dev_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Krzysztof Helt7779f752008-07-31 21:03:41 +0200148const char *snd_wss_chip_id(struct snd_wss *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Krzysztof Helt7779f752008-07-31 21:03:41 +0200150int snd_wss_create(struct snd_card *card,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 unsigned long port,
152 unsigned long cport,
153 int irq, int dma1, int dma2,
154 unsigned short hardware,
155 unsigned short hwshare,
Krzysztof Helt7779f752008-07-31 21:03:41 +0200156 struct snd_wss **rchip);
Krzysztof Heltc2b73d12009-02-16 21:38:37 +0100157int snd_wss_free(struct snd_wss *chip);
Krzysztof Helt7779f752008-07-31 21:03:41 +0200158int snd_wss_pcm(struct snd_wss *chip, int device, struct snd_pcm **rpcm);
159int snd_wss_timer(struct snd_wss *chip, int device, struct snd_timer **rtimer);
160int snd_wss_mixer(struct snd_wss *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Krzysztof Heltead893c2008-07-31 21:09:32 +0200162const struct snd_pcm_ops *snd_wss_get_pcm_ops(int direction);
163
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100164int snd_cs4236_create(struct snd_card *card,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 unsigned long port,
166 unsigned long cport,
167 int irq, int dma1, int dma2,
168 unsigned short hardware,
169 unsigned short hwshare,
Krzysztof Helt7779f752008-07-31 21:03:41 +0200170 struct snd_wss **rchip);
171int snd_cs4236_pcm(struct snd_wss *chip, int device, struct snd_pcm **rpcm);
172int snd_cs4236_mixer(struct snd_wss *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174/*
175 * mixer library
176 */
177
Krzysztof Helt7779f752008-07-31 21:03:41 +0200178#define WSS_SINGLE(xname, xindex, reg, shift, mask, invert) \
179{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
180 .name = xname, \
181 .index = xindex, \
182 .info = snd_wss_info_single, \
183 .get = snd_wss_get_single, \
184 .put = snd_wss_put_single, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
186
Krzysztof Helt7779f752008-07-31 21:03:41 +0200187int snd_wss_info_single(struct snd_kcontrol *kcontrol,
188 struct snd_ctl_elem_info *uinfo);
189int snd_wss_get_single(struct snd_kcontrol *kcontrol,
190 struct snd_ctl_elem_value *ucontrol);
191int snd_wss_put_single(struct snd_kcontrol *kcontrol,
192 struct snd_ctl_elem_value *ucontrol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Krzysztof Helt7779f752008-07-31 21:03:41 +0200194#define WSS_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
195{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
196 .name = xname, \
197 .index = xindex, \
198 .info = snd_wss_info_double, \
199 .get = snd_wss_get_double, \
200 .put = snd_wss_put_double, \
201 .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | \
202 (shift_right << 19) | (mask << 24) | (invert << 22) }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Krzysztof Helt5664daa2008-07-31 21:08:32 +0200204#define WSS_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
205{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
206 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
207 .name = xname, \
208 .index = xindex, \
209 .info = snd_wss_info_single, \
210 .get = snd_wss_get_single, \
211 .put = snd_wss_put_single, \
212 .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
213 .tlv = { .p = (xtlv) } }
214
215#define WSS_DOUBLE_TLV(xname, xindex, left_reg, right_reg, \
216 shift_left, shift_right, mask, invert, xtlv) \
217{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
218 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
219 .name = xname, \
220 .index = xindex, \
221 .info = snd_wss_info_double, \
222 .get = snd_wss_get_double, \
223 .put = snd_wss_put_double, \
224 .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | \
225 (shift_right << 19) | (mask << 24) | (invert << 22), \
226 .tlv = { .p = (xtlv) } }
227
228
Krzysztof Helt7779f752008-07-31 21:03:41 +0200229int snd_wss_info_double(struct snd_kcontrol *kcontrol,
230 struct snd_ctl_elem_info *uinfo);
231int snd_wss_get_double(struct snd_kcontrol *kcontrol,
232 struct snd_ctl_elem_value *ucontrol);
233int snd_wss_put_double(struct snd_kcontrol *kcontrol,
234 struct snd_ctl_elem_value *ucontrol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Krzysztof Helt7779f752008-07-31 21:03:41 +0200236#endif /* __SOUND_WSS_H */