xref: /openbmc/linux/sound/pci/hda/patch_cirrus.c (revision f35e839a)
1 /*
2  * HD audio interface patch for Cirrus Logic CS420x chip
3  *
4  * Copyright (c) 2009 Takashi Iwai <tiwai@suse.de>
5  *
6  *  This driver is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This driver is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  */
20 
21 #include <linux/init.h>
22 #include <linux/slab.h>
23 #include <linux/pci.h>
24 #include <linux/module.h>
25 #include <sound/core.h>
26 #include <sound/tlv.h>
27 #include "hda_codec.h"
28 #include "hda_local.h"
29 #include "hda_auto_parser.h"
30 #include "hda_jack.h"
31 #include "hda_generic.h"
32 
33 /*
34  */
35 
36 struct cs_spec {
37 	struct hda_gen_spec gen;
38 
39 	unsigned int gpio_mask;
40 	unsigned int gpio_dir;
41 	unsigned int gpio_data;
42 	unsigned int gpio_eapd_hp; /* EAPD GPIO bit for headphones */
43 	unsigned int gpio_eapd_speaker; /* EAPD GPIO bit for speakers */
44 
45 	/* CS421x */
46 	unsigned int spdif_detect:1;
47 	unsigned int spdif_present:1;
48 	unsigned int sense_b:1;
49 	hda_nid_t vendor_nid;
50 };
51 
52 /* available models with CS420x */
53 enum {
54 	CS420X_MBP53,
55 	CS420X_MBP55,
56 	CS420X_IMAC27,
57 	CS420X_GPIO_13,
58 	CS420X_GPIO_23,
59 	CS420X_MBP101,
60 	CS420X_MBP81,
61 	CS420X_AUTO,
62 	/* aliases */
63 	CS420X_IMAC27_122 = CS420X_GPIO_23,
64 	CS420X_APPLE = CS420X_GPIO_13,
65 };
66 
67 /* CS421x boards */
68 enum {
69 	CS421X_CDB4210,
70 	CS421X_SENSE_B,
71 	CS421X_STUMPY,
72 };
73 
74 /* Vendor-specific processing widget */
75 #define CS420X_VENDOR_NID	0x11
76 #define CS_DIG_OUT1_PIN_NID	0x10
77 #define CS_DIG_OUT2_PIN_NID	0x15
78 #define CS_DMIC1_PIN_NID	0x0e
79 #define CS_DMIC2_PIN_NID	0x12
80 
81 /* coef indices */
82 #define IDX_SPDIF_STAT		0x0000
83 #define IDX_SPDIF_CTL		0x0001
84 #define IDX_ADC_CFG		0x0002
85 /* SZC bitmask, 4 modes below:
86  * 0 = immediate,
87  * 1 = digital immediate, analog zero-cross
88  * 2 = digtail & analog soft-ramp
89  * 3 = digital soft-ramp, analog zero-cross
90  */
91 #define   CS_COEF_ADC_SZC_MASK		(3 << 0)
92 #define   CS_COEF_ADC_MIC_SZC_MODE	(3 << 0) /* SZC setup for mic */
93 #define   CS_COEF_ADC_LI_SZC_MODE	(3 << 0) /* SZC setup for line-in */
94 /* PGA mode: 0 = differential, 1 = signle-ended */
95 #define   CS_COEF_ADC_MIC_PGA_MODE	(1 << 5) /* PGA setup for mic */
96 #define   CS_COEF_ADC_LI_PGA_MODE	(1 << 6) /* PGA setup for line-in */
97 #define IDX_DAC_CFG		0x0003
98 /* SZC bitmask, 4 modes below:
99  * 0 = Immediate
100  * 1 = zero-cross
101  * 2 = soft-ramp
102  * 3 = soft-ramp on zero-cross
103  */
104 #define   CS_COEF_DAC_HP_SZC_MODE	(3 << 0) /* nid 0x02 */
105 #define   CS_COEF_DAC_LO_SZC_MODE	(3 << 2) /* nid 0x03 */
106 #define   CS_COEF_DAC_SPK_SZC_MODE	(3 << 4) /* nid 0x04 */
107 
108 #define IDX_BEEP_CFG		0x0004
109 /* 0x0008 - test reg key */
110 /* 0x0009 - 0x0014 -> 12 test regs */
111 /* 0x0015 - visibility reg */
112 
113 /*
114  * Cirrus Logic CS4210
115  *
116  * 1 DAC => HP(sense) / Speakers,
117  * 1 ADC <= LineIn(sense) / MicIn / DMicIn,
118  * 1 SPDIF OUT => SPDIF Trasmitter(sense)
119 */
120 #define CS4210_DAC_NID		0x02
121 #define CS4210_ADC_NID		0x03
122 #define CS4210_VENDOR_NID	0x0B
123 #define CS421X_DMIC_PIN_NID	0x09 /* Port E */
124 #define CS421X_SPDIF_PIN_NID	0x0A /* Port H */
125 
126 #define CS421X_IDX_DEV_CFG	0x01
127 #define CS421X_IDX_ADC_CFG	0x02
128 #define CS421X_IDX_DAC_CFG	0x03
129 #define CS421X_IDX_SPK_CTL	0x04
130 
131 #define SPDIF_EVENT		0x04
132 
133 /* Cirrus Logic CS4213 is like CS4210 but does not have SPDIF input/output */
134 #define CS4213_VENDOR_NID	0x09
135 
136 
137 static inline int cs_vendor_coef_get(struct hda_codec *codec, unsigned int idx)
138 {
139 	struct cs_spec *spec = codec->spec;
140 	snd_hda_codec_write(codec, spec->vendor_nid, 0,
141 			    AC_VERB_SET_COEF_INDEX, idx);
142 	return snd_hda_codec_read(codec, spec->vendor_nid, 0,
143 				  AC_VERB_GET_PROC_COEF, 0);
144 }
145 
146 static inline void cs_vendor_coef_set(struct hda_codec *codec, unsigned int idx,
147 				      unsigned int coef)
148 {
149 	struct cs_spec *spec = codec->spec;
150 	snd_hda_codec_write(codec, spec->vendor_nid, 0,
151 			    AC_VERB_SET_COEF_INDEX, idx);
152 	snd_hda_codec_write(codec, spec->vendor_nid, 0,
153 			    AC_VERB_SET_PROC_COEF, coef);
154 }
155 
156 /*
157  * auto-mute and auto-mic switching
158  * CS421x auto-output redirecting
159  * HP/SPK/SPDIF
160  */
161 
162 static void cs_automute(struct hda_codec *codec)
163 {
164 	struct cs_spec *spec = codec->spec;
165 
166 	/* mute HPs if spdif jack (SENSE_B) is present */
167 	spec->gen.master_mute = !!(spec->spdif_present && spec->sense_b);
168 
169 	snd_hda_gen_update_outputs(codec);
170 
171 	if (spec->gpio_eapd_hp) {
172 		spec->gpio_data = spec->gen.hp_jack_present ?
173 			spec->gpio_eapd_hp : spec->gpio_eapd_speaker;
174 		snd_hda_codec_write(codec, 0x01, 0,
175 				    AC_VERB_SET_GPIO_DATA, spec->gpio_data);
176 	}
177 }
178 
179 static bool is_active_pin(struct hda_codec *codec, hda_nid_t nid)
180 {
181 	unsigned int val;
182 	val = snd_hda_codec_get_pincfg(codec, nid);
183 	return (get_defcfg_connect(val) != AC_JACK_PORT_NONE);
184 }
185 
186 static void init_input_coef(struct hda_codec *codec)
187 {
188 	struct cs_spec *spec = codec->spec;
189 	unsigned int coef;
190 
191 	/* CS420x has multiple ADC, CS421x has single ADC */
192 	if (spec->vendor_nid == CS420X_VENDOR_NID) {
193 		coef = cs_vendor_coef_get(codec, IDX_BEEP_CFG);
194 		if (is_active_pin(codec, CS_DMIC2_PIN_NID))
195 			coef |= 1 << 4; /* DMIC2 2 chan on, GPIO1 off */
196 		if (is_active_pin(codec, CS_DMIC1_PIN_NID))
197 			coef |= 1 << 3; /* DMIC1 2 chan on, GPIO0 off
198 					 * No effect if SPDIF_OUT2 is
199 					 * selected in IDX_SPDIF_CTL.
200 					*/
201 
202 		cs_vendor_coef_set(codec, IDX_BEEP_CFG, coef);
203 	}
204 }
205 
206 static const struct hda_verb cs_coef_init_verbs[] = {
207 	{0x11, AC_VERB_SET_PROC_STATE, 1},
208 	{0x11, AC_VERB_SET_COEF_INDEX, IDX_DAC_CFG},
209 	{0x11, AC_VERB_SET_PROC_COEF,
210 	 (0x002a /* DAC1/2/3 SZCMode Soft Ramp */
211 	  | 0x0040 /* Mute DACs on FIFO error */
212 	  | 0x1000 /* Enable DACs High Pass Filter */
213 	  | 0x0400 /* Disable Coefficient Auto increment */
214 	  )},
215 	/* ADC1/2 - Digital and Analog Soft Ramp */
216 	{0x11, AC_VERB_SET_COEF_INDEX, IDX_ADC_CFG},
217 	{0x11, AC_VERB_SET_PROC_COEF, 0x000a},
218 	/* Beep */
219 	{0x11, AC_VERB_SET_COEF_INDEX, IDX_BEEP_CFG},
220 	{0x11, AC_VERB_SET_PROC_COEF, 0x0007}, /* Enable Beep thru DAC1/2/3 */
221 
222 	{} /* terminator */
223 };
224 
225 /* Errata: CS4207 rev C0/C1/C2 Silicon
226  *
227  * http://www.cirrus.com/en/pubs/errata/ER880C3.pdf
228  *
229  * 6. At high temperature (TA > +85°C), the digital supply current (IVD)
230  * may be excessive (up to an additional 200 μA), which is most easily
231  * observed while the part is being held in reset (RESET# active low).
232  *
233  * Root Cause: At initial powerup of the device, the logic that drives
234  * the clock and write enable to the S/PDIF SRC RAMs is not properly
235  * initialized.
236  * Certain random patterns will cause a steady leakage current in those
237  * RAM cells. The issue will resolve once the SRCs are used (turned on).
238  *
239  * Workaround: The following verb sequence briefly turns on the S/PDIF SRC
240  * blocks, which will alleviate the issue.
241  */
242 
243 static const struct hda_verb cs_errata_init_verbs[] = {
244 	{0x01, AC_VERB_SET_POWER_STATE, 0x00}, /* AFG: D0 */
245 	{0x11, AC_VERB_SET_PROC_STATE, 0x01},  /* VPW: processing on */
246 
247 	{0x11, AC_VERB_SET_COEF_INDEX, 0x0008},
248 	{0x11, AC_VERB_SET_PROC_COEF, 0x9999},
249 	{0x11, AC_VERB_SET_COEF_INDEX, 0x0017},
250 	{0x11, AC_VERB_SET_PROC_COEF, 0xa412},
251 	{0x11, AC_VERB_SET_COEF_INDEX, 0x0001},
252 	{0x11, AC_VERB_SET_PROC_COEF, 0x0009},
253 
254 	{0x07, AC_VERB_SET_POWER_STATE, 0x00}, /* S/PDIF Rx: D0 */
255 	{0x08, AC_VERB_SET_POWER_STATE, 0x00}, /* S/PDIF Tx: D0 */
256 
257 	{0x11, AC_VERB_SET_COEF_INDEX, 0x0017},
258 	{0x11, AC_VERB_SET_PROC_COEF, 0x2412},
259 	{0x11, AC_VERB_SET_COEF_INDEX, 0x0008},
260 	{0x11, AC_VERB_SET_PROC_COEF, 0x0000},
261 	{0x11, AC_VERB_SET_COEF_INDEX, 0x0001},
262 	{0x11, AC_VERB_SET_PROC_COEF, 0x0008},
263 	{0x11, AC_VERB_SET_PROC_STATE, 0x00},
264 
265 #if 0 /* Don't to set to D3 as we are in power-up sequence */
266 	{0x07, AC_VERB_SET_POWER_STATE, 0x03}, /* S/PDIF Rx: D3 */
267 	{0x08, AC_VERB_SET_POWER_STATE, 0x03}, /* S/PDIF Tx: D3 */
268 	/*{0x01, AC_VERB_SET_POWER_STATE, 0x03},*/ /* AFG: D3 This is already handled */
269 #endif
270 
271 	{} /* terminator */
272 };
273 
274 /* SPDIF setup */
275 static void init_digital_coef(struct hda_codec *codec)
276 {
277 	unsigned int coef;
278 
279 	coef = 0x0002; /* SRC_MUTE soft-mute on SPDIF (if no lock) */
280 	coef |= 0x0008; /* Replace with mute on error */
281 	if (is_active_pin(codec, CS_DIG_OUT2_PIN_NID))
282 		coef |= 0x4000; /* RX to TX1 or TX2 Loopthru / SPDIF2
283 				 * SPDIF_OUT2 is shared with GPIO1 and
284 				 * DMIC_SDA2.
285 				 */
286 	cs_vendor_coef_set(codec, IDX_SPDIF_CTL, coef);
287 }
288 
289 static int cs_init(struct hda_codec *codec)
290 {
291 	struct cs_spec *spec = codec->spec;
292 
293 	/* init_verb sequence for C0/C1/C2 errata*/
294 	snd_hda_sequence_write(codec, cs_errata_init_verbs);
295 
296 	snd_hda_sequence_write(codec, cs_coef_init_verbs);
297 
298 	snd_hda_gen_init(codec);
299 
300 	if (spec->gpio_mask) {
301 		snd_hda_codec_write(codec, 0x01, 0, AC_VERB_SET_GPIO_MASK,
302 				    spec->gpio_mask);
303 		snd_hda_codec_write(codec, 0x01, 0, AC_VERB_SET_GPIO_DIRECTION,
304 				    spec->gpio_dir);
305 		snd_hda_codec_write(codec, 0x01, 0, AC_VERB_SET_GPIO_DATA,
306 				    spec->gpio_data);
307 	}
308 
309 	init_input_coef(codec);
310 	init_digital_coef(codec);
311 
312 	return 0;
313 }
314 
315 #define cs_free		snd_hda_gen_free
316 
317 static const struct hda_codec_ops cs_patch_ops = {
318 	.build_controls = snd_hda_gen_build_controls,
319 	.build_pcms = snd_hda_gen_build_pcms,
320 	.init = cs_init,
321 	.free = cs_free,
322 	.unsol_event = snd_hda_jack_unsol_event,
323 };
324 
325 static int cs_parse_auto_config(struct hda_codec *codec)
326 {
327 	struct cs_spec *spec = codec->spec;
328 	int err;
329 
330 	err = snd_hda_parse_pin_defcfg(codec, &spec->gen.autocfg, NULL, 0);
331 	if (err < 0)
332 		return err;
333 
334 	err = snd_hda_gen_parse_auto_config(codec, &spec->gen.autocfg);
335 	if (err < 0)
336 		return err;
337 
338 	return 0;
339 }
340 
341 static const struct hda_model_fixup cs420x_models[] = {
342 	{ .id = CS420X_MBP53, .name = "mbp53" },
343 	{ .id = CS420X_MBP55, .name = "mbp55" },
344 	{ .id = CS420X_IMAC27, .name = "imac27" },
345 	{ .id = CS420X_IMAC27_122, .name = "imac27_122" },
346 	{ .id = CS420X_APPLE, .name = "apple" },
347 	{ .id = CS420X_MBP101, .name = "mbp101" },
348 	{ .id = CS420X_MBP81, .name = "mbp81" },
349 	{}
350 };
351 
352 static const struct snd_pci_quirk cs420x_fixup_tbl[] = {
353 	SND_PCI_QUIRK(0x10de, 0x0ac0, "MacBookPro 5,3", CS420X_MBP53),
354 	SND_PCI_QUIRK(0x10de, 0x0d94, "MacBookAir 3,1(2)", CS420X_MBP55),
355 	SND_PCI_QUIRK(0x10de, 0xcb79, "MacBookPro 5,5", CS420X_MBP55),
356 	SND_PCI_QUIRK(0x10de, 0xcb89, "MacBookPro 7,1", CS420X_MBP55),
357 	/* this conflicts with too many other models */
358 	/*SND_PCI_QUIRK(0x8086, 0x7270, "IMac 27 Inch", CS420X_IMAC27),*/
359 
360 	/* codec SSID */
361 	SND_PCI_QUIRK(0x106b, 0x1c00, "MacBookPro 8,1", CS420X_MBP81),
362 	SND_PCI_QUIRK(0x106b, 0x2000, "iMac 12,2", CS420X_IMAC27_122),
363 	SND_PCI_QUIRK(0x106b, 0x2800, "MacBookPro 10,1", CS420X_MBP101),
364 	SND_PCI_QUIRK_VENDOR(0x106b, "Apple", CS420X_APPLE),
365 	{} /* terminator */
366 };
367 
368 static const struct hda_pintbl mbp53_pincfgs[] = {
369 	{ 0x09, 0x012b4050 },
370 	{ 0x0a, 0x90100141 },
371 	{ 0x0b, 0x90100140 },
372 	{ 0x0c, 0x018b3020 },
373 	{ 0x0d, 0x90a00110 },
374 	{ 0x0e, 0x400000f0 },
375 	{ 0x0f, 0x01cbe030 },
376 	{ 0x10, 0x014be060 },
377 	{ 0x12, 0x400000f0 },
378 	{ 0x15, 0x400000f0 },
379 	{} /* terminator */
380 };
381 
382 static const struct hda_pintbl mbp55_pincfgs[] = {
383 	{ 0x09, 0x012b4030 },
384 	{ 0x0a, 0x90100121 },
385 	{ 0x0b, 0x90100120 },
386 	{ 0x0c, 0x400000f0 },
387 	{ 0x0d, 0x90a00110 },
388 	{ 0x0e, 0x400000f0 },
389 	{ 0x0f, 0x400000f0 },
390 	{ 0x10, 0x014be040 },
391 	{ 0x12, 0x400000f0 },
392 	{ 0x15, 0x400000f0 },
393 	{} /* terminator */
394 };
395 
396 static const struct hda_pintbl imac27_pincfgs[] = {
397 	{ 0x09, 0x012b4050 },
398 	{ 0x0a, 0x90100140 },
399 	{ 0x0b, 0x90100142 },
400 	{ 0x0c, 0x018b3020 },
401 	{ 0x0d, 0x90a00110 },
402 	{ 0x0e, 0x400000f0 },
403 	{ 0x0f, 0x01cbe030 },
404 	{ 0x10, 0x014be060 },
405 	{ 0x12, 0x01ab9070 },
406 	{ 0x15, 0x400000f0 },
407 	{} /* terminator */
408 };
409 
410 static const struct hda_pintbl mbp101_pincfgs[] = {
411 	{ 0x0d, 0x40ab90f0 },
412 	{ 0x0e, 0x90a600f0 },
413 	{ 0x12, 0x50a600f0 },
414 	{} /* terminator */
415 };
416 
417 static void cs420x_fixup_gpio_13(struct hda_codec *codec,
418 				 const struct hda_fixup *fix, int action)
419 {
420 	if (action == HDA_FIXUP_ACT_PRE_PROBE) {
421 		struct cs_spec *spec = codec->spec;
422 		spec->gpio_eapd_hp = 2; /* GPIO1 = headphones */
423 		spec->gpio_eapd_speaker = 8; /* GPIO3 = speakers */
424 		spec->gpio_mask = spec->gpio_dir =
425 			spec->gpio_eapd_hp | spec->gpio_eapd_speaker;
426 	}
427 }
428 
429 static void cs420x_fixup_gpio_23(struct hda_codec *codec,
430 				 const struct hda_fixup *fix, int action)
431 {
432 	if (action == HDA_FIXUP_ACT_PRE_PROBE) {
433 		struct cs_spec *spec = codec->spec;
434 		spec->gpio_eapd_hp = 4; /* GPIO2 = headphones */
435 		spec->gpio_eapd_speaker = 8; /* GPIO3 = speakers */
436 		spec->gpio_mask = spec->gpio_dir =
437 			spec->gpio_eapd_hp | spec->gpio_eapd_speaker;
438 	}
439 }
440 
441 static const struct hda_fixup cs420x_fixups[] = {
442 	[CS420X_MBP53] = {
443 		.type = HDA_FIXUP_PINS,
444 		.v.pins = mbp53_pincfgs,
445 		.chained = true,
446 		.chain_id = CS420X_APPLE,
447 	},
448 	[CS420X_MBP55] = {
449 		.type = HDA_FIXUP_PINS,
450 		.v.pins = mbp55_pincfgs,
451 		.chained = true,
452 		.chain_id = CS420X_GPIO_13,
453 	},
454 	[CS420X_IMAC27] = {
455 		.type = HDA_FIXUP_PINS,
456 		.v.pins = imac27_pincfgs,
457 		.chained = true,
458 		.chain_id = CS420X_GPIO_13,
459 	},
460 	[CS420X_GPIO_13] = {
461 		.type = HDA_FIXUP_FUNC,
462 		.v.func = cs420x_fixup_gpio_13,
463 	},
464 	[CS420X_GPIO_23] = {
465 		.type = HDA_FIXUP_FUNC,
466 		.v.func = cs420x_fixup_gpio_23,
467 	},
468 	[CS420X_MBP101] = {
469 		.type = HDA_FIXUP_PINS,
470 		.v.pins = mbp101_pincfgs,
471 		.chained = true,
472 		.chain_id = CS420X_GPIO_13,
473 	},
474 	[CS420X_MBP81] = {
475 		.type = HDA_FIXUP_VERBS,
476 		.v.verbs = (const struct hda_verb[]) {
477 			/* internal mic ADC2: right only, single ended */
478 			{0x11, AC_VERB_SET_COEF_INDEX, IDX_ADC_CFG},
479 			{0x11, AC_VERB_SET_PROC_COEF, 0x102a},
480 			{}
481 		},
482 		.chained = true,
483 		.chain_id = CS420X_GPIO_13,
484 	},
485 };
486 
487 static struct cs_spec *cs_alloc_spec(struct hda_codec *codec, int vendor_nid)
488 {
489 	struct cs_spec *spec;
490 
491 	spec = kzalloc(sizeof(*spec), GFP_KERNEL);
492 	if (!spec)
493 		return NULL;
494 	codec->spec = spec;
495 	spec->vendor_nid = vendor_nid;
496 	snd_hda_gen_spec_init(&spec->gen);
497 
498 	return spec;
499 }
500 
501 static int patch_cs420x(struct hda_codec *codec)
502 {
503 	struct cs_spec *spec;
504 	int err;
505 
506 	spec = cs_alloc_spec(codec, CS420X_VENDOR_NID);
507 	if (!spec)
508 		return -ENOMEM;
509 
510 	spec->gen.automute_hook = cs_automute;
511 
512 	snd_hda_pick_fixup(codec, cs420x_models, cs420x_fixup_tbl,
513 			   cs420x_fixups);
514 	snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_PRE_PROBE);
515 
516 	err = cs_parse_auto_config(codec);
517 	if (err < 0)
518 		goto error;
519 
520 	codec->patch_ops = cs_patch_ops;
521 
522 	snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_PROBE);
523 
524 	return 0;
525 
526  error:
527 	cs_free(codec);
528 	return err;
529 }
530 
531 /*
532  * Cirrus Logic CS4210
533  *
534  * 1 DAC => HP(sense) / Speakers,
535  * 1 ADC <= LineIn(sense) / MicIn / DMicIn,
536  * 1 SPDIF OUT => SPDIF Trasmitter(sense)
537 */
538 
539 /* CS4210 board names */
540 static const struct hda_model_fixup cs421x_models[] = {
541 	{ .id = CS421X_CDB4210, .name = "cdb4210" },
542 	{ .id = CS421X_STUMPY, .name = "stumpy" },
543 	{}
544 };
545 
546 static const struct snd_pci_quirk cs421x_fixup_tbl[] = {
547 	/* Test Intel board + CDB2410  */
548 	SND_PCI_QUIRK(0x8086, 0x5001, "DP45SG/CDB4210", CS421X_CDB4210),
549 	{} /* terminator */
550 };
551 
552 /* CS4210 board pinconfigs */
553 /* Default CS4210 (CDB4210)*/
554 static const struct hda_pintbl cdb4210_pincfgs[] = {
555 	{ 0x05, 0x0321401f },
556 	{ 0x06, 0x90170010 },
557 	{ 0x07, 0x03813031 },
558 	{ 0x08, 0xb7a70037 },
559 	{ 0x09, 0xb7a6003e },
560 	{ 0x0a, 0x034510f0 },
561 	{} /* terminator */
562 };
563 
564 /* Stumpy ChromeBox */
565 static const struct hda_pintbl stumpy_pincfgs[] = {
566 	{ 0x05, 0x022120f0 },
567 	{ 0x06, 0x901700f0 },
568 	{ 0x07, 0x02a120f0 },
569 	{ 0x08, 0x77a70037 },
570 	{ 0x09, 0x77a6003e },
571 	{ 0x0a, 0x434510f0 },
572 	{} /* terminator */
573 };
574 
575 /* Setup GPIO/SENSE for each board (if used) */
576 static void cs421x_fixup_sense_b(struct hda_codec *codec,
577 				 const struct hda_fixup *fix, int action)
578 {
579 	struct cs_spec *spec = codec->spec;
580 	if (action == HDA_FIXUP_ACT_PRE_PROBE)
581 		spec->sense_b = 1;
582 }
583 
584 static const struct hda_fixup cs421x_fixups[] = {
585 	[CS421X_CDB4210] = {
586 		.type = HDA_FIXUP_PINS,
587 		.v.pins = cdb4210_pincfgs,
588 		.chained = true,
589 		.chain_id = CS421X_SENSE_B,
590 	},
591 	[CS421X_SENSE_B] = {
592 		.type = HDA_FIXUP_FUNC,
593 		.v.func = cs421x_fixup_sense_b,
594 	},
595 	[CS421X_STUMPY] = {
596 		.type = HDA_FIXUP_PINS,
597 		.v.pins = stumpy_pincfgs,
598 	},
599 };
600 
601 static const struct hda_verb cs421x_coef_init_verbs[] = {
602 	{0x0B, AC_VERB_SET_PROC_STATE, 1},
603 	{0x0B, AC_VERB_SET_COEF_INDEX, CS421X_IDX_DEV_CFG},
604 	/*
605 	    Disable Coefficient Index Auto-Increment(DAI)=1,
606 	    PDREF=0
607 	*/
608 	{0x0B, AC_VERB_SET_PROC_COEF, 0x0001 },
609 
610 	{0x0B, AC_VERB_SET_COEF_INDEX, CS421X_IDX_ADC_CFG},
611 	/* ADC SZCMode = Digital Soft Ramp */
612 	{0x0B, AC_VERB_SET_PROC_COEF, 0x0002 },
613 
614 	{0x0B, AC_VERB_SET_COEF_INDEX, CS421X_IDX_DAC_CFG},
615 	{0x0B, AC_VERB_SET_PROC_COEF,
616 	 (0x0002 /* DAC SZCMode = Digital Soft Ramp */
617 	  | 0x0004 /* Mute DAC on FIFO error */
618 	  | 0x0008 /* Enable DAC High Pass Filter */
619 	  )},
620 	{} /* terminator */
621 };
622 
623 /* Errata: CS4210 rev A1 Silicon
624  *
625  * http://www.cirrus.com/en/pubs/errata/
626  *
627  * Description:
628  * 1. Performance degredation is present in the ADC.
629  * 2. Speaker output is not completely muted upon HP detect.
630  * 3. Noise is present when clipping occurs on the amplified
631  *    speaker outputs.
632  *
633  * Workaround:
634  * The following verb sequence written to the registers during
635  * initialization will correct the issues listed above.
636  */
637 
638 static const struct hda_verb cs421x_coef_init_verbs_A1_silicon_fixes[] = {
639 	{0x0B, AC_VERB_SET_PROC_STATE, 0x01},  /* VPW: processing on */
640 
641 	{0x0B, AC_VERB_SET_COEF_INDEX, 0x0006},
642 	{0x0B, AC_VERB_SET_PROC_COEF, 0x9999}, /* Test mode: on */
643 
644 	{0x0B, AC_VERB_SET_COEF_INDEX, 0x000A},
645 	{0x0B, AC_VERB_SET_PROC_COEF, 0x14CB}, /* Chop double */
646 
647 	{0x0B, AC_VERB_SET_COEF_INDEX, 0x0011},
648 	{0x0B, AC_VERB_SET_PROC_COEF, 0xA2D0}, /* Increase ADC current */
649 
650 	{0x0B, AC_VERB_SET_COEF_INDEX, 0x001A},
651 	{0x0B, AC_VERB_SET_PROC_COEF, 0x02A9}, /* Mute speaker */
652 
653 	{0x0B, AC_VERB_SET_COEF_INDEX, 0x001B},
654 	{0x0B, AC_VERB_SET_PROC_COEF, 0X1006}, /* Remove noise */
655 
656 	{} /* terminator */
657 };
658 
659 /* Speaker Amp Gain is controlled by the vendor widget's coef 4 */
660 static const DECLARE_TLV_DB_SCALE(cs421x_speaker_boost_db_scale, 900, 300, 0);
661 
662 static int cs421x_boost_vol_info(struct snd_kcontrol *kcontrol,
663 				struct snd_ctl_elem_info *uinfo)
664 {
665 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
666 	uinfo->count = 1;
667 	uinfo->value.integer.min = 0;
668 	uinfo->value.integer.max = 3;
669 	return 0;
670 }
671 
672 static int cs421x_boost_vol_get(struct snd_kcontrol *kcontrol,
673 				struct snd_ctl_elem_value *ucontrol)
674 {
675 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
676 
677 	ucontrol->value.integer.value[0] =
678 		cs_vendor_coef_get(codec, CS421X_IDX_SPK_CTL) & 0x0003;
679 	return 0;
680 }
681 
682 static int cs421x_boost_vol_put(struct snd_kcontrol *kcontrol,
683 				struct snd_ctl_elem_value *ucontrol)
684 {
685 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
686 
687 	unsigned int vol = ucontrol->value.integer.value[0];
688 	unsigned int coef =
689 		cs_vendor_coef_get(codec, CS421X_IDX_SPK_CTL);
690 	unsigned int original_coef = coef;
691 
692 	coef &= ~0x0003;
693 	coef |= (vol & 0x0003);
694 	if (original_coef == coef)
695 		return 0;
696 	else {
697 		cs_vendor_coef_set(codec, CS421X_IDX_SPK_CTL, coef);
698 		return 1;
699 	}
700 }
701 
702 static const struct snd_kcontrol_new cs421x_speaker_boost_ctl = {
703 
704 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
705 	.access = (SNDRV_CTL_ELEM_ACCESS_READWRITE |
706 			SNDRV_CTL_ELEM_ACCESS_TLV_READ),
707 	.name = "Speaker Boost Playback Volume",
708 	.info = cs421x_boost_vol_info,
709 	.get = cs421x_boost_vol_get,
710 	.put = cs421x_boost_vol_put,
711 	.tlv = { .p = cs421x_speaker_boost_db_scale },
712 };
713 
714 static void cs4210_pinmux_init(struct hda_codec *codec)
715 {
716 	struct cs_spec *spec = codec->spec;
717 	unsigned int def_conf, coef;
718 
719 	/* GPIO, DMIC_SCL, DMIC_SDA and SENSE_B are multiplexed */
720 	coef = cs_vendor_coef_get(codec, CS421X_IDX_DEV_CFG);
721 
722 	if (spec->gpio_mask)
723 		coef |= 0x0008; /* B1,B2 are GPIOs */
724 	else
725 		coef &= ~0x0008;
726 
727 	if (spec->sense_b)
728 		coef |= 0x0010; /* B2 is SENSE_B, not inverted  */
729 	else
730 		coef &= ~0x0010;
731 
732 	cs_vendor_coef_set(codec, CS421X_IDX_DEV_CFG, coef);
733 
734 	if ((spec->gpio_mask || spec->sense_b) &&
735 	    is_active_pin(codec, CS421X_DMIC_PIN_NID)) {
736 
737 		/*
738 		    GPIO or SENSE_B forced - disconnect the DMIC pin.
739 		*/
740 		def_conf = snd_hda_codec_get_pincfg(codec, CS421X_DMIC_PIN_NID);
741 		def_conf &= ~AC_DEFCFG_PORT_CONN;
742 		def_conf |= (AC_JACK_PORT_NONE << AC_DEFCFG_PORT_CONN_SHIFT);
743 		snd_hda_codec_set_pincfg(codec, CS421X_DMIC_PIN_NID, def_conf);
744 	}
745 }
746 
747 static void cs4210_spdif_automute(struct hda_codec *codec,
748 				  struct hda_jack_tbl *tbl)
749 {
750 	struct cs_spec *spec = codec->spec;
751 	bool spdif_present = false;
752 	hda_nid_t spdif_pin = spec->gen.autocfg.dig_out_pins[0];
753 
754 	/* detect on spdif is specific to CS4210 */
755 	if (!spec->spdif_detect ||
756 	    spec->vendor_nid != CS4210_VENDOR_NID)
757 		return;
758 
759 	spdif_present = snd_hda_jack_detect(codec, spdif_pin);
760 	if (spdif_present == spec->spdif_present)
761 		return;
762 
763 	spec->spdif_present = spdif_present;
764 	/* SPDIF TX on/off */
765 	if (spdif_present)
766 		snd_hda_set_pin_ctl(codec, spdif_pin,
767 				    spdif_present ? PIN_OUT : 0);
768 
769 	cs_automute(codec);
770 }
771 
772 static void parse_cs421x_digital(struct hda_codec *codec)
773 {
774 	struct cs_spec *spec = codec->spec;
775 	struct auto_pin_cfg *cfg = &spec->gen.autocfg;
776 	int i;
777 
778 	for (i = 0; i < cfg->dig_outs; i++) {
779 		hda_nid_t nid = cfg->dig_out_pins[i];
780 		if (get_wcaps(codec, nid) & AC_WCAP_UNSOL_CAP) {
781 			spec->spdif_detect = 1;
782 			snd_hda_jack_detect_enable_callback(codec, nid,
783 							    SPDIF_EVENT,
784 							    cs4210_spdif_automute);
785 		}
786 	}
787 }
788 
789 static int cs421x_init(struct hda_codec *codec)
790 {
791 	struct cs_spec *spec = codec->spec;
792 
793 	if (spec->vendor_nid == CS4210_VENDOR_NID) {
794 		snd_hda_sequence_write(codec, cs421x_coef_init_verbs);
795 		snd_hda_sequence_write(codec, cs421x_coef_init_verbs_A1_silicon_fixes);
796 		cs4210_pinmux_init(codec);
797 	}
798 
799 	snd_hda_gen_init(codec);
800 
801 	if (spec->gpio_mask) {
802 		snd_hda_codec_write(codec, 0x01, 0, AC_VERB_SET_GPIO_MASK,
803 				    spec->gpio_mask);
804 		snd_hda_codec_write(codec, 0x01, 0, AC_VERB_SET_GPIO_DIRECTION,
805 				    spec->gpio_dir);
806 		snd_hda_codec_write(codec, 0x01, 0, AC_VERB_SET_GPIO_DATA,
807 				    spec->gpio_data);
808 	}
809 
810 	init_input_coef(codec);
811 
812 	cs4210_spdif_automute(codec, NULL);
813 
814 	return 0;
815 }
816 
817 static int cs421x_build_controls(struct hda_codec *codec)
818 {
819 	struct cs_spec *spec = codec->spec;
820 	int err;
821 
822 	err = snd_hda_gen_build_controls(codec);
823 	if (err < 0)
824 		return err;
825 
826 	if (spec->gen.autocfg.speaker_outs &&
827 	    spec->vendor_nid == CS4210_VENDOR_NID) {
828 		err = snd_hda_ctl_add(codec, 0,
829 			snd_ctl_new1(&cs421x_speaker_boost_ctl, codec));
830 		if (err < 0)
831 			return err;
832 	}
833 	return 0;
834 }
835 
836 static void fix_volume_caps(struct hda_codec *codec, hda_nid_t dac)
837 {
838 	unsigned int caps;
839 
840 	/* set the upper-limit for mixer amp to 0dB */
841 	caps = query_amp_caps(codec, dac, HDA_OUTPUT);
842 	caps &= ~(0x7f << AC_AMPCAP_NUM_STEPS_SHIFT);
843 	caps |= ((caps >> AC_AMPCAP_OFFSET_SHIFT) & 0x7f)
844 		<< AC_AMPCAP_NUM_STEPS_SHIFT;
845 	snd_hda_override_amp_caps(codec, dac, HDA_OUTPUT, caps);
846 }
847 
848 static int cs421x_parse_auto_config(struct hda_codec *codec)
849 {
850 	struct cs_spec *spec = codec->spec;
851 	hda_nid_t dac = CS4210_DAC_NID;
852 	int err;
853 
854 	fix_volume_caps(codec, dac);
855 
856 	err = snd_hda_parse_pin_defcfg(codec, &spec->gen.autocfg, NULL, 0);
857 	if (err < 0)
858 		return err;
859 
860 	err = snd_hda_gen_parse_auto_config(codec, &spec->gen.autocfg);
861 	if (err < 0)
862 		return err;
863 
864 	parse_cs421x_digital(codec);
865 	return 0;
866 }
867 
868 #ifdef CONFIG_PM
869 /*
870 	Manage PDREF, when transitioning to D3hot
871 	(DAC,ADC) -> D3, PDREF=1, AFG->D3
872 */
873 static int cs421x_suspend(struct hda_codec *codec)
874 {
875 	struct cs_spec *spec = codec->spec;
876 	unsigned int coef;
877 
878 	snd_hda_shutup_pins(codec);
879 
880 	snd_hda_codec_write(codec, CS4210_DAC_NID, 0,
881 			    AC_VERB_SET_POWER_STATE,  AC_PWRST_D3);
882 	snd_hda_codec_write(codec, CS4210_ADC_NID, 0,
883 			    AC_VERB_SET_POWER_STATE,  AC_PWRST_D3);
884 
885 	if (spec->vendor_nid == CS4210_VENDOR_NID) {
886 		coef = cs_vendor_coef_get(codec, CS421X_IDX_DEV_CFG);
887 		coef |= 0x0004; /* PDREF */
888 		cs_vendor_coef_set(codec, CS421X_IDX_DEV_CFG, coef);
889 	}
890 
891 	return 0;
892 }
893 #endif
894 
895 static const struct hda_codec_ops cs421x_patch_ops = {
896 	.build_controls = cs421x_build_controls,
897 	.build_pcms = snd_hda_gen_build_pcms,
898 	.init = cs421x_init,
899 	.free = cs_free,
900 	.unsol_event = snd_hda_jack_unsol_event,
901 #ifdef CONFIG_PM
902 	.suspend = cs421x_suspend,
903 #endif
904 };
905 
906 static int patch_cs4210(struct hda_codec *codec)
907 {
908 	struct cs_spec *spec;
909 	int err;
910 
911 	spec = cs_alloc_spec(codec, CS4210_VENDOR_NID);
912 	if (!spec)
913 		return -ENOMEM;
914 
915 	spec->gen.automute_hook = cs_automute;
916 
917 	snd_hda_pick_fixup(codec, cs421x_models, cs421x_fixup_tbl,
918 			   cs421x_fixups);
919 	snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_PRE_PROBE);
920 
921 	/*
922 	    Update the GPIO/DMIC/SENSE_B pinmux before the configuration
923 	    is auto-parsed. If GPIO or SENSE_B is forced, DMIC input
924 	    is disabled.
925 	*/
926 	cs4210_pinmux_init(codec);
927 
928 	err = cs421x_parse_auto_config(codec);
929 	if (err < 0)
930 		goto error;
931 
932 	codec->patch_ops = cs421x_patch_ops;
933 
934 	snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_PROBE);
935 
936 	return 0;
937 
938  error:
939 	cs_free(codec);
940 	return err;
941 }
942 
943 static int patch_cs4213(struct hda_codec *codec)
944 {
945 	struct cs_spec *spec;
946 	int err;
947 
948 	spec = cs_alloc_spec(codec, CS4213_VENDOR_NID);
949 	if (!spec)
950 		return -ENOMEM;
951 
952 	err = cs421x_parse_auto_config(codec);
953 	if (err < 0)
954 		goto error;
955 
956 	codec->patch_ops = cs421x_patch_ops;
957 	return 0;
958 
959  error:
960 	cs_free(codec);
961 	return err;
962 }
963 
964 
965 /*
966  * patch entries
967  */
968 static const struct hda_codec_preset snd_hda_preset_cirrus[] = {
969 	{ .id = 0x10134206, .name = "CS4206", .patch = patch_cs420x },
970 	{ .id = 0x10134207, .name = "CS4207", .patch = patch_cs420x },
971 	{ .id = 0x10134210, .name = "CS4210", .patch = patch_cs4210 },
972 	{ .id = 0x10134213, .name = "CS4213", .patch = patch_cs4213 },
973 	{} /* terminator */
974 };
975 
976 MODULE_ALIAS("snd-hda-codec-id:10134206");
977 MODULE_ALIAS("snd-hda-codec-id:10134207");
978 MODULE_ALIAS("snd-hda-codec-id:10134210");
979 MODULE_ALIAS("snd-hda-codec-id:10134213");
980 
981 MODULE_LICENSE("GPL");
982 MODULE_DESCRIPTION("Cirrus Logic HD-audio codec");
983 
984 static struct hda_codec_preset_list cirrus_list = {
985 	.preset = snd_hda_preset_cirrus,
986 	.owner = THIS_MODULE,
987 };
988 
989 static int __init patch_cirrus_init(void)
990 {
991 	return snd_hda_add_codec_preset(&cirrus_list);
992 }
993 
994 static void __exit patch_cirrus_exit(void)
995 {
996 	snd_hda_delete_codec_preset(&cirrus_list);
997 }
998 
999 module_init(patch_cirrus_init)
1000 module_exit(patch_cirrus_exit)
1001