~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/sound/pci/hda/hda_codec.c

Version: ~ [ linux-5.15-rc5 ] ~ [ linux-5.14.11 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.72 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.152 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.210 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.250 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.286 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.288 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp