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