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