ALSA: hda - Define AC_FMT_* constants

[deliverable/linux.git] / sound / pci / hda / hda_codec.c

/*
 * Universal Interface for Intel High Definition Audio Codec
 *
 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
 *
 *
 *  This driver is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This driver is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

#include <linux/init.h>
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/pci.h>
#include <linux/mutex.h>
#include <sound/core.h>
#include "hda_codec.h"
#include <sound/asoundef.h>
#include <sound/tlv.h>
#include <sound/initval.h>
#include "hda_local.h"
#include "hda_beep.h"
#include <sound/hda_hwdep.h>

/*
 * vendor / preset table
 */

struct hda_vendor_id {
        unsigned int id;
        const char *name;
};

/* codec vendor labels */
static struct hda_vendor_id hda_vendor_ids[] = {
        { 0x1002, "ATI" },
        { 0x1013, "Cirrus Logic" },
        { 0x1057, "Motorola" },
        { 0x1095, "Silicon Image" },
        { 0x10de, "Nvidia" },
        { 0x10ec, "Realtek" },
        { 0x1102, "Creative" },
        { 0x1106, "VIA" },
        { 0x111d, "IDT" },
        { 0x11c1, "LSI" },
        { 0x11d4, "Analog Devices" },
        { 0x13f6, "C-Media" },
        { 0x14f1, "Conexant" },
        { 0x17e8, "Chrontel" },
        { 0x1854, "LG" },
        { 0x1aec, "Wolfson Microelectronics" },
        { 0x434d, "C-Media" },
        { 0x8086, "Intel" },
        { 0x8384, "SigmaTel" },
        {} /* terminator */
};

static DEFINE_MUTEX(preset_mutex);
static LIST_HEAD(hda_preset_tables);

int snd_hda_add_codec_preset(struct hda_codec_preset_list *preset)
{
        mutex_lock(&preset_mutex);
        list_add_tail(&preset->list, &hda_preset_tables);
        mutex_unlock(&preset_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_add_codec_preset);

int snd_hda_delete_codec_preset(struct hda_codec_preset_list *preset)
{
        mutex_lock(&preset_mutex);
        list_del(&preset->list);
        mutex_unlock(&preset_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_delete_codec_preset);

#ifdef CONFIG_SND_HDA_POWER_SAVE
static void hda_power_work(struct work_struct *work);
static void hda_keep_power_on(struct hda_codec *codec);
#else
static inline void hda_keep_power_on(struct hda_codec *codec) {}
#endif

/**
 * snd_hda_get_jack_location - Give a location string of the jack
 * @cfg: pin default config value
 *
 * Parse the pin default config value and returns the string of the
 * jack location, e.g. "Rear", "Front", etc.
 */
const char *snd_hda_get_jack_location(u32 cfg)
{
        static char *bases[7] = {
                "N/A", "Rear", "Front", "Left", "Right", "Top", "Bottom",
        };
        static unsigned char specials_idx[] = {
                0x07, 0x08,
                0x17, 0x18, 0x19,
                0x37, 0x38
        };
        static char *specials[] = {
                "Rear Panel", "Drive Bar",
                "Riser", "HDMI", "ATAPI",
                "Mobile-In", "Mobile-Out"
        };
        int i;
        cfg = (cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT;
        if ((cfg & 0x0f) < 7)
                return bases[cfg & 0x0f];
        for (i = 0; i < ARRAY_SIZE(specials_idx); i++) {
                if (cfg == specials_idx[i])
                        return specials[i];
        }
        return "UNKNOWN";
}
EXPORT_SYMBOL_HDA(snd_hda_get_jack_location);

/**
 * snd_hda_get_jack_connectivity - Give a connectivity string of the jack
 * @cfg: pin default config value
 *
 * Parse the pin default config value and returns the string of the
 * jack connectivity, i.e. external or internal connection.
 */
const char *snd_hda_get_jack_connectivity(u32 cfg)
{
        static char *jack_locations[4] = { "Ext", "Int", "Sep", "Oth" };

        return jack_locations[(cfg >> (AC_DEFCFG_LOCATION_SHIFT + 4)) & 3];
}
EXPORT_SYMBOL_HDA(snd_hda_get_jack_connectivity);

/**
 * snd_hda_get_jack_type - Give a type string of the jack
 * @cfg: pin default config value
 *
 * Parse the pin default config value and returns the string of the
 * jack type, i.e. the purpose of the jack, such as Line-Out or CD.
 */
const char *snd_hda_get_jack_type(u32 cfg)
{
        static char *jack_types[16] = {
                "Line Out", "Speaker", "HP Out", "CD",
                "SPDIF Out", "Digital Out", "Modem Line", "Modem Hand",
                "Line In", "Aux", "Mic", "Telephony",
                "SPDIF In", "Digitial In", "Reserved", "Other"
        };

        return jack_types[(cfg & AC_DEFCFG_DEVICE)
                                >> AC_DEFCFG_DEVICE_SHIFT];
}
EXPORT_SYMBOL_HDA(snd_hda_get_jack_type);

/*
 * Compose a 32bit command word to be sent to the HD-audio controller
 */
static inline unsigned int
make_codec_cmd(struct hda_codec *codec, hda_nid_t nid, int direct,
               unsigned int verb, unsigned int parm)
{
        u32 val;

        if ((codec->addr & ~0xf) || (direct & ~1) || (nid & ~0x7f) ||
            (verb & ~0xfff) || (parm & ~0xffff)) {
                printk(KERN_ERR "hda-codec: out of range cmd %x:%x:%x:%x:%x\n",
                       codec->addr, direct, nid, verb, parm);
                return ~0;
        }

        val = (u32)codec->addr << 28;
        val |= (u32)direct << 27;
        val |= (u32)nid << 20;
        val |= verb << 8;
        val |= parm;
        return val;
}

/*
 * Send and receive a verb
 */
static int codec_exec_verb(struct hda_codec *codec, unsigned int cmd,
                           unsigned int *res)
{
        struct hda_bus *bus = codec->bus;
        int err;

        if (cmd == ~0)
                return -1;

        if (res)
                *res = -1;
 again:
        snd_hda_power_up(codec);
        mutex_lock(&bus->cmd_mutex);
        err = bus->ops.command(bus, cmd);
        if (!err && res)
                *res = bus->ops.get_response(bus, codec->addr);
        mutex_unlock(&bus->cmd_mutex);
        snd_hda_power_down(codec);
        if (res && *res == -1 && bus->rirb_error) {
                if (bus->response_reset) {
                        snd_printd("hda_codec: resetting BUS due to "
                                   "fatal communication error\n");
                        bus->ops.bus_reset(bus);
                }
                goto again;
        }
        /* clear reset-flag when the communication gets recovered */
        if (!err)
                bus->response_reset = 0;
        return err;
}

/**
 * snd_hda_codec_read - send a command and get the response
 * @codec: the HDA codec
 * @nid: NID to send the command
 * @direct: direct flag
 * @verb: the verb to send
 * @parm: the parameter for the verb
 *
 * Send a single command and read the corresponding response.
 *
 * Returns the obtained response value, or -1 for an error.
 */
unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
                                int direct,
                                unsigned int verb, unsigned int parm)
{
        unsigned cmd = make_codec_cmd(codec, nid, direct, verb, parm);
        unsigned int res;
        codec_exec_verb(codec, cmd, &res);
        return res;
}
EXPORT_SYMBOL_HDA(snd_hda_codec_read);

/**
 * snd_hda_codec_write - send a single command without waiting for response
 * @codec: the HDA codec
 * @nid: NID to send the command
 * @direct: direct flag
 * @verb: the verb to send
 * @parm: the parameter for the verb
 *
 * Send a single command without waiting for response.
 *
 * Returns 0 if successful, or a negative error code.
 */
int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
                         unsigned int verb, unsigned int parm)
{
        unsigned int cmd = make_codec_cmd(codec, nid, direct, verb, parm);
        unsigned int res;
        return codec_exec_verb(codec, cmd,
                               codec->bus->sync_write ? &res : NULL);
}
EXPORT_SYMBOL_HDA(snd_hda_codec_write);

/**
 * snd_hda_sequence_write - sequence writes
 * @codec: the HDA codec
 * @seq: VERB array to send
 *
 * Send the commands sequentially from the given array.
 * The array must be terminated with NID=0.
 */
void snd_hda_sequence_write(struct hda_codec *codec, const struct hda_verb *seq)
{
        for (; seq->nid; seq++)
                snd_hda_codec_write(codec, seq->nid, 0, seq->verb, seq->param);
}
EXPORT_SYMBOL_HDA(snd_hda_sequence_write);

/**
 * snd_hda_get_sub_nodes - get the range of sub nodes
 * @codec: the HDA codec
 * @nid: NID to parse
 * @start_id: the pointer to store the start NID
 *
 * Parse the NID and store the start NID of its sub-nodes.
 * Returns the number of sub-nodes.
 */
int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
                          hda_nid_t *start_id)
{
        unsigned int parm;

        parm = snd_hda_param_read(codec, nid, AC_PAR_NODE_COUNT);
        if (parm == -1)
                return 0;
        *start_id = (parm >> 16) & 0x7fff;
        return (int)(parm & 0x7fff);
}
EXPORT_SYMBOL_HDA(snd_hda_get_sub_nodes);

/**
 * snd_hda_get_connections - get connection list
 * @codec: the HDA codec
 * @nid: NID to parse
 * @conn_list: connection list array
 * @max_conns: max. number of connections to store
 *
 * Parses the connection list of the given widget and stores the list
 * of NIDs.
 *
 * Returns the number of connections, or a negative error code.
 */
int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
                            hda_nid_t *conn_list, int max_conns)
{
        unsigned int parm;
        int i, conn_len, conns;
        unsigned int shift, num_elems, mask;
        unsigned int wcaps;
        hda_nid_t prev_nid;

        if (snd_BUG_ON(!conn_list || max_conns <= 0))
                return -EINVAL;

        wcaps = get_wcaps(codec, nid);
        if (!(wcaps & AC_WCAP_CONN_LIST) &&
            get_wcaps_type(wcaps) != AC_WID_VOL_KNB) {
                snd_printk(KERN_WARNING "hda_codec: "
                           "connection list not available for 0x%x\n", nid);
                return -EINVAL;
        }

        parm = snd_hda_param_read(codec, nid, AC_PAR_CONNLIST_LEN);
        if (parm & AC_CLIST_LONG) {
                /* long form */
                shift = 16;
                num_elems = 2;
        } else {
                /* short form */
                shift = 8;
                num_elems = 4;
        }
        conn_len = parm & AC_CLIST_LENGTH;
        mask = (1 << (shift-1)) - 1;

        if (!conn_len)
                return 0; /* no connection */

        if (conn_len == 1) {
                /* single connection */
                parm = snd_hda_codec_read(codec, nid, 0,
                                          AC_VERB_GET_CONNECT_LIST, 0);
                if (parm == -1 && codec->bus->rirb_error)
                        return -EIO;
                conn_list[0] = parm & mask;
                return 1;
        }

        /* multi connection */
        conns = 0;
        prev_nid = 0;
        for (i = 0; i < conn_len; i++) {
                int range_val;
                hda_nid_t val, n;

                if (i % num_elems == 0) {
                        parm = snd_hda_codec_read(codec, nid, 0,
                                                  AC_VERB_GET_CONNECT_LIST, i);
                        if (parm == -1 && codec->bus->rirb_error)
                                return -EIO;
                }
                range_val = !!(parm & (1 << (shift-1))); /* ranges */
                val = parm & mask;
                if (val == 0) {
                        snd_printk(KERN_WARNING "hda_codec: "
                                   "invalid CONNECT_LIST verb %x[%i]:%x\n",
                                    nid, i, parm);
                        return 0;
                }
                parm >>= shift;
                if (range_val) {
                        /* ranges between the previous and this one */
                        if (!prev_nid || prev_nid >= val) {
                                snd_printk(KERN_WARNING "hda_codec: "
                                           "invalid dep_range_val %x:%x\n",
                                           prev_nid, val);
                                continue;
                        }
                        for (n = prev_nid + 1; n <= val; n++) {
                                if (conns >= max_conns) {
                                        snd_printk(KERN_ERR "hda_codec: "
                                                   "Too many connections %d for NID 0x%x\n",
                                                   conns, nid);
                                        return -EINVAL;
                                }
                                conn_list[conns++] = n;
                        }
                } else {
                        if (conns >= max_conns) {
                                snd_printk(KERN_ERR "hda_codec: "
                                           "Too many connections %d for NID 0x%x\n",
                                           conns, nid);
                                return -EINVAL;
                        }
                        conn_list[conns++] = val;
                }
                prev_nid = val;
        }
        return conns;
}
EXPORT_SYMBOL_HDA(snd_hda_get_connections);


/**
 * snd_hda_queue_unsol_event - add an unsolicited event to queue
 * @bus: the BUS
 * @res: unsolicited event (lower 32bit of RIRB entry)
 * @res_ex: codec addr and flags (upper 32bit or RIRB entry)
 *
 * Adds the given event to the queue.  The events are processed in
 * the workqueue asynchronously.  Call this function in the interrupt
 * hanlder when RIRB receives an unsolicited event.
 *
 * Returns 0 if successful, or a negative error code.
 */
int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex)
{
        struct hda_bus_unsolicited *unsol;
        unsigned int wp;

        unsol = bus->unsol;
        if (!unsol)
                return 0;

        wp = (unsol->wp + 1) % HDA_UNSOL_QUEUE_SIZE;
        unsol->wp = wp;

        wp <<= 1;
        unsol->queue[wp] = res;
        unsol->queue[wp + 1] = res_ex;

        queue_work(bus->workq, &unsol->work);

        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_queue_unsol_event);

/*
 * process queued unsolicited events
 */
static void process_unsol_events(struct work_struct *work)
{
        struct hda_bus_unsolicited *unsol =
                container_of(work, struct hda_bus_unsolicited, work);
        struct hda_bus *bus = unsol->bus;
        struct hda_codec *codec;
        unsigned int rp, caddr, res;

        while (unsol->rp != unsol->wp) {
                rp = (unsol->rp + 1) % HDA_UNSOL_QUEUE_SIZE;
                unsol->rp = rp;
                rp <<= 1;
                res = unsol->queue[rp];
                caddr = unsol->queue[rp + 1];
                if (!(caddr & (1 << 4))) /* no unsolicited event? */
                        continue;
                codec = bus->caddr_tbl[caddr & 0x0f];
                if (codec && codec->patch_ops.unsol_event)
                        codec->patch_ops.unsol_event(codec, res);
        }
}

/*
 * initialize unsolicited queue
 */
static int init_unsol_queue(struct hda_bus *bus)
{
        struct hda_bus_unsolicited *unsol;

        if (bus->unsol) /* already initialized */
                return 0;

        unsol = kzalloc(sizeof(*unsol), GFP_KERNEL);
        if (!unsol) {
                snd_printk(KERN_ERR "hda_codec: "
                           "can't allocate unsolicited queue\n");
                return -ENOMEM;
        }
        INIT_WORK(&unsol->work, process_unsol_events);
        unsol->bus = bus;
        bus->unsol = unsol;
        return 0;
}

/*
 * destructor
 */
static void snd_hda_codec_free(struct hda_codec *codec);

static int snd_hda_bus_free(struct hda_bus *bus)
{
        struct hda_codec *codec, *n;

        if (!bus)
                return 0;
        if (bus->workq)
                flush_workqueue(bus->workq);
        if (bus->unsol)
                kfree(bus->unsol);
        list_for_each_entry_safe(codec, n, &bus->codec_list, list) {
                snd_hda_codec_free(codec);
        }
        if (bus->ops.private_free)
                bus->ops.private_free(bus);
        if (bus->workq)
                destroy_workqueue(bus->workq);
        kfree(bus);
        return 0;
}

static int snd_hda_bus_dev_free(struct snd_device *device)
{
        struct hda_bus *bus = device->device_data;
        bus->shutdown = 1;
        return snd_hda_bus_free(bus);
}

#ifdef CONFIG_SND_HDA_HWDEP
static int snd_hda_bus_dev_register(struct snd_device *device)
{
        struct hda_bus *bus = device->device_data;
        struct hda_codec *codec;
        list_for_each_entry(codec, &bus->codec_list, list) {
                snd_hda_hwdep_add_sysfs(codec);
                snd_hda_hwdep_add_power_sysfs(codec);
        }
        return 0;
}
#else
#define snd_hda_bus_dev_register        NULL
#endif

/**
 * snd_hda_bus_new - create a HDA bus
 * @card: the card entry
 * @temp: the template for hda_bus information
 * @busp: the pointer to store the created bus instance
 *
 * Returns 0 if successful, or a negative error code.
 */
int /*__devinit*/ snd_hda_bus_new(struct snd_card *card,
                              const struct hda_bus_template *temp,
                              struct hda_bus **busp)
{
        struct hda_bus *bus;
        int err;
        static struct snd_device_ops dev_ops = {
                .dev_register = snd_hda_bus_dev_register,
                .dev_free = snd_hda_bus_dev_free,
        };

        if (snd_BUG_ON(!temp))
                return -EINVAL;
        if (snd_BUG_ON(!temp->ops.command || !temp->ops.get_response))
                return -EINVAL;

        if (busp)
                *busp = NULL;

        bus = kzalloc(sizeof(*bus), GFP_KERNEL);
        if (bus == NULL) {
                snd_printk(KERN_ERR "can't allocate struct hda_bus\n");
                return -ENOMEM;
        }

        bus->card = card;
        bus->private_data = temp->private_data;
        bus->pci = temp->pci;
        bus->modelname = temp->modelname;
        bus->power_save = temp->power_save;
        bus->ops = temp->ops;

        mutex_init(&bus->cmd_mutex);
        INIT_LIST_HEAD(&bus->codec_list);

        snprintf(bus->workq_name, sizeof(bus->workq_name),
                 "hd-audio%d", card->number);
        bus->workq = create_singlethread_workqueue(bus->workq_name);
        if (!bus->workq) {
                snd_printk(KERN_ERR "cannot create workqueue %s\n",
                           bus->workq_name);
                kfree(bus);
                return -ENOMEM;
        }

        err = snd_device_new(card, SNDRV_DEV_BUS, bus, &dev_ops);
        if (err < 0) {
                snd_hda_bus_free(bus);
                return err;
        }
        if (busp)
                *busp = bus;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_bus_new);

#ifdef CONFIG_SND_HDA_GENERIC
#define is_generic_config(codec) \
        (codec->modelname && !strcmp(codec->modelname, "generic"))
#else
#define is_generic_config(codec)        0
#endif

#ifdef MODULE
#define HDA_MODREQ_MAX_COUNT    2       /* two request_modules()'s */
#else
#define HDA_MODREQ_MAX_COUNT    0       /* all presets are statically linked */
#endif

/*
 * find a matching codec preset
 */
static const struct hda_codec_preset *
find_codec_preset(struct hda_codec *codec)
{
        struct hda_codec_preset_list *tbl;
        const struct hda_codec_preset *preset;
        int mod_requested = 0;

        if (is_generic_config(codec))
                return NULL; /* use the generic parser */

 again:
        mutex_lock(&preset_mutex);
        list_for_each_entry(tbl, &hda_preset_tables, list) {
                if (!try_module_get(tbl->owner)) {
                        snd_printk(KERN_ERR "hda_codec: cannot module_get\n");
                        continue;
                }
                for (preset = tbl->preset; preset->id; preset++) {
                        u32 mask = preset->mask;
                        if (preset->afg && preset->afg != codec->afg)
                                continue;
                        if (preset->mfg && preset->mfg != codec->mfg)
                                continue;
                        if (!mask)
                                mask = ~0;
                        if (preset->id == (codec->vendor_id & mask) &&
                            (!preset->rev ||
                             preset->rev == codec->revision_id)) {
                                mutex_unlock(&preset_mutex);
                                codec->owner = tbl->owner;
                                return preset;
                        }
                }
                module_put(tbl->owner);
        }
        mutex_unlock(&preset_mutex);

        if (mod_requested < HDA_MODREQ_MAX_COUNT) {
                char name[32];
                if (!mod_requested)
                        snprintf(name, sizeof(name), "snd-hda-codec-id:%08x",
                                 codec->vendor_id);
                else
                        snprintf(name, sizeof(name), "snd-hda-codec-id:%04x*",
                                 (codec->vendor_id >> 16) & 0xffff);
                request_module(name);
                mod_requested++;
                goto again;
        }
        return NULL;
}

/*
 * get_codec_name - store the codec name
 */
static int get_codec_name(struct hda_codec *codec)
{
        const struct hda_vendor_id *c;
        const char *vendor = NULL;
        u16 vendor_id = codec->vendor_id >> 16;
        char tmp[16];

        if (codec->vendor_name)
                goto get_chip_name;

        for (c = hda_vendor_ids; c->id; c++) {
                if (c->id == vendor_id) {
                        vendor = c->name;
                        break;
                }
        }
        if (!vendor) {
                sprintf(tmp, "Generic %04x", vendor_id);
                vendor = tmp;
        }
        codec->vendor_name = kstrdup(vendor, GFP_KERNEL);
        if (!codec->vendor_name)
                return -ENOMEM;

 get_chip_name:
        if (codec->chip_name)
                return 0;

        if (codec->preset && codec->preset->name)
                codec->chip_name = kstrdup(codec->preset->name, GFP_KERNEL);
        else {
                sprintf(tmp, "ID %x", codec->vendor_id & 0xffff);
                codec->chip_name = kstrdup(tmp, GFP_KERNEL);
        }
        if (!codec->chip_name)
                return -ENOMEM;
        return 0;
}

/*
 * look for an AFG and MFG nodes
 */
static void /*__devinit*/ setup_fg_nodes(struct hda_codec *codec)
{
        int i, total_nodes, function_id;
        hda_nid_t nid;

        total_nodes = snd_hda_get_sub_nodes(codec, AC_NODE_ROOT, &nid);
        for (i = 0; i < total_nodes; i++, nid++) {
                function_id = snd_hda_param_read(codec, nid,
                                                AC_PAR_FUNCTION_TYPE) & 0xff;
                switch (function_id) {
                case AC_GRP_AUDIO_FUNCTION:
                        codec->afg = nid;
                        codec->function_id = function_id;
                        break;
                case AC_GRP_MODEM_FUNCTION:
                        codec->mfg = nid;
                        codec->function_id = function_id;
                        break;
                default:
                        break;
                }
        }
}

/*
 * read widget caps for each widget and store in cache
 */
static int read_widget_caps(struct hda_codec *codec, hda_nid_t fg_node)
{
        int i;
        hda_nid_t nid;

        codec->num_nodes = snd_hda_get_sub_nodes(codec, fg_node,
                                                 &codec->start_nid);
        codec->wcaps = kmalloc(codec->num_nodes * 4, GFP_KERNEL);
        if (!codec->wcaps)
                return -ENOMEM;
        nid = codec->start_nid;
        for (i = 0; i < codec->num_nodes; i++, nid++)
                codec->wcaps[i] = snd_hda_param_read(codec, nid,
                                                     AC_PAR_AUDIO_WIDGET_CAP);
        return 0;
}

/* read all pin default configurations and save codec->init_pins */
static int read_pin_defaults(struct hda_codec *codec)
{
        int i;
        hda_nid_t nid = codec->start_nid;

        for (i = 0; i < codec->num_nodes; i++, nid++) {
                struct hda_pincfg *pin;
                unsigned int wcaps = get_wcaps(codec, nid);
                unsigned int wid_type = get_wcaps_type(wcaps);
                if (wid_type != AC_WID_PIN)
                        continue;
                pin = snd_array_new(&codec->init_pins);
                if (!pin)
                        return -ENOMEM;
                pin->nid = nid;
                pin->cfg = snd_hda_codec_read(codec, nid, 0,
                                              AC_VERB_GET_CONFIG_DEFAULT, 0);
                pin->ctrl = snd_hda_codec_read(codec, nid, 0,
                                               AC_VERB_GET_PIN_WIDGET_CONTROL,
                                               0);
        }
        return 0;
}

/* look up the given pin config list and return the item matching with NID */
static struct hda_pincfg *look_up_pincfg(struct hda_codec *codec,
                                         struct snd_array *array,
                                         hda_nid_t nid)
{
        int i;
        for (i = 0; i < array->used; i++) {
                struct hda_pincfg *pin = snd_array_elem(array, i);
                if (pin->nid == nid)
                        return pin;
        }
        return NULL;
}

/* write a config value for the given NID */
static void set_pincfg(struct hda_codec *codec, hda_nid_t nid,
                       unsigned int cfg)
{
        int i;
        for (i = 0; i < 4; i++) {
                snd_hda_codec_write(codec, nid, 0,
                                    AC_VERB_SET_CONFIG_DEFAULT_BYTES_0 + i,
                                    cfg & 0xff);
                cfg >>= 8;
        }
}

/* set the current pin config value for the given NID.
 * the value is cached, and read via snd_hda_codec_get_pincfg()
 */
int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
                       hda_nid_t nid, unsigned int cfg)
{
        struct hda_pincfg *pin;
        unsigned int oldcfg;

        if (get_wcaps_type(get_wcaps(codec, nid)) != AC_WID_PIN)
                return -EINVAL;

        oldcfg = snd_hda_codec_get_pincfg(codec, nid);
        pin = look_up_pincfg(codec, list, nid);
        if (!pin) {
                pin = snd_array_new(list);
                if (!pin)
                        return -ENOMEM;
                pin->nid = nid;
        }
        pin->cfg = cfg;

        /* change only when needed; e.g. if the pincfg is already present
         * in user_pins[], don't write it
         */
        cfg = snd_hda_codec_get_pincfg(codec, nid);
        if (oldcfg != cfg)
                set_pincfg(codec, nid, cfg);
        return 0;
}

/**
 * snd_hda_codec_set_pincfg - Override a pin default configuration
 * @codec: the HDA codec
 * @nid: NID to set the pin config
 * @cfg: the pin default config value
 *
 * Override a pin default configuration value in the cache.
 * This value can be read by snd_hda_codec_get_pincfg() in a higher
 * priority than the real hardware value.
 */
int snd_hda_codec_set_pincfg(struct hda_codec *codec,
                             hda_nid_t nid, unsigned int cfg)
{
        return snd_hda_add_pincfg(codec, &codec->driver_pins, nid, cfg);
}
EXPORT_SYMBOL_HDA(snd_hda_codec_set_pincfg);

/**
 * snd_hda_codec_get_pincfg - Obtain a pin-default configuration
 * @codec: the HDA codec
 * @nid: NID to get the pin config
 *
 * Get the current pin config value of the given pin NID.
 * If the pincfg value is cached or overridden via sysfs or driver,
 * returns the cached value.
 */
unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid)
{
        struct hda_pincfg *pin;

#ifdef CONFIG_SND_HDA_HWDEP
        pin = look_up_pincfg(codec, &codec->user_pins, nid);
        if (pin)
                return pin->cfg;
#endif
        pin = look_up_pincfg(codec, &codec->driver_pins, nid);
        if (pin)
                return pin->cfg;
        pin = look_up_pincfg(codec, &codec->init_pins, nid);
        if (pin)
                return pin->cfg;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_codec_get_pincfg);

/* restore all current pin configs */
static void restore_pincfgs(struct hda_codec *codec)
{
        int i;
        for (i = 0; i < codec->init_pins.used; i++) {
                struct hda_pincfg *pin = snd_array_elem(&codec->init_pins, i);
                set_pincfg(codec, pin->nid,
                           snd_hda_codec_get_pincfg(codec, pin->nid));
        }
}

/**
 * snd_hda_shutup_pins - Shut up all pins
 * @codec: the HDA codec
 *
 * Clear all pin controls to shup up before suspend for avoiding click noise.
 * The controls aren't cached so that they can be resumed properly.
 */
void snd_hda_shutup_pins(struct hda_codec *codec)
{
        int i;
        /* don't shut up pins when unloading the driver; otherwise it breaks
         * the default pin setup at the next load of the driver
         */
        if (codec->bus->shutdown)
                return;
        for (i = 0; i < codec->init_pins.used; i++) {
                struct hda_pincfg *pin = snd_array_elem(&codec->init_pins, i);
                /* use read here for syncing after issuing each verb */
                snd_hda_codec_read(codec, pin->nid, 0,
                                   AC_VERB_SET_PIN_WIDGET_CONTROL, 0);
        }
        codec->pins_shutup = 1;
}
EXPORT_SYMBOL_HDA(snd_hda_shutup_pins);

/* Restore the pin controls cleared previously via snd_hda_shutup_pins() */
static void restore_shutup_pins(struct hda_codec *codec)
{
        int i;
        if (!codec->pins_shutup)
                return;
        if (codec->bus->shutdown)
                return;
        for (i = 0; i < codec->init_pins.used; i++) {
                struct hda_pincfg *pin = snd_array_elem(&codec->init_pins, i);
                snd_hda_codec_write(codec, pin->nid, 0,
                                    AC_VERB_SET_PIN_WIDGET_CONTROL,
                                    pin->ctrl);
        }
        codec->pins_shutup = 0;
}

static void init_hda_cache(struct hda_cache_rec *cache,
                           unsigned int record_size);
static void free_hda_cache(struct hda_cache_rec *cache);

/* restore the initial pin cfgs and release all pincfg lists */
static void restore_init_pincfgs(struct hda_codec *codec)
{
        /* first free driver_pins and user_pins, then call restore_pincfg
         * so that only the values in init_pins are restored
         */
        snd_array_free(&codec->driver_pins);
#ifdef CONFIG_SND_HDA_HWDEP
        snd_array_free(&codec->user_pins);
#endif
        restore_pincfgs(codec);
        snd_array_free(&codec->init_pins);
}

/*
 * codec destructor
 */
static void snd_hda_codec_free(struct hda_codec *codec)
{
        if (!codec)
                return;
        restore_init_pincfgs(codec);
#ifdef CONFIG_SND_HDA_POWER_SAVE
        cancel_delayed_work(&codec->power_work);
        flush_workqueue(codec->bus->workq);
#endif
        list_del(&codec->list);
        snd_array_free(&codec->mixers);
        snd_array_free(&codec->nids);
        codec->bus->caddr_tbl[codec->addr] = NULL;
        if (codec->patch_ops.free)
                codec->patch_ops.free(codec);
        module_put(codec->owner);
        free_hda_cache(&codec->amp_cache);
        free_hda_cache(&codec->cmd_cache);
        kfree(codec->vendor_name);
        kfree(codec->chip_name);
        kfree(codec->modelname);
        kfree(codec->wcaps);
        kfree(codec);
}

static void hda_set_power_state(struct hda_codec *codec, hda_nid_t fg,
                                unsigned int power_state);

/**
 * snd_hda_codec_new - create a HDA codec
 * @bus: the bus to assign
 * @codec_addr: the codec address
 * @codecp: the pointer to store the generated codec
 *
 * Returns 0 if successful, or a negative error code.
 */
int /*__devinit*/ snd_hda_codec_new(struct hda_bus *bus,
                                unsigned int codec_addr,
                                struct hda_codec **codecp)
{
        struct hda_codec *codec;
        char component[31];
        int err;

        if (snd_BUG_ON(!bus))
                return -EINVAL;
        if (snd_BUG_ON(codec_addr > HDA_MAX_CODEC_ADDRESS))
                return -EINVAL;

        if (bus->caddr_tbl[codec_addr]) {
                snd_printk(KERN_ERR "hda_codec: "
                           "address 0x%x is already occupied\n", codec_addr);
                return -EBUSY;
        }

        codec = kzalloc(sizeof(*codec), GFP_KERNEL);
        if (codec == NULL) {
                snd_printk(KERN_ERR "can't allocate struct hda_codec\n");
                return -ENOMEM;
        }

        codec->bus = bus;
        codec->addr = codec_addr;
        mutex_init(&codec->spdif_mutex);
        mutex_init(&codec->control_mutex);
        init_hda_cache(&codec->amp_cache, sizeof(struct hda_amp_info));
        init_hda_cache(&codec->cmd_cache, sizeof(struct hda_cache_head));
        snd_array_init(&codec->mixers, sizeof(struct hda_nid_item), 32);
        snd_array_init(&codec->nids, sizeof(struct hda_nid_item), 32);
        snd_array_init(&codec->init_pins, sizeof(struct hda_pincfg), 16);
        snd_array_init(&codec->driver_pins, sizeof(struct hda_pincfg), 16);
        if (codec->bus->modelname) {
                codec->modelname = kstrdup(codec->bus->modelname, GFP_KERNEL);
                if (!codec->modelname) {
                        snd_hda_codec_free(codec);
                        return -ENODEV;
                }
        }

#ifdef CONFIG_SND_HDA_POWER_SAVE
        INIT_DELAYED_WORK(&codec->power_work, hda_power_work);
        /* snd_hda_codec_new() marks the codec as power-up, and leave it as is.
         * the caller has to power down appropriatley after initialization
         * phase.
         */
        hda_keep_power_on(codec);
#endif

        list_add_tail(&codec->list, &bus->codec_list);
        bus->caddr_tbl[codec_addr] = codec;

        codec->vendor_id = snd_hda_param_read(codec, AC_NODE_ROOT,
                                              AC_PAR_VENDOR_ID);
        if (codec->vendor_id == -1)
                /* read again, hopefully the access method was corrected
                 * in the last read...
                 */
                codec->vendor_id = snd_hda_param_read(codec, AC_NODE_ROOT,
                                                      AC_PAR_VENDOR_ID);
        codec->subsystem_id = snd_hda_param_read(codec, AC_NODE_ROOT,
                                                 AC_PAR_SUBSYSTEM_ID);
        codec->revision_id = snd_hda_param_read(codec, AC_NODE_ROOT,
                                                AC_PAR_REV_ID);

        setup_fg_nodes(codec);
        if (!codec->afg && !codec->mfg) {
                snd_printdd("hda_codec: no AFG or MFG node found\n");
                err = -ENODEV;
                goto error;
        }

        err = read_widget_caps(codec, codec->afg ? codec->afg : codec->mfg);
        if (err < 0) {
                snd_printk(KERN_ERR "hda_codec: cannot malloc\n");
                goto error;
        }
        err = read_pin_defaults(codec);
        if (err < 0)
                goto error;

        if (!codec->subsystem_id) {
                hda_nid_t nid = codec->afg ? codec->afg : codec->mfg;
                codec->subsystem_id =
                        snd_hda_codec_read(codec, nid, 0,
                                           AC_VERB_GET_SUBSYSTEM_ID, 0);
        }

        /* power-up all before initialization */
        hda_set_power_state(codec,
                            codec->afg ? codec->afg : codec->mfg,
                            AC_PWRST_D0);

        snd_hda_codec_proc_new(codec);

        snd_hda_create_hwdep(codec);

        sprintf(component, "HDA:%08x,%08x,%08x", codec->vendor_id,
                codec->subsystem_id, codec->revision_id);
        snd_component_add(codec->bus->card, component);

        if (codecp)
                *codecp = codec;
        return 0;

 error:
        snd_hda_codec_free(codec);
        return err;
}
EXPORT_SYMBOL_HDA(snd_hda_codec_new);

/**
 * snd_hda_codec_configure - (Re-)configure the HD-audio codec
 * @codec: the HDA codec
 *
 * Start parsing of the given codec tree and (re-)initialize the whole
 * patch instance.
 *
 * Returns 0 if successful or a negative error code.
 */
int snd_hda_codec_configure(struct hda_codec *codec)
{
        int err;

        codec->preset = find_codec_preset(codec);
        if (!codec->vendor_name || !codec->chip_name) {
                err = get_codec_name(codec);
                if (err < 0)
                        return err;
        }

        if (is_generic_config(codec)) {
                err = snd_hda_parse_generic_codec(codec);
                goto patched;
        }
        if (codec->preset && codec->preset->patch) {
                err = codec->preset->patch(codec);
                goto patched;
        }

        /* call the default parser */
        err = snd_hda_parse_generic_codec(codec);
        if (err < 0)
                printk(KERN_ERR "hda-codec: No codec parser is available\n");

 patched:
        if (!err && codec->patch_ops.unsol_event)
                err = init_unsol_queue(codec->bus);
        /* audio codec should override the mixer name */
        if (!err && (codec->afg || !*codec->bus->card->mixername))
                snprintf(codec->bus->card->mixername,
                         sizeof(codec->bus->card->mixername),
                         "%s %s", codec->vendor_name, codec->chip_name);
        return err;
}
EXPORT_SYMBOL_HDA(snd_hda_codec_configure);

/**
 * snd_hda_codec_setup_stream - set up the codec for streaming
 * @codec: the CODEC to set up
 * @nid: the NID to set up
 * @stream_tag: stream tag to pass, it's between 0x1 and 0xf.
 * @channel_id: channel id to pass, zero based.
 * @format: stream format.
 */
void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
                                u32 stream_tag,
                                int channel_id, int format)
{
        if (!nid)
                return;

        snd_printdd("hda_codec_setup_stream: "
                    "NID=0x%x, stream=0x%x, channel=%d, format=0x%x\n",
                    nid, stream_tag, channel_id, format);
        snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_CHANNEL_STREAMID,
                            (stream_tag << 4) | channel_id);
        msleep(1);
        snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_STREAM_FORMAT, format);
}
EXPORT_SYMBOL_HDA(snd_hda_codec_setup_stream);

/**
 * snd_hda_codec_cleanup_stream - clean up the codec for closing
 * @codec: the CODEC to clean up
 * @nid: the NID to clean up
 */
void snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid)
{
        if (!nid)
                return;

        snd_printdd("hda_codec_cleanup_stream: NID=0x%x\n", nid);
        snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_CHANNEL_STREAMID, 0);
#if 0 /* keep the format */
        msleep(1);
        snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_STREAM_FORMAT, 0);
#endif
}
EXPORT_SYMBOL_HDA(snd_hda_codec_cleanup_stream);

/*
 * amp access functions
 */

/* FIXME: more better hash key? */
#define HDA_HASH_KEY(nid, dir, idx) (u32)((nid) + ((idx) << 16) + ((dir) << 24))
#define HDA_HASH_PINCAP_KEY(nid) (u32)((nid) + (0x02 << 24))
#define HDA_HASH_PARPCM_KEY(nid) (u32)((nid) + (0x03 << 24))
#define HDA_HASH_PARSTR_KEY(nid) (u32)((nid) + (0x04 << 24))
#define INFO_AMP_CAPS   (1<<0)
#define INFO_AMP_VOL(ch)        (1 << (1 + (ch)))

/* initialize the hash table */
static void /*__devinit*/ init_hda_cache(struct hda_cache_rec *cache,
                                     unsigned int record_size)
{
        memset(cache, 0, sizeof(*cache));
        memset(cache->hash, 0xff, sizeof(cache->hash));
        snd_array_init(&cache->buf, record_size, 64);
}

static void free_hda_cache(struct hda_cache_rec *cache)
{
        snd_array_free(&cache->buf);
}

/* query the hash.  allocate an entry if not found. */
static struct hda_cache_head  *get_hash(struct hda_cache_rec *cache, u32 key)
{
        u16 idx = key % (u16)ARRAY_SIZE(cache->hash);
        u16 cur = cache->hash[idx];
        struct hda_cache_head *info;

        while (cur != 0xffff) {
                info = snd_array_elem(&cache->buf, cur);
                if (info->key == key)
                        return info;
                cur = info->next;
        }
        return NULL;
}

/* query the hash.  allocate an entry if not found. */
static struct hda_cache_head  *get_alloc_hash(struct hda_cache_rec *cache,
                                              u32 key)
{
        struct hda_cache_head *info = get_hash(cache, key);
        if (!info) {
                u16 idx, cur;
                /* add a new hash entry */
                info = snd_array_new(&cache->buf);
                if (!info)
                        return NULL;
                cur = snd_array_index(&cache->buf, info);
                info->key = key;
                info->val = 0;
                idx = key % (u16)ARRAY_SIZE(cache->hash);
                info->next = cache->hash[idx];
                cache->hash[idx] = cur;
        }
        return info;
}

/* query and allocate an amp hash entry */
static inline struct hda_amp_info *
get_alloc_amp_hash(struct hda_codec *codec, u32 key)
{
        return (struct hda_amp_info *)get_alloc_hash(&codec->amp_cache, key);
}

/**
 * query_amp_caps - query AMP capabilities
 * @codec: the HD-auio codec
 * @nid: the NID to query
 * @direction: either #HDA_INPUT or #HDA_OUTPUT
 *
 * Query AMP capabilities for the given widget and direction.
 * Returns the obtained capability bits.
 *
 * When cap bits have been already read, this doesn't read again but
 * returns the cached value.
 */
u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction)
{
        struct hda_amp_info *info;

        info = get_alloc_amp_hash(codec, HDA_HASH_KEY(nid, direction, 0));
        if (!info)
                return 0;
        if (!(info->head.val & INFO_AMP_CAPS)) {
                if (!(get_wcaps(codec, nid) & AC_WCAP_AMP_OVRD))
                        nid = codec->afg;
                info->amp_caps = snd_hda_param_read(codec, nid,
                                                    direction == HDA_OUTPUT ?
                                                    AC_PAR_AMP_OUT_CAP :
                                                    AC_PAR_AMP_IN_CAP);
                if (info->amp_caps)
                        info->head.val |= INFO_AMP_CAPS;
        }
        return info->amp_caps;
}
EXPORT_SYMBOL_HDA(query_amp_caps);

/**
 * snd_hda_override_amp_caps - Override the AMP capabilities
 * @codec: the CODEC to clean up
 * @nid: the NID to clean up
 * @direction: either #HDA_INPUT or #HDA_OUTPUT
 * @caps: the capability bits to set
 *
 * Override the cached AMP caps bits value by the given one.
 * This function is useful if the driver needs to adjust the AMP ranges,
 * e.g. limit to 0dB, etc.
 *
 * Returns zero if successful or a negative error code.
 */
int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
                              unsigned int caps)
{
        struct hda_amp_info *info;

        info = get_alloc_amp_hash(codec, HDA_HASH_KEY(nid, dir, 0));
        if (!info)
                return -EINVAL;
        info->amp_caps = caps;
        info->head.val |= INFO_AMP_CAPS;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_override_amp_caps);

static unsigned int
query_caps_hash(struct hda_codec *codec, hda_nid_t nid, u32 key,
                unsigned int (*func)(struct hda_codec *, hda_nid_t))
{
        struct hda_amp_info *info;

        info = get_alloc_amp_hash(codec, key);
        if (!info)
                return 0;
        if (!info->head.val) {
                info->head.val |= INFO_AMP_CAPS;
                info->amp_caps = func(codec, nid);
        }
        return info->amp_caps;
}

static unsigned int read_pin_cap(struct hda_codec *codec, hda_nid_t nid)
{
        return snd_hda_param_read(codec, nid, AC_PAR_PIN_CAP);
}

/**
 * snd_hda_query_pin_caps - Query PIN capabilities
 * @codec: the HD-auio codec
 * @nid: the NID to query
 *
 * Query PIN capabilities for the given widget.
 * Returns the obtained capability bits.
 *
 * When cap bits have been already read, this doesn't read again but
 * returns the cached value.
 */
u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid)
{
        return query_caps_hash(codec, nid, HDA_HASH_PINCAP_KEY(nid),
                               read_pin_cap);
}
EXPORT_SYMBOL_HDA(snd_hda_query_pin_caps);

/**
 * snd_hda_pin_sense - execute pin sense measurement
 * @codec: the CODEC to sense
 * @nid: the pin NID to sense
 *
 * Execute necessary pin sense measurement and return its Presence Detect,
 * Impedance, ELD Valid etc. status bits.
 */
u32 snd_hda_pin_sense(struct hda_codec *codec, hda_nid_t nid)
{
        u32 pincap;

        if (!codec->no_trigger_sense) {
                pincap = snd_hda_query_pin_caps(codec, nid);
                if (pincap & AC_PINCAP_TRIG_REQ) /* need trigger? */
                        snd_hda_codec_read(codec, nid, 0,
                                        AC_VERB_SET_PIN_SENSE, 0);
        }
        return snd_hda_codec_read(codec, nid, 0,
                                  AC_VERB_GET_PIN_SENSE, 0);
}
EXPORT_SYMBOL_HDA(snd_hda_pin_sense);

/**
 * snd_hda_jack_detect - query pin Presence Detect status
 * @codec: the CODEC to sense
 * @nid: the pin NID to sense
 *
 * Query and return the pin's Presence Detect status.
 */
int snd_hda_jack_detect(struct hda_codec *codec, hda_nid_t nid)
{
        u32 sense = snd_hda_pin_sense(codec, nid);
        return !!(sense & AC_PINSENSE_PRESENCE);
}
EXPORT_SYMBOL_HDA(snd_hda_jack_detect);

/*
 * read the current volume to info
 * if the cache exists, read the cache value.
 */
static unsigned int get_vol_mute(struct hda_codec *codec,
                                 struct hda_amp_info *info, hda_nid_t nid,
                                 int ch, int direction, int index)
{
        u32 val, parm;

        if (info->head.val & INFO_AMP_VOL(ch))
                return info->vol[ch];

        parm = ch ? AC_AMP_GET_RIGHT : AC_AMP_GET_LEFT;
        parm |= direction == HDA_OUTPUT ? AC_AMP_GET_OUTPUT : AC_AMP_GET_INPUT;
        parm |= index;
        val = snd_hda_codec_read(codec, nid, 0,
                                 AC_VERB_GET_AMP_GAIN_MUTE, parm);
        info->vol[ch] = val & 0xff;
        info->head.val |= INFO_AMP_VOL(ch);
        return info->vol[ch];
}

/*
 * write the current volume in info to the h/w and update the cache
 */
static void put_vol_mute(struct hda_codec *codec, struct hda_amp_info *info,
                         hda_nid_t nid, int ch, int direction, int index,
                         int val)
{
        u32 parm;

        parm = ch ? AC_AMP_SET_RIGHT : AC_AMP_SET_LEFT;
        parm |= direction == HDA_OUTPUT ? AC_AMP_SET_OUTPUT : AC_AMP_SET_INPUT;
        parm |= index << AC_AMP_SET_INDEX_SHIFT;
        parm |= val;
        snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_AMP_GAIN_MUTE, parm);
        info->vol[ch] = val;
}

/**
 * snd_hda_codec_amp_read - Read AMP value
 * @codec: HD-audio codec
 * @nid: NID to read the AMP value
 * @ch: channel (left=0 or right=1)
 * @direction: #HDA_INPUT or #HDA_OUTPUT
 * @index: the index value (only for input direction)
 *
 * Read AMP value.  The volume is between 0 to 0x7f, 0x80 = mute bit.
 */
int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
                           int direction, int index)
{
        struct hda_amp_info *info;
        info = get_alloc_amp_hash(codec, HDA_HASH_KEY(nid, direction, index));
        if (!info)
                return 0;
        return get_vol_mute(codec, info, nid, ch, direction, index);
}
EXPORT_SYMBOL_HDA(snd_hda_codec_amp_read);

/**
 * snd_hda_codec_amp_update - update the AMP value
 * @codec: HD-audio codec
 * @nid: NID to read the AMP value
 * @ch: channel (left=0 or right=1)
 * @direction: #HDA_INPUT or #HDA_OUTPUT
 * @idx: the index value (only for input direction)
 * @mask: bit mask to set
 * @val: the bits value to set
 *
 * Update the AMP value with a bit mask.
 * Returns 0 if the value is unchanged, 1 if changed.
 */
int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
                             int direction, int idx, int mask, int val)
{
        struct hda_amp_info *info;

        info = get_alloc_amp_hash(codec, HDA_HASH_KEY(nid, direction, idx));
        if (!info)
                return 0;
        if (snd_BUG_ON(mask & ~0xff))
                mask &= 0xff;
        val &= mask;
        val |= get_vol_mute(codec, info, nid, ch, direction, idx) & ~mask;
        if (info->vol[ch] == val)
                return 0;
        put_vol_mute(codec, info, nid, ch, direction, idx, val);
        return 1;
}
EXPORT_SYMBOL_HDA(snd_hda_codec_amp_update);

/**
 * snd_hda_codec_amp_stereo - update the AMP stereo values
 * @codec: HD-audio codec
 * @nid: NID to read the AMP value
 * @direction: #HDA_INPUT or #HDA_OUTPUT
 * @idx: the index value (only for input direction)
 * @mask: bit mask to set
 * @val: the bits value to set
 *
 * Update the AMP values like snd_hda_codec_amp_update(), but for a
 * stereo widget with the same mask and value.
 */
int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
                             int direction, int idx, int mask, int val)
{
        int ch, ret = 0;

        if (snd_BUG_ON(mask & ~0xff))
                mask &= 0xff;
        for (ch = 0; ch < 2; ch++)
                ret |= snd_hda_codec_amp_update(codec, nid, ch, direction,
                                                idx, mask, val);
        return ret;
}
EXPORT_SYMBOL_HDA(snd_hda_codec_amp_stereo);

#ifdef SND_HDA_NEEDS_RESUME
/**
 * snd_hda_codec_resume_amp - Resume all AMP commands from the cache
 * @codec: HD-audio codec
 *
 * Resume the all amp commands from the cache.
 */
void snd_hda_codec_resume_amp(struct hda_codec *codec)
{
        struct hda_amp_info *buffer = codec->amp_cache.buf.list;
        int i;

        for (i = 0; i < codec->amp_cache.buf.used; i++, buffer++) {
                u32 key = buffer->head.key;
                hda_nid_t nid;
                unsigned int idx, dir, ch;
                if (!key)
                        continue;
                nid = key & 0xff;
                idx = (key >> 16) & 0xff;
                dir = (key >> 24) & 0xff;
                for (ch = 0; ch < 2; ch++) {
                        if (!(buffer->head.val & INFO_AMP_VOL(ch)))
                                continue;
                        put_vol_mute(codec, buffer, nid, ch, dir, idx,
                                     buffer->vol[ch]);
                }
        }
}
EXPORT_SYMBOL_HDA(snd_hda_codec_resume_amp);
#endif /* SND_HDA_NEEDS_RESUME */

static u32 get_amp_max_value(struct hda_codec *codec, hda_nid_t nid, int dir,
                             unsigned int ofs)
{
        u32 caps = query_amp_caps(codec, nid, dir);
        /* get num steps */
        caps = (caps & AC_AMPCAP_NUM_STEPS) >> AC_AMPCAP_NUM_STEPS_SHIFT;
        if (ofs < caps)
                caps -= ofs;
        return caps;
}

/**
 * snd_hda_mixer_amp_volume_info - Info callback for a standard AMP mixer
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
 */
int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
                                  struct snd_ctl_elem_info *uinfo)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        u16 nid = get_amp_nid(kcontrol);
        u8 chs = get_amp_channels(kcontrol);
        int dir = get_amp_direction(kcontrol);
        unsigned int ofs = get_amp_offset(kcontrol);

        uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
        uinfo->count = chs == 3 ? 2 : 1;
        uinfo->value.integer.min = 0;
        uinfo->value.integer.max = get_amp_max_value(codec, nid, dir, ofs);
        if (!uinfo->value.integer.max) {
                printk(KERN_WARNING "hda_codec: "
                       "num_steps = 0 for NID=0x%x (ctl = %s)\n", nid,
                       kcontrol->id.name);
                return -EINVAL;
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_volume_info);


static inline unsigned int
read_amp_value(struct hda_codec *codec, hda_nid_t nid,
               int ch, int dir, int idx, unsigned int ofs)
{
        unsigned int val;
        val = snd_hda_codec_amp_read(codec, nid, ch, dir, idx);
        val &= HDA_AMP_VOLMASK;
        if (val >= ofs)
                val -= ofs;
        else
                val = 0;
        return val;
}

static inline int
update_amp_value(struct hda_codec *codec, hda_nid_t nid,
                 int ch, int dir, int idx, unsigned int ofs,
                 unsigned int val)
{
        unsigned int maxval;

        if (val > 0)
                val += ofs;
        /* ofs = 0: raw max value */
        maxval = get_amp_max_value(codec, nid, dir, 0);
        if (val > maxval)
                val = maxval;
        return snd_hda_codec_amp_update(codec, nid, ch, dir, idx,
                                        HDA_AMP_VOLMASK, val);
}

/**
 * snd_hda_mixer_amp_volume_get - Get callback for a standard AMP mixer volume
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
 */
int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
                                 struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = get_amp_nid(kcontrol);
        int chs = get_amp_channels(kcontrol);
        int dir = get_amp_direction(kcontrol);
        int idx = get_amp_index(kcontrol);
        unsigned int ofs = get_amp_offset(kcontrol);
        long *valp = ucontrol->value.integer.value;

        if (chs & 1)
                *valp++ = read_amp_value(codec, nid, 0, dir, idx, ofs);
        if (chs & 2)
                *valp = read_amp_value(codec, nid, 1, dir, idx, ofs);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_volume_get);

/**
 * snd_hda_mixer_amp_volume_put - Put callback for a standard AMP mixer volume
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
 */
int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
                                 struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = get_amp_nid(kcontrol);
        int chs = get_amp_channels(kcontrol);
        int dir = get_amp_direction(kcontrol);
        int idx = get_amp_index(kcontrol);
        unsigned int ofs = get_amp_offset(kcontrol);
        long *valp = ucontrol->value.integer.value;
        int change = 0;

        snd_hda_power_up(codec);
        if (chs & 1) {
                change = update_amp_value(codec, nid, 0, dir, idx, ofs, *valp);
                valp++;
        }
        if (chs & 2)
                change |= update_amp_value(codec, nid, 1, dir, idx, ofs, *valp);
        snd_hda_power_down(codec);
        return change;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_volume_put);

/**
 * snd_hda_mixer_amp_volume_put - TLV callback for a standard AMP mixer volume
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
 */
int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
                          unsigned int size, unsigned int __user *_tlv)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = get_amp_nid(kcontrol);
        int dir = get_amp_direction(kcontrol);
        unsigned int ofs = get_amp_offset(kcontrol);
        u32 caps, val1, val2;

        if (size < 4 * sizeof(unsigned int))
                return -ENOMEM;
        caps = query_amp_caps(codec, nid, dir);
        val2 = (caps & AC_AMPCAP_STEP_SIZE) >> AC_AMPCAP_STEP_SIZE_SHIFT;
        val2 = (val2 + 1) * 25;
        val1 = -((caps & AC_AMPCAP_OFFSET) >> AC_AMPCAP_OFFSET_SHIFT);
        val1 += ofs;
        val1 = ((int)val1) * ((int)val2);
        if (put_user(SNDRV_CTL_TLVT_DB_SCALE, _tlv))
                return -EFAULT;
        if (put_user(2 * sizeof(unsigned int), _tlv + 1))
                return -EFAULT;
        if (put_user(val1, _tlv + 2))
                return -EFAULT;
        if (put_user(val2, _tlv + 3))
                return -EFAULT;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_tlv);

/**
 * snd_hda_set_vmaster_tlv - Set TLV for a virtual master control
 * @codec: HD-audio codec
 * @nid: NID of a reference widget
 * @dir: #HDA_INPUT or #HDA_OUTPUT
 * @tlv: TLV data to be stored, at least 4 elements
 *
 * Set (static) TLV data for a virtual master volume using the AMP caps
 * obtained from the reference NID.
 * The volume range is recalculated as if the max volume is 0dB.
 */
void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
                             unsigned int *tlv)
{
        u32 caps;
        int nums, step;

        caps = query_amp_caps(codec, nid, dir);
        nums = (caps & AC_AMPCAP_NUM_STEPS) >> AC_AMPCAP_NUM_STEPS_SHIFT;
        step = (caps & AC_AMPCAP_STEP_SIZE) >> AC_AMPCAP_STEP_SIZE_SHIFT;
        step = (step + 1) * 25;
        tlv[0] = SNDRV_CTL_TLVT_DB_SCALE;
        tlv[1] = 2 * sizeof(unsigned int);
        tlv[2] = -nums * step;
        tlv[3] = step;
}
EXPORT_SYMBOL_HDA(snd_hda_set_vmaster_tlv);

/* find a mixer control element with the given name */
static struct snd_kcontrol *
_snd_hda_find_mixer_ctl(struct hda_codec *codec,
                        const char *name, int idx)
{
        struct snd_ctl_elem_id id;
        memset(&id, 0, sizeof(id));
        id.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
        id.index = idx;
        if (snd_BUG_ON(strlen(name) >= sizeof(id.name)))
                return NULL;
        strcpy(id.name, name);
        return snd_ctl_find_id(codec->bus->card, &id);
}

/**
 * snd_hda_find_mixer_ctl - Find a mixer control element with the given name
 * @codec: HD-audio codec
 * @name: ctl id name string
 *
 * Get the control element with the given id string and IFACE_MIXER.
 */
struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
                                            const char *name)
{
        return _snd_hda_find_mixer_ctl(codec, name, 0);
}
EXPORT_SYMBOL_HDA(snd_hda_find_mixer_ctl);

/**
 * snd_hda_ctl_add - Add a control element and assign to the codec
 * @codec: HD-audio codec
 * @nid: corresponding NID (optional)
 * @kctl: the control element to assign
 *
 * Add the given control element to an array inside the codec instance.
 * All control elements belonging to a codec are supposed to be added
 * by this function so that a proper clean-up works at the free or
 * reconfiguration time.
 *
 * If non-zero @nid is passed, the NID is assigned to the control element.
 * The assignment is shown in the codec proc file.
 *
 * snd_hda_ctl_add() checks the control subdev id field whether
 * #HDA_SUBDEV_NID_FLAG bit is set.  If set (and @nid is zero), the lower
 * bits value is taken as the NID to assign. The #HDA_NID_ITEM_AMP bit
 * specifies if kctl->private_value is a HDA amplifier value.
 */
int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
                    struct snd_kcontrol *kctl)
{
        int err;
        unsigned short flags = 0;
        struct hda_nid_item *item;

        if (kctl->id.subdevice & HDA_SUBDEV_AMP_FLAG) {
                flags |= HDA_NID_ITEM_AMP;
                if (nid == 0)
                        nid = get_amp_nid_(kctl->private_value);
        }
        if ((kctl->id.subdevice & HDA_SUBDEV_NID_FLAG) != 0 && nid == 0)
                nid = kctl->id.subdevice & 0xffff;
        if (kctl->id.subdevice & (HDA_SUBDEV_NID_FLAG|HDA_SUBDEV_AMP_FLAG))
                kctl->id.subdevice = 0;
        err = snd_ctl_add(codec->bus->card, kctl);
        if (err < 0)
                return err;
        item = snd_array_new(&codec->mixers);
        if (!item)
                return -ENOMEM;
        item->kctl = kctl;
        item->nid = nid;
        item->flags = flags;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_ctl_add);

/**
 * snd_hda_add_nid - Assign a NID to a control element
 * @codec: HD-audio codec
 * @nid: corresponding NID (optional)
 * @kctl: the control element to assign
 * @index: index to kctl
 *
 * Add the given control element to an array inside the codec instance.
 * This function is used when #snd_hda_ctl_add cannot be used for 1:1
 * NID:KCTL mapping - for example "Capture Source" selector.
 */
int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
                    unsigned int index, hda_nid_t nid)
{
        struct hda_nid_item *item;

        if (nid > 0) {
                item = snd_array_new(&codec->nids);
                if (!item)
                        return -ENOMEM;
                item->kctl = kctl;
                item->index = index;
                item->nid = nid;
                return 0;
        }
        printk(KERN_ERR "hda-codec: no NID for mapping control %s:%d:%d\n",
               kctl->id.name, kctl->id.index, index);
        return -EINVAL;
}
EXPORT_SYMBOL_HDA(snd_hda_add_nid);

/**
 * snd_hda_ctls_clear - Clear all controls assigned to the given codec
 * @codec: HD-audio codec
 */
void snd_hda_ctls_clear(struct hda_codec *codec)
{
        int i;
        struct hda_nid_item *items = codec->mixers.list;
        for (i = 0; i < codec->mixers.used; i++)
                snd_ctl_remove(codec->bus->card, items[i].kctl);
        snd_array_free(&codec->mixers);
        snd_array_free(&codec->nids);
}

/* pseudo device locking
 * toggle card->shutdown to allow/disallow the device access (as a hack)
 */
static int hda_lock_devices(struct snd_card *card)
{
        spin_lock(&card->files_lock);
        if (card->shutdown) {
                spin_unlock(&card->files_lock);
                return -EINVAL;
        }
        card->shutdown = 1;
        spin_unlock(&card->files_lock);
        return 0;
}

static void hda_unlock_devices(struct snd_card *card)
{
        spin_lock(&card->files_lock);
        card->shutdown = 0;
        spin_unlock(&card->files_lock);
}

/**
 * snd_hda_codec_reset - Clear all objects assigned to the codec
 * @codec: HD-audio codec
 *
 * This frees the all PCM and control elements assigned to the codec, and
 * clears the caches and restores the pin default configurations.
 *
 * When a device is being used, it returns -EBSY.  If successfully freed,
 * returns zero.
 */
int snd_hda_codec_reset(struct hda_codec *codec)
{
        struct snd_card *card = codec->bus->card;
        int i, pcm;

        if (hda_lock_devices(card) < 0)
                return -EBUSY;
        /* check whether the codec isn't used by any mixer or PCM streams */
        if (!list_empty(&card->ctl_files)) {
                hda_unlock_devices(card);
                return -EBUSY;
        }
        for (pcm = 0; pcm < codec->num_pcms; pcm++) {
                struct hda_pcm *cpcm = &codec->pcm_info[pcm];
                if (!cpcm->pcm)
                        continue;
                if (cpcm->pcm->streams[0].substream_opened ||
                    cpcm->pcm->streams[1].substream_opened) {
                        hda_unlock_devices(card);
                        return -EBUSY;
                }
        }

        /* OK, let it free */

#ifdef CONFIG_SND_HDA_POWER_SAVE
        cancel_delayed_work(&codec->power_work);
        flush_workqueue(codec->bus->workq);
#endif
        snd_hda_ctls_clear(codec);
        /* relase PCMs */
        for (i = 0; i < codec->num_pcms; i++) {
                if (codec->pcm_info[i].pcm) {
                        snd_device_free(card, codec->pcm_info[i].pcm);
                        clear_bit(codec->pcm_info[i].device,
                                  codec->bus->pcm_dev_bits);
                }
        }
        if (codec->patch_ops.free)
                codec->patch_ops.free(codec);
        codec->proc_widget_hook = NULL;
        codec->spec = NULL;
        free_hda_cache(&codec->amp_cache);
        free_hda_cache(&codec->cmd_cache);
        init_hda_cache(&codec->amp_cache, sizeof(struct hda_amp_info));
        init_hda_cache(&codec->cmd_cache, sizeof(struct hda_cache_head));
        /* free only driver_pins so that init_pins + user_pins are restored */
        snd_array_free(&codec->driver_pins);
        restore_pincfgs(codec);
        codec->num_pcms = 0;
        codec->pcm_info = NULL;
        codec->preset = NULL;
        memset(&codec->patch_ops, 0, sizeof(codec->patch_ops));
        codec->slave_dig_outs = NULL;
        codec->spdif_status_reset = 0;
        module_put(codec->owner);
        codec->owner = NULL;

        /* allow device access again */
        hda_unlock_devices(card);
        return 0;
}

/**
 * snd_hda_add_vmaster - create a virtual master control and add slaves
 * @codec: HD-audio codec
 * @name: vmaster control name
 * @tlv: TLV data (optional)
 * @slaves: slave control names (optional)
 *
 * Create a virtual master control with the given name.  The TLV data
 * must be either NULL or a valid data.
 *
 * @slaves is a NULL-terminated array of strings, each of which is a
 * slave control name.  All controls with these names are assigned to
 * the new virtual master control.
 *
 * This function returns zero if successful or a negative error code.
 */
int snd_hda_add_vmaster(struct hda_codec *codec, char *name,
                        unsigned int *tlv, const char **slaves)
{
        struct snd_kcontrol *kctl;
        const char **s;
        int err;

        for (s = slaves; *s && !snd_hda_find_mixer_ctl(codec, *s); s++)
                ;
        if (!*s) {
                snd_printdd("No slave found for %s\n", name);
                return 0;
        }
        kctl = snd_ctl_make_virtual_master(name, tlv);
        if (!kctl)
                return -ENOMEM;
        err = snd_hda_ctl_add(codec, 0, kctl);
        if (err < 0)
                return err;

        for (s = slaves; *s; s++) {
                struct snd_kcontrol *sctl;
                int i = 0;
                for (;;) {
                        sctl = _snd_hda_find_mixer_ctl(codec, *s, i);
                        if (!sctl) {
                                if (!i)
                                        snd_printdd("Cannot find slave %s, "
                                                    "skipped\n", *s);
                                break;
                        }
                        err = snd_ctl_add_slave(kctl, sctl);
                        if (err < 0)
                                return err;
                        i++;
                }
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_add_vmaster);

/**
 * snd_hda_mixer_amp_switch_info - Info callback for a standard AMP mixer switch
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
 */
int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
                                  struct snd_ctl_elem_info *uinfo)
{
        int chs = get_amp_channels(kcontrol);

        uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
        uinfo->count = chs == 3 ? 2 : 1;
        uinfo->value.integer.min = 0;
        uinfo->value.integer.max = 1;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_switch_info);

/**
 * snd_hda_mixer_amp_switch_get - Get callback for a standard AMP mixer switch
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
 */
int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
                                 struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = get_amp_nid(kcontrol);
        int chs = get_amp_channels(kcontrol);
        int dir = get_amp_direction(kcontrol);
        int idx = get_amp_index(kcontrol);
        long *valp = ucontrol->value.integer.value;

        if (chs & 1)
                *valp++ = (snd_hda_codec_amp_read(codec, nid, 0, dir, idx) &
                           HDA_AMP_MUTE) ? 0 : 1;
        if (chs & 2)
                *valp = (snd_hda_codec_amp_read(codec, nid, 1, dir, idx) &
                         HDA_AMP_MUTE) ? 0 : 1;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_switch_get);

/**
 * snd_hda_mixer_amp_switch_put - Put callback for a standard AMP mixer switch
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_COMPOSE_AMP_VAL*() or related macros.
 */
int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
                                 struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = get_amp_nid(kcontrol);
        int chs = get_amp_channels(kcontrol);
        int dir = get_amp_direction(kcontrol);
        int idx = get_amp_index(kcontrol);
        long *valp = ucontrol->value.integer.value;
        int change = 0;

        snd_hda_power_up(codec);
        if (chs & 1) {
                change = snd_hda_codec_amp_update(codec, nid, 0, dir, idx,
                                                  HDA_AMP_MUTE,
                                                  *valp ? 0 : HDA_AMP_MUTE);
                valp++;
        }
        if (chs & 2)
                change |= snd_hda_codec_amp_update(codec, nid, 1, dir, idx,
                                                   HDA_AMP_MUTE,
                                                   *valp ? 0 : HDA_AMP_MUTE);
#ifdef CONFIG_SND_HDA_POWER_SAVE
        if (codec->patch_ops.check_power_status)
                codec->patch_ops.check_power_status(codec, nid);
#endif
        snd_hda_power_down(codec);
        return change;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_switch_put);

#ifdef CONFIG_SND_HDA_INPUT_BEEP
/**
 * snd_hda_mixer_amp_switch_put_beep - Put callback for a beep AMP switch
 *
 * This function calls snd_hda_enable_beep_device(), which behaves differently
 * depending on beep_mode option.
 */
int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
                                      struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        long *valp = ucontrol->value.integer.value;

        snd_hda_enable_beep_device(codec, *valp);
        return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_switch_put_beep);
#endif /* CONFIG_SND_HDA_INPUT_BEEP */

/*
 * bound volume controls
 *
 * bind multiple volumes (# indices, from 0)
 */

#define AMP_VAL_IDX_SHIFT       19
#define AMP_VAL_IDX_MASK        (0x0f<<19)

/**
 * snd_hda_mixer_bind_switch_get - Get callback for a bound volume control
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_BIND_MUTE*() macros.
 */
int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
                                  struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        unsigned long pval;
        int err;

        mutex_lock(&codec->control_mutex);
        pval = kcontrol->private_value;
        kcontrol->private_value = pval & ~AMP_VAL_IDX_MASK; /* index 0 */
        err = snd_hda_mixer_amp_switch_get(kcontrol, ucontrol);
        kcontrol->private_value = pval;
        mutex_unlock(&codec->control_mutex);
        return err;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_bind_switch_get);

/**
 * snd_hda_mixer_bind_switch_put - Put callback for a bound volume control
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_BIND_MUTE*() macros.
 */
int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
                                  struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        unsigned long pval;
        int i, indices, err = 0, change = 0;

        mutex_lock(&codec->control_mutex);
        pval = kcontrol->private_value;
        indices = (pval & AMP_VAL_IDX_MASK) >> AMP_VAL_IDX_SHIFT;
        for (i = 0; i < indices; i++) {
                kcontrol->private_value = (pval & ~AMP_VAL_IDX_MASK) |
                        (i << AMP_VAL_IDX_SHIFT);
                err = snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
                if (err < 0)
                        break;
                change |= err;
        }
        kcontrol->private_value = pval;
        mutex_unlock(&codec->control_mutex);
        return err < 0 ? err : change;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_bind_switch_put);

/**
 * snd_hda_mixer_bind_ctls_info - Info callback for a generic bound control
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_BIND_VOL() or HDA_BIND_SW() macros.
 */
int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
                                 struct snd_ctl_elem_info *uinfo)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        struct hda_bind_ctls *c;
        int err;

        mutex_lock(&codec->control_mutex);
        c = (struct hda_bind_ctls *)kcontrol->private_value;
        kcontrol->private_value = *c->values;
        err = c->ops->info(kcontrol, uinfo);
        kcontrol->private_value = (long)c;
        mutex_unlock(&codec->control_mutex);
        return err;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_bind_ctls_info);

/**
 * snd_hda_mixer_bind_ctls_get - Get callback for a generic bound control
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_BIND_VOL() or HDA_BIND_SW() macros.
 */
int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
                                struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        struct hda_bind_ctls *c;
        int err;

        mutex_lock(&codec->control_mutex);
        c = (struct hda_bind_ctls *)kcontrol->private_value;
        kcontrol->private_value = *c->values;
        err = c->ops->get(kcontrol, ucontrol);
        kcontrol->private_value = (long)c;
        mutex_unlock(&codec->control_mutex);
        return err;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_bind_ctls_get);

/**
 * snd_hda_mixer_bind_ctls_put - Put callback for a generic bound control
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_BIND_VOL() or HDA_BIND_SW() macros.
 */
int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
                                struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        struct hda_bind_ctls *c;
        unsigned long *vals;
        int err = 0, change = 0;

        mutex_lock(&codec->control_mutex);
        c = (struct hda_bind_ctls *)kcontrol->private_value;
        for (vals = c->values; *vals; vals++) {
                kcontrol->private_value = *vals;
                err = c->ops->put(kcontrol, ucontrol);
                if (err < 0)
                        break;
                change |= err;
        }
        kcontrol->private_value = (long)c;
        mutex_unlock(&codec->control_mutex);
        return err < 0 ? err : change;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_bind_ctls_put);

/**
 * snd_hda_mixer_bind_tlv - TLV callback for a generic bound control
 *
 * The control element is supposed to have the private_value field
 * set up via HDA_BIND_VOL() macro.
 */
int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
                           unsigned int size, unsigned int __user *tlv)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        struct hda_bind_ctls *c;
        int err;

        mutex_lock(&codec->control_mutex);
        c = (struct hda_bind_ctls *)kcontrol->private_value;
        kcontrol->private_value = *c->values;
        err = c->ops->tlv(kcontrol, op_flag, size, tlv);
        kcontrol->private_value = (long)c;
        mutex_unlock(&codec->control_mutex);
        return err;
}
EXPORT_SYMBOL_HDA(snd_hda_mixer_bind_tlv);

struct hda_ctl_ops snd_hda_bind_vol = {
        .info = snd_hda_mixer_amp_volume_info,
        .get = snd_hda_mixer_amp_volume_get,
        .put = snd_hda_mixer_amp_volume_put,
        .tlv = snd_hda_mixer_amp_tlv
};
EXPORT_SYMBOL_HDA(snd_hda_bind_vol);

struct hda_ctl_ops snd_hda_bind_sw = {
        .info = snd_hda_mixer_amp_switch_info,
        .get = snd_hda_mixer_amp_switch_get,
        .put = snd_hda_mixer_amp_switch_put,
        .tlv = snd_hda_mixer_amp_tlv
};
EXPORT_SYMBOL_HDA(snd_hda_bind_sw);

/*
 * SPDIF out controls
 */

static int snd_hda_spdif_mask_info(struct snd_kcontrol *kcontrol,
                                   struct snd_ctl_elem_info *uinfo)
{
        uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
        uinfo->count = 1;
        return 0;
}

static int snd_hda_spdif_cmask_get(struct snd_kcontrol *kcontrol,
                                   struct snd_ctl_elem_value *ucontrol)
{
        ucontrol->value.iec958.status[0] = IEC958_AES0_PROFESSIONAL |
                                           IEC958_AES0_NONAUDIO |
                                           IEC958_AES0_CON_EMPHASIS_5015 |
                                           IEC958_AES0_CON_NOT_COPYRIGHT;
        ucontrol->value.iec958.status[1] = IEC958_AES1_CON_CATEGORY |
                                           IEC958_AES1_CON_ORIGINAL;
        return 0;
}

static int snd_hda_spdif_pmask_get(struct snd_kcontrol *kcontrol,
                                   struct snd_ctl_elem_value *ucontrol)
{
        ucontrol->value.iec958.status[0] = IEC958_AES0_PROFESSIONAL |
                                           IEC958_AES0_NONAUDIO |
                                           IEC958_AES0_PRO_EMPHASIS_5015;
        return 0;
}

static int snd_hda_spdif_default_get(struct snd_kcontrol *kcontrol,
                                     struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);

        ucontrol->value.iec958.status[0] = codec->spdif_status & 0xff;
        ucontrol->value.iec958.status[1] = (codec->spdif_status >> 8) & 0xff;
        ucontrol->value.iec958.status[2] = (codec->spdif_status >> 16) & 0xff;
        ucontrol->value.iec958.status[3] = (codec->spdif_status >> 24) & 0xff;

        return 0;
}

/* convert from SPDIF status bits to HDA SPDIF bits
 * bit 0 (DigEn) is always set zero (to be filled later)
 */
static unsigned short convert_from_spdif_status(unsigned int sbits)
{
        unsigned short val = 0;

        if (sbits & IEC958_AES0_PROFESSIONAL)
                val |= AC_DIG1_PROFESSIONAL;
        if (sbits & IEC958_AES0_NONAUDIO)
                val |= AC_DIG1_NONAUDIO;
        if (sbits & IEC958_AES0_PROFESSIONAL) {
                if ((sbits & IEC958_AES0_PRO_EMPHASIS) ==
                    IEC958_AES0_PRO_EMPHASIS_5015)
                        val |= AC_DIG1_EMPHASIS;
        } else {
                if ((sbits & IEC958_AES0_CON_EMPHASIS) ==
                    IEC958_AES0_CON_EMPHASIS_5015)
                        val |= AC_DIG1_EMPHASIS;
                if (!(sbits & IEC958_AES0_CON_NOT_COPYRIGHT))
                        val |= AC_DIG1_COPYRIGHT;
                if (sbits & (IEC958_AES1_CON_ORIGINAL << 8))
                        val |= AC_DIG1_LEVEL;
                val |= sbits & (IEC958_AES1_CON_CATEGORY << 8);
        }
        return val;
}

/* convert to SPDIF status bits from HDA SPDIF bits
 */
static unsigned int convert_to_spdif_status(unsigned short val)
{
        unsigned int sbits = 0;

        if (val & AC_DIG1_NONAUDIO)
                sbits |= IEC958_AES0_NONAUDIO;
        if (val & AC_DIG1_PROFESSIONAL)
                sbits |= IEC958_AES0_PROFESSIONAL;
        if (sbits & IEC958_AES0_PROFESSIONAL) {
                if (sbits & AC_DIG1_EMPHASIS)
                        sbits |= IEC958_AES0_PRO_EMPHASIS_5015;
        } else {
                if (val & AC_DIG1_EMPHASIS)
                        sbits |= IEC958_AES0_CON_EMPHASIS_5015;
                if (!(val & AC_DIG1_COPYRIGHT))
                        sbits |= IEC958_AES0_CON_NOT_COPYRIGHT;
                if (val & AC_DIG1_LEVEL)
                        sbits |= (IEC958_AES1_CON_ORIGINAL << 8);
                sbits |= val & (0x7f << 8);
        }
        return sbits;
}

/* set digital convert verbs both for the given NID and its slaves */
static void set_dig_out(struct hda_codec *codec, hda_nid_t nid,
                        int verb, int val)
{
        hda_nid_t *d;

        snd_hda_codec_write_cache(codec, nid, 0, verb, val);
        d = codec->slave_dig_outs;
        if (!d)
                return;
        for (; *d; d++)
                snd_hda_codec_write_cache(codec, *d, 0, verb, val);
}

static inline void set_dig_out_convert(struct hda_codec *codec, hda_nid_t nid,
                                       int dig1, int dig2)
{
        if (dig1 != -1)
                set_dig_out(codec, nid, AC_VERB_SET_DIGI_CONVERT_1, dig1);
        if (dig2 != -1)
                set_dig_out(codec, nid, AC_VERB_SET_DIGI_CONVERT_2, dig2);
}

static int snd_hda_spdif_default_put(struct snd_kcontrol *kcontrol,
                                     struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = kcontrol->private_value;
        unsigned short val;
        int change;

        mutex_lock(&codec->spdif_mutex);
        codec->spdif_status = ucontrol->value.iec958.status[0] |
                ((unsigned int)ucontrol->value.iec958.status[1] << 8) |
                ((unsigned int)ucontrol->value.iec958.status[2] << 16) |
                ((unsigned int)ucontrol->value.iec958.status[3] << 24);
        val = convert_from_spdif_status(codec->spdif_status);
        val |= codec->spdif_ctls & 1;
        change = codec->spdif_ctls != val;
        codec->spdif_ctls = val;

        if (change)
                set_dig_out_convert(codec, nid, val & 0xff, (val >> 8) & 0xff);

        mutex_unlock(&codec->spdif_mutex);
        return change;
}

#define snd_hda_spdif_out_switch_info   snd_ctl_boolean_mono_info

static int snd_hda_spdif_out_switch_get(struct snd_kcontrol *kcontrol,
                                        struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);

        ucontrol->value.integer.value[0] = codec->spdif_ctls & AC_DIG1_ENABLE;
        return 0;
}

static int snd_hda_spdif_out_switch_put(struct snd_kcontrol *kcontrol,
                                        struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = kcontrol->private_value;
        unsigned short val;
        int change;

        mutex_lock(&codec->spdif_mutex);
        val = codec->spdif_ctls & ~AC_DIG1_ENABLE;
        if (ucontrol->value.integer.value[0])
                val |= AC_DIG1_ENABLE;
        change = codec->spdif_ctls != val;
        if (change) {
                codec->spdif_ctls = val;
                set_dig_out_convert(codec, nid, val & 0xff, -1);
                /* unmute amp switch (if any) */
                if ((get_wcaps(codec, nid) & AC_WCAP_OUT_AMP) &&
                    (val & AC_DIG1_ENABLE))
                        snd_hda_codec_amp_stereo(codec, nid, HDA_OUTPUT, 0,
                                                 HDA_AMP_MUTE, 0);
        }
        mutex_unlock(&codec->spdif_mutex);
        return change;
}

static struct snd_kcontrol_new dig_mixes[] = {
        {
                .access = SNDRV_CTL_ELEM_ACCESS_READ,
                .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
                .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, CON_MASK),
                .info = snd_hda_spdif_mask_info,
                .get = snd_hda_spdif_cmask_get,
        },
        {
                .access = SNDRV_CTL_ELEM_ACCESS_READ,
                .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
                .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, PRO_MASK),
                .info = snd_hda_spdif_mask_info,
                .get = snd_hda_spdif_pmask_get,
        },
        {
                .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
                .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, DEFAULT),
                .info = snd_hda_spdif_mask_info,
                .get = snd_hda_spdif_default_get,
                .put = snd_hda_spdif_default_put,
        },
        {
                .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
                .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, SWITCH),
                .info = snd_hda_spdif_out_switch_info,
                .get = snd_hda_spdif_out_switch_get,
                .put = snd_hda_spdif_out_switch_put,
        },
        { } /* end */
};

#define SPDIF_MAX_IDX   4       /* 4 instances should be enough to probe */

/**
 * snd_hda_create_spdif_out_ctls - create Output SPDIF-related controls
 * @codec: the HDA codec
 * @nid: audio out widget NID
 *
 * Creates controls related with the SPDIF output.
 * Called from each patch supporting the SPDIF out.
 *
 * Returns 0 if successful, or a negative error code.
 */
int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid)
{
        int err;
        struct snd_kcontrol *kctl;
        struct snd_kcontrol_new *dig_mix;
        int idx;

        for (idx = 0; idx < SPDIF_MAX_IDX; idx++) {
                if (!_snd_hda_find_mixer_ctl(codec, "IEC958 Playback Switch",
                                             idx))
                        break;
        }
        if (idx >= SPDIF_MAX_IDX) {
                printk(KERN_ERR "hda_codec: too many IEC958 outputs\n");
                return -EBUSY;
        }
        for (dig_mix = dig_mixes; dig_mix->name; dig_mix++) {
                kctl = snd_ctl_new1(dig_mix, codec);
                if (!kctl)
                        return -ENOMEM;
                kctl->id.index = idx;
                kctl->private_value = nid;
                err = snd_hda_ctl_add(codec, nid, kctl);
                if (err < 0)
                        return err;
        }
        codec->spdif_ctls =
                snd_hda_codec_read(codec, nid, 0,
                                   AC_VERB_GET_DIGI_CONVERT_1, 0);
        codec->spdif_status = convert_to_spdif_status(codec->spdif_ctls);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_create_spdif_out_ctls);

/*
 * SPDIF sharing with analog output
 */
static int spdif_share_sw_get(struct snd_kcontrol *kcontrol,
                              struct snd_ctl_elem_value *ucontrol)
{
        struct hda_multi_out *mout = snd_kcontrol_chip(kcontrol);
        ucontrol->value.integer.value[0] = mout->share_spdif;
        return 0;
}

static int spdif_share_sw_put(struct snd_kcontrol *kcontrol,
                              struct snd_ctl_elem_value *ucontrol)
{
        struct hda_multi_out *mout = snd_kcontrol_chip(kcontrol);
        mout->share_spdif = !!ucontrol->value.integer.value[0];
        return 0;
}

static struct snd_kcontrol_new spdif_share_sw = {
        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
        .name = "IEC958 Default PCM Playback Switch",
        .info = snd_ctl_boolean_mono_info,
        .get = spdif_share_sw_get,
        .put = spdif_share_sw_put,
};

/**
 * snd_hda_create_spdif_share_sw - create Default PCM switch
 * @codec: the HDA codec
 * @mout: multi-out instance
 */
int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
                                  struct hda_multi_out *mout)
{
        if (!mout->dig_out_nid)
                return 0;
        /* ATTENTION: here mout is passed as private_data, instead of codec */
        return snd_hda_ctl_add(codec, mout->dig_out_nid,
                              snd_ctl_new1(&spdif_share_sw, mout));
}
EXPORT_SYMBOL_HDA(snd_hda_create_spdif_share_sw);

/*
 * SPDIF input
 */

#define snd_hda_spdif_in_switch_info    snd_hda_spdif_out_switch_info

static int snd_hda_spdif_in_switch_get(struct snd_kcontrol *kcontrol,
                                       struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);

        ucontrol->value.integer.value[0] = codec->spdif_in_enable;
        return 0;
}

static int snd_hda_spdif_in_switch_put(struct snd_kcontrol *kcontrol,
                                       struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = kcontrol->private_value;
        unsigned int val = !!ucontrol->value.integer.value[0];
        int change;

        mutex_lock(&codec->spdif_mutex);
        change = codec->spdif_in_enable != val;
        if (change) {
                codec->spdif_in_enable = val;
                snd_hda_codec_write_cache(codec, nid, 0,
                                          AC_VERB_SET_DIGI_CONVERT_1, val);
        }
        mutex_unlock(&codec->spdif_mutex);
        return change;
}

static int snd_hda_spdif_in_status_get(struct snd_kcontrol *kcontrol,
                                       struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        hda_nid_t nid = kcontrol->private_value;
        unsigned short val;
        unsigned int sbits;

        val = snd_hda_codec_read(codec, nid, 0, AC_VERB_GET_DIGI_CONVERT_1, 0);
        sbits = convert_to_spdif_status(val);
        ucontrol->value.iec958.status[0] = sbits;
        ucontrol->value.iec958.status[1] = sbits >> 8;
        ucontrol->value.iec958.status[2] = sbits >> 16;
        ucontrol->value.iec958.status[3] = sbits >> 24;
        return 0;
}

static struct snd_kcontrol_new dig_in_ctls[] = {
        {
                .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
                .name = SNDRV_CTL_NAME_IEC958("", CAPTURE, SWITCH),
                .info = snd_hda_spdif_in_switch_info,
                .get = snd_hda_spdif_in_switch_get,
                .put = snd_hda_spdif_in_switch_put,
        },
        {
                .access = SNDRV_CTL_ELEM_ACCESS_READ,
                .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
                .name = SNDRV_CTL_NAME_IEC958("", CAPTURE, DEFAULT),
                .info = snd_hda_spdif_mask_info,
                .get = snd_hda_spdif_in_status_get,
        },
        { } /* end */
};

/**
 * snd_hda_create_spdif_in_ctls - create Input SPDIF-related controls
 * @codec: the HDA codec
 * @nid: audio in widget NID
 *
 * Creates controls related with the SPDIF input.
 * Called from each patch supporting the SPDIF in.
 *
 * Returns 0 if successful, or a negative error code.
 */
int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid)
{
        int err;
        struct snd_kcontrol *kctl;
        struct snd_kcontrol_new *dig_mix;
        int idx;

        for (idx = 0; idx < SPDIF_MAX_IDX; idx++) {
                if (!_snd_hda_find_mixer_ctl(codec, "IEC958 Capture Switch",
                                             idx))
                        break;
        }
        if (idx >= SPDIF_MAX_IDX) {
                printk(KERN_ERR "hda_codec: too many IEC958 inputs\n");
                return -EBUSY;
        }
        for (dig_mix = dig_in_ctls; dig_mix->name; dig_mix++) {
                kctl = snd_ctl_new1(dig_mix, codec);
                if (!kctl)
                        return -ENOMEM;
                kctl->private_value = nid;
                err = snd_hda_ctl_add(codec, nid, kctl);
                if (err < 0)
                        return err;
        }
        codec->spdif_in_enable =
                snd_hda_codec_read(codec, nid, 0,
                                   AC_VERB_GET_DIGI_CONVERT_1, 0) &
                AC_DIG1_ENABLE;
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_create_spdif_in_ctls);

#ifdef SND_HDA_NEEDS_RESUME
/*
 * command cache
 */

/* build a 32bit cache key with the widget id and the command parameter */
#define build_cmd_cache_key(nid, verb)  ((verb << 8) | nid)
#define get_cmd_cache_nid(key)          ((key) & 0xff)
#define get_cmd_cache_cmd(key)          (((key) >> 8) & 0xffff)

/**
 * snd_hda_codec_write_cache - send a single command with caching
 * @codec: the HDA codec
 * @nid: NID to send the command
 * @direct: direct flag
 * @verb: the verb to send
 * @parm: the parameter for the verb
 *
 * Send a single command without waiting for response.
 *
 * Returns 0 if successful, or a negative error code.
 */
int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
                              int direct, unsigned int verb, unsigned int parm)
{
        int err = snd_hda_codec_write(codec, nid, direct, verb, parm);
        struct hda_cache_head *c;
        u32 key;

        if (err < 0)
                return err;
        /* parm may contain the verb stuff for get/set amp */
        verb = verb | (parm >> 8);
        parm &= 0xff;
        key = build_cmd_cache_key(nid, verb);
        mutex_lock(&codec->bus->cmd_mutex);
        c = get_alloc_hash(&codec->cmd_cache, key);
        if (c)
                c->val = parm;
        mutex_unlock(&codec->bus->cmd_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_codec_write_cache);

/**
 * snd_hda_codec_update_cache - check cache and write the cmd only when needed
 * @codec: the HDA codec
 * @nid: NID to send the command
 * @direct: direct flag
 * @verb: the verb to send
 * @parm: the parameter for the verb
 *
 * This function works like snd_hda_codec_write_cache(), but it doesn't send
 * command if the parameter is already identical with the cached value.
 * If not, it sends the command and refreshes the cache.
 *
 * Returns 0 if successful, or a negative error code.
 */
int snd_hda_codec_update_cache(struct hda_codec *codec, hda_nid_t nid,
                               int direct, unsigned int verb, unsigned int parm)
{
        struct hda_cache_head *c;
        u32 key;

        /* parm may contain the verb stuff for get/set amp */
        verb = verb | (parm >> 8);
        parm &= 0xff;
        key = build_cmd_cache_key(nid, verb);
        mutex_lock(&codec->bus->cmd_mutex);
        c = get_hash(&codec->cmd_cache, key);
        if (c && c->val == parm) {
                mutex_unlock(&codec->bus->cmd_mutex);
                return 0;
        }
        mutex_unlock(&codec->bus->cmd_mutex);
        return snd_hda_codec_write_cache(codec, nid, direct, verb, parm);
}
EXPORT_SYMBOL_HDA(snd_hda_codec_update_cache);

/**
 * snd_hda_codec_resume_cache - Resume the all commands from the cache
 * @codec: HD-audio codec
 *
 * Execute all verbs recorded in the command caches to resume.
 */
void snd_hda_codec_resume_cache(struct hda_codec *codec)
{
        struct hda_cache_head *buffer = codec->cmd_cache.buf.list;
        int i;

        for (i = 0; i < codec->cmd_cache.buf.used; i++, buffer++) {
                u32 key = buffer->key;
                if (!key)
                        continue;
                snd_hda_codec_write(codec, get_cmd_cache_nid(key), 0,
                                    get_cmd_cache_cmd(key), buffer->val);
        }
}
EXPORT_SYMBOL_HDA(snd_hda_codec_resume_cache);

/**
 * snd_hda_sequence_write_cache - sequence writes with caching
 * @codec: the HDA codec
 * @seq: VERB array to send
 *
 * Send the commands sequentially from the given array.
 * Thte commands are recorded on cache for power-save and resume.
 * The array must be terminated with NID=0.
 */
void snd_hda_sequence_write_cache(struct hda_codec *codec,
                                  const struct hda_verb *seq)
{
        for (; seq->nid; seq++)
                snd_hda_codec_write_cache(codec, seq->nid, 0, seq->verb,
                                          seq->param);
}
EXPORT_SYMBOL_HDA(snd_hda_sequence_write_cache);
#endif /* SND_HDA_NEEDS_RESUME */

/*
 * set power state of the codec
 */
static void hda_set_power_state(struct hda_codec *codec, hda_nid_t fg,
                                unsigned int power_state)
{
        hda_nid_t nid;
        int i;

        /* this delay seems necessary to avoid click noise at power-down */
        if (power_state == AC_PWRST_D3)
                msleep(100);
        snd_hda_codec_read(codec, fg, 0, AC_VERB_SET_POWER_STATE,
                            power_state);
        /* partial workaround for "azx_get_response timeout" */
        if (power_state == AC_PWRST_D0 &&
            (codec->vendor_id & 0xffff0000) == 0x14f10000)
                msleep(10);

        nid = codec->start_nid;
        for (i = 0; i < codec->num_nodes; i++, nid++) {
                unsigned int wcaps = get_wcaps(codec, nid);
                if (wcaps & AC_WCAP_POWER) {
                        unsigned int wid_type = get_wcaps_type(wcaps);
                        if (power_state == AC_PWRST_D3 &&
                            wid_type == AC_WID_PIN) {
                                unsigned int pincap;
                                /*
                                 * don't power down the widget if it controls
                                 * eapd and EAPD_BTLENABLE is set.
                                 */
                                pincap = snd_hda_query_pin_caps(codec, nid);
                                if (pincap & AC_PINCAP_EAPD) {
                                        int eapd = snd_hda_codec_read(codec,
                                                nid, 0,
                                                AC_VERB_GET_EAPD_BTLENABLE, 0);
                                        eapd &= 0x02;
                                        if (eapd)
                                                continue;
                                }
                        }
                        snd_hda_codec_write(codec, nid, 0,
                                            AC_VERB_SET_POWER_STATE,
                                            power_state);
                }
        }

        if (power_state == AC_PWRST_D0) {
                unsigned long end_time;
                int state;
                /* wait until the codec reachs to D0 */
                end_time = jiffies + msecs_to_jiffies(500);
                do {
                        state = snd_hda_codec_read(codec, fg, 0,
                                                   AC_VERB_GET_POWER_STATE, 0);
                        if (state == power_state)
                                break;
                        msleep(1);
                } while (time_after_eq(end_time, jiffies));
        }
}

#ifdef CONFIG_SND_HDA_HWDEP
/* execute additional init verbs */
static void hda_exec_init_verbs(struct hda_codec *codec)
{
        if (codec->init_verbs.list)
                snd_hda_sequence_write(codec, codec->init_verbs.list);
}
#else
static inline void hda_exec_init_verbs(struct hda_codec *codec) {}
#endif

#ifdef SND_HDA_NEEDS_RESUME
/*
 * call suspend and power-down; used both from PM and power-save
 */
static void hda_call_codec_suspend(struct hda_codec *codec)
{
        if (codec->patch_ops.suspend)
                codec->patch_ops.suspend(codec, PMSG_SUSPEND);
        hda_set_power_state(codec,
                            codec->afg ? codec->afg : codec->mfg,
                            AC_PWRST_D3);
#ifdef CONFIG_SND_HDA_POWER_SAVE
        snd_hda_update_power_acct(codec);
        cancel_delayed_work(&codec->power_work);
        codec->power_on = 0;
        codec->power_transition = 0;
        codec->power_jiffies = jiffies;
#endif
}

/*
 * kick up codec; used both from PM and power-save
 */
static void hda_call_codec_resume(struct hda_codec *codec)
{
        hda_set_power_state(codec,
                            codec->afg ? codec->afg : codec->mfg,
                            AC_PWRST_D0);
        restore_pincfgs(codec); /* restore all current pin configs */
        restore_shutup_pins(codec);
        hda_exec_init_verbs(codec);
        if (codec->patch_ops.resume)
                codec->patch_ops.resume(codec);
        else {
                if (codec->patch_ops.init)
                        codec->patch_ops.init(codec);
                snd_hda_codec_resume_amp(codec);
                snd_hda_codec_resume_cache(codec);
        }
}
#endif /* SND_HDA_NEEDS_RESUME */


/**
 * snd_hda_build_controls - build mixer controls
 * @bus: the BUS
 *
 * Creates mixer controls for each codec included in the bus.
 *
 * Returns 0 if successful, otherwise a negative error code.
 */
int /*__devinit*/ snd_hda_build_controls(struct hda_bus *bus)
{
        struct hda_codec *codec;

        list_for_each_entry(codec, &bus->codec_list, list) {
                int err = snd_hda_codec_build_controls(codec);
                if (err < 0) {
                        printk(KERN_ERR "hda_codec: cannot build controls "
                               "for #%d (error %d)\n", codec->addr, err);
                        err = snd_hda_codec_reset(codec);
                        if (err < 0) {
                                printk(KERN_ERR
                                       "hda_codec: cannot revert codec\n");
                                return err;
                        }
                }
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_build_controls);

int snd_hda_codec_build_controls(struct hda_codec *codec)
{
        int err = 0;
        hda_exec_init_verbs(codec);
        /* continue to initialize... */
        if (codec->patch_ops.init)
                err = codec->patch_ops.init(codec);
        if (!err && codec->patch_ops.build_controls)
                err = codec->patch_ops.build_controls(codec);
        if (err < 0)
                return err;
        return 0;
}

/*
 * stream formats
 */
struct hda_rate_tbl {
        unsigned int hz;
        unsigned int alsa_bits;
        unsigned int hda_fmt;
};

/* rate = base * mult / div */
#define HDA_RATE(base, mult, div) \
        (AC_FMT_BASE_##base##K | (((mult) - 1) << AC_FMT_MULT_SHIFT) | \
         (((div) - 1) << AC_FMT_DIV_SHIFT))

static struct hda_rate_tbl rate_bits[] = {
        /* rate in Hz, ALSA rate bitmask, HDA format value */

        /* autodetected value used in snd_hda_query_supported_pcm */
        { 8000, SNDRV_PCM_RATE_8000, HDA_RATE(48, 1, 6) },
        { 11025, SNDRV_PCM_RATE_11025, HDA_RATE(44, 1, 4) },
        { 16000, SNDRV_PCM_RATE_16000, HDA_RATE(48, 1, 3) },
        { 22050, SNDRV_PCM_RATE_22050, HDA_RATE(44, 1, 2) },
        { 32000, SNDRV_PCM_RATE_32000, HDA_RATE(48, 2, 3) },
        { 44100, SNDRV_PCM_RATE_44100, HDA_RATE(44, 1, 1) },
        { 48000, SNDRV_PCM_RATE_48000, HDA_RATE(48, 1, 1) },
        { 88200, SNDRV_PCM_RATE_88200, HDA_RATE(44, 2, 1) },
        { 96000, SNDRV_PCM_RATE_96000, HDA_RATE(48, 2, 1) },
        { 176400, SNDRV_PCM_RATE_176400, HDA_RATE(44, 4, 1) },
        { 192000, SNDRV_PCM_RATE_192000, HDA_RATE(48, 4, 1) },
#define AC_PAR_PCM_RATE_BITS    11
        /* up to bits 10, 384kHZ isn't supported properly */

        /* not autodetected value */
        { 9600, SNDRV_PCM_RATE_KNOT, HDA_RATE(48, 1, 5) },

        { 0 } /* terminator */
};

/**
 * snd_hda_calc_stream_format - calculate format bitset
 * @rate: the sample rate
 * @channels: the number of channels
 * @format: the PCM format (SNDRV_PCM_FORMAT_XXX)
 * @maxbps: the max. bps
 *
 * Calculate the format bitset from the given rate, channels and th PCM format.
 *
 * Return zero if invalid.
 */
unsigned int snd_hda_calc_stream_format(unsigned int rate,
                                        unsigned int channels,
                                        unsigned int format,
                                        unsigned int maxbps,
                                        unsigned short spdif_ctls)
{
        int i;
        unsigned int val = 0;

        for (i = 0; rate_bits[i].hz; i++)
                if (rate_bits[i].hz == rate) {
                        val = rate_bits[i].hda_fmt;
                        break;
                }
        if (!rate_bits[i].hz) {
                snd_printdd("invalid rate %d\n", rate);
                return 0;
        }

        if (channels == 0 || channels > 8) {
                snd_printdd("invalid channels %d\n", channels);
                return 0;
        }
        val |= channels - 1;

        switch (snd_pcm_format_width(format)) {
        case 8:
                val |= AC_FMT_BITS_8;
                break;
        case 16:
                val |= AC_FMT_BITS_16;
                break;
        case 20:
        case 24:
        case 32:
                if (maxbps >= 32 || format == SNDRV_PCM_FORMAT_FLOAT_LE)
                        val |= AC_FMT_BITS_32;
                else if (maxbps >= 24)
                        val |= AC_FMT_BITS_24;
                else
                        val |= AC_FMT_BITS_20;
                break;
        default:
                snd_printdd("invalid format width %d\n",
                            snd_pcm_format_width(format));
                return 0;
        }

        if (spdif_ctls & AC_DIG1_NONAUDIO)
                val |= AC_FMT_TYPE_NON_PCM;

        return val;
}
EXPORT_SYMBOL_HDA(snd_hda_calc_stream_format);

static unsigned int get_pcm_param(struct hda_codec *codec, hda_nid_t nid)
{
        unsigned int val = 0;
        if (nid != codec->afg &&
            (get_wcaps(codec, nid) & AC_WCAP_FORMAT_OVRD))
                val = snd_hda_param_read(codec, nid, AC_PAR_PCM);
        if (!val || val == -1)
                val = snd_hda_param_read(codec, codec->afg, AC_PAR_PCM);
        if (!val || val == -1)
                return 0;
        return val;
}

static unsigned int query_pcm_param(struct hda_codec *codec, hda_nid_t nid)
{
        return query_caps_hash(codec, nid, HDA_HASH_PARPCM_KEY(nid),
                               get_pcm_param);
}

static unsigned int get_stream_param(struct hda_codec *codec, hda_nid_t nid)
{
        unsigned int streams = snd_hda_param_read(codec, nid, AC_PAR_STREAM);
        if (!streams || streams == -1)
                streams = snd_hda_param_read(codec, codec->afg, AC_PAR_STREAM);
        if (!streams || streams == -1)
                return 0;
        return streams;
}

static unsigned int query_stream_param(struct hda_codec *codec, hda_nid_t nid)
{
        return query_caps_hash(codec, nid, HDA_HASH_PARSTR_KEY(nid),
                               get_stream_param);
}

/**
 * snd_hda_query_supported_pcm - query the supported PCM rates and formats
 * @codec: the HDA codec
 * @nid: NID to query
 * @ratesp: the pointer to store the detected rate bitflags
 * @formatsp: the pointer to store the detected formats
 * @bpsp: the pointer to store the detected format widths
 *
 * Queries the supported PCM rates and formats.  The NULL @ratesp, @formatsp
 * or @bsps argument is ignored.
 *
 * Returns 0 if successful, otherwise a negative error code.
 */
static int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
                                u32 *ratesp, u64 *formatsp, unsigned int *bpsp)
{
        unsigned int i, val, wcaps;

        wcaps = get_wcaps(codec, nid);
        val = query_pcm_param(codec, nid);

        if (ratesp) {
                u32 rates = 0;
                for (i = 0; i < AC_PAR_PCM_RATE_BITS; i++) {
                        if (val & (1 << i))
                                rates |= rate_bits[i].alsa_bits;
                }
                if (rates == 0) {
                        snd_printk(KERN_ERR "hda_codec: rates == 0 "
                                   "(nid=0x%x, val=0x%x, ovrd=%i)\n",
                                        nid, val,
                                        (wcaps & AC_WCAP_FORMAT_OVRD) ? 1 : 0);
                        return -EIO;
                }
                *ratesp = rates;
        }

        if (formatsp || bpsp) {
                u64 formats = 0;
                unsigned int streams, bps;

                streams = query_stream_param(codec, nid);
                if (!streams)
                        return -EIO;

                bps = 0;
                if (streams & AC_SUPFMT_PCM) {
                        if (val & AC_SUPPCM_BITS_8) {
                                formats |= SNDRV_PCM_FMTBIT_U8;
                                bps = 8;
                        }
                        if (val & AC_SUPPCM_BITS_16) {
                                formats |= SNDRV_PCM_FMTBIT_S16_LE;
                                bps = 16;
                        }
                        if (wcaps & AC_WCAP_DIGITAL) {
                                if (val & AC_SUPPCM_BITS_32)
                                        formats |= SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE;
                                if (val & (AC_SUPPCM_BITS_20|AC_SUPPCM_BITS_24))
                                        formats |= SNDRV_PCM_FMTBIT_S32_LE;
                                if (val & AC_SUPPCM_BITS_24)
                                        bps = 24;
                                else if (val & AC_SUPPCM_BITS_20)
                                        bps = 20;
                        } else if (val & (AC_SUPPCM_BITS_20|AC_SUPPCM_BITS_24|
                                          AC_SUPPCM_BITS_32)) {
                                formats |= SNDRV_PCM_FMTBIT_S32_LE;
                                if (val & AC_SUPPCM_BITS_32)
                                        bps = 32;
                                else if (val & AC_SUPPCM_BITS_24)
                                        bps = 24;
                                else if (val & AC_SUPPCM_BITS_20)
                                        bps = 20;
                        }
                }
                if (streams & AC_SUPFMT_FLOAT32) {
                        formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
                        if (!bps)
                                bps = 32;
                }
                if (streams == AC_SUPFMT_AC3) {
                        /* should be exclusive */
                        /* temporary hack: we have still no proper support
                         * for the direct AC3 stream...
                         */
                        formats |= SNDRV_PCM_FMTBIT_U8;
                        bps = 8;
                }
                if (formats == 0) {
                        snd_printk(KERN_ERR "hda_codec: formats == 0 "
                                   "(nid=0x%x, val=0x%x, ovrd=%i, "
                                   "streams=0x%x)\n",
                                        nid, val,
                                        (wcaps & AC_WCAP_FORMAT_OVRD) ? 1 : 0,
                                        streams);
                        return -EIO;
                }
                if (formatsp)
                        *formatsp = formats;
                if (bpsp)
                        *bpsp = bps;
        }

        return 0;
}

/**
 * snd_hda_is_supported_format - Check the validity of the format
 * @codec: HD-audio codec
 * @nid: NID to check
 * @format: the HD-audio format value to check
 *
 * Check whether the given node supports the format value.
 *
 * Returns 1 if supported, 0 if not.
 */
int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
                                unsigned int format)
{
        int i;
        unsigned int val = 0, rate, stream;

        val = query_pcm_param(codec, nid);
        if (!val)
                return 0;

        rate = format & 0xff00;
        for (i = 0; i < AC_PAR_PCM_RATE_BITS; i++)
                if (rate_bits[i].hda_fmt == rate) {
                        if (val & (1 << i))
                                break;
                        return 0;
                }
        if (i >= AC_PAR_PCM_RATE_BITS)
                return 0;

        stream = query_stream_param(codec, nid);
        if (!stream)
                return 0;

        if (stream & AC_SUPFMT_PCM) {
                switch (format & 0xf0) {
                case 0x00:
                        if (!(val & AC_SUPPCM_BITS_8))
                                return 0;
                        break;
                case 0x10:
                        if (!(val & AC_SUPPCM_BITS_16))
                                return 0;
                        break;
                case 0x20:
                        if (!(val & AC_SUPPCM_BITS_20))
                                return 0;
                        break;
                case 0x30:
                        if (!(val & AC_SUPPCM_BITS_24))
                                return 0;
                        break;
                case 0x40:
                        if (!(val & AC_SUPPCM_BITS_32))
                                return 0;
                        break;
                default:
                        return 0;
                }
        } else {
                /* FIXME: check for float32 and AC3? */
        }

        return 1;
}
EXPORT_SYMBOL_HDA(snd_hda_is_supported_format);

/*
 * PCM stuff
 */
static int hda_pcm_default_open_close(struct hda_pcm_stream *hinfo,
                                      struct hda_codec *codec,
                                      struct snd_pcm_substream *substream)
{
        return 0;
}

static int hda_pcm_default_prepare(struct hda_pcm_stream *hinfo,
                                   struct hda_codec *codec,
                                   unsigned int stream_tag,
                                   unsigned int format,
                                   struct snd_pcm_substream *substream)
{
        snd_hda_codec_setup_stream(codec, hinfo->nid, stream_tag, 0, format);
        return 0;
}

static int hda_pcm_default_cleanup(struct hda_pcm_stream *hinfo,
                                   struct hda_codec *codec,
                                   struct snd_pcm_substream *substream)
{
        snd_hda_codec_cleanup_stream(codec, hinfo->nid);
        return 0;
}

static int set_pcm_default_values(struct hda_codec *codec,
                                  struct hda_pcm_stream *info)
{
        int err;

        /* query support PCM information from the given NID */
        if (info->nid && (!info->rates || !info->formats)) {
                err = snd_hda_query_supported_pcm(codec, info->nid,
                                info->rates ? NULL : &info->rates,
                                info->formats ? NULL : &info->formats,
                                info->maxbps ? NULL : &info->maxbps);
                if (err < 0)
                        return err;
        }
        if (info->ops.open == NULL)
                info->ops.open = hda_pcm_default_open_close;
        if (info->ops.close == NULL)
                info->ops.close = hda_pcm_default_open_close;
        if (info->ops.prepare == NULL) {
                if (snd_BUG_ON(!info->nid))
                        return -EINVAL;
                info->ops.prepare = hda_pcm_default_prepare;
        }
        if (info->ops.cleanup == NULL) {
                if (snd_BUG_ON(!info->nid))
                        return -EINVAL;
                info->ops.cleanup = hda_pcm_default_cleanup;
        }
        return 0;
}

/* global */
const char *snd_hda_pcm_type_name[HDA_PCM_NTYPES] = {
        "Audio", "SPDIF", "HDMI", "Modem"
};

/*
 * get the empty PCM device number to assign
 *
 * note the max device number is limited by HDA_MAX_PCMS, currently 10
 */
static int get_empty_pcm_device(struct hda_bus *bus, int type)
{
        /* audio device indices; not linear to keep compatibility */
        static int audio_idx[HDA_PCM_NTYPES][5] = {
                [HDA_PCM_TYPE_AUDIO] = { 0, 2, 4, 5, -1 },
                [HDA_PCM_TYPE_SPDIF] = { 1, -1 },
                [HDA_PCM_TYPE_HDMI]  = { 3, 7, 8, 9, -1 },
                [HDA_PCM_TYPE_MODEM] = { 6, -1 },
        };
        int i;

        if (type >= HDA_PCM_NTYPES) {
                snd_printk(KERN_WARNING "Invalid PCM type %d\n", type);
                return -EINVAL;
        }

        for (i = 0; audio_idx[type][i] >= 0 ; i++)
                if (!test_and_set_bit(audio_idx[type][i], bus->pcm_dev_bits))
                        return audio_idx[type][i];

        snd_printk(KERN_WARNING "Too many %s devices\n",
                snd_hda_pcm_type_name[type]);
        return -EAGAIN;
}

/*
 * attach a new PCM stream
 */
static int snd_hda_attach_pcm(struct hda_codec *codec, struct hda_pcm *pcm)
{
        struct hda_bus *bus = codec->bus;
        struct hda_pcm_stream *info;
        int stream, err;

        if (snd_BUG_ON(!pcm->name))
                return -EINVAL;
        for (stream = 0; stream < 2; stream++) {
                info = &pcm->stream[stream];
                if (info->substreams) {
                        err = set_pcm_default_values(codec, info);
                        if (err < 0)
                                return err;
                }
        }
        return bus->ops.attach_pcm(bus, codec, pcm);
}

/* assign all PCMs of the given codec */
int snd_hda_codec_build_pcms(struct hda_codec *codec)
{
        unsigned int pcm;
        int err;

        if (!codec->num_pcms) {
                if (!codec->patch_ops.build_pcms)
                        return 0;
                err = codec->patch_ops.build_pcms(codec);
                if (err < 0) {
                        printk(KERN_ERR "hda_codec: cannot build PCMs"
                               "for #%d (error %d)\n", codec->addr, err);
                        err = snd_hda_codec_reset(codec);
                        if (err < 0) {
                                printk(KERN_ERR
                                       "hda_codec: cannot revert codec\n");
                                return err;
                        }
                }
        }
        for (pcm = 0; pcm < codec->num_pcms; pcm++) {
                struct hda_pcm *cpcm = &codec->pcm_info[pcm];
                int dev;

                if (!cpcm->stream[0].substreams && !cpcm->stream[1].substreams)
                        continue; /* no substreams assigned */

                if (!cpcm->pcm) {
                        dev = get_empty_pcm_device(codec->bus, cpcm->pcm_type);
                        if (dev < 0)
                                continue; /* no fatal error */
                        cpcm->device = dev;
                        err = snd_hda_attach_pcm(codec, cpcm);
                        if (err < 0) {
                                printk(KERN_ERR "hda_codec: cannot attach "
                                       "PCM stream %d for codec #%d\n",
                                       dev, codec->addr);
                                continue; /* no fatal error */
                        }
                }
        }
        return 0;
}

/**
 * snd_hda_build_pcms - build PCM information
 * @bus: the BUS
 *
 * Create PCM information for each codec included in the bus.
 *
 * The build_pcms codec patch is requested to set up codec->num_pcms and
 * codec->pcm_info properly.  The array is referred by the top-level driver
 * to create its PCM instances.
 * The allocated codec->pcm_info should be released in codec->patch_ops.free
 * callback.
 *
 * At least, substreams, channels_min and channels_max must be filled for
 * each stream.  substreams = 0 indicates that the stream doesn't exist.
 * When rates and/or formats are zero, the supported values are queried
 * from the given nid.  The nid is used also by the default ops.prepare
 * and ops.cleanup callbacks.
 *
 * The driver needs to call ops.open in its open callback.  Similarly,
 * ops.close is supposed to be called in the close callback.
 * ops.prepare should be called in the prepare or hw_params callback
 * with the proper parameters for set up.
 * ops.cleanup should be called in hw_free for clean up of streams.
 *
 * This function returns 0 if successfull, or a negative error code.
 */
int __devinit snd_hda_build_pcms(struct hda_bus *bus)
{
        struct hda_codec *codec;

        list_for_each_entry(codec, &bus->codec_list, list) {
                int err = snd_hda_codec_build_pcms(codec);
                if (err < 0)
                        return err;
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_build_pcms);

/**
 * snd_hda_check_board_config - compare the current codec with the config table
 * @codec: the HDA codec
 * @num_configs: number of config enums
 * @models: array of model name strings
 * @tbl: configuration table, terminated by null entries
 *
 * Compares the modelname or PCI subsystem id of the current codec with the
 * given configuration table.  If a matching entry is found, returns its
 * config value (supposed to be 0 or positive).
 *
 * If no entries are matching, the function returns a negative value.
 */
int snd_hda_check_board_config(struct hda_codec *codec,
                               int num_configs, const char **models,
                               const struct snd_pci_quirk *tbl)
{
        if (codec->modelname && models) {
                int i;
                for (i = 0; i < num_configs; i++) {
                        if (models[i] &&
                            !strcmp(codec->modelname, models[i])) {
                                snd_printd(KERN_INFO "hda_codec: model '%s' is "
                                           "selected\n", models[i]);
                                return i;
                        }
                }
        }

        if (!codec->bus->pci || !tbl)
                return -1;

        tbl = snd_pci_quirk_lookup(codec->bus->pci, tbl);
        if (!tbl)
                return -1;
        if (tbl->value >= 0 && tbl->value < num_configs) {
#ifdef CONFIG_SND_DEBUG_VERBOSE
                char tmp[10];
                const char *model = NULL;
                if (models)
                        model = models[tbl->value];
                if (!model) {
                        sprintf(tmp, "#%d", tbl->value);
                        model = tmp;
                }
                snd_printdd(KERN_INFO "hda_codec: model '%s' is selected "
                            "for config %x:%x (%s)\n",
                            model, tbl->subvendor, tbl->subdevice,
                            (tbl->name ? tbl->name : "Unknown device"));
#endif
                return tbl->value;
        }
        return -1;
}
EXPORT_SYMBOL_HDA(snd_hda_check_board_config);

/**
 * snd_hda_check_board_codec_sid_config - compare the current codec
                                        subsystem ID with the
                                        config table

           This is important for Gateway notebooks with SB450 HDA Audio
           where the vendor ID of the PCI device is:
                ATI Technologies Inc SB450 HDA Audio [1002:437b]
           and the vendor/subvendor are found only at the codec.

 * @codec: the HDA codec
 * @num_configs: number of config enums
 * @models: array of model name strings
 * @tbl: configuration table, terminated by null entries
 *
 * Compares the modelname or PCI subsystem id of the current codec with the
 * given configuration table.  If a matching entry is found, returns its
 * config value (supposed to be 0 or positive).
 *
 * If no entries are matching, the function returns a negative value.
 */
int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
                               int num_configs, const char **models,
                               const struct snd_pci_quirk *tbl)
{
        const struct snd_pci_quirk *q;

        /* Search for codec ID */
        for (q = tbl; q->subvendor; q++) {
                unsigned long vendorid = (q->subdevice) | (q->subvendor << 16);

                if (vendorid == codec->subsystem_id)
                        break;
        }

        if (!q->subvendor)
                return -1;

        tbl = q;

        if (tbl->value >= 0 && tbl->value < num_configs) {
#ifdef CONFIG_SND_DEBUG_VERBOSE
                char tmp[10];
                const char *model = NULL;
                if (models)
                        model = models[tbl->value];
                if (!model) {
                        sprintf(tmp, "#%d", tbl->value);
                        model = tmp;
                }
                snd_printdd(KERN_INFO "hda_codec: model '%s' is selected "
                            "for config %x:%x (%s)\n",
                            model, tbl->subvendor, tbl->subdevice,
                            (tbl->name ? tbl->name : "Unknown device"));
#endif
                return tbl->value;
        }
        return -1;
}
EXPORT_SYMBOL_HDA(snd_hda_check_board_codec_sid_config);

/**
 * snd_hda_add_new_ctls - create controls from the array
 * @codec: the HDA codec
 * @knew: the array of struct snd_kcontrol_new
 *
 * This helper function creates and add new controls in the given array.
 * The array must be terminated with an empty entry as terminator.
 *
 * Returns 0 if successful, or a negative error code.
 */
int snd_hda_add_new_ctls(struct hda_codec *codec, struct snd_kcontrol_new *knew)
{
        int err;

        for (; knew->name; knew++) {
                struct snd_kcontrol *kctl;
                if (knew->iface == -1)  /* skip this codec private value */
                        continue;
                kctl = snd_ctl_new1(knew, codec);
                if (!kctl)
                        return -ENOMEM;
                err = snd_hda_ctl_add(codec, 0, kctl);
                if (err < 0) {
                        if (!codec->addr)
                                return err;
                        kctl = snd_ctl_new1(knew, codec);
                        if (!kctl)
                                return -ENOMEM;
                        kctl->id.device = codec->addr;
                        err = snd_hda_ctl_add(codec, 0, kctl);
                        if (err < 0)
                                return err;
                }
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_add_new_ctls);

#ifdef CONFIG_SND_HDA_POWER_SAVE
static void hda_set_power_state(struct hda_codec *codec, hda_nid_t fg,
                                unsigned int power_state);

static void hda_power_work(struct work_struct *work)
{
        struct hda_codec *codec =
                container_of(work, struct hda_codec, power_work.work);
        struct hda_bus *bus = codec->bus;

        if (!codec->power_on || codec->power_count) {
                codec->power_transition = 0;
                return;
        }

        hda_call_codec_suspend(codec);
        if (bus->ops.pm_notify)
                bus->ops.pm_notify(bus);
}

static void hda_keep_power_on(struct hda_codec *codec)
{
        codec->power_count++;
        codec->power_on = 1;
        codec->power_jiffies = jiffies;
}

/* update the power on/off account with the current jiffies */
void snd_hda_update_power_acct(struct hda_codec *codec)
{
        unsigned long delta = jiffies - codec->power_jiffies;
        if (codec->power_on)
                codec->power_on_acct += delta;
        else
                codec->power_off_acct += delta;
        codec->power_jiffies += delta;
}

/**
 * snd_hda_power_up - Power-up the codec
 * @codec: HD-audio codec
 *
 * Increment the power-up counter and power up the hardware really when
 * not turned on yet.
 */
void snd_hda_power_up(struct hda_codec *codec)
{
        struct hda_bus *bus = codec->bus;

        codec->power_count++;
        if (codec->power_on || codec->power_transition)
                return;

        snd_hda_update_power_acct(codec);
        codec->power_on = 1;
        codec->power_jiffies = jiffies;
        if (bus->ops.pm_notify)
                bus->ops.pm_notify(bus);
        hda_call_codec_resume(codec);
        cancel_delayed_work(&codec->power_work);
        codec->power_transition = 0;
}
EXPORT_SYMBOL_HDA(snd_hda_power_up);

#define power_save(codec)       \
        ((codec)->bus->power_save ? *(codec)->bus->power_save : 0)

/**
 * snd_hda_power_down - Power-down the codec
 * @codec: HD-audio codec
 *
 * Decrement the power-up counter and schedules the power-off work if
 * the counter rearches to zero.
 */
void snd_hda_power_down(struct hda_codec *codec)
{
        --codec->power_count;
        if (!codec->power_on || codec->power_count || codec->power_transition)
                return;
        if (power_save(codec)) {
                codec->power_transition = 1; /* avoid reentrance */
                queue_delayed_work(codec->bus->workq, &codec->power_work,
                                msecs_to_jiffies(power_save(codec) * 1000));
        }
}
EXPORT_SYMBOL_HDA(snd_hda_power_down);

/**
 * snd_hda_check_amp_list_power - Check the amp list and update the power
 * @codec: HD-audio codec
 * @check: the object containing an AMP list and the status
 * @nid: NID to check / update
 *
 * Check whether the given NID is in the amp list.  If it's in the list,
 * check the current AMP status, and update the the power-status according
 * to the mute status.
 *
 * This function is supposed to be set or called from the check_power_status
 * patch ops.
 */
int snd_hda_check_amp_list_power(struct hda_codec *codec,
                                 struct hda_loopback_check *check,
                                 hda_nid_t nid)
{
        struct hda_amp_list *p;
        int ch, v;

        if (!check->amplist)
                return 0;
        for (p = check->amplist; p->nid; p++) {
                if (p->nid == nid)
                        break;
        }
        if (!p->nid)
                return 0; /* nothing changed */

        for (p = check->amplist; p->nid; p++) {
                for (ch = 0; ch < 2; ch++) {
                        v = snd_hda_codec_amp_read(codec, p->nid, ch, p->dir,
                                                   p->idx);
                        if (!(v & HDA_AMP_MUTE) && v > 0) {
                                if (!check->power_on) {
                                        check->power_on = 1;
                                        snd_hda_power_up(codec);
                                }
                                return 1;
                        }
                }
        }
        if (check->power_on) {
                check->power_on = 0;
                snd_hda_power_down(codec);
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_check_amp_list_power);
#endif

/*
 * Channel mode helper
 */

/**
 * snd_hda_ch_mode_info - Info callback helper for the channel mode enum
 */
int snd_hda_ch_mode_info(struct hda_codec *codec,
                         struct snd_ctl_elem_info *uinfo,
                         const struct hda_channel_mode *chmode,
                         int num_chmodes)
{
        uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
        uinfo->count = 1;
        uinfo->value.enumerated.items = num_chmodes;
        if (uinfo->value.enumerated.item >= num_chmodes)
                uinfo->value.enumerated.item = num_chmodes - 1;
        sprintf(uinfo->value.enumerated.name, "%dch",
                chmode[uinfo->value.enumerated.item].channels);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_ch_mode_info);

/**
 * snd_hda_ch_mode_get - Get callback helper for the channel mode enum
 */
int snd_hda_ch_mode_get(struct hda_codec *codec,
                        struct snd_ctl_elem_value *ucontrol,
                        const struct hda_channel_mode *chmode,
                        int num_chmodes,
                        int max_channels)
{
        int i;

        for (i = 0; i < num_chmodes; i++) {
                if (max_channels == chmode[i].channels) {
                        ucontrol->value.enumerated.item[0] = i;
                        break;
                }
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_ch_mode_get);

/**
 * snd_hda_ch_mode_put - Put callback helper for the channel mode enum
 */
int snd_hda_ch_mode_put(struct hda_codec *codec,
                        struct snd_ctl_elem_value *ucontrol,
                        const struct hda_channel_mode *chmode,
                        int num_chmodes,
                        int *max_channelsp)
{
        unsigned int mode;

        mode = ucontrol->value.enumerated.item[0];
        if (mode >= num_chmodes)
                return -EINVAL;
        if (*max_channelsp == chmode[mode].channels)
                return 0;
        /* change the current channel setting */
        *max_channelsp = chmode[mode].channels;
        if (chmode[mode].sequence)
                snd_hda_sequence_write_cache(codec, chmode[mode].sequence);
        return 1;
}
EXPORT_SYMBOL_HDA(snd_hda_ch_mode_put);

/*
 * input MUX helper
 */

/**
 * snd_hda_input_mux_info_info - Info callback helper for the input-mux enum
 */
int snd_hda_input_mux_info(const struct hda_input_mux *imux,
                           struct snd_ctl_elem_info *uinfo)
{
        unsigned int index;

        uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
        uinfo->count = 1;
        uinfo->value.enumerated.items = imux->num_items;
        if (!imux->num_items)
                return 0;
        index = uinfo->value.enumerated.item;
        if (index >= imux->num_items)
                index = imux->num_items - 1;
        strcpy(uinfo->value.enumerated.name, imux->items[index].label);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_input_mux_info);

/**
 * snd_hda_input_mux_info_put - Put callback helper for the input-mux enum
 */
int snd_hda_input_mux_put(struct hda_codec *codec,
                          const struct hda_input_mux *imux,
                          struct snd_ctl_elem_value *ucontrol,
                          hda_nid_t nid,
                          unsigned int *cur_val)
{
        unsigned int idx;

        if (!imux->num_items)
                return 0;
        idx = ucontrol->value.enumerated.item[0];
        if (idx >= imux->num_items)
                idx = imux->num_items - 1;
        if (*cur_val == idx)
                return 0;
        snd_hda_codec_write_cache(codec, nid, 0, AC_VERB_SET_CONNECT_SEL,
                                  imux->items[idx].index);
        *cur_val = idx;
        return 1;
}
EXPORT_SYMBOL_HDA(snd_hda_input_mux_put);


/*
 * Multi-channel / digital-out PCM helper functions
 */

/* setup SPDIF output stream */
static void setup_dig_out_stream(struct hda_codec *codec, hda_nid_t nid,
                                 unsigned int stream_tag, unsigned int format)
{
        /* turn off SPDIF once; otherwise the IEC958 bits won't be updated */
        if (codec->spdif_status_reset && (codec->spdif_ctls & AC_DIG1_ENABLE))
                set_dig_out_convert(codec, nid,
                                    codec->spdif_ctls & ~AC_DIG1_ENABLE & 0xff,
                                    -1);
        snd_hda_codec_setup_stream(codec, nid, stream_tag, 0, format);
        if (codec->slave_dig_outs) {
                hda_nid_t *d;
                for (d = codec->slave_dig_outs; *d; d++)
                        snd_hda_codec_setup_stream(codec, *d, stream_tag, 0,
                                                   format);
        }
        /* turn on again (if needed) */
        if (codec->spdif_status_reset && (codec->spdif_ctls & AC_DIG1_ENABLE))
                set_dig_out_convert(codec, nid,
                                    codec->spdif_ctls & 0xff, -1);
}

static void cleanup_dig_out_stream(struct hda_codec *codec, hda_nid_t nid)
{
        snd_hda_codec_cleanup_stream(codec, nid);
        if (codec->slave_dig_outs) {
                hda_nid_t *d;
                for (d = codec->slave_dig_outs; *d; d++)
                        snd_hda_codec_cleanup_stream(codec, *d);
        }
}

/**
 * snd_hda_bus_reboot_notify - call the reboot notifier of each codec
 * @bus: HD-audio bus
 */
void snd_hda_bus_reboot_notify(struct hda_bus *bus)
{
        struct hda_codec *codec;

        if (!bus)
                return;
        list_for_each_entry(codec, &bus->codec_list, list) {
#ifdef CONFIG_SND_HDA_POWER_SAVE
                if (!codec->power_on)
                        continue;
#endif
                if (codec->patch_ops.reboot_notify)
                        codec->patch_ops.reboot_notify(codec);
        }
}
EXPORT_SYMBOL_HDA(snd_hda_bus_reboot_notify);

/**
 * snd_hda_multi_out_dig_open - open the digital out in the exclusive mode
 */
int snd_hda_multi_out_dig_open(struct hda_codec *codec,
                               struct hda_multi_out *mout)
{
        mutex_lock(&codec->spdif_mutex);
        if (mout->dig_out_used == HDA_DIG_ANALOG_DUP)
                /* already opened as analog dup; reset it once */
                cleanup_dig_out_stream(codec, mout->dig_out_nid);
        mout->dig_out_used = HDA_DIG_EXCLUSIVE;
        mutex_unlock(&codec->spdif_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_multi_out_dig_open);

/**
 * snd_hda_multi_out_dig_prepare - prepare the digital out stream
 */
int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
                                  struct hda_multi_out *mout,
                                  unsigned int stream_tag,
                                  unsigned int format,
                                  struct snd_pcm_substream *substream)
{
        mutex_lock(&codec->spdif_mutex);
        setup_dig_out_stream(codec, mout->dig_out_nid, stream_tag, format);
        mutex_unlock(&codec->spdif_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_multi_out_dig_prepare);

/**
 * snd_hda_multi_out_dig_cleanup - clean-up the digital out stream
 */
int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
                                  struct hda_multi_out *mout)
{
        mutex_lock(&codec->spdif_mutex);
        cleanup_dig_out_stream(codec, mout->dig_out_nid);
        mutex_unlock(&codec->spdif_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_multi_out_dig_cleanup);

/**
 * snd_hda_multi_out_dig_close - release the digital out stream
 */
int snd_hda_multi_out_dig_close(struct hda_codec *codec,
                                struct hda_multi_out *mout)
{
        mutex_lock(&codec->spdif_mutex);
        mout->dig_out_used = 0;
        mutex_unlock(&codec->spdif_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_multi_out_dig_close);

/**
 * snd_hda_multi_out_analog_open - open analog outputs
 *
 * Open analog outputs and set up the hw-constraints.
 * If the digital outputs can be opened as slave, open the digital
 * outputs, too.
 */
int snd_hda_multi_out_analog_open(struct hda_codec *codec,
                                  struct hda_multi_out *mout,
                                  struct snd_pcm_substream *substream,
                                  struct hda_pcm_stream *hinfo)
{
        struct snd_pcm_runtime *runtime = substream->runtime;
        runtime->hw.channels_max = mout->max_channels;
        if (mout->dig_out_nid) {
                if (!mout->analog_rates) {
                        mout->analog_rates = hinfo->rates;
                        mout->analog_formats = hinfo->formats;
                        mout->analog_maxbps = hinfo->maxbps;
                } else {
                        runtime->hw.rates = mout->analog_rates;
                        runtime->hw.formats = mout->analog_formats;
                        hinfo->maxbps = mout->analog_maxbps;
                }
                if (!mout->spdif_rates) {
                        snd_hda_query_supported_pcm(codec, mout->dig_out_nid,
                                                    &mout->spdif_rates,
                                                    &mout->spdif_formats,
                                                    &mout->spdif_maxbps);
                }
                mutex_lock(&codec->spdif_mutex);
                if (mout->share_spdif) {
                        if ((runtime->hw.rates & mout->spdif_rates) &&
                            (runtime->hw.formats & mout->spdif_formats)) {
                                runtime->hw.rates &= mout->spdif_rates;
                                runtime->hw.formats &= mout->spdif_formats;
                                if (mout->spdif_maxbps < hinfo->maxbps)
                                        hinfo->maxbps = mout->spdif_maxbps;
                        } else {
                                mout->share_spdif = 0;
                                /* FIXME: need notify? */
                        }
                }
                mutex_unlock(&codec->spdif_mutex);
        }
        return snd_pcm_hw_constraint_step(substream->runtime, 0,
                                          SNDRV_PCM_HW_PARAM_CHANNELS, 2);
}
EXPORT_SYMBOL_HDA(snd_hda_multi_out_analog_open);

/**
 * snd_hda_multi_out_analog_prepare - Preapre the analog outputs.
 *
 * Set up the i/o for analog out.
 * When the digital out is available, copy the front out to digital out, too.
 */
int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
                                     struct hda_multi_out *mout,
                                     unsigned int stream_tag,
                                     unsigned int format,
                                     struct snd_pcm_substream *substream)
{
        hda_nid_t *nids = mout->dac_nids;
        int chs = substream->runtime->channels;
        int i;

        mutex_lock(&codec->spdif_mutex);
        if (mout->dig_out_nid && mout->share_spdif &&
            mout->dig_out_used != HDA_DIG_EXCLUSIVE) {
                if (chs == 2 &&
                    snd_hda_is_supported_format(codec, mout->dig_out_nid,
                                                format) &&
                    !(codec->spdif_status & IEC958_AES0_NONAUDIO)) {
                        mout->dig_out_used = HDA_DIG_ANALOG_DUP;
                        setup_dig_out_stream(codec, mout->dig_out_nid,
                                             stream_tag, format);
                } else {
                        mout->dig_out_used = 0;
                        cleanup_dig_out_stream(codec, mout->dig_out_nid);
                }
        }
        mutex_unlock(&codec->spdif_mutex);

        /* front */
        snd_hda_codec_setup_stream(codec, nids[HDA_FRONT], stream_tag,
                                   0, format);
        if (!mout->no_share_stream &&
            mout->hp_nid && mout->hp_nid != nids[HDA_FRONT])
                /* headphone out will just decode front left/right (stereo) */
                snd_hda_codec_setup_stream(codec, mout->hp_nid, stream_tag,
                                           0, format);
        /* extra outputs copied from front */
        for (i = 0; i < ARRAY_SIZE(mout->extra_out_nid); i++)
                if (!mout->no_share_stream && mout->extra_out_nid[i])
                        snd_hda_codec_setup_stream(codec,
                                                   mout->extra_out_nid[i],
                                                   stream_tag, 0, format);

        /* surrounds */
        for (i = 1; i < mout->num_dacs; i++) {
                if (chs >= (i + 1) * 2) /* independent out */
                        snd_hda_codec_setup_stream(codec, nids[i], stream_tag,
                                                   i * 2, format);
                else if (!mout->no_share_stream) /* copy front */
                        snd_hda_codec_setup_stream(codec, nids[i], stream_tag,
                                                   0, format);
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_multi_out_analog_prepare);

/**
 * snd_hda_multi_out_analog_cleanup - clean up the setting for analog out
 */
int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
                                     struct hda_multi_out *mout)
{
        hda_nid_t *nids = mout->dac_nids;
        int i;

        for (i = 0; i < mout->num_dacs; i++)
                snd_hda_codec_cleanup_stream(codec, nids[i]);
        if (mout->hp_nid)
                snd_hda_codec_cleanup_stream(codec, mout->hp_nid);
        for (i = 0; i < ARRAY_SIZE(mout->extra_out_nid); i++)
                if (mout->extra_out_nid[i])
                        snd_hda_codec_cleanup_stream(codec,
                                                     mout->extra_out_nid[i]);
        mutex_lock(&codec->spdif_mutex);
        if (mout->dig_out_nid && mout->dig_out_used == HDA_DIG_ANALOG_DUP) {
                cleanup_dig_out_stream(codec, mout->dig_out_nid);
                mout->dig_out_used = 0;
        }
        mutex_unlock(&codec->spdif_mutex);
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_multi_out_analog_cleanup);

/*
 * Helper for automatic pin configuration
 */

static int is_in_nid_list(hda_nid_t nid, hda_nid_t *list)
{
        for (; *list; list++)
                if (*list == nid)
                        return 1;
        return 0;
}


/*
 * Sort an associated group of pins according to their sequence numbers.
 */
static void sort_pins_by_sequence(hda_nid_t *pins, short *sequences,
                                  int num_pins)
{
        int i, j;
        short seq;
        hda_nid_t nid;

        for (i = 0; i < num_pins; i++) {
                for (j = i + 1; j < num_pins; j++) {
                        if (sequences[i] > sequences[j]) {
                                seq = sequences[i];
                                sequences[i] = sequences[j];
                                sequences[j] = seq;
                                nid = pins[i];
                                pins[i] = pins[j];
                                pins[j] = nid;
                        }
                }
        }
}


/*
 * Parse all pin widgets and store the useful pin nids to cfg
 *
 * The number of line-outs or any primary output is stored in line_outs,
 * and the corresponding output pins are assigned to line_out_pins[],
 * in the order of front, rear, CLFE, side, ...
 *
 * If more extra outputs (speaker and headphone) are found, the pins are
 * assisnged to hp_pins[] and speaker_pins[], respectively.  If no line-out jack
 * is detected, one of speaker of HP pins is assigned as the primary
 * output, i.e. to line_out_pins[0].  So, line_outs is always positive
 * if any analog output exists.
 *
 * The analog input pins are assigned to input_pins array.
 * The digital input/output pins are assigned to dig_in_pin and dig_out_pin,
 * respectively.
 */
int snd_hda_parse_pin_def_config(struct hda_codec *codec,
                                 struct auto_pin_cfg *cfg,
                                 hda_nid_t *ignore_nids)
{
        hda_nid_t nid, end_nid;
        short seq, assoc_line_out, assoc_speaker;
        short sequences_line_out[ARRAY_SIZE(cfg->line_out_pins)];
        short sequences_speaker[ARRAY_SIZE(cfg->speaker_pins)];
        short sequences_hp[ARRAY_SIZE(cfg->hp_pins)];

        memset(cfg, 0, sizeof(*cfg));

        memset(sequences_line_out, 0, sizeof(sequences_line_out));
        memset(sequences_speaker, 0, sizeof(sequences_speaker));
        memset(sequences_hp, 0, sizeof(sequences_hp));
        assoc_line_out = assoc_speaker = 0;

        end_nid = codec->start_nid + codec->num_nodes;
        for (nid = codec->start_nid; nid < end_nid; nid++) {
                unsigned int wid_caps = get_wcaps(codec, nid);
                unsigned int wid_type = get_wcaps_type(wid_caps);
                unsigned int def_conf;
                short assoc, loc;

                /* read all default configuration for pin complex */
                if (wid_type != AC_WID_PIN)
                        continue;
                /* ignore the given nids (e.g. pc-beep returns error) */
                if (ignore_nids && is_in_nid_list(nid, ignore_nids))
                        continue;

                def_conf = snd_hda_codec_get_pincfg(codec, nid);
                if (get_defcfg_connect(def_conf) == AC_JACK_PORT_NONE)
                        continue;
                loc = get_defcfg_location(def_conf);
                switch (get_defcfg_device(def_conf)) {
                case AC_JACK_LINE_OUT:
                        seq = get_defcfg_sequence(def_conf);
                        assoc = get_defcfg_association(def_conf);

                        if (!(wid_caps & AC_WCAP_STEREO))
                                if (!cfg->mono_out_pin)
                                        cfg->mono_out_pin = nid;
                        if (!assoc)
                                continue;
                        if (!assoc_line_out)
                                assoc_line_out = assoc;
                        else if (assoc_line_out != assoc)
                                continue;
                        if (cfg->line_outs >= ARRAY_SIZE(cfg->line_out_pins))
                                continue;
                        cfg->line_out_pins[cfg->line_outs] = nid;
                        sequences_line_out[cfg->line_outs] = seq;
                        cfg->line_outs++;
                        break;
                case AC_JACK_SPEAKER:
                        seq = get_defcfg_sequence(def_conf);
                        assoc = get_defcfg_association(def_conf);
                        if (!assoc)
                                continue;
                        if (!assoc_speaker)
                                assoc_speaker = assoc;
                        else if (assoc_speaker != assoc)
                                continue;
                        if (cfg->speaker_outs >= ARRAY_SIZE(cfg->speaker_pins))
                                continue;
                        cfg->speaker_pins[cfg->speaker_outs] = nid;
                        sequences_speaker[cfg->speaker_outs] = seq;
                        cfg->speaker_outs++;
                        break;
                case AC_JACK_HP_OUT:
                        seq = get_defcfg_sequence(def_conf);
                        assoc = get_defcfg_association(def_conf);
                        if (cfg->hp_outs >= ARRAY_SIZE(cfg->hp_pins))
                                continue;
                        cfg->hp_pins[cfg->hp_outs] = nid;
                        sequences_hp[cfg->hp_outs] = (assoc << 4) | seq;
                        cfg->hp_outs++;
                        break;
                case AC_JACK_MIC_IN: {
                        int preferred, alt;
                        if (loc == AC_JACK_LOC_FRONT ||
                            (loc & 0x30) == AC_JACK_LOC_INTERNAL) {
                                preferred = AUTO_PIN_FRONT_MIC;
                                alt = AUTO_PIN_MIC;
                        } else {
                                preferred = AUTO_PIN_MIC;
                                alt = AUTO_PIN_FRONT_MIC;
                        }
                        if (!cfg->input_pins[preferred])
                                cfg->input_pins[preferred] = nid;
                        else if (!cfg->input_pins[alt])
                                cfg->input_pins[alt] = nid;
                        break;
                }
                case AC_JACK_LINE_IN:
                        if (loc == AC_JACK_LOC_FRONT)
                                cfg->input_pins[AUTO_PIN_FRONT_LINE] = nid;
                        else
                                cfg->input_pins[AUTO_PIN_LINE] = nid;
                        break;
                case AC_JACK_CD:
                        cfg->input_pins[AUTO_PIN_CD] = nid;
                        break;
                case AC_JACK_AUX:
                        cfg->input_pins[AUTO_PIN_AUX] = nid;
                        break;
                case AC_JACK_SPDIF_OUT:
                case AC_JACK_DIG_OTHER_OUT:
                        if (cfg->dig_outs >= ARRAY_SIZE(cfg->dig_out_pins))
                                continue;
                        cfg->dig_out_pins[cfg->dig_outs] = nid;
                        cfg->dig_out_type[cfg->dig_outs] =
                                (loc == AC_JACK_LOC_HDMI) ?
                                HDA_PCM_TYPE_HDMI : HDA_PCM_TYPE_SPDIF;
                        cfg->dig_outs++;
                        break;
                case AC_JACK_SPDIF_IN:
                case AC_JACK_DIG_OTHER_IN:
                        cfg->dig_in_pin = nid;
                        if (loc == AC_JACK_LOC_HDMI)
                                cfg->dig_in_type = HDA_PCM_TYPE_HDMI;
                        else
                                cfg->dig_in_type = HDA_PCM_TYPE_SPDIF;
                        break;
                }
        }

        /* FIX-UP:
         * If no line-out is defined but multiple HPs are found,
         * some of them might be the real line-outs.
         */
        if (!cfg->line_outs && cfg->hp_outs > 1) {
                int i = 0;
                while (i < cfg->hp_outs) {
                        /* The real HPs should have the sequence 0x0f */
                        if ((sequences_hp[i] & 0x0f) == 0x0f) {
                                i++;
                                continue;
                        }
                        /* Move it to the line-out table */
                        cfg->line_out_pins[cfg->line_outs] = cfg->hp_pins[i];
                        sequences_line_out[cfg->line_outs] = sequences_hp[i];
                        cfg->line_outs++;
                        cfg->hp_outs--;
                        memmove(cfg->hp_pins + i, cfg->hp_pins + i + 1,
                                sizeof(cfg->hp_pins[0]) * (cfg->hp_outs - i));
                        memmove(sequences_hp + i - 1, sequences_hp + i,
                                sizeof(sequences_hp[0]) * (cfg->hp_outs - i));
                }
        }

        /* sort by sequence */
        sort_pins_by_sequence(cfg->line_out_pins, sequences_line_out,
                              cfg->line_outs);
        sort_pins_by_sequence(cfg->speaker_pins, sequences_speaker,
                              cfg->speaker_outs);
        sort_pins_by_sequence(cfg->hp_pins, sequences_hp,
                              cfg->hp_outs);

        /* if we have only one mic, make it AUTO_PIN_MIC */
        if (!cfg->input_pins[AUTO_PIN_MIC] &&
            cfg->input_pins[AUTO_PIN_FRONT_MIC]) {
                cfg->input_pins[AUTO_PIN_MIC] =
                        cfg->input_pins[AUTO_PIN_FRONT_MIC];
                cfg->input_pins[AUTO_PIN_FRONT_MIC] = 0;
        }
        /* ditto for line-in */
        if (!cfg->input_pins[AUTO_PIN_LINE] &&
            cfg->input_pins[AUTO_PIN_FRONT_LINE]) {
                cfg->input_pins[AUTO_PIN_LINE] =
                        cfg->input_pins[AUTO_PIN_FRONT_LINE];
                cfg->input_pins[AUTO_PIN_FRONT_LINE] = 0;
        }

        /*
         * FIX-UP: if no line-outs are detected, try to use speaker or HP pin
         * as a primary output
         */
        if (!cfg->line_outs) {
                if (cfg->speaker_outs) {
                        cfg->line_outs = cfg->speaker_outs;
                        memcpy(cfg->line_out_pins, cfg->speaker_pins,
                               sizeof(cfg->speaker_pins));
                        cfg->speaker_outs = 0;
                        memset(cfg->speaker_pins, 0, sizeof(cfg->speaker_pins));
                        cfg->line_out_type = AUTO_PIN_SPEAKER_OUT;
                } else if (cfg->hp_outs) {
                        cfg->line_outs = cfg->hp_outs;
                        memcpy(cfg->line_out_pins, cfg->hp_pins,
                               sizeof(cfg->hp_pins));
                        cfg->hp_outs = 0;
                        memset(cfg->hp_pins, 0, sizeof(cfg->hp_pins));
                        cfg->line_out_type = AUTO_PIN_HP_OUT;
                }
        }

        /* Reorder the surround channels
         * ALSA sequence is front/surr/clfe/side
         * HDA sequence is:
         *    4-ch: front/surr  =>  OK as it is
         *    6-ch: front/clfe/surr
         *    8-ch: front/clfe/rear/side|fc
         */
        switch (cfg->line_outs) {
        case 3:
        case 4:
                nid = cfg->line_out_pins[1];
                cfg->line_out_pins[1] = cfg->line_out_pins[2];
                cfg->line_out_pins[2] = nid;
                break;
        }

        /*
         * debug prints of the parsed results
         */
        snd_printd("autoconfig: line_outs=%d (0x%x/0x%x/0x%x/0x%x/0x%x)\n",
                   cfg->line_outs, cfg->line_out_pins[0], cfg->line_out_pins[1],
                   cfg->line_out_pins[2], cfg->line_out_pins[3],
                   cfg->line_out_pins[4]);
        snd_printd("   speaker_outs=%d (0x%x/0x%x/0x%x/0x%x/0x%x)\n",
                   cfg->speaker_outs, cfg->speaker_pins[0],
                   cfg->speaker_pins[1], cfg->speaker_pins[2],
                   cfg->speaker_pins[3], cfg->speaker_pins[4]);
        snd_printd("   hp_outs=%d (0x%x/0x%x/0x%x/0x%x/0x%x)\n",
                   cfg->hp_outs, cfg->hp_pins[0],
                   cfg->hp_pins[1], cfg->hp_pins[2],
                   cfg->hp_pins[3], cfg->hp_pins[4]);
        snd_printd("   mono: mono_out=0x%x\n", cfg->mono_out_pin);
        if (cfg->dig_outs)
                snd_printd("   dig-out=0x%x/0x%x\n",
                           cfg->dig_out_pins[0], cfg->dig_out_pins[1]);
        snd_printd("   inputs: mic=0x%x, fmic=0x%x, line=0x%x, fline=0x%x,"
                   " cd=0x%x, aux=0x%x\n",
                   cfg->input_pins[AUTO_PIN_MIC],
                   cfg->input_pins[AUTO_PIN_FRONT_MIC],
                   cfg->input_pins[AUTO_PIN_LINE],
                   cfg->input_pins[AUTO_PIN_FRONT_LINE],
                   cfg->input_pins[AUTO_PIN_CD],
                   cfg->input_pins[AUTO_PIN_AUX]);
        if (cfg->dig_in_pin)
                snd_printd("   dig-in=0x%x\n", cfg->dig_in_pin);

        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_parse_pin_def_config);

/* labels for input pins */
const char *auto_pin_cfg_labels[AUTO_PIN_LAST] = {
        "Mic", "Front Mic", "Line", "Front Line", "CD", "Aux"
};
EXPORT_SYMBOL_HDA(auto_pin_cfg_labels);


#ifdef CONFIG_PM
/*
 * power management
 */

/**
 * snd_hda_suspend - suspend the codecs
 * @bus: the HDA bus
 *
 * Returns 0 if successful.
 */
int snd_hda_suspend(struct hda_bus *bus)
{
        struct hda_codec *codec;

        list_for_each_entry(codec, &bus->codec_list, list) {
#ifdef CONFIG_SND_HDA_POWER_SAVE
                if (!codec->power_on)
                        continue;
#endif
                hda_call_codec_suspend(codec);
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_suspend);

/**
 * snd_hda_resume - resume the codecs
 * @bus: the HDA bus
 *
 * Returns 0 if successful.
 *
 * This fucntion is defined only when POWER_SAVE isn't set.
 * In the power-save mode, the codec is resumed dynamically.
 */
int snd_hda_resume(struct hda_bus *bus)
{
        struct hda_codec *codec;

        list_for_each_entry(codec, &bus->codec_list, list) {
                if (snd_hda_codec_needs_resume(codec))
                        hda_call_codec_resume(codec);
        }
        return 0;
}
EXPORT_SYMBOL_HDA(snd_hda_resume);
#endif /* CONFIG_PM */

/*
 * generic arrays
 */

/**
 * snd_array_new - get a new element from the given array
 * @array: the array object
 *
 * Get a new element from the given array.  If it exceeds the
 * pre-allocated array size, re-allocate the array.
 *
 * Returns NULL if allocation failed.
 */
void *snd_array_new(struct snd_array *array)
{
        if (array->used >= array->alloced) {
                int num = array->alloced + array->alloc_align;
                void *nlist;
                if (snd_BUG_ON(num >= 4096))
                        return NULL;
                nlist = kcalloc(num + 1, array->elem_size, GFP_KERNEL);
                if (!nlist)
                        return NULL;
                if (array->list) {
                        memcpy(nlist, array->list,
                               array->elem_size * array->alloced);
                        kfree(array->list);
                }
                array->list = nlist;
                array->alloced = num;
        }
        return snd_array_elem(array, array->used++);
}
EXPORT_SYMBOL_HDA(snd_array_new);

/**
 * snd_array_free - free the given array elements
 * @array: the array object
 */
void snd_array_free(struct snd_array *array)
{
        kfree(array->list);
        array->used = 0;
        array->alloced = 0;
        array->list = NULL;
}
EXPORT_SYMBOL_HDA(snd_array_free);

/**
 * snd_print_pcm_rates - Print the supported PCM rates to the string buffer
 * @pcm: PCM caps bits
 * @buf: the string buffer to write
 * @buflen: the max buffer length
 *
 * used by hda_proc.c and hda_eld.c
 */
void snd_print_pcm_rates(int pcm, char *buf, int buflen)
{
        static unsigned int rates[] = {
                8000, 11025, 16000, 22050, 32000, 44100, 48000, 88200,
                96000, 176400, 192000, 384000
        };
        int i, j;

        for (i = 0, j = 0; i < ARRAY_SIZE(rates); i++)
                if (pcm & (1 << i))
                        j += snprintf(buf + j, buflen - j,  " %d", rates[i]);

        buf[j] = '\0'; /* necessary when j == 0 */
}
EXPORT_SYMBOL_HDA(snd_print_pcm_rates);

/**
 * snd_print_pcm_bits - Print the supported PCM fmt bits to the string buffer
 * @pcm: PCM caps bits
 * @buf: the string buffer to write
 * @buflen: the max buffer length
 *
 * used by hda_proc.c and hda_eld.c
 */
void snd_print_pcm_bits(int pcm, char *buf, int buflen)
{
        static unsigned int bits[] = { 8, 16, 20, 24, 32 };
        int i, j;

        for (i = 0, j = 0; i < ARRAY_SIZE(bits); i++)
                if (pcm & (AC_SUPPCM_BITS_8 << i))
                        j += snprintf(buf + j, buflen - j,  " %d", bits[i]);

        buf[j] = '\0'; /* necessary when j == 0 */
}
EXPORT_SYMBOL_HDA(snd_print_pcm_bits);

MODULE_DESCRIPTION("HDA codec core");
MODULE_LICENSE("GPL");