LXR linux/sound/pci/hda/hda

   1/*
   2 * Universal Interface for Intel High Definition Audio Codec
   3 *
   4 * Local helper functions
   5 *
   6 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
   7 *
   8 *  This program is free software; you can redistribute it and/or modify it
   9 *  under the terms of the GNU General Public License as published by the Free
  10 *  Software Foundation; either version 2 of the License, or (at your option)
  11 *  any later version.
  12 *
  13 *  This program is distributed in the hope that it will be useful, but WITHOUT
  14 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  16 *  more details.
  17 *
  18 *  You should have received a copy of the GNU General Public License along with
  19 *  this program; if not, write to the Free Software Foundation, Inc., 59
  20 *  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 */
  22
  23#ifndef __SOUND_HDA_LOCAL_H
  24#define __SOUND_HDA_LOCAL_H
  25
  26/* We abuse kcontrol_new.subdev field to pass the NID corresponding to
  27 * the given new control.  If id.subdev has a bit flag HDA_SUBDEV_NID_FLAG,
  28 * snd_hda_ctl_add() takes the lower-bit subdev value as a valid NID.
  29 * 
  30 * Note that the subdevice field is cleared again before the real registration
  31 * in snd_hda_ctl_add(), so that this value won't appear in the outside.
  32 */
  33#define HDA_SUBDEV_NID_FLAG     (1U << 31)
  34#define HDA_SUBDEV_AMP_FLAG     (1U << 30)
  35
  36/*
  37 * for mixer controls
  38 */
  39#define HDA_COMPOSE_AMP_VAL_OFS(nid,chs,idx,dir,ofs)            \
  40        ((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19) | ((ofs)<<23))
  41#define HDA_AMP_VAL_MIN_MUTE (1<<29)
  42#define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
  43        HDA_COMPOSE_AMP_VAL_OFS(nid, chs, idx, dir, 0)
  44/* mono volume with index (index=0,1,...) (channel=1,2) */
  45#define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, dir, flags) \
  46        { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx,  \
  47          .subdevice = HDA_SUBDEV_AMP_FLAG, \
  48          .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
  49                    SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  50                    SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
  51          .info = snd_hda_mixer_amp_volume_info, \
  52          .get = snd_hda_mixer_amp_volume_get, \
  53          .put = snd_hda_mixer_amp_volume_put, \
  54          .tlv = { .c = snd_hda_mixer_amp_tlv },                \
  55          .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, dir) | flags }
  56/* stereo volume with index */
  57#define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
  58        HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction, 0)
  59/* mono volume */
  60#define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
  61        HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction, 0)
  62/* stereo volume */
  63#define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
  64        HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
  65/* stereo volume with min=mute */
  66#define HDA_CODEC_VOLUME_MIN_MUTE(xname, nid, xindex, direction) \
  67        HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, 3, xindex, direction, \
  68                                  HDA_AMP_VAL_MIN_MUTE)
  69/* mono mute switch with index (index=0,1,...) (channel=1,2) */
  70#define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
  71        { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
  72          .subdevice = HDA_SUBDEV_AMP_FLAG, \
  73          .info = snd_hda_mixer_amp_switch_info, \
  74          .get = snd_hda_mixer_amp_switch_get, \
  75          .put = snd_hda_mixer_amp_switch_put, \
  76          .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
  77/* stereo mute switch with index */
  78#define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
  79        HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
  80/* mono mute switch */
  81#define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
  82        HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
  83/* stereo mute switch */
  84#define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
  85        HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
  86#ifdef CONFIG_SND_HDA_INPUT_BEEP
  87/* special beep mono mute switch with index (index=0,1,...) (channel=1,2) */
  88#define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
  89        { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
  90          .subdevice = HDA_SUBDEV_AMP_FLAG, \
  91          .info = snd_hda_mixer_amp_switch_info, \
  92          .get = snd_hda_mixer_amp_switch_get_beep, \
  93          .put = snd_hda_mixer_amp_switch_put_beep, \
  94          .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
  95#else
  96/* no digital beep - just the standard one */
  97#define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, ch, xidx, dir) \
  98        HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, ch, xidx, dir)
  99#endif /* CONFIG_SND_HDA_INPUT_BEEP */
 100/* special beep mono mute switch */
 101#define HDA_CODEC_MUTE_BEEP_MONO(xname, nid, channel, xindex, direction) \
 102        HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, 0, nid, channel, xindex, direction)
 103/* special beep stereo mute switch */
 104#define HDA_CODEC_MUTE_BEEP(xname, nid, xindex, direction) \
 105        HDA_CODEC_MUTE_BEEP_MONO(xname, nid, 3, xindex, direction)
 106
 107extern const char *snd_hda_pcm_type_name[];
 108
 109int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
 110                                  struct snd_ctl_elem_info *uinfo);
 111int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
 112                                 struct snd_ctl_elem_value *ucontrol);
 113int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
 114                                 struct snd_ctl_elem_value *ucontrol);
 115int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 116                          unsigned int size, unsigned int __user *tlv);
 117int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
 118                                  struct snd_ctl_elem_info *uinfo);
 119int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
 120                                 struct snd_ctl_elem_value *ucontrol);
 121int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
 122                                 struct snd_ctl_elem_value *ucontrol);
 123#ifdef CONFIG_SND_HDA_INPUT_BEEP
 124int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
 125                                      struct snd_ctl_elem_value *ucontrol);
 126int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
 127                                      struct snd_ctl_elem_value *ucontrol);
 128#endif
 129/* lowlevel accessor with caching; use carefully */
 130int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
 131                           int direction, int index);
 132int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
 133                             int direction, int idx, int mask, int val);
 134int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
 135                             int dir, int idx, int mask, int val);
 136int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch,
 137                           int direction, int idx, int mask, int val);
 138int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid,
 139                                  int dir, int idx, int mask, int val);
 140void snd_hda_codec_resume_amp(struct hda_codec *codec);
 141
 142void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
 143                             unsigned int *tlv);
 144struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
 145                                            const char *name);
 146int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
 147                          unsigned int *tlv, const char * const *slaves,
 148                          const char *suffix, bool init_slave_vol,
 149                          struct snd_kcontrol **ctl_ret);
 150#define snd_hda_add_vmaster(codec, name, tlv, slaves, suffix) \
 151        __snd_hda_add_vmaster(codec, name, tlv, slaves, suffix, true, NULL)
 152int snd_hda_codec_reset(struct hda_codec *codec);
 153
 154enum {
 155        HDA_VMUTE_OFF,
 156        HDA_VMUTE_ON,
 157        HDA_VMUTE_FOLLOW_MASTER,
 158};
 159
 160struct hda_vmaster_mute_hook {
 161        /* below two fields must be filled by the caller of
 162         * snd_hda_add_vmaster_hook() beforehand
 163         */
 164        struct snd_kcontrol *sw_kctl;
 165        void (*hook)(void *, int);
 166        /* below are initialized automatically */
 167        unsigned int mute_mode; /* HDA_VMUTE_XXX */
 168        struct hda_codec *codec;
 169};
 170
 171int snd_hda_add_vmaster_hook(struct hda_codec *codec,
 172                             struct hda_vmaster_mute_hook *hook,
 173                             bool expose_enum_ctl);
 174void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
 175
 176/* amp value bits */
 177#define HDA_AMP_MUTE    0x80
 178#define HDA_AMP_UNMUTE  0x00
 179#define HDA_AMP_VOLMASK 0x7f
 180
 181/* mono switch binding multiple inputs */
 182#define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
 183        { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
 184          .info = snd_hda_mixer_amp_switch_info, \
 185          .get = snd_hda_mixer_bind_switch_get, \
 186          .put = snd_hda_mixer_bind_switch_put, \
 187          .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
 188
 189/* stereo switch binding multiple inputs */
 190#define HDA_BIND_MUTE(xname,nid,indices,dir) \
 191        HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
 192
 193int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
 194                                  struct snd_ctl_elem_value *ucontrol);
 195int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
 196                                  struct snd_ctl_elem_value *ucontrol);
 197
 198/* more generic bound controls */
 199struct hda_ctl_ops {
 200        snd_kcontrol_info_t *info;
 201        snd_kcontrol_get_t *get;
 202        snd_kcontrol_put_t *put;
 203        snd_kcontrol_tlv_rw_t *tlv;
 204};
 205
 206extern struct hda_ctl_ops snd_hda_bind_vol;     /* for bind-volume with TLV */
 207extern struct hda_ctl_ops snd_hda_bind_sw;      /* for bind-switch */
 208
 209struct hda_bind_ctls {
 210        struct hda_ctl_ops *ops;
 211        unsigned long values[];
 212};
 213
 214int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
 215                                 struct snd_ctl_elem_info *uinfo);
 216int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
 217                                struct snd_ctl_elem_value *ucontrol);
 218int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
 219                                struct snd_ctl_elem_value *ucontrol);
 220int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 221                           unsigned int size, unsigned int __user *tlv);
 222
 223#define HDA_BIND_VOL(xname, bindrec) \
 224        { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
 225          .name = xname, \
 226          .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
 227                          SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 228                          SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
 229          .info = snd_hda_mixer_bind_ctls_info,\
 230          .get =  snd_hda_mixer_bind_ctls_get,\
 231          .put = snd_hda_mixer_bind_ctls_put,\
 232          .tlv = { .c = snd_hda_mixer_bind_tlv },\
 233          .private_value = (long) (bindrec) }
 234#define HDA_BIND_SW(xname, bindrec) \
 235        { .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
 236          .name = xname, \
 237          .info = snd_hda_mixer_bind_ctls_info,\
 238          .get =  snd_hda_mixer_bind_ctls_get,\
 239          .put = snd_hda_mixer_bind_ctls_put,\
 240          .private_value = (long) (bindrec) }
 241
 242/*
 243 * SPDIF I/O
 244 */
 245int snd_hda_create_dig_out_ctls(struct hda_codec *codec,
 246                                hda_nid_t associated_nid,
 247                                hda_nid_t cvt_nid, int type);
 248#define snd_hda_create_spdif_out_ctls(codec, anid, cnid) \
 249        snd_hda_create_dig_out_ctls(codec, anid, cnid, HDA_PCM_TYPE_SPDIF)
 250int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
 251
 252/*
 253 * input MUX helper
 254 */
 255#define HDA_MAX_NUM_INPUTS      16
 256struct hda_input_mux_item {
 257        char label[32];
 258        unsigned int index;
 259};
 260struct hda_input_mux {
 261        unsigned int num_items;
 262        struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
 263};
 264
 265int snd_hda_input_mux_info(const struct hda_input_mux *imux,
 266                           struct snd_ctl_elem_info *uinfo);
 267int snd_hda_input_mux_put(struct hda_codec *codec,
 268                          const struct hda_input_mux *imux,
 269                          struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
 270                          unsigned int *cur_val);
 271int snd_hda_add_imux_item(struct hda_input_mux *imux, const char *label,
 272                          int index, int *type_index_ret);
 273
 274/*
 275 * Channel mode helper
 276 */
 277struct hda_channel_mode {
 278        int channels;
 279        const struct hda_verb *sequence;
 280};
 281
 282int snd_hda_ch_mode_info(struct hda_codec *codec,
 283                         struct snd_ctl_elem_info *uinfo,
 284                         const struct hda_channel_mode *chmode,
 285                         int num_chmodes);
 286int snd_hda_ch_mode_get(struct hda_codec *codec,
 287                        struct snd_ctl_elem_value *ucontrol,
 288                        const struct hda_channel_mode *chmode,
 289                        int num_chmodes,
 290                        int max_channels);
 291int snd_hda_ch_mode_put(struct hda_codec *codec,
 292                        struct snd_ctl_elem_value *ucontrol,
 293                        const struct hda_channel_mode *chmode,
 294                        int num_chmodes,
 295                        int *max_channelsp);
 296
 297/*
 298 * Multi-channel / digital-out PCM helper
 299 */
 300
 301enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
 302enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
 303
 304#define HDA_MAX_OUTS    5
 305
 306struct hda_multi_out {
 307        int num_dacs;           /* # of DACs, must be more than 1 */
 308        const hda_nid_t *dac_nids;      /* DAC list */
 309        hda_nid_t hp_nid;       /* optional DAC for HP, 0 when not exists */
 310        hda_nid_t hp_out_nid[HDA_MAX_OUTS];     /* DACs for multiple HPs */
 311        hda_nid_t extra_out_nid[HDA_MAX_OUTS];  /* other (e.g. speaker) DACs */
 312        hda_nid_t dig_out_nid;  /* digital out audio widget */
 313        const hda_nid_t *slave_dig_outs;
 314        int max_channels;       /* currently supported analog channels */
 315        int dig_out_used;       /* current usage of digital out (HDA_DIG_XXX) */
 316        int no_share_stream;    /* don't share a stream with multiple pins */
 317        int share_spdif;        /* share SPDIF pin */
 318        /* PCM information for both analog and SPDIF DACs */
 319        unsigned int analog_rates;
 320        unsigned int analog_maxbps;
 321        u64 analog_formats;
 322        unsigned int spdif_rates;
 323        unsigned int spdif_maxbps;
 324        u64 spdif_formats;
 325};
 326
 327int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
 328                                  struct hda_multi_out *mout);
 329int snd_hda_multi_out_dig_open(struct hda_codec *codec,
 330                               struct hda_multi_out *mout);
 331int snd_hda_multi_out_dig_close(struct hda_codec *codec,
 332                                struct hda_multi_out *mout);
 333int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
 334                                  struct hda_multi_out *mout,
 335                                  unsigned int stream_tag,
 336                                  unsigned int format,
 337                                  struct snd_pcm_substream *substream);
 338int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
 339                                  struct hda_multi_out *mout);
 340int snd_hda_multi_out_analog_open(struct hda_codec *codec,
 341                                  struct hda_multi_out *mout,
 342                                  struct snd_pcm_substream *substream,
 343                                  struct hda_pcm_stream *hinfo);
 344int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
 345                                     struct hda_multi_out *mout,
 346                                     unsigned int stream_tag,
 347                                     unsigned int format,
 348                                     struct snd_pcm_substream *substream);
 349int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
 350                                     struct hda_multi_out *mout);
 351
 352/*
 353 * generic codec parser
 354 */
 355int snd_hda_parse_generic_codec(struct hda_codec *codec);
 356int snd_hda_parse_hdmi_codec(struct hda_codec *codec);
 357
 358/*
 359 * generic proc interface
 360 */
 361#ifdef CONFIG_PROC_FS
 362int snd_hda_codec_proc_new(struct hda_codec *codec);
 363#else
 364static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
 365#endif
 366
 367#define SND_PRINT_BITS_ADVISED_BUFSIZE  16
 368void snd_print_pcm_bits(int pcm, char *buf, int buflen);
 369
 370/*
 371 * Misc
 372 */
 373int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
 374                               const char * const *modelnames,
 375                               const struct snd_pci_quirk *pci_list);
 376int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
 377                               int num_configs, const char * const *models,
 378                               const struct snd_pci_quirk *tbl);
 379int snd_hda_add_new_ctls(struct hda_codec *codec,
 380                         const struct snd_kcontrol_new *knew);
 381
 382/*
 383 * Fix-up pin default configurations and add default verbs
 384 */
 385
 386struct hda_pintbl {
 387        hda_nid_t nid;
 388        u32 val;
 389};
 390
 391struct hda_model_fixup {
 392        const int id;
 393        const char *name;
 394};
 395
 396struct hda_fixup {
 397        int type;
 398        bool chained:1;         /* call the chained fixup(s) after this */
 399        bool chained_before:1;  /* call the chained fixup(s) before this */
 400        int chain_id;
 401        union {
 402                const struct hda_pintbl *pins;
 403                const struct hda_verb *verbs;
 404                void (*func)(struct hda_codec *codec,
 405                             const struct hda_fixup *fix,
 406                             int action);
 407        } v;
 408};
 409
 410/* fixup types */
 411enum {
 412        HDA_FIXUP_INVALID,
 413        HDA_FIXUP_PINS,
 414        HDA_FIXUP_VERBS,
 415        HDA_FIXUP_FUNC,
 416        HDA_FIXUP_PINCTLS,
 417};
 418
 419/* fixup action definitions */
 420enum {
 421        HDA_FIXUP_ACT_PRE_PROBE,
 422        HDA_FIXUP_ACT_PROBE,
 423        HDA_FIXUP_ACT_INIT,
 424        HDA_FIXUP_ACT_BUILD,
 425        HDA_FIXUP_ACT_FREE,
 426};
 427
 428int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
 429void snd_hda_apply_verbs(struct hda_codec *codec);
 430void snd_hda_apply_pincfgs(struct hda_codec *codec,
 431                           const struct hda_pintbl *cfg);
 432void snd_hda_apply_fixup(struct hda_codec *codec, int action);
 433void snd_hda_pick_fixup(struct hda_codec *codec,
 434                        const struct hda_model_fixup *models,
 435                        const struct snd_pci_quirk *quirk,
 436                        const struct hda_fixup *fixlist);
 437
 438/*
 439 * unsolicited event handler
 440 */
 441
 442#define HDA_UNSOL_QUEUE_SIZE    64
 443
 444struct hda_bus_unsolicited {
 445        /* ring buffer */
 446        u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
 447        unsigned int rp, wp;
 448
 449        /* workqueue */
 450        struct work_struct work;
 451        struct hda_bus *bus;
 452};
 453
 454/* helper macros to retrieve pin default-config values */
 455#define get_defcfg_connect(cfg) \
 456        ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
 457#define get_defcfg_association(cfg) \
 458        ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
 459#define get_defcfg_location(cfg) \
 460        ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
 461#define get_defcfg_sequence(cfg) \
 462        (cfg & AC_DEFCFG_SEQUENCE)
 463#define get_defcfg_device(cfg) \
 464        ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
 465#define get_defcfg_misc(cfg) \
 466        ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
 467
 468/* amp values */
 469#define AMP_IN_MUTE(idx)        (0x7080 | ((idx)<<8))
 470#define AMP_IN_UNMUTE(idx)      (0x7000 | ((idx)<<8))
 471#define AMP_OUT_MUTE            0xb080
 472#define AMP_OUT_UNMUTE          0xb000
 473#define AMP_OUT_ZERO            0xb000
 474/* pinctl values */
 475#define PIN_IN                  (AC_PINCTL_IN_EN)
 476#define PIN_VREFHIZ             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
 477#define PIN_VREF50              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
 478#define PIN_VREFGRD             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
 479#define PIN_VREF80              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
 480#define PIN_VREF100             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
 481#define PIN_OUT                 (AC_PINCTL_OUT_EN)
 482#define PIN_HP                  (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
 483#define PIN_HP_AMP              (AC_PINCTL_HP_EN)
 484
 485unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
 486unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
 487                                     hda_nid_t pin, unsigned int val);
 488int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
 489                         unsigned int val, bool cached);
 490
 491/**
 492 * _snd_hda_set_pin_ctl - Set a pin-control value safely
 493 * @codec: the codec instance
 494 * @pin: the pin NID to set the control
 495 * @val: the pin-control value (AC_PINCTL_* bits)
 496 *
 497 * This function sets the pin-control value to the given pin, but
 498 * filters out the invalid pin-control bits when the pin has no such
 499 * capabilities.  For example, when PIN_HP is passed but the pin has no
 500 * HP-drive capability, the HP bit is omitted.
 501 *
 502 * The function doesn't check the input VREF capability bits, though.
 503 * Use snd_hda_get_default_vref() to guess the right value.
 504 * Also, this function is only for analog pins, not for HDMI pins.
 505 */
 506static inline int
 507snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
 508{
 509        return _snd_hda_set_pin_ctl(codec, pin, val, false);
 510}
 511
 512/**
 513 * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
 514 * @codec: the codec instance
 515 * @pin: the pin NID to set the control
 516 * @val: the pin-control value (AC_PINCTL_* bits)
 517 *
 518 * Just like snd_hda_set_pin_ctl() but write to cache as well.
 519 */
 520static inline int
 521snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
 522                          unsigned int val)
 523{
 524        return _snd_hda_set_pin_ctl(codec, pin, val, true);
 525}
 526
 527int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
 528int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
 529                                 unsigned int val);
 530
 531/*
 532 * get widget capabilities
 533 */
 534static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
 535{
 536        if (nid < codec->start_nid ||
 537            nid >= codec->start_nid + codec->num_nodes)
 538                return 0;
 539        return codec->wcaps[nid - codec->start_nid];
 540}
 541
 542/* get the widget type from widget capability bits */
 543static inline int get_wcaps_type(unsigned int wcaps)
 544{
 545        if (!wcaps)
 546                return -1; /* invalid type */
 547        return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
 548}
 549
 550static inline unsigned int get_wcaps_channels(u32 wcaps)
 551{
 552        unsigned int chans;
 553
 554        chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
 555        chans = ((chans << 1) | 1) + 1;
 556
 557        return chans;
 558}
 559
 560static inline void snd_hda_override_wcaps(struct hda_codec *codec,
 561                                          hda_nid_t nid, u32 val)
 562{
 563        if (nid >= codec->start_nid &&
 564            nid < codec->start_nid + codec->num_nodes)
 565                codec->wcaps[nid - codec->start_nid] = val;
 566}
 567
 568u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
 569int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
 570                              unsigned int caps);
 571u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
 572int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
 573                              unsigned int caps);
 574
 575/* flags for hda_nid_item */
 576#define HDA_NID_ITEM_AMP        (1<<0)
 577
 578struct hda_nid_item {
 579        struct snd_kcontrol *kctl;
 580        unsigned int index;
 581        hda_nid_t nid;
 582        unsigned short flags;
 583};
 584
 585int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
 586                    struct snd_kcontrol *kctl);
 587int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
 588                    unsigned int index, hda_nid_t nid);
 589void snd_hda_ctls_clear(struct hda_codec *codec);
 590
 591/*
 592 * hwdep interface
 593 */
 594#ifdef CONFIG_SND_HDA_HWDEP
 595int snd_hda_create_hwdep(struct hda_codec *codec);
 596#else
 597static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
 598#endif
 599
 600void snd_hda_sysfs_init(struct hda_codec *codec);
 601void snd_hda_sysfs_clear(struct hda_codec *codec);
 602
 603extern const struct attribute_group *snd_hda_dev_attr_groups[];
 604
 605#ifdef CONFIG_SND_HDA_RECONFIG
 606const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
 607int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
 608int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
 609#else
 610static inline
 611const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
 612{
 613        return NULL;
 614}
 615
 616static inline
 617int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
 618{
 619        return -ENOENT;
 620}
 621
 622static inline
 623int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
 624{
 625        return -ENOENT;
 626}
 627#endif
 628
 629/*
 630 * power-management
 631 */
 632
 633void snd_hda_schedule_power_save(struct hda_codec *codec);
 634
 635struct hda_amp_list {
 636        hda_nid_t nid;
 637        unsigned char dir;
 638        unsigned char idx;
 639};
 640
 641struct hda_loopback_check {
 642        const struct hda_amp_list *amplist;
 643        int power_on;
 644};
 645
 646int snd_hda_check_amp_list_power(struct hda_codec *codec,
 647                                 struct hda_loopback_check *check,
 648                                 hda_nid_t nid);
 649
 650/* check whether the actual power state matches with the target state */
 651static inline bool
 652snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
 653                          unsigned int target_state)
 654{
 655        unsigned int state = snd_hda_codec_read(codec, nid, 0,
 656                                                AC_VERB_GET_POWER_STATE, 0);
 657        if (state & AC_PWRST_ERROR)
 658                return true;
 659        state = (state >> 4) & 0x0f;
 660        return (state == target_state);
 661}
 662
 663unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
 664                                             hda_nid_t nid,
 665                                             unsigned int power_state);
 666
 667/*
 668 * AMP control callbacks
 669 */
 670/* retrieve parameters from private_value */
 671#define get_amp_nid_(pv)        ((pv) & 0xffff)
 672#define get_amp_nid(kc)         get_amp_nid_((kc)->private_value)
 673#define get_amp_channels(kc)    (((kc)->private_value >> 16) & 0x3)
 674#define get_amp_direction_(pv)  (((pv) >> 18) & 0x1)
 675#define get_amp_direction(kc)   get_amp_direction_((kc)->private_value)
 676#define get_amp_index_(pv)      (((pv) >> 19) & 0xf)
 677#define get_amp_index(kc)       get_amp_index_((kc)->private_value)
 678#define get_amp_offset(kc)      (((kc)->private_value >> 23) & 0x3f)
 679#define get_amp_min_mute(kc)    (((kc)->private_value >> 29) & 0x1)
 680
 681/*
 682 * enum control helper
 683 */
 684int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
 685                             struct snd_ctl_elem_info *uinfo,
 686                             int num_entries, const char * const *texts);
 687#define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
 688        snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
 689
 690/*
 691 * CEA Short Audio Descriptor data
 692 */
 693struct cea_sad {
 694        int     channels;
 695        int     format;         /* (format == 0) indicates invalid SAD */
 696        int     rates;
 697        int     sample_bits;    /* for LPCM */
 698        int     max_bitrate;    /* for AC3...ATRAC */
 699        int     profile;        /* for WMAPRO */
 700};
 701
 702#define ELD_FIXED_BYTES 20
 703#define ELD_MAX_SIZE    256
 704#define ELD_MAX_MNL     16
 705#define ELD_MAX_SAD     16
 706
 707/*
 708 * ELD: EDID Like Data
 709 */
 710struct parsed_hdmi_eld {
 711        /*
 712         * all fields will be cleared before updating ELD
 713         */
 714        int     baseline_len;
 715        int     eld_ver;
 716        int     cea_edid_ver;
 717        char    monitor_name[ELD_MAX_MNL + 1];
 718        int     manufacture_id;
 719        int     product_id;
 720        u64     port_id;
 721        int     support_hdcp;
 722        int     support_ai;
 723        int     conn_type;
 724        int     aud_synch_delay;
 725        int     spk_alloc;
 726        int     sad_count;
 727        struct cea_sad sad[ELD_MAX_SAD];
 728};
 729
 730struct hdmi_eld {
 731        bool    monitor_present;
 732        bool    eld_valid;
 733        int     eld_size;
 734        char    eld_buffer[ELD_MAX_SIZE];
 735        struct parsed_hdmi_eld info;
 736};
 737
 738int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
 739int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
 740                     unsigned char *buf, int *eld_size);
 741int snd_hdmi_parse_eld(struct parsed_hdmi_eld *e,
 742                       const unsigned char *buf, int size);
 743void snd_hdmi_show_eld(struct parsed_hdmi_eld *e);
 744void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
 745                              struct hda_pcm_stream *hinfo);
 746
 747int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
 748                         unsigned char *buf, int *eld_size,
 749                         bool rev3_or_later);
 750
 751#ifdef CONFIG_PROC_FS
 752void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
 753                             struct snd_info_buffer *buffer);
 754void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
 755                             struct snd_info_buffer *buffer);
 756#endif
 757
 758#define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
 759void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
 760
 761/*
 762 */
 763#define codec_err(codec, fmt, args...) dev_err(&(codec)->dev, fmt, ##args)
 764#define codec_warn(codec, fmt, args...) dev_warn(&(codec)->dev, fmt, ##args)
 765#define codec_info(codec, fmt, args...) dev_info(&(codec)->dev, fmt, ##args)
 766#define codec_dbg(codec, fmt, args...) dev_dbg(&(codec)->dev, fmt, ##args)
 767
 768#endif /* __SOUND_HDA_LOCAL_H */
 769