sound: oxygen: more hardware documentation
[safe/jmp/linux-2.6] / sound / pci / oxygen / xonar_cs43xx.c
1 /*
2  * card driver for models with CS4398/CS4362A DACs (Xonar D1/DX)
3  *
4  * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
5  *
6  *
7  *  This driver is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License, version 2.
9  *
10  *  This driver is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this driver; if not, see <http://www.gnu.org/licenses/>.
17  */
18
19 /*
20  * Xonar D1/DX
21  * -----------
22  *
23  * CMI8788:
24  *
25  * I²C <-> CS4398 (front)
26  *     <-> CS4362A (surround, center/LFE, back)
27  *
28  * GPI 0 <- external power present (DX only)
29  *
30  * GPIO 0 -> enable output to speakers
31  * GPIO 1 -> enable front panel I/O
32  * GPIO 2 -> M0 of CS5361
33  * GPIO 3 -> M1 of CS5361
34  * GPIO 8 -> route input jack to line-in (0) or mic-in (1)
35  *
36  * CS4398:
37  *
38  * AD0 <- 1
39  * AD1 <- 1
40  *
41  * CS4362A:
42  *
43  * AD0 <- 0
44  *
45  * CM9780:
46  *
47  * GPO 0 -> route line-in (0) or AC97 output (1) to CS5361 input
48  */
49
50 #include <linux/pci.h>
51 #include <linux/delay.h>
52 #include <sound/ac97_codec.h>
53 #include <sound/control.h>
54 #include <sound/core.h>
55 #include <sound/pcm.h>
56 #include <sound/pcm_params.h>
57 #include <sound/tlv.h>
58 #include "xonar.h"
59 #include "cs4398.h"
60 #include "cs4362a.h"
61
62 #define GPI_EXT_POWER           0x01
63 #define GPIO_D1_OUTPUT_ENABLE   0x0001
64 #define GPIO_D1_FRONT_PANEL     0x0002
65 #define GPIO_D1_INPUT_ROUTE     0x0100
66
67 #define I2C_DEVICE_CS4398       0x9e    /* 10011, AD1=1, AD0=1, /W=0 */
68 #define I2C_DEVICE_CS4362A      0x30    /* 001100, AD0=0, /W=0 */
69
70 struct xonar_cs43xx {
71         struct xonar_generic generic;
72         u8 cs4398_fm;
73         u8 cs4362a_fm;
74         u8 cs4362a_fm_c;
75 };
76
77 static void cs4398_write(struct oxygen *chip, u8 reg, u8 value)
78 {
79         oxygen_write_i2c(chip, I2C_DEVICE_CS4398, reg, value);
80 }
81
82 static void cs4362a_write(struct oxygen *chip, u8 reg, u8 value)
83 {
84         oxygen_write_i2c(chip, I2C_DEVICE_CS4362A, reg, value);
85 }
86
87 static void update_cs4362a_volumes(struct oxygen *chip)
88 {
89         u8 mute;
90
91         mute = chip->dac_mute ? CS4362A_MUTE : 0;
92         cs4362a_write(chip, 7, (127 - chip->dac_volume[2]) | mute);
93         cs4362a_write(chip, 8, (127 - chip->dac_volume[3]) | mute);
94         cs4362a_write(chip, 10, (127 - chip->dac_volume[4]) | mute);
95         cs4362a_write(chip, 11, (127 - chip->dac_volume[5]) | mute);
96         cs4362a_write(chip, 13, (127 - chip->dac_volume[6]) | mute);
97         cs4362a_write(chip, 14, (127 - chip->dac_volume[7]) | mute);
98 }
99
100 static void update_cs43xx_volume(struct oxygen *chip)
101 {
102         cs4398_write(chip, 5, (127 - chip->dac_volume[0]) * 2);
103         cs4398_write(chip, 6, (127 - chip->dac_volume[1]) * 2);
104         update_cs4362a_volumes(chip);
105 }
106
107 static void update_cs43xx_mute(struct oxygen *chip)
108 {
109         u8 reg;
110
111         reg = CS4398_MUTEP_LOW | CS4398_PAMUTE;
112         if (chip->dac_mute)
113                 reg |= CS4398_MUTE_B | CS4398_MUTE_A;
114         cs4398_write(chip, 4, reg);
115         update_cs4362a_volumes(chip);
116 }
117
118 static void cs43xx_init(struct oxygen *chip)
119 {
120         struct xonar_cs43xx *data = chip->model_data;
121
122         /* set CPEN (control port mode) and power down */
123         cs4398_write(chip, 8, CS4398_CPEN | CS4398_PDN);
124         cs4362a_write(chip, 0x01, CS4362A_PDN | CS4362A_CPEN);
125         /* configure */
126         cs4398_write(chip, 2, data->cs4398_fm);
127         cs4398_write(chip, 3, CS4398_ATAPI_B_R | CS4398_ATAPI_A_L);
128         cs4398_write(chip, 7, CS4398_RMP_DN | CS4398_RMP_UP |
129                      CS4398_ZERO_CROSS | CS4398_SOFT_RAMP);
130         cs4362a_write(chip, 0x02, CS4362A_DIF_LJUST);
131         cs4362a_write(chip, 0x03, CS4362A_MUTEC_6 | CS4362A_AMUTE |
132                       CS4362A_RMP_UP | CS4362A_ZERO_CROSS | CS4362A_SOFT_RAMP);
133         cs4362a_write(chip, 0x04, CS4362A_RMP_DN | CS4362A_DEM_NONE);
134         cs4362a_write(chip, 0x05, 0);
135         cs4362a_write(chip, 0x06, data->cs4362a_fm);
136         cs4362a_write(chip, 0x09, data->cs4362a_fm_c);
137         cs4362a_write(chip, 0x0c, data->cs4362a_fm);
138         update_cs43xx_volume(chip);
139         update_cs43xx_mute(chip);
140         /* clear power down */
141         cs4398_write(chip, 8, CS4398_CPEN);
142         cs4362a_write(chip, 0x01, CS4362A_CPEN);
143 }
144
145 static void xonar_d1_init(struct oxygen *chip)
146 {
147         struct xonar_cs43xx *data = chip->model_data;
148
149         data->generic.anti_pop_delay = 800;
150         data->generic.output_enable_bit = GPIO_D1_OUTPUT_ENABLE;
151         data->cs4398_fm = CS4398_FM_SINGLE | CS4398_DEM_NONE | CS4398_DIF_LJUST;
152         data->cs4362a_fm = CS4362A_FM_SINGLE |
153                 CS4362A_ATAPI_B_R | CS4362A_ATAPI_A_L;
154         data->cs4362a_fm_c = data->cs4362a_fm;
155
156         oxygen_write16(chip, OXYGEN_2WIRE_BUS_STATUS,
157                        OXYGEN_2WIRE_LENGTH_8 |
158                        OXYGEN_2WIRE_INTERRUPT_MASK |
159                        OXYGEN_2WIRE_SPEED_FAST);
160
161         cs43xx_init(chip);
162
163         oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL,
164                           GPIO_D1_FRONT_PANEL | GPIO_D1_INPUT_ROUTE);
165         oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA,
166                             GPIO_D1_FRONT_PANEL | GPIO_D1_INPUT_ROUTE);
167
168         xonar_init_cs53x1(chip);
169         xonar_enable_output(chip);
170
171         snd_component_add(chip->card, "CS4398");
172         snd_component_add(chip->card, "CS4362A");
173         snd_component_add(chip->card, "CS5361");
174 }
175
176 static void xonar_dx_init(struct oxygen *chip)
177 {
178         struct xonar_cs43xx *data = chip->model_data;
179
180         data->generic.ext_power_reg = OXYGEN_GPI_DATA;
181         data->generic.ext_power_int_reg = OXYGEN_GPI_INTERRUPT_MASK;
182         data->generic.ext_power_bit = GPI_EXT_POWER;
183         xonar_init_ext_power(chip);
184         xonar_d1_init(chip);
185 }
186
187 static void xonar_d1_cleanup(struct oxygen *chip)
188 {
189         xonar_disable_output(chip);
190         cs4362a_write(chip, 0x01, CS4362A_PDN | CS4362A_CPEN);
191         oxygen_clear_bits8(chip, OXYGEN_FUNCTION, OXYGEN_FUNCTION_RESET_CODEC);
192 }
193
194 static void xonar_d1_suspend(struct oxygen *chip)
195 {
196         xonar_d1_cleanup(chip);
197 }
198
199 static void xonar_d1_resume(struct oxygen *chip)
200 {
201         oxygen_set_bits8(chip, OXYGEN_FUNCTION, OXYGEN_FUNCTION_RESET_CODEC);
202         msleep(1);
203         cs43xx_init(chip);
204         xonar_enable_output(chip);
205 }
206
207 static void set_cs43xx_params(struct oxygen *chip,
208                               struct snd_pcm_hw_params *params)
209 {
210         struct xonar_cs43xx *data = chip->model_data;
211         u8 cs4398_fm, cs4362a_fm;
212
213         if (params_rate(params) <= 50000) {
214                 cs4398_fm = CS4398_FM_SINGLE;
215                 cs4362a_fm = CS4362A_FM_SINGLE;
216         } else if (params_rate(params) <= 100000) {
217                 cs4398_fm = CS4398_FM_DOUBLE;
218                 cs4362a_fm = CS4362A_FM_DOUBLE;
219         } else {
220                 cs4398_fm = CS4398_FM_QUAD;
221                 cs4362a_fm = CS4362A_FM_QUAD;
222         }
223         data->cs4398_fm = CS4398_DEM_NONE | CS4398_DIF_LJUST | cs4398_fm;
224         data->cs4362a_fm =
225                 (data->cs4362a_fm & ~CS4362A_FM_MASK) | cs4362a_fm;
226         data->cs4362a_fm_c =
227                 (data->cs4362a_fm_c & ~CS4362A_FM_MASK) | cs4362a_fm;
228         cs4398_write(chip, 2, data->cs4398_fm);
229         cs4362a_write(chip, 0x06, data->cs4362a_fm);
230         cs4362a_write(chip, 0x09, data->cs4362a_fm_c);
231         cs4362a_write(chip, 0x0c, data->cs4362a_fm);
232 }
233
234 static void update_cs43xx_center_lfe_mix(struct oxygen *chip, bool mixed)
235 {
236         struct xonar_cs43xx *data = chip->model_data;
237
238         data->cs4362a_fm_c &= ~CS4362A_ATAPI_MASK;
239         if (mixed)
240                 data->cs4362a_fm_c |= CS4362A_ATAPI_B_LR | CS4362A_ATAPI_A_LR;
241         else
242                 data->cs4362a_fm_c |= CS4362A_ATAPI_B_R | CS4362A_ATAPI_A_L;
243         cs4362a_write(chip, 0x09, data->cs4362a_fm_c);
244 }
245
246 static const struct snd_kcontrol_new front_panel_switch = {
247         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
248         .name = "Front Panel Switch",
249         .info = snd_ctl_boolean_mono_info,
250         .get = xonar_gpio_bit_switch_get,
251         .put = xonar_gpio_bit_switch_put,
252         .private_value = GPIO_D1_FRONT_PANEL,
253 };
254
255 static void xonar_d1_line_mic_ac97_switch(struct oxygen *chip,
256                                           unsigned int reg, unsigned int mute)
257 {
258         if (reg == AC97_LINE) {
259                 spin_lock_irq(&chip->reg_lock);
260                 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA,
261                                       mute ? GPIO_D1_INPUT_ROUTE : 0,
262                                       GPIO_D1_INPUT_ROUTE);
263                 spin_unlock_irq(&chip->reg_lock);
264         }
265 }
266
267 static const DECLARE_TLV_DB_SCALE(cs4362a_db_scale, -6000, 100, 0);
268
269 static int xonar_d1_control_filter(struct snd_kcontrol_new *template)
270 {
271         if (!strncmp(template->name, "CD Capture ", 11))
272                 return 1; /* no CD input */
273         return 0;
274 }
275
276 static int xonar_d1_mixer_init(struct oxygen *chip)
277 {
278         return snd_ctl_add(chip->card, snd_ctl_new1(&front_panel_switch, chip));
279 }
280
281 static const struct oxygen_model model_xonar_d1 = {
282         .longname = "Asus Virtuoso 100",
283         .chip = "AV200",
284         .init = xonar_d1_init,
285         .control_filter = xonar_d1_control_filter,
286         .mixer_init = xonar_d1_mixer_init,
287         .cleanup = xonar_d1_cleanup,
288         .suspend = xonar_d1_suspend,
289         .resume = xonar_d1_resume,
290         .set_dac_params = set_cs43xx_params,
291         .set_adc_params = xonar_set_cs53x1_params,
292         .update_dac_volume = update_cs43xx_volume,
293         .update_dac_mute = update_cs43xx_mute,
294         .update_center_lfe_mix = update_cs43xx_center_lfe_mix,
295         .ac97_switch = xonar_d1_line_mic_ac97_switch,
296         .dac_tlv = cs4362a_db_scale,
297         .model_data_size = sizeof(struct xonar_cs43xx),
298         .device_config = PLAYBACK_0_TO_I2S |
299                          PLAYBACK_1_TO_SPDIF |
300                          CAPTURE_0_FROM_I2S_2,
301         .dac_channels = 8,
302         .dac_volume_min = 127 - 60,
303         .dac_volume_max = 127,
304         .function_flags = OXYGEN_FUNCTION_2WIRE,
305         .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
306         .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
307 };
308
309 int __devinit get_xonar_cs43xx_model(struct oxygen *chip,
310                                      const struct pci_device_id *id)
311 {
312         switch (id->subdevice) {
313         case 0x834f:
314                 chip->model = model_xonar_d1;
315                 chip->model.shortname = "Xonar D1";
316                 break;
317         case 0x8275:
318         case 0x8327:
319                 chip->model = model_xonar_d1;
320                 chip->model.shortname = "Xonar DX";
321                 chip->model.init = xonar_dx_init;
322                 break;
323         default:
324                 return -EINVAL;
325         }
326         return 0;
327 }