iwlwifi: mvm: fix nvm_data leak

[linux-2.6/btrfs-unstable.git] / sound / pci / hda / patch_hdmi.c

/*
 *
 *  patch_hdmi.c - routines for HDMI/DisplayPort codecs
 *
 *  Copyright(c) 2008-2010 Intel Corporation. All rights reserved.
 *  Copyright (c) 2006 ATI Technologies Inc.
 *  Copyright (c) 2008 NVIDIA Corp.  All rights reserved.
 *  Copyright (c) 2008 Wei Ni <wni@nvidia.com>
 *  Copyright (c) 2013 Anssi Hannula <anssi.hannula@iki.fi>
 *
 *  Authors:
 *                      Wu Fengguang <wfg@linux.intel.com>
 *
 *  Maintained by:
 *                      Wu Fengguang <wfg@linux.intel.com>
 *
 *  This program 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 program 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/module.h>
#include <sound/core.h>
#include <sound/jack.h>
#include <sound/asoundef.h>
#include <sound/tlv.h>
#include <sound/hdaudio.h>
#include <sound/hda_i915.h>
#include <sound/hda_chmap.h>
#include "hda_codec.h"
#include "hda_local.h"
#include "hda_jack.h"

static bool static_hdmi_pcm;
module_param(static_hdmi_pcm, bool, 0644);
MODULE_PARM_DESC(static_hdmi_pcm, "Don't restrict PCM parameters per ELD info");

#define is_haswell(codec)  ((codec)->core.vendor_id == 0x80862807)
#define is_broadwell(codec)    ((codec)->core.vendor_id == 0x80862808)
#define is_skylake(codec) ((codec)->core.vendor_id == 0x80862809)
#define is_broxton(codec) ((codec)->core.vendor_id == 0x8086280a)
#define is_kabylake(codec) ((codec)->core.vendor_id == 0x8086280b)
#define is_haswell_plus(codec) (is_haswell(codec) || is_broadwell(codec) \
                                || is_skylake(codec) || is_broxton(codec) \
                                || is_kabylake(codec))

#define is_valleyview(codec) ((codec)->core.vendor_id == 0x80862882)
#define is_cherryview(codec) ((codec)->core.vendor_id == 0x80862883)
#define is_valleyview_plus(codec) (is_valleyview(codec) || is_cherryview(codec))

struct hdmi_spec_per_cvt {
        hda_nid_t cvt_nid;
        int assigned;
        unsigned int channels_min;
        unsigned int channels_max;
        u32 rates;
        u64 formats;
        unsigned int maxbps;
};

/* max. connections to a widget */
#define HDA_MAX_CONNECTIONS     32

struct hdmi_spec_per_pin {
        hda_nid_t pin_nid;
        int dev_id;
        /* pin idx, different device entries on the same pin use the same idx */
        int pin_nid_idx;
        int num_mux_nids;
        hda_nid_t mux_nids[HDA_MAX_CONNECTIONS];
        int mux_idx;
        hda_nid_t cvt_nid;

        struct hda_codec *codec;
        struct hdmi_eld sink_eld;
        struct mutex lock;
        struct delayed_work work;
        struct hdmi_pcm *pcm; /* pointer to spec->pcm_rec[n] dynamically*/
        int pcm_idx; /* which pcm is attached. -1 means no pcm is attached */
        int repoll_count;
        bool setup; /* the stream has been set up by prepare callback */
        int channels; /* current number of channels */
        bool non_pcm;
        bool chmap_set;         /* channel-map override by ALSA API? */
        unsigned char chmap[8]; /* ALSA API channel-map */
#ifdef CONFIG_SND_PROC_FS
        struct snd_info_entry *proc_entry;
#endif
};

/* operations used by generic code that can be overridden by patches */
struct hdmi_ops {
        int (*pin_get_eld)(struct hda_codec *codec, hda_nid_t pin_nid,
                           unsigned char *buf, int *eld_size);

        void (*pin_setup_infoframe)(struct hda_codec *codec, hda_nid_t pin_nid,
                                    int ca, int active_channels, int conn_type);

        /* enable/disable HBR (HD passthrough) */
        int (*pin_hbr_setup)(struct hda_codec *codec, hda_nid_t pin_nid, bool hbr);

        int (*setup_stream)(struct hda_codec *codec, hda_nid_t cvt_nid,
                            hda_nid_t pin_nid, u32 stream_tag, int format);

        void (*pin_cvt_fixup)(struct hda_codec *codec,
                              struct hdmi_spec_per_pin *per_pin,
                              hda_nid_t cvt_nid);
};

struct hdmi_pcm {
        struct hda_pcm *pcm;
        struct snd_jack *jack;
        struct snd_kcontrol *eld_ctl;
};

struct hdmi_spec {
        int num_cvts;
        struct snd_array cvts; /* struct hdmi_spec_per_cvt */
        hda_nid_t cvt_nids[4]; /* only for haswell fix */

        /*
         * num_pins is the number of virtual pins
         * for example, there are 3 pins, and each pin
         * has 4 device entries, then the num_pins is 12
         */
        int num_pins;
        /*
         * num_nids is the number of real pins
         * In the above example, num_nids is 3
         */
        int num_nids;
        /*
         * dev_num is the number of device entries
         * on each pin.
         * In the above example, dev_num is 4
         */
        int dev_num;
        struct snd_array pins; /* struct hdmi_spec_per_pin */
        struct hdmi_pcm pcm_rec[16];
        struct mutex pcm_lock;
        /* pcm_bitmap means which pcms have been assigned to pins*/
        unsigned long pcm_bitmap;
        int pcm_used;   /* counter of pcm_rec[] */
        /* bitmap shows whether the pcm is opened in user space
         * bit 0 means the first playback PCM (PCM3);
         * bit 1 means the second playback PCM, and so on.
         */
        unsigned long pcm_in_use;

        struct hdmi_eld temp_eld;
        struct hdmi_ops ops;

        bool dyn_pin_out;
        bool dyn_pcm_assign;
        /*
         * Non-generic VIA/NVIDIA specific
         */
        struct hda_multi_out multiout;
        struct hda_pcm_stream pcm_playback;

        /* i915/powerwell (Haswell+/Valleyview+) specific */
        bool use_acomp_notifier; /* use i915 eld_notify callback for hotplug */
        struct i915_audio_component_audio_ops i915_audio_ops;
        bool i915_bound; /* was i915 bound in this driver? */

        struct hdac_chmap chmap;
        hda_nid_t vendor_nid;
};

#ifdef CONFIG_SND_HDA_I915
static inline bool codec_has_acomp(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        return spec->use_acomp_notifier;
}
#else
#define codec_has_acomp(codec)  false
#endif

struct hdmi_audio_infoframe {
        u8 type; /* 0x84 */
        u8 ver;  /* 0x01 */
        u8 len;  /* 0x0a */

        u8 checksum;

        u8 CC02_CT47;   /* CC in bits 0:2, CT in 4:7 */
        u8 SS01_SF24;
        u8 CXT04;
        u8 CA;
        u8 LFEPBL01_LSV36_DM_INH7;
};

struct dp_audio_infoframe {
        u8 type; /* 0x84 */
        u8 len;  /* 0x1b */
        u8 ver;  /* 0x11 << 2 */

        u8 CC02_CT47;   /* match with HDMI infoframe from this on */
        u8 SS01_SF24;
        u8 CXT04;
        u8 CA;
        u8 LFEPBL01_LSV36_DM_INH7;
};

union audio_infoframe {
        struct hdmi_audio_infoframe hdmi;
        struct dp_audio_infoframe dp;
        u8 bytes[0];
};

/*
 * HDMI routines
 */

#define get_pin(spec, idx) \
        ((struct hdmi_spec_per_pin *)snd_array_elem(&spec->pins, idx))
#define get_cvt(spec, idx) \
        ((struct hdmi_spec_per_cvt  *)snd_array_elem(&spec->cvts, idx))
/* obtain hdmi_pcm object assigned to idx */
#define get_hdmi_pcm(spec, idx) (&(spec)->pcm_rec[idx])
/* obtain hda_pcm object assigned to idx */
#define get_pcm_rec(spec, idx)  (get_hdmi_pcm(spec, idx)->pcm)

static int pin_id_to_pin_index(struct hda_codec *codec,
                               hda_nid_t pin_nid, int dev_id)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_idx;
        struct hdmi_spec_per_pin *per_pin;

        /*
         * (dev_id == -1) means it is NON-MST pin
         * return the first virtual pin on this port
         */
        if (dev_id == -1)
                dev_id = 0;

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                per_pin = get_pin(spec, pin_idx);
                if ((per_pin->pin_nid == pin_nid) &&
                        (per_pin->dev_id == dev_id))
                        return pin_idx;
        }

        codec_warn(codec, "HDMI: pin nid %d not registered\n", pin_nid);
        return -EINVAL;
}

static int hinfo_to_pcm_index(struct hda_codec *codec,
                        struct hda_pcm_stream *hinfo)
{
        struct hdmi_spec *spec = codec->spec;
        int pcm_idx;

        for (pcm_idx = 0; pcm_idx < spec->pcm_used; pcm_idx++)
                if (get_pcm_rec(spec, pcm_idx)->stream == hinfo)
                        return pcm_idx;

        codec_warn(codec, "HDMI: hinfo %p not registered\n", hinfo);
        return -EINVAL;
}

static int hinfo_to_pin_index(struct hda_codec *codec,
                              struct hda_pcm_stream *hinfo)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin;
        int pin_idx;

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                per_pin = get_pin(spec, pin_idx);
                if (per_pin->pcm &&
                        per_pin->pcm->pcm->stream == hinfo)
                        return pin_idx;
        }

        codec_dbg(codec, "HDMI: hinfo %p not registered\n", hinfo);
        return -EINVAL;
}

static struct hdmi_spec_per_pin *pcm_idx_to_pin(struct hdmi_spec *spec,
                                                int pcm_idx)
{
        int i;
        struct hdmi_spec_per_pin *per_pin;

        for (i = 0; i < spec->num_pins; i++) {
                per_pin = get_pin(spec, i);
                if (per_pin->pcm_idx == pcm_idx)
                        return per_pin;
        }
        return NULL;
}

static int cvt_nid_to_cvt_index(struct hda_codec *codec, hda_nid_t cvt_nid)
{
        struct hdmi_spec *spec = codec->spec;
        int cvt_idx;

        for (cvt_idx = 0; cvt_idx < spec->num_cvts; cvt_idx++)
                if (get_cvt(spec, cvt_idx)->cvt_nid == cvt_nid)
                        return cvt_idx;

        codec_warn(codec, "HDMI: cvt nid %d not registered\n", cvt_nid);
        return -EINVAL;
}

static int hdmi_eld_ctl_info(struct snd_kcontrol *kcontrol,
                        struct snd_ctl_elem_info *uinfo)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin;
        struct hdmi_eld *eld;
        int pcm_idx;

        uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;

        pcm_idx = kcontrol->private_value;
        mutex_lock(&spec->pcm_lock);
        per_pin = pcm_idx_to_pin(spec, pcm_idx);
        if (!per_pin) {
                /* no pin is bound to the pcm */
                uinfo->count = 0;
                mutex_unlock(&spec->pcm_lock);
                return 0;
        }
        eld = &per_pin->sink_eld;
        uinfo->count = eld->eld_valid ? eld->eld_size : 0;
        mutex_unlock(&spec->pcm_lock);

        return 0;
}

static int hdmi_eld_ctl_get(struct snd_kcontrol *kcontrol,
                        struct snd_ctl_elem_value *ucontrol)
{
        struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin;
        struct hdmi_eld *eld;
        int pcm_idx;

        pcm_idx = kcontrol->private_value;
        mutex_lock(&spec->pcm_lock);
        per_pin = pcm_idx_to_pin(spec, pcm_idx);
        if (!per_pin) {
                /* no pin is bound to the pcm */
                memset(ucontrol->value.bytes.data, 0,
                       ARRAY_SIZE(ucontrol->value.bytes.data));
                mutex_unlock(&spec->pcm_lock);
                return 0;
        }
        eld = &per_pin->sink_eld;

        if (eld->eld_size > ARRAY_SIZE(ucontrol->value.bytes.data) ||
            eld->eld_size > ELD_MAX_SIZE) {
                mutex_unlock(&spec->pcm_lock);
                snd_BUG();
                return -EINVAL;
        }

        memset(ucontrol->value.bytes.data, 0,
               ARRAY_SIZE(ucontrol->value.bytes.data));
        if (eld->eld_valid)
                memcpy(ucontrol->value.bytes.data, eld->eld_buffer,
                       eld->eld_size);
        mutex_unlock(&spec->pcm_lock);

        return 0;
}

static const struct snd_kcontrol_new eld_bytes_ctl = {
        .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
        .iface = SNDRV_CTL_ELEM_IFACE_PCM,
        .name = "ELD",
        .info = hdmi_eld_ctl_info,
        .get = hdmi_eld_ctl_get,
};

static int hdmi_create_eld_ctl(struct hda_codec *codec, int pcm_idx,
                        int device)
{
        struct snd_kcontrol *kctl;
        struct hdmi_spec *spec = codec->spec;
        int err;

        kctl = snd_ctl_new1(&eld_bytes_ctl, codec);
        if (!kctl)
                return -ENOMEM;
        kctl->private_value = pcm_idx;
        kctl->id.device = device;

        /* no pin nid is associated with the kctl now
         * tbd: associate pin nid to eld ctl later
         */
        err = snd_hda_ctl_add(codec, 0, kctl);
        if (err < 0)
                return err;

        get_hdmi_pcm(spec, pcm_idx)->eld_ctl = kctl;
        return 0;
}

#ifdef BE_PARANOID
static void hdmi_get_dip_index(struct hda_codec *codec, hda_nid_t pin_nid,
                                int *packet_index, int *byte_index)
{
        int val;

        val = snd_hda_codec_read(codec, pin_nid, 0,
                                 AC_VERB_GET_HDMI_DIP_INDEX, 0);

        *packet_index = val >> 5;
        *byte_index = val & 0x1f;
}
#endif

static void hdmi_set_dip_index(struct hda_codec *codec, hda_nid_t pin_nid,
                                int packet_index, int byte_index)
{
        int val;

        val = (packet_index << 5) | (byte_index & 0x1f);

        snd_hda_codec_write(codec, pin_nid, 0, AC_VERB_SET_HDMI_DIP_INDEX, val);
}

static void hdmi_write_dip_byte(struct hda_codec *codec, hda_nid_t pin_nid,
                                unsigned char val)
{
        snd_hda_codec_write(codec, pin_nid, 0, AC_VERB_SET_HDMI_DIP_DATA, val);
}

static void hdmi_init_pin(struct hda_codec *codec, hda_nid_t pin_nid)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_out;

        /* Unmute */
        if (get_wcaps(codec, pin_nid) & AC_WCAP_OUT_AMP)
                snd_hda_codec_write(codec, pin_nid, 0,
                                AC_VERB_SET_AMP_GAIN_MUTE, AMP_OUT_UNMUTE);

        if (spec->dyn_pin_out)
                /* Disable pin out until stream is active */
                pin_out = 0;
        else
                /* Enable pin out: some machines with GM965 gets broken output
                 * when the pin is disabled or changed while using with HDMI
                 */
                pin_out = PIN_OUT;

        snd_hda_codec_write(codec, pin_nid, 0,
                            AC_VERB_SET_PIN_WIDGET_CONTROL, pin_out);
}

/*
 * ELD proc files
 */

#ifdef CONFIG_SND_PROC_FS
static void print_eld_info(struct snd_info_entry *entry,
                           struct snd_info_buffer *buffer)
{
        struct hdmi_spec_per_pin *per_pin = entry->private_data;

        mutex_lock(&per_pin->lock);
        snd_hdmi_print_eld_info(&per_pin->sink_eld, buffer);
        mutex_unlock(&per_pin->lock);
}

static void write_eld_info(struct snd_info_entry *entry,
                           struct snd_info_buffer *buffer)
{
        struct hdmi_spec_per_pin *per_pin = entry->private_data;

        mutex_lock(&per_pin->lock);
        snd_hdmi_write_eld_info(&per_pin->sink_eld, buffer);
        mutex_unlock(&per_pin->lock);
}

static int eld_proc_new(struct hdmi_spec_per_pin *per_pin, int index)
{
        char name[32];
        struct hda_codec *codec = per_pin->codec;
        struct snd_info_entry *entry;
        int err;

        snprintf(name, sizeof(name), "eld#%d.%d", codec->addr, index);
        err = snd_card_proc_new(codec->card, name, &entry);
        if (err < 0)
                return err;

        snd_info_set_text_ops(entry, per_pin, print_eld_info);
        entry->c.text.write = write_eld_info;
        entry->mode |= S_IWUSR;
        per_pin->proc_entry = entry;

        return 0;
}

static void eld_proc_free(struct hdmi_spec_per_pin *per_pin)
{
        if (!per_pin->codec->bus->shutdown) {
                snd_info_free_entry(per_pin->proc_entry);
                per_pin->proc_entry = NULL;
        }
}
#else
static inline int eld_proc_new(struct hdmi_spec_per_pin *per_pin,
                               int index)
{
        return 0;
}
static inline void eld_proc_free(struct hdmi_spec_per_pin *per_pin)
{
}
#endif

/*
 * Audio InfoFrame routines
 */

/*
 * Enable Audio InfoFrame Transmission
 */
static void hdmi_start_infoframe_trans(struct hda_codec *codec,
                                       hda_nid_t pin_nid)
{
        hdmi_set_dip_index(codec, pin_nid, 0x0, 0x0);
        snd_hda_codec_write(codec, pin_nid, 0, AC_VERB_SET_HDMI_DIP_XMIT,
                                                AC_DIPXMIT_BEST);
}

/*
 * Disable Audio InfoFrame Transmission
 */
static void hdmi_stop_infoframe_trans(struct hda_codec *codec,
                                      hda_nid_t pin_nid)
{
        hdmi_set_dip_index(codec, pin_nid, 0x0, 0x0);
        snd_hda_codec_write(codec, pin_nid, 0, AC_VERB_SET_HDMI_DIP_XMIT,
                                                AC_DIPXMIT_DISABLE);
}

static void hdmi_debug_dip_size(struct hda_codec *codec, hda_nid_t pin_nid)
{
#ifdef CONFIG_SND_DEBUG_VERBOSE
        int i;
        int size;

        size = snd_hdmi_get_eld_size(codec, pin_nid);
        codec_dbg(codec, "HDMI: ELD buf size is %d\n", size);

        for (i = 0; i < 8; i++) {
                size = snd_hda_codec_read(codec, pin_nid, 0,
                                                AC_VERB_GET_HDMI_DIP_SIZE, i);
                codec_dbg(codec, "HDMI: DIP GP[%d] buf size is %d\n", i, size);
        }
#endif
}

static void hdmi_clear_dip_buffers(struct hda_codec *codec, hda_nid_t pin_nid)
{
#ifdef BE_PARANOID
        int i, j;
        int size;
        int pi, bi;
        for (i = 0; i < 8; i++) {
                size = snd_hda_codec_read(codec, pin_nid, 0,
                                                AC_VERB_GET_HDMI_DIP_SIZE, i);
                if (size == 0)
                        continue;

                hdmi_set_dip_index(codec, pin_nid, i, 0x0);
                for (j = 1; j < 1000; j++) {
                        hdmi_write_dip_byte(codec, pin_nid, 0x0);
                        hdmi_get_dip_index(codec, pin_nid, &pi, &bi);
                        if (pi != i)
                                codec_dbg(codec, "dip index %d: %d != %d\n",
                                                bi, pi, i);
                        if (bi == 0) /* byte index wrapped around */
                                break;
                }
                codec_dbg(codec,
                        "HDMI: DIP GP[%d] buf reported size=%d, written=%d\n",
                        i, size, j);
        }
#endif
}

static void hdmi_checksum_audio_infoframe(struct hdmi_audio_infoframe *hdmi_ai)
{
        u8 *bytes = (u8 *)hdmi_ai;
        u8 sum = 0;
        int i;

        hdmi_ai->checksum = 0;

        for (i = 0; i < sizeof(*hdmi_ai); i++)
                sum += bytes[i];

        hdmi_ai->checksum = -sum;
}

static void hdmi_fill_audio_infoframe(struct hda_codec *codec,
                                      hda_nid_t pin_nid,
                                      u8 *dip, int size)
{
        int i;

        hdmi_debug_dip_size(codec, pin_nid);
        hdmi_clear_dip_buffers(codec, pin_nid); /* be paranoid */

        hdmi_set_dip_index(codec, pin_nid, 0x0, 0x0);
        for (i = 0; i < size; i++)
                hdmi_write_dip_byte(codec, pin_nid, dip[i]);
}

static bool hdmi_infoframe_uptodate(struct hda_codec *codec, hda_nid_t pin_nid,
                                    u8 *dip, int size)
{
        u8 val;
        int i;

        if (snd_hda_codec_read(codec, pin_nid, 0, AC_VERB_GET_HDMI_DIP_XMIT, 0)
                                                            != AC_DIPXMIT_BEST)
                return false;

        hdmi_set_dip_index(codec, pin_nid, 0x0, 0x0);
        for (i = 0; i < size; i++) {
                val = snd_hda_codec_read(codec, pin_nid, 0,
                                         AC_VERB_GET_HDMI_DIP_DATA, 0);
                if (val != dip[i])
                        return false;
        }

        return true;
}

static void hdmi_pin_setup_infoframe(struct hda_codec *codec,
                                     hda_nid_t pin_nid,
                                     int ca, int active_channels,
                                     int conn_type)
{
        union audio_infoframe ai;

        memset(&ai, 0, sizeof(ai));
        if (conn_type == 0) { /* HDMI */
                struct hdmi_audio_infoframe *hdmi_ai = &ai.hdmi;

                hdmi_ai->type           = 0x84;
                hdmi_ai->ver            = 0x01;
                hdmi_ai->len            = 0x0a;
                hdmi_ai->CC02_CT47      = active_channels - 1;
                hdmi_ai->CA             = ca;
                hdmi_checksum_audio_infoframe(hdmi_ai);
        } else if (conn_type == 1) { /* DisplayPort */
                struct dp_audio_infoframe *dp_ai = &ai.dp;

                dp_ai->type             = 0x84;
                dp_ai->len              = 0x1b;
                dp_ai->ver              = 0x11 << 2;
                dp_ai->CC02_CT47        = active_channels - 1;
                dp_ai->CA               = ca;
        } else {
                codec_dbg(codec, "HDMI: unknown connection type at pin %d\n",
                            pin_nid);
                return;
        }

        /*
         * sizeof(ai) is used instead of sizeof(*hdmi_ai) or
         * sizeof(*dp_ai) to avoid partial match/update problems when
         * the user switches between HDMI/DP monitors.
         */
        if (!hdmi_infoframe_uptodate(codec, pin_nid, ai.bytes,
                                        sizeof(ai))) {
                codec_dbg(codec,
                          "hdmi_pin_setup_infoframe: pin=%d channels=%d ca=0x%02x\n",
                            pin_nid,
                            active_channels, ca);
                hdmi_stop_infoframe_trans(codec, pin_nid);
                hdmi_fill_audio_infoframe(codec, pin_nid,
                                            ai.bytes, sizeof(ai));
                hdmi_start_infoframe_trans(codec, pin_nid);
        }
}

static void hdmi_setup_audio_infoframe(struct hda_codec *codec,
                                       struct hdmi_spec_per_pin *per_pin,
                                       bool non_pcm)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdac_chmap *chmap = &spec->chmap;
        hda_nid_t pin_nid = per_pin->pin_nid;
        int channels = per_pin->channels;
        int active_channels;
        struct hdmi_eld *eld;
        int ca;

        if (!channels)
                return;

        /* some HW (e.g. HSW+) needs reprogramming the amp at each time */
        if (get_wcaps(codec, pin_nid) & AC_WCAP_OUT_AMP)
                snd_hda_codec_write(codec, pin_nid, 0,
                                            AC_VERB_SET_AMP_GAIN_MUTE,
                                            AMP_OUT_UNMUTE);

        eld = &per_pin->sink_eld;

        ca = snd_hdac_channel_allocation(&codec->core,
                        eld->info.spk_alloc, channels,
                        per_pin->chmap_set, non_pcm, per_pin->chmap);

        active_channels = snd_hdac_get_active_channels(ca);

        chmap->ops.set_channel_count(&codec->core, per_pin->cvt_nid,
                                                active_channels);

        /*
         * always configure channel mapping, it may have been changed by the
         * user in the meantime
         */
        snd_hdac_setup_channel_mapping(&spec->chmap,
                                pin_nid, non_pcm, ca, channels,
                                per_pin->chmap, per_pin->chmap_set);

        spec->ops.pin_setup_infoframe(codec, pin_nid, ca, active_channels,
                                      eld->info.conn_type);

        per_pin->non_pcm = non_pcm;
}

/*
 * Unsolicited events
 */

static bool hdmi_present_sense(struct hdmi_spec_per_pin *per_pin, int repoll);

static void check_presence_and_report(struct hda_codec *codec, hda_nid_t nid,
                                      int dev_id)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_idx = pin_id_to_pin_index(codec, nid, dev_id);

        if (pin_idx < 0)
                return;
        if (hdmi_present_sense(get_pin(spec, pin_idx), 1))
                snd_hda_jack_report_sync(codec);
}

static void jack_callback(struct hda_codec *codec,
                          struct hda_jack_callback *jack)
{
        /* hda_jack don't support DP MST */
        check_presence_and_report(codec, jack->nid, 0);
}

static void hdmi_intrinsic_event(struct hda_codec *codec, unsigned int res)
{
        int tag = res >> AC_UNSOL_RES_TAG_SHIFT;
        struct hda_jack_tbl *jack;
        int dev_entry = (res & AC_UNSOL_RES_DE) >> AC_UNSOL_RES_DE_SHIFT;

        /*
         * assume DP MST uses dyn_pcm_assign and acomp and
         * never comes here
         * if DP MST supports unsol event, below code need
         * consider dev_entry
         */
        jack = snd_hda_jack_tbl_get_from_tag(codec, tag);
        if (!jack)
                return;
        jack->jack_dirty = 1;

        codec_dbg(codec,
                "HDMI hot plug event: Codec=%d Pin=%d Device=%d Inactive=%d Presence_Detect=%d ELD_Valid=%d\n",
                codec->addr, jack->nid, dev_entry, !!(res & AC_UNSOL_RES_IA),
                !!(res & AC_UNSOL_RES_PD), !!(res & AC_UNSOL_RES_ELDV));

        /* hda_jack don't support DP MST */
        check_presence_and_report(codec, jack->nid, 0);
}

static void hdmi_non_intrinsic_event(struct hda_codec *codec, unsigned int res)
{
        int tag = res >> AC_UNSOL_RES_TAG_SHIFT;
        int subtag = (res & AC_UNSOL_RES_SUBTAG) >> AC_UNSOL_RES_SUBTAG_SHIFT;
        int cp_state = !!(res & AC_UNSOL_RES_CP_STATE);
        int cp_ready = !!(res & AC_UNSOL_RES_CP_READY);

        codec_info(codec,
                "HDMI CP event: CODEC=%d TAG=%d SUBTAG=0x%x CP_STATE=%d CP_READY=%d\n",
                codec->addr,
                tag,
                subtag,
                cp_state,
                cp_ready);

        /* TODO */
        if (cp_state)
                ;
        if (cp_ready)
                ;
}


static void hdmi_unsol_event(struct hda_codec *codec, unsigned int res)
{
        int tag = res >> AC_UNSOL_RES_TAG_SHIFT;
        int subtag = (res & AC_UNSOL_RES_SUBTAG) >> AC_UNSOL_RES_SUBTAG_SHIFT;

        if (!snd_hda_jack_tbl_get_from_tag(codec, tag)) {
                codec_dbg(codec, "Unexpected HDMI event tag 0x%x\n", tag);
                return;
        }

        if (subtag == 0)
                hdmi_intrinsic_event(codec, res);
        else
                hdmi_non_intrinsic_event(codec, res);
}

static void haswell_verify_D0(struct hda_codec *codec,
                hda_nid_t cvt_nid, hda_nid_t nid)
{
        int pwr;

        /* For Haswell, the converter 1/2 may keep in D3 state after bootup,
         * thus pins could only choose converter 0 for use. Make sure the
         * converters are in correct power state */
        if (!snd_hda_check_power_state(codec, cvt_nid, AC_PWRST_D0))
                snd_hda_codec_write(codec, cvt_nid, 0, AC_VERB_SET_POWER_STATE, AC_PWRST_D0);

        if (!snd_hda_check_power_state(codec, nid, AC_PWRST_D0)) {
                snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_POWER_STATE,
                                    AC_PWRST_D0);
                msleep(40);
                pwr = snd_hda_codec_read(codec, nid, 0, AC_VERB_GET_POWER_STATE, 0);
                pwr = (pwr & AC_PWRST_ACTUAL) >> AC_PWRST_ACTUAL_SHIFT;
                codec_dbg(codec, "Haswell HDMI audio: Power for pin 0x%x is now D%d\n", nid, pwr);
        }
}

/*
 * Callbacks
 */

/* HBR should be Non-PCM, 8 channels */
#define is_hbr_format(format) \
        ((format & AC_FMT_TYPE_NON_PCM) && (format & AC_FMT_CHAN_MASK) == 7)

static int hdmi_pin_hbr_setup(struct hda_codec *codec, hda_nid_t pin_nid,
                              bool hbr)
{
        int pinctl, new_pinctl;

        if (snd_hda_query_pin_caps(codec, pin_nid) & AC_PINCAP_HBR) {
                pinctl = snd_hda_codec_read(codec, pin_nid, 0,
                                            AC_VERB_GET_PIN_WIDGET_CONTROL, 0);

                if (pinctl < 0)
                        return hbr ? -EINVAL : 0;

                new_pinctl = pinctl & ~AC_PINCTL_EPT;
                if (hbr)
                        new_pinctl |= AC_PINCTL_EPT_HBR;
                else
                        new_pinctl |= AC_PINCTL_EPT_NATIVE;

                codec_dbg(codec,
                          "hdmi_pin_hbr_setup: NID=0x%x, %spinctl=0x%x\n",
                            pin_nid,
                            pinctl == new_pinctl ? "" : "new-",
                            new_pinctl);

                if (pinctl != new_pinctl)
                        snd_hda_codec_write(codec, pin_nid, 0,
                                            AC_VERB_SET_PIN_WIDGET_CONTROL,
                                            new_pinctl);
        } else if (hbr)
                return -EINVAL;

        return 0;
}

static int hdmi_setup_stream(struct hda_codec *codec, hda_nid_t cvt_nid,
                              hda_nid_t pin_nid, u32 stream_tag, int format)
{
        struct hdmi_spec *spec = codec->spec;
        int err;

        err = spec->ops.pin_hbr_setup(codec, pin_nid, is_hbr_format(format));

        if (err) {
                codec_dbg(codec, "hdmi_setup_stream: HBR is not supported\n");
                return err;
        }

        snd_hda_codec_setup_stream(codec, cvt_nid, stream_tag, 0, format);
        return 0;
}

/* Try to find an available converter
 * If pin_idx is less then zero, just try to find an available converter.
 * Otherwise, try to find an available converter and get the cvt mux index
 * of the pin.
 */
static int hdmi_choose_cvt(struct hda_codec *codec,
                           int pin_idx, int *cvt_id)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin;
        struct hdmi_spec_per_cvt *per_cvt = NULL;
        int cvt_idx, mux_idx = 0;

        /* pin_idx < 0 means no pin will be bound to the converter */
        if (pin_idx < 0)
                per_pin = NULL;
        else
                per_pin = get_pin(spec, pin_idx);

        /* Dynamically assign converter to stream */
        for (cvt_idx = 0; cvt_idx < spec->num_cvts; cvt_idx++) {
                per_cvt = get_cvt(spec, cvt_idx);

                /* Must not already be assigned */
                if (per_cvt->assigned)
                        continue;
                if (per_pin == NULL)
                        break;
                /* Must be in pin's mux's list of converters */
                for (mux_idx = 0; mux_idx < per_pin->num_mux_nids; mux_idx++)
                        if (per_pin->mux_nids[mux_idx] == per_cvt->cvt_nid)
                                break;
                /* Not in mux list */
                if (mux_idx == per_pin->num_mux_nids)
                        continue;
                break;
        }

        /* No free converters */
        if (cvt_idx == spec->num_cvts)
                return -EBUSY;

        if (per_pin != NULL)
                per_pin->mux_idx = mux_idx;

        if (cvt_id)
                *cvt_id = cvt_idx;

        return 0;
}

/* Assure the pin select the right convetor */
static void intel_verify_pin_cvt_connect(struct hda_codec *codec,
                        struct hdmi_spec_per_pin *per_pin)
{
        hda_nid_t pin_nid = per_pin->pin_nid;
        int mux_idx, curr;

        mux_idx = per_pin->mux_idx;
        curr = snd_hda_codec_read(codec, pin_nid, 0,
                                          AC_VERB_GET_CONNECT_SEL, 0);
        if (curr != mux_idx)
                snd_hda_codec_write_cache(codec, pin_nid, 0,
                                            AC_VERB_SET_CONNECT_SEL,
                                            mux_idx);
}

/* get the mux index for the converter of the pins
 * converter's mux index is the same for all pins on Intel platform
 */
static int intel_cvt_id_to_mux_idx(struct hdmi_spec *spec,
                        hda_nid_t cvt_nid)
{
        int i;

        for (i = 0; i < spec->num_cvts; i++)
                if (spec->cvt_nids[i] == cvt_nid)
                        return i;
        return -EINVAL;
}

/* Intel HDMI workaround to fix audio routing issue:
 * For some Intel display codecs, pins share the same connection list.
 * So a conveter can be selected by multiple pins and playback on any of these
 * pins will generate sound on the external display, because audio flows from
 * the same converter to the display pipeline. Also muting one pin may make
 * other pins have no sound output.
 * So this function assures that an assigned converter for a pin is not selected
 * by any other pins.
 */
static void intel_not_share_assigned_cvt(struct hda_codec *codec,
                                         hda_nid_t pin_nid,
                                         int dev_id, int mux_idx)
{
        struct hdmi_spec *spec = codec->spec;
        hda_nid_t nid;
        int cvt_idx, curr;
        struct hdmi_spec_per_cvt *per_cvt;
        struct hdmi_spec_per_pin *per_pin;
        int pin_idx;

        /* configure the pins connections */
        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                int dev_id_saved;
                int dev_num;

                per_pin = get_pin(spec, pin_idx);
                /*
                 * pin not connected to monitor
                 * no need to operate on it
                 */
                if (!per_pin->pcm)
                        continue;

                if ((per_pin->pin_nid == pin_nid) &&
                        (per_pin->dev_id == dev_id))
                        continue;

                /*
                 * if per_pin->dev_id >= dev_num,
                 * snd_hda_get_dev_select() will fail,
                 * and the following operation is unpredictable.
                 * So skip this situation.
                 */
                dev_num = snd_hda_get_num_devices(codec, per_pin->pin_nid) + 1;
                if (per_pin->dev_id >= dev_num)
                        continue;

                nid = per_pin->pin_nid;

                /*
                 * Calling this function should not impact
                 * on the device entry selection
                 * So let's save the dev id for each pin,
                 * and restore it when return
                 */
                dev_id_saved = snd_hda_get_dev_select(codec, nid);
                snd_hda_set_dev_select(codec, nid, per_pin->dev_id);
                curr = snd_hda_codec_read(codec, nid, 0,
                                          AC_VERB_GET_CONNECT_SEL, 0);
                if (curr != mux_idx) {
                        snd_hda_set_dev_select(codec, nid, dev_id_saved);
                        continue;
                }


                /* choose an unassigned converter. The conveters in the
                 * connection list are in the same order as in the codec.
                 */
                for (cvt_idx = 0; cvt_idx < spec->num_cvts; cvt_idx++) {
                        per_cvt = get_cvt(spec, cvt_idx);
                        if (!per_cvt->assigned) {
                                codec_dbg(codec,
                                          "choose cvt %d for pin nid %d\n",
                                        cvt_idx, nid);
                                snd_hda_codec_write_cache(codec, nid, 0,
                                            AC_VERB_SET_CONNECT_SEL,
                                            cvt_idx);
                                break;
                        }
                }
                snd_hda_set_dev_select(codec, nid, dev_id_saved);
        }
}

/* A wrapper of intel_not_share_asigned_cvt() */
static void intel_not_share_assigned_cvt_nid(struct hda_codec *codec,
                        hda_nid_t pin_nid, int dev_id, hda_nid_t cvt_nid)
{
        int mux_idx;
        struct hdmi_spec *spec = codec->spec;

        /* On Intel platform, the mapping of converter nid to
         * mux index of the pins are always the same.
         * The pin nid may be 0, this means all pins will not
         * share the converter.
         */
        mux_idx = intel_cvt_id_to_mux_idx(spec, cvt_nid);
        if (mux_idx >= 0)
                intel_not_share_assigned_cvt(codec, pin_nid, dev_id, mux_idx);
}

/* skeleton caller of pin_cvt_fixup ops */
static void pin_cvt_fixup(struct hda_codec *codec,
                          struct hdmi_spec_per_pin *per_pin,
                          hda_nid_t cvt_nid)
{
        struct hdmi_spec *spec = codec->spec;

        if (spec->ops.pin_cvt_fixup)
                spec->ops.pin_cvt_fixup(codec, per_pin, cvt_nid);
}

/* called in hdmi_pcm_open when no pin is assigned to the PCM
 * in dyn_pcm_assign mode.
 */
static int hdmi_pcm_open_no_pin(struct hda_pcm_stream *hinfo,
                         struct hda_codec *codec,
                         struct snd_pcm_substream *substream)
{
        struct hdmi_spec *spec = codec->spec;
        struct snd_pcm_runtime *runtime = substream->runtime;
        int cvt_idx, pcm_idx;
        struct hdmi_spec_per_cvt *per_cvt = NULL;
        int err;

        pcm_idx = hinfo_to_pcm_index(codec, hinfo);
        if (pcm_idx < 0)
                return -EINVAL;

        err = hdmi_choose_cvt(codec, -1, &cvt_idx);
        if (err)
                return err;

        per_cvt = get_cvt(spec, cvt_idx);
        per_cvt->assigned = 1;
        hinfo->nid = per_cvt->cvt_nid;

        pin_cvt_fixup(codec, NULL, per_cvt->cvt_nid);

        set_bit(pcm_idx, &spec->pcm_in_use);
        /* todo: setup spdif ctls assign */

        /* Initially set the converter's capabilities */
        hinfo->channels_min = per_cvt->channels_min;
        hinfo->channels_max = per_cvt->channels_max;
        hinfo->rates = per_cvt->rates;
        hinfo->formats = per_cvt->formats;
        hinfo->maxbps = per_cvt->maxbps;

        /* Store the updated parameters */
        runtime->hw.channels_min = hinfo->channels_min;
        runtime->hw.channels_max = hinfo->channels_max;
        runtime->hw.formats = hinfo->formats;
        runtime->hw.rates = hinfo->rates;

        snd_pcm_hw_constraint_step(substream->runtime, 0,
                                   SNDRV_PCM_HW_PARAM_CHANNELS, 2);
        return 0;
}

/*
 * HDA PCM callbacks
 */
static int hdmi_pcm_open(struct hda_pcm_stream *hinfo,
                         struct hda_codec *codec,
                         struct snd_pcm_substream *substream)
{
        struct hdmi_spec *spec = codec->spec;
        struct snd_pcm_runtime *runtime = substream->runtime;
        int pin_idx, cvt_idx, pcm_idx;
        struct hdmi_spec_per_pin *per_pin;
        struct hdmi_eld *eld;
        struct hdmi_spec_per_cvt *per_cvt = NULL;
        int err;

        /* Validate hinfo */
        pcm_idx = hinfo_to_pcm_index(codec, hinfo);
        if (pcm_idx < 0)
                return -EINVAL;

        mutex_lock(&spec->pcm_lock);
        pin_idx = hinfo_to_pin_index(codec, hinfo);
        if (!spec->dyn_pcm_assign) {
                if (snd_BUG_ON(pin_idx < 0)) {
                        mutex_unlock(&spec->pcm_lock);
                        return -EINVAL;
                }
        } else {
                /* no pin is assigned to the PCM
                 * PA need pcm open successfully when probe
                 */
                if (pin_idx < 0) {
                        err = hdmi_pcm_open_no_pin(hinfo, codec, substream);
                        mutex_unlock(&spec->pcm_lock);
                        return err;
                }
        }

        err = hdmi_choose_cvt(codec, pin_idx, &cvt_idx);
        if (err < 0) {
                mutex_unlock(&spec->pcm_lock);
                return err;
        }

        per_cvt = get_cvt(spec, cvt_idx);
        /* Claim converter */
        per_cvt->assigned = 1;

        set_bit(pcm_idx, &spec->pcm_in_use);
        per_pin = get_pin(spec, pin_idx);
        per_pin->cvt_nid = per_cvt->cvt_nid;
        hinfo->nid = per_cvt->cvt_nid;

        snd_hda_set_dev_select(codec, per_pin->pin_nid, per_pin->dev_id);
        snd_hda_codec_write_cache(codec, per_pin->pin_nid, 0,
                            AC_VERB_SET_CONNECT_SEL,
                            per_pin->mux_idx);

        /* configure unused pins to choose other converters */
        pin_cvt_fixup(codec, per_pin, 0);

        snd_hda_spdif_ctls_assign(codec, pcm_idx, per_cvt->cvt_nid);

        /* Initially set the converter's capabilities */
        hinfo->channels_min = per_cvt->channels_min;
        hinfo->channels_max = per_cvt->channels_max;
        hinfo->rates = per_cvt->rates;
        hinfo->formats = per_cvt->formats;
        hinfo->maxbps = per_cvt->maxbps;

        eld = &per_pin->sink_eld;
        /* Restrict capabilities by ELD if this isn't disabled */
        if (!static_hdmi_pcm && eld->eld_valid) {
                snd_hdmi_eld_update_pcm_info(&eld->info, hinfo);
                if (hinfo->channels_min > hinfo->channels_max ||
                    !hinfo->rates || !hinfo->formats) {
                        per_cvt->assigned = 0;
                        hinfo->nid = 0;
                        snd_hda_spdif_ctls_unassign(codec, pcm_idx);
                        mutex_unlock(&spec->pcm_lock);
                        return -ENODEV;
                }
        }

        mutex_unlock(&spec->pcm_lock);
        /* Store the updated parameters */
        runtime->hw.channels_min = hinfo->channels_min;
        runtime->hw.channels_max = hinfo->channels_max;
        runtime->hw.formats = hinfo->formats;
        runtime->hw.rates = hinfo->rates;

        snd_pcm_hw_constraint_step(substream->runtime, 0,
                                   SNDRV_PCM_HW_PARAM_CHANNELS, 2);
        return 0;
}

/*
 * HDA/HDMI auto parsing
 */
static int hdmi_read_pin_conn(struct hda_codec *codec, int pin_idx)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin = get_pin(spec, pin_idx);
        hda_nid_t pin_nid = per_pin->pin_nid;

        if (!(get_wcaps(codec, pin_nid) & AC_WCAP_CONN_LIST)) {
                codec_warn(codec,
                           "HDMI: pin %d wcaps %#x does not support connection list\n",
                           pin_nid, get_wcaps(codec, pin_nid));
                return -EINVAL;
        }

        /* all the device entries on the same pin have the same conn list */
        per_pin->num_mux_nids = snd_hda_get_connections(codec, pin_nid,
                                                        per_pin->mux_nids,
                                                        HDA_MAX_CONNECTIONS);

        return 0;
}

static int hdmi_find_pcm_slot(struct hdmi_spec *spec,
                                struct hdmi_spec_per_pin *per_pin)
{
        int i;

        /* try the prefer PCM */
        if (!test_bit(per_pin->pin_nid_idx, &spec->pcm_bitmap))
                return per_pin->pin_nid_idx;

        /* have a second try; check the "reserved area" over num_pins */
        for (i = spec->num_nids; i < spec->pcm_used; i++) {
                if (!test_bit(i, &spec->pcm_bitmap))
                        return i;
        }

        /* the last try; check the empty slots in pins */
        for (i = 0; i < spec->num_nids; i++) {
                if (!test_bit(i, &spec->pcm_bitmap))
                        return i;
        }
        return -EBUSY;
}

static void hdmi_attach_hda_pcm(struct hdmi_spec *spec,
                                struct hdmi_spec_per_pin *per_pin)
{
        int idx;

        /* pcm already be attached to the pin */
        if (per_pin->pcm)
                return;
        idx = hdmi_find_pcm_slot(spec, per_pin);
        if (idx == -EBUSY)
                return;
        per_pin->pcm_idx = idx;
        per_pin->pcm = get_hdmi_pcm(spec, idx);
        set_bit(idx, &spec->pcm_bitmap);
}

static void hdmi_detach_hda_pcm(struct hdmi_spec *spec,
                                struct hdmi_spec_per_pin *per_pin)
{
        int idx;

        /* pcm already be detached from the pin */
        if (!per_pin->pcm)
                return;
        idx = per_pin->pcm_idx;
        per_pin->pcm_idx = -1;
        per_pin->pcm = NULL;
        if (idx >= 0 && idx < spec->pcm_used)
                clear_bit(idx, &spec->pcm_bitmap);
}

static int hdmi_get_pin_cvt_mux(struct hdmi_spec *spec,
                struct hdmi_spec_per_pin *per_pin, hda_nid_t cvt_nid)
{
        int mux_idx;

        for (mux_idx = 0; mux_idx < per_pin->num_mux_nids; mux_idx++)
                if (per_pin->mux_nids[mux_idx] == cvt_nid)
                        break;
        return mux_idx;
}

static bool check_non_pcm_per_cvt(struct hda_codec *codec, hda_nid_t cvt_nid);

static void hdmi_pcm_setup_pin(struct hdmi_spec *spec,
                           struct hdmi_spec_per_pin *per_pin)
{
        struct hda_codec *codec = per_pin->codec;
        struct hda_pcm *pcm;
        struct hda_pcm_stream *hinfo;
        struct snd_pcm_substream *substream;
        int mux_idx;
        bool non_pcm;

        if (per_pin->pcm_idx >= 0 && per_pin->pcm_idx < spec->pcm_used)
                pcm = get_pcm_rec(spec, per_pin->pcm_idx);
        else
                return;
        if (!test_bit(per_pin->pcm_idx, &spec->pcm_in_use))
                return;

        /* hdmi audio only uses playback and one substream */
        hinfo = pcm->stream;
        substream = pcm->pcm->streams[0].substream;

        per_pin->cvt_nid = hinfo->nid;

        mux_idx = hdmi_get_pin_cvt_mux(spec, per_pin, hinfo->nid);
        if (mux_idx < per_pin->num_mux_nids) {
                snd_hda_set_dev_select(codec, per_pin->pin_nid,
                                   per_pin->dev_id);
                snd_hda_codec_write_cache(codec, per_pin->pin_nid, 0,
                                AC_VERB_SET_CONNECT_SEL,
                                mux_idx);
        }
        snd_hda_spdif_ctls_assign(codec, per_pin->pcm_idx, hinfo->nid);

        non_pcm = check_non_pcm_per_cvt(codec, hinfo->nid);
        if (substream->runtime)
                per_pin->channels = substream->runtime->channels;
        per_pin->setup = true;
        per_pin->mux_idx = mux_idx;

        hdmi_setup_audio_infoframe(codec, per_pin, non_pcm);
}

static void hdmi_pcm_reset_pin(struct hdmi_spec *spec,
                           struct hdmi_spec_per_pin *per_pin)
{
        if (per_pin->pcm_idx >= 0 && per_pin->pcm_idx < spec->pcm_used)
                snd_hda_spdif_ctls_unassign(per_pin->codec, per_pin->pcm_idx);

        per_pin->chmap_set = false;
        memset(per_pin->chmap, 0, sizeof(per_pin->chmap));

        per_pin->setup = false;
        per_pin->channels = 0;
}

/* update per_pin ELD from the given new ELD;
 * setup info frame and notification accordingly
 */
static void update_eld(struct hda_codec *codec,
                       struct hdmi_spec_per_pin *per_pin,
                       struct hdmi_eld *eld)
{
        struct hdmi_eld *pin_eld = &per_pin->sink_eld;
        struct hdmi_spec *spec = codec->spec;
        bool old_eld_valid = pin_eld->eld_valid;
        bool eld_changed;
        int pcm_idx = -1;

        /* for monitor disconnection, save pcm_idx firstly */
        pcm_idx = per_pin->pcm_idx;
        if (spec->dyn_pcm_assign) {
                if (eld->eld_valid) {
                        hdmi_attach_hda_pcm(spec, per_pin);
                        hdmi_pcm_setup_pin(spec, per_pin);
                } else {
                        hdmi_pcm_reset_pin(spec, per_pin);
                        hdmi_detach_hda_pcm(spec, per_pin);
                }
        }
        /* if pcm_idx == -1, it means this is in monitor connection event
         * we can get the correct pcm_idx now.
         */
        if (pcm_idx == -1)
                pcm_idx = per_pin->pcm_idx;

        if (eld->eld_valid)
                snd_hdmi_show_eld(codec, &eld->info);

        eld_changed = (pin_eld->eld_valid != eld->eld_valid);
        if (eld->eld_valid && pin_eld->eld_valid)
                if (pin_eld->eld_size != eld->eld_size ||
                    memcmp(pin_eld->eld_buffer, eld->eld_buffer,
                           eld->eld_size) != 0)
                        eld_changed = true;

        pin_eld->monitor_present = eld->monitor_present;
        pin_eld->eld_valid = eld->eld_valid;
        pin_eld->eld_size = eld->eld_size;
        if (eld->eld_valid)
                memcpy(pin_eld->eld_buffer, eld->eld_buffer, eld->eld_size);
        pin_eld->info = eld->info;

        /*
         * Re-setup pin and infoframe. This is needed e.g. when
         * - sink is first plugged-in
         * - transcoder can change during stream playback on Haswell
         *   and this can make HW reset converter selection on a pin.
         */
        if (eld->eld_valid && !old_eld_valid && per_pin->setup) {
                pin_cvt_fixup(codec, per_pin, 0);
                hdmi_setup_audio_infoframe(codec, per_pin, per_pin->non_pcm);
        }

        if (eld_changed && pcm_idx >= 0)
                snd_ctl_notify(codec->card,
                               SNDRV_CTL_EVENT_MASK_VALUE |
                               SNDRV_CTL_EVENT_MASK_INFO,
                               &get_hdmi_pcm(spec, pcm_idx)->eld_ctl->id);
}

/* update ELD and jack state via HD-audio verbs */
static bool hdmi_present_sense_via_verbs(struct hdmi_spec_per_pin *per_pin,
                                         int repoll)
{
        struct hda_jack_tbl *jack;
        struct hda_codec *codec = per_pin->codec;
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_eld *eld = &spec->temp_eld;
        hda_nid_t pin_nid = per_pin->pin_nid;
        /*
         * Always execute a GetPinSense verb here, even when called from
         * hdmi_intrinsic_event; for some NVIDIA HW, the unsolicited
         * response's PD bit is not the real PD value, but indicates that
         * the real PD value changed. An older version of the HD-audio
         * specification worked this way. Hence, we just ignore the data in
         * the unsolicited response to avoid custom WARs.
         */
        int present;
        bool ret;
        bool do_repoll = false;

        present = snd_hda_pin_sense(codec, pin_nid);

        mutex_lock(&per_pin->lock);
        eld->monitor_present = !!(present & AC_PINSENSE_PRESENCE);
        if (eld->monitor_present)
                eld->eld_valid  = !!(present & AC_PINSENSE_ELDV);
        else
                eld->eld_valid = false;

        codec_dbg(codec,
                "HDMI status: Codec=%d Pin=%d Presence_Detect=%d ELD_Valid=%d\n",
                codec->addr, pin_nid, eld->monitor_present, eld->eld_valid);

        if (eld->eld_valid) {
                if (spec->ops.pin_get_eld(codec, pin_nid, eld->eld_buffer,
                                                     &eld->eld_size) < 0)
                        eld->eld_valid = false;
                else {
                        if (snd_hdmi_parse_eld(codec, &eld->info, eld->eld_buffer,
                                                    eld->eld_size) < 0)
                                eld->eld_valid = false;
                }
                if (!eld->eld_valid && repoll)
                        do_repoll = true;
        }

        if (do_repoll)
                schedule_delayed_work(&per_pin->work, msecs_to_jiffies(300));
        else
                update_eld(codec, per_pin, eld);

        ret = !repoll || !eld->monitor_present || eld->eld_valid;

        jack = snd_hda_jack_tbl_get(codec, pin_nid);
        if (jack)
                jack->block_report = !ret;

        mutex_unlock(&per_pin->lock);
        return ret;
}

static struct snd_jack *pin_idx_to_jack(struct hda_codec *codec,
                                 struct hdmi_spec_per_pin *per_pin)
{
        struct hdmi_spec *spec = codec->spec;
        struct snd_jack *jack = NULL;
        struct hda_jack_tbl *jack_tbl;

        /* if !dyn_pcm_assign, get jack from hda_jack_tbl
         * in !dyn_pcm_assign case, spec->pcm_rec[].jack is not
         * NULL even after snd_hda_jack_tbl_clear() is called to
         * free snd_jack. This may cause access invalid memory
         * when calling snd_jack_report
         */
        if (per_pin->pcm_idx >= 0 && spec->dyn_pcm_assign)
                jack = spec->pcm_rec[per_pin->pcm_idx].jack;
        else if (!spec->dyn_pcm_assign) {
                /*
                 * jack tbl doesn't support DP MST
                 * DP MST will use dyn_pcm_assign,
                 * so DP MST will never come here
                 */
                jack_tbl = snd_hda_jack_tbl_get(codec, per_pin->pin_nid);
                if (jack_tbl)
                        jack = jack_tbl->jack;
        }
        return jack;
}

/* update ELD and jack state via audio component */
static void sync_eld_via_acomp(struct hda_codec *codec,
                               struct hdmi_spec_per_pin *per_pin)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_eld *eld = &spec->temp_eld;
        struct snd_jack *jack = NULL;
        int size;

        mutex_lock(&per_pin->lock);
        eld->monitor_present = false;
        size = snd_hdac_acomp_get_eld(&codec->core, per_pin->pin_nid,
                                      per_pin->dev_id, &eld->monitor_present,
                                      eld->eld_buffer, ELD_MAX_SIZE);
        if (size > 0) {
                size = min(size, ELD_MAX_SIZE);
                if (snd_hdmi_parse_eld(codec, &eld->info,
                                       eld->eld_buffer, size) < 0)
                        size = -EINVAL;
        }

        if (size > 0) {
                eld->eld_valid = true;
                eld->eld_size = size;
        } else {
                eld->eld_valid = false;
                eld->eld_size = 0;
        }

        /* pcm_idx >=0 before update_eld() means it is in monitor
         * disconnected event. Jack must be fetched before update_eld()
         */
        jack = pin_idx_to_jack(codec, per_pin);
        update_eld(codec, per_pin, eld);
        if (jack == NULL)
                jack = pin_idx_to_jack(codec, per_pin);
        if (jack == NULL)
                goto unlock;
        snd_jack_report(jack,
                        eld->monitor_present ? SND_JACK_AVOUT : 0);
 unlock:
        mutex_unlock(&per_pin->lock);
}

static bool hdmi_present_sense(struct hdmi_spec_per_pin *per_pin, int repoll)
{
        struct hda_codec *codec = per_pin->codec;
        struct hdmi_spec *spec = codec->spec;
        int ret;

        /* no temporary power up/down needed for component notifier */
        if (!codec_has_acomp(codec))
                snd_hda_power_up_pm(codec);

        mutex_lock(&spec->pcm_lock);
        if (codec_has_acomp(codec)) {
                sync_eld_via_acomp(codec, per_pin);
                ret = false; /* don't call snd_hda_jack_report_sync() */
        } else {
                ret = hdmi_present_sense_via_verbs(per_pin, repoll);
        }
        mutex_unlock(&spec->pcm_lock);

        if (!codec_has_acomp(codec))
                snd_hda_power_down_pm(codec);

        return ret;
}

static void hdmi_repoll_eld(struct work_struct *work)
{
        struct hdmi_spec_per_pin *per_pin =
        container_of(to_delayed_work(work), struct hdmi_spec_per_pin, work);

        if (per_pin->repoll_count++ > 6)
                per_pin->repoll_count = 0;

        if (hdmi_present_sense(per_pin, per_pin->repoll_count))
                snd_hda_jack_report_sync(per_pin->codec);
}

static void intel_haswell_fixup_connect_list(struct hda_codec *codec,
                                             hda_nid_t nid);

static int hdmi_add_pin(struct hda_codec *codec, hda_nid_t pin_nid)
{
        struct hdmi_spec *spec = codec->spec;
        unsigned int caps, config;
        int pin_idx;
        struct hdmi_spec_per_pin *per_pin;
        int err;
        int dev_num, i;

        caps = snd_hda_query_pin_caps(codec, pin_nid);
        if (!(caps & (AC_PINCAP_HDMI | AC_PINCAP_DP)))
                return 0;

        /*
         * For DP MST audio, Configuration Default is the same for
         * all device entries on the same pin
         */
        config = snd_hda_codec_get_pincfg(codec, pin_nid);
        if (get_defcfg_connect(config) == AC_JACK_PORT_NONE)
                return 0;

        /*
         * To simplify the implementation, malloc all
         * the virtual pins in the initialization statically
         */
        if (is_haswell_plus(codec)) {
                /*
                 * On Intel platforms, device entries number is
                 * changed dynamically. If there is a DP MST
                 * hub connected, the device entries number is 3.
                 * Otherwise, it is 1.
                 * Here we manually set dev_num to 3, so that
                 * we can initialize all the device entries when
                 * bootup statically.
                 */
                dev_num = 3;
                spec->dev_num = 3;
        } else if (spec->dyn_pcm_assign && codec->dp_mst) {
                dev_num = snd_hda_get_num_devices(codec, pin_nid) + 1;
                /*
                 * spec->dev_num is the maxinum number of device entries
                 * among all the pins
                 */
                spec->dev_num = (spec->dev_num > dev_num) ?
                        spec->dev_num : dev_num;
        } else {
                /*
                 * If the platform doesn't support DP MST,
                 * manually set dev_num to 1. This means
                 * the pin has only one device entry.
                 */
                dev_num = 1;
                spec->dev_num = 1;
        }

        for (i = 0; i < dev_num; i++) {
                pin_idx = spec->num_pins;
                per_pin = snd_array_new(&spec->pins);

                if (!per_pin)
                        return -ENOMEM;

                if (spec->dyn_pcm_assign) {
                        per_pin->pcm = NULL;
                        per_pin->pcm_idx = -1;
                } else {
                        per_pin->pcm = get_hdmi_pcm(spec, pin_idx);
                        per_pin->pcm_idx = pin_idx;
                }
                per_pin->pin_nid = pin_nid;
                per_pin->pin_nid_idx = spec->num_nids;
                per_pin->dev_id = i;
                per_pin->non_pcm = false;
                snd_hda_set_dev_select(codec, pin_nid, i);
                if (is_haswell_plus(codec))
                        intel_haswell_fixup_connect_list(codec, pin_nid);
                err = hdmi_read_pin_conn(codec, pin_idx);
                if (err < 0)
                        return err;
                spec->num_pins++;
        }
        spec->num_nids++;

        return 0;
}

static int hdmi_add_cvt(struct hda_codec *codec, hda_nid_t cvt_nid)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_cvt *per_cvt;
        unsigned int chans;
        int err;

        chans = get_wcaps(codec, cvt_nid);
        chans = get_wcaps_channels(chans);

        per_cvt = snd_array_new(&spec->cvts);
        if (!per_cvt)
                return -ENOMEM;

        per_cvt->cvt_nid = cvt_nid;
        per_cvt->channels_min = 2;
        if (chans <= 16) {
                per_cvt->channels_max = chans;
                if (chans > spec->chmap.channels_max)
                        spec->chmap.channels_max = chans;
        }

        err = snd_hda_query_supported_pcm(codec, cvt_nid,
                                          &per_cvt->rates,
                                          &per_cvt->formats,
                                          &per_cvt->maxbps);
        if (err < 0)
                return err;

        if (spec->num_cvts < ARRAY_SIZE(spec->cvt_nids))
                spec->cvt_nids[spec->num_cvts] = cvt_nid;
        spec->num_cvts++;

        return 0;
}

static int hdmi_parse_codec(struct hda_codec *codec)
{
        hda_nid_t nid;
        int i, nodes;

        nodes = snd_hda_get_sub_nodes(codec, codec->core.afg, &nid);
        if (!nid || nodes < 0) {
                codec_warn(codec, "HDMI: failed to get afg sub nodes\n");
                return -EINVAL;
        }

        for (i = 0; i < nodes; i++, nid++) {
                unsigned int caps;
                unsigned int type;

                caps = get_wcaps(codec, nid);
                type = get_wcaps_type(caps);

                if (!(caps & AC_WCAP_DIGITAL))
                        continue;

                switch (type) {
                case AC_WID_AUD_OUT:
                        hdmi_add_cvt(codec, nid);
                        break;
                case AC_WID_PIN:
                        hdmi_add_pin(codec, nid);
                        break;
                }
        }

        return 0;
}

/*
 */
static bool check_non_pcm_per_cvt(struct hda_codec *codec, hda_nid_t cvt_nid)
{
        struct hda_spdif_out *spdif;
        bool non_pcm;

        mutex_lock(&codec->spdif_mutex);
        spdif = snd_hda_spdif_out_of_nid(codec, cvt_nid);
        /* Add sanity check to pass klockwork check.
         * This should never happen.
         */
        if (WARN_ON(spdif == NULL))
                return true;
        non_pcm = !!(spdif->status & IEC958_AES0_NONAUDIO);
        mutex_unlock(&codec->spdif_mutex);
        return non_pcm;
}

/*
 * HDMI callbacks
 */

static int generic_hdmi_playback_pcm_prepare(struct hda_pcm_stream *hinfo,
                                           struct hda_codec *codec,
                                           unsigned int stream_tag,
                                           unsigned int format,
                                           struct snd_pcm_substream *substream)
{
        hda_nid_t cvt_nid = hinfo->nid;
        struct hdmi_spec *spec = codec->spec;
        int pin_idx;
        struct hdmi_spec_per_pin *per_pin;
        hda_nid_t pin_nid;
        struct snd_pcm_runtime *runtime = substream->runtime;
        bool non_pcm;
        int pinctl;
        int err;

        mutex_lock(&spec->pcm_lock);
        pin_idx = hinfo_to_pin_index(codec, hinfo);
        if (spec->dyn_pcm_assign && pin_idx < 0) {
                /* when dyn_pcm_assign and pcm is not bound to a pin
                 * skip pin setup and return 0 to make audio playback
                 * be ongoing
                 */
                pin_cvt_fixup(codec, NULL, cvt_nid);
                snd_hda_codec_setup_stream(codec, cvt_nid,
                                        stream_tag, 0, format);
                mutex_unlock(&spec->pcm_lock);
                return 0;
        }

        if (snd_BUG_ON(pin_idx < 0)) {
                mutex_unlock(&spec->pcm_lock);
                return -EINVAL;
        }
        per_pin = get_pin(spec, pin_idx);
        pin_nid = per_pin->pin_nid;

        /* Verify pin:cvt selections to avoid silent audio after S3.
         * After S3, the audio driver restores pin:cvt selections
         * but this can happen before gfx is ready and such selection
         * is overlooked by HW. Thus multiple pins can share a same
         * default convertor and mute control will affect each other,
         * which can cause a resumed audio playback become silent
         * after S3.
         */
        pin_cvt_fixup(codec, per_pin, 0);

        /* Call sync_audio_rate to set the N/CTS/M manually if necessary */
        /* Todo: add DP1.2 MST audio support later */
        if (codec_has_acomp(codec))
                snd_hdac_sync_audio_rate(&codec->core, pin_nid, per_pin->dev_id,
                                         runtime->rate);

        non_pcm = check_non_pcm_per_cvt(codec, cvt_nid);
        mutex_lock(&per_pin->lock);
        per_pin->channels = substream->runtime->channels;
        per_pin->setup = true;

        hdmi_setup_audio_infoframe(codec, per_pin, non_pcm);
        mutex_unlock(&per_pin->lock);
        if (spec->dyn_pin_out) {
                pinctl = snd_hda_codec_read(codec, pin_nid, 0,
                                            AC_VERB_GET_PIN_WIDGET_CONTROL, 0);
                snd_hda_codec_write(codec, pin_nid, 0,
                                    AC_VERB_SET_PIN_WIDGET_CONTROL,
                                    pinctl | PIN_OUT);
        }

        /* snd_hda_set_dev_select() has been called before */
        err = spec->ops.setup_stream(codec, cvt_nid, pin_nid,
                                 stream_tag, format);
        mutex_unlock(&spec->pcm_lock);
        return err;
}

static int generic_hdmi_playback_pcm_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 hdmi_pcm_close(struct hda_pcm_stream *hinfo,
                          struct hda_codec *codec,
                          struct snd_pcm_substream *substream)
{
        struct hdmi_spec *spec = codec->spec;
        int cvt_idx, pin_idx, pcm_idx;
        struct hdmi_spec_per_cvt *per_cvt;
        struct hdmi_spec_per_pin *per_pin;
        int pinctl;

        if (hinfo->nid) {
                pcm_idx = hinfo_to_pcm_index(codec, hinfo);
                if (snd_BUG_ON(pcm_idx < 0))
                        return -EINVAL;
                cvt_idx = cvt_nid_to_cvt_index(codec, hinfo->nid);
                if (snd_BUG_ON(cvt_idx < 0))
                        return -EINVAL;
                per_cvt = get_cvt(spec, cvt_idx);

                snd_BUG_ON(!per_cvt->assigned);
                per_cvt->assigned = 0;
                hinfo->nid = 0;

                mutex_lock(&spec->pcm_lock);
                snd_hda_spdif_ctls_unassign(codec, pcm_idx);
                clear_bit(pcm_idx, &spec->pcm_in_use);
                pin_idx = hinfo_to_pin_index(codec, hinfo);
                if (spec->dyn_pcm_assign && pin_idx < 0) {
                        mutex_unlock(&spec->pcm_lock);
                        return 0;
                }

                if (snd_BUG_ON(pin_idx < 0)) {
                        mutex_unlock(&spec->pcm_lock);
                        return -EINVAL;
                }
                per_pin = get_pin(spec, pin_idx);

                if (spec->dyn_pin_out) {
                        pinctl = snd_hda_codec_read(codec, per_pin->pin_nid, 0,
                                        AC_VERB_GET_PIN_WIDGET_CONTROL, 0);
                        snd_hda_codec_write(codec, per_pin->pin_nid, 0,
                                            AC_VERB_SET_PIN_WIDGET_CONTROL,
                                            pinctl & ~PIN_OUT);
                }

                mutex_lock(&per_pin->lock);
                per_pin->chmap_set = false;
                memset(per_pin->chmap, 0, sizeof(per_pin->chmap));

                per_pin->setup = false;
                per_pin->channels = 0;
                mutex_unlock(&per_pin->lock);
                mutex_unlock(&spec->pcm_lock);
        }

        return 0;
}

static const struct hda_pcm_ops generic_ops = {
        .open = hdmi_pcm_open,
        .close = hdmi_pcm_close,
        .prepare = generic_hdmi_playback_pcm_prepare,
        .cleanup = generic_hdmi_playback_pcm_cleanup,
};

static int hdmi_get_spk_alloc(struct hdac_device *hdac, int pcm_idx)
{
        struct hda_codec *codec = container_of(hdac, struct hda_codec, core);
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin = pcm_idx_to_pin(spec, pcm_idx);

        if (!per_pin)
                return 0;

        return per_pin->sink_eld.info.spk_alloc;
}

static void hdmi_get_chmap(struct hdac_device *hdac, int pcm_idx,
                                        unsigned char *chmap)
{
        struct hda_codec *codec = container_of(hdac, struct hda_codec, core);
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin = pcm_idx_to_pin(spec, pcm_idx);

        /* chmap is already set to 0 in caller */
        if (!per_pin)
                return;

        memcpy(chmap, per_pin->chmap, ARRAY_SIZE(per_pin->chmap));
}

static void hdmi_set_chmap(struct hdac_device *hdac, int pcm_idx,
                                unsigned char *chmap, int prepared)
{
        struct hda_codec *codec = container_of(hdac, struct hda_codec, core);
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin = pcm_idx_to_pin(spec, pcm_idx);

        if (!per_pin)
                return;
        mutex_lock(&per_pin->lock);
        per_pin->chmap_set = true;
        memcpy(per_pin->chmap, chmap, ARRAY_SIZE(per_pin->chmap));
        if (prepared)
                hdmi_setup_audio_infoframe(codec, per_pin, per_pin->non_pcm);
        mutex_unlock(&per_pin->lock);
}

static bool is_hdmi_pcm_attached(struct hdac_device *hdac, int pcm_idx)
{
        struct hda_codec *codec = container_of(hdac, struct hda_codec, core);
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin = pcm_idx_to_pin(spec, pcm_idx);

        return per_pin ? true:false;
}

static int generic_hdmi_build_pcms(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int idx;

        /*
         * for non-mst mode, pcm number is the same as before
         * for DP MST mode, pcm number is (nid number + dev_num - 1)
         *  dev_num is the device entry number in a pin
         *
         */
        for (idx = 0; idx < spec->num_nids + spec->dev_num - 1; idx++) {
                struct hda_pcm *info;
                struct hda_pcm_stream *pstr;

                info = snd_hda_codec_pcm_new(codec, "HDMI %d", idx);
                if (!info)
                        return -ENOMEM;

                spec->pcm_rec[idx].pcm = info;
                spec->pcm_used++;
                info->pcm_type = HDA_PCM_TYPE_HDMI;
                info->own_chmap = true;

                pstr = &info->stream[SNDRV_PCM_STREAM_PLAYBACK];
                pstr->substreams = 1;
                pstr->ops = generic_ops;
                /* pcm number is less than 16 */
                if (spec->pcm_used >= 16)
                        break;
                /* other pstr fields are set in open */
        }

        return 0;
}

static void free_hdmi_jack_priv(struct snd_jack *jack)
{
        struct hdmi_pcm *pcm = jack->private_data;

        pcm->jack = NULL;
}

static int add_hdmi_jack_kctl(struct hda_codec *codec,
                               struct hdmi_spec *spec,
                               int pcm_idx,
                               const char *name)
{
        struct snd_jack *jack;
        int err;

        err = snd_jack_new(codec->card, name, SND_JACK_AVOUT, &jack,
                           true, false);
        if (err < 0)
                return err;

        spec->pcm_rec[pcm_idx].jack = jack;
        jack->private_data = &spec->pcm_rec[pcm_idx];
        jack->private_free = free_hdmi_jack_priv;
        return 0;
}

static int generic_hdmi_build_jack(struct hda_codec *codec, int pcm_idx)
{
        char hdmi_str[32] = "HDMI/DP";
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin;
        struct hda_jack_tbl *jack;
        int pcmdev = get_pcm_rec(spec, pcm_idx)->device;
        bool phantom_jack;
        int ret;

        if (pcmdev > 0)
                sprintf(hdmi_str + strlen(hdmi_str), ",pcm=%d", pcmdev);

        if (spec->dyn_pcm_assign)
                return add_hdmi_jack_kctl(codec, spec, pcm_idx, hdmi_str);

        /* for !dyn_pcm_assign, we still use hda_jack for compatibility */
        /* if !dyn_pcm_assign, it must be non-MST mode.
         * This means pcms and pins are statically mapped.
         * And pcm_idx is pin_idx.
         */
        per_pin = get_pin(spec, pcm_idx);
        phantom_jack = !is_jack_detectable(codec, per_pin->pin_nid);
        if (phantom_jack)
                strncat(hdmi_str, " Phantom",
                        sizeof(hdmi_str) - strlen(hdmi_str) - 1);
        ret = snd_hda_jack_add_kctl(codec, per_pin->pin_nid, hdmi_str,
                                    phantom_jack);
        if (ret < 0)
                return ret;
        jack = snd_hda_jack_tbl_get(codec, per_pin->pin_nid);
        if (jack == NULL)
                return 0;
        /* assign jack->jack to pcm_rec[].jack to
         * align with dyn_pcm_assign mode
         */
        spec->pcm_rec[pcm_idx].jack = jack->jack;
        return 0;
}

static int generic_hdmi_build_controls(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int err;
        int pin_idx, pcm_idx;


        for (pcm_idx = 0; pcm_idx < spec->pcm_used; pcm_idx++) {
                err = generic_hdmi_build_jack(codec, pcm_idx);
                if (err < 0)
                        return err;

                /* create the spdif for each pcm
                 * pin will be bound when monitor is connected
                 */
                if (spec->dyn_pcm_assign)
                        err = snd_hda_create_dig_out_ctls(codec,
                                          0, spec->cvt_nids[0],
                                          HDA_PCM_TYPE_HDMI);
                else {
                        struct hdmi_spec_per_pin *per_pin =
                                get_pin(spec, pcm_idx);
                        err = snd_hda_create_dig_out_ctls(codec,
                                                  per_pin->pin_nid,
                                                  per_pin->mux_nids[0],
                                                  HDA_PCM_TYPE_HDMI);
                }
                if (err < 0)
                        return err;
                snd_hda_spdif_ctls_unassign(codec, pcm_idx);

                /* add control for ELD Bytes */
                err = hdmi_create_eld_ctl(codec, pcm_idx,
                                        get_pcm_rec(spec, pcm_idx)->device);
                if (err < 0)
                        return err;
        }

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                struct hdmi_spec_per_pin *per_pin = get_pin(spec, pin_idx);

                hdmi_present_sense(per_pin, 0);
        }

        /* add channel maps */
        for (pcm_idx = 0; pcm_idx < spec->pcm_used; pcm_idx++) {
                struct hda_pcm *pcm;

                pcm = get_pcm_rec(spec, pcm_idx);
                if (!pcm || !pcm->pcm)
                        break;
                err = snd_hdac_add_chmap_ctls(pcm->pcm, pcm_idx, &spec->chmap);
                if (err < 0)
                        return err;
        }

        return 0;
}

static int generic_hdmi_init_per_pins(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_idx;

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                struct hdmi_spec_per_pin *per_pin = get_pin(spec, pin_idx);

                per_pin->codec = codec;
                mutex_init(&per_pin->lock);
                INIT_DELAYED_WORK(&per_pin->work, hdmi_repoll_eld);
                eld_proc_new(per_pin, pin_idx);
        }
        return 0;
}

static int generic_hdmi_init(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_idx;

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                struct hdmi_spec_per_pin *per_pin = get_pin(spec, pin_idx);
                hda_nid_t pin_nid = per_pin->pin_nid;
                int dev_id = per_pin->dev_id;

                snd_hda_set_dev_select(codec, pin_nid, dev_id);
                hdmi_init_pin(codec, pin_nid);
                if (!codec_has_acomp(codec))
                        snd_hda_jack_detect_enable_callback(codec, pin_nid,
                                codec->jackpoll_interval > 0 ?
                                jack_callback : NULL);
        }
        return 0;
}

static void hdmi_array_init(struct hdmi_spec *spec, int nums)
{
        snd_array_init(&spec->pins, sizeof(struct hdmi_spec_per_pin), nums);
        snd_array_init(&spec->cvts, sizeof(struct hdmi_spec_per_cvt), nums);
}

static void hdmi_array_free(struct hdmi_spec *spec)
{
        snd_array_free(&spec->pins);
        snd_array_free(&spec->cvts);
}

static void generic_spec_free(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;

        if (spec) {
                if (spec->i915_bound)
                        snd_hdac_i915_exit(&codec->bus->core);
                hdmi_array_free(spec);
                kfree(spec);
                codec->spec = NULL;
        }
        codec->dp_mst = false;
}

static void generic_hdmi_free(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_idx, pcm_idx;

        if (codec_has_acomp(codec))
                snd_hdac_i915_register_notifier(NULL);

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                struct hdmi_spec_per_pin *per_pin = get_pin(spec, pin_idx);
                cancel_delayed_work_sync(&per_pin->work);
                eld_proc_free(per_pin);
        }

        for (pcm_idx = 0; pcm_idx < spec->pcm_used; pcm_idx++) {
                if (spec->pcm_rec[pcm_idx].jack == NULL)
                        continue;
                if (spec->dyn_pcm_assign)
                        snd_device_free(codec->card,
                                        spec->pcm_rec[pcm_idx].jack);
                else
                        spec->pcm_rec[pcm_idx].jack = NULL;
        }

        generic_spec_free(codec);
}

#ifdef CONFIG_PM
static int generic_hdmi_resume(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_idx;

        codec->patch_ops.init(codec);
        regcache_sync(codec->core.regmap);

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                struct hdmi_spec_per_pin *per_pin = get_pin(spec, pin_idx);
                hdmi_present_sense(per_pin, 1);
        }
        return 0;
}
#endif

static const struct hda_codec_ops generic_hdmi_patch_ops = {
        .init                   = generic_hdmi_init,
        .free                   = generic_hdmi_free,
        .build_pcms             = generic_hdmi_build_pcms,
        .build_controls         = generic_hdmi_build_controls,
        .unsol_event            = hdmi_unsol_event,
#ifdef CONFIG_PM
        .resume                 = generic_hdmi_resume,
#endif
};

static const struct hdmi_ops generic_standard_hdmi_ops = {
        .pin_get_eld                            = snd_hdmi_get_eld,
        .pin_setup_infoframe                    = hdmi_pin_setup_infoframe,
        .pin_hbr_setup                          = hdmi_pin_hbr_setup,
        .setup_stream                           = hdmi_setup_stream,
};

/* allocate codec->spec and assign/initialize generic parser ops */
static int alloc_generic_hdmi(struct hda_codec *codec)
{
        struct hdmi_spec *spec;

        spec = kzalloc(sizeof(*spec), GFP_KERNEL);
        if (!spec)
                return -ENOMEM;

        spec->ops = generic_standard_hdmi_ops;
        spec->dev_num = 1;      /* initialize to 1 */
        mutex_init(&spec->pcm_lock);
        snd_hdac_register_chmap_ops(&codec->core, &spec->chmap);

        spec->chmap.ops.get_chmap = hdmi_get_chmap;
        spec->chmap.ops.set_chmap = hdmi_set_chmap;
        spec->chmap.ops.is_pcm_attached = is_hdmi_pcm_attached;
        spec->chmap.ops.get_spk_alloc = hdmi_get_spk_alloc,

        codec->spec = spec;
        hdmi_array_init(spec, 4);

        codec->patch_ops = generic_hdmi_patch_ops;

        return 0;
}

/* generic HDMI parser */
static int patch_generic_hdmi(struct hda_codec *codec)
{
        int err;

        err = alloc_generic_hdmi(codec);
        if (err < 0)
                return err;

        err = hdmi_parse_codec(codec);
        if (err < 0) {
                generic_spec_free(codec);
                return err;
        }

        generic_hdmi_init_per_pins(codec);
        return 0;
}

/*
 * Intel codec parsers and helpers
 */

static void intel_haswell_fixup_connect_list(struct hda_codec *codec,
                                             hda_nid_t nid)
{
        struct hdmi_spec *spec = codec->spec;
        hda_nid_t conns[4];
        int nconns;

        nconns = snd_hda_get_connections(codec, nid, conns, ARRAY_SIZE(conns));
        if (nconns == spec->num_cvts &&
            !memcmp(conns, spec->cvt_nids, spec->num_cvts * sizeof(hda_nid_t)))
                return;

        /* override pins connection list */
        codec_dbg(codec, "hdmi: haswell: override pin connection 0x%x\n", nid);
        snd_hda_override_conn_list(codec, nid, spec->num_cvts, spec->cvt_nids);
}

#define INTEL_VENDOR_NID 0x08
#define INTEL_GLK_VENDOR_NID 0x0B
#define INTEL_GET_VENDOR_VERB 0xf81
#define INTEL_SET_VENDOR_VERB 0x781
#define INTEL_EN_DP12                   0x02 /* enable DP 1.2 features */
#define INTEL_EN_ALL_PIN_CVTS   0x01 /* enable 2nd & 3rd pins and convertors */

static void intel_haswell_enable_all_pins(struct hda_codec *codec,
                                          bool update_tree)
{
        unsigned int vendor_param;
        struct hdmi_spec *spec = codec->spec;

        vendor_param = snd_hda_codec_read(codec, spec->vendor_nid, 0,
                                INTEL_GET_VENDOR_VERB, 0);
        if (vendor_param == -1 || vendor_param & INTEL_EN_ALL_PIN_CVTS)
                return;

        vendor_param |= INTEL_EN_ALL_PIN_CVTS;
        vendor_param = snd_hda_codec_read(codec, spec->vendor_nid, 0,
                                INTEL_SET_VENDOR_VERB, vendor_param);
        if (vendor_param == -1)
                return;

        if (update_tree)
                snd_hda_codec_update_widgets(codec);
}

static void intel_haswell_fixup_enable_dp12(struct hda_codec *codec)
{
        unsigned int vendor_param;
        struct hdmi_spec *spec = codec->spec;

        vendor_param = snd_hda_codec_read(codec, spec->vendor_nid, 0,
                                INTEL_GET_VENDOR_VERB, 0);
        if (vendor_param == -1 || vendor_param & INTEL_EN_DP12)
                return;

        /* enable DP1.2 mode */
        vendor_param |= INTEL_EN_DP12;
        snd_hdac_regmap_add_vendor_verb(&codec->core, INTEL_SET_VENDOR_VERB);
        snd_hda_codec_write_cache(codec, spec->vendor_nid, 0,
                                INTEL_SET_VENDOR_VERB, vendor_param);
}

/* Haswell needs to re-issue the vendor-specific verbs before turning to D0.
 * Otherwise you may get severe h/w communication errors.
 */
static void haswell_set_power_state(struct hda_codec *codec, hda_nid_t fg,
                                unsigned int power_state)
{
        if (power_state == AC_PWRST_D0) {
                intel_haswell_enable_all_pins(codec, false);
                intel_haswell_fixup_enable_dp12(codec);
        }

        snd_hda_codec_read(codec, fg, 0, AC_VERB_SET_POWER_STATE, power_state);
        snd_hda_codec_set_power_to_all(codec, fg, power_state);
}

static void intel_pin_eld_notify(void *audio_ptr, int port, int pipe)
{
        struct hda_codec *codec = audio_ptr;
        int pin_nid;
        int dev_id = pipe;

        /* we assume only from port-B to port-D */
        if (port < 1 || port > 3)
                return;

        switch (codec->core.vendor_id) {
        case 0x80860054: /* ILK */
        case 0x80862804: /* ILK */
        case 0x80862882: /* VLV */
                pin_nid = port + 0x03;
                break;
        default:
                pin_nid = port + 0x04;
                break;
        }

        /* skip notification during system suspend (but not in runtime PM);
         * the state will be updated at resume
         */
        if (snd_power_get_state(codec->card) != SNDRV_CTL_POWER_D0)
                return;
        /* ditto during suspend/resume process itself */
        if (atomic_read(&(codec)->core.in_pm))
                return;

        snd_hdac_i915_set_bclk(&codec->bus->core);
        check_presence_and_report(codec, pin_nid, dev_id);
}

/* register i915 component pin_eld_notify callback */
static void register_i915_notifier(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;

        spec->use_acomp_notifier = true;
        spec->i915_audio_ops.audio_ptr = codec;
        /* intel_audio_codec_enable() or intel_audio_codec_disable()
         * will call pin_eld_notify with using audio_ptr pointer
         * We need make sure audio_ptr is really setup
         */
        wmb();
        spec->i915_audio_ops.pin_eld_notify = intel_pin_eld_notify;
        snd_hdac_i915_register_notifier(&spec->i915_audio_ops);
}

/* setup_stream ops override for HSW+ */
static int i915_hsw_setup_stream(struct hda_codec *codec, hda_nid_t cvt_nid,
                                 hda_nid_t pin_nid, u32 stream_tag, int format)
{
        haswell_verify_D0(codec, cvt_nid, pin_nid);
        return hdmi_setup_stream(codec, cvt_nid, pin_nid, stream_tag, format);
}

/* pin_cvt_fixup ops override for HSW+ and VLV+ */
static void i915_pin_cvt_fixup(struct hda_codec *codec,
                               struct hdmi_spec_per_pin *per_pin,
                               hda_nid_t cvt_nid)
{
        if (per_pin) {
                snd_hda_set_dev_select(codec, per_pin->pin_nid,
                               per_pin->dev_id);
                intel_verify_pin_cvt_connect(codec, per_pin);
                intel_not_share_assigned_cvt(codec, per_pin->pin_nid,
                                     per_pin->dev_id, per_pin->mux_idx);
        } else {
                intel_not_share_assigned_cvt_nid(codec, 0, 0, cvt_nid);
        }
}

/* Intel Haswell and onwards; audio component with eld notifier */
static int intel_hsw_common_init(struct hda_codec *codec, hda_nid_t vendor_nid)
{
        struct hdmi_spec *spec;
        int err;

        /* HSW+ requires i915 binding */
        if (!codec->bus->core.audio_component) {
                codec_info(codec, "No i915 binding for Intel HDMI/DP codec\n");
                return -ENODEV;
        }

        err = alloc_generic_hdmi(codec);
        if (err < 0)
                return err;
        spec = codec->spec;
        codec->dp_mst = true;
        spec->dyn_pcm_assign = true;
        spec->vendor_nid = vendor_nid;

        intel_haswell_enable_all_pins(codec, true);
        intel_haswell_fixup_enable_dp12(codec);

        /* For Haswell/Broadwell, the controller is also in the power well and
         * can cover the codec power request, and so need not set this flag.
         */
        if (!is_haswell(codec) && !is_broadwell(codec))
                codec->core.link_power_control = 1;

        codec->patch_ops.set_power_state = haswell_set_power_state;
        codec->depop_delay = 0;
        codec->auto_runtime_pm = 1;

        spec->ops.setup_stream = i915_hsw_setup_stream;
        spec->ops.pin_cvt_fixup = i915_pin_cvt_fixup;

        err = hdmi_parse_codec(codec);
        if (err < 0) {
                generic_spec_free(codec);
                return err;
        }

        generic_hdmi_init_per_pins(codec);
        register_i915_notifier(codec);
        return 0;
}

static int patch_i915_hsw_hdmi(struct hda_codec *codec)
{
        return intel_hsw_common_init(codec, INTEL_VENDOR_NID);
}

static int patch_i915_glk_hdmi(struct hda_codec *codec)
{
        return intel_hsw_common_init(codec, INTEL_GLK_VENDOR_NID);
}

/* Intel Baytrail and Braswell; with eld notifier */
static int patch_i915_byt_hdmi(struct hda_codec *codec)
{
        struct hdmi_spec *spec;
        int err;

        /* requires i915 binding */
        if (!codec->bus->core.audio_component) {
                codec_info(codec, "No i915 binding for Intel HDMI/DP codec\n");
                return -ENODEV;
        }

        err = alloc_generic_hdmi(codec);
        if (err < 0)
                return err;
        spec = codec->spec;

        /* For Valleyview/Cherryview, only the display codec is in the display
         * power well and can use link_power ops to request/release the power.
         */
        codec->core.link_power_control = 1;

        codec->depop_delay = 0;
        codec->auto_runtime_pm = 1;

        spec->ops.pin_cvt_fixup = i915_pin_cvt_fixup;

        err = hdmi_parse_codec(codec);
        if (err < 0) {
                generic_spec_free(codec);
                return err;
        }

        generic_hdmi_init_per_pins(codec);
        register_i915_notifier(codec);
        return 0;
}

/* Intel IronLake, SandyBridge and IvyBridge; with eld notifier */
static int patch_i915_cpt_hdmi(struct hda_codec *codec)
{
        struct hdmi_spec *spec;
        int err;

        /* no i915 component should have been bound before this */
        if (WARN_ON(codec->bus->core.audio_component))
                return -EBUSY;

        err = alloc_generic_hdmi(codec);
        if (err < 0)
                return err;
        spec = codec->spec;

        /* Try to bind with i915 now */
        err = snd_hdac_i915_init(&codec->bus->core);
        if (err < 0)
                goto error;
        spec->i915_bound = true;

        err = hdmi_parse_codec(codec);
        if (err < 0)
                goto error;

        generic_hdmi_init_per_pins(codec);
        register_i915_notifier(codec);
        return 0;

 error:
        generic_spec_free(codec);
        return err;
}

/*
 * Shared non-generic implementations
 */

static int simple_playback_build_pcms(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        struct hda_pcm *info;
        unsigned int chans;
        struct hda_pcm_stream *pstr;
        struct hdmi_spec_per_cvt *per_cvt;

        per_cvt = get_cvt(spec, 0);
        chans = get_wcaps(codec, per_cvt->cvt_nid);
        chans = get_wcaps_channels(chans);

        info = snd_hda_codec_pcm_new(codec, "HDMI 0");
        if (!info)
                return -ENOMEM;
        spec->pcm_rec[0].pcm = info;
        info->pcm_type = HDA_PCM_TYPE_HDMI;
        pstr = &info->stream[SNDRV_PCM_STREAM_PLAYBACK];
        *pstr = spec->pcm_playback;
        pstr->nid = per_cvt->cvt_nid;
        if (pstr->channels_max <= 2 && chans && chans <= 16)
                pstr->channels_max = chans;

        return 0;
}

/* unsolicited event for jack sensing */
static void simple_hdmi_unsol_event(struct hda_codec *codec,
                                    unsigned int res)
{
        snd_hda_jack_set_dirty_all(codec);
        snd_hda_jack_report_sync(codec);
}

/* generic_hdmi_build_jack can be used for simple_hdmi, too,
 * as long as spec->pins[] is set correctly
 */
#define simple_hdmi_build_jack  generic_hdmi_build_jack

static int simple_playback_build_controls(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_cvt *per_cvt;
        int err;

        per_cvt = get_cvt(spec, 0);
        err = snd_hda_create_dig_out_ctls(codec, per_cvt->cvt_nid,
                                          per_cvt->cvt_nid,
                                          HDA_PCM_TYPE_HDMI);
        if (err < 0)
                return err;
        return simple_hdmi_build_jack(codec, 0);
}

static int simple_playback_init(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        struct hdmi_spec_per_pin *per_pin = get_pin(spec, 0);
        hda_nid_t pin = per_pin->pin_nid;

        snd_hda_codec_write(codec, pin, 0,
                            AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT);
        /* some codecs require to unmute the pin */
        if (get_wcaps(codec, pin) & AC_WCAP_OUT_AMP)
                snd_hda_codec_write(codec, pin, 0, AC_VERB_SET_AMP_GAIN_MUTE,
                                    AMP_OUT_UNMUTE);
        snd_hda_jack_detect_enable(codec, pin);
        return 0;
}

static void simple_playback_free(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;

        hdmi_array_free(spec);
        kfree(spec);
}

/*
 * Nvidia specific implementations
 */

#define Nv_VERB_SET_Channel_Allocation          0xF79
#define Nv_VERB_SET_Info_Frame_Checksum         0xF7A
#define Nv_VERB_SET_Audio_Protection_On         0xF98
#define Nv_VERB_SET_Audio_Protection_Off        0xF99

#define nvhdmi_master_con_nid_7x        0x04
#define nvhdmi_master_pin_nid_7x        0x05

static const hda_nid_t nvhdmi_con_nids_7x[4] = {
        /*front, rear, clfe, rear_surr */
        0x6, 0x8, 0xa, 0xc,
};

static const struct hda_verb nvhdmi_basic_init_7x_2ch[] = {
        /* set audio protect on */
        { 0x1, Nv_VERB_SET_Audio_Protection_On, 0x1},
        /* enable digital output on pin widget */
        { 0x5, AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT | 0x5 },
        {} /* terminator */
};

static const struct hda_verb nvhdmi_basic_init_7x_8ch[] = {
        /* set audio protect on */
        { 0x1, Nv_VERB_SET_Audio_Protection_On, 0x1},
        /* enable digital output on pin widget */
        { 0x5, AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT | 0x5 },
        { 0x7, AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT | 0x5 },
        { 0x9, AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT | 0x5 },
        { 0xb, AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT | 0x5 },
        { 0xd, AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT | 0x5 },
        {} /* terminator */
};

#ifdef LIMITED_RATE_FMT_SUPPORT
/* support only the safe format and rate */
#define SUPPORTED_RATES         SNDRV_PCM_RATE_48000
#define SUPPORTED_MAXBPS        16
#define SUPPORTED_FORMATS       SNDRV_PCM_FMTBIT_S16_LE
#else
/* support all rates and formats */
#define SUPPORTED_RATES \
        (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000 |\
        SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 |\
         SNDRV_PCM_RATE_192000)
#define SUPPORTED_MAXBPS        24
#define SUPPORTED_FORMATS \
        (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S32_LE)
#endif

static int nvhdmi_7x_init_2ch(struct hda_codec *codec)
{
        snd_hda_sequence_write(codec, nvhdmi_basic_init_7x_2ch);
        return 0;
}

static int nvhdmi_7x_init_8ch(struct hda_codec *codec)
{
        snd_hda_sequence_write(codec, nvhdmi_basic_init_7x_8ch);
        return 0;
}

static unsigned int channels_2_6_8[] = {
        2, 6, 8
};

static unsigned int channels_2_8[] = {
        2, 8
};

static struct snd_pcm_hw_constraint_list hw_constraints_2_6_8_channels = {
        .count = ARRAY_SIZE(channels_2_6_8),
        .list = channels_2_6_8,
        .mask = 0,
};

static struct snd_pcm_hw_constraint_list hw_constraints_2_8_channels = {
        .count = ARRAY_SIZE(channels_2_8),
        .list = channels_2_8,
        .mask = 0,
};

static int simple_playback_pcm_open(struct hda_pcm_stream *hinfo,
                                    struct hda_codec *codec,
                                    struct snd_pcm_substream *substream)
{
        struct hdmi_spec *spec = codec->spec;
        struct snd_pcm_hw_constraint_list *hw_constraints_channels = NULL;

        switch (codec->preset->vendor_id) {
        case 0x10de0002:
        case 0x10de0003:
        case 0x10de0005:
        case 0x10de0006:
                hw_constraints_channels = &hw_constraints_2_8_channels;
                break;
        case 0x10de0007:
                hw_constraints_channels = &hw_constraints_2_6_8_channels;
                break;
        default:
                break;
        }

        if (hw_constraints_channels != NULL) {
                snd_pcm_hw_constraint_list(substream->runtime, 0,
                                SNDRV_PCM_HW_PARAM_CHANNELS,
                                hw_constraints_channels);
        } else {
                snd_pcm_hw_constraint_step(substream->runtime, 0,
                                           SNDRV_PCM_HW_PARAM_CHANNELS, 2);
        }

        return snd_hda_multi_out_dig_open(codec, &spec->multiout);
}

static int simple_playback_pcm_close(struct hda_pcm_stream *hinfo,
                                     struct hda_codec *codec,
                                     struct snd_pcm_substream *substream)
{
        struct hdmi_spec *spec = codec->spec;
        return snd_hda_multi_out_dig_close(codec, &spec->multiout);
}

static int simple_playback_pcm_prepare(struct hda_pcm_stream *hinfo,
                                       struct hda_codec *codec,
                                       unsigned int stream_tag,
                                       unsigned int format,
                                       struct snd_pcm_substream *substream)
{
        struct hdmi_spec *spec = codec->spec;
        return snd_hda_multi_out_dig_prepare(codec, &spec->multiout,
                                             stream_tag, format, substream);
}

static const struct hda_pcm_stream simple_pcm_playback = {
        .substreams = 1,
        .channels_min = 2,
        .channels_max = 2,
        .ops = {
                .open = simple_playback_pcm_open,
                .close = simple_playback_pcm_close,
                .prepare = simple_playback_pcm_prepare
        },
};

static const struct hda_codec_ops simple_hdmi_patch_ops = {
        .build_controls = simple_playback_build_controls,
        .build_pcms = simple_playback_build_pcms,
        .init = simple_playback_init,
        .free = simple_playback_free,
        .unsol_event = simple_hdmi_unsol_event,
};

static int patch_simple_hdmi(struct hda_codec *codec,
                             hda_nid_t cvt_nid, hda_nid_t pin_nid)
{
        struct hdmi_spec *spec;
        struct hdmi_spec_per_cvt *per_cvt;
        struct hdmi_spec_per_pin *per_pin;

        spec = kzalloc(sizeof(*spec), GFP_KERNEL);
        if (!spec)
                return -ENOMEM;

        codec->spec = spec;
        hdmi_array_init(spec, 1);

        spec->multiout.num_dacs = 0;  /* no analog */
        spec->multiout.max_channels = 2;
        spec->multiout.dig_out_nid = cvt_nid;
        spec->num_cvts = 1;
        spec->num_pins = 1;
        per_pin = snd_array_new(&spec->pins);
        per_cvt = snd_array_new(&spec->cvts);
        if (!per_pin || !per_cvt) {
                simple_playback_free(codec);
                return -ENOMEM;
        }
        per_cvt->cvt_nid = cvt_nid;
        per_pin->pin_nid = pin_nid;
        spec->pcm_playback = simple_pcm_playback;

        codec->patch_ops = simple_hdmi_patch_ops;

        return 0;
}

static void nvhdmi_8ch_7x_set_info_frame_parameters(struct hda_codec *codec,
                                                    int channels)
{
        unsigned int chanmask;
        int chan = channels ? (channels - 1) : 1;

        switch (channels) {
        default:
        case 0:
        case 2:
                chanmask = 0x00;
                break;
        case 4:
                chanmask = 0x08;
                break;
        case 6:
                chanmask = 0x0b;
                break;
        case 8:
                chanmask = 0x13;
                break;
        }

        /* Set the audio infoframe channel allocation and checksum fields.  The
         * channel count is computed implicitly by the hardware. */
        snd_hda_codec_write(codec, 0x1, 0,
                        Nv_VERB_SET_Channel_Allocation, chanmask);

        snd_hda_codec_write(codec, 0x1, 0,
                        Nv_VERB_SET_Info_Frame_Checksum,
                        (0x71 - chan - chanmask));
}

static int nvhdmi_8ch_7x_pcm_close(struct hda_pcm_stream *hinfo,
                                   struct hda_codec *codec,
                                   struct snd_pcm_substream *substream)
{
        struct hdmi_spec *spec = codec->spec;
        int i;

        snd_hda_codec_write(codec, nvhdmi_master_con_nid_7x,
                        0, AC_VERB_SET_CHANNEL_STREAMID, 0);
        for (i = 0; i < 4; i++) {
                /* set the stream id */
                snd_hda_codec_write(codec, nvhdmi_con_nids_7x[i], 0,
                                AC_VERB_SET_CHANNEL_STREAMID, 0);
                /* set the stream format */
                snd_hda_codec_write(codec, nvhdmi_con_nids_7x[i], 0,
                                AC_VERB_SET_STREAM_FORMAT, 0);
        }

        /* The audio hardware sends a channel count of 0x7 (8ch) when all the
         * streams are disabled. */
        nvhdmi_8ch_7x_set_info_frame_parameters(codec, 8);

        return snd_hda_multi_out_dig_close(codec, &spec->multiout);
}

static int nvhdmi_8ch_7x_pcm_prepare(struct hda_pcm_stream *hinfo,
                                     struct hda_codec *codec,
                                     unsigned int stream_tag,
                                     unsigned int format,
                                     struct snd_pcm_substream *substream)
{
        int chs;
        unsigned int dataDCC2, channel_id;
        int i;
        struct hdmi_spec *spec = codec->spec;
        struct hda_spdif_out *spdif;
        struct hdmi_spec_per_cvt *per_cvt;

        mutex_lock(&codec->spdif_mutex);
        per_cvt = get_cvt(spec, 0);
        spdif = snd_hda_spdif_out_of_nid(codec, per_cvt->cvt_nid);

        chs = substream->runtime->channels;

        dataDCC2 = 0x2;

        /* turn off SPDIF once; otherwise the IEC958 bits won't be updated */
        if (codec->spdif_status_reset && (spdif->ctls & AC_DIG1_ENABLE))
                snd_hda_codec_write(codec,
                                nvhdmi_master_con_nid_7x,
                                0,
                                AC_VERB_SET_DIGI_CONVERT_1,
                                spdif->ctls & ~AC_DIG1_ENABLE & 0xff);

        /* set the stream id */
        snd_hda_codec_write(codec, nvhdmi_master_con_nid_7x, 0,
                        AC_VERB_SET_CHANNEL_STREAMID, (stream_tag << 4) | 0x0);

        /* set the stream format */
        snd_hda_codec_write(codec, nvhdmi_master_con_nid_7x, 0,
                        AC_VERB_SET_STREAM_FORMAT, format);

        /* turn on again (if needed) */
        /* enable and set the channel status audio/data flag */
        if (codec->spdif_status_reset && (spdif->ctls & AC_DIG1_ENABLE)) {
                snd_hda_codec_write(codec,
                                nvhdmi_master_con_nid_7x,
                                0,
                                AC_VERB_SET_DIGI_CONVERT_1,
                                spdif->ctls & 0xff);
                snd_hda_codec_write(codec,
                                nvhdmi_master_con_nid_7x,
                                0,
                                AC_VERB_SET_DIGI_CONVERT_2, dataDCC2);
        }

        for (i = 0; i < 4; i++) {
                if (chs == 2)
                        channel_id = 0;
                else
                        channel_id = i * 2;

                /* turn off SPDIF once;
                 *otherwise the IEC958 bits won't be updated
                 */
                if (codec->spdif_status_reset &&
                (spdif->ctls & AC_DIG1_ENABLE))
                        snd_hda_codec_write(codec,
                                nvhdmi_con_nids_7x[i],
                                0,
                                AC_VERB_SET_DIGI_CONVERT_1,
                                spdif->ctls & ~AC_DIG1_ENABLE & 0xff);
                /* set the stream id */
                snd_hda_codec_write(codec,
                                nvhdmi_con_nids_7x[i],
                                0,
                                AC_VERB_SET_CHANNEL_STREAMID,
                                (stream_tag << 4) | channel_id);
                /* set the stream format */
                snd_hda_codec_write(codec,
                                nvhdmi_con_nids_7x[i],
                                0,
                                AC_VERB_SET_STREAM_FORMAT,
                                format);
                /* turn on again (if needed) */
                /* enable and set the channel status audio/data flag */
                if (codec->spdif_status_reset &&
                (spdif->ctls & AC_DIG1_ENABLE)) {
                        snd_hda_codec_write(codec,
                                        nvhdmi_con_nids_7x[i],
                                        0,
                                        AC_VERB_SET_DIGI_CONVERT_1,
                                        spdif->ctls & 0xff);
                        snd_hda_codec_write(codec,
                                        nvhdmi_con_nids_7x[i],
                                        0,
                                        AC_VERB_SET_DIGI_CONVERT_2, dataDCC2);
                }
        }

        nvhdmi_8ch_7x_set_info_frame_parameters(codec, chs);

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

static const struct hda_pcm_stream nvhdmi_pcm_playback_8ch_7x = {
        .substreams = 1,
        .channels_min = 2,
        .channels_max = 8,
        .nid = nvhdmi_master_con_nid_7x,
        .rates = SUPPORTED_RATES,
        .maxbps = SUPPORTED_MAXBPS,
        .formats = SUPPORTED_FORMATS,
        .ops = {
                .open = simple_playback_pcm_open,
                .close = nvhdmi_8ch_7x_pcm_close,
                .prepare = nvhdmi_8ch_7x_pcm_prepare
        },
};

static int patch_nvhdmi_2ch(struct hda_codec *codec)
{
        struct hdmi_spec *spec;
        int err = patch_simple_hdmi(codec, nvhdmi_master_con_nid_7x,
                                    nvhdmi_master_pin_nid_7x);
        if (err < 0)
                return err;

        codec->patch_ops.init = nvhdmi_7x_init_2ch;
        /* override the PCM rates, etc, as the codec doesn't give full list */
        spec = codec->spec;
        spec->pcm_playback.rates = SUPPORTED_RATES;
        spec->pcm_playback.maxbps = SUPPORTED_MAXBPS;
        spec->pcm_playback.formats = SUPPORTED_FORMATS;
        return 0;
}

static int nvhdmi_7x_8ch_build_pcms(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int err = simple_playback_build_pcms(codec);
        if (!err) {
                struct hda_pcm *info = get_pcm_rec(spec, 0);
                info->own_chmap = true;
        }
        return err;
}

static int nvhdmi_7x_8ch_build_controls(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        struct hda_pcm *info;
        struct snd_pcm_chmap *chmap;
        int err;

        err = simple_playback_build_controls(codec);
        if (err < 0)
                return err;

        /* add channel maps */
        info = get_pcm_rec(spec, 0);
        err = snd_pcm_add_chmap_ctls(info->pcm,
                                     SNDRV_PCM_STREAM_PLAYBACK,
                                     snd_pcm_alt_chmaps, 8, 0, &chmap);
        if (err < 0)
                return err;
        switch (codec->preset->vendor_id) {
        case 0x10de0002:
        case 0x10de0003:
        case 0x10de0005:
        case 0x10de0006:
                chmap->channel_mask = (1U << 2) | (1U << 8);
                break;
        case 0x10de0007:
                chmap->channel_mask = (1U << 2) | (1U << 6) | (1U << 8);
        }
        return 0;
}

static int patch_nvhdmi_8ch_7x(struct hda_codec *codec)
{
        struct hdmi_spec *spec;
        int err = patch_nvhdmi_2ch(codec);
        if (err < 0)
                return err;
        spec = codec->spec;
        spec->multiout.max_channels = 8;
        spec->pcm_playback = nvhdmi_pcm_playback_8ch_7x;
        codec->patch_ops.init = nvhdmi_7x_init_8ch;
        codec->patch_ops.build_pcms = nvhdmi_7x_8ch_build_pcms;
        codec->patch_ops.build_controls = nvhdmi_7x_8ch_build_controls;

        /* Initialize the audio infoframe channel mask and checksum to something
         * valid */
        nvhdmi_8ch_7x_set_info_frame_parameters(codec, 8);

        return 0;
}

/*
 * NVIDIA codecs ignore ASP mapping for 2ch - confirmed on:
 * - 0x10de0015
 * - 0x10de0040
 */
static int nvhdmi_chmap_cea_alloc_validate_get_type(struct hdac_chmap *chmap,
                struct hdac_cea_channel_speaker_allocation *cap, int channels)
{
        if (cap->ca_index == 0x00 && channels == 2)
                return SNDRV_CTL_TLVT_CHMAP_FIXED;

        /* If the speaker allocation matches the channel count, it is OK. */
        if (cap->channels != channels)
                return -1;

        /* all channels are remappable freely */
        return SNDRV_CTL_TLVT_CHMAP_VAR;
}

static int nvhdmi_chmap_validate(struct hdac_chmap *chmap,
                int ca, int chs, unsigned char *map)
{
        if (ca == 0x00 && (map[0] != SNDRV_CHMAP_FL || map[1] != SNDRV_CHMAP_FR))
                return -EINVAL;

        return 0;
}

static int patch_nvhdmi(struct hda_codec *codec)
{
        struct hdmi_spec *spec;
        int err;

        err = patch_generic_hdmi(codec);
        if (err)
                return err;

        spec = codec->spec;
        spec->dyn_pin_out = true;

        spec->chmap.ops.chmap_cea_alloc_validate_get_type =
                nvhdmi_chmap_cea_alloc_validate_get_type;
        spec->chmap.ops.chmap_validate = nvhdmi_chmap_validate;

        return 0;
}

/*
 * The HDA codec on NVIDIA Tegra contains two scratch registers that are
 * accessed using vendor-defined verbs. These registers can be used for
 * interoperability between the HDA and HDMI drivers.
 */

/* Audio Function Group node */
#define NVIDIA_AFG_NID 0x01

/*
 * The SCRATCH0 register is used to notify the HDMI codec of changes in audio
 * format. On Tegra, bit 31 is used as a trigger that causes an interrupt to
 * be raised in the HDMI codec. The remainder of the bits is arbitrary. This
 * implementation stores the HDA format (see AC_FMT_*) in bits [15:0] and an
 * additional bit (at position 30) to signal the validity of the format.
 *
 * | 31      | 30    | 29  16 | 15   0 |
 * +---------+-------+--------+--------+
 * | TRIGGER | VALID | UNUSED | FORMAT |
 * +-----------------------------------|
 *
 * Note that for the trigger bit to take effect it needs to change value
 * (i.e. it needs to be toggled).
 */
#define NVIDIA_GET_SCRATCH0             0xfa6
#define NVIDIA_SET_SCRATCH0_BYTE0       0xfa7
#define NVIDIA_SET_SCRATCH0_BYTE1       0xfa8
#define NVIDIA_SET_SCRATCH0_BYTE2       0xfa9
#define NVIDIA_SET_SCRATCH0_BYTE3       0xfaa
#define NVIDIA_SCRATCH_TRIGGER (1 << 7)
#define NVIDIA_SCRATCH_VALID   (1 << 6)

#define NVIDIA_GET_SCRATCH1             0xfab
#define NVIDIA_SET_SCRATCH1_BYTE0       0xfac
#define NVIDIA_SET_SCRATCH1_BYTE1       0xfad
#define NVIDIA_SET_SCRATCH1_BYTE2       0xfae
#define NVIDIA_SET_SCRATCH1_BYTE3       0xfaf

/*
 * The format parameter is the HDA audio format (see AC_FMT_*). If set to 0,
 * the format is invalidated so that the HDMI codec can be disabled.
 */
static void tegra_hdmi_set_format(struct hda_codec *codec, unsigned int format)
{
        unsigned int value;

        /* bits [31:30] contain the trigger and valid bits */
        value = snd_hda_codec_read(codec, NVIDIA_AFG_NID, 0,
                                   NVIDIA_GET_SCRATCH0, 0);
        value = (value >> 24) & 0xff;

        /* bits [15:0] are used to store the HDA format */
        snd_hda_codec_write(codec, NVIDIA_AFG_NID, 0,
                            NVIDIA_SET_SCRATCH0_BYTE0,
                            (format >> 0) & 0xff);
        snd_hda_codec_write(codec, NVIDIA_AFG_NID, 0,
                            NVIDIA_SET_SCRATCH0_BYTE1,
                            (format >> 8) & 0xff);

        /* bits [16:24] are unused */
        snd_hda_codec_write(codec, NVIDIA_AFG_NID, 0,
                            NVIDIA_SET_SCRATCH0_BYTE2, 0);

        /*
         * Bit 30 signals that the data is valid and hence that HDMI audio can
         * be enabled.
         */
        if (format == 0)
                value &= ~NVIDIA_SCRATCH_VALID;
        else
                value |= NVIDIA_SCRATCH_VALID;

        /*
         * Whenever the trigger bit is toggled, an interrupt is raised in the
         * HDMI codec. The HDMI driver will use that as trigger to update its
         * configuration.
         */
        value ^= NVIDIA_SCRATCH_TRIGGER;

        snd_hda_codec_write(codec, NVIDIA_AFG_NID, 0,
                            NVIDIA_SET_SCRATCH0_BYTE3, value);
}

static int tegra_hdmi_pcm_prepare(struct hda_pcm_stream *hinfo,
                                  struct hda_codec *codec,
                                  unsigned int stream_tag,
                                  unsigned int format,
                                  struct snd_pcm_substream *substream)
{
        int err;

        err = generic_hdmi_playback_pcm_prepare(hinfo, codec, stream_tag,
                                                format, substream);
        if (err < 0)
                return err;

        /* notify the HDMI codec of the format change */
        tegra_hdmi_set_format(codec, format);

        return 0;
}

static int tegra_hdmi_pcm_cleanup(struct hda_pcm_stream *hinfo,
                                  struct hda_codec *codec,
                                  struct snd_pcm_substream *substream)
{
        /* invalidate the format in the HDMI codec */
        tegra_hdmi_set_format(codec, 0);

        return generic_hdmi_playback_pcm_cleanup(hinfo, codec, substream);
}

static struct hda_pcm *hda_find_pcm_by_type(struct hda_codec *codec, int type)
{
        struct hdmi_spec *spec = codec->spec;
        unsigned int i;

        for (i = 0; i < spec->num_pins; i++) {
                struct hda_pcm *pcm = get_pcm_rec(spec, i);

                if (pcm->pcm_type == type)
                        return pcm;
        }

        return NULL;
}

static int tegra_hdmi_build_pcms(struct hda_codec *codec)
{
        struct hda_pcm_stream *stream;
        struct hda_pcm *pcm;
        int err;

        err = generic_hdmi_build_pcms(codec);
        if (err < 0)
                return err;

        pcm = hda_find_pcm_by_type(codec, HDA_PCM_TYPE_HDMI);
        if (!pcm)
                return -ENODEV;

        /*
         * Override ->prepare() and ->cleanup() operations to notify the HDMI
         * codec about format changes.
         */
        stream = &pcm->stream[SNDRV_PCM_STREAM_PLAYBACK];
        stream->ops.prepare = tegra_hdmi_pcm_prepare;
        stream->ops.cleanup = tegra_hdmi_pcm_cleanup;

        return 0;
}

static int patch_tegra_hdmi(struct hda_codec *codec)
{
        int err;

        err = patch_generic_hdmi(codec);
        if (err)
                return err;

        codec->patch_ops.build_pcms = tegra_hdmi_build_pcms;

        return 0;
}

/*
 * ATI/AMD-specific implementations
 */

#define is_amdhdmi_rev3_or_later(codec) \
        ((codec)->core.vendor_id == 0x1002aa01 && \
         ((codec)->core.revision_id & 0xff00) >= 0x0300)
#define has_amd_full_remap_support(codec) is_amdhdmi_rev3_or_later(codec)

/* ATI/AMD specific HDA pin verbs, see the AMD HDA Verbs specification */
#define ATI_VERB_SET_CHANNEL_ALLOCATION 0x771
#define ATI_VERB_SET_DOWNMIX_INFO       0x772
#define ATI_VERB_SET_MULTICHANNEL_01    0x777
#define ATI_VERB_SET_MULTICHANNEL_23    0x778
#define ATI_VERB_SET_MULTICHANNEL_45    0x779
#define ATI_VERB_SET_MULTICHANNEL_67    0x77a
#define ATI_VERB_SET_HBR_CONTROL        0x77c
#define ATI_VERB_SET_MULTICHANNEL_1     0x785
#define ATI_VERB_SET_MULTICHANNEL_3     0x786
#define ATI_VERB_SET_MULTICHANNEL_5     0x787
#define ATI_VERB_SET_MULTICHANNEL_7     0x788
#define ATI_VERB_SET_MULTICHANNEL_MODE  0x789
#define ATI_VERB_GET_CHANNEL_ALLOCATION 0xf71
#define ATI_VERB_GET_DOWNMIX_INFO       0xf72
#define ATI_VERB_GET_MULTICHANNEL_01    0xf77
#define ATI_VERB_GET_MULTICHANNEL_23    0xf78
#define ATI_VERB_GET_MULTICHANNEL_45    0xf79
#define ATI_VERB_GET_MULTICHANNEL_67    0xf7a
#define ATI_VERB_GET_HBR_CONTROL        0xf7c
#define ATI_VERB_GET_MULTICHANNEL_1     0xf85
#define ATI_VERB_GET_MULTICHANNEL_3     0xf86
#define ATI_VERB_GET_MULTICHANNEL_5     0xf87
#define ATI_VERB_GET_MULTICHANNEL_7     0xf88
#define ATI_VERB_GET_MULTICHANNEL_MODE  0xf89

/* AMD specific HDA cvt verbs */
#define ATI_VERB_SET_RAMP_RATE          0x770
#define ATI_VERB_GET_RAMP_RATE          0xf70

#define ATI_OUT_ENABLE 0x1

#define ATI_MULTICHANNEL_MODE_PAIRED    0
#define ATI_MULTICHANNEL_MODE_SINGLE    1

#define ATI_HBR_CAPABLE 0x01
#define ATI_HBR_ENABLE 0x10

static int atihdmi_pin_get_eld(struct hda_codec *codec, hda_nid_t nid,
                           unsigned char *buf, int *eld_size)
{
        /* call hda_eld.c ATI/AMD-specific function */
        return snd_hdmi_get_eld_ati(codec, nid, buf, eld_size,
                                    is_amdhdmi_rev3_or_later(codec));
}

static void atihdmi_pin_setup_infoframe(struct hda_codec *codec, hda_nid_t pin_nid, int ca,
                                        int active_channels, int conn_type)
{
        snd_hda_codec_write(codec, pin_nid, 0, ATI_VERB_SET_CHANNEL_ALLOCATION, ca);
}

static int atihdmi_paired_swap_fc_lfe(int pos)
{
        /*
         * ATI/AMD have automatic FC/LFE swap built-in
         * when in pairwise mapping mode.
         */

        switch (pos) {
                /* see channel_allocations[].speakers[] */
                case 2: return 3;
                case 3: return 2;
                default: break;
        }

        return pos;
}

static int atihdmi_paired_chmap_validate(struct hdac_chmap *chmap,
                        int ca, int chs, unsigned char *map)
{
        struct hdac_cea_channel_speaker_allocation *cap;
        int i, j;

        /* check that only channel pairs need to be remapped on old pre-rev3 ATI/AMD */

        cap = snd_hdac_get_ch_alloc_from_ca(ca);
        for (i = 0; i < chs; ++i) {
                int mask = snd_hdac_chmap_to_spk_mask(map[i]);
                bool ok = false;
                bool companion_ok = false;

                if (!mask)
                        continue;

                for (j = 0 + i % 2; j < 8; j += 2) {
                        int chan_idx = 7 - atihdmi_paired_swap_fc_lfe(j);
                        if (cap->speakers[chan_idx] == mask) {
                                /* channel is in a supported position */
                                ok = true;

                                if (i % 2 == 0 && i + 1 < chs) {
                                        /* even channel, check the odd companion */
                                        int comp_chan_idx = 7 - atihdmi_paired_swap_fc_lfe(j + 1);
                                        int comp_mask_req = snd_hdac_chmap_to_spk_mask(map[i+1]);
                                        int comp_mask_act = cap->speakers[comp_chan_idx];

                                        if (comp_mask_req == comp_mask_act)
                                                companion_ok = true;
                                        else
                                                return -EINVAL;
                                }
                                break;
                        }
                }

                if (!ok)
                        return -EINVAL;

                if (companion_ok)
                        i++; /* companion channel already checked */
        }

        return 0;
}

static int atihdmi_pin_set_slot_channel(struct hdac_device *hdac,
                hda_nid_t pin_nid, int hdmi_slot, int stream_channel)
{
        struct hda_codec *codec = container_of(hdac, struct hda_codec, core);
        int verb;
        int ati_channel_setup = 0;

        if (hdmi_slot > 7)
                return -EINVAL;

        if (!has_amd_full_remap_support(codec)) {
                hdmi_slot = atihdmi_paired_swap_fc_lfe(hdmi_slot);

                /* In case this is an odd slot but without stream channel, do not
                 * disable the slot since the corresponding even slot could have a
                 * channel. In case neither have a channel, the slot pair will be
                 * disabled when this function is called for the even slot. */
                if (hdmi_slot % 2 != 0 && stream_channel == 0xf)
                        return 0;

                hdmi_slot -= hdmi_slot % 2;

                if (stream_channel != 0xf)
                        stream_channel -= stream_channel % 2;
        }

        verb = ATI_VERB_SET_MULTICHANNEL_01 + hdmi_slot/2 + (hdmi_slot % 2) * 0x00e;

        /* ati_channel_setup format: [7..4] = stream_channel_id, [1] = mute, [0] = enable */

        if (stream_channel != 0xf)
                ati_channel_setup = (stream_channel << 4) | ATI_OUT_ENABLE;

        return snd_hda_codec_write(codec, pin_nid, 0, verb, ati_channel_setup);
}

static int atihdmi_pin_get_slot_channel(struct hdac_device *hdac,
                                hda_nid_t pin_nid, int asp_slot)
{
        struct hda_codec *codec = container_of(hdac, struct hda_codec, core);
        bool was_odd = false;
        int ati_asp_slot = asp_slot;
        int verb;
        int ati_channel_setup;

        if (asp_slot > 7)
                return -EINVAL;

        if (!has_amd_full_remap_support(codec)) {
                ati_asp_slot = atihdmi_paired_swap_fc_lfe(asp_slot);
                if (ati_asp_slot % 2 != 0) {
                        ati_asp_slot -= 1;
                        was_odd = true;
                }
        }

        verb = ATI_VERB_GET_MULTICHANNEL_01 + ati_asp_slot/2 + (ati_asp_slot % 2) * 0x00e;

        ati_channel_setup = snd_hda_codec_read(codec, pin_nid, 0, verb, 0);

        if (!(ati_channel_setup & ATI_OUT_ENABLE))
                return 0xf;

        return ((ati_channel_setup & 0xf0) >> 4) + !!was_odd;
}

static int atihdmi_paired_chmap_cea_alloc_validate_get_type(
                struct hdac_chmap *chmap,
                struct hdac_cea_channel_speaker_allocation *cap,
                int channels)
{
        int c;

        /*
         * Pre-rev3 ATI/AMD codecs operate in a paired channel mode, so
         * we need to take that into account (a single channel may take 2
         * channel slots if we need to carry a silent channel next to it).
         * On Rev3+ AMD codecs this function is not used.
         */
        int chanpairs = 0;

        /* We only produce even-numbered channel count TLVs */
        if ((channels % 2) != 0)
                return -1;

        for (c = 0; c < 7; c += 2) {
                if (cap->speakers[c] || cap->speakers[c+1])
                        chanpairs++;
        }

        if (chanpairs * 2 != channels)
                return -1;

        return SNDRV_CTL_TLVT_CHMAP_PAIRED;
}

static void atihdmi_paired_cea_alloc_to_tlv_chmap(struct hdac_chmap *hchmap,
                struct hdac_cea_channel_speaker_allocation *cap,
                unsigned int *chmap, int channels)
{
        /* produce paired maps for pre-rev3 ATI/AMD codecs */
        int count = 0;
        int c;

        for (c = 7; c >= 0; c--) {
                int chan = 7 - atihdmi_paired_swap_fc_lfe(7 - c);
                int spk = cap->speakers[chan];
                if (!spk) {
                        /* add N/A channel if the companion channel is occupied */
                        if (cap->speakers[chan + (chan % 2 ? -1 : 1)])
                                chmap[count++] = SNDRV_CHMAP_NA;

                        continue;
                }

                chmap[count++] = snd_hdac_spk_to_chmap(spk);
        }

        WARN_ON(count != channels);
}

static int atihdmi_pin_hbr_setup(struct hda_codec *codec, hda_nid_t pin_nid,
                                 bool hbr)
{
        int hbr_ctl, hbr_ctl_new;

        hbr_ctl = snd_hda_codec_read(codec, pin_nid, 0, ATI_VERB_GET_HBR_CONTROL, 0);
        if (hbr_ctl >= 0 && (hbr_ctl & ATI_HBR_CAPABLE)) {
                if (hbr)
                        hbr_ctl_new = hbr_ctl | ATI_HBR_ENABLE;
                else
                        hbr_ctl_new = hbr_ctl & ~ATI_HBR_ENABLE;

                codec_dbg(codec,
                          "atihdmi_pin_hbr_setup: NID=0x%x, %shbr-ctl=0x%x\n",
                                pin_nid,
                                hbr_ctl == hbr_ctl_new ? "" : "new-",
                                hbr_ctl_new);

                if (hbr_ctl != hbr_ctl_new)
                        snd_hda_codec_write(codec, pin_nid, 0,
                                                ATI_VERB_SET_HBR_CONTROL,
                                                hbr_ctl_new);

        } else if (hbr)
                return -EINVAL;

        return 0;
}

static int atihdmi_setup_stream(struct hda_codec *codec, hda_nid_t cvt_nid,
                                hda_nid_t pin_nid, u32 stream_tag, int format)
{

        if (is_amdhdmi_rev3_or_later(codec)) {
                int ramp_rate = 180; /* default as per AMD spec */
                /* disable ramp-up/down for non-pcm as per AMD spec */
                if (format & AC_FMT_TYPE_NON_PCM)
                        ramp_rate = 0;

                snd_hda_codec_write(codec, cvt_nid, 0, ATI_VERB_SET_RAMP_RATE, ramp_rate);
        }

        return hdmi_setup_stream(codec, cvt_nid, pin_nid, stream_tag, format);
}


static int atihdmi_init(struct hda_codec *codec)
{
        struct hdmi_spec *spec = codec->spec;
        int pin_idx, err;

        err = generic_hdmi_init(codec);

        if (err)
                return err;

        for (pin_idx = 0; pin_idx < spec->num_pins; pin_idx++) {
                struct hdmi_spec_per_pin *per_pin = get_pin(spec, pin_idx);

                /* make sure downmix information in infoframe is zero */
                snd_hda_codec_write(codec, per_pin->pin_nid, 0, ATI_VERB_SET_DOWNMIX_INFO, 0);

                /* enable channel-wise remap mode if supported */
                if (has_amd_full_remap_support(codec))
                        snd_hda_codec_write(codec, per_pin->pin_nid, 0,
                                            ATI_VERB_SET_MULTICHANNEL_MODE,
                                            ATI_MULTICHANNEL_MODE_SINGLE);
        }

        return 0;
}

static int patch_atihdmi(struct hda_codec *codec)
{
        struct hdmi_spec *spec;
        struct hdmi_spec_per_cvt *per_cvt;
        int err, cvt_idx;

        err = patch_generic_hdmi(codec);

        if (err)
                return err;

        codec->patch_ops.init = atihdmi_init;

        spec = codec->spec;

        spec->ops.pin_get_eld = atihdmi_pin_get_eld;
        spec->ops.pin_setup_infoframe = atihdmi_pin_setup_infoframe;
        spec->ops.pin_hbr_setup = atihdmi_pin_hbr_setup;
        spec->ops.setup_stream = atihdmi_setup_stream;

        spec->chmap.ops.pin_get_slot_channel = atihdmi_pin_get_slot_channel;
        spec->chmap.ops.pin_set_slot_channel = atihdmi_pin_set_slot_channel;

        if (!has_amd_full_remap_support(codec)) {
                /* override to ATI/AMD-specific versions with pairwise mapping */
                spec->chmap.ops.chmap_cea_alloc_validate_get_type =
                        atihdmi_paired_chmap_cea_alloc_validate_get_type;
                spec->chmap.ops.cea_alloc_to_tlv_chmap =
                                atihdmi_paired_cea_alloc_to_tlv_chmap;
                spec->chmap.ops.chmap_validate = atihdmi_paired_chmap_validate;
        }

        /* ATI/AMD converters do not advertise all of their capabilities */
        for (cvt_idx = 0; cvt_idx < spec->num_cvts; cvt_idx++) {
                per_cvt = get_cvt(spec, cvt_idx);
                per_cvt->channels_max = max(per_cvt->channels_max, 8u);
                per_cvt->rates |= SUPPORTED_RATES;
                per_cvt->formats |= SUPPORTED_FORMATS;
                per_cvt->maxbps = max(per_cvt->maxbps, 24u);
        }

        spec->chmap.channels_max = max(spec->chmap.channels_max, 8u);

        return 0;
}

/* VIA HDMI Implementation */
#define VIAHDMI_CVT_NID 0x02    /* audio converter1 */
#define VIAHDMI_PIN_NID 0x03    /* HDMI output pin1 */

static int patch_via_hdmi(struct hda_codec *codec)
{
        return patch_simple_hdmi(codec, VIAHDMI_CVT_NID, VIAHDMI_PIN_NID);
}

/*
 * patch entries
 */
static const struct hda_device_id snd_hda_id_hdmi[] = {
HDA_CODEC_ENTRY(0x1002793c, "RS600 HDMI",       patch_atihdmi),
HDA_CODEC_ENTRY(0x10027919, "RS600 HDMI",       patch_atihdmi),
HDA_CODEC_ENTRY(0x1002791a, "RS690/780 HDMI",   patch_atihdmi),
HDA_CODEC_ENTRY(0x1002aa01, "R6xx HDMI",        patch_atihdmi),
HDA_CODEC_ENTRY(0x10951390, "SiI1390 HDMI",     patch_generic_hdmi),
HDA_CODEC_ENTRY(0x10951392, "SiI1392 HDMI",     patch_generic_hdmi),
HDA_CODEC_ENTRY(0x17e80047, "Chrontel HDMI",    patch_generic_hdmi),
HDA_CODEC_ENTRY(0x10de0002, "MCP77/78 HDMI",    patch_nvhdmi_8ch_7x),
HDA_CODEC_ENTRY(0x10de0003, "MCP77/78 HDMI",    patch_nvhdmi_8ch_7x),
HDA_CODEC_ENTRY(0x10de0005, "MCP77/78 HDMI",    patch_nvhdmi_8ch_7x),
HDA_CODEC_ENTRY(0x10de0006, "MCP77/78 HDMI",    patch_nvhdmi_8ch_7x),
HDA_CODEC_ENTRY(0x10de0007, "MCP79/7A HDMI",    patch_nvhdmi_8ch_7x),
HDA_CODEC_ENTRY(0x10de000a, "GPU 0a HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de000b, "GPU 0b HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de000c, "MCP89 HDMI",       patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de000d, "GPU 0d HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0010, "GPU 10 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0011, "GPU 11 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0012, "GPU 12 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0013, "GPU 13 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0014, "GPU 14 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0015, "GPU 15 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0016, "GPU 16 HDMI/DP",   patch_nvhdmi),
/* 17 is known to be absent */
HDA_CODEC_ENTRY(0x10de0018, "GPU 18 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0019, "GPU 19 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de001a, "GPU 1a HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de001b, "GPU 1b HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de001c, "GPU 1c HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0020, "Tegra30 HDMI",     patch_tegra_hdmi),
HDA_CODEC_ENTRY(0x10de0022, "Tegra114 HDMI",    patch_tegra_hdmi),
HDA_CODEC_ENTRY(0x10de0028, "Tegra124 HDMI",    patch_tegra_hdmi),
HDA_CODEC_ENTRY(0x10de0029, "Tegra210 HDMI/DP", patch_tegra_hdmi),
HDA_CODEC_ENTRY(0x10de0040, "GPU 40 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0041, "GPU 41 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0042, "GPU 42 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0043, "GPU 43 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0044, "GPU 44 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0051, "GPU 51 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0060, "GPU 60 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0067, "MCP67 HDMI",       patch_nvhdmi_2ch),
HDA_CODEC_ENTRY(0x10de0070, "GPU 70 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0071, "GPU 71 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0072, "GPU 72 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de007d, "GPU 7d HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0080, "GPU 80 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0082, "GPU 82 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de0083, "GPU 83 HDMI/DP",   patch_nvhdmi),
HDA_CODEC_ENTRY(0x10de8001, "MCP73 HDMI",       patch_nvhdmi_2ch),
HDA_CODEC_ENTRY(0x11069f80, "VX900 HDMI/DP",    patch_via_hdmi),
HDA_CODEC_ENTRY(0x11069f81, "VX900 HDMI/DP",    patch_via_hdmi),
HDA_CODEC_ENTRY(0x11069f84, "VX11 HDMI/DP",     patch_generic_hdmi),
HDA_CODEC_ENTRY(0x11069f85, "VX11 HDMI/DP",     patch_generic_hdmi),
HDA_CODEC_ENTRY(0x80860054, "IbexPeak HDMI",    patch_i915_cpt_hdmi),
HDA_CODEC_ENTRY(0x80862801, "Bearlake HDMI",    patch_generic_hdmi),
HDA_CODEC_ENTRY(0x80862802, "Cantiga HDMI",     patch_generic_hdmi),
HDA_CODEC_ENTRY(0x80862803, "Eaglelake HDMI",   patch_generic_hdmi),
HDA_CODEC_ENTRY(0x80862804, "IbexPeak HDMI",    patch_i915_cpt_hdmi),
HDA_CODEC_ENTRY(0x80862805, "CougarPoint HDMI", patch_i915_cpt_hdmi),
HDA_CODEC_ENTRY(0x80862806, "PantherPoint HDMI", patch_i915_cpt_hdmi),
HDA_CODEC_ENTRY(0x80862807, "Haswell HDMI",     patch_i915_hsw_hdmi),
HDA_CODEC_ENTRY(0x80862808, "Broadwell HDMI",   patch_i915_hsw_hdmi),
HDA_CODEC_ENTRY(0x80862809, "Skylake HDMI",     patch_i915_hsw_hdmi),
HDA_CODEC_ENTRY(0x8086280a, "Broxton HDMI",     patch_i915_hsw_hdmi),
HDA_CODEC_ENTRY(0x8086280b, "Kabylake HDMI",    patch_i915_hsw_hdmi),
HDA_CODEC_ENTRY(0x8086280d, "Geminilake HDMI",  patch_i915_glk_hdmi),
HDA_CODEC_ENTRY(0x80862880, "CedarTrail HDMI",  patch_generic_hdmi),
HDA_CODEC_ENTRY(0x80862882, "Valleyview2 HDMI", patch_i915_byt_hdmi),
HDA_CODEC_ENTRY(0x80862883, "Braswell HDMI",    patch_i915_byt_hdmi),
HDA_CODEC_ENTRY(0x808629fb, "Crestline HDMI",   patch_generic_hdmi),
/* special ID for generic HDMI */
HDA_CODEC_ENTRY(HDA_CODEC_ID_GENERIC_HDMI, "Generic HDMI", patch_generic_hdmi),
{} /* terminator */
};
MODULE_DEVICE_TABLE(hdaudio, snd_hda_id_hdmi);

MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("HDMI HD-audio codec");
MODULE_ALIAS("snd-hda-codec-intelhdmi");
MODULE_ALIAS("snd-hda-codec-nvhdmi");
MODULE_ALIAS("snd-hda-codec-atihdmi");

static struct hda_codec_driver hdmi_driver = {
        .id = snd_hda_id_hdmi,
};

module_hda_codec_driver(hdmi_driver);