Merge tag 'master-2014-07-31' of git://git.kernel.org/pub/scm/linux/kernel/git/linvil...
[cascardo/linux.git] / sound / pci / hda / hda_auto_parser.c
1 /*
2  * BIOS auto-parser helper functions for HD-audio
3  *
4  * Copyright (c) 2012 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
12 #include <linux/slab.h>
13 #include <linux/export.h>
14 #include <linux/sort.h>
15 #include <sound/core.h>
16 #include "hda_codec.h"
17 #include "hda_local.h"
18 #include "hda_auto_parser.h"
19
20 #define SFX     "hda_codec: "
21
22 /*
23  * Helper for automatic pin configuration
24  */
25
26 static int is_in_nid_list(hda_nid_t nid, const hda_nid_t *list)
27 {
28         for (; *list; list++)
29                 if (*list == nid)
30                         return 1;
31         return 0;
32 }
33
34 /* a pair of input pin and its sequence */
35 struct auto_out_pin {
36         hda_nid_t pin;
37         short seq;
38 };
39
40 static int compare_seq(const void *ap, const void *bp)
41 {
42         const struct auto_out_pin *a = ap;
43         const struct auto_out_pin *b = bp;
44         return (int)(a->seq - b->seq);
45 }
46
47 /*
48  * Sort an associated group of pins according to their sequence numbers.
49  * then store it to a pin array.
50  */
51 static void sort_pins_by_sequence(hda_nid_t *pins, struct auto_out_pin *list,
52                                   int num_pins)
53 {
54         int i;
55         sort(list, num_pins, sizeof(list[0]), compare_seq, NULL);
56         for (i = 0; i < num_pins; i++)
57                 pins[i] = list[i].pin;
58 }
59
60
61 /* add the found input-pin to the cfg->inputs[] table */
62 static void add_auto_cfg_input_pin(struct auto_pin_cfg *cfg, hda_nid_t nid,
63                                    int type)
64 {
65         if (cfg->num_inputs < AUTO_CFG_MAX_INS) {
66                 cfg->inputs[cfg->num_inputs].pin = nid;
67                 cfg->inputs[cfg->num_inputs].type = type;
68                 cfg->num_inputs++;
69         }
70 }
71
72 static int compare_input_type(const void *ap, const void *bp)
73 {
74         const struct auto_pin_cfg_item *a = ap;
75         const struct auto_pin_cfg_item *b = bp;
76         return (int)(a->type - b->type);
77 }
78
79 /* Reorder the surround channels
80  * ALSA sequence is front/surr/clfe/side
81  * HDA sequence is:
82  *    4-ch: front/surr  =>  OK as it is
83  *    6-ch: front/clfe/surr
84  *    8-ch: front/clfe/rear/side|fc
85  */
86 static void reorder_outputs(unsigned int nums, hda_nid_t *pins)
87 {
88         hda_nid_t nid;
89
90         switch (nums) {
91         case 3:
92         case 4:
93                 nid = pins[1];
94                 pins[1] = pins[2];
95                 pins[2] = nid;
96                 break;
97         }
98 }
99
100 /* check whether the given pin has a proper pin I/O capability bit */
101 static bool check_pincap_validity(struct hda_codec *codec, hda_nid_t pin,
102                                   unsigned int dev)
103 {
104         unsigned int pincap = snd_hda_query_pin_caps(codec, pin);
105
106         /* some old hardware don't return the proper pincaps */
107         if (!pincap)
108                 return true;
109
110         switch (dev) {
111         case AC_JACK_LINE_OUT:
112         case AC_JACK_SPEAKER:
113         case AC_JACK_HP_OUT:
114         case AC_JACK_SPDIF_OUT:
115         case AC_JACK_DIG_OTHER_OUT:
116                 return !!(pincap & AC_PINCAP_OUT);
117         default:
118                 return !!(pincap & AC_PINCAP_IN);
119         }
120 }
121
122 static bool can_be_headset_mic(struct hda_codec *codec,
123                                struct auto_pin_cfg_item *item,
124                                int seq_number)
125 {
126         int attr;
127         unsigned int def_conf;
128         if (item->type != AUTO_PIN_MIC)
129                 return false;
130
131         if (item->is_headset_mic || item->is_headphone_mic)
132                 return false; /* Already assigned */
133
134         def_conf = snd_hda_codec_get_pincfg(codec, item->pin);
135         attr = snd_hda_get_input_pin_attr(def_conf);
136         if (attr <= INPUT_PIN_ATTR_DOCK)
137                 return false;
138
139         if (seq_number >= 0) {
140                 int seq = get_defcfg_sequence(def_conf);
141                 if (seq != seq_number)
142                         return false;
143         }
144
145         return true;
146 }
147
148 /*
149  * Parse all pin widgets and store the useful pin nids to cfg
150  *
151  * The number of line-outs or any primary output is stored in line_outs,
152  * and the corresponding output pins are assigned to line_out_pins[],
153  * in the order of front, rear, CLFE, side, ...
154  *
155  * If more extra outputs (speaker and headphone) are found, the pins are
156  * assisnged to hp_pins[] and speaker_pins[], respectively.  If no line-out jack
157  * is detected, one of speaker of HP pins is assigned as the primary
158  * output, i.e. to line_out_pins[0].  So, line_outs is always positive
159  * if any analog output exists.
160  *
161  * The analog input pins are assigned to inputs array.
162  * The digital input/output pins are assigned to dig_in_pin and dig_out_pin,
163  * respectively.
164  */
165 int snd_hda_parse_pin_defcfg(struct hda_codec *codec,
166                              struct auto_pin_cfg *cfg,
167                              const hda_nid_t *ignore_nids,
168                              unsigned int cond_flags)
169 {
170         hda_nid_t nid, end_nid;
171         short seq, assoc_line_out;
172         struct auto_out_pin line_out[ARRAY_SIZE(cfg->line_out_pins)];
173         struct auto_out_pin speaker_out[ARRAY_SIZE(cfg->speaker_pins)];
174         struct auto_out_pin hp_out[ARRAY_SIZE(cfg->hp_pins)];
175         int i;
176
177         if (!snd_hda_get_int_hint(codec, "parser_flags", &i))
178                 cond_flags = i;
179
180         memset(cfg, 0, sizeof(*cfg));
181
182         memset(line_out, 0, sizeof(line_out));
183         memset(speaker_out, 0, sizeof(speaker_out));
184         memset(hp_out, 0, sizeof(hp_out));
185         assoc_line_out = 0;
186
187         end_nid = codec->start_nid + codec->num_nodes;
188         for (nid = codec->start_nid; nid < end_nid; nid++) {
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(cfg, nid, AUTO_PIN_MIC);
274                         break;
275                 case AC_JACK_LINE_IN:
276                         add_auto_cfg_input_pin(cfg, nid, AUTO_PIN_LINE_IN);
277                         break;
278                 case AC_JACK_CD:
279                         add_auto_cfg_input_pin(cfg, nid, AUTO_PIN_CD);
280                         break;
281                 case AC_JACK_AUX:
282                         add_auto_cfg_input_pin(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: line_outs=%d (0x%x/0x%x/0x%x/0x%x/0x%x) type:%s\n",
408                    cfg->line_outs, cfg->line_out_pins[0], cfg->line_out_pins[1],
409                    cfg->line_out_pins[2], cfg->line_out_pins[3],
410                    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 int snd_hda_get_input_pin_attr(unsigned int def_conf)
440 {
441         unsigned int loc = get_defcfg_location(def_conf);
442         unsigned int conn = get_defcfg_connect(def_conf);
443         if (conn == AC_JACK_PORT_NONE)
444                 return INPUT_PIN_ATTR_UNUSED;
445         /* Windows may claim the internal mic to be BOTH, too */
446         if (conn == AC_JACK_PORT_FIXED || conn == AC_JACK_PORT_BOTH)
447                 return INPUT_PIN_ATTR_INT;
448         if ((loc & 0x30) == AC_JACK_LOC_INTERNAL)
449                 return INPUT_PIN_ATTR_INT;
450         if ((loc & 0x30) == AC_JACK_LOC_SEPARATE)
451                 return INPUT_PIN_ATTR_DOCK;
452         if (loc == AC_JACK_LOC_REAR)
453                 return INPUT_PIN_ATTR_REAR;
454         if (loc == AC_JACK_LOC_FRONT)
455                 return INPUT_PIN_ATTR_FRONT;
456         return INPUT_PIN_ATTR_NORMAL;
457 }
458 EXPORT_SYMBOL_GPL(snd_hda_get_input_pin_attr);
459
460 /**
461  * hda_get_input_pin_label - Give a label for the given input pin
462  *
463  * When check_location is true, the function checks the pin location
464  * for mic and line-in pins, and set an appropriate prefix like "Front",
465  * "Rear", "Internal".
466  */
467
468 static const char *hda_get_input_pin_label(struct hda_codec *codec,
469                                            const struct auto_pin_cfg_item *item,
470                                            hda_nid_t pin, bool check_location)
471 {
472         unsigned int def_conf;
473         static const char * const mic_names[] = {
474                 "Internal Mic", "Dock Mic", "Mic", "Rear Mic", "Front Mic"
475         };
476         int attr;
477
478         def_conf = snd_hda_codec_get_pincfg(codec, pin);
479
480         switch (get_defcfg_device(def_conf)) {
481         case AC_JACK_MIC_IN:
482                 if (item && item->is_headset_mic)
483                         return "Headset Mic";
484                 if (item && item->is_headphone_mic)
485                         return "Headphone Mic";
486                 if (!check_location)
487                         return "Mic";
488                 attr = snd_hda_get_input_pin_attr(def_conf);
489                 if (!attr)
490                         return "None";
491                 return mic_names[attr - 1];
492         case AC_JACK_LINE_IN:
493                 if (!check_location)
494                         return "Line";
495                 attr = snd_hda_get_input_pin_attr(def_conf);
496                 if (!attr)
497                         return "None";
498                 if (attr == INPUT_PIN_ATTR_DOCK)
499                         return "Dock Line";
500                 return "Line";
501         case AC_JACK_AUX:
502                 return "Aux";
503         case AC_JACK_CD:
504                 return "CD";
505         case AC_JACK_SPDIF_IN:
506                 return "SPDIF In";
507         case AC_JACK_DIG_OTHER_IN:
508                 return "Digital In";
509         case AC_JACK_HP_OUT:
510                 return "Headphone Mic";
511         default:
512                 return "Misc";
513         }
514 }
515
516 /* Check whether the location prefix needs to be added to the label.
517  * If all mic-jacks are in the same location (e.g. rear panel), we don't
518  * have to put "Front" prefix to each label.  In such a case, returns false.
519  */
520 static int check_mic_location_need(struct hda_codec *codec,
521                                    const struct auto_pin_cfg *cfg,
522                                    int input)
523 {
524         unsigned int defc;
525         int i, attr, attr2;
526
527         defc = snd_hda_codec_get_pincfg(codec, cfg->inputs[input].pin);
528         attr = snd_hda_get_input_pin_attr(defc);
529         /* for internal or docking mics, we need locations */
530         if (attr <= INPUT_PIN_ATTR_NORMAL)
531                 return 1;
532
533         attr = 0;
534         for (i = 0; i < cfg->num_inputs; i++) {
535                 defc = snd_hda_codec_get_pincfg(codec, cfg->inputs[i].pin);
536                 attr2 = snd_hda_get_input_pin_attr(defc);
537                 if (attr2 >= INPUT_PIN_ATTR_NORMAL) {
538                         if (attr && attr != attr2)
539                                 return 1; /* different locations found */
540                         attr = attr2;
541                 }
542         }
543         return 0;
544 }
545
546 /**
547  * hda_get_autocfg_input_label - Get a label for the given input
548  *
549  * Get a label for the given input pin defined by the autocfg item.
550  * Unlike hda_get_input_pin_label(), this function checks all inputs
551  * defined in autocfg and avoids the redundant mic/line prefix as much as
552  * possible.
553  */
554 const char *hda_get_autocfg_input_label(struct hda_codec *codec,
555                                         const struct auto_pin_cfg *cfg,
556                                         int input)
557 {
558         int type = cfg->inputs[input].type;
559         int has_multiple_pins = 0;
560
561         if ((input > 0 && cfg->inputs[input - 1].type == type) ||
562             (input < cfg->num_inputs - 1 && cfg->inputs[input + 1].type == type))
563                 has_multiple_pins = 1;
564         if (has_multiple_pins && type == AUTO_PIN_MIC)
565                 has_multiple_pins &= check_mic_location_need(codec, cfg, input);
566         return hda_get_input_pin_label(codec, &cfg->inputs[input],
567                                        cfg->inputs[input].pin,
568                                        has_multiple_pins);
569 }
570 EXPORT_SYMBOL_GPL(hda_get_autocfg_input_label);
571
572 /* return the position of NID in the list, or -1 if not found */
573 static int find_idx_in_nid_list(hda_nid_t nid, const hda_nid_t *list, int nums)
574 {
575         int i;
576         for (i = 0; i < nums; i++)
577                 if (list[i] == nid)
578                         return i;
579         return -1;
580 }
581
582 /* get a unique suffix or an index number */
583 static const char *check_output_sfx(hda_nid_t nid, const hda_nid_t *pins,
584                                     int num_pins, int *indexp)
585 {
586         static const char * const channel_sfx[] = {
587                 " Front", " Surround", " CLFE", " Side"
588         };
589         int i;
590
591         i = find_idx_in_nid_list(nid, pins, num_pins);
592         if (i < 0)
593                 return NULL;
594         if (num_pins == 1)
595                 return "";
596         if (num_pins > ARRAY_SIZE(channel_sfx)) {
597                 if (indexp)
598                         *indexp = i;
599                 return "";
600         }
601         return channel_sfx[i];
602 }
603
604 static const char *check_output_pfx(struct hda_codec *codec, hda_nid_t nid)
605 {
606         unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
607         int attr = snd_hda_get_input_pin_attr(def_conf);
608
609         /* check the location */
610         switch (attr) {
611         case INPUT_PIN_ATTR_DOCK:
612                 return "Dock ";
613         case INPUT_PIN_ATTR_FRONT:
614                 return "Front ";
615         }
616         return "";
617 }
618
619 static int get_hp_label_index(struct hda_codec *codec, hda_nid_t nid,
620                               const hda_nid_t *pins, int num_pins)
621 {
622         int i, j, idx = 0;
623
624         const char *pfx = check_output_pfx(codec, nid);
625
626         i = find_idx_in_nid_list(nid, pins, num_pins);
627         if (i < 0)
628                 return -1;
629         for (j = 0; j < i; j++)
630                 if (pfx == check_output_pfx(codec, pins[j]))
631                         idx++;
632
633         return idx;
634 }
635
636 static int fill_audio_out_name(struct hda_codec *codec, hda_nid_t nid,
637                                const struct auto_pin_cfg *cfg,
638                                const char *name, char *label, int maxlen,
639                                int *indexp)
640 {
641         unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
642         int attr = snd_hda_get_input_pin_attr(def_conf);
643         const char *pfx, *sfx = "";
644
645         /* handle as a speaker if it's a fixed line-out */
646         if (!strcmp(name, "Line Out") && attr == INPUT_PIN_ATTR_INT)
647                 name = "Speaker";
648         pfx = check_output_pfx(codec, nid);
649
650         if (cfg) {
651                 /* try to give a unique suffix if needed */
652                 sfx = check_output_sfx(nid, cfg->line_out_pins, cfg->line_outs,
653                                        indexp);
654                 if (!sfx)
655                         sfx = check_output_sfx(nid, cfg->speaker_pins, cfg->speaker_outs,
656                                                indexp);
657                 if (!sfx) {
658                         /* don't add channel suffix for Headphone controls */
659                         int idx = get_hp_label_index(codec, nid, cfg->hp_pins,
660                                                      cfg->hp_outs);
661                         if (idx >= 0 && indexp)
662                                 *indexp = idx;
663                         sfx = "";
664                 }
665         }
666         snprintf(label, maxlen, "%s%s%s", pfx, name, sfx);
667         return 1;
668 }
669
670 #define is_hdmi_cfg(conf) \
671         (get_defcfg_location(conf) == AC_JACK_LOC_HDMI)
672
673 /**
674  * snd_hda_get_pin_label - Get a label for the given I/O pin
675  *
676  * Get a label for the given pin.  This function works for both input and
677  * output pins.  When @cfg is given as non-NULL, the function tries to get
678  * an optimized label using hda_get_autocfg_input_label().
679  *
680  * This function tries to give a unique label string for the pin as much as
681  * possible.  For example, when the multiple line-outs are present, it adds
682  * the channel suffix like "Front", "Surround", etc (only when @cfg is given).
683  * If no unique name with a suffix is available and @indexp is non-NULL, the
684  * index number is stored in the pointer.
685  */
686 int snd_hda_get_pin_label(struct hda_codec *codec, hda_nid_t nid,
687                           const struct auto_pin_cfg *cfg,
688                           char *label, int maxlen, int *indexp)
689 {
690         unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
691         const char *name = NULL;
692         int i;
693         bool hdmi;
694
695         if (indexp)
696                 *indexp = 0;
697         if (get_defcfg_connect(def_conf) == AC_JACK_PORT_NONE)
698                 return 0;
699
700         switch (get_defcfg_device(def_conf)) {
701         case AC_JACK_LINE_OUT:
702                 return fill_audio_out_name(codec, nid, cfg, "Line Out",
703                                            label, maxlen, indexp);
704         case AC_JACK_SPEAKER:
705                 return fill_audio_out_name(codec, nid, cfg, "Speaker",
706                                            label, maxlen, indexp);
707         case AC_JACK_HP_OUT:
708                 return fill_audio_out_name(codec, nid, cfg, "Headphone",
709                                            label, maxlen, indexp);
710         case AC_JACK_SPDIF_OUT:
711         case AC_JACK_DIG_OTHER_OUT:
712                 hdmi = is_hdmi_cfg(def_conf);
713                 name = hdmi ? "HDMI" : "SPDIF";
714                 if (cfg && indexp)
715                         for (i = 0; i < cfg->dig_outs; i++) {
716                                 hda_nid_t pin = cfg->dig_out_pins[i];
717                                 unsigned int c;
718                                 if (pin == nid)
719                                         break;
720                                 c = snd_hda_codec_get_pincfg(codec, pin);
721                                 if (hdmi == is_hdmi_cfg(c))
722                                         (*indexp)++;
723                         }
724                 break;
725         default:
726                 if (cfg) {
727                         for (i = 0; i < cfg->num_inputs; i++) {
728                                 if (cfg->inputs[i].pin != nid)
729                                         continue;
730                                 name = hda_get_autocfg_input_label(codec, cfg, i);
731                                 if (name)
732                                         break;
733                         }
734                 }
735                 if (!name)
736                         name = hda_get_input_pin_label(codec, NULL, nid, true);
737                 break;
738         }
739         if (!name)
740                 return 0;
741         strlcpy(label, name, maxlen);
742         return 1;
743 }
744 EXPORT_SYMBOL_GPL(snd_hda_get_pin_label);
745
746 int snd_hda_add_verbs(struct hda_codec *codec,
747                       const struct hda_verb *list)
748 {
749         const struct hda_verb **v;
750         v = snd_array_new(&codec->verbs);
751         if (!v)
752                 return -ENOMEM;
753         *v = list;
754         return 0;
755 }
756 EXPORT_SYMBOL_GPL(snd_hda_add_verbs);
757
758 void snd_hda_apply_verbs(struct hda_codec *codec)
759 {
760         int i;
761         for (i = 0; i < codec->verbs.used; i++) {
762                 struct hda_verb **v = snd_array_elem(&codec->verbs, i);
763                 snd_hda_sequence_write(codec, *v);
764         }
765 }
766 EXPORT_SYMBOL_GPL(snd_hda_apply_verbs);
767
768 void snd_hda_apply_pincfgs(struct hda_codec *codec,
769                            const struct hda_pintbl *cfg)
770 {
771         for (; cfg->nid; cfg++)
772                 snd_hda_codec_set_pincfg(codec, cfg->nid, cfg->val);
773 }
774 EXPORT_SYMBOL_GPL(snd_hda_apply_pincfgs);
775
776 static void set_pin_targets(struct hda_codec *codec,
777                             const struct hda_pintbl *cfg)
778 {
779         for (; cfg->nid; cfg++)
780                 snd_hda_set_pin_ctl_cache(codec, cfg->nid, cfg->val);
781 }
782
783 static void apply_fixup(struct hda_codec *codec, int id, int action, int depth)
784 {
785         const char *modelname = codec->fixup_name;
786
787         while (id >= 0) {
788                 const struct hda_fixup *fix = codec->fixup_list + id;
789
790                 if (fix->chained_before)
791                         apply_fixup(codec, fix->chain_id, action, depth + 1);
792
793                 switch (fix->type) {
794                 case HDA_FIXUP_PINS:
795                         if (action != HDA_FIXUP_ACT_PRE_PROBE || !fix->v.pins)
796                                 break;
797                         codec_dbg(codec, "%s: Apply pincfg for %s\n",
798                                     codec->chip_name, modelname);
799                         snd_hda_apply_pincfgs(codec, fix->v.pins);
800                         break;
801                 case HDA_FIXUP_VERBS:
802                         if (action != HDA_FIXUP_ACT_PROBE || !fix->v.verbs)
803                                 break;
804                         codec_dbg(codec, "%s: Apply fix-verbs for %s\n",
805                                     codec->chip_name, modelname);
806                         snd_hda_add_verbs(codec, fix->v.verbs);
807                         break;
808                 case HDA_FIXUP_FUNC:
809                         if (!fix->v.func)
810                                 break;
811                         codec_dbg(codec, "%s: Apply fix-func for %s\n",
812                                     codec->chip_name, modelname);
813                         fix->v.func(codec, fix, action);
814                         break;
815                 case HDA_FIXUP_PINCTLS:
816                         if (action != HDA_FIXUP_ACT_PROBE || !fix->v.pins)
817                                 break;
818                         codec_dbg(codec, "%s: Apply pinctl for %s\n",
819                                     codec->chip_name, modelname);
820                         set_pin_targets(codec, fix->v.pins);
821                         break;
822                 default:
823                         codec_err(codec, "%s: Invalid fixup type %d\n",
824                                    codec->chip_name, fix->type);
825                         break;
826                 }
827                 if (!fix->chained || fix->chained_before)
828                         break;
829                 if (++depth > 10)
830                         break;
831                 id = fix->chain_id;
832         }
833 }
834
835 void snd_hda_apply_fixup(struct hda_codec *codec, int action)
836 {
837         if (codec->fixup_list)
838                 apply_fixup(codec, codec->fixup_id, action, 0);
839 }
840 EXPORT_SYMBOL_GPL(snd_hda_apply_fixup);
841
842 static bool pin_config_match(struct hda_codec *codec,
843                              const struct hda_pintbl *pins)
844 {
845         for (; pins->nid; pins++) {
846                 u32 def_conf = snd_hda_codec_get_pincfg(codec, pins->nid);
847                 if (pins->val != def_conf)
848                         return false;
849         }
850         return true;
851 }
852
853 void snd_hda_pick_pin_fixup(struct hda_codec *codec,
854                             const struct snd_hda_pin_quirk *pin_quirk,
855                             const struct hda_fixup *fixlist)
856 {
857         const struct snd_hda_pin_quirk *pq;
858
859         if (codec->fixup_forced)
860                 return;
861
862         for (pq = pin_quirk; pq->subvendor; pq++) {
863                 if ((codec->subsystem_id & 0xffff0000) != (pq->subvendor << 16))
864                         continue;
865                 if (codec->vendor_id != pq->codec)
866                         continue;
867                 if (pin_config_match(codec, pq->pins)) {
868                         codec->fixup_id = pq->value;
869 #ifdef CONFIG_SND_DEBUG_VERBOSE
870                         codec->fixup_name = pq->name;
871 #endif
872                         codec->fixup_list = fixlist;
873                         return;
874                 }
875         }
876 }
877 EXPORT_SYMBOL_GPL(snd_hda_pick_pin_fixup);
878
879 void snd_hda_pick_fixup(struct hda_codec *codec,
880                         const struct hda_model_fixup *models,
881                         const struct snd_pci_quirk *quirk,
882                         const struct hda_fixup *fixlist)
883 {
884         const struct snd_pci_quirk *q;
885         int id = -1;
886         const char *name = NULL;
887
888         /* when model=nofixup is given, don't pick up any fixups */
889         if (codec->modelname && !strcmp(codec->modelname, "nofixup")) {
890                 codec->fixup_list = NULL;
891                 codec->fixup_id = -1;
892                 codec->fixup_forced = 1;
893                 return;
894         }
895
896         if (codec->modelname && models) {
897                 while (models->name) {
898                         if (!strcmp(codec->modelname, models->name)) {
899                                 codec->fixup_id = models->id;
900                                 codec->fixup_name = models->name;
901                                 codec->fixup_list = fixlist;
902                                 codec->fixup_forced = 1;
903                                 return;
904                         }
905                         models++;
906                 }
907         }
908         if (id < 0 && quirk) {
909                 q = snd_pci_quirk_lookup(codec->bus->pci, quirk);
910                 if (q) {
911                         id = q->value;
912 #ifdef CONFIG_SND_DEBUG_VERBOSE
913                         name = q->name;
914 #endif
915                 }
916         }
917         if (id < 0 && quirk) {
918                 for (q = quirk; q->subvendor || q->subdevice; q++) {
919                         unsigned int vendorid =
920                                 q->subdevice | (q->subvendor << 16);
921                         unsigned int mask = 0xffff0000 | q->subdevice_mask;
922                         if ((codec->subsystem_id & mask) == (vendorid & mask)) {
923                                 id = q->value;
924 #ifdef CONFIG_SND_DEBUG_VERBOSE
925                                 name = q->name;
926 #endif
927                                 break;
928                         }
929                 }
930         }
931
932         codec->fixup_forced = 0;
933         codec->fixup_id = id;
934         if (id >= 0) {
935                 codec->fixup_list = fixlist;
936                 codec->fixup_name = name;
937         }
938 }
939 EXPORT_SYMBOL_GPL(snd_hda_pick_fixup);