xref: /openbmc/linux/sound/pci/hda/hda_auto_parser.c (revision 61bf3293)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * BIOS auto-parser helper functions for HD-audio
4  *
5  * Copyright (c) 2012 Takashi Iwai <tiwai@suse.de>
6  */
7 
8 #include <linux/slab.h>
9 #include <linux/export.h>
10 #include <linux/sort.h>
11 #include <sound/core.h>
12 #include <sound/hda_codec.h>
13 #include "hda_local.h"
14 #include "hda_auto_parser.h"
15 
16 /*
17  * Helper for automatic pin configuration
18  */
19 
20 static int is_in_nid_list(hda_nid_t nid, const hda_nid_t *list)
21 {
22 	for (; *list; list++)
23 		if (*list == nid)
24 			return 1;
25 	return 0;
26 }
27 
28 /* a pair of input pin and its sequence */
29 struct auto_out_pin {
30 	hda_nid_t pin;
31 	short seq;
32 };
33 
34 static int compare_seq(const void *ap, const void *bp)
35 {
36 	const struct auto_out_pin *a = ap;
37 	const struct auto_out_pin *b = bp;
38 	return (int)(a->seq - b->seq);
39 }
40 
41 /*
42  * Sort an associated group of pins according to their sequence numbers.
43  * then store it to a pin array.
44  */
45 static void sort_pins_by_sequence(hda_nid_t *pins, struct auto_out_pin *list,
46 				  int num_pins)
47 {
48 	int i;
49 	sort(list, num_pins, sizeof(list[0]), compare_seq, NULL);
50 	for (i = 0; i < num_pins; i++)
51 		pins[i] = list[i].pin;
52 }
53 
54 
55 /* add the found input-pin to the cfg->inputs[] table */
56 static void add_auto_cfg_input_pin(struct hda_codec *codec, struct auto_pin_cfg *cfg,
57 				   hda_nid_t nid, int type)
58 {
59 	if (cfg->num_inputs < AUTO_CFG_MAX_INS) {
60 		cfg->inputs[cfg->num_inputs].pin = nid;
61 		cfg->inputs[cfg->num_inputs].type = type;
62 		cfg->inputs[cfg->num_inputs].has_boost_on_pin =
63 			nid_has_volume(codec, nid, HDA_INPUT);
64 		cfg->num_inputs++;
65 	}
66 }
67 
68 static int compare_input_type(const void *ap, const void *bp)
69 {
70 	const struct auto_pin_cfg_item *a = ap;
71 	const struct auto_pin_cfg_item *b = bp;
72 	if (a->type != b->type)
73 		return (int)(a->type - b->type);
74 
75 	/* In case one has boost and the other one has not,
76 	   pick the one with boost first. */
77 	return (int)(b->has_boost_on_pin - a->has_boost_on_pin);
78 }
79 
80 /* Reorder the surround channels
81  * ALSA sequence is front/surr/clfe/side
82  * HDA sequence is:
83  *    4-ch: front/surr  =>  OK as it is
84  *    6-ch: front/clfe/surr
85  *    8-ch: front/clfe/rear/side|fc
86  */
87 static void reorder_outputs(unsigned int nums, hda_nid_t *pins)
88 {
89 	hda_nid_t nid;
90 
91 	switch (nums) {
92 	case 3:
93 	case 4:
94 		nid = pins[1];
95 		pins[1] = pins[2];
96 		pins[2] = nid;
97 		break;
98 	}
99 }
100 
101 /* check whether the given pin has a proper pin I/O capability bit */
102 static bool check_pincap_validity(struct hda_codec *codec, hda_nid_t pin,
103 				  unsigned int dev)
104 {
105 	unsigned int pincap = snd_hda_query_pin_caps(codec, pin);
106 
107 	/* some old hardware don't return the proper pincaps */
108 	if (!pincap)
109 		return true;
110 
111 	switch (dev) {
112 	case AC_JACK_LINE_OUT:
113 	case AC_JACK_SPEAKER:
114 	case AC_JACK_HP_OUT:
115 	case AC_JACK_SPDIF_OUT:
116 	case AC_JACK_DIG_OTHER_OUT:
117 		return !!(pincap & AC_PINCAP_OUT);
118 	default:
119 		return !!(pincap & AC_PINCAP_IN);
120 	}
121 }
122 
123 static bool can_be_headset_mic(struct hda_codec *codec,
124 			       struct auto_pin_cfg_item *item,
125 			       int seq_number)
126 {
127 	int attr;
128 	unsigned int def_conf;
129 	if (item->type != AUTO_PIN_MIC)
130 		return false;
131 
132 	if (item->is_headset_mic || item->is_headphone_mic)
133 		return false; /* Already assigned */
134 
135 	def_conf = snd_hda_codec_get_pincfg(codec, item->pin);
136 	attr = snd_hda_get_input_pin_attr(def_conf);
137 	if (attr <= INPUT_PIN_ATTR_DOCK)
138 		return false;
139 
140 	if (seq_number >= 0) {
141 		int seq = get_defcfg_sequence(def_conf);
142 		if (seq != seq_number)
143 			return false;
144 	}
145 
146 	return true;
147 }
148 
149 /*
150  * Parse all pin widgets and store the useful pin nids to cfg
151  *
152  * The number of line-outs or any primary output is stored in line_outs,
153  * and the corresponding output pins are assigned to line_out_pins[],
154  * in the order of front, rear, CLFE, side, ...
155  *
156  * If more extra outputs (speaker and headphone) are found, the pins are
157  * assisnged to hp_pins[] and speaker_pins[], respectively.  If no line-out jack
158  * is detected, one of speaker of HP pins is assigned as the primary
159  * output, i.e. to line_out_pins[0].  So, line_outs is always positive
160  * if any analog output exists.
161  *
162  * The analog input pins are assigned to inputs array.
163  * The digital input/output pins are assigned to dig_in_pin and dig_out_pin,
164  * respectively.
165  */
166 int snd_hda_parse_pin_defcfg(struct hda_codec *codec,
167 			     struct auto_pin_cfg *cfg,
168 			     const hda_nid_t *ignore_nids,
169 			     unsigned int cond_flags)
170 {
171 	hda_nid_t nid;
172 	short seq, assoc_line_out;
173 	struct auto_out_pin line_out[ARRAY_SIZE(cfg->line_out_pins)];
174 	struct auto_out_pin speaker_out[ARRAY_SIZE(cfg->speaker_pins)];
175 	struct auto_out_pin hp_out[ARRAY_SIZE(cfg->hp_pins)];
176 	int i;
177 
178 	if (!snd_hda_get_int_hint(codec, "parser_flags", &i))
179 		cond_flags = i;
180 
181 	memset(cfg, 0, sizeof(*cfg));
182 
183 	memset(line_out, 0, sizeof(line_out));
184 	memset(speaker_out, 0, sizeof(speaker_out));
185 	memset(hp_out, 0, sizeof(hp_out));
186 	assoc_line_out = 0;
187 
188 	for_each_hda_codec_node(nid, codec) {
189 		unsigned int wid_caps = get_wcaps(codec, nid);
190 		unsigned int wid_type = get_wcaps_type(wid_caps);
191 		unsigned int def_conf;
192 		short assoc, loc, conn, dev;
193 
194 		/* read all default configuration for pin complex */
195 		if (wid_type != AC_WID_PIN)
196 			continue;
197 		/* ignore the given nids (e.g. pc-beep returns error) */
198 		if (ignore_nids && is_in_nid_list(nid, ignore_nids))
199 			continue;
200 
201 		def_conf = snd_hda_codec_get_pincfg(codec, nid);
202 		conn = get_defcfg_connect(def_conf);
203 		if (conn == AC_JACK_PORT_NONE)
204 			continue;
205 		loc = get_defcfg_location(def_conf);
206 		dev = get_defcfg_device(def_conf);
207 
208 		/* workaround for buggy BIOS setups */
209 		if (dev == AC_JACK_LINE_OUT) {
210 			if (conn == AC_JACK_PORT_FIXED ||
211 			    conn == AC_JACK_PORT_BOTH)
212 				dev = AC_JACK_SPEAKER;
213 		}
214 
215 		if (!check_pincap_validity(codec, nid, dev))
216 			continue;
217 
218 		switch (dev) {
219 		case AC_JACK_LINE_OUT:
220 			seq = get_defcfg_sequence(def_conf);
221 			assoc = get_defcfg_association(def_conf);
222 
223 			if (!(wid_caps & AC_WCAP_STEREO))
224 				if (!cfg->mono_out_pin)
225 					cfg->mono_out_pin = nid;
226 			if (!assoc)
227 				continue;
228 			if (!assoc_line_out)
229 				assoc_line_out = assoc;
230 			else if (assoc_line_out != assoc) {
231 				codec_info(codec,
232 					   "ignore pin 0x%x with mismatching assoc# 0x%x vs 0x%x\n",
233 					   nid, assoc, assoc_line_out);
234 				continue;
235 			}
236 			if (cfg->line_outs >= ARRAY_SIZE(cfg->line_out_pins)) {
237 				codec_info(codec,
238 					   "ignore pin 0x%x, too many assigned pins\n",
239 					   nid);
240 				continue;
241 			}
242 			line_out[cfg->line_outs].pin = nid;
243 			line_out[cfg->line_outs].seq = seq;
244 			cfg->line_outs++;
245 			break;
246 		case AC_JACK_SPEAKER:
247 			seq = get_defcfg_sequence(def_conf);
248 			assoc = get_defcfg_association(def_conf);
249 			if (cfg->speaker_outs >= ARRAY_SIZE(cfg->speaker_pins)) {
250 				codec_info(codec,
251 					   "ignore pin 0x%x, too many assigned pins\n",
252 					   nid);
253 				continue;
254 			}
255 			speaker_out[cfg->speaker_outs].pin = nid;
256 			speaker_out[cfg->speaker_outs].seq = (assoc << 4) | seq;
257 			cfg->speaker_outs++;
258 			break;
259 		case AC_JACK_HP_OUT:
260 			seq = get_defcfg_sequence(def_conf);
261 			assoc = get_defcfg_association(def_conf);
262 			if (cfg->hp_outs >= ARRAY_SIZE(cfg->hp_pins)) {
263 				codec_info(codec,
264 					   "ignore pin 0x%x, too many assigned pins\n",
265 					   nid);
266 				continue;
267 			}
268 			hp_out[cfg->hp_outs].pin = nid;
269 			hp_out[cfg->hp_outs].seq = (assoc << 4) | seq;
270 			cfg->hp_outs++;
271 			break;
272 		case AC_JACK_MIC_IN:
273 			add_auto_cfg_input_pin(codec, cfg, nid, AUTO_PIN_MIC);
274 			break;
275 		case AC_JACK_LINE_IN:
276 			add_auto_cfg_input_pin(codec, cfg, nid, AUTO_PIN_LINE_IN);
277 			break;
278 		case AC_JACK_CD:
279 			add_auto_cfg_input_pin(codec, cfg, nid, AUTO_PIN_CD);
280 			break;
281 		case AC_JACK_AUX:
282 			add_auto_cfg_input_pin(codec, cfg, nid, AUTO_PIN_AUX);
283 			break;
284 		case AC_JACK_SPDIF_OUT:
285 		case AC_JACK_DIG_OTHER_OUT:
286 			if (cfg->dig_outs >= ARRAY_SIZE(cfg->dig_out_pins)) {
287 				codec_info(codec,
288 					   "ignore pin 0x%x, too many assigned pins\n",
289 					   nid);
290 				continue;
291 			}
292 			cfg->dig_out_pins[cfg->dig_outs] = nid;
293 			cfg->dig_out_type[cfg->dig_outs] =
294 				(loc == AC_JACK_LOC_HDMI) ?
295 				HDA_PCM_TYPE_HDMI : HDA_PCM_TYPE_SPDIF;
296 			cfg->dig_outs++;
297 			break;
298 		case AC_JACK_SPDIF_IN:
299 		case AC_JACK_DIG_OTHER_IN:
300 			cfg->dig_in_pin = nid;
301 			if (loc == AC_JACK_LOC_HDMI)
302 				cfg->dig_in_type = HDA_PCM_TYPE_HDMI;
303 			else
304 				cfg->dig_in_type = HDA_PCM_TYPE_SPDIF;
305 			break;
306 		}
307 	}
308 
309 	/* Find a pin that could be a headset or headphone mic */
310 	if (cond_flags & HDA_PINCFG_HEADSET_MIC || cond_flags & HDA_PINCFG_HEADPHONE_MIC) {
311 		bool hsmic = !!(cond_flags & HDA_PINCFG_HEADSET_MIC);
312 		bool hpmic = !!(cond_flags & HDA_PINCFG_HEADPHONE_MIC);
313 		for (i = 0; (hsmic || hpmic) && (i < cfg->num_inputs); i++)
314 			if (hsmic && can_be_headset_mic(codec, &cfg->inputs[i], 0xc)) {
315 				cfg->inputs[i].is_headset_mic = 1;
316 				hsmic = false;
317 			} else if (hpmic && can_be_headset_mic(codec, &cfg->inputs[i], 0xd)) {
318 				cfg->inputs[i].is_headphone_mic = 1;
319 				hpmic = false;
320 			}
321 
322 		/* If we didn't find our sequence number mark, fall back to any sequence number */
323 		for (i = 0; (hsmic || hpmic) && (i < cfg->num_inputs); i++) {
324 			if (!can_be_headset_mic(codec, &cfg->inputs[i], -1))
325 				continue;
326 			if (hsmic) {
327 				cfg->inputs[i].is_headset_mic = 1;
328 				hsmic = false;
329 			} else if (hpmic) {
330 				cfg->inputs[i].is_headphone_mic = 1;
331 				hpmic = false;
332 			}
333 		}
334 
335 		if (hsmic)
336 			codec_dbg(codec, "Told to look for a headset mic, but didn't find any.\n");
337 		if (hpmic)
338 			codec_dbg(codec, "Told to look for a headphone mic, but didn't find any.\n");
339 	}
340 
341 	/* FIX-UP:
342 	 * If no line-out is defined but multiple HPs are found,
343 	 * some of them might be the real line-outs.
344 	 */
345 	if (!cfg->line_outs && cfg->hp_outs > 1 &&
346 	    !(cond_flags & HDA_PINCFG_NO_HP_FIXUP)) {
347 		int i = 0;
348 		while (i < cfg->hp_outs) {
349 			/* The real HPs should have the sequence 0x0f */
350 			if ((hp_out[i].seq & 0x0f) == 0x0f) {
351 				i++;
352 				continue;
353 			}
354 			/* Move it to the line-out table */
355 			line_out[cfg->line_outs++] = hp_out[i];
356 			cfg->hp_outs--;
357 			memmove(hp_out + i, hp_out + i + 1,
358 				sizeof(hp_out[0]) * (cfg->hp_outs - i));
359 		}
360 		memset(hp_out + cfg->hp_outs, 0,
361 		       sizeof(hp_out[0]) * (AUTO_CFG_MAX_OUTS - cfg->hp_outs));
362 		if (!cfg->hp_outs)
363 			cfg->line_out_type = AUTO_PIN_HP_OUT;
364 
365 	}
366 
367 	/* sort by sequence */
368 	sort_pins_by_sequence(cfg->line_out_pins, line_out, cfg->line_outs);
369 	sort_pins_by_sequence(cfg->speaker_pins, speaker_out,
370 			      cfg->speaker_outs);
371 	sort_pins_by_sequence(cfg->hp_pins, hp_out, cfg->hp_outs);
372 
373 	/*
374 	 * FIX-UP: if no line-outs are detected, try to use speaker or HP pin
375 	 * as a primary output
376 	 */
377 	if (!cfg->line_outs &&
378 	    !(cond_flags & HDA_PINCFG_NO_LO_FIXUP)) {
379 		if (cfg->speaker_outs) {
380 			cfg->line_outs = cfg->speaker_outs;
381 			memcpy(cfg->line_out_pins, cfg->speaker_pins,
382 			       sizeof(cfg->speaker_pins));
383 			cfg->speaker_outs = 0;
384 			memset(cfg->speaker_pins, 0, sizeof(cfg->speaker_pins));
385 			cfg->line_out_type = AUTO_PIN_SPEAKER_OUT;
386 		} else if (cfg->hp_outs) {
387 			cfg->line_outs = cfg->hp_outs;
388 			memcpy(cfg->line_out_pins, cfg->hp_pins,
389 			       sizeof(cfg->hp_pins));
390 			cfg->hp_outs = 0;
391 			memset(cfg->hp_pins, 0, sizeof(cfg->hp_pins));
392 			cfg->line_out_type = AUTO_PIN_HP_OUT;
393 		}
394 	}
395 
396 	reorder_outputs(cfg->line_outs, cfg->line_out_pins);
397 	reorder_outputs(cfg->hp_outs, cfg->hp_pins);
398 	reorder_outputs(cfg->speaker_outs, cfg->speaker_pins);
399 
400 	/* sort inputs in the order of AUTO_PIN_* type */
401 	sort(cfg->inputs, cfg->num_inputs, sizeof(cfg->inputs[0]),
402 	     compare_input_type, NULL);
403 
404 	/*
405 	 * debug prints of the parsed results
406 	 */
407 	codec_info(codec, "autoconfig for %s: line_outs=%d (0x%x/0x%x/0x%x/0x%x/0x%x) type:%s\n",
408 		   codec->core.chip_name, cfg->line_outs, cfg->line_out_pins[0],
409 		   cfg->line_out_pins[1], cfg->line_out_pins[2],
410 		   cfg->line_out_pins[3], cfg->line_out_pins[4],
411 		   cfg->line_out_type == AUTO_PIN_HP_OUT ? "hp" :
412 		   (cfg->line_out_type == AUTO_PIN_SPEAKER_OUT ?
413 		    "speaker" : "line"));
414 	codec_info(codec, "   speaker_outs=%d (0x%x/0x%x/0x%x/0x%x/0x%x)\n",
415 		   cfg->speaker_outs, cfg->speaker_pins[0],
416 		   cfg->speaker_pins[1], cfg->speaker_pins[2],
417 		   cfg->speaker_pins[3], cfg->speaker_pins[4]);
418 	codec_info(codec, "   hp_outs=%d (0x%x/0x%x/0x%x/0x%x/0x%x)\n",
419 		   cfg->hp_outs, cfg->hp_pins[0],
420 		   cfg->hp_pins[1], cfg->hp_pins[2],
421 		   cfg->hp_pins[3], cfg->hp_pins[4]);
422 	codec_info(codec, "   mono: mono_out=0x%x\n", cfg->mono_out_pin);
423 	if (cfg->dig_outs)
424 		codec_info(codec, "   dig-out=0x%x/0x%x\n",
425 			   cfg->dig_out_pins[0], cfg->dig_out_pins[1]);
426 	codec_info(codec, "   inputs:\n");
427 	for (i = 0; i < cfg->num_inputs; i++) {
428 		codec_info(codec, "     %s=0x%x\n",
429 			    hda_get_autocfg_input_label(codec, cfg, i),
430 			    cfg->inputs[i].pin);
431 	}
432 	if (cfg->dig_in_pin)
433 		codec_info(codec, "   dig-in=0x%x\n", cfg->dig_in_pin);
434 
435 	return 0;
436 }
437 EXPORT_SYMBOL_GPL(snd_hda_parse_pin_defcfg);
438 
439 /**
440  * snd_hda_get_input_pin_attr - Get the input pin attribute from pin config
441  * @def_conf: pin configuration value
442  *
443  * Guess the input pin attribute (INPUT_PIN_ATTR_XXX) from the given
444  * default pin configuration value.
445  */
446 int snd_hda_get_input_pin_attr(unsigned int def_conf)
447 {
448 	unsigned int loc = get_defcfg_location(def_conf);
449 	unsigned int conn = get_defcfg_connect(def_conf);
450 	if (conn == AC_JACK_PORT_NONE)
451 		return INPUT_PIN_ATTR_UNUSED;
452 	/* Windows may claim the internal mic to be BOTH, too */
453 	if (conn == AC_JACK_PORT_FIXED || conn == AC_JACK_PORT_BOTH)
454 		return INPUT_PIN_ATTR_INT;
455 	if ((loc & 0x30) == AC_JACK_LOC_INTERNAL)
456 		return INPUT_PIN_ATTR_INT;
457 	if ((loc & 0x30) == AC_JACK_LOC_SEPARATE)
458 		return INPUT_PIN_ATTR_DOCK;
459 	if (loc == AC_JACK_LOC_REAR)
460 		return INPUT_PIN_ATTR_REAR;
461 	if (loc == AC_JACK_LOC_FRONT)
462 		return INPUT_PIN_ATTR_FRONT;
463 	return INPUT_PIN_ATTR_NORMAL;
464 }
465 EXPORT_SYMBOL_GPL(snd_hda_get_input_pin_attr);
466 
467 /**
468  * hda_get_input_pin_label - Give a label for the given input pin
469  * @codec: the HDA codec
470  * @item: ping config item to refer
471  * @pin: the pin NID
472  * @check_location: flag to add the jack location prefix
473  *
474  * When @check_location is true, the function checks the pin location
475  * for mic and line-in pins, and set an appropriate prefix like "Front",
476  * "Rear", "Internal".
477  */
478 static const char *hda_get_input_pin_label(struct hda_codec *codec,
479 					   const struct auto_pin_cfg_item *item,
480 					   hda_nid_t pin, bool check_location)
481 {
482 	unsigned int def_conf;
483 	static const char * const mic_names[] = {
484 		"Internal Mic", "Dock Mic", "Mic", "Rear Mic", "Front Mic"
485 	};
486 	int attr;
487 
488 	def_conf = snd_hda_codec_get_pincfg(codec, pin);
489 
490 	switch (get_defcfg_device(def_conf)) {
491 	case AC_JACK_MIC_IN:
492 		if (item && item->is_headset_mic)
493 			return "Headset Mic";
494 		if (item && item->is_headphone_mic)
495 			return "Headphone Mic";
496 		if (!check_location)
497 			return "Mic";
498 		attr = snd_hda_get_input_pin_attr(def_conf);
499 		if (!attr)
500 			return "None";
501 		return mic_names[attr - 1];
502 	case AC_JACK_LINE_IN:
503 		if (!check_location)
504 			return "Line";
505 		attr = snd_hda_get_input_pin_attr(def_conf);
506 		if (!attr)
507 			return "None";
508 		if (attr == INPUT_PIN_ATTR_DOCK)
509 			return "Dock Line";
510 		return "Line";
511 	case AC_JACK_AUX:
512 		return "Aux";
513 	case AC_JACK_CD:
514 		return "CD";
515 	case AC_JACK_SPDIF_IN:
516 		return "SPDIF In";
517 	case AC_JACK_DIG_OTHER_IN:
518 		return "Digital In";
519 	case AC_JACK_HP_OUT:
520 		return "Headphone Mic";
521 	default:
522 		return "Misc";
523 	}
524 }
525 
526 /* Check whether the location prefix needs to be added to the label.
527  * If all mic-jacks are in the same location (e.g. rear panel), we don't
528  * have to put "Front" prefix to each label.  In such a case, returns false.
529  */
530 static int check_mic_location_need(struct hda_codec *codec,
531 				   const struct auto_pin_cfg *cfg,
532 				   int input)
533 {
534 	unsigned int defc;
535 	int i, attr, attr2;
536 
537 	defc = snd_hda_codec_get_pincfg(codec, cfg->inputs[input].pin);
538 	attr = snd_hda_get_input_pin_attr(defc);
539 	/* for internal or docking mics, we need locations */
540 	if (attr <= INPUT_PIN_ATTR_NORMAL)
541 		return 1;
542 
543 	attr = 0;
544 	for (i = 0; i < cfg->num_inputs; i++) {
545 		defc = snd_hda_codec_get_pincfg(codec, cfg->inputs[i].pin);
546 		attr2 = snd_hda_get_input_pin_attr(defc);
547 		if (attr2 >= INPUT_PIN_ATTR_NORMAL) {
548 			if (attr && attr != attr2)
549 				return 1; /* different locations found */
550 			attr = attr2;
551 		}
552 	}
553 	return 0;
554 }
555 
556 /**
557  * hda_get_autocfg_input_label - Get a label for the given input
558  * @codec: the HDA codec
559  * @cfg: the parsed pin configuration
560  * @input: the input index number
561  *
562  * Get a label for the given input pin defined by the autocfg item.
563  * Unlike hda_get_input_pin_label(), this function checks all inputs
564  * defined in autocfg and avoids the redundant mic/line prefix as much as
565  * possible.
566  */
567 const char *hda_get_autocfg_input_label(struct hda_codec *codec,
568 					const struct auto_pin_cfg *cfg,
569 					int input)
570 {
571 	int type = cfg->inputs[input].type;
572 	int has_multiple_pins = 0;
573 
574 	if ((input > 0 && cfg->inputs[input - 1].type == type) ||
575 	    (input < cfg->num_inputs - 1 && cfg->inputs[input + 1].type == type))
576 		has_multiple_pins = 1;
577 	if (has_multiple_pins && type == AUTO_PIN_MIC)
578 		has_multiple_pins &= check_mic_location_need(codec, cfg, input);
579 	has_multiple_pins |= codec->force_pin_prefix;
580 	return hda_get_input_pin_label(codec, &cfg->inputs[input],
581 				       cfg->inputs[input].pin,
582 				       has_multiple_pins);
583 }
584 EXPORT_SYMBOL_GPL(hda_get_autocfg_input_label);
585 
586 /* return the position of NID in the list, or -1 if not found */
587 static int find_idx_in_nid_list(hda_nid_t nid, const hda_nid_t *list, int nums)
588 {
589 	int i;
590 	for (i = 0; i < nums; i++)
591 		if (list[i] == nid)
592 			return i;
593 	return -1;
594 }
595 
596 /* get a unique suffix or an index number */
597 static const char *check_output_sfx(hda_nid_t nid, const hda_nid_t *pins,
598 				    int num_pins, int *indexp)
599 {
600 	static const char * const channel_sfx[] = {
601 		" Front", " Surround", " CLFE", " Side"
602 	};
603 	int i;
604 
605 	i = find_idx_in_nid_list(nid, pins, num_pins);
606 	if (i < 0)
607 		return NULL;
608 	if (num_pins == 1)
609 		return "";
610 	if (num_pins > ARRAY_SIZE(channel_sfx)) {
611 		if (indexp)
612 			*indexp = i;
613 		return "";
614 	}
615 	return channel_sfx[i];
616 }
617 
618 static const char *check_output_pfx(struct hda_codec *codec, hda_nid_t nid)
619 {
620 	unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
621 	int attr = snd_hda_get_input_pin_attr(def_conf);
622 
623 	/* check the location */
624 	switch (attr) {
625 	case INPUT_PIN_ATTR_DOCK:
626 		return "Dock ";
627 	case INPUT_PIN_ATTR_FRONT:
628 		return "Front ";
629 	}
630 	return "";
631 }
632 
633 static int get_hp_label_index(struct hda_codec *codec, hda_nid_t nid,
634 			      const hda_nid_t *pins, int num_pins)
635 {
636 	int i, j, idx = 0;
637 
638 	const char *pfx = check_output_pfx(codec, nid);
639 
640 	i = find_idx_in_nid_list(nid, pins, num_pins);
641 	if (i < 0)
642 		return -1;
643 	for (j = 0; j < i; j++)
644 		if (pfx == check_output_pfx(codec, pins[j]))
645 			idx++;
646 
647 	return idx;
648 }
649 
650 static int fill_audio_out_name(struct hda_codec *codec, hda_nid_t nid,
651 			       const struct auto_pin_cfg *cfg,
652 			       const char *name, char *label, int maxlen,
653 			       int *indexp)
654 {
655 	unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
656 	int attr = snd_hda_get_input_pin_attr(def_conf);
657 	const char *pfx, *sfx = "";
658 
659 	/* handle as a speaker if it's a fixed line-out */
660 	if (!strcmp(name, "Line Out") && attr == INPUT_PIN_ATTR_INT)
661 		name = "Speaker";
662 	pfx = check_output_pfx(codec, nid);
663 
664 	if (cfg) {
665 		/* try to give a unique suffix if needed */
666 		sfx = check_output_sfx(nid, cfg->line_out_pins, cfg->line_outs,
667 				       indexp);
668 		if (!sfx)
669 			sfx = check_output_sfx(nid, cfg->speaker_pins, cfg->speaker_outs,
670 					       indexp);
671 		if (!sfx) {
672 			/* don't add channel suffix for Headphone controls */
673 			int idx = get_hp_label_index(codec, nid, cfg->hp_pins,
674 						     cfg->hp_outs);
675 			if (idx >= 0 && indexp)
676 				*indexp = idx;
677 			sfx = "";
678 		}
679 	}
680 	snprintf(label, maxlen, "%s%s%s", pfx, name, sfx);
681 	return 1;
682 }
683 
684 #define is_hdmi_cfg(conf) \
685 	(get_defcfg_location(conf) == AC_JACK_LOC_HDMI)
686 
687 /**
688  * snd_hda_get_pin_label - Get a label for the given I/O pin
689  * @codec: the HDA codec
690  * @nid: pin NID
691  * @cfg: the parsed pin configuration
692  * @label: the string buffer to store
693  * @maxlen: the max length of string buffer (including termination)
694  * @indexp: the pointer to return the index number (for multiple ctls)
695  *
696  * Get a label for the given pin.  This function works for both input and
697  * output pins.  When @cfg is given as non-NULL, the function tries to get
698  * an optimized label using hda_get_autocfg_input_label().
699  *
700  * This function tries to give a unique label string for the pin as much as
701  * possible.  For example, when the multiple line-outs are present, it adds
702  * the channel suffix like "Front", "Surround", etc (only when @cfg is given).
703  * If no unique name with a suffix is available and @indexp is non-NULL, the
704  * index number is stored in the pointer.
705  */
706 int snd_hda_get_pin_label(struct hda_codec *codec, hda_nid_t nid,
707 			  const struct auto_pin_cfg *cfg,
708 			  char *label, int maxlen, int *indexp)
709 {
710 	unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
711 	const char *name = NULL;
712 	int i;
713 	bool hdmi;
714 
715 	if (indexp)
716 		*indexp = 0;
717 	if (get_defcfg_connect(def_conf) == AC_JACK_PORT_NONE)
718 		return 0;
719 
720 	switch (get_defcfg_device(def_conf)) {
721 	case AC_JACK_LINE_OUT:
722 		return fill_audio_out_name(codec, nid, cfg, "Line Out",
723 					   label, maxlen, indexp);
724 	case AC_JACK_SPEAKER:
725 		return fill_audio_out_name(codec, nid, cfg, "Speaker",
726 					   label, maxlen, indexp);
727 	case AC_JACK_HP_OUT:
728 		return fill_audio_out_name(codec, nid, cfg, "Headphone",
729 					   label, maxlen, indexp);
730 	case AC_JACK_SPDIF_OUT:
731 	case AC_JACK_DIG_OTHER_OUT:
732 		hdmi = is_hdmi_cfg(def_conf);
733 		name = hdmi ? "HDMI" : "SPDIF";
734 		if (cfg && indexp)
735 			for (i = 0; i < cfg->dig_outs; i++) {
736 				hda_nid_t pin = cfg->dig_out_pins[i];
737 				unsigned int c;
738 				if (pin == nid)
739 					break;
740 				c = snd_hda_codec_get_pincfg(codec, pin);
741 				if (hdmi == is_hdmi_cfg(c))
742 					(*indexp)++;
743 			}
744 		break;
745 	default:
746 		if (cfg) {
747 			for (i = 0; i < cfg->num_inputs; i++) {
748 				if (cfg->inputs[i].pin != nid)
749 					continue;
750 				name = hda_get_autocfg_input_label(codec, cfg, i);
751 				if (name)
752 					break;
753 			}
754 		}
755 		if (!name)
756 			name = hda_get_input_pin_label(codec, NULL, nid, true);
757 		break;
758 	}
759 	if (!name)
760 		return 0;
761 	strlcpy(label, name, maxlen);
762 	return 1;
763 }
764 EXPORT_SYMBOL_GPL(snd_hda_get_pin_label);
765 
766 /**
767  * snd_hda_add_verbs - Add verbs to the init list
768  * @codec: the HDA codec
769  * @list: zero-terminated verb list to add
770  *
771  * Append the given verb list to the execution list.  The verbs will be
772  * performed at init and resume time via snd_hda_apply_verbs().
773  */
774 int snd_hda_add_verbs(struct hda_codec *codec,
775 		      const struct hda_verb *list)
776 {
777 	const struct hda_verb **v;
778 	v = snd_array_new(&codec->verbs);
779 	if (!v)
780 		return -ENOMEM;
781 	*v = list;
782 	return 0;
783 }
784 EXPORT_SYMBOL_GPL(snd_hda_add_verbs);
785 
786 /**
787  * snd_hda_apply_verbs - Execute the init verb lists
788  * @codec: the HDA codec
789  */
790 void snd_hda_apply_verbs(struct hda_codec *codec)
791 {
792 	const struct hda_verb **v;
793 	int i;
794 
795 	snd_array_for_each(&codec->verbs, i, v)
796 		snd_hda_sequence_write(codec, *v);
797 }
798 EXPORT_SYMBOL_GPL(snd_hda_apply_verbs);
799 
800 /**
801  * snd_hda_apply_pincfgs - Set each pin config in the given list
802  * @codec: the HDA codec
803  * @cfg: NULL-terminated pin config table
804  */
805 void snd_hda_apply_pincfgs(struct hda_codec *codec,
806 			   const struct hda_pintbl *cfg)
807 {
808 	for (; cfg->nid; cfg++)
809 		snd_hda_codec_set_pincfg(codec, cfg->nid, cfg->val);
810 }
811 EXPORT_SYMBOL_GPL(snd_hda_apply_pincfgs);
812 
813 static void set_pin_targets(struct hda_codec *codec,
814 			    const struct hda_pintbl *cfg)
815 {
816 	for (; cfg->nid; cfg++)
817 		snd_hda_set_pin_ctl_cache(codec, cfg->nid, cfg->val);
818 }
819 
820 static void apply_fixup(struct hda_codec *codec, int id, int action, int depth)
821 {
822 	const char *modelname = codec->fixup_name;
823 
824 	while (id >= 0) {
825 		const struct hda_fixup *fix = codec->fixup_list + id;
826 
827 		if (++depth > 10)
828 			break;
829 		if (fix->chained_before)
830 			apply_fixup(codec, fix->chain_id, action, depth + 1);
831 
832 		switch (fix->type) {
833 		case HDA_FIXUP_PINS:
834 			if (action != HDA_FIXUP_ACT_PRE_PROBE || !fix->v.pins)
835 				break;
836 			codec_dbg(codec, "%s: Apply pincfg for %s\n",
837 				    codec->core.chip_name, modelname);
838 			snd_hda_apply_pincfgs(codec, fix->v.pins);
839 			break;
840 		case HDA_FIXUP_VERBS:
841 			if (action != HDA_FIXUP_ACT_PROBE || !fix->v.verbs)
842 				break;
843 			codec_dbg(codec, "%s: Apply fix-verbs for %s\n",
844 				    codec->core.chip_name, modelname);
845 			snd_hda_add_verbs(codec, fix->v.verbs);
846 			break;
847 		case HDA_FIXUP_FUNC:
848 			if (!fix->v.func)
849 				break;
850 			codec_dbg(codec, "%s: Apply fix-func for %s\n",
851 				    codec->core.chip_name, modelname);
852 			fix->v.func(codec, fix, action);
853 			break;
854 		case HDA_FIXUP_PINCTLS:
855 			if (action != HDA_FIXUP_ACT_PROBE || !fix->v.pins)
856 				break;
857 			codec_dbg(codec, "%s: Apply pinctl for %s\n",
858 				    codec->core.chip_name, modelname);
859 			set_pin_targets(codec, fix->v.pins);
860 			break;
861 		default:
862 			codec_err(codec, "%s: Invalid fixup type %d\n",
863 				   codec->core.chip_name, fix->type);
864 			break;
865 		}
866 		if (!fix->chained || fix->chained_before)
867 			break;
868 		id = fix->chain_id;
869 	}
870 }
871 
872 /**
873  * snd_hda_apply_fixup - Apply the fixup chain with the given action
874  * @codec: the HDA codec
875  * @action: fixup action (HDA_FIXUP_ACT_XXX)
876  */
877 void snd_hda_apply_fixup(struct hda_codec *codec, int action)
878 {
879 	if (codec->fixup_list)
880 		apply_fixup(codec, codec->fixup_id, action, 0);
881 }
882 EXPORT_SYMBOL_GPL(snd_hda_apply_fixup);
883 
884 #define IGNORE_SEQ_ASSOC (~(AC_DEFCFG_SEQUENCE | AC_DEFCFG_DEF_ASSOC))
885 
886 static bool pin_config_match(struct hda_codec *codec,
887 			     const struct hda_pintbl *pins,
888 			     bool match_all_pins)
889 {
890 	const struct hda_pincfg *pin;
891 	int i;
892 
893 	snd_array_for_each(&codec->init_pins, i, pin) {
894 		hda_nid_t nid = pin->nid;
895 		u32 cfg = pin->cfg;
896 		const struct hda_pintbl *t_pins;
897 		int found;
898 
899 		t_pins = pins;
900 		found = 0;
901 		for (; t_pins->nid; t_pins++) {
902 			if (t_pins->nid == nid) {
903 				found = 1;
904 				if ((t_pins->val & IGNORE_SEQ_ASSOC) == (cfg & IGNORE_SEQ_ASSOC))
905 					break;
906 				else if ((cfg & 0xf0000000) == 0x40000000 && (t_pins->val & 0xf0000000) == 0x40000000)
907 					break;
908 				else
909 					return false;
910 			}
911 		}
912 		if (match_all_pins &&
913 		    !found && (cfg & 0xf0000000) != 0x40000000)
914 			return false;
915 	}
916 
917 	return true;
918 }
919 
920 /**
921  * snd_hda_pick_pin_fixup - Pick up a fixup matching with the pin quirk list
922  * @codec: the HDA codec
923  * @pin_quirk: zero-terminated pin quirk list
924  * @fixlist: the fixup list
925  * @match_all_pins: all valid pins must match with the table entries
926  */
927 void snd_hda_pick_pin_fixup(struct hda_codec *codec,
928 			    const struct snd_hda_pin_quirk *pin_quirk,
929 			    const struct hda_fixup *fixlist,
930 			    bool match_all_pins)
931 {
932 	const struct snd_hda_pin_quirk *pq;
933 
934 	if (codec->fixup_id != HDA_FIXUP_ID_NOT_SET)
935 		return;
936 
937 	for (pq = pin_quirk; pq->subvendor; pq++) {
938 		if ((codec->core.subsystem_id & 0xffff0000) != (pq->subvendor << 16))
939 			continue;
940 		if (codec->core.vendor_id != pq->codec)
941 			continue;
942 		if (pin_config_match(codec, pq->pins, match_all_pins)) {
943 			codec->fixup_id = pq->value;
944 #ifdef CONFIG_SND_DEBUG_VERBOSE
945 			codec->fixup_name = pq->name;
946 			codec_dbg(codec, "%s: picked fixup %s (pin match)\n",
947 				  codec->core.chip_name, codec->fixup_name);
948 #endif
949 			codec->fixup_list = fixlist;
950 			return;
951 		}
952 	}
953 }
954 EXPORT_SYMBOL_GPL(snd_hda_pick_pin_fixup);
955 
956 /**
957  * snd_hda_pick_fixup - Pick up a fixup matching with PCI/codec SSID or model string
958  * @codec: the HDA codec
959  * @models: NULL-terminated model string list
960  * @quirk: zero-terminated PCI/codec SSID quirk list
961  * @fixlist: the fixup list
962  *
963  * Pick up a fixup entry matching with the given model string or SSID.
964  * If a fixup was already set beforehand, the function doesn't do anything.
965  * When a special model string "nofixup" is given, also no fixup is applied.
966  *
967  * The function tries to find the matching model name at first, if given.
968  * If nothing matched, try to look up the PCI SSID.
969  * If still nothing matched, try to look up the codec SSID.
970  */
971 void snd_hda_pick_fixup(struct hda_codec *codec,
972 			const struct hda_model_fixup *models,
973 			const struct snd_pci_quirk *quirk,
974 			const struct hda_fixup *fixlist)
975 {
976 	const struct snd_pci_quirk *q;
977 	int id = HDA_FIXUP_ID_NOT_SET;
978 	const char *name = NULL;
979 
980 	if (codec->fixup_id != HDA_FIXUP_ID_NOT_SET)
981 		return;
982 
983 	/* when model=nofixup is given, don't pick up any fixups */
984 	if (codec->modelname && !strcmp(codec->modelname, "nofixup")) {
985 		codec->fixup_list = NULL;
986 		codec->fixup_name = NULL;
987 		codec->fixup_id = HDA_FIXUP_ID_NO_FIXUP;
988 		codec_dbg(codec, "%s: picked no fixup (nofixup specified)\n",
989 			  codec->core.chip_name);
990 		return;
991 	}
992 
993 	if (codec->modelname && models) {
994 		while (models->name) {
995 			if (!strcmp(codec->modelname, models->name)) {
996 				codec->fixup_id = models->id;
997 				codec->fixup_name = models->name;
998 				codec->fixup_list = fixlist;
999 				codec_dbg(codec, "%s: picked fixup %s (model specified)\n",
1000 					  codec->core.chip_name, codec->fixup_name);
1001 				return;
1002 			}
1003 			models++;
1004 		}
1005 	}
1006 	if (quirk) {
1007 		q = snd_pci_quirk_lookup(codec->bus->pci, quirk);
1008 		if (q) {
1009 			id = q->value;
1010 #ifdef CONFIG_SND_DEBUG_VERBOSE
1011 			name = q->name;
1012 			codec_dbg(codec, "%s: picked fixup %s (PCI SSID%s)\n",
1013 				  codec->core.chip_name, name, q->subdevice_mask ? "" : " - vendor generic");
1014 #endif
1015 		}
1016 	}
1017 	if (id < 0 && quirk) {
1018 		for (q = quirk; q->subvendor || q->subdevice; q++) {
1019 			unsigned int vendorid =
1020 				q->subdevice | (q->subvendor << 16);
1021 			unsigned int mask = 0xffff0000 | q->subdevice_mask;
1022 			if ((codec->core.subsystem_id & mask) == (vendorid & mask)) {
1023 				id = q->value;
1024 #ifdef CONFIG_SND_DEBUG_VERBOSE
1025 				name = q->name;
1026 				codec_dbg(codec, "%s: picked fixup %s (codec SSID)\n",
1027 					  codec->core.chip_name, name);
1028 #endif
1029 				break;
1030 			}
1031 		}
1032 	}
1033 
1034 	codec->fixup_id = id;
1035 	if (id >= 0) {
1036 		codec->fixup_list = fixlist;
1037 		codec->fixup_name = name;
1038 	}
1039 }
1040 EXPORT_SYMBOL_GPL(snd_hda_pick_fixup);
1041