xref: /openbmc/linux/sound/pci/hda/hda_codec.c (revision 9fb29c73)
1 /*
2  * Universal Interface for Intel High Definition Audio Codec
3  *
4  * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
5  *
6  *
7  *  This driver is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This driver is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
20  */
21 
22 #include <linux/init.h>
23 #include <linux/delay.h>
24 #include <linux/slab.h>
25 #include <linux/mutex.h>
26 #include <linux/module.h>
27 #include <linux/pm.h>
28 #include <linux/pm_runtime.h>
29 #include <sound/core.h>
30 #include <sound/hda_codec.h>
31 #include <sound/asoundef.h>
32 #include <sound/tlv.h>
33 #include <sound/initval.h>
34 #include <sound/jack.h>
35 #include "hda_local.h"
36 #include "hda_beep.h"
37 #include "hda_jack.h"
38 #include <sound/hda_hwdep.h>
39 #include <sound/hda_component.h>
40 
41 #define codec_in_pm(codec)		snd_hdac_is_in_pm(&codec->core)
42 #define hda_codec_is_power_on(codec)	snd_hdac_is_power_on(&codec->core)
43 #define codec_has_epss(codec) \
44 	((codec)->core.power_caps & AC_PWRST_EPSS)
45 #define codec_has_clkstop(codec) \
46 	((codec)->core.power_caps & AC_PWRST_CLKSTOP)
47 
48 /*
49  * Send and receive a verb - passed to exec_verb override for hdac_device
50  */
51 static int codec_exec_verb(struct hdac_device *dev, unsigned int cmd,
52 			   unsigned int flags, unsigned int *res)
53 {
54 	struct hda_codec *codec = container_of(dev, struct hda_codec, core);
55 	struct hda_bus *bus = codec->bus;
56 	int err;
57 
58 	if (cmd == ~0)
59 		return -1;
60 
61  again:
62 	snd_hda_power_up_pm(codec);
63 	mutex_lock(&bus->core.cmd_mutex);
64 	if (flags & HDA_RW_NO_RESPONSE_FALLBACK)
65 		bus->no_response_fallback = 1;
66 	err = snd_hdac_bus_exec_verb_unlocked(&bus->core, codec->core.addr,
67 					      cmd, res);
68 	bus->no_response_fallback = 0;
69 	mutex_unlock(&bus->core.cmd_mutex);
70 	snd_hda_power_down_pm(codec);
71 	if (!codec_in_pm(codec) && res && err == -EAGAIN) {
72 		if (bus->response_reset) {
73 			codec_dbg(codec,
74 				  "resetting BUS due to fatal communication error\n");
75 			snd_hda_bus_reset(bus);
76 		}
77 		goto again;
78 	}
79 	/* clear reset-flag when the communication gets recovered */
80 	if (!err || codec_in_pm(codec))
81 		bus->response_reset = 0;
82 	return err;
83 }
84 
85 /**
86  * snd_hda_sequence_write - sequence writes
87  * @codec: the HDA codec
88  * @seq: VERB array to send
89  *
90  * Send the commands sequentially from the given array.
91  * The array must be terminated with NID=0.
92  */
93 void snd_hda_sequence_write(struct hda_codec *codec, const struct hda_verb *seq)
94 {
95 	for (; seq->nid; seq++)
96 		snd_hda_codec_write(codec, seq->nid, 0, seq->verb, seq->param);
97 }
98 EXPORT_SYMBOL_GPL(snd_hda_sequence_write);
99 
100 /* connection list element */
101 struct hda_conn_list {
102 	struct list_head list;
103 	int len;
104 	hda_nid_t nid;
105 	hda_nid_t conns[0];
106 };
107 
108 /* look up the cached results */
109 static struct hda_conn_list *
110 lookup_conn_list(struct hda_codec *codec, hda_nid_t nid)
111 {
112 	struct hda_conn_list *p;
113 	list_for_each_entry(p, &codec->conn_list, list) {
114 		if (p->nid == nid)
115 			return p;
116 	}
117 	return NULL;
118 }
119 
120 static int add_conn_list(struct hda_codec *codec, hda_nid_t nid, int len,
121 			 const hda_nid_t *list)
122 {
123 	struct hda_conn_list *p;
124 
125 	p = kmalloc(sizeof(*p) + len * sizeof(hda_nid_t), GFP_KERNEL);
126 	if (!p)
127 		return -ENOMEM;
128 	p->len = len;
129 	p->nid = nid;
130 	memcpy(p->conns, list, len * sizeof(hda_nid_t));
131 	list_add(&p->list, &codec->conn_list);
132 	return 0;
133 }
134 
135 static void remove_conn_list(struct hda_codec *codec)
136 {
137 	while (!list_empty(&codec->conn_list)) {
138 		struct hda_conn_list *p;
139 		p = list_first_entry(&codec->conn_list, typeof(*p), list);
140 		list_del(&p->list);
141 		kfree(p);
142 	}
143 }
144 
145 /* read the connection and add to the cache */
146 static int read_and_add_raw_conns(struct hda_codec *codec, hda_nid_t nid)
147 {
148 	hda_nid_t list[32];
149 	hda_nid_t *result = list;
150 	int len;
151 
152 	len = snd_hda_get_raw_connections(codec, nid, list, ARRAY_SIZE(list));
153 	if (len == -ENOSPC) {
154 		len = snd_hda_get_num_raw_conns(codec, nid);
155 		result = kmalloc_array(len, sizeof(hda_nid_t), GFP_KERNEL);
156 		if (!result)
157 			return -ENOMEM;
158 		len = snd_hda_get_raw_connections(codec, nid, result, len);
159 	}
160 	if (len >= 0)
161 		len = snd_hda_override_conn_list(codec, nid, len, result);
162 	if (result != list)
163 		kfree(result);
164 	return len;
165 }
166 
167 /**
168  * snd_hda_get_conn_list - get connection list
169  * @codec: the HDA codec
170  * @nid: NID to parse
171  * @listp: the pointer to store NID list
172  *
173  * Parses the connection list of the given widget and stores the pointer
174  * to the list of NIDs.
175  *
176  * Returns the number of connections, or a negative error code.
177  *
178  * Note that the returned pointer isn't protected against the list
179  * modification.  If snd_hda_override_conn_list() might be called
180  * concurrently, protect with a mutex appropriately.
181  */
182 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
183 			  const hda_nid_t **listp)
184 {
185 	bool added = false;
186 
187 	for (;;) {
188 		int err;
189 		const struct hda_conn_list *p;
190 
191 		/* if the connection-list is already cached, read it */
192 		p = lookup_conn_list(codec, nid);
193 		if (p) {
194 			if (listp)
195 				*listp = p->conns;
196 			return p->len;
197 		}
198 		if (snd_BUG_ON(added))
199 			return -EINVAL;
200 
201 		err = read_and_add_raw_conns(codec, nid);
202 		if (err < 0)
203 			return err;
204 		added = true;
205 	}
206 }
207 EXPORT_SYMBOL_GPL(snd_hda_get_conn_list);
208 
209 /**
210  * snd_hda_get_connections - copy connection list
211  * @codec: the HDA codec
212  * @nid: NID to parse
213  * @conn_list: connection list array; when NULL, checks only the size
214  * @max_conns: max. number of connections to store
215  *
216  * Parses the connection list of the given widget and stores the list
217  * of NIDs.
218  *
219  * Returns the number of connections, or a negative error code.
220  */
221 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
222 			    hda_nid_t *conn_list, int max_conns)
223 {
224 	const hda_nid_t *list;
225 	int len = snd_hda_get_conn_list(codec, nid, &list);
226 
227 	if (len > 0 && conn_list) {
228 		if (len > max_conns) {
229 			codec_err(codec, "Too many connections %d for NID 0x%x\n",
230 				   len, nid);
231 			return -EINVAL;
232 		}
233 		memcpy(conn_list, list, len * sizeof(hda_nid_t));
234 	}
235 
236 	return len;
237 }
238 EXPORT_SYMBOL_GPL(snd_hda_get_connections);
239 
240 /**
241  * snd_hda_override_conn_list - add/modify the connection-list to cache
242  * @codec: the HDA codec
243  * @nid: NID to parse
244  * @len: number of connection list entries
245  * @list: the list of connection entries
246  *
247  * Add or modify the given connection-list to the cache.  If the corresponding
248  * cache already exists, invalidate it and append a new one.
249  *
250  * Returns zero or a negative error code.
251  */
252 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int len,
253 			       const hda_nid_t *list)
254 {
255 	struct hda_conn_list *p;
256 
257 	p = lookup_conn_list(codec, nid);
258 	if (p) {
259 		list_del(&p->list);
260 		kfree(p);
261 	}
262 
263 	return add_conn_list(codec, nid, len, list);
264 }
265 EXPORT_SYMBOL_GPL(snd_hda_override_conn_list);
266 
267 /**
268  * snd_hda_get_conn_index - get the connection index of the given NID
269  * @codec: the HDA codec
270  * @mux: NID containing the list
271  * @nid: NID to select
272  * @recursive: 1 when searching NID recursively, otherwise 0
273  *
274  * Parses the connection list of the widget @mux and checks whether the
275  * widget @nid is present.  If it is, return the connection index.
276  * Otherwise it returns -1.
277  */
278 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
279 			   hda_nid_t nid, int recursive)
280 {
281 	const hda_nid_t *conn;
282 	int i, nums;
283 
284 	nums = snd_hda_get_conn_list(codec, mux, &conn);
285 	for (i = 0; i < nums; i++)
286 		if (conn[i] == nid)
287 			return i;
288 	if (!recursive)
289 		return -1;
290 	if (recursive > 10) {
291 		codec_dbg(codec, "too deep connection for 0x%x\n", nid);
292 		return -1;
293 	}
294 	recursive++;
295 	for (i = 0; i < nums; i++) {
296 		unsigned int type = get_wcaps_type(get_wcaps(codec, conn[i]));
297 		if (type == AC_WID_PIN || type == AC_WID_AUD_OUT)
298 			continue;
299 		if (snd_hda_get_conn_index(codec, conn[i], nid, recursive) >= 0)
300 			return i;
301 	}
302 	return -1;
303 }
304 EXPORT_SYMBOL_GPL(snd_hda_get_conn_index);
305 
306 /**
307  * snd_hda_get_num_devices - get DEVLIST_LEN parameter of the given widget
308  *  @codec: the HDA codec
309  *  @nid: NID of the pin to parse
310  *
311  * Get the device entry number on the given widget. This is a feature of
312  * DP MST audio. Each pin can have several device entries in it.
313  */
314 unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid)
315 {
316 	unsigned int wcaps = get_wcaps(codec, nid);
317 	unsigned int parm;
318 
319 	if (!codec->dp_mst || !(wcaps & AC_WCAP_DIGITAL) ||
320 	    get_wcaps_type(wcaps) != AC_WID_PIN)
321 		return 0;
322 
323 	parm = snd_hdac_read_parm_uncached(&codec->core, nid, AC_PAR_DEVLIST_LEN);
324 	if (parm == -1)
325 		parm = 0;
326 	return parm & AC_DEV_LIST_LEN_MASK;
327 }
328 EXPORT_SYMBOL_GPL(snd_hda_get_num_devices);
329 
330 /**
331  * snd_hda_get_devices - copy device list without cache
332  * @codec: the HDA codec
333  * @nid: NID of the pin to parse
334  * @dev_list: device list array
335  * @max_devices: max. number of devices to store
336  *
337  * Copy the device list. This info is dynamic and so not cached.
338  * Currently called only from hda_proc.c, so not exported.
339  */
340 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
341 			u8 *dev_list, int max_devices)
342 {
343 	unsigned int parm;
344 	int i, dev_len, devices;
345 
346 	parm = snd_hda_get_num_devices(codec, nid);
347 	if (!parm)	/* not multi-stream capable */
348 		return 0;
349 
350 	dev_len = parm + 1;
351 	dev_len = dev_len < max_devices ? dev_len : max_devices;
352 
353 	devices = 0;
354 	while (devices < dev_len) {
355 		if (snd_hdac_read(&codec->core, nid,
356 				  AC_VERB_GET_DEVICE_LIST, devices, &parm))
357 			break; /* error */
358 
359 		for (i = 0; i < 8; i++) {
360 			dev_list[devices] = (u8)parm;
361 			parm >>= 4;
362 			devices++;
363 			if (devices >= dev_len)
364 				break;
365 		}
366 	}
367 	return devices;
368 }
369 
370 /**
371  * snd_hda_get_dev_select - get device entry select on the pin
372  * @codec: the HDA codec
373  * @nid: NID of the pin to get device entry select
374  *
375  * Get the devcie entry select on the pin. Return the device entry
376  * id selected on the pin. Return 0 means the first device entry
377  * is selected or MST is not supported.
378  */
379 int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid)
380 {
381 	/* not support dp_mst will always return 0, using first dev_entry */
382 	if (!codec->dp_mst)
383 		return 0;
384 
385 	return snd_hda_codec_read(codec, nid, 0, AC_VERB_GET_DEVICE_SEL, 0);
386 }
387 EXPORT_SYMBOL_GPL(snd_hda_get_dev_select);
388 
389 /**
390  * snd_hda_set_dev_select - set device entry select on the pin
391  * @codec: the HDA codec
392  * @nid: NID of the pin to set device entry select
393  * @dev_id: device entry id to be set
394  *
395  * Set the device entry select on the pin nid.
396  */
397 int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id)
398 {
399 	int ret, num_devices;
400 
401 	/* not support dp_mst will always return 0, using first dev_entry */
402 	if (!codec->dp_mst)
403 		return 0;
404 
405 	/* AC_PAR_DEVLIST_LEN is 0 based. */
406 	num_devices = snd_hda_get_num_devices(codec, nid) + 1;
407 	/* If Device List Length is 0 (num_device = 1),
408 	 * the pin is not multi stream capable.
409 	 * Do nothing in this case.
410 	 */
411 	if (num_devices == 1)
412 		return 0;
413 
414 	/* Behavior of setting index being equal to or greater than
415 	 * Device List Length is not predictable
416 	 */
417 	if (num_devices <= dev_id)
418 		return -EINVAL;
419 
420 	ret = snd_hda_codec_write(codec, nid, 0,
421 			AC_VERB_SET_DEVICE_SEL, dev_id);
422 
423 	return ret;
424 }
425 EXPORT_SYMBOL_GPL(snd_hda_set_dev_select);
426 
427 /*
428  * read widget caps for each widget and store in cache
429  */
430 static int read_widget_caps(struct hda_codec *codec, hda_nid_t fg_node)
431 {
432 	int i;
433 	hda_nid_t nid;
434 
435 	codec->wcaps = kmalloc_array(codec->core.num_nodes, 4, GFP_KERNEL);
436 	if (!codec->wcaps)
437 		return -ENOMEM;
438 	nid = codec->core.start_nid;
439 	for (i = 0; i < codec->core.num_nodes; i++, nid++)
440 		codec->wcaps[i] = snd_hdac_read_parm_uncached(&codec->core,
441 					nid, AC_PAR_AUDIO_WIDGET_CAP);
442 	return 0;
443 }
444 
445 /* read all pin default configurations and save codec->init_pins */
446 static int read_pin_defaults(struct hda_codec *codec)
447 {
448 	hda_nid_t nid;
449 
450 	for_each_hda_codec_node(nid, codec) {
451 		struct hda_pincfg *pin;
452 		unsigned int wcaps = get_wcaps(codec, nid);
453 		unsigned int wid_type = get_wcaps_type(wcaps);
454 		if (wid_type != AC_WID_PIN)
455 			continue;
456 		pin = snd_array_new(&codec->init_pins);
457 		if (!pin)
458 			return -ENOMEM;
459 		pin->nid = nid;
460 		pin->cfg = snd_hda_codec_read(codec, nid, 0,
461 					      AC_VERB_GET_CONFIG_DEFAULT, 0);
462 		/*
463 		 * all device entries are the same widget control so far
464 		 * fixme: if any codec is different, need fix here
465 		 */
466 		pin->ctrl = snd_hda_codec_read(codec, nid, 0,
467 					       AC_VERB_GET_PIN_WIDGET_CONTROL,
468 					       0);
469 	}
470 	return 0;
471 }
472 
473 /* look up the given pin config list and return the item matching with NID */
474 static struct hda_pincfg *look_up_pincfg(struct hda_codec *codec,
475 					 struct snd_array *array,
476 					 hda_nid_t nid)
477 {
478 	struct hda_pincfg *pin;
479 	int i;
480 
481 	snd_array_for_each(array, i, pin) {
482 		if (pin->nid == nid)
483 			return pin;
484 	}
485 	return NULL;
486 }
487 
488 /* set the current pin config value for the given NID.
489  * the value is cached, and read via snd_hda_codec_get_pincfg()
490  */
491 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
492 		       hda_nid_t nid, unsigned int cfg)
493 {
494 	struct hda_pincfg *pin;
495 
496 	/* the check below may be invalid when pins are added by a fixup
497 	 * dynamically (e.g. via snd_hda_codec_update_widgets()), so disabled
498 	 * for now
499 	 */
500 	/*
501 	if (get_wcaps_type(get_wcaps(codec, nid)) != AC_WID_PIN)
502 		return -EINVAL;
503 	*/
504 
505 	pin = look_up_pincfg(codec, list, nid);
506 	if (!pin) {
507 		pin = snd_array_new(list);
508 		if (!pin)
509 			return -ENOMEM;
510 		pin->nid = nid;
511 	}
512 	pin->cfg = cfg;
513 	return 0;
514 }
515 
516 /**
517  * snd_hda_codec_set_pincfg - Override a pin default configuration
518  * @codec: the HDA codec
519  * @nid: NID to set the pin config
520  * @cfg: the pin default config value
521  *
522  * Override a pin default configuration value in the cache.
523  * This value can be read by snd_hda_codec_get_pincfg() in a higher
524  * priority than the real hardware value.
525  */
526 int snd_hda_codec_set_pincfg(struct hda_codec *codec,
527 			     hda_nid_t nid, unsigned int cfg)
528 {
529 	return snd_hda_add_pincfg(codec, &codec->driver_pins, nid, cfg);
530 }
531 EXPORT_SYMBOL_GPL(snd_hda_codec_set_pincfg);
532 
533 /**
534  * snd_hda_codec_get_pincfg - Obtain a pin-default configuration
535  * @codec: the HDA codec
536  * @nid: NID to get the pin config
537  *
538  * Get the current pin config value of the given pin NID.
539  * If the pincfg value is cached or overridden via sysfs or driver,
540  * returns the cached value.
541  */
542 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid)
543 {
544 	struct hda_pincfg *pin;
545 
546 #ifdef CONFIG_SND_HDA_RECONFIG
547 	{
548 		unsigned int cfg = 0;
549 		mutex_lock(&codec->user_mutex);
550 		pin = look_up_pincfg(codec, &codec->user_pins, nid);
551 		if (pin)
552 			cfg = pin->cfg;
553 		mutex_unlock(&codec->user_mutex);
554 		if (cfg)
555 			return cfg;
556 	}
557 #endif
558 	pin = look_up_pincfg(codec, &codec->driver_pins, nid);
559 	if (pin)
560 		return pin->cfg;
561 	pin = look_up_pincfg(codec, &codec->init_pins, nid);
562 	if (pin)
563 		return pin->cfg;
564 	return 0;
565 }
566 EXPORT_SYMBOL_GPL(snd_hda_codec_get_pincfg);
567 
568 /**
569  * snd_hda_codec_set_pin_target - remember the current pinctl target value
570  * @codec: the HDA codec
571  * @nid: pin NID
572  * @val: assigned pinctl value
573  *
574  * This function stores the given value to a pinctl target value in the
575  * pincfg table.  This isn't always as same as the actually written value
576  * but can be referred at any time via snd_hda_codec_get_pin_target().
577  */
578 int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
579 				 unsigned int val)
580 {
581 	struct hda_pincfg *pin;
582 
583 	pin = look_up_pincfg(codec, &codec->init_pins, nid);
584 	if (!pin)
585 		return -EINVAL;
586 	pin->target = val;
587 	return 0;
588 }
589 EXPORT_SYMBOL_GPL(snd_hda_codec_set_pin_target);
590 
591 /**
592  * snd_hda_codec_get_pin_target - return the current pinctl target value
593  * @codec: the HDA codec
594  * @nid: pin NID
595  */
596 int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid)
597 {
598 	struct hda_pincfg *pin;
599 
600 	pin = look_up_pincfg(codec, &codec->init_pins, nid);
601 	if (!pin)
602 		return 0;
603 	return pin->target;
604 }
605 EXPORT_SYMBOL_GPL(snd_hda_codec_get_pin_target);
606 
607 /**
608  * snd_hda_shutup_pins - Shut up all pins
609  * @codec: the HDA codec
610  *
611  * Clear all pin controls to shup up before suspend for avoiding click noise.
612  * The controls aren't cached so that they can be resumed properly.
613  */
614 void snd_hda_shutup_pins(struct hda_codec *codec)
615 {
616 	const struct hda_pincfg *pin;
617 	int i;
618 
619 	/* don't shut up pins when unloading the driver; otherwise it breaks
620 	 * the default pin setup at the next load of the driver
621 	 */
622 	if (codec->bus->shutdown)
623 		return;
624 	snd_array_for_each(&codec->init_pins, i, pin) {
625 		/* use read here for syncing after issuing each verb */
626 		snd_hda_codec_read(codec, pin->nid, 0,
627 				   AC_VERB_SET_PIN_WIDGET_CONTROL, 0);
628 	}
629 	codec->pins_shutup = 1;
630 }
631 EXPORT_SYMBOL_GPL(snd_hda_shutup_pins);
632 
633 #ifdef CONFIG_PM
634 /* Restore the pin controls cleared previously via snd_hda_shutup_pins() */
635 static void restore_shutup_pins(struct hda_codec *codec)
636 {
637 	const struct hda_pincfg *pin;
638 	int i;
639 
640 	if (!codec->pins_shutup)
641 		return;
642 	if (codec->bus->shutdown)
643 		return;
644 	snd_array_for_each(&codec->init_pins, i, pin) {
645 		snd_hda_codec_write(codec, pin->nid, 0,
646 				    AC_VERB_SET_PIN_WIDGET_CONTROL,
647 				    pin->ctrl);
648 	}
649 	codec->pins_shutup = 0;
650 }
651 #endif
652 
653 static void hda_jackpoll_work(struct work_struct *work)
654 {
655 	struct hda_codec *codec =
656 		container_of(work, struct hda_codec, jackpoll_work.work);
657 
658 	snd_hda_jack_set_dirty_all(codec);
659 	snd_hda_jack_poll_all(codec);
660 
661 	if (!codec->jackpoll_interval)
662 		return;
663 
664 	schedule_delayed_work(&codec->jackpoll_work,
665 			      codec->jackpoll_interval);
666 }
667 
668 /* release all pincfg lists */
669 static void free_init_pincfgs(struct hda_codec *codec)
670 {
671 	snd_array_free(&codec->driver_pins);
672 #ifdef CONFIG_SND_HDA_RECONFIG
673 	snd_array_free(&codec->user_pins);
674 #endif
675 	snd_array_free(&codec->init_pins);
676 }
677 
678 /*
679  * audio-converter setup caches
680  */
681 struct hda_cvt_setup {
682 	hda_nid_t nid;
683 	u8 stream_tag;
684 	u8 channel_id;
685 	u16 format_id;
686 	unsigned char active;	/* cvt is currently used */
687 	unsigned char dirty;	/* setups should be cleared */
688 };
689 
690 /* get or create a cache entry for the given audio converter NID */
691 static struct hda_cvt_setup *
692 get_hda_cvt_setup(struct hda_codec *codec, hda_nid_t nid)
693 {
694 	struct hda_cvt_setup *p;
695 	int i;
696 
697 	snd_array_for_each(&codec->cvt_setups, i, p) {
698 		if (p->nid == nid)
699 			return p;
700 	}
701 	p = snd_array_new(&codec->cvt_setups);
702 	if (p)
703 		p->nid = nid;
704 	return p;
705 }
706 
707 /*
708  * PCM device
709  */
710 static void release_pcm(struct kref *kref)
711 {
712 	struct hda_pcm *pcm = container_of(kref, struct hda_pcm, kref);
713 
714 	if (pcm->pcm)
715 		snd_device_free(pcm->codec->card, pcm->pcm);
716 	clear_bit(pcm->device, pcm->codec->bus->pcm_dev_bits);
717 	kfree(pcm->name);
718 	kfree(pcm);
719 }
720 
721 void snd_hda_codec_pcm_put(struct hda_pcm *pcm)
722 {
723 	kref_put(&pcm->kref, release_pcm);
724 }
725 EXPORT_SYMBOL_GPL(snd_hda_codec_pcm_put);
726 
727 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
728 				      const char *fmt, ...)
729 {
730 	struct hda_pcm *pcm;
731 	va_list args;
732 
733 	pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
734 	if (!pcm)
735 		return NULL;
736 
737 	pcm->codec = codec;
738 	kref_init(&pcm->kref);
739 	va_start(args, fmt);
740 	pcm->name = kvasprintf(GFP_KERNEL, fmt, args);
741 	va_end(args);
742 	if (!pcm->name) {
743 		kfree(pcm);
744 		return NULL;
745 	}
746 
747 	list_add_tail(&pcm->list, &codec->pcm_list_head);
748 	return pcm;
749 }
750 EXPORT_SYMBOL_GPL(snd_hda_codec_pcm_new);
751 
752 /*
753  * codec destructor
754  */
755 static void codec_release_pcms(struct hda_codec *codec)
756 {
757 	struct hda_pcm *pcm, *n;
758 
759 	list_for_each_entry_safe(pcm, n, &codec->pcm_list_head, list) {
760 		list_del_init(&pcm->list);
761 		if (pcm->pcm)
762 			snd_device_disconnect(codec->card, pcm->pcm);
763 		snd_hda_codec_pcm_put(pcm);
764 	}
765 }
766 
767 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec)
768 {
769 	if (codec->registered) {
770 		/* pm_runtime_put() is called in snd_hdac_device_exit() */
771 		pm_runtime_get_noresume(hda_codec_dev(codec));
772 		pm_runtime_disable(hda_codec_dev(codec));
773 		codec->registered = 0;
774 	}
775 
776 	cancel_delayed_work_sync(&codec->jackpoll_work);
777 	if (!codec->in_freeing)
778 		snd_hda_ctls_clear(codec);
779 	codec_release_pcms(codec);
780 	snd_hda_detach_beep_device(codec);
781 	memset(&codec->patch_ops, 0, sizeof(codec->patch_ops));
782 	snd_hda_jack_tbl_clear(codec);
783 	codec->proc_widget_hook = NULL;
784 	codec->spec = NULL;
785 
786 	/* free only driver_pins so that init_pins + user_pins are restored */
787 	snd_array_free(&codec->driver_pins);
788 	snd_array_free(&codec->cvt_setups);
789 	snd_array_free(&codec->spdif_out);
790 	snd_array_free(&codec->verbs);
791 	codec->preset = NULL;
792 	codec->slave_dig_outs = NULL;
793 	codec->spdif_status_reset = 0;
794 	snd_array_free(&codec->mixers);
795 	snd_array_free(&codec->nids);
796 	remove_conn_list(codec);
797 	snd_hdac_regmap_exit(&codec->core);
798 }
799 
800 static unsigned int hda_set_power_state(struct hda_codec *codec,
801 				unsigned int power_state);
802 
803 /* enable/disable display power per codec */
804 static void codec_display_power(struct hda_codec *codec, bool enable)
805 {
806 	if (codec->display_power_control)
807 		snd_hdac_display_power(&codec->bus->core, codec->addr, enable);
808 }
809 
810 /* also called from hda_bind.c */
811 void snd_hda_codec_register(struct hda_codec *codec)
812 {
813 	if (codec->registered)
814 		return;
815 	if (device_is_registered(hda_codec_dev(codec))) {
816 		snd_hda_register_beep_device(codec);
817 		codec_display_power(codec, true);
818 		pm_runtime_enable(hda_codec_dev(codec));
819 		/* it was powered up in snd_hda_codec_new(), now all done */
820 		snd_hda_power_down(codec);
821 		codec->registered = 1;
822 	}
823 }
824 
825 static int snd_hda_codec_dev_register(struct snd_device *device)
826 {
827 	snd_hda_codec_register(device->device_data);
828 	return 0;
829 }
830 
831 static int snd_hda_codec_dev_disconnect(struct snd_device *device)
832 {
833 	struct hda_codec *codec = device->device_data;
834 
835 	snd_hda_detach_beep_device(codec);
836 	return 0;
837 }
838 
839 static int snd_hda_codec_dev_free(struct snd_device *device)
840 {
841 	struct hda_codec *codec = device->device_data;
842 
843 	codec->in_freeing = 1;
844 	snd_hdac_device_unregister(&codec->core);
845 	codec_display_power(codec, false);
846 	put_device(hda_codec_dev(codec));
847 	return 0;
848 }
849 
850 static void snd_hda_codec_dev_release(struct device *dev)
851 {
852 	struct hda_codec *codec = dev_to_hda_codec(dev);
853 
854 	free_init_pincfgs(codec);
855 	snd_hdac_device_exit(&codec->core);
856 	snd_hda_sysfs_clear(codec);
857 	kfree(codec->modelname);
858 	kfree(codec->wcaps);
859 	kfree(codec);
860 }
861 
862 #define DEV_NAME_LEN 31
863 
864 static int snd_hda_codec_device_init(struct hda_bus *bus, struct snd_card *card,
865 			unsigned int codec_addr, struct hda_codec **codecp)
866 {
867 	char name[DEV_NAME_LEN];
868 	struct hda_codec *codec;
869 	int err;
870 
871 	dev_dbg(card->dev, "%s: entry\n", __func__);
872 
873 	if (snd_BUG_ON(!bus))
874 		return -EINVAL;
875 	if (snd_BUG_ON(codec_addr > HDA_MAX_CODEC_ADDRESS))
876 		return -EINVAL;
877 
878 	codec = kzalloc(sizeof(*codec), GFP_KERNEL);
879 	if (!codec)
880 		return -ENOMEM;
881 
882 	sprintf(name, "hdaudioC%dD%d", card->number, codec_addr);
883 	err = snd_hdac_device_init(&codec->core, &bus->core, name, codec_addr);
884 	if (err < 0) {
885 		kfree(codec);
886 		return err;
887 	}
888 
889 	codec->core.type = HDA_DEV_LEGACY;
890 	*codecp = codec;
891 
892 	return err;
893 }
894 
895 /**
896  * snd_hda_codec_new - create a HDA codec
897  * @bus: the bus to assign
898  * @codec_addr: the codec address
899  * @codecp: the pointer to store the generated codec
900  *
901  * Returns 0 if successful, or a negative error code.
902  */
903 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
904 		      unsigned int codec_addr, struct hda_codec **codecp)
905 {
906 	int ret;
907 
908 	ret = snd_hda_codec_device_init(bus, card, codec_addr, codecp);
909 	if (ret < 0)
910 		return ret;
911 
912 	return snd_hda_codec_device_new(bus, card, codec_addr, *codecp);
913 }
914 EXPORT_SYMBOL_GPL(snd_hda_codec_new);
915 
916 int snd_hda_codec_device_new(struct hda_bus *bus, struct snd_card *card,
917 			unsigned int codec_addr, struct hda_codec *codec)
918 {
919 	char component[31];
920 	hda_nid_t fg;
921 	int err;
922 	static struct snd_device_ops dev_ops = {
923 		.dev_register = snd_hda_codec_dev_register,
924 		.dev_disconnect = snd_hda_codec_dev_disconnect,
925 		.dev_free = snd_hda_codec_dev_free,
926 	};
927 
928 	dev_dbg(card->dev, "%s: entry\n", __func__);
929 
930 	if (snd_BUG_ON(!bus))
931 		return -EINVAL;
932 	if (snd_BUG_ON(codec_addr > HDA_MAX_CODEC_ADDRESS))
933 		return -EINVAL;
934 
935 	codec->core.dev.release = snd_hda_codec_dev_release;
936 	codec->core.exec_verb = codec_exec_verb;
937 
938 	codec->bus = bus;
939 	codec->card = card;
940 	codec->addr = codec_addr;
941 	mutex_init(&codec->spdif_mutex);
942 	mutex_init(&codec->control_mutex);
943 	snd_array_init(&codec->mixers, sizeof(struct hda_nid_item), 32);
944 	snd_array_init(&codec->nids, sizeof(struct hda_nid_item), 32);
945 	snd_array_init(&codec->init_pins, sizeof(struct hda_pincfg), 16);
946 	snd_array_init(&codec->driver_pins, sizeof(struct hda_pincfg), 16);
947 	snd_array_init(&codec->cvt_setups, sizeof(struct hda_cvt_setup), 8);
948 	snd_array_init(&codec->spdif_out, sizeof(struct hda_spdif_out), 16);
949 	snd_array_init(&codec->jacktbl, sizeof(struct hda_jack_tbl), 16);
950 	snd_array_init(&codec->verbs, sizeof(struct hda_verb *), 8);
951 	INIT_LIST_HEAD(&codec->conn_list);
952 	INIT_LIST_HEAD(&codec->pcm_list_head);
953 
954 	INIT_DELAYED_WORK(&codec->jackpoll_work, hda_jackpoll_work);
955 	codec->depop_delay = -1;
956 	codec->fixup_id = HDA_FIXUP_ID_NOT_SET;
957 
958 #ifdef CONFIG_PM
959 	codec->power_jiffies = jiffies;
960 #endif
961 
962 	snd_hda_sysfs_init(codec);
963 
964 	if (codec->bus->modelname) {
965 		codec->modelname = kstrdup(codec->bus->modelname, GFP_KERNEL);
966 		if (!codec->modelname) {
967 			err = -ENOMEM;
968 			goto error;
969 		}
970 	}
971 
972 	fg = codec->core.afg ? codec->core.afg : codec->core.mfg;
973 	err = read_widget_caps(codec, fg);
974 	if (err < 0)
975 		goto error;
976 	err = read_pin_defaults(codec);
977 	if (err < 0)
978 		goto error;
979 
980 	/* power-up all before initialization */
981 	hda_set_power_state(codec, AC_PWRST_D0);
982 
983 	snd_hda_codec_proc_new(codec);
984 
985 	snd_hda_create_hwdep(codec);
986 
987 	sprintf(component, "HDA:%08x,%08x,%08x", codec->core.vendor_id,
988 		codec->core.subsystem_id, codec->core.revision_id);
989 	snd_component_add(card, component);
990 
991 	err = snd_device_new(card, SNDRV_DEV_CODEC, codec, &dev_ops);
992 	if (err < 0)
993 		goto error;
994 
995 	return 0;
996 
997  error:
998 	put_device(hda_codec_dev(codec));
999 	return err;
1000 }
1001 EXPORT_SYMBOL_GPL(snd_hda_codec_device_new);
1002 
1003 /**
1004  * snd_hda_codec_update_widgets - Refresh widget caps and pin defaults
1005  * @codec: the HDA codec
1006  *
1007  * Forcibly refresh the all widget caps and the init pin configurations of
1008  * the given codec.
1009  */
1010 int snd_hda_codec_update_widgets(struct hda_codec *codec)
1011 {
1012 	hda_nid_t fg;
1013 	int err;
1014 
1015 	err = snd_hdac_refresh_widgets(&codec->core, true);
1016 	if (err < 0)
1017 		return err;
1018 
1019 	/* Assume the function group node does not change,
1020 	 * only the widget nodes may change.
1021 	 */
1022 	kfree(codec->wcaps);
1023 	fg = codec->core.afg ? codec->core.afg : codec->core.mfg;
1024 	err = read_widget_caps(codec, fg);
1025 	if (err < 0)
1026 		return err;
1027 
1028 	snd_array_free(&codec->init_pins);
1029 	err = read_pin_defaults(codec);
1030 
1031 	return err;
1032 }
1033 EXPORT_SYMBOL_GPL(snd_hda_codec_update_widgets);
1034 
1035 /* update the stream-id if changed */
1036 static void update_pcm_stream_id(struct hda_codec *codec,
1037 				 struct hda_cvt_setup *p, hda_nid_t nid,
1038 				 u32 stream_tag, int channel_id)
1039 {
1040 	unsigned int oldval, newval;
1041 
1042 	if (p->stream_tag != stream_tag || p->channel_id != channel_id) {
1043 		oldval = snd_hda_codec_read(codec, nid, 0, AC_VERB_GET_CONV, 0);
1044 		newval = (stream_tag << 4) | channel_id;
1045 		if (oldval != newval)
1046 			snd_hda_codec_write(codec, nid, 0,
1047 					    AC_VERB_SET_CHANNEL_STREAMID,
1048 					    newval);
1049 		p->stream_tag = stream_tag;
1050 		p->channel_id = channel_id;
1051 	}
1052 }
1053 
1054 /* update the format-id if changed */
1055 static void update_pcm_format(struct hda_codec *codec, struct hda_cvt_setup *p,
1056 			      hda_nid_t nid, int format)
1057 {
1058 	unsigned int oldval;
1059 
1060 	if (p->format_id != format) {
1061 		oldval = snd_hda_codec_read(codec, nid, 0,
1062 					    AC_VERB_GET_STREAM_FORMAT, 0);
1063 		if (oldval != format) {
1064 			msleep(1);
1065 			snd_hda_codec_write(codec, nid, 0,
1066 					    AC_VERB_SET_STREAM_FORMAT,
1067 					    format);
1068 		}
1069 		p->format_id = format;
1070 	}
1071 }
1072 
1073 /**
1074  * snd_hda_codec_setup_stream - set up the codec for streaming
1075  * @codec: the CODEC to set up
1076  * @nid: the NID to set up
1077  * @stream_tag: stream tag to pass, it's between 0x1 and 0xf.
1078  * @channel_id: channel id to pass, zero based.
1079  * @format: stream format.
1080  */
1081 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
1082 				u32 stream_tag,
1083 				int channel_id, int format)
1084 {
1085 	struct hda_codec *c;
1086 	struct hda_cvt_setup *p;
1087 	int type;
1088 	int i;
1089 
1090 	if (!nid)
1091 		return;
1092 
1093 	codec_dbg(codec,
1094 		  "hda_codec_setup_stream: NID=0x%x, stream=0x%x, channel=%d, format=0x%x\n",
1095 		  nid, stream_tag, channel_id, format);
1096 	p = get_hda_cvt_setup(codec, nid);
1097 	if (!p)
1098 		return;
1099 
1100 	if (codec->patch_ops.stream_pm)
1101 		codec->patch_ops.stream_pm(codec, nid, true);
1102 	if (codec->pcm_format_first)
1103 		update_pcm_format(codec, p, nid, format);
1104 	update_pcm_stream_id(codec, p, nid, stream_tag, channel_id);
1105 	if (!codec->pcm_format_first)
1106 		update_pcm_format(codec, p, nid, format);
1107 
1108 	p->active = 1;
1109 	p->dirty = 0;
1110 
1111 	/* make other inactive cvts with the same stream-tag dirty */
1112 	type = get_wcaps_type(get_wcaps(codec, nid));
1113 	list_for_each_codec(c, codec->bus) {
1114 		snd_array_for_each(&c->cvt_setups, i, p) {
1115 			if (!p->active && p->stream_tag == stream_tag &&
1116 			    get_wcaps_type(get_wcaps(c, p->nid)) == type)
1117 				p->dirty = 1;
1118 		}
1119 	}
1120 }
1121 EXPORT_SYMBOL_GPL(snd_hda_codec_setup_stream);
1122 
1123 static void really_cleanup_stream(struct hda_codec *codec,
1124 				  struct hda_cvt_setup *q);
1125 
1126 /**
1127  * __snd_hda_codec_cleanup_stream - clean up the codec for closing
1128  * @codec: the CODEC to clean up
1129  * @nid: the NID to clean up
1130  * @do_now: really clean up the stream instead of clearing the active flag
1131  */
1132 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
1133 				    int do_now)
1134 {
1135 	struct hda_cvt_setup *p;
1136 
1137 	if (!nid)
1138 		return;
1139 
1140 	if (codec->no_sticky_stream)
1141 		do_now = 1;
1142 
1143 	codec_dbg(codec, "hda_codec_cleanup_stream: NID=0x%x\n", nid);
1144 	p = get_hda_cvt_setup(codec, nid);
1145 	if (p) {
1146 		/* here we just clear the active flag when do_now isn't set;
1147 		 * actual clean-ups will be done later in
1148 		 * purify_inactive_streams() called from snd_hda_codec_prpapre()
1149 		 */
1150 		if (do_now)
1151 			really_cleanup_stream(codec, p);
1152 		else
1153 			p->active = 0;
1154 	}
1155 }
1156 EXPORT_SYMBOL_GPL(__snd_hda_codec_cleanup_stream);
1157 
1158 static void really_cleanup_stream(struct hda_codec *codec,
1159 				  struct hda_cvt_setup *q)
1160 {
1161 	hda_nid_t nid = q->nid;
1162 	if (q->stream_tag || q->channel_id)
1163 		snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_CHANNEL_STREAMID, 0);
1164 	if (q->format_id)
1165 		snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_STREAM_FORMAT, 0
1166 );
1167 	memset(q, 0, sizeof(*q));
1168 	q->nid = nid;
1169 	if (codec->patch_ops.stream_pm)
1170 		codec->patch_ops.stream_pm(codec, nid, false);
1171 }
1172 
1173 /* clean up the all conflicting obsolete streams */
1174 static void purify_inactive_streams(struct hda_codec *codec)
1175 {
1176 	struct hda_codec *c;
1177 	struct hda_cvt_setup *p;
1178 	int i;
1179 
1180 	list_for_each_codec(c, codec->bus) {
1181 		snd_array_for_each(&c->cvt_setups, i, p) {
1182 			if (p->dirty)
1183 				really_cleanup_stream(c, p);
1184 		}
1185 	}
1186 }
1187 
1188 #ifdef CONFIG_PM
1189 /* clean up all streams; called from suspend */
1190 static void hda_cleanup_all_streams(struct hda_codec *codec)
1191 {
1192 	struct hda_cvt_setup *p;
1193 	int i;
1194 
1195 	snd_array_for_each(&codec->cvt_setups, i, p) {
1196 		if (p->stream_tag)
1197 			really_cleanup_stream(codec, p);
1198 	}
1199 }
1200 #endif
1201 
1202 /*
1203  * amp access functions
1204  */
1205 
1206 /**
1207  * query_amp_caps - query AMP capabilities
1208  * @codec: the HD-auio codec
1209  * @nid: the NID to query
1210  * @direction: either #HDA_INPUT or #HDA_OUTPUT
1211  *
1212  * Query AMP capabilities for the given widget and direction.
1213  * Returns the obtained capability bits.
1214  *
1215  * When cap bits have been already read, this doesn't read again but
1216  * returns the cached value.
1217  */
1218 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction)
1219 {
1220 	if (!(get_wcaps(codec, nid) & AC_WCAP_AMP_OVRD))
1221 		nid = codec->core.afg;
1222 	return snd_hda_param_read(codec, nid,
1223 				  direction == HDA_OUTPUT ?
1224 				  AC_PAR_AMP_OUT_CAP : AC_PAR_AMP_IN_CAP);
1225 }
1226 EXPORT_SYMBOL_GPL(query_amp_caps);
1227 
1228 /**
1229  * snd_hda_check_amp_caps - query AMP capabilities
1230  * @codec: the HD-audio codec
1231  * @nid: the NID to query
1232  * @dir: either #HDA_INPUT or #HDA_OUTPUT
1233  * @bits: bit mask to check the result
1234  *
1235  * Check whether the widget has the given amp capability for the direction.
1236  */
1237 bool snd_hda_check_amp_caps(struct hda_codec *codec, hda_nid_t nid,
1238 			   int dir, unsigned int bits)
1239 {
1240 	if (!nid)
1241 		return false;
1242 	if (get_wcaps(codec, nid) & (1 << (dir + 1)))
1243 		if (query_amp_caps(codec, nid, dir) & bits)
1244 			return true;
1245 	return false;
1246 }
1247 EXPORT_SYMBOL_GPL(snd_hda_check_amp_caps);
1248 
1249 /**
1250  * snd_hda_override_amp_caps - Override the AMP capabilities
1251  * @codec: the CODEC to clean up
1252  * @nid: the NID to clean up
1253  * @dir: either #HDA_INPUT or #HDA_OUTPUT
1254  * @caps: the capability bits to set
1255  *
1256  * Override the cached AMP caps bits value by the given one.
1257  * This function is useful if the driver needs to adjust the AMP ranges,
1258  * e.g. limit to 0dB, etc.
1259  *
1260  * Returns zero if successful or a negative error code.
1261  */
1262 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
1263 			      unsigned int caps)
1264 {
1265 	unsigned int parm;
1266 
1267 	snd_hda_override_wcaps(codec, nid,
1268 			       get_wcaps(codec, nid) | AC_WCAP_AMP_OVRD);
1269 	parm = dir == HDA_OUTPUT ? AC_PAR_AMP_OUT_CAP : AC_PAR_AMP_IN_CAP;
1270 	return snd_hdac_override_parm(&codec->core, nid, parm, caps);
1271 }
1272 EXPORT_SYMBOL_GPL(snd_hda_override_amp_caps);
1273 
1274 /**
1275  * snd_hda_codec_amp_update - update the AMP mono value
1276  * @codec: HD-audio codec
1277  * @nid: NID to read the AMP value
1278  * @ch: channel to update (0 or 1)
1279  * @dir: #HDA_INPUT or #HDA_OUTPUT
1280  * @idx: the index value (only for input direction)
1281  * @mask: bit mask to set
1282  * @val: the bits value to set
1283  *
1284  * Update the AMP values for the given channel, direction and index.
1285  */
1286 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid,
1287 			     int ch, int dir, int idx, int mask, int val)
1288 {
1289 	unsigned int cmd = snd_hdac_regmap_encode_amp(nid, ch, dir, idx);
1290 
1291 	/* enable fake mute if no h/w mute but min=mute */
1292 	if ((query_amp_caps(codec, nid, dir) &
1293 	     (AC_AMPCAP_MUTE | AC_AMPCAP_MIN_MUTE)) == AC_AMPCAP_MIN_MUTE)
1294 		cmd |= AC_AMP_FAKE_MUTE;
1295 	return snd_hdac_regmap_update_raw(&codec->core, cmd, mask, val);
1296 }
1297 EXPORT_SYMBOL_GPL(snd_hda_codec_amp_update);
1298 
1299 /**
1300  * snd_hda_codec_amp_stereo - update the AMP stereo values
1301  * @codec: HD-audio codec
1302  * @nid: NID to read the AMP value
1303  * @direction: #HDA_INPUT or #HDA_OUTPUT
1304  * @idx: the index value (only for input direction)
1305  * @mask: bit mask to set
1306  * @val: the bits value to set
1307  *
1308  * Update the AMP values like snd_hda_codec_amp_update(), but for a
1309  * stereo widget with the same mask and value.
1310  */
1311 int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
1312 			     int direction, int idx, int mask, int val)
1313 {
1314 	int ch, ret = 0;
1315 
1316 	if (snd_BUG_ON(mask & ~0xff))
1317 		mask &= 0xff;
1318 	for (ch = 0; ch < 2; ch++)
1319 		ret |= snd_hda_codec_amp_update(codec, nid, ch, direction,
1320 						idx, mask, val);
1321 	return ret;
1322 }
1323 EXPORT_SYMBOL_GPL(snd_hda_codec_amp_stereo);
1324 
1325 /**
1326  * snd_hda_codec_amp_init - initialize the AMP value
1327  * @codec: the HDA codec
1328  * @nid: NID to read the AMP value
1329  * @ch: channel (left=0 or right=1)
1330  * @dir: #HDA_INPUT or #HDA_OUTPUT
1331  * @idx: the index value (only for input direction)
1332  * @mask: bit mask to set
1333  * @val: the bits value to set
1334  *
1335  * Works like snd_hda_codec_amp_update() but it writes the value only at
1336  * the first access.  If the amp was already initialized / updated beforehand,
1337  * this does nothing.
1338  */
1339 int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch,
1340 			   int dir, int idx, int mask, int val)
1341 {
1342 	int orig;
1343 
1344 	if (!codec->core.regmap)
1345 		return -EINVAL;
1346 	regcache_cache_only(codec->core.regmap, true);
1347 	orig = snd_hda_codec_amp_read(codec, nid, ch, dir, idx);
1348 	regcache_cache_only(codec->core.regmap, false);
1349 	if (orig >= 0)
1350 		return 0;
1351 	return snd_hda_codec_amp_update(codec, nid, ch, dir, idx, mask, val);
1352 }
1353 EXPORT_SYMBOL_GPL(snd_hda_codec_amp_init);
1354 
1355 /**
1356  * snd_hda_codec_amp_init_stereo - initialize the stereo AMP value
1357  * @codec: the HDA codec
1358  * @nid: NID to read the AMP value
1359  * @dir: #HDA_INPUT or #HDA_OUTPUT
1360  * @idx: the index value (only for input direction)
1361  * @mask: bit mask to set
1362  * @val: the bits value to set
1363  *
1364  * Call snd_hda_codec_amp_init() for both stereo channels.
1365  */
1366 int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid,
1367 				  int dir, int idx, int mask, int val)
1368 {
1369 	int ch, ret = 0;
1370 
1371 	if (snd_BUG_ON(mask & ~0xff))
1372 		mask &= 0xff;
1373 	for (ch = 0; ch < 2; ch++)
1374 		ret |= snd_hda_codec_amp_init(codec, nid, ch, dir,
1375 					      idx, mask, val);
1376 	return ret;
1377 }
1378 EXPORT_SYMBOL_GPL(snd_hda_codec_amp_init_stereo);
1379 
1380 static u32 get_amp_max_value(struct hda_codec *codec, hda_nid_t nid, int dir,
1381 			     unsigned int ofs)
1382 {
1383 	u32 caps = query_amp_caps(codec, nid, dir);
1384 	/* get num steps */
1385 	caps = (caps & AC_AMPCAP_NUM_STEPS) >> AC_AMPCAP_NUM_STEPS_SHIFT;
1386 	if (ofs < caps)
1387 		caps -= ofs;
1388 	return caps;
1389 }
1390 
1391 /**
1392  * snd_hda_mixer_amp_volume_info - Info callback for a standard AMP mixer
1393  * @kcontrol: referred ctl element
1394  * @uinfo: pointer to get/store the data
1395  *
1396  * The control element is supposed to have the private_value field
1397  * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
1398  */
1399 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
1400 				  struct snd_ctl_elem_info *uinfo)
1401 {
1402 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
1403 	u16 nid = get_amp_nid(kcontrol);
1404 	u8 chs = get_amp_channels(kcontrol);
1405 	int dir = get_amp_direction(kcontrol);
1406 	unsigned int ofs = get_amp_offset(kcontrol);
1407 
1408 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1409 	uinfo->count = chs == 3 ? 2 : 1;
1410 	uinfo->value.integer.min = 0;
1411 	uinfo->value.integer.max = get_amp_max_value(codec, nid, dir, ofs);
1412 	if (!uinfo->value.integer.max) {
1413 		codec_warn(codec,
1414 			   "num_steps = 0 for NID=0x%x (ctl = %s)\n",
1415 			   nid, kcontrol->id.name);
1416 		return -EINVAL;
1417 	}
1418 	return 0;
1419 }
1420 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_volume_info);
1421 
1422 
1423 static inline unsigned int
1424 read_amp_value(struct hda_codec *codec, hda_nid_t nid,
1425 	       int ch, int dir, int idx, unsigned int ofs)
1426 {
1427 	unsigned int val;
1428 	val = snd_hda_codec_amp_read(codec, nid, ch, dir, idx);
1429 	val &= HDA_AMP_VOLMASK;
1430 	if (val >= ofs)
1431 		val -= ofs;
1432 	else
1433 		val = 0;
1434 	return val;
1435 }
1436 
1437 static inline int
1438 update_amp_value(struct hda_codec *codec, hda_nid_t nid,
1439 		 int ch, int dir, int idx, unsigned int ofs,
1440 		 unsigned int val)
1441 {
1442 	unsigned int maxval;
1443 
1444 	if (val > 0)
1445 		val += ofs;
1446 	/* ofs = 0: raw max value */
1447 	maxval = get_amp_max_value(codec, nid, dir, 0);
1448 	if (val > maxval)
1449 		val = maxval;
1450 	return snd_hda_codec_amp_update(codec, nid, ch, dir, idx,
1451 					HDA_AMP_VOLMASK, val);
1452 }
1453 
1454 /**
1455  * snd_hda_mixer_amp_volume_get - Get callback for a standard AMP mixer volume
1456  * @kcontrol: ctl element
1457  * @ucontrol: pointer to get/store the data
1458  *
1459  * The control element is supposed to have the private_value field
1460  * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
1461  */
1462 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
1463 				 struct snd_ctl_elem_value *ucontrol)
1464 {
1465 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
1466 	hda_nid_t nid = get_amp_nid(kcontrol);
1467 	int chs = get_amp_channels(kcontrol);
1468 	int dir = get_amp_direction(kcontrol);
1469 	int idx = get_amp_index(kcontrol);
1470 	unsigned int ofs = get_amp_offset(kcontrol);
1471 	long *valp = ucontrol->value.integer.value;
1472 
1473 	if (chs & 1)
1474 		*valp++ = read_amp_value(codec, nid, 0, dir, idx, ofs);
1475 	if (chs & 2)
1476 		*valp = read_amp_value(codec, nid, 1, dir, idx, ofs);
1477 	return 0;
1478 }
1479 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_volume_get);
1480 
1481 /**
1482  * snd_hda_mixer_amp_volume_put - Put callback for a standard AMP mixer volume
1483  * @kcontrol: ctl element
1484  * @ucontrol: pointer to get/store the data
1485  *
1486  * The control element is supposed to have the private_value field
1487  * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
1488  */
1489 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
1490 				 struct snd_ctl_elem_value *ucontrol)
1491 {
1492 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
1493 	hda_nid_t nid = get_amp_nid(kcontrol);
1494 	int chs = get_amp_channels(kcontrol);
1495 	int dir = get_amp_direction(kcontrol);
1496 	int idx = get_amp_index(kcontrol);
1497 	unsigned int ofs = get_amp_offset(kcontrol);
1498 	long *valp = ucontrol->value.integer.value;
1499 	int change = 0;
1500 
1501 	if (chs & 1) {
1502 		change = update_amp_value(codec, nid, 0, dir, idx, ofs, *valp);
1503 		valp++;
1504 	}
1505 	if (chs & 2)
1506 		change |= update_amp_value(codec, nid, 1, dir, idx, ofs, *valp);
1507 	return change;
1508 }
1509 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_volume_put);
1510 
1511 /* inquiry the amp caps and convert to TLV */
1512 static void get_ctl_amp_tlv(struct snd_kcontrol *kcontrol, unsigned int *tlv)
1513 {
1514 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
1515 	hda_nid_t nid = get_amp_nid(kcontrol);
1516 	int dir = get_amp_direction(kcontrol);
1517 	unsigned int ofs = get_amp_offset(kcontrol);
1518 	bool min_mute = get_amp_min_mute(kcontrol);
1519 	u32 caps, val1, val2;
1520 
1521 	caps = query_amp_caps(codec, nid, dir);
1522 	val2 = (caps & AC_AMPCAP_STEP_SIZE) >> AC_AMPCAP_STEP_SIZE_SHIFT;
1523 	val2 = (val2 + 1) * 25;
1524 	val1 = -((caps & AC_AMPCAP_OFFSET) >> AC_AMPCAP_OFFSET_SHIFT);
1525 	val1 += ofs;
1526 	val1 = ((int)val1) * ((int)val2);
1527 	if (min_mute || (caps & AC_AMPCAP_MIN_MUTE))
1528 		val2 |= TLV_DB_SCALE_MUTE;
1529 	tlv[SNDRV_CTL_TLVO_TYPE] = SNDRV_CTL_TLVT_DB_SCALE;
1530 	tlv[SNDRV_CTL_TLVO_LEN] = 2 * sizeof(unsigned int);
1531 	tlv[SNDRV_CTL_TLVO_DB_SCALE_MIN] = val1;
1532 	tlv[SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP] = val2;
1533 }
1534 
1535 /**
1536  * snd_hda_mixer_amp_tlv - TLV callback for a standard AMP mixer volume
1537  * @kcontrol: ctl element
1538  * @op_flag: operation flag
1539  * @size: byte size of input TLV
1540  * @_tlv: TLV data
1541  *
1542  * The control element is supposed to have the private_value field
1543  * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
1544  */
1545 int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
1546 			  unsigned int size, unsigned int __user *_tlv)
1547 {
1548 	unsigned int tlv[4];
1549 
1550 	if (size < 4 * sizeof(unsigned int))
1551 		return -ENOMEM;
1552 	get_ctl_amp_tlv(kcontrol, tlv);
1553 	if (copy_to_user(_tlv, tlv, sizeof(tlv)))
1554 		return -EFAULT;
1555 	return 0;
1556 }
1557 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_tlv);
1558 
1559 /**
1560  * snd_hda_set_vmaster_tlv - Set TLV for a virtual master control
1561  * @codec: HD-audio codec
1562  * @nid: NID of a reference widget
1563  * @dir: #HDA_INPUT or #HDA_OUTPUT
1564  * @tlv: TLV data to be stored, at least 4 elements
1565  *
1566  * Set (static) TLV data for a virtual master volume using the AMP caps
1567  * obtained from the reference NID.
1568  * The volume range is recalculated as if the max volume is 0dB.
1569  */
1570 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
1571 			     unsigned int *tlv)
1572 {
1573 	u32 caps;
1574 	int nums, step;
1575 
1576 	caps = query_amp_caps(codec, nid, dir);
1577 	nums = (caps & AC_AMPCAP_NUM_STEPS) >> AC_AMPCAP_NUM_STEPS_SHIFT;
1578 	step = (caps & AC_AMPCAP_STEP_SIZE) >> AC_AMPCAP_STEP_SIZE_SHIFT;
1579 	step = (step + 1) * 25;
1580 	tlv[SNDRV_CTL_TLVO_TYPE] = SNDRV_CTL_TLVT_DB_SCALE;
1581 	tlv[SNDRV_CTL_TLVO_LEN] = 2 * sizeof(unsigned int);
1582 	tlv[SNDRV_CTL_TLVO_DB_SCALE_MIN] = -nums * step;
1583 	tlv[SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP] = step;
1584 }
1585 EXPORT_SYMBOL_GPL(snd_hda_set_vmaster_tlv);
1586 
1587 /* find a mixer control element with the given name */
1588 static struct snd_kcontrol *
1589 find_mixer_ctl(struct hda_codec *codec, const char *name, int dev, int idx)
1590 {
1591 	struct snd_ctl_elem_id id;
1592 	memset(&id, 0, sizeof(id));
1593 	id.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1594 	id.device = dev;
1595 	id.index = idx;
1596 	if (snd_BUG_ON(strlen(name) >= sizeof(id.name)))
1597 		return NULL;
1598 	strcpy(id.name, name);
1599 	return snd_ctl_find_id(codec->card, &id);
1600 }
1601 
1602 /**
1603  * snd_hda_find_mixer_ctl - Find a mixer control element with the given name
1604  * @codec: HD-audio codec
1605  * @name: ctl id name string
1606  *
1607  * Get the control element with the given id string and IFACE_MIXER.
1608  */
1609 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
1610 					    const char *name)
1611 {
1612 	return find_mixer_ctl(codec, name, 0, 0);
1613 }
1614 EXPORT_SYMBOL_GPL(snd_hda_find_mixer_ctl);
1615 
1616 static int find_empty_mixer_ctl_idx(struct hda_codec *codec, const char *name,
1617 				    int start_idx)
1618 {
1619 	int i, idx;
1620 	/* 16 ctlrs should be large enough */
1621 	for (i = 0, idx = start_idx; i < 16; i++, idx++) {
1622 		if (!find_mixer_ctl(codec, name, 0, idx))
1623 			return idx;
1624 	}
1625 	return -EBUSY;
1626 }
1627 
1628 /**
1629  * snd_hda_ctl_add - Add a control element and assign to the codec
1630  * @codec: HD-audio codec
1631  * @nid: corresponding NID (optional)
1632  * @kctl: the control element to assign
1633  *
1634  * Add the given control element to an array inside the codec instance.
1635  * All control elements belonging to a codec are supposed to be added
1636  * by this function so that a proper clean-up works at the free or
1637  * reconfiguration time.
1638  *
1639  * If non-zero @nid is passed, the NID is assigned to the control element.
1640  * The assignment is shown in the codec proc file.
1641  *
1642  * snd_hda_ctl_add() checks the control subdev id field whether
1643  * #HDA_SUBDEV_NID_FLAG bit is set.  If set (and @nid is zero), the lower
1644  * bits value is taken as the NID to assign. The #HDA_NID_ITEM_AMP bit
1645  * specifies if kctl->private_value is a HDA amplifier value.
1646  */
1647 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
1648 		    struct snd_kcontrol *kctl)
1649 {
1650 	int err;
1651 	unsigned short flags = 0;
1652 	struct hda_nid_item *item;
1653 
1654 	if (kctl->id.subdevice & HDA_SUBDEV_AMP_FLAG) {
1655 		flags |= HDA_NID_ITEM_AMP;
1656 		if (nid == 0)
1657 			nid = get_amp_nid_(kctl->private_value);
1658 	}
1659 	if ((kctl->id.subdevice & HDA_SUBDEV_NID_FLAG) != 0 && nid == 0)
1660 		nid = kctl->id.subdevice & 0xffff;
1661 	if (kctl->id.subdevice & (HDA_SUBDEV_NID_FLAG|HDA_SUBDEV_AMP_FLAG))
1662 		kctl->id.subdevice = 0;
1663 	err = snd_ctl_add(codec->card, kctl);
1664 	if (err < 0)
1665 		return err;
1666 	item = snd_array_new(&codec->mixers);
1667 	if (!item)
1668 		return -ENOMEM;
1669 	item->kctl = kctl;
1670 	item->nid = nid;
1671 	item->flags = flags;
1672 	return 0;
1673 }
1674 EXPORT_SYMBOL_GPL(snd_hda_ctl_add);
1675 
1676 /**
1677  * snd_hda_add_nid - Assign a NID to a control element
1678  * @codec: HD-audio codec
1679  * @nid: corresponding NID (optional)
1680  * @kctl: the control element to assign
1681  * @index: index to kctl
1682  *
1683  * Add the given control element to an array inside the codec instance.
1684  * This function is used when #snd_hda_ctl_add cannot be used for 1:1
1685  * NID:KCTL mapping - for example "Capture Source" selector.
1686  */
1687 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
1688 		    unsigned int index, hda_nid_t nid)
1689 {
1690 	struct hda_nid_item *item;
1691 
1692 	if (nid > 0) {
1693 		item = snd_array_new(&codec->nids);
1694 		if (!item)
1695 			return -ENOMEM;
1696 		item->kctl = kctl;
1697 		item->index = index;
1698 		item->nid = nid;
1699 		return 0;
1700 	}
1701 	codec_err(codec, "no NID for mapping control %s:%d:%d\n",
1702 		  kctl->id.name, kctl->id.index, index);
1703 	return -EINVAL;
1704 }
1705 EXPORT_SYMBOL_GPL(snd_hda_add_nid);
1706 
1707 /**
1708  * snd_hda_ctls_clear - Clear all controls assigned to the given codec
1709  * @codec: HD-audio codec
1710  */
1711 void snd_hda_ctls_clear(struct hda_codec *codec)
1712 {
1713 	int i;
1714 	struct hda_nid_item *items = codec->mixers.list;
1715 	for (i = 0; i < codec->mixers.used; i++)
1716 		snd_ctl_remove(codec->card, items[i].kctl);
1717 	snd_array_free(&codec->mixers);
1718 	snd_array_free(&codec->nids);
1719 }
1720 
1721 /**
1722  * snd_hda_lock_devices - pseudo device locking
1723  * @bus: the BUS
1724  *
1725  * toggle card->shutdown to allow/disallow the device access (as a hack)
1726  */
1727 int snd_hda_lock_devices(struct hda_bus *bus)
1728 {
1729 	struct snd_card *card = bus->card;
1730 	struct hda_codec *codec;
1731 
1732 	spin_lock(&card->files_lock);
1733 	if (card->shutdown)
1734 		goto err_unlock;
1735 	card->shutdown = 1;
1736 	if (!list_empty(&card->ctl_files))
1737 		goto err_clear;
1738 
1739 	list_for_each_codec(codec, bus) {
1740 		struct hda_pcm *cpcm;
1741 		list_for_each_entry(cpcm, &codec->pcm_list_head, list) {
1742 			if (!cpcm->pcm)
1743 				continue;
1744 			if (cpcm->pcm->streams[0].substream_opened ||
1745 			    cpcm->pcm->streams[1].substream_opened)
1746 				goto err_clear;
1747 		}
1748 	}
1749 	spin_unlock(&card->files_lock);
1750 	return 0;
1751 
1752  err_clear:
1753 	card->shutdown = 0;
1754  err_unlock:
1755 	spin_unlock(&card->files_lock);
1756 	return -EINVAL;
1757 }
1758 EXPORT_SYMBOL_GPL(snd_hda_lock_devices);
1759 
1760 /**
1761  * snd_hda_unlock_devices - pseudo device unlocking
1762  * @bus: the BUS
1763  */
1764 void snd_hda_unlock_devices(struct hda_bus *bus)
1765 {
1766 	struct snd_card *card = bus->card;
1767 
1768 	spin_lock(&card->files_lock);
1769 	card->shutdown = 0;
1770 	spin_unlock(&card->files_lock);
1771 }
1772 EXPORT_SYMBOL_GPL(snd_hda_unlock_devices);
1773 
1774 /**
1775  * snd_hda_codec_reset - Clear all objects assigned to the codec
1776  * @codec: HD-audio codec
1777  *
1778  * This frees the all PCM and control elements assigned to the codec, and
1779  * clears the caches and restores the pin default configurations.
1780  *
1781  * When a device is being used, it returns -EBSY.  If successfully freed,
1782  * returns zero.
1783  */
1784 int snd_hda_codec_reset(struct hda_codec *codec)
1785 {
1786 	struct hda_bus *bus = codec->bus;
1787 
1788 	if (snd_hda_lock_devices(bus) < 0)
1789 		return -EBUSY;
1790 
1791 	/* OK, let it free */
1792 	snd_hdac_device_unregister(&codec->core);
1793 
1794 	/* allow device access again */
1795 	snd_hda_unlock_devices(bus);
1796 	return 0;
1797 }
1798 
1799 typedef int (*map_slave_func_t)(struct hda_codec *, void *, struct snd_kcontrol *);
1800 
1801 /* apply the function to all matching slave ctls in the mixer list */
1802 static int map_slaves(struct hda_codec *codec, const char * const *slaves,
1803 		      const char *suffix, map_slave_func_t func, void *data)
1804 {
1805 	struct hda_nid_item *items;
1806 	const char * const *s;
1807 	int i, err;
1808 
1809 	items = codec->mixers.list;
1810 	for (i = 0; i < codec->mixers.used; i++) {
1811 		struct snd_kcontrol *sctl = items[i].kctl;
1812 		if (!sctl || sctl->id.iface != SNDRV_CTL_ELEM_IFACE_MIXER)
1813 			continue;
1814 		for (s = slaves; *s; s++) {
1815 			char tmpname[sizeof(sctl->id.name)];
1816 			const char *name = *s;
1817 			if (suffix) {
1818 				snprintf(tmpname, sizeof(tmpname), "%s %s",
1819 					 name, suffix);
1820 				name = tmpname;
1821 			}
1822 			if (!strcmp(sctl->id.name, name)) {
1823 				err = func(codec, data, sctl);
1824 				if (err)
1825 					return err;
1826 				break;
1827 			}
1828 		}
1829 	}
1830 	return 0;
1831 }
1832 
1833 static int check_slave_present(struct hda_codec *codec,
1834 			       void *data, struct snd_kcontrol *sctl)
1835 {
1836 	return 1;
1837 }
1838 
1839 /* call kctl->put with the given value(s) */
1840 static int put_kctl_with_value(struct snd_kcontrol *kctl, int val)
1841 {
1842 	struct snd_ctl_elem_value *ucontrol;
1843 	ucontrol = kzalloc(sizeof(*ucontrol), GFP_KERNEL);
1844 	if (!ucontrol)
1845 		return -ENOMEM;
1846 	ucontrol->value.integer.value[0] = val;
1847 	ucontrol->value.integer.value[1] = val;
1848 	kctl->put(kctl, ucontrol);
1849 	kfree(ucontrol);
1850 	return 0;
1851 }
1852 
1853 struct slave_init_arg {
1854 	struct hda_codec *codec;
1855 	int step;
1856 };
1857 
1858 /* initialize the slave volume with 0dB via snd_ctl_apply_vmaster_slaves() */
1859 static int init_slave_0dB(struct snd_kcontrol *slave,
1860 			  struct snd_kcontrol *kctl,
1861 			  void *_arg)
1862 {
1863 	struct slave_init_arg *arg = _arg;
1864 	int _tlv[4];
1865 	const int *tlv = NULL;
1866 	int step;
1867 	int val;
1868 
1869 	if (kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1870 		if (kctl->tlv.c != snd_hda_mixer_amp_tlv) {
1871 			codec_err(arg->codec,
1872 				  "Unexpected TLV callback for slave %s:%d\n",
1873 				  kctl->id.name, kctl->id.index);
1874 			return 0; /* ignore */
1875 		}
1876 		get_ctl_amp_tlv(kctl, _tlv);
1877 		tlv = _tlv;
1878 	} else if (kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_TLV_READ)
1879 		tlv = kctl->tlv.p;
1880 
1881 	if (!tlv || tlv[SNDRV_CTL_TLVO_TYPE] != SNDRV_CTL_TLVT_DB_SCALE)
1882 		return 0;
1883 
1884 	step = tlv[SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP];
1885 	step &= ~TLV_DB_SCALE_MUTE;
1886 	if (!step)
1887 		return 0;
1888 	if (arg->step && arg->step != step) {
1889 		codec_err(arg->codec,
1890 			  "Mismatching dB step for vmaster slave (%d!=%d)\n",
1891 			  arg->step, step);
1892 		return 0;
1893 	}
1894 
1895 	arg->step = step;
1896 	val = -tlv[SNDRV_CTL_TLVO_DB_SCALE_MIN] / step;
1897 	if (val > 0) {
1898 		put_kctl_with_value(slave, val);
1899 		return val;
1900 	}
1901 
1902 	return 0;
1903 }
1904 
1905 /* unmute the slave via snd_ctl_apply_vmaster_slaves() */
1906 static int init_slave_unmute(struct snd_kcontrol *slave,
1907 			     struct snd_kcontrol *kctl,
1908 			     void *_arg)
1909 {
1910 	return put_kctl_with_value(slave, 1);
1911 }
1912 
1913 static int add_slave(struct hda_codec *codec,
1914 		     void *data, struct snd_kcontrol *slave)
1915 {
1916 	return snd_ctl_add_slave(data, slave);
1917 }
1918 
1919 /**
1920  * __snd_hda_add_vmaster - create a virtual master control and add slaves
1921  * @codec: HD-audio codec
1922  * @name: vmaster control name
1923  * @tlv: TLV data (optional)
1924  * @slaves: slave control names (optional)
1925  * @suffix: suffix string to each slave name (optional)
1926  * @init_slave_vol: initialize slaves to unmute/0dB
1927  * @ctl_ret: store the vmaster kcontrol in return
1928  *
1929  * Create a virtual master control with the given name.  The TLV data
1930  * must be either NULL or a valid data.
1931  *
1932  * @slaves is a NULL-terminated array of strings, each of which is a
1933  * slave control name.  All controls with these names are assigned to
1934  * the new virtual master control.
1935  *
1936  * This function returns zero if successful or a negative error code.
1937  */
1938 int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
1939 			unsigned int *tlv, const char * const *slaves,
1940 			  const char *suffix, bool init_slave_vol,
1941 			  struct snd_kcontrol **ctl_ret)
1942 {
1943 	struct snd_kcontrol *kctl;
1944 	int err;
1945 
1946 	if (ctl_ret)
1947 		*ctl_ret = NULL;
1948 
1949 	err = map_slaves(codec, slaves, suffix, check_slave_present, NULL);
1950 	if (err != 1) {
1951 		codec_dbg(codec, "No slave found for %s\n", name);
1952 		return 0;
1953 	}
1954 	kctl = snd_ctl_make_virtual_master(name, tlv);
1955 	if (!kctl)
1956 		return -ENOMEM;
1957 	err = snd_hda_ctl_add(codec, 0, kctl);
1958 	if (err < 0)
1959 		return err;
1960 
1961 	err = map_slaves(codec, slaves, suffix, add_slave, kctl);
1962 	if (err < 0)
1963 		return err;
1964 
1965 	/* init with master mute & zero volume */
1966 	put_kctl_with_value(kctl, 0);
1967 	if (init_slave_vol) {
1968 		struct slave_init_arg arg = {
1969 			.codec = codec,
1970 			.step = 0,
1971 		};
1972 		snd_ctl_apply_vmaster_slaves(kctl,
1973 					     tlv ? init_slave_0dB : init_slave_unmute,
1974 					     &arg);
1975 	}
1976 
1977 	if (ctl_ret)
1978 		*ctl_ret = kctl;
1979 	return 0;
1980 }
1981 EXPORT_SYMBOL_GPL(__snd_hda_add_vmaster);
1982 
1983 /*
1984  * mute-LED control using vmaster
1985  */
1986 static int vmaster_mute_mode_info(struct snd_kcontrol *kcontrol,
1987 				  struct snd_ctl_elem_info *uinfo)
1988 {
1989 	static const char * const texts[] = {
1990 		"On", "Off", "Follow Master"
1991 	};
1992 
1993 	return snd_ctl_enum_info(uinfo, 1, 3, texts);
1994 }
1995 
1996 static int vmaster_mute_mode_get(struct snd_kcontrol *kcontrol,
1997 				 struct snd_ctl_elem_value *ucontrol)
1998 {
1999 	struct hda_vmaster_mute_hook *hook = snd_kcontrol_chip(kcontrol);
2000 	ucontrol->value.enumerated.item[0] = hook->mute_mode;
2001 	return 0;
2002 }
2003 
2004 static int vmaster_mute_mode_put(struct snd_kcontrol *kcontrol,
2005 				 struct snd_ctl_elem_value *ucontrol)
2006 {
2007 	struct hda_vmaster_mute_hook *hook = snd_kcontrol_chip(kcontrol);
2008 	unsigned int old_mode = hook->mute_mode;
2009 
2010 	hook->mute_mode = ucontrol->value.enumerated.item[0];
2011 	if (hook->mute_mode > HDA_VMUTE_FOLLOW_MASTER)
2012 		hook->mute_mode = HDA_VMUTE_FOLLOW_MASTER;
2013 	if (old_mode == hook->mute_mode)
2014 		return 0;
2015 	snd_hda_sync_vmaster_hook(hook);
2016 	return 1;
2017 }
2018 
2019 static const struct snd_kcontrol_new vmaster_mute_mode = {
2020 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2021 	.name = "Mute-LED Mode",
2022 	.info = vmaster_mute_mode_info,
2023 	.get = vmaster_mute_mode_get,
2024 	.put = vmaster_mute_mode_put,
2025 };
2026 
2027 /* meta hook to call each driver's vmaster hook */
2028 static void vmaster_hook(void *private_data, int enabled)
2029 {
2030 	struct hda_vmaster_mute_hook *hook = private_data;
2031 
2032 	if (hook->mute_mode != HDA_VMUTE_FOLLOW_MASTER)
2033 		enabled = hook->mute_mode;
2034 	hook->hook(hook->codec, enabled);
2035 }
2036 
2037 /**
2038  * snd_hda_add_vmaster_hook - Add a vmaster hook for mute-LED
2039  * @codec: the HDA codec
2040  * @hook: the vmaster hook object
2041  * @expose_enum_ctl: flag to create an enum ctl
2042  *
2043  * Add a mute-LED hook with the given vmaster switch kctl.
2044  * When @expose_enum_ctl is set, "Mute-LED Mode" control is automatically
2045  * created and associated with the given hook.
2046  */
2047 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
2048 			     struct hda_vmaster_mute_hook *hook,
2049 			     bool expose_enum_ctl)
2050 {
2051 	struct snd_kcontrol *kctl;
2052 
2053 	if (!hook->hook || !hook->sw_kctl)
2054 		return 0;
2055 	hook->codec = codec;
2056 	hook->mute_mode = HDA_VMUTE_FOLLOW_MASTER;
2057 	snd_ctl_add_vmaster_hook(hook->sw_kctl, vmaster_hook, hook);
2058 	if (!expose_enum_ctl)
2059 		return 0;
2060 	kctl = snd_ctl_new1(&vmaster_mute_mode, hook);
2061 	if (!kctl)
2062 		return -ENOMEM;
2063 	return snd_hda_ctl_add(codec, 0, kctl);
2064 }
2065 EXPORT_SYMBOL_GPL(snd_hda_add_vmaster_hook);
2066 
2067 /**
2068  * snd_hda_sync_vmaster_hook - Sync vmaster hook
2069  * @hook: the vmaster hook
2070  *
2071  * Call the hook with the current value for synchronization.
2072  * Should be called in init callback.
2073  */
2074 void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook)
2075 {
2076 	if (!hook->hook || !hook->codec)
2077 		return;
2078 	/* don't call vmaster hook in the destructor since it might have
2079 	 * been already destroyed
2080 	 */
2081 	if (hook->codec->bus->shutdown)
2082 		return;
2083 	snd_ctl_sync_vmaster_hook(hook->sw_kctl);
2084 }
2085 EXPORT_SYMBOL_GPL(snd_hda_sync_vmaster_hook);
2086 
2087 
2088 /**
2089  * snd_hda_mixer_amp_switch_info - Info callback for a standard AMP mixer switch
2090  * @kcontrol: referred ctl element
2091  * @uinfo: pointer to get/store the data
2092  *
2093  * The control element is supposed to have the private_value field
2094  * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
2095  */
2096 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
2097 				  struct snd_ctl_elem_info *uinfo)
2098 {
2099 	int chs = get_amp_channels(kcontrol);
2100 
2101 	uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
2102 	uinfo->count = chs == 3 ? 2 : 1;
2103 	uinfo->value.integer.min = 0;
2104 	uinfo->value.integer.max = 1;
2105 	return 0;
2106 }
2107 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_info);
2108 
2109 /**
2110  * snd_hda_mixer_amp_switch_get - Get callback for a standard AMP mixer switch
2111  * @kcontrol: ctl element
2112  * @ucontrol: pointer to get/store the data
2113  *
2114  * The control element is supposed to have the private_value field
2115  * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
2116  */
2117 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
2118 				 struct snd_ctl_elem_value *ucontrol)
2119 {
2120 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2121 	hda_nid_t nid = get_amp_nid(kcontrol);
2122 	int chs = get_amp_channels(kcontrol);
2123 	int dir = get_amp_direction(kcontrol);
2124 	int idx = get_amp_index(kcontrol);
2125 	long *valp = ucontrol->value.integer.value;
2126 
2127 	if (chs & 1)
2128 		*valp++ = (snd_hda_codec_amp_read(codec, nid, 0, dir, idx) &
2129 			   HDA_AMP_MUTE) ? 0 : 1;
2130 	if (chs & 2)
2131 		*valp = (snd_hda_codec_amp_read(codec, nid, 1, dir, idx) &
2132 			 HDA_AMP_MUTE) ? 0 : 1;
2133 	return 0;
2134 }
2135 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get);
2136 
2137 /**
2138  * snd_hda_mixer_amp_switch_put - Put callback for a standard AMP mixer switch
2139  * @kcontrol: ctl element
2140  * @ucontrol: pointer to get/store the data
2141  *
2142  * The control element is supposed to have the private_value field
2143  * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
2144  */
2145 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
2146 				 struct snd_ctl_elem_value *ucontrol)
2147 {
2148 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2149 	hda_nid_t nid = get_amp_nid(kcontrol);
2150 	int chs = get_amp_channels(kcontrol);
2151 	int dir = get_amp_direction(kcontrol);
2152 	int idx = get_amp_index(kcontrol);
2153 	long *valp = ucontrol->value.integer.value;
2154 	int change = 0;
2155 
2156 	if (chs & 1) {
2157 		change = snd_hda_codec_amp_update(codec, nid, 0, dir, idx,
2158 						  HDA_AMP_MUTE,
2159 						  *valp ? 0 : HDA_AMP_MUTE);
2160 		valp++;
2161 	}
2162 	if (chs & 2)
2163 		change |= snd_hda_codec_amp_update(codec, nid, 1, dir, idx,
2164 						   HDA_AMP_MUTE,
2165 						   *valp ? 0 : HDA_AMP_MUTE);
2166 	hda_call_check_power_status(codec, nid);
2167 	return change;
2168 }
2169 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put);
2170 
2171 /*
2172  * SPDIF out controls
2173  */
2174 
2175 static int snd_hda_spdif_mask_info(struct snd_kcontrol *kcontrol,
2176 				   struct snd_ctl_elem_info *uinfo)
2177 {
2178 	uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
2179 	uinfo->count = 1;
2180 	return 0;
2181 }
2182 
2183 static int snd_hda_spdif_cmask_get(struct snd_kcontrol *kcontrol,
2184 				   struct snd_ctl_elem_value *ucontrol)
2185 {
2186 	ucontrol->value.iec958.status[0] = IEC958_AES0_PROFESSIONAL |
2187 					   IEC958_AES0_NONAUDIO |
2188 					   IEC958_AES0_CON_EMPHASIS_5015 |
2189 					   IEC958_AES0_CON_NOT_COPYRIGHT;
2190 	ucontrol->value.iec958.status[1] = IEC958_AES1_CON_CATEGORY |
2191 					   IEC958_AES1_CON_ORIGINAL;
2192 	return 0;
2193 }
2194 
2195 static int snd_hda_spdif_pmask_get(struct snd_kcontrol *kcontrol,
2196 				   struct snd_ctl_elem_value *ucontrol)
2197 {
2198 	ucontrol->value.iec958.status[0] = IEC958_AES0_PROFESSIONAL |
2199 					   IEC958_AES0_NONAUDIO |
2200 					   IEC958_AES0_PRO_EMPHASIS_5015;
2201 	return 0;
2202 }
2203 
2204 static int snd_hda_spdif_default_get(struct snd_kcontrol *kcontrol,
2205 				     struct snd_ctl_elem_value *ucontrol)
2206 {
2207 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2208 	int idx = kcontrol->private_value;
2209 	struct hda_spdif_out *spdif;
2210 
2211 	if (WARN_ON(codec->spdif_out.used <= idx))
2212 		return -EINVAL;
2213 	mutex_lock(&codec->spdif_mutex);
2214 	spdif = snd_array_elem(&codec->spdif_out, idx);
2215 	ucontrol->value.iec958.status[0] = spdif->status & 0xff;
2216 	ucontrol->value.iec958.status[1] = (spdif->status >> 8) & 0xff;
2217 	ucontrol->value.iec958.status[2] = (spdif->status >> 16) & 0xff;
2218 	ucontrol->value.iec958.status[3] = (spdif->status >> 24) & 0xff;
2219 	mutex_unlock(&codec->spdif_mutex);
2220 
2221 	return 0;
2222 }
2223 
2224 /* convert from SPDIF status bits to HDA SPDIF bits
2225  * bit 0 (DigEn) is always set zero (to be filled later)
2226  */
2227 static unsigned short convert_from_spdif_status(unsigned int sbits)
2228 {
2229 	unsigned short val = 0;
2230 
2231 	if (sbits & IEC958_AES0_PROFESSIONAL)
2232 		val |= AC_DIG1_PROFESSIONAL;
2233 	if (sbits & IEC958_AES0_NONAUDIO)
2234 		val |= AC_DIG1_NONAUDIO;
2235 	if (sbits & IEC958_AES0_PROFESSIONAL) {
2236 		if ((sbits & IEC958_AES0_PRO_EMPHASIS) ==
2237 		    IEC958_AES0_PRO_EMPHASIS_5015)
2238 			val |= AC_DIG1_EMPHASIS;
2239 	} else {
2240 		if ((sbits & IEC958_AES0_CON_EMPHASIS) ==
2241 		    IEC958_AES0_CON_EMPHASIS_5015)
2242 			val |= AC_DIG1_EMPHASIS;
2243 		if (!(sbits & IEC958_AES0_CON_NOT_COPYRIGHT))
2244 			val |= AC_DIG1_COPYRIGHT;
2245 		if (sbits & (IEC958_AES1_CON_ORIGINAL << 8))
2246 			val |= AC_DIG1_LEVEL;
2247 		val |= sbits & (IEC958_AES1_CON_CATEGORY << 8);
2248 	}
2249 	return val;
2250 }
2251 
2252 /* convert to SPDIF status bits from HDA SPDIF bits
2253  */
2254 static unsigned int convert_to_spdif_status(unsigned short val)
2255 {
2256 	unsigned int sbits = 0;
2257 
2258 	if (val & AC_DIG1_NONAUDIO)
2259 		sbits |= IEC958_AES0_NONAUDIO;
2260 	if (val & AC_DIG1_PROFESSIONAL)
2261 		sbits |= IEC958_AES0_PROFESSIONAL;
2262 	if (sbits & IEC958_AES0_PROFESSIONAL) {
2263 		if (val & AC_DIG1_EMPHASIS)
2264 			sbits |= IEC958_AES0_PRO_EMPHASIS_5015;
2265 	} else {
2266 		if (val & AC_DIG1_EMPHASIS)
2267 			sbits |= IEC958_AES0_CON_EMPHASIS_5015;
2268 		if (!(val & AC_DIG1_COPYRIGHT))
2269 			sbits |= IEC958_AES0_CON_NOT_COPYRIGHT;
2270 		if (val & AC_DIG1_LEVEL)
2271 			sbits |= (IEC958_AES1_CON_ORIGINAL << 8);
2272 		sbits |= val & (0x7f << 8);
2273 	}
2274 	return sbits;
2275 }
2276 
2277 /* set digital convert verbs both for the given NID and its slaves */
2278 static void set_dig_out(struct hda_codec *codec, hda_nid_t nid,
2279 			int mask, int val)
2280 {
2281 	const hda_nid_t *d;
2282 
2283 	snd_hdac_regmap_update(&codec->core, nid, AC_VERB_SET_DIGI_CONVERT_1,
2284 			       mask, val);
2285 	d = codec->slave_dig_outs;
2286 	if (!d)
2287 		return;
2288 	for (; *d; d++)
2289 		snd_hdac_regmap_update(&codec->core, *d,
2290 				       AC_VERB_SET_DIGI_CONVERT_1, mask, val);
2291 }
2292 
2293 static inline void set_dig_out_convert(struct hda_codec *codec, hda_nid_t nid,
2294 				       int dig1, int dig2)
2295 {
2296 	unsigned int mask = 0;
2297 	unsigned int val = 0;
2298 
2299 	if (dig1 != -1) {
2300 		mask |= 0xff;
2301 		val = dig1;
2302 	}
2303 	if (dig2 != -1) {
2304 		mask |= 0xff00;
2305 		val |= dig2 << 8;
2306 	}
2307 	set_dig_out(codec, nid, mask, val);
2308 }
2309 
2310 static int snd_hda_spdif_default_put(struct snd_kcontrol *kcontrol,
2311 				     struct snd_ctl_elem_value *ucontrol)
2312 {
2313 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2314 	int idx = kcontrol->private_value;
2315 	struct hda_spdif_out *spdif;
2316 	hda_nid_t nid;
2317 	unsigned short val;
2318 	int change;
2319 
2320 	if (WARN_ON(codec->spdif_out.used <= idx))
2321 		return -EINVAL;
2322 	mutex_lock(&codec->spdif_mutex);
2323 	spdif = snd_array_elem(&codec->spdif_out, idx);
2324 	nid = spdif->nid;
2325 	spdif->status = ucontrol->value.iec958.status[0] |
2326 		((unsigned int)ucontrol->value.iec958.status[1] << 8) |
2327 		((unsigned int)ucontrol->value.iec958.status[2] << 16) |
2328 		((unsigned int)ucontrol->value.iec958.status[3] << 24);
2329 	val = convert_from_spdif_status(spdif->status);
2330 	val |= spdif->ctls & 1;
2331 	change = spdif->ctls != val;
2332 	spdif->ctls = val;
2333 	if (change && nid != (u16)-1)
2334 		set_dig_out_convert(codec, nid, val & 0xff, (val >> 8) & 0xff);
2335 	mutex_unlock(&codec->spdif_mutex);
2336 	return change;
2337 }
2338 
2339 #define snd_hda_spdif_out_switch_info	snd_ctl_boolean_mono_info
2340 
2341 static int snd_hda_spdif_out_switch_get(struct snd_kcontrol *kcontrol,
2342 					struct snd_ctl_elem_value *ucontrol)
2343 {
2344 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2345 	int idx = kcontrol->private_value;
2346 	struct hda_spdif_out *spdif;
2347 
2348 	if (WARN_ON(codec->spdif_out.used <= idx))
2349 		return -EINVAL;
2350 	mutex_lock(&codec->spdif_mutex);
2351 	spdif = snd_array_elem(&codec->spdif_out, idx);
2352 	ucontrol->value.integer.value[0] = spdif->ctls & AC_DIG1_ENABLE;
2353 	mutex_unlock(&codec->spdif_mutex);
2354 	return 0;
2355 }
2356 
2357 static inline void set_spdif_ctls(struct hda_codec *codec, hda_nid_t nid,
2358 				  int dig1, int dig2)
2359 {
2360 	set_dig_out_convert(codec, nid, dig1, dig2);
2361 	/* unmute amp switch (if any) */
2362 	if ((get_wcaps(codec, nid) & AC_WCAP_OUT_AMP) &&
2363 	    (dig1 & AC_DIG1_ENABLE))
2364 		snd_hda_codec_amp_stereo(codec, nid, HDA_OUTPUT, 0,
2365 					    HDA_AMP_MUTE, 0);
2366 }
2367 
2368 static int snd_hda_spdif_out_switch_put(struct snd_kcontrol *kcontrol,
2369 					struct snd_ctl_elem_value *ucontrol)
2370 {
2371 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2372 	int idx = kcontrol->private_value;
2373 	struct hda_spdif_out *spdif;
2374 	hda_nid_t nid;
2375 	unsigned short val;
2376 	int change;
2377 
2378 	if (WARN_ON(codec->spdif_out.used <= idx))
2379 		return -EINVAL;
2380 	mutex_lock(&codec->spdif_mutex);
2381 	spdif = snd_array_elem(&codec->spdif_out, idx);
2382 	nid = spdif->nid;
2383 	val = spdif->ctls & ~AC_DIG1_ENABLE;
2384 	if (ucontrol->value.integer.value[0])
2385 		val |= AC_DIG1_ENABLE;
2386 	change = spdif->ctls != val;
2387 	spdif->ctls = val;
2388 	if (change && nid != (u16)-1)
2389 		set_spdif_ctls(codec, nid, val & 0xff, -1);
2390 	mutex_unlock(&codec->spdif_mutex);
2391 	return change;
2392 }
2393 
2394 static struct snd_kcontrol_new dig_mixes[] = {
2395 	{
2396 		.access = SNDRV_CTL_ELEM_ACCESS_READ,
2397 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2398 		.name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, CON_MASK),
2399 		.info = snd_hda_spdif_mask_info,
2400 		.get = snd_hda_spdif_cmask_get,
2401 	},
2402 	{
2403 		.access = SNDRV_CTL_ELEM_ACCESS_READ,
2404 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2405 		.name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, PRO_MASK),
2406 		.info = snd_hda_spdif_mask_info,
2407 		.get = snd_hda_spdif_pmask_get,
2408 	},
2409 	{
2410 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2411 		.name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, DEFAULT),
2412 		.info = snd_hda_spdif_mask_info,
2413 		.get = snd_hda_spdif_default_get,
2414 		.put = snd_hda_spdif_default_put,
2415 	},
2416 	{
2417 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2418 		.name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, SWITCH),
2419 		.info = snd_hda_spdif_out_switch_info,
2420 		.get = snd_hda_spdif_out_switch_get,
2421 		.put = snd_hda_spdif_out_switch_put,
2422 	},
2423 	{ } /* end */
2424 };
2425 
2426 /**
2427  * snd_hda_create_dig_out_ctls - create Output SPDIF-related controls
2428  * @codec: the HDA codec
2429  * @associated_nid: NID that new ctls associated with
2430  * @cvt_nid: converter NID
2431  * @type: HDA_PCM_TYPE_*
2432  * Creates controls related with the digital output.
2433  * Called from each patch supporting the digital out.
2434  *
2435  * Returns 0 if successful, or a negative error code.
2436  */
2437 int snd_hda_create_dig_out_ctls(struct hda_codec *codec,
2438 				hda_nid_t associated_nid,
2439 				hda_nid_t cvt_nid,
2440 				int type)
2441 {
2442 	int err;
2443 	struct snd_kcontrol *kctl;
2444 	struct snd_kcontrol_new *dig_mix;
2445 	int idx = 0;
2446 	int val = 0;
2447 	const int spdif_index = 16;
2448 	struct hda_spdif_out *spdif;
2449 	struct hda_bus *bus = codec->bus;
2450 
2451 	if (bus->primary_dig_out_type == HDA_PCM_TYPE_HDMI &&
2452 	    type == HDA_PCM_TYPE_SPDIF) {
2453 		idx = spdif_index;
2454 	} else if (bus->primary_dig_out_type == HDA_PCM_TYPE_SPDIF &&
2455 		   type == HDA_PCM_TYPE_HDMI) {
2456 		/* suppose a single SPDIF device */
2457 		for (dig_mix = dig_mixes; dig_mix->name; dig_mix++) {
2458 			kctl = find_mixer_ctl(codec, dig_mix->name, 0, 0);
2459 			if (!kctl)
2460 				break;
2461 			kctl->id.index = spdif_index;
2462 		}
2463 		bus->primary_dig_out_type = HDA_PCM_TYPE_HDMI;
2464 	}
2465 	if (!bus->primary_dig_out_type)
2466 		bus->primary_dig_out_type = type;
2467 
2468 	idx = find_empty_mixer_ctl_idx(codec, "IEC958 Playback Switch", idx);
2469 	if (idx < 0) {
2470 		codec_err(codec, "too many IEC958 outputs\n");
2471 		return -EBUSY;
2472 	}
2473 	spdif = snd_array_new(&codec->spdif_out);
2474 	if (!spdif)
2475 		return -ENOMEM;
2476 	for (dig_mix = dig_mixes; dig_mix->name; dig_mix++) {
2477 		kctl = snd_ctl_new1(dig_mix, codec);
2478 		if (!kctl)
2479 			return -ENOMEM;
2480 		kctl->id.index = idx;
2481 		kctl->private_value = codec->spdif_out.used - 1;
2482 		err = snd_hda_ctl_add(codec, associated_nid, kctl);
2483 		if (err < 0)
2484 			return err;
2485 	}
2486 	spdif->nid = cvt_nid;
2487 	snd_hdac_regmap_read(&codec->core, cvt_nid,
2488 			     AC_VERB_GET_DIGI_CONVERT_1, &val);
2489 	spdif->ctls = val;
2490 	spdif->status = convert_to_spdif_status(spdif->ctls);
2491 	return 0;
2492 }
2493 EXPORT_SYMBOL_GPL(snd_hda_create_dig_out_ctls);
2494 
2495 /**
2496  * snd_hda_spdif_out_of_nid - get the hda_spdif_out entry from the given NID
2497  * @codec: the HDA codec
2498  * @nid: widget NID
2499  *
2500  * call within spdif_mutex lock
2501  */
2502 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
2503 					       hda_nid_t nid)
2504 {
2505 	struct hda_spdif_out *spdif;
2506 	int i;
2507 
2508 	snd_array_for_each(&codec->spdif_out, i, spdif) {
2509 		if (spdif->nid == nid)
2510 			return spdif;
2511 	}
2512 	return NULL;
2513 }
2514 EXPORT_SYMBOL_GPL(snd_hda_spdif_out_of_nid);
2515 
2516 /**
2517  * snd_hda_spdif_ctls_unassign - Unassign the given SPDIF ctl
2518  * @codec: the HDA codec
2519  * @idx: the SPDIF ctl index
2520  *
2521  * Unassign the widget from the given SPDIF control.
2522  */
2523 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx)
2524 {
2525 	struct hda_spdif_out *spdif;
2526 
2527 	if (WARN_ON(codec->spdif_out.used <= idx))
2528 		return;
2529 	mutex_lock(&codec->spdif_mutex);
2530 	spdif = snd_array_elem(&codec->spdif_out, idx);
2531 	spdif->nid = (u16)-1;
2532 	mutex_unlock(&codec->spdif_mutex);
2533 }
2534 EXPORT_SYMBOL_GPL(snd_hda_spdif_ctls_unassign);
2535 
2536 /**
2537  * snd_hda_spdif_ctls_assign - Assign the SPDIF controls to the given NID
2538  * @codec: the HDA codec
2539  * @idx: the SPDIF ctl idx
2540  * @nid: widget NID
2541  *
2542  * Assign the widget to the SPDIF control with the given index.
2543  */
2544 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid)
2545 {
2546 	struct hda_spdif_out *spdif;
2547 	unsigned short val;
2548 
2549 	if (WARN_ON(codec->spdif_out.used <= idx))
2550 		return;
2551 	mutex_lock(&codec->spdif_mutex);
2552 	spdif = snd_array_elem(&codec->spdif_out, idx);
2553 	if (spdif->nid != nid) {
2554 		spdif->nid = nid;
2555 		val = spdif->ctls;
2556 		set_spdif_ctls(codec, nid, val & 0xff, (val >> 8) & 0xff);
2557 	}
2558 	mutex_unlock(&codec->spdif_mutex);
2559 }
2560 EXPORT_SYMBOL_GPL(snd_hda_spdif_ctls_assign);
2561 
2562 /*
2563  * SPDIF sharing with analog output
2564  */
2565 static int spdif_share_sw_get(struct snd_kcontrol *kcontrol,
2566 			      struct snd_ctl_elem_value *ucontrol)
2567 {
2568 	struct hda_multi_out *mout = snd_kcontrol_chip(kcontrol);
2569 	ucontrol->value.integer.value[0] = mout->share_spdif;
2570 	return 0;
2571 }
2572 
2573 static int spdif_share_sw_put(struct snd_kcontrol *kcontrol,
2574 			      struct snd_ctl_elem_value *ucontrol)
2575 {
2576 	struct hda_multi_out *mout = snd_kcontrol_chip(kcontrol);
2577 	mout->share_spdif = !!ucontrol->value.integer.value[0];
2578 	return 0;
2579 }
2580 
2581 static const struct snd_kcontrol_new spdif_share_sw = {
2582 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2583 	.name = "IEC958 Default PCM Playback Switch",
2584 	.info = snd_ctl_boolean_mono_info,
2585 	.get = spdif_share_sw_get,
2586 	.put = spdif_share_sw_put,
2587 };
2588 
2589 /**
2590  * snd_hda_create_spdif_share_sw - create Default PCM switch
2591  * @codec: the HDA codec
2592  * @mout: multi-out instance
2593  */
2594 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
2595 				  struct hda_multi_out *mout)
2596 {
2597 	struct snd_kcontrol *kctl;
2598 
2599 	if (!mout->dig_out_nid)
2600 		return 0;
2601 
2602 	kctl = snd_ctl_new1(&spdif_share_sw, mout);
2603 	if (!kctl)
2604 		return -ENOMEM;
2605 	/* ATTENTION: here mout is passed as private_data, instead of codec */
2606 	return snd_hda_ctl_add(codec, mout->dig_out_nid, kctl);
2607 }
2608 EXPORT_SYMBOL_GPL(snd_hda_create_spdif_share_sw);
2609 
2610 /*
2611  * SPDIF input
2612  */
2613 
2614 #define snd_hda_spdif_in_switch_info	snd_hda_spdif_out_switch_info
2615 
2616 static int snd_hda_spdif_in_switch_get(struct snd_kcontrol *kcontrol,
2617 				       struct snd_ctl_elem_value *ucontrol)
2618 {
2619 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2620 
2621 	ucontrol->value.integer.value[0] = codec->spdif_in_enable;
2622 	return 0;
2623 }
2624 
2625 static int snd_hda_spdif_in_switch_put(struct snd_kcontrol *kcontrol,
2626 				       struct snd_ctl_elem_value *ucontrol)
2627 {
2628 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2629 	hda_nid_t nid = kcontrol->private_value;
2630 	unsigned int val = !!ucontrol->value.integer.value[0];
2631 	int change;
2632 
2633 	mutex_lock(&codec->spdif_mutex);
2634 	change = codec->spdif_in_enable != val;
2635 	if (change) {
2636 		codec->spdif_in_enable = val;
2637 		snd_hdac_regmap_write(&codec->core, nid,
2638 				      AC_VERB_SET_DIGI_CONVERT_1, val);
2639 	}
2640 	mutex_unlock(&codec->spdif_mutex);
2641 	return change;
2642 }
2643 
2644 static int snd_hda_spdif_in_status_get(struct snd_kcontrol *kcontrol,
2645 				       struct snd_ctl_elem_value *ucontrol)
2646 {
2647 	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
2648 	hda_nid_t nid = kcontrol->private_value;
2649 	unsigned int val;
2650 	unsigned int sbits;
2651 
2652 	snd_hdac_regmap_read(&codec->core, nid,
2653 			     AC_VERB_GET_DIGI_CONVERT_1, &val);
2654 	sbits = convert_to_spdif_status(val);
2655 	ucontrol->value.iec958.status[0] = sbits;
2656 	ucontrol->value.iec958.status[1] = sbits >> 8;
2657 	ucontrol->value.iec958.status[2] = sbits >> 16;
2658 	ucontrol->value.iec958.status[3] = sbits >> 24;
2659 	return 0;
2660 }
2661 
2662 static struct snd_kcontrol_new dig_in_ctls[] = {
2663 	{
2664 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2665 		.name = SNDRV_CTL_NAME_IEC958("", CAPTURE, SWITCH),
2666 		.info = snd_hda_spdif_in_switch_info,
2667 		.get = snd_hda_spdif_in_switch_get,
2668 		.put = snd_hda_spdif_in_switch_put,
2669 	},
2670 	{
2671 		.access = SNDRV_CTL_ELEM_ACCESS_READ,
2672 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2673 		.name = SNDRV_CTL_NAME_IEC958("", CAPTURE, DEFAULT),
2674 		.info = snd_hda_spdif_mask_info,
2675 		.get = snd_hda_spdif_in_status_get,
2676 	},
2677 	{ } /* end */
2678 };
2679 
2680 /**
2681  * snd_hda_create_spdif_in_ctls - create Input SPDIF-related controls
2682  * @codec: the HDA codec
2683  * @nid: audio in widget NID
2684  *
2685  * Creates controls related with the SPDIF input.
2686  * Called from each patch supporting the SPDIF in.
2687  *
2688  * Returns 0 if successful, or a negative error code.
2689  */
2690 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid)
2691 {
2692 	int err;
2693 	struct snd_kcontrol *kctl;
2694 	struct snd_kcontrol_new *dig_mix;
2695 	int idx;
2696 
2697 	idx = find_empty_mixer_ctl_idx(codec, "IEC958 Capture Switch", 0);
2698 	if (idx < 0) {
2699 		codec_err(codec, "too many IEC958 inputs\n");
2700 		return -EBUSY;
2701 	}
2702 	for (dig_mix = dig_in_ctls; dig_mix->name; dig_mix++) {
2703 		kctl = snd_ctl_new1(dig_mix, codec);
2704 		if (!kctl)
2705 			return -ENOMEM;
2706 		kctl->private_value = nid;
2707 		err = snd_hda_ctl_add(codec, nid, kctl);
2708 		if (err < 0)
2709 			return err;
2710 	}
2711 	codec->spdif_in_enable =
2712 		snd_hda_codec_read(codec, nid, 0,
2713 				   AC_VERB_GET_DIGI_CONVERT_1, 0) &
2714 		AC_DIG1_ENABLE;
2715 	return 0;
2716 }
2717 EXPORT_SYMBOL_GPL(snd_hda_create_spdif_in_ctls);
2718 
2719 /**
2720  * snd_hda_codec_set_power_to_all - Set the power state to all widgets
2721  * @codec: the HDA codec
2722  * @fg: function group (not used now)
2723  * @power_state: the power state to set (AC_PWRST_*)
2724  *
2725  * Set the given power state to all widgets that have the power control.
2726  * If the codec has power_filter set, it evaluates the power state and
2727  * filter out if it's unchanged as D3.
2728  */
2729 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
2730 				    unsigned int power_state)
2731 {
2732 	hda_nid_t nid;
2733 
2734 	for_each_hda_codec_node(nid, codec) {
2735 		unsigned int wcaps = get_wcaps(codec, nid);
2736 		unsigned int state = power_state;
2737 		if (!(wcaps & AC_WCAP_POWER))
2738 			continue;
2739 		if (codec->power_filter) {
2740 			state = codec->power_filter(codec, nid, power_state);
2741 			if (state != power_state && power_state == AC_PWRST_D3)
2742 				continue;
2743 		}
2744 		snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_POWER_STATE,
2745 				    state);
2746 	}
2747 }
2748 EXPORT_SYMBOL_GPL(snd_hda_codec_set_power_to_all);
2749 
2750 /**
2751  * snd_hda_codec_eapd_power_filter - A power filter callback for EAPD
2752  * @codec: the HDA codec
2753  * @nid: widget NID
2754  * @power_state: power state to evalue
2755  *
2756  * Don't power down the widget if it controls eapd and EAPD_BTLENABLE is set.
2757  * This can be used a codec power_filter callback.
2758  */
2759 unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
2760 					     hda_nid_t nid,
2761 					     unsigned int power_state)
2762 {
2763 	if (nid == codec->core.afg || nid == codec->core.mfg)
2764 		return power_state;
2765 	if (power_state == AC_PWRST_D3 &&
2766 	    get_wcaps_type(get_wcaps(codec, nid)) == AC_WID_PIN &&
2767 	    (snd_hda_query_pin_caps(codec, nid) & AC_PINCAP_EAPD)) {
2768 		int eapd = snd_hda_codec_read(codec, nid, 0,
2769 					      AC_VERB_GET_EAPD_BTLENABLE, 0);
2770 		if (eapd & 0x02)
2771 			return AC_PWRST_D0;
2772 	}
2773 	return power_state;
2774 }
2775 EXPORT_SYMBOL_GPL(snd_hda_codec_eapd_power_filter);
2776 
2777 /*
2778  * set power state of the codec, and return the power state
2779  */
2780 static unsigned int hda_set_power_state(struct hda_codec *codec,
2781 					unsigned int power_state)
2782 {
2783 	hda_nid_t fg = codec->core.afg ? codec->core.afg : codec->core.mfg;
2784 	int count;
2785 	unsigned int state;
2786 	int flags = 0;
2787 
2788 	/* this delay seems necessary to avoid click noise at power-down */
2789 	if (power_state == AC_PWRST_D3) {
2790 		if (codec->depop_delay < 0)
2791 			msleep(codec_has_epss(codec) ? 10 : 100);
2792 		else if (codec->depop_delay > 0)
2793 			msleep(codec->depop_delay);
2794 		flags = HDA_RW_NO_RESPONSE_FALLBACK;
2795 	}
2796 
2797 	/* repeat power states setting at most 10 times*/
2798 	for (count = 0; count < 10; count++) {
2799 		if (codec->patch_ops.set_power_state)
2800 			codec->patch_ops.set_power_state(codec, fg,
2801 							 power_state);
2802 		else {
2803 			state = power_state;
2804 			if (codec->power_filter)
2805 				state = codec->power_filter(codec, fg, state);
2806 			if (state == power_state || power_state != AC_PWRST_D3)
2807 				snd_hda_codec_read(codec, fg, flags,
2808 						   AC_VERB_SET_POWER_STATE,
2809 						   state);
2810 			snd_hda_codec_set_power_to_all(codec, fg, power_state);
2811 		}
2812 		state = snd_hda_sync_power_state(codec, fg, power_state);
2813 		if (!(state & AC_PWRST_ERROR))
2814 			break;
2815 	}
2816 
2817 	return state;
2818 }
2819 
2820 /* sync power states of all widgets;
2821  * this is called at the end of codec parsing
2822  */
2823 static void sync_power_up_states(struct hda_codec *codec)
2824 {
2825 	hda_nid_t nid;
2826 
2827 	/* don't care if no filter is used */
2828 	if (!codec->power_filter)
2829 		return;
2830 
2831 	for_each_hda_codec_node(nid, codec) {
2832 		unsigned int wcaps = get_wcaps(codec, nid);
2833 		unsigned int target;
2834 		if (!(wcaps & AC_WCAP_POWER))
2835 			continue;
2836 		target = codec->power_filter(codec, nid, AC_PWRST_D0);
2837 		if (target == AC_PWRST_D0)
2838 			continue;
2839 		if (!snd_hda_check_power_state(codec, nid, target))
2840 			snd_hda_codec_write(codec, nid, 0,
2841 					    AC_VERB_SET_POWER_STATE, target);
2842 	}
2843 }
2844 
2845 #ifdef CONFIG_SND_HDA_RECONFIG
2846 /* execute additional init verbs */
2847 static void hda_exec_init_verbs(struct hda_codec *codec)
2848 {
2849 	if (codec->init_verbs.list)
2850 		snd_hda_sequence_write(codec, codec->init_verbs.list);
2851 }
2852 #else
2853 static inline void hda_exec_init_verbs(struct hda_codec *codec) {}
2854 #endif
2855 
2856 #ifdef CONFIG_PM
2857 /* update the power on/off account with the current jiffies */
2858 static void update_power_acct(struct hda_codec *codec, bool on)
2859 {
2860 	unsigned long delta = jiffies - codec->power_jiffies;
2861 
2862 	if (on)
2863 		codec->power_on_acct += delta;
2864 	else
2865 		codec->power_off_acct += delta;
2866 	codec->power_jiffies += delta;
2867 }
2868 
2869 void snd_hda_update_power_acct(struct hda_codec *codec)
2870 {
2871 	update_power_acct(codec, hda_codec_is_power_on(codec));
2872 }
2873 
2874 /*
2875  * call suspend and power-down; used both from PM and power-save
2876  * this function returns the power state in the end
2877  */
2878 static unsigned int hda_call_codec_suspend(struct hda_codec *codec)
2879 {
2880 	unsigned int state;
2881 
2882 	snd_hdac_enter_pm(&codec->core);
2883 	if (codec->patch_ops.suspend)
2884 		codec->patch_ops.suspend(codec);
2885 	hda_cleanup_all_streams(codec);
2886 	state = hda_set_power_state(codec, AC_PWRST_D3);
2887 	update_power_acct(codec, true);
2888 	snd_hdac_leave_pm(&codec->core);
2889 	return state;
2890 }
2891 
2892 /*
2893  * kick up codec; used both from PM and power-save
2894  */
2895 static void hda_call_codec_resume(struct hda_codec *codec)
2896 {
2897 	snd_hdac_enter_pm(&codec->core);
2898 	if (codec->core.regmap)
2899 		regcache_mark_dirty(codec->core.regmap);
2900 
2901 	codec->power_jiffies = jiffies;
2902 
2903 	hda_set_power_state(codec, AC_PWRST_D0);
2904 	restore_shutup_pins(codec);
2905 	hda_exec_init_verbs(codec);
2906 	snd_hda_jack_set_dirty_all(codec);
2907 	if (codec->patch_ops.resume)
2908 		codec->patch_ops.resume(codec);
2909 	else {
2910 		if (codec->patch_ops.init)
2911 			codec->patch_ops.init(codec);
2912 		if (codec->core.regmap)
2913 			regcache_sync(codec->core.regmap);
2914 	}
2915 
2916 	if (codec->jackpoll_interval)
2917 		hda_jackpoll_work(&codec->jackpoll_work.work);
2918 	else
2919 		snd_hda_jack_report_sync(codec);
2920 	snd_hdac_leave_pm(&codec->core);
2921 }
2922 
2923 static int hda_codec_runtime_suspend(struct device *dev)
2924 {
2925 	struct hda_codec *codec = dev_to_hda_codec(dev);
2926 	struct hda_pcm *pcm;
2927 	unsigned int state;
2928 
2929 	cancel_delayed_work_sync(&codec->jackpoll_work);
2930 	list_for_each_entry(pcm, &codec->pcm_list_head, list)
2931 		snd_pcm_suspend_all(pcm->pcm);
2932 	state = hda_call_codec_suspend(codec);
2933 	if (codec->link_down_at_suspend ||
2934 	    (codec_has_clkstop(codec) && codec_has_epss(codec) &&
2935 	     (state & AC_PWRST_CLK_STOP_OK)))
2936 		snd_hdac_codec_link_down(&codec->core);
2937 	codec_display_power(codec, false);
2938 	return 0;
2939 }
2940 
2941 static int hda_codec_runtime_resume(struct device *dev)
2942 {
2943 	struct hda_codec *codec = dev_to_hda_codec(dev);
2944 
2945 	codec_display_power(codec, true);
2946 	snd_hdac_codec_link_up(&codec->core);
2947 	hda_call_codec_resume(codec);
2948 	pm_runtime_mark_last_busy(dev);
2949 	return 0;
2950 }
2951 #endif /* CONFIG_PM */
2952 
2953 /* referred in hda_bind.c */
2954 const struct dev_pm_ops hda_codec_driver_pm = {
2955 	SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
2956 				pm_runtime_force_resume)
2957 	SET_RUNTIME_PM_OPS(hda_codec_runtime_suspend, hda_codec_runtime_resume,
2958 			   NULL)
2959 };
2960 
2961 /*
2962  * add standard channel maps if not specified
2963  */
2964 static int add_std_chmaps(struct hda_codec *codec)
2965 {
2966 	struct hda_pcm *pcm;
2967 	int str, err;
2968 
2969 	list_for_each_entry(pcm, &codec->pcm_list_head, list) {
2970 		for (str = 0; str < 2; str++) {
2971 			struct hda_pcm_stream *hinfo = &pcm->stream[str];
2972 			struct snd_pcm_chmap *chmap;
2973 			const struct snd_pcm_chmap_elem *elem;
2974 
2975 			if (!pcm->pcm || pcm->own_chmap || !hinfo->substreams)
2976 				continue;
2977 			elem = hinfo->chmap ? hinfo->chmap : snd_pcm_std_chmaps;
2978 			err = snd_pcm_add_chmap_ctls(pcm->pcm, str, elem,
2979 						     hinfo->channels_max,
2980 						     0, &chmap);
2981 			if (err < 0)
2982 				return err;
2983 			chmap->channel_mask = SND_PCM_CHMAP_MASK_2468;
2984 		}
2985 	}
2986 	return 0;
2987 }
2988 
2989 /* default channel maps for 2.1 speakers;
2990  * since HD-audio supports only stereo, odd number channels are omitted
2991  */
2992 const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[] = {
2993 	{ .channels = 2,
2994 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2995 	{ .channels = 4,
2996 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2997 		   SNDRV_CHMAP_LFE, SNDRV_CHMAP_LFE } },
2998 	{ }
2999 };
3000 EXPORT_SYMBOL_GPL(snd_pcm_2_1_chmaps);
3001 
3002 int snd_hda_codec_build_controls(struct hda_codec *codec)
3003 {
3004 	int err = 0;
3005 	hda_exec_init_verbs(codec);
3006 	/* continue to initialize... */
3007 	if (codec->patch_ops.init)
3008 		err = codec->patch_ops.init(codec);
3009 	if (!err && codec->patch_ops.build_controls)
3010 		err = codec->patch_ops.build_controls(codec);
3011 	if (err < 0)
3012 		return err;
3013 
3014 	/* we create chmaps here instead of build_pcms */
3015 	err = add_std_chmaps(codec);
3016 	if (err < 0)
3017 		return err;
3018 
3019 	if (codec->jackpoll_interval)
3020 		hda_jackpoll_work(&codec->jackpoll_work.work);
3021 	else
3022 		snd_hda_jack_report_sync(codec); /* call at the last init point */
3023 	sync_power_up_states(codec);
3024 	return 0;
3025 }
3026 EXPORT_SYMBOL_GPL(snd_hda_codec_build_controls);
3027 
3028 /*
3029  * PCM stuff
3030  */
3031 static int hda_pcm_default_open_close(struct hda_pcm_stream *hinfo,
3032 				      struct hda_codec *codec,
3033 				      struct snd_pcm_substream *substream)
3034 {
3035 	return 0;
3036 }
3037 
3038 static int hda_pcm_default_prepare(struct hda_pcm_stream *hinfo,
3039 				   struct hda_codec *codec,
3040 				   unsigned int stream_tag,
3041 				   unsigned int format,
3042 				   struct snd_pcm_substream *substream)
3043 {
3044 	snd_hda_codec_setup_stream(codec, hinfo->nid, stream_tag, 0, format);
3045 	return 0;
3046 }
3047 
3048 static int hda_pcm_default_cleanup(struct hda_pcm_stream *hinfo,
3049 				   struct hda_codec *codec,
3050 				   struct snd_pcm_substream *substream)
3051 {
3052 	snd_hda_codec_cleanup_stream(codec, hinfo->nid);
3053 	return 0;
3054 }
3055 
3056 static int set_pcm_default_values(struct hda_codec *codec,
3057 				  struct hda_pcm_stream *info)
3058 {
3059 	int err;
3060 
3061 	/* query support PCM information from the given NID */
3062 	if (info->nid && (!info->rates || !info->formats)) {
3063 		err = snd_hda_query_supported_pcm(codec, info->nid,
3064 				info->rates ? NULL : &info->rates,
3065 				info->formats ? NULL : &info->formats,
3066 				info->maxbps ? NULL : &info->maxbps);
3067 		if (err < 0)
3068 			return err;
3069 	}
3070 	if (info->ops.open == NULL)
3071 		info->ops.open = hda_pcm_default_open_close;
3072 	if (info->ops.close == NULL)
3073 		info->ops.close = hda_pcm_default_open_close;
3074 	if (info->ops.prepare == NULL) {
3075 		if (snd_BUG_ON(!info->nid))
3076 			return -EINVAL;
3077 		info->ops.prepare = hda_pcm_default_prepare;
3078 	}
3079 	if (info->ops.cleanup == NULL) {
3080 		if (snd_BUG_ON(!info->nid))
3081 			return -EINVAL;
3082 		info->ops.cleanup = hda_pcm_default_cleanup;
3083 	}
3084 	return 0;
3085 }
3086 
3087 /*
3088  * codec prepare/cleanup entries
3089  */
3090 /**
3091  * snd_hda_codec_prepare - Prepare a stream
3092  * @codec: the HDA codec
3093  * @hinfo: PCM information
3094  * @stream: stream tag to assign
3095  * @format: format id to assign
3096  * @substream: PCM substream to assign
3097  *
3098  * Calls the prepare callback set by the codec with the given arguments.
3099  * Clean up the inactive streams when successful.
3100  */
3101 int snd_hda_codec_prepare(struct hda_codec *codec,
3102 			  struct hda_pcm_stream *hinfo,
3103 			  unsigned int stream,
3104 			  unsigned int format,
3105 			  struct snd_pcm_substream *substream)
3106 {
3107 	int ret;
3108 	mutex_lock(&codec->bus->prepare_mutex);
3109 	if (hinfo->ops.prepare)
3110 		ret = hinfo->ops.prepare(hinfo, codec, stream, format,
3111 					 substream);
3112 	else
3113 		ret = -ENODEV;
3114 	if (ret >= 0)
3115 		purify_inactive_streams(codec);
3116 	mutex_unlock(&codec->bus->prepare_mutex);
3117 	return ret;
3118 }
3119 EXPORT_SYMBOL_GPL(snd_hda_codec_prepare);
3120 
3121 /**
3122  * snd_hda_codec_cleanup - Prepare a stream
3123  * @codec: the HDA codec
3124  * @hinfo: PCM information
3125  * @substream: PCM substream
3126  *
3127  * Calls the cleanup callback set by the codec with the given arguments.
3128  */
3129 void snd_hda_codec_cleanup(struct hda_codec *codec,
3130 			   struct hda_pcm_stream *hinfo,
3131 			   struct snd_pcm_substream *substream)
3132 {
3133 	mutex_lock(&codec->bus->prepare_mutex);
3134 	if (hinfo->ops.cleanup)
3135 		hinfo->ops.cleanup(hinfo, codec, substream);
3136 	mutex_unlock(&codec->bus->prepare_mutex);
3137 }
3138 EXPORT_SYMBOL_GPL(snd_hda_codec_cleanup);
3139 
3140 /* global */
3141 const char *snd_hda_pcm_type_name[HDA_PCM_NTYPES] = {
3142 	"Audio", "SPDIF", "HDMI", "Modem"
3143 };
3144 
3145 /*
3146  * get the empty PCM device number to assign
3147  */
3148 static int get_empty_pcm_device(struct hda_bus *bus, unsigned int type)
3149 {
3150 	/* audio device indices; not linear to keep compatibility */
3151 	/* assigned to static slots up to dev#10; if more needed, assign
3152 	 * the later slot dynamically (when CONFIG_SND_DYNAMIC_MINORS=y)
3153 	 */
3154 	static int audio_idx[HDA_PCM_NTYPES][5] = {
3155 		[HDA_PCM_TYPE_AUDIO] = { 0, 2, 4, 5, -1 },
3156 		[HDA_PCM_TYPE_SPDIF] = { 1, -1 },
3157 		[HDA_PCM_TYPE_HDMI]  = { 3, 7, 8, 9, -1 },
3158 		[HDA_PCM_TYPE_MODEM] = { 6, -1 },
3159 	};
3160 	int i;
3161 
3162 	if (type >= HDA_PCM_NTYPES) {
3163 		dev_err(bus->card->dev, "Invalid PCM type %d\n", type);
3164 		return -EINVAL;
3165 	}
3166 
3167 	for (i = 0; audio_idx[type][i] >= 0; i++) {
3168 #ifndef CONFIG_SND_DYNAMIC_MINORS
3169 		if (audio_idx[type][i] >= 8)
3170 			break;
3171 #endif
3172 		if (!test_and_set_bit(audio_idx[type][i], bus->pcm_dev_bits))
3173 			return audio_idx[type][i];
3174 	}
3175 
3176 #ifdef CONFIG_SND_DYNAMIC_MINORS
3177 	/* non-fixed slots starting from 10 */
3178 	for (i = 10; i < 32; i++) {
3179 		if (!test_and_set_bit(i, bus->pcm_dev_bits))
3180 			return i;
3181 	}
3182 #endif
3183 
3184 	dev_warn(bus->card->dev, "Too many %s devices\n",
3185 		snd_hda_pcm_type_name[type]);
3186 #ifndef CONFIG_SND_DYNAMIC_MINORS
3187 	dev_warn(bus->card->dev,
3188 		 "Consider building the kernel with CONFIG_SND_DYNAMIC_MINORS=y\n");
3189 #endif
3190 	return -EAGAIN;
3191 }
3192 
3193 /* call build_pcms ops of the given codec and set up the default parameters */
3194 int snd_hda_codec_parse_pcms(struct hda_codec *codec)
3195 {
3196 	struct hda_pcm *cpcm;
3197 	int err;
3198 
3199 	if (!list_empty(&codec->pcm_list_head))
3200 		return 0; /* already parsed */
3201 
3202 	if (!codec->patch_ops.build_pcms)
3203 		return 0;
3204 
3205 	err = codec->patch_ops.build_pcms(codec);
3206 	if (err < 0) {
3207 		codec_err(codec, "cannot build PCMs for #%d (error %d)\n",
3208 			  codec->core.addr, err);
3209 		return err;
3210 	}
3211 
3212 	list_for_each_entry(cpcm, &codec->pcm_list_head, list) {
3213 		int stream;
3214 
3215 		for (stream = 0; stream < 2; stream++) {
3216 			struct hda_pcm_stream *info = &cpcm->stream[stream];
3217 
3218 			if (!info->substreams)
3219 				continue;
3220 			err = set_pcm_default_values(codec, info);
3221 			if (err < 0) {
3222 				codec_warn(codec,
3223 					   "fail to setup default for PCM %s\n",
3224 					   cpcm->name);
3225 				return err;
3226 			}
3227 		}
3228 	}
3229 
3230 	return 0;
3231 }
3232 EXPORT_SYMBOL_GPL(snd_hda_codec_parse_pcms);
3233 
3234 /* assign all PCMs of the given codec */
3235 int snd_hda_codec_build_pcms(struct hda_codec *codec)
3236 {
3237 	struct hda_bus *bus = codec->bus;
3238 	struct hda_pcm *cpcm;
3239 	int dev, err;
3240 
3241 	err = snd_hda_codec_parse_pcms(codec);
3242 	if (err < 0)
3243 		return err;
3244 
3245 	/* attach a new PCM streams */
3246 	list_for_each_entry(cpcm, &codec->pcm_list_head, list) {
3247 		if (cpcm->pcm)
3248 			continue; /* already attached */
3249 		if (!cpcm->stream[0].substreams && !cpcm->stream[1].substreams)
3250 			continue; /* no substreams assigned */
3251 
3252 		dev = get_empty_pcm_device(bus, cpcm->pcm_type);
3253 		if (dev < 0) {
3254 			cpcm->device = SNDRV_PCM_INVALID_DEVICE;
3255 			continue; /* no fatal error */
3256 		}
3257 		cpcm->device = dev;
3258 		err =  snd_hda_attach_pcm_stream(bus, codec, cpcm);
3259 		if (err < 0) {
3260 			codec_err(codec,
3261 				  "cannot attach PCM stream %d for codec #%d\n",
3262 				  dev, codec->core.addr);
3263 			continue; /* no fatal error */
3264 		}
3265 	}
3266 
3267 	return 0;
3268 }
3269 
3270 /**
3271  * snd_hda_add_new_ctls - create controls from the array
3272  * @codec: the HDA codec
3273  * @knew: the array of struct snd_kcontrol_new
3274  *
3275  * This helper function creates and add new controls in the given array.
3276  * The array must be terminated with an empty entry as terminator.
3277  *
3278  * Returns 0 if successful, or a negative error code.
3279  */
3280 int snd_hda_add_new_ctls(struct hda_codec *codec,
3281 			 const struct snd_kcontrol_new *knew)
3282 {
3283 	int err;
3284 
3285 	for (; knew->name; knew++) {
3286 		struct snd_kcontrol *kctl;
3287 		int addr = 0, idx = 0;
3288 		if (knew->iface == (__force snd_ctl_elem_iface_t)-1)
3289 			continue; /* skip this codec private value */
3290 		for (;;) {
3291 			kctl = snd_ctl_new1(knew, codec);
3292 			if (!kctl)
3293 				return -ENOMEM;
3294 			if (addr > 0)
3295 				kctl->id.device = addr;
3296 			if (idx > 0)
3297 				kctl->id.index = idx;
3298 			err = snd_hda_ctl_add(codec, 0, kctl);
3299 			if (!err)
3300 				break;
3301 			/* try first with another device index corresponding to
3302 			 * the codec addr; if it still fails (or it's the
3303 			 * primary codec), then try another control index
3304 			 */
3305 			if (!addr && codec->core.addr)
3306 				addr = codec->core.addr;
3307 			else if (!idx && !knew->index) {
3308 				idx = find_empty_mixer_ctl_idx(codec,
3309 							       knew->name, 0);
3310 				if (idx <= 0)
3311 					return err;
3312 			} else
3313 				return err;
3314 		}
3315 	}
3316 	return 0;
3317 }
3318 EXPORT_SYMBOL_GPL(snd_hda_add_new_ctls);
3319 
3320 #ifdef CONFIG_PM
3321 static void codec_set_power_save(struct hda_codec *codec, int delay)
3322 {
3323 	struct device *dev = hda_codec_dev(codec);
3324 
3325 	if (delay == 0 && codec->auto_runtime_pm)
3326 		delay = 3000;
3327 
3328 	if (delay > 0) {
3329 		pm_runtime_set_autosuspend_delay(dev, delay);
3330 		pm_runtime_use_autosuspend(dev);
3331 		pm_runtime_allow(dev);
3332 		if (!pm_runtime_suspended(dev))
3333 			pm_runtime_mark_last_busy(dev);
3334 	} else {
3335 		pm_runtime_dont_use_autosuspend(dev);
3336 		pm_runtime_forbid(dev);
3337 	}
3338 }
3339 
3340 /**
3341  * snd_hda_set_power_save - reprogram autosuspend for the given delay
3342  * @bus: HD-audio bus
3343  * @delay: autosuspend delay in msec, 0 = off
3344  *
3345  * Synchronize the runtime PM autosuspend state from the power_save option.
3346  */
3347 void snd_hda_set_power_save(struct hda_bus *bus, int delay)
3348 {
3349 	struct hda_codec *c;
3350 
3351 	list_for_each_codec(c, bus)
3352 		codec_set_power_save(c, delay);
3353 }
3354 EXPORT_SYMBOL_GPL(snd_hda_set_power_save);
3355 
3356 /**
3357  * snd_hda_check_amp_list_power - Check the amp list and update the power
3358  * @codec: HD-audio codec
3359  * @check: the object containing an AMP list and the status
3360  * @nid: NID to check / update
3361  *
3362  * Check whether the given NID is in the amp list.  If it's in the list,
3363  * check the current AMP status, and update the the power-status according
3364  * to the mute status.
3365  *
3366  * This function is supposed to be set or called from the check_power_status
3367  * patch ops.
3368  */
3369 int snd_hda_check_amp_list_power(struct hda_codec *codec,
3370 				 struct hda_loopback_check *check,
3371 				 hda_nid_t nid)
3372 {
3373 	const struct hda_amp_list *p;
3374 	int ch, v;
3375 
3376 	if (!check->amplist)
3377 		return 0;
3378 	for (p = check->amplist; p->nid; p++) {
3379 		if (p->nid == nid)
3380 			break;
3381 	}
3382 	if (!p->nid)
3383 		return 0; /* nothing changed */
3384 
3385 	for (p = check->amplist; p->nid; p++) {
3386 		for (ch = 0; ch < 2; ch++) {
3387 			v = snd_hda_codec_amp_read(codec, p->nid, ch, p->dir,
3388 						   p->idx);
3389 			if (!(v & HDA_AMP_MUTE) && v > 0) {
3390 				if (!check->power_on) {
3391 					check->power_on = 1;
3392 					snd_hda_power_up_pm(codec);
3393 				}
3394 				return 1;
3395 			}
3396 		}
3397 	}
3398 	if (check->power_on) {
3399 		check->power_on = 0;
3400 		snd_hda_power_down_pm(codec);
3401 	}
3402 	return 0;
3403 }
3404 EXPORT_SYMBOL_GPL(snd_hda_check_amp_list_power);
3405 #endif
3406 
3407 /*
3408  * input MUX helper
3409  */
3410 
3411 /**
3412  * snd_hda_input_mux_info_info - Info callback helper for the input-mux enum
3413  * @imux: imux helper object
3414  * @uinfo: pointer to get/store the data
3415  */
3416 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
3417 			   struct snd_ctl_elem_info *uinfo)
3418 {
3419 	unsigned int index;
3420 
3421 	uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
3422 	uinfo->count = 1;
3423 	uinfo->value.enumerated.items = imux->num_items;
3424 	if (!imux->num_items)
3425 		return 0;
3426 	index = uinfo->value.enumerated.item;
3427 	if (index >= imux->num_items)
3428 		index = imux->num_items - 1;
3429 	strcpy(uinfo->value.enumerated.name, imux->items[index].label);
3430 	return 0;
3431 }
3432 EXPORT_SYMBOL_GPL(snd_hda_input_mux_info);
3433 
3434 /**
3435  * snd_hda_input_mux_info_put - Put callback helper for the input-mux enum
3436  * @codec: the HDA codec
3437  * @imux: imux helper object
3438  * @ucontrol: pointer to get/store the data
3439  * @nid: input mux NID
3440  * @cur_val: pointer to get/store the current imux value
3441  */
3442 int snd_hda_input_mux_put(struct hda_codec *codec,
3443 			  const struct hda_input_mux *imux,
3444 			  struct snd_ctl_elem_value *ucontrol,
3445 			  hda_nid_t nid,
3446 			  unsigned int *cur_val)
3447 {
3448 	unsigned int idx;
3449 
3450 	if (!imux->num_items)
3451 		return 0;
3452 	idx = ucontrol->value.enumerated.item[0];
3453 	if (idx >= imux->num_items)
3454 		idx = imux->num_items - 1;
3455 	if (*cur_val == idx)
3456 		return 0;
3457 	snd_hda_codec_write_cache(codec, nid, 0, AC_VERB_SET_CONNECT_SEL,
3458 				  imux->items[idx].index);
3459 	*cur_val = idx;
3460 	return 1;
3461 }
3462 EXPORT_SYMBOL_GPL(snd_hda_input_mux_put);
3463 
3464 
3465 /**
3466  * snd_hda_enum_helper_info - Helper for simple enum ctls
3467  * @kcontrol: ctl element
3468  * @uinfo: pointer to get/store the data
3469  * @num_items: number of enum items
3470  * @texts: enum item string array
3471  *
3472  * process kcontrol info callback of a simple string enum array
3473  * when @num_items is 0 or @texts is NULL, assume a boolean enum array
3474  */
3475 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
3476 			     struct snd_ctl_elem_info *uinfo,
3477 			     int num_items, const char * const *texts)
3478 {
3479 	static const char * const texts_default[] = {
3480 		"Disabled", "Enabled"
3481 	};
3482 
3483 	if (!texts || !num_items) {
3484 		num_items = 2;
3485 		texts = texts_default;
3486 	}
3487 
3488 	return snd_ctl_enum_info(uinfo, 1, num_items, texts);
3489 }
3490 EXPORT_SYMBOL_GPL(snd_hda_enum_helper_info);
3491 
3492 /*
3493  * Multi-channel / digital-out PCM helper functions
3494  */
3495 
3496 /* setup SPDIF output stream */
3497 static void setup_dig_out_stream(struct hda_codec *codec, hda_nid_t nid,
3498 				 unsigned int stream_tag, unsigned int format)
3499 {
3500 	struct hda_spdif_out *spdif;
3501 	unsigned int curr_fmt;
3502 	bool reset;
3503 
3504 	spdif = snd_hda_spdif_out_of_nid(codec, nid);
3505 	/* Add sanity check to pass klockwork check.
3506 	 * This should never happen.
3507 	 */
3508 	if (WARN_ON(spdif == NULL))
3509 		return;
3510 
3511 	curr_fmt = snd_hda_codec_read(codec, nid, 0,
3512 				      AC_VERB_GET_STREAM_FORMAT, 0);
3513 	reset = codec->spdif_status_reset &&
3514 		(spdif->ctls & AC_DIG1_ENABLE) &&
3515 		curr_fmt != format;
3516 
3517 	/* turn off SPDIF if needed; otherwise the IEC958 bits won't be
3518 	   updated */
3519 	if (reset)
3520 		set_dig_out_convert(codec, nid,
3521 				    spdif->ctls & ~AC_DIG1_ENABLE & 0xff,
3522 				    -1);
3523 	snd_hda_codec_setup_stream(codec, nid, stream_tag, 0, format);
3524 	if (codec->slave_dig_outs) {
3525 		const hda_nid_t *d;
3526 		for (d = codec->slave_dig_outs; *d; d++)
3527 			snd_hda_codec_setup_stream(codec, *d, stream_tag, 0,
3528 						   format);
3529 	}
3530 	/* turn on again (if needed) */
3531 	if (reset)
3532 		set_dig_out_convert(codec, nid,
3533 				    spdif->ctls & 0xff, -1);
3534 }
3535 
3536 static void cleanup_dig_out_stream(struct hda_codec *codec, hda_nid_t nid)
3537 {
3538 	snd_hda_codec_cleanup_stream(codec, nid);
3539 	if (codec->slave_dig_outs) {
3540 		const hda_nid_t *d;
3541 		for (d = codec->slave_dig_outs; *d; d++)
3542 			snd_hda_codec_cleanup_stream(codec, *d);
3543 	}
3544 }
3545 
3546 /**
3547  * snd_hda_multi_out_dig_open - open the digital out in the exclusive mode
3548  * @codec: the HDA codec
3549  * @mout: hda_multi_out object
3550  */
3551 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
3552 			       struct hda_multi_out *mout)
3553 {
3554 	mutex_lock(&codec->spdif_mutex);
3555 	if (mout->dig_out_used == HDA_DIG_ANALOG_DUP)
3556 		/* already opened as analog dup; reset it once */
3557 		cleanup_dig_out_stream(codec, mout->dig_out_nid);
3558 	mout->dig_out_used = HDA_DIG_EXCLUSIVE;
3559 	mutex_unlock(&codec->spdif_mutex);
3560 	return 0;
3561 }
3562 EXPORT_SYMBOL_GPL(snd_hda_multi_out_dig_open);
3563 
3564 /**
3565  * snd_hda_multi_out_dig_prepare - prepare the digital out stream
3566  * @codec: the HDA codec
3567  * @mout: hda_multi_out object
3568  * @stream_tag: stream tag to assign
3569  * @format: format id to assign
3570  * @substream: PCM substream to assign
3571  */
3572 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
3573 				  struct hda_multi_out *mout,
3574 				  unsigned int stream_tag,
3575 				  unsigned int format,
3576 				  struct snd_pcm_substream *substream)
3577 {
3578 	mutex_lock(&codec->spdif_mutex);
3579 	setup_dig_out_stream(codec, mout->dig_out_nid, stream_tag, format);
3580 	mutex_unlock(&codec->spdif_mutex);
3581 	return 0;
3582 }
3583 EXPORT_SYMBOL_GPL(snd_hda_multi_out_dig_prepare);
3584 
3585 /**
3586  * snd_hda_multi_out_dig_cleanup - clean-up the digital out stream
3587  * @codec: the HDA codec
3588  * @mout: hda_multi_out object
3589  */
3590 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
3591 				  struct hda_multi_out *mout)
3592 {
3593 	mutex_lock(&codec->spdif_mutex);
3594 	cleanup_dig_out_stream(codec, mout->dig_out_nid);
3595 	mutex_unlock(&codec->spdif_mutex);
3596 	return 0;
3597 }
3598 EXPORT_SYMBOL_GPL(snd_hda_multi_out_dig_cleanup);
3599 
3600 /**
3601  * snd_hda_multi_out_dig_close - release the digital out stream
3602  * @codec: the HDA codec
3603  * @mout: hda_multi_out object
3604  */
3605 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
3606 				struct hda_multi_out *mout)
3607 {
3608 	mutex_lock(&codec->spdif_mutex);
3609 	mout->dig_out_used = 0;
3610 	mutex_unlock(&codec->spdif_mutex);
3611 	return 0;
3612 }
3613 EXPORT_SYMBOL_GPL(snd_hda_multi_out_dig_close);
3614 
3615 /**
3616  * snd_hda_multi_out_analog_open - open analog outputs
3617  * @codec: the HDA codec
3618  * @mout: hda_multi_out object
3619  * @substream: PCM substream to assign
3620  * @hinfo: PCM information to assign
3621  *
3622  * Open analog outputs and set up the hw-constraints.
3623  * If the digital outputs can be opened as slave, open the digital
3624  * outputs, too.
3625  */
3626 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
3627 				  struct hda_multi_out *mout,
3628 				  struct snd_pcm_substream *substream,
3629 				  struct hda_pcm_stream *hinfo)
3630 {
3631 	struct snd_pcm_runtime *runtime = substream->runtime;
3632 	runtime->hw.channels_max = mout->max_channels;
3633 	if (mout->dig_out_nid) {
3634 		if (!mout->analog_rates) {
3635 			mout->analog_rates = hinfo->rates;
3636 			mout->analog_formats = hinfo->formats;
3637 			mout->analog_maxbps = hinfo->maxbps;
3638 		} else {
3639 			runtime->hw.rates = mout->analog_rates;
3640 			runtime->hw.formats = mout->analog_formats;
3641 			hinfo->maxbps = mout->analog_maxbps;
3642 		}
3643 		if (!mout->spdif_rates) {
3644 			snd_hda_query_supported_pcm(codec, mout->dig_out_nid,
3645 						    &mout->spdif_rates,
3646 						    &mout->spdif_formats,
3647 						    &mout->spdif_maxbps);
3648 		}
3649 		mutex_lock(&codec->spdif_mutex);
3650 		if (mout->share_spdif) {
3651 			if ((runtime->hw.rates & mout->spdif_rates) &&
3652 			    (runtime->hw.formats & mout->spdif_formats)) {
3653 				runtime->hw.rates &= mout->spdif_rates;
3654 				runtime->hw.formats &= mout->spdif_formats;
3655 				if (mout->spdif_maxbps < hinfo->maxbps)
3656 					hinfo->maxbps = mout->spdif_maxbps;
3657 			} else {
3658 				mout->share_spdif = 0;
3659 				/* FIXME: need notify? */
3660 			}
3661 		}
3662 		mutex_unlock(&codec->spdif_mutex);
3663 	}
3664 	return snd_pcm_hw_constraint_step(substream->runtime, 0,
3665 					  SNDRV_PCM_HW_PARAM_CHANNELS, 2);
3666 }
3667 EXPORT_SYMBOL_GPL(snd_hda_multi_out_analog_open);
3668 
3669 /**
3670  * snd_hda_multi_out_analog_prepare - Preapre the analog outputs.
3671  * @codec: the HDA codec
3672  * @mout: hda_multi_out object
3673  * @stream_tag: stream tag to assign
3674  * @format: format id to assign
3675  * @substream: PCM substream to assign
3676  *
3677  * Set up the i/o for analog out.
3678  * When the digital out is available, copy the front out to digital out, too.
3679  */
3680 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
3681 				     struct hda_multi_out *mout,
3682 				     unsigned int stream_tag,
3683 				     unsigned int format,
3684 				     struct snd_pcm_substream *substream)
3685 {
3686 	const hda_nid_t *nids = mout->dac_nids;
3687 	int chs = substream->runtime->channels;
3688 	struct hda_spdif_out *spdif;
3689 	int i;
3690 
3691 	mutex_lock(&codec->spdif_mutex);
3692 	spdif = snd_hda_spdif_out_of_nid(codec, mout->dig_out_nid);
3693 	if (mout->dig_out_nid && mout->share_spdif &&
3694 	    mout->dig_out_used != HDA_DIG_EXCLUSIVE) {
3695 		if (chs == 2 && spdif != NULL &&
3696 		    snd_hda_is_supported_format(codec, mout->dig_out_nid,
3697 						format) &&
3698 		    !(spdif->status & IEC958_AES0_NONAUDIO)) {
3699 			mout->dig_out_used = HDA_DIG_ANALOG_DUP;
3700 			setup_dig_out_stream(codec, mout->dig_out_nid,
3701 					     stream_tag, format);
3702 		} else {
3703 			mout->dig_out_used = 0;
3704 			cleanup_dig_out_stream(codec, mout->dig_out_nid);
3705 		}
3706 	}
3707 	mutex_unlock(&codec->spdif_mutex);
3708 
3709 	/* front */
3710 	snd_hda_codec_setup_stream(codec, nids[HDA_FRONT], stream_tag,
3711 				   0, format);
3712 	if (!mout->no_share_stream &&
3713 	    mout->hp_nid && mout->hp_nid != nids[HDA_FRONT])
3714 		/* headphone out will just decode front left/right (stereo) */
3715 		snd_hda_codec_setup_stream(codec, mout->hp_nid, stream_tag,
3716 					   0, format);
3717 	/* extra outputs copied from front */
3718 	for (i = 0; i < ARRAY_SIZE(mout->hp_out_nid); i++)
3719 		if (!mout->no_share_stream && mout->hp_out_nid[i])
3720 			snd_hda_codec_setup_stream(codec,
3721 						   mout->hp_out_nid[i],
3722 						   stream_tag, 0, format);
3723 
3724 	/* surrounds */
3725 	for (i = 1; i < mout->num_dacs; i++) {
3726 		if (chs >= (i + 1) * 2) /* independent out */
3727 			snd_hda_codec_setup_stream(codec, nids[i], stream_tag,
3728 						   i * 2, format);
3729 		else if (!mout->no_share_stream) /* copy front */
3730 			snd_hda_codec_setup_stream(codec, nids[i], stream_tag,
3731 						   0, format);
3732 	}
3733 
3734 	/* extra surrounds */
3735 	for (i = 0; i < ARRAY_SIZE(mout->extra_out_nid); i++) {
3736 		int ch = 0;
3737 		if (!mout->extra_out_nid[i])
3738 			break;
3739 		if (chs >= (i + 1) * 2)
3740 			ch = i * 2;
3741 		else if (!mout->no_share_stream)
3742 			break;
3743 		snd_hda_codec_setup_stream(codec, mout->extra_out_nid[i],
3744 					   stream_tag, ch, format);
3745 	}
3746 
3747 	return 0;
3748 }
3749 EXPORT_SYMBOL_GPL(snd_hda_multi_out_analog_prepare);
3750 
3751 /**
3752  * snd_hda_multi_out_analog_cleanup - clean up the setting for analog out
3753  * @codec: the HDA codec
3754  * @mout: hda_multi_out object
3755  */
3756 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
3757 				     struct hda_multi_out *mout)
3758 {
3759 	const hda_nid_t *nids = mout->dac_nids;
3760 	int i;
3761 
3762 	for (i = 0; i < mout->num_dacs; i++)
3763 		snd_hda_codec_cleanup_stream(codec, nids[i]);
3764 	if (mout->hp_nid)
3765 		snd_hda_codec_cleanup_stream(codec, mout->hp_nid);
3766 	for (i = 0; i < ARRAY_SIZE(mout->hp_out_nid); i++)
3767 		if (mout->hp_out_nid[i])
3768 			snd_hda_codec_cleanup_stream(codec,
3769 						     mout->hp_out_nid[i]);
3770 	for (i = 0; i < ARRAY_SIZE(mout->extra_out_nid); i++)
3771 		if (mout->extra_out_nid[i])
3772 			snd_hda_codec_cleanup_stream(codec,
3773 						     mout->extra_out_nid[i]);
3774 	mutex_lock(&codec->spdif_mutex);
3775 	if (mout->dig_out_nid && mout->dig_out_used == HDA_DIG_ANALOG_DUP) {
3776 		cleanup_dig_out_stream(codec, mout->dig_out_nid);
3777 		mout->dig_out_used = 0;
3778 	}
3779 	mutex_unlock(&codec->spdif_mutex);
3780 	return 0;
3781 }
3782 EXPORT_SYMBOL_GPL(snd_hda_multi_out_analog_cleanup);
3783 
3784 /**
3785  * snd_hda_get_default_vref - Get the default (mic) VREF pin bits
3786  * @codec: the HDA codec
3787  * @pin: referred pin NID
3788  *
3789  * Guess the suitable VREF pin bits to be set as the pin-control value.
3790  * Note: the function doesn't set the AC_PINCTL_IN_EN bit.
3791  */
3792 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin)
3793 {
3794 	unsigned int pincap;
3795 	unsigned int oldval;
3796 	oldval = snd_hda_codec_read(codec, pin, 0,
3797 				    AC_VERB_GET_PIN_WIDGET_CONTROL, 0);
3798 	pincap = snd_hda_query_pin_caps(codec, pin);
3799 	pincap = (pincap & AC_PINCAP_VREF) >> AC_PINCAP_VREF_SHIFT;
3800 	/* Exception: if the default pin setup is vref50, we give it priority */
3801 	if ((pincap & AC_PINCAP_VREF_80) && oldval != PIN_VREF50)
3802 		return AC_PINCTL_VREF_80;
3803 	else if (pincap & AC_PINCAP_VREF_50)
3804 		return AC_PINCTL_VREF_50;
3805 	else if (pincap & AC_PINCAP_VREF_100)
3806 		return AC_PINCTL_VREF_100;
3807 	else if (pincap & AC_PINCAP_VREF_GRD)
3808 		return AC_PINCTL_VREF_GRD;
3809 	return AC_PINCTL_VREF_HIZ;
3810 }
3811 EXPORT_SYMBOL_GPL(snd_hda_get_default_vref);
3812 
3813 /**
3814  * snd_hda_correct_pin_ctl - correct the pin ctl value for matching with the pin cap
3815  * @codec: the HDA codec
3816  * @pin: referred pin NID
3817  * @val: pin ctl value to audit
3818  */
3819 unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
3820 				     hda_nid_t pin, unsigned int val)
3821 {
3822 	static unsigned int cap_lists[][2] = {
3823 		{ AC_PINCTL_VREF_100, AC_PINCAP_VREF_100 },
3824 		{ AC_PINCTL_VREF_80, AC_PINCAP_VREF_80 },
3825 		{ AC_PINCTL_VREF_50, AC_PINCAP_VREF_50 },
3826 		{ AC_PINCTL_VREF_GRD, AC_PINCAP_VREF_GRD },
3827 	};
3828 	unsigned int cap;
3829 
3830 	if (!val)
3831 		return 0;
3832 	cap = snd_hda_query_pin_caps(codec, pin);
3833 	if (!cap)
3834 		return val; /* don't know what to do... */
3835 
3836 	if (val & AC_PINCTL_OUT_EN) {
3837 		if (!(cap & AC_PINCAP_OUT))
3838 			val &= ~(AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN);
3839 		else if ((val & AC_PINCTL_HP_EN) && !(cap & AC_PINCAP_HP_DRV))
3840 			val &= ~AC_PINCTL_HP_EN;
3841 	}
3842 
3843 	if (val & AC_PINCTL_IN_EN) {
3844 		if (!(cap & AC_PINCAP_IN))
3845 			val &= ~(AC_PINCTL_IN_EN | AC_PINCTL_VREFEN);
3846 		else {
3847 			unsigned int vcap, vref;
3848 			int i;
3849 			vcap = (cap & AC_PINCAP_VREF) >> AC_PINCAP_VREF_SHIFT;
3850 			vref = val & AC_PINCTL_VREFEN;
3851 			for (i = 0; i < ARRAY_SIZE(cap_lists); i++) {
3852 				if (vref == cap_lists[i][0] &&
3853 				    !(vcap & cap_lists[i][1])) {
3854 					if (i == ARRAY_SIZE(cap_lists) - 1)
3855 						vref = AC_PINCTL_VREF_HIZ;
3856 					else
3857 						vref = cap_lists[i + 1][0];
3858 				}
3859 			}
3860 			val &= ~AC_PINCTL_VREFEN;
3861 			val |= vref;
3862 		}
3863 	}
3864 
3865 	return val;
3866 }
3867 EXPORT_SYMBOL_GPL(snd_hda_correct_pin_ctl);
3868 
3869 /**
3870  * _snd_hda_pin_ctl - Helper to set pin ctl value
3871  * @codec: the HDA codec
3872  * @pin: referred pin NID
3873  * @val: pin control value to set
3874  * @cached: access over codec pinctl cache or direct write
3875  *
3876  * This function is a helper to set a pin ctl value more safely.
3877  * It corrects the pin ctl value via snd_hda_correct_pin_ctl(), stores the
3878  * value in pin target array via snd_hda_codec_set_pin_target(), then
3879  * actually writes the value via either snd_hda_codec_write_cache() or
3880  * snd_hda_codec_write() depending on @cached flag.
3881  */
3882 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
3883 			 unsigned int val, bool cached)
3884 {
3885 	val = snd_hda_correct_pin_ctl(codec, pin, val);
3886 	snd_hda_codec_set_pin_target(codec, pin, val);
3887 	if (cached)
3888 		return snd_hda_codec_write_cache(codec, pin, 0,
3889 				AC_VERB_SET_PIN_WIDGET_CONTROL, val);
3890 	else
3891 		return snd_hda_codec_write(codec, pin, 0,
3892 					   AC_VERB_SET_PIN_WIDGET_CONTROL, val);
3893 }
3894 EXPORT_SYMBOL_GPL(_snd_hda_set_pin_ctl);
3895 
3896 /**
3897  * snd_hda_add_imux_item - Add an item to input_mux
3898  * @codec: the HDA codec
3899  * @imux: imux helper object
3900  * @label: the name of imux item to assign
3901  * @index: index number of imux item to assign
3902  * @type_idx: pointer to store the resultant label index
3903  *
3904  * When the same label is used already in the existing items, the number
3905  * suffix is appended to the label.  This label index number is stored
3906  * to type_idx when non-NULL pointer is given.
3907  */
3908 int snd_hda_add_imux_item(struct hda_codec *codec,
3909 			  struct hda_input_mux *imux, const char *label,
3910 			  int index, int *type_idx)
3911 {
3912 	int i, label_idx = 0;
3913 	if (imux->num_items >= HDA_MAX_NUM_INPUTS) {
3914 		codec_err(codec, "hda_codec: Too many imux items!\n");
3915 		return -EINVAL;
3916 	}
3917 	for (i = 0; i < imux->num_items; i++) {
3918 		if (!strncmp(label, imux->items[i].label, strlen(label)))
3919 			label_idx++;
3920 	}
3921 	if (type_idx)
3922 		*type_idx = label_idx;
3923 	if (label_idx > 0)
3924 		snprintf(imux->items[imux->num_items].label,
3925 			 sizeof(imux->items[imux->num_items].label),
3926 			 "%s %d", label, label_idx);
3927 	else
3928 		strlcpy(imux->items[imux->num_items].label, label,
3929 			sizeof(imux->items[imux->num_items].label));
3930 	imux->items[imux->num_items].index = index;
3931 	imux->num_items++;
3932 	return 0;
3933 }
3934 EXPORT_SYMBOL_GPL(snd_hda_add_imux_item);
3935 
3936 /**
3937  * snd_hda_bus_reset_codecs - Reset the bus
3938  * @bus: HD-audio bus
3939  */
3940 void snd_hda_bus_reset_codecs(struct hda_bus *bus)
3941 {
3942 	struct hda_codec *codec;
3943 
3944 	list_for_each_codec(codec, bus) {
3945 		/* FIXME: maybe a better way needed for forced reset */
3946 		if (current_work() != &codec->jackpoll_work.work)
3947 			cancel_delayed_work_sync(&codec->jackpoll_work);
3948 #ifdef CONFIG_PM
3949 		if (hda_codec_is_power_on(codec)) {
3950 			hda_call_codec_suspend(codec);
3951 			hda_call_codec_resume(codec);
3952 		}
3953 #endif
3954 	}
3955 }
3956 
3957 /**
3958  * snd_print_pcm_bits - Print the supported PCM fmt bits to the string buffer
3959  * @pcm: PCM caps bits
3960  * @buf: the string buffer to write
3961  * @buflen: the max buffer length
3962  *
3963  * used by hda_proc.c and hda_eld.c
3964  */
3965 void snd_print_pcm_bits(int pcm, char *buf, int buflen)
3966 {
3967 	static unsigned int bits[] = { 8, 16, 20, 24, 32 };
3968 	int i, j;
3969 
3970 	for (i = 0, j = 0; i < ARRAY_SIZE(bits); i++)
3971 		if (pcm & (AC_SUPPCM_BITS_8 << i))
3972 			j += snprintf(buf + j, buflen - j,  " %d", bits[i]);
3973 
3974 	buf[j] = '\0'; /* necessary when j == 0 */
3975 }
3976 EXPORT_SYMBOL_GPL(snd_print_pcm_bits);
3977 
3978 MODULE_DESCRIPTION("HDA codec core");
3979 MODULE_LICENSE("GPL");
3980