ASoC: Decouple DAPM from CODECs
[linux-2.6.git] / sound / soc / codecs / stac9766.c
1 /*
2  * stac9766.c  --  ALSA SoC STAC9766 codec support
3  *
4  * Copyright 2009 Jon Smirl, Digispeaker
5  * Author: Jon Smirl <jonsmirl@gmail.com>
6  *
7  *  This program is free software; you can redistribute  it and/or modify it
8  *  under  the terms of  the GNU General  Public License as published by the
9  *  Free Software Foundation;  either version 2 of the  License, or (at your
10  *  option) any later version.
11  *
12  *  Features:-
13  *
14  *   o Support for AC97 Codec, S/PDIF
15  */
16
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/module.h>
20 #include <linux/device.h>
21 #include <sound/core.h>
22 #include <sound/pcm.h>
23 #include <sound/ac97_codec.h>
24 #include <sound/initval.h>
25 #include <sound/pcm_params.h>
26 #include <sound/soc.h>
27 #include <sound/soc-dapm.h>
28 #include <sound/tlv.h>
29
30 #include "stac9766.h"
31
32 #define STAC9766_VERSION "0.10"
33
34 /*
35  * STAC9766 register cache
36  */
37 static const u16 stac9766_reg[] = {
38         0x6A90, 0x8000, 0x8000, 0x8000, /* 6 */
39         0x0000, 0x0000, 0x8008, 0x8008, /* e */
40         0x8808, 0x8808, 0x8808, 0x8808, /* 16 */
41         0x8808, 0x0000, 0x8000, 0x0000, /* 1e */
42         0x0000, 0x0000, 0x0000, 0x000f, /* 26 */
43         0x0a05, 0x0400, 0xbb80, 0x0000, /* 2e */
44         0x0000, 0xbb80, 0x0000, 0x0000, /* 36 */
45         0x0000, 0x2000, 0x0000, 0x0100, /* 3e */
46         0x0000, 0x0000, 0x0080, 0x0000, /* 46 */
47         0x0000, 0x0000, 0x0003, 0xffff, /* 4e */
48         0x0000, 0x0000, 0x0000, 0x0000, /* 56 */
49         0x4000, 0x0000, 0x0000, 0x0000, /* 5e */
50         0x1201, 0xFFFF, 0xFFFF, 0x0000, /* 66 */
51         0x0000, 0x0000, 0x0000, 0x0000, /* 6e */
52         0x0000, 0x0000, 0x0000, 0x0006, /* 76 */
53         0x0000, 0x0000, 0x0000, 0x0000, /* 7e */
54 };
55
56 static const char *stac9766_record_mux[] = {"Mic", "CD", "Video", "AUX",
57                         "Line", "Stereo Mix", "Mono Mix", "Phone"};
58 static const char *stac9766_mono_mux[] = {"Mix", "Mic"};
59 static const char *stac9766_mic_mux[] = {"Mic1", "Mic2"};
60 static const char *stac9766_SPDIF_mux[] = {"PCM", "ADC Record"};
61 static const char *stac9766_popbypass_mux[] = {"Normal", "Bypass Mixer"};
62 static const char *stac9766_record_all_mux[] = {"All analog",
63         "Analog plus DAC"};
64 static const char *stac9766_boost1[] = {"0dB", "10dB"};
65 static const char *stac9766_boost2[] = {"0dB", "20dB"};
66 static const char *stac9766_stereo_mic[] = {"Off", "On"};
67
68 static const struct soc_enum stac9766_record_enum =
69         SOC_ENUM_DOUBLE(AC97_REC_SEL, 8, 0, 8, stac9766_record_mux);
70 static const struct soc_enum stac9766_mono_enum =
71         SOC_ENUM_SINGLE(AC97_GENERAL_PURPOSE, 9, 2, stac9766_mono_mux);
72 static const struct soc_enum stac9766_mic_enum =
73         SOC_ENUM_SINGLE(AC97_GENERAL_PURPOSE, 8, 2, stac9766_mic_mux);
74 static const struct soc_enum stac9766_SPDIF_enum =
75         SOC_ENUM_SINGLE(AC97_STAC_DA_CONTROL, 1, 2, stac9766_SPDIF_mux);
76 static const struct soc_enum stac9766_popbypass_enum =
77         SOC_ENUM_SINGLE(AC97_GENERAL_PURPOSE, 15, 2, stac9766_popbypass_mux);
78 static const struct soc_enum stac9766_record_all_enum =
79         SOC_ENUM_SINGLE(AC97_STAC_ANALOG_SPECIAL, 12, 2,
80                         stac9766_record_all_mux);
81 static const struct soc_enum stac9766_boost1_enum =
82         SOC_ENUM_SINGLE(AC97_MIC, 6, 2, stac9766_boost1); /* 0/10dB */
83 static const struct soc_enum stac9766_boost2_enum =
84         SOC_ENUM_SINGLE(AC97_STAC_ANALOG_SPECIAL, 2, 2, stac9766_boost2); /* 0/20dB */
85 static const struct soc_enum stac9766_stereo_mic_enum =
86         SOC_ENUM_SINGLE(AC97_STAC_STEREO_MIC, 2, 1, stac9766_stereo_mic);
87
88 static const DECLARE_TLV_DB_LINEAR(master_tlv, -4600, 0);
89 static const DECLARE_TLV_DB_LINEAR(record_tlv, 0, 2250);
90 static const DECLARE_TLV_DB_LINEAR(beep_tlv, -4500, 0);
91 static const DECLARE_TLV_DB_LINEAR(mix_tlv, -3450, 1200);
92
93 static const struct snd_kcontrol_new stac9766_snd_ac97_controls[] = {
94         SOC_DOUBLE_TLV("Speaker Volume", AC97_MASTER, 8, 0, 31, 1, master_tlv),
95         SOC_SINGLE("Speaker Switch", AC97_MASTER, 15, 1, 1),
96         SOC_DOUBLE_TLV("Headphone Volume", AC97_HEADPHONE, 8, 0, 31, 1,
97                        master_tlv),
98         SOC_SINGLE("Headphone Switch", AC97_HEADPHONE, 15, 1, 1),
99         SOC_SINGLE_TLV("Mono Out Volume", AC97_MASTER_MONO, 0, 31, 1,
100                        master_tlv),
101         SOC_SINGLE("Mono Out Switch", AC97_MASTER_MONO, 15, 1, 1),
102
103         SOC_DOUBLE_TLV("Record Volume", AC97_REC_GAIN, 8, 0, 15, 0, record_tlv),
104         SOC_SINGLE("Record Switch", AC97_REC_GAIN, 15, 1, 1),
105
106
107         SOC_SINGLE_TLV("Beep Volume", AC97_PC_BEEP, 1, 15, 1, beep_tlv),
108         SOC_SINGLE("Beep Switch", AC97_PC_BEEP, 15, 1, 1),
109         SOC_SINGLE("Beep Frequency", AC97_PC_BEEP, 5, 127, 1),
110         SOC_SINGLE_TLV("Phone Volume", AC97_PHONE, 0, 31, 1, mix_tlv),
111         SOC_SINGLE("Phone Switch", AC97_PHONE, 15, 1, 1),
112
113         SOC_ENUM("Mic Boost1", stac9766_boost1_enum),
114         SOC_ENUM("Mic Boost2", stac9766_boost2_enum),
115         SOC_SINGLE_TLV("Mic Volume", AC97_MIC, 0, 31, 1, mix_tlv),
116         SOC_SINGLE("Mic Switch", AC97_MIC, 15, 1, 1),
117         SOC_ENUM("Stereo Mic", stac9766_stereo_mic_enum),
118
119         SOC_DOUBLE_TLV("Line Volume", AC97_LINE, 8, 0, 31, 1, mix_tlv),
120         SOC_SINGLE("Line Switch", AC97_LINE, 15, 1, 1),
121         SOC_DOUBLE_TLV("CD Volume", AC97_CD, 8, 0, 31, 1, mix_tlv),
122         SOC_SINGLE("CD Switch", AC97_CD, 15, 1, 1),
123         SOC_DOUBLE_TLV("AUX Volume", AC97_AUX, 8, 0, 31, 1, mix_tlv),
124         SOC_SINGLE("AUX Switch", AC97_AUX, 15, 1, 1),
125         SOC_DOUBLE_TLV("Video Volume", AC97_VIDEO, 8, 0, 31, 1, mix_tlv),
126         SOC_SINGLE("Video Switch", AC97_VIDEO, 15, 1, 1),
127
128         SOC_DOUBLE_TLV("DAC Volume", AC97_PCM, 8, 0, 31, 1, mix_tlv),
129         SOC_SINGLE("DAC Switch", AC97_PCM, 15, 1, 1),
130         SOC_SINGLE("Loopback Test Switch", AC97_GENERAL_PURPOSE, 7, 1, 0),
131         SOC_SINGLE("3D Volume", AC97_3D_CONTROL, 3, 2, 1),
132         SOC_SINGLE("3D Switch", AC97_GENERAL_PURPOSE, 13, 1, 0),
133
134         SOC_ENUM("SPDIF Mux", stac9766_SPDIF_enum),
135         SOC_ENUM("Mic1/2 Mux", stac9766_mic_enum),
136         SOC_ENUM("Record All Mux", stac9766_record_all_enum),
137         SOC_ENUM("Record Mux", stac9766_record_enum),
138         SOC_ENUM("Mono Mux", stac9766_mono_enum),
139         SOC_ENUM("Pop Bypass Mux", stac9766_popbypass_enum),
140 };
141
142 static int stac9766_ac97_write(struct snd_soc_codec *codec, unsigned int reg,
143                                unsigned int val)
144 {
145         u16 *cache = codec->reg_cache;
146
147         if (reg > AC97_STAC_PAGE0) {
148                 stac9766_ac97_write(codec, AC97_INT_PAGING, 0);
149                 soc_ac97_ops.write(codec->ac97, reg, val);
150                 stac9766_ac97_write(codec, AC97_INT_PAGING, 1);
151                 return 0;
152         }
153         if (reg / 2 >= ARRAY_SIZE(stac9766_reg))
154                 return -EIO;
155
156         soc_ac97_ops.write(codec->ac97, reg, val);
157         cache[reg / 2] = val;
158         return 0;
159 }
160
161 static unsigned int stac9766_ac97_read(struct snd_soc_codec *codec,
162                                        unsigned int reg)
163 {
164         u16 val = 0, *cache = codec->reg_cache;
165
166         if (reg > AC97_STAC_PAGE0) {
167                 stac9766_ac97_write(codec, AC97_INT_PAGING, 0);
168                 val = soc_ac97_ops.read(codec->ac97, reg - AC97_STAC_PAGE0);
169                 stac9766_ac97_write(codec, AC97_INT_PAGING, 1);
170                 return val;
171         }
172         if (reg / 2 >= ARRAY_SIZE(stac9766_reg))
173                 return -EIO;
174
175         if (reg == AC97_RESET || reg == AC97_GPIO_STATUS ||
176                 reg == AC97_INT_PAGING || reg == AC97_VENDOR_ID1 ||
177                 reg == AC97_VENDOR_ID2) {
178
179                 val = soc_ac97_ops.read(codec->ac97, reg);
180                 return val;
181         }
182         return cache[reg / 2];
183 }
184
185 static int ac97_analog_prepare(struct snd_pcm_substream *substream,
186                                struct snd_soc_dai *dai)
187 {
188         struct snd_soc_codec *codec = dai->codec;
189         struct snd_pcm_runtime *runtime = substream->runtime;
190         unsigned short reg, vra;
191
192         vra = stac9766_ac97_read(codec, AC97_EXTENDED_STATUS);
193
194         vra |= 0x1; /* enable variable rate audio */
195         vra &= ~0x4; /* disable SPDIF output */
196
197         stac9766_ac97_write(codec, AC97_EXTENDED_STATUS, vra);
198
199         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
200                 reg = AC97_PCM_FRONT_DAC_RATE;
201         else
202                 reg = AC97_PCM_LR_ADC_RATE;
203
204         return stac9766_ac97_write(codec, reg, runtime->rate);
205 }
206
207 static int ac97_digital_prepare(struct snd_pcm_substream *substream,
208                                 struct snd_soc_dai *dai)
209 {
210         struct snd_soc_codec *codec = dai->codec;
211         struct snd_pcm_runtime *runtime = substream->runtime;
212         unsigned short reg, vra;
213
214         stac9766_ac97_write(codec, AC97_SPDIF, 0x2002);
215
216         vra = stac9766_ac97_read(codec, AC97_EXTENDED_STATUS);
217         vra |= 0x5; /* Enable VRA and SPDIF out */
218
219         stac9766_ac97_write(codec, AC97_EXTENDED_STATUS, vra);
220
221         reg = AC97_PCM_FRONT_DAC_RATE;
222
223         return stac9766_ac97_write(codec, reg, runtime->rate);
224 }
225
226 static int stac9766_set_bias_level(struct snd_soc_codec *codec,
227                                    enum snd_soc_bias_level level)
228 {
229         switch (level) {
230         case SND_SOC_BIAS_ON: /* full On */
231         case SND_SOC_BIAS_PREPARE: /* partial On */
232         case SND_SOC_BIAS_STANDBY: /* Off, with power */
233                 stac9766_ac97_write(codec, AC97_POWERDOWN, 0x0000);
234                 break;
235         case SND_SOC_BIAS_OFF: /* Off, without power */
236                 /* disable everything including AC link */
237                 stac9766_ac97_write(codec, AC97_POWERDOWN, 0xffff);
238                 break;
239         }
240         codec->dapm.bias_level = level;
241         return 0;
242 }
243
244 static int stac9766_reset(struct snd_soc_codec *codec, int try_warm)
245 {
246         if (try_warm && soc_ac97_ops.warm_reset) {
247                 soc_ac97_ops.warm_reset(codec->ac97);
248                 if (stac9766_ac97_read(codec, 0) == stac9766_reg[0])
249                         return 1;
250         }
251
252         soc_ac97_ops.reset(codec->ac97);
253         if (soc_ac97_ops.warm_reset)
254                 soc_ac97_ops.warm_reset(codec->ac97);
255         if (stac9766_ac97_read(codec, 0) != stac9766_reg[0])
256                 return -EIO;
257         return 0;
258 }
259
260 static int stac9766_codec_suspend(struct snd_soc_codec *codec,
261                                   pm_message_t state)
262 {
263         stac9766_set_bias_level(codec, SND_SOC_BIAS_OFF);
264         return 0;
265 }
266
267 static int stac9766_codec_resume(struct snd_soc_codec *codec)
268 {
269         u16 id, reset;
270
271         reset = 0;
272         /* give the codec an AC97 warm reset to start the link */
273 reset:
274         if (reset > 5) {
275                 printk(KERN_ERR "stac9766 failed to resume");
276                 return -EIO;
277         }
278         codec->ac97->bus->ops->warm_reset(codec->ac97);
279         id = soc_ac97_ops.read(codec->ac97, AC97_VENDOR_ID2);
280         if (id != 0x4c13) {
281                 stac9766_reset(codec, 0);
282                 reset++;
283                 goto reset;
284         }
285         stac9766_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
286
287         return 0;
288 }
289
290 static struct snd_soc_dai_ops stac9766_dai_ops_analog = {
291         .prepare = ac97_analog_prepare,
292 };
293
294 static struct snd_soc_dai_ops stac9766_dai_ops_digital = {
295         .prepare = ac97_digital_prepare,
296 };
297
298 static struct snd_soc_dai_driver stac9766_dai[] = {
299 {
300         .name = "stac9766-hifi-analog",
301         .ac97_control = 1,
302
303         /* stream cababilities */
304         .playback = {
305                 .stream_name = "stac9766 analog",
306                 .channels_min = 1,
307                 .channels_max = 2,
308                 .rates = SNDRV_PCM_RATE_8000_48000,
309                 .formats = SND_SOC_STD_AC97_FMTS,
310         },
311         .capture = {
312                 .stream_name = "stac9766 analog",
313                 .channels_min = 1,
314                 .channels_max = 2,
315                 .rates = SNDRV_PCM_RATE_8000_48000,
316                 .formats = SND_SOC_STD_AC97_FMTS,
317         },
318         /* alsa ops */
319         .ops = &stac9766_dai_ops_analog,
320 },
321 {
322         .name = "stac9766-hifi-IEC958",
323         .ac97_control = 1,
324
325         /* stream cababilities */
326         .playback = {
327                 .stream_name = "stac9766 IEC958",
328                 .channels_min = 1,
329                 .channels_max = 2,
330                 .rates = SNDRV_PCM_RATE_32000 | \
331                         SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000,
332                 .formats = SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE,
333         },
334         /* alsa ops */
335         .ops = &stac9766_dai_ops_digital,
336 }
337 };
338
339 static int stac9766_codec_probe(struct snd_soc_codec *codec)
340 {
341         int ret = 0;
342
343         printk(KERN_INFO "STAC9766 SoC Audio Codec %s\n", STAC9766_VERSION);
344
345         ret = snd_soc_new_ac97_codec(codec, &soc_ac97_ops, 0);
346         if (ret < 0)
347                 goto codec_err;
348
349         /* do a cold reset for the controller and then try
350          * a warm reset followed by an optional cold reset for codec */
351         stac9766_reset(codec, 0);
352         ret = stac9766_reset(codec, 1);
353         if (ret < 0) {
354                 printk(KERN_ERR "Failed to reset STAC9766: AC97 link error\n");
355                 goto codec_err;
356         }
357
358         stac9766_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
359
360         snd_soc_add_controls(codec, stac9766_snd_ac97_controls,
361                              ARRAY_SIZE(stac9766_snd_ac97_controls));
362
363         return 0;
364
365 codec_err:
366         snd_soc_free_ac97_codec(codec);
367         return ret;
368 }
369
370 static int stac9766_codec_remove(struct snd_soc_codec *codec)
371 {
372         snd_soc_free_ac97_codec(codec);
373         return 0;
374 }
375
376 static struct snd_soc_codec_driver soc_codec_dev_stac9766 = {
377         .write = stac9766_ac97_write,
378         .read = stac9766_ac97_read,
379         .set_bias_level = stac9766_set_bias_level,
380         .probe = stac9766_codec_probe,
381         .remove = stac9766_codec_remove,
382         .suspend = stac9766_codec_suspend,
383         .resume = stac9766_codec_resume,
384         .reg_cache_size = sizeof(stac9766_reg),
385         .reg_word_size = sizeof(u16),
386         .reg_cache_step = 2,
387 };
388
389 static __devinit int stac9766_probe(struct platform_device *pdev)
390 {
391         return snd_soc_register_codec(&pdev->dev,
392                         &soc_codec_dev_stac9766, stac9766_dai, ARRAY_SIZE(stac9766_dai));
393 }
394
395 static int __devexit stac9766_remove(struct platform_device *pdev)
396 {
397         snd_soc_unregister_codec(&pdev->dev);
398         return 0;
399 }
400
401 static struct platform_driver stac9766_codec_driver = {
402         .driver = {
403                         .name = "stac9766-codec",
404                         .owner = THIS_MODULE,
405         },
406
407         .probe = stac9766_probe,
408         .remove = __devexit_p(stac9766_remove),
409 };
410
411 static int __init stac9766_init(void)
412 {
413         return platform_driver_register(&stac9766_codec_driver);
414 }
415 module_init(stac9766_init);
416
417 static void __exit stac9766_exit(void)
418 {
419         platform_driver_unregister(&stac9766_codec_driver);
420 }
421 module_exit(stac9766_exit);
422
423 MODULE_DESCRIPTION("ASoC stac9766 driver");
424 MODULE_AUTHOR("Jon Smirl <jonsmirl@gmail.com>");
425 MODULE_LICENSE("GPL");