sound/pci/hda/hda_local.h

   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
 107 extern const char *snd_hda_pcm_type_name[];
 108
 109 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
 110                                   struct snd_ctl_elem_info *uinfo);
 111 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
 112                                  struct snd_ctl_elem_value *ucontrol);
 113 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
 114                                  struct snd_ctl_elem_value *ucontrol);
 115 int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 116                           unsigned int size, unsigned int __user *tlv);
 117 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
 118                                   struct snd_ctl_elem_info *uinfo);
 119 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
 120                                  struct snd_ctl_elem_value *ucontrol);
 121 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
 122                                  struct snd_ctl_elem_value *ucontrol);
 123 #ifdef CONFIG_SND_HDA_INPUT_BEEP
 124 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
 125                                       struct snd_ctl_elem_value *ucontrol);
 126 int 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 */
 130 int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
 131                            int direction, int index);
 132 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
 133                              int direction, int idx, int mask, int val);
 134 int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
 135                              int dir, int idx, int mask, int val);
 136 int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch,
 137                            int direction, int idx, int mask, int val);
 138 int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid,
 139                                   int dir, int idx, int mask, int val);
 140 void snd_hda_codec_resume_amp(struct hda_codec *codec);
 141
 142 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
 143                              unsigned int *tlv);
 144 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
 145                                             const char *name);
 146 int __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)
 152 int snd_hda_codec_reset(struct hda_codec *codec);
 153
 154 enum {
 155         HDA_VMUTE_OFF,
 156         HDA_VMUTE_ON,
 157         HDA_VMUTE_FOLLOW_MASTER,
 158 };
 159
 160 struct 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
 171 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
 172                              struct hda_vmaster_mute_hook *hook,
 173                              bool expose_enum_ctl);
 174 void 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
 193 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
 194                                   struct snd_ctl_elem_value *ucontrol);
 195 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
 196                                   struct snd_ctl_elem_value *ucontrol);
 197
 198 /* more generic bound controls */
 199 struct 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
 206 extern struct hda_ctl_ops snd_hda_bind_vol;     /* for bind-volume with TLV */
 207 extern struct hda_ctl_ops snd_hda_bind_sw;      /* for bind-switch */
 208
 209 struct hda_bind_ctls {
 210         struct hda_ctl_ops *ops;
 211         unsigned long values[];
 212 };
 213
 214 int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
 215                                  struct snd_ctl_elem_info *uinfo);
 216 int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
 217                                 struct snd_ctl_elem_value *ucontrol);
 218 int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
 219                                 struct snd_ctl_elem_value *ucontrol);
 220 int 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  */
 245 int 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)
 250 int 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
 256 struct hda_input_mux_item {
 257         char label[32];
 258         unsigned int index;
 259 };
 260 struct hda_input_mux {
 261         unsigned int num_items;
 262         struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
 263 };
 264
 265 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
 266                            struct snd_ctl_elem_info *uinfo);
 267 int 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);
 271 int 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  */
 277 struct hda_channel_mode {
 278         int channels;
 279         const struct hda_verb *sequence;
 280 };
 281
 282 int 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);
 286 int 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);
 291 int 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
 301 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
 302 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
 303
 304 #define HDA_MAX_OUTS    5
 305
 306 struct 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
 327 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
 328                                   struct hda_multi_out *mout);
 329 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
 330                                struct hda_multi_out *mout);
 331 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
 332                                 struct hda_multi_out *mout);
 333 int 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);
 338 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
 339                                   struct hda_multi_out *mout);
 340 int 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);
 344 int 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);
 349 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
 350                                      struct hda_multi_out *mout);
 351
 352 /*
 353  * generic codec parser
 354  */
 355 #ifdef CONFIG_SND_HDA_GENERIC
 356 int snd_hda_parse_generic_codec(struct hda_codec *codec);
 357 #else
 358 static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
 359 {
 360         return -ENODEV;
 361 }
 362 #endif
 363
 364 /*
 365  * generic proc interface
 366  */
 367 #ifdef CONFIG_PROC_FS
 368 int snd_hda_codec_proc_new(struct hda_codec *codec);
 369 #else
 370 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
 371 #endif
 372
 373 #define SND_PRINT_BITS_ADVISED_BUFSIZE  16
 374 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
 375
 376 /*
 377  * Misc
 378  */
 379 int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
 380                                const char * const *modelnames,
 381                                const struct snd_pci_quirk *pci_list);
 382 int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
 383                                int num_configs, const char * const *models,
 384                                const struct snd_pci_quirk *tbl);
 385 int snd_hda_add_new_ctls(struct hda_codec *codec,
 386                          const struct snd_kcontrol_new *knew);
 387
 388 /*
 389  * Fix-up pin default configurations and add default verbs
 390  */
 391
 392 struct hda_pintbl {
 393         hda_nid_t nid;
 394         u32 val;
 395 };
 396
 397 struct hda_model_fixup {
 398         const int id;
 399         const char *name;
 400 };
 401
 402 struct hda_fixup {
 403         int type;
 404         bool chained:1;         /* call the chained fixup(s) after this */
 405         bool chained_before:1;  /* call the chained fixup(s) before this */
 406         int chain_id;
 407         union {
 408                 const struct hda_pintbl *pins;
 409                 const struct hda_verb *verbs;
 410                 void (*func)(struct hda_codec *codec,
 411                              const struct hda_fixup *fix,
 412                              int action);
 413         } v;
 414 };
 415
 416 /* fixup types */
 417 enum {
 418         HDA_FIXUP_INVALID,
 419         HDA_FIXUP_PINS,
 420         HDA_FIXUP_VERBS,
 421         HDA_FIXUP_FUNC,
 422         HDA_FIXUP_PINCTLS,
 423 };
 424
 425 /* fixup action definitions */
 426 enum {
 427         HDA_FIXUP_ACT_PRE_PROBE,
 428         HDA_FIXUP_ACT_PROBE,
 429         HDA_FIXUP_ACT_INIT,
 430         HDA_FIXUP_ACT_BUILD,
 431 };
 432
 433 int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
 434 void snd_hda_apply_verbs(struct hda_codec *codec);
 435 void snd_hda_apply_pincfgs(struct hda_codec *codec,
 436                            const struct hda_pintbl *cfg);
 437 void snd_hda_apply_fixup(struct hda_codec *codec, int action);
 438 void snd_hda_pick_fixup(struct hda_codec *codec,
 439                         const struct hda_model_fixup *models,
 440                         const struct snd_pci_quirk *quirk,
 441                         const struct hda_fixup *fixlist);
 442
 443 /*
 444  * unsolicited event handler
 445  */
 446
 447 #define HDA_UNSOL_QUEUE_SIZE    64
 448
 449 struct hda_bus_unsolicited {
 450         /* ring buffer */
 451         u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
 452         unsigned int rp, wp;
 453
 454         /* workqueue */
 455         struct work_struct work;
 456         struct hda_bus *bus;
 457 };
 458
 459 /* helper macros to retrieve pin default-config values */
 460 #define get_defcfg_connect(cfg) \
 461         ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
 462 #define get_defcfg_association(cfg) \
 463         ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
 464 #define get_defcfg_location(cfg) \
 465         ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
 466 #define get_defcfg_sequence(cfg) \
 467         (cfg & AC_DEFCFG_SEQUENCE)
 468 #define get_defcfg_device(cfg) \
 469         ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
 470 #define get_defcfg_misc(cfg) \
 471         ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
 472
 473 /* amp values */
 474 #define AMP_IN_MUTE(idx)        (0x7080 | ((idx)<<8))
 475 #define AMP_IN_UNMUTE(idx)      (0x7000 | ((idx)<<8))
 476 #define AMP_OUT_MUTE            0xb080
 477 #define AMP_OUT_UNMUTE          0xb000
 478 #define AMP_OUT_ZERO            0xb000
 479 /* pinctl values */
 480 #define PIN_IN                  (AC_PINCTL_IN_EN)
 481 #define PIN_VREFHIZ             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
 482 #define PIN_VREF50              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
 483 #define PIN_VREFGRD             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
 484 #define PIN_VREF80              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
 485 #define PIN_VREF100             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
 486 #define PIN_OUT                 (AC_PINCTL_OUT_EN)
 487 #define PIN_HP                  (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
 488 #define PIN_HP_AMP              (AC_PINCTL_HP_EN)
 489
 490 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
 491 unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
 492                                      hda_nid_t pin, unsigned int val);
 493 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
 494                          unsigned int val, bool cached);
 495
 496 /**
 497  * _snd_hda_set_pin_ctl - Set a pin-control value safely
 498  * @codec: the codec instance
 499  * @pin: the pin NID to set the control
 500  * @val: the pin-control value (AC_PINCTL_* bits)
 501  *
 502  * This function sets the pin-control value to the given pin, but
 503  * filters out the invalid pin-control bits when the pin has no such
 504  * capabilities.  For example, when PIN_HP is passed but the pin has no
 505  * HP-drive capability, the HP bit is omitted.
 506  *
 507  * The function doesn't check the input VREF capability bits, though.
 508  * Use snd_hda_get_default_vref() to guess the right value.
 509  * Also, this function is only for analog pins, not for HDMI pins.
 510  */
 511 static inline int
 512 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
 513 {
 514         return _snd_hda_set_pin_ctl(codec, pin, val, false);
 515 }
 516
 517 /**
 518  * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
 519  * @codec: the codec instance
 520  * @pin: the pin NID to set the control
 521  * @val: the pin-control value (AC_PINCTL_* bits)
 522  *
 523  * Just like snd_hda_set_pin_ctl() but write to cache as well.
 524  */
 525 static inline int
 526 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
 527                           unsigned int val)
 528 {
 529         return _snd_hda_set_pin_ctl(codec, pin, val, true);
 530 }
 531
 532 int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
 533 int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
 534                                  unsigned int val);
 535
 536 /*
 537  * get widget capabilities
 538  */
 539 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
 540 {
 541         if (nid < codec->start_nid ||
 542             nid >= codec->start_nid + codec->num_nodes)
 543                 return 0;
 544         return codec->wcaps[nid - codec->start_nid];
 545 }
 546
 547 /* get the widget type from widget capability bits */
 548 static inline int get_wcaps_type(unsigned int wcaps)
 549 {
 550         if (!wcaps)
 551                 return -1; /* invalid type */
 552         return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
 553 }
 554
 555 static inline unsigned int get_wcaps_channels(u32 wcaps)
 556 {
 557         unsigned int chans;
 558
 559         chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
 560         chans = ((chans << 1) | 1) + 1;
 561
 562         return chans;
 563 }
 564
 565 static inline void snd_hda_override_wcaps(struct hda_codec *codec,
 566                                           hda_nid_t nid, u32 val)
 567 {
 568         if (nid >= codec->start_nid &&
 569             nid < codec->start_nid + codec->num_nodes)
 570                 codec->wcaps[nid - codec->start_nid] = val;
 571 }
 572
 573 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
 574 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
 575                               unsigned int caps);
 576 u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
 577 int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
 578                               unsigned int caps);
 579
 580 /* flags for hda_nid_item */
 581 #define HDA_NID_ITEM_AMP        (1<<0)
 582
 583 struct hda_nid_item {
 584         struct snd_kcontrol *kctl;
 585         unsigned int index;
 586         hda_nid_t nid;
 587         unsigned short flags;
 588 };
 589
 590 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
 591                     struct snd_kcontrol *kctl);
 592 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
 593                     unsigned int index, hda_nid_t nid);
 594 void snd_hda_ctls_clear(struct hda_codec *codec);
 595
 596 /*
 597  * hwdep interface
 598  */
 599 #ifdef CONFIG_SND_HDA_HWDEP
 600 int snd_hda_create_hwdep(struct hda_codec *codec);
 601 #else
 602 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
 603 #endif
 604
 605 #if defined(CONFIG_PM) && defined(CONFIG_SND_HDA_HWDEP)
 606 int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec);
 607 #else
 608 static inline int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec)
 609 {
 610         return 0;
 611 }
 612 #endif
 613
 614 #ifdef CONFIG_SND_HDA_RECONFIG
 615 int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
 616 #else
 617 static inline int snd_hda_hwdep_add_sysfs(struct hda_codec *codec)
 618 {
 619         return 0;
 620 }
 621 #endif
 622
 623 #ifdef CONFIG_SND_HDA_RECONFIG
 624 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
 625 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
 626 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
 627 #else
 628 static inline
 629 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
 630 {
 631         return NULL;
 632 }
 633
 634 static inline
 635 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
 636 {
 637         return -ENOENT;
 638 }
 639
 640 static inline
 641 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
 642 {
 643         return -ENOENT;
 644 }
 645 #endif
 646
 647 /*
 648  * power-management
 649  */
 650
 651 void snd_hda_schedule_power_save(struct hda_codec *codec);
 652
 653 struct hda_amp_list {
 654         hda_nid_t nid;
 655         unsigned char dir;
 656         unsigned char idx;
 657 };
 658
 659 struct hda_loopback_check {
 660         const struct hda_amp_list *amplist;
 661         int power_on;
 662 };
 663
 664 int snd_hda_check_amp_list_power(struct hda_codec *codec,
 665                                  struct hda_loopback_check *check,
 666                                  hda_nid_t nid);
 667
 668 /* check whether the actual power state matches with the target state */
 669 static inline bool
 670 snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
 671                           unsigned int target_state)
 672 {
 673         unsigned int state = snd_hda_codec_read(codec, nid, 0,
 674                                                 AC_VERB_GET_POWER_STATE, 0);
 675         if (state & AC_PWRST_ERROR)
 676                 return true;
 677         state = (state >> 4) & 0x0f;
 678         return (state == target_state);
 679 }
 680
 681 unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
 682                                              hda_nid_t nid,
 683                                              unsigned int power_state);
 684
 685 /*
 686  * AMP control callbacks
 687  */
 688 /* retrieve parameters from private_value */
 689 #define get_amp_nid_(pv)        ((pv) & 0xffff)
 690 #define get_amp_nid(kc)         get_amp_nid_((kc)->private_value)
 691 #define get_amp_channels(kc)    (((kc)->private_value >> 16) & 0x3)
 692 #define get_amp_direction_(pv)  (((pv) >> 18) & 0x1)
 693 #define get_amp_direction(kc)   get_amp_direction_((kc)->private_value)
 694 #define get_amp_index_(pv)      (((pv) >> 19) & 0xf)
 695 #define get_amp_index(kc)       get_amp_index_((kc)->private_value)
 696 #define get_amp_offset(kc)      (((kc)->private_value >> 23) & 0x3f)
 697 #define get_amp_min_mute(kc)    (((kc)->private_value >> 29) & 0x1)
 698
 699 /*
 700  * enum control helper
 701  */
 702 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
 703                              struct snd_ctl_elem_info *uinfo,
 704                              int num_entries, const char * const *texts);
 705 #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
 706         snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
 707
 708 /*
 709  * CEA Short Audio Descriptor data
 710  */
 711 struct cea_sad {
 712         int     channels;
 713         int     format;         /* (format == 0) indicates invalid SAD */
 714         int     rates;
 715         int     sample_bits;    /* for LPCM */
 716         int     max_bitrate;    /* for AC3...ATRAC */
 717         int     profile;        /* for WMAPRO */
 718 };
 719
 720 #define ELD_FIXED_BYTES 20
 721 #define ELD_MAX_SIZE    256
 722 #define ELD_MAX_MNL     16
 723 #define ELD_MAX_SAD     16
 724
 725 /*
 726  * ELD: EDID Like Data
 727  */
 728 struct parsed_hdmi_eld {
 729         /*
 730          * all fields will be cleared before updating ELD
 731          */
 732         int     baseline_len;
 733         int     eld_ver;
 734         int     cea_edid_ver;
 735         char    monitor_name[ELD_MAX_MNL + 1];
 736         int     manufacture_id;
 737         int     product_id;
 738         u64     port_id;
 739         int     support_hdcp;
 740         int     support_ai;
 741         int     conn_type;
 742         int     aud_synch_delay;
 743         int     spk_alloc;
 744         int     sad_count;
 745         struct cea_sad sad[ELD_MAX_SAD];
 746 };
 747
 748 struct hdmi_eld {
 749         bool    monitor_present;
 750         bool    eld_valid;
 751         int     eld_size;
 752         char    eld_buffer[ELD_MAX_SIZE];
 753         struct parsed_hdmi_eld info;
 754         struct mutex lock;
 755 #ifdef CONFIG_PROC_FS
 756         struct snd_info_entry *proc_entry;
 757 #endif
 758 };
 759
 760 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
 761 int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
 762                      unsigned char *buf, int *eld_size);
 763 int snd_hdmi_parse_eld(struct parsed_hdmi_eld *e,
 764                        const unsigned char *buf, int size);
 765 void snd_hdmi_show_eld(struct parsed_hdmi_eld *e);
 766 void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
 767                               struct hda_pcm_stream *hinfo);
 768
 769 #ifdef CONFIG_PROC_FS
 770 int snd_hda_eld_proc_new(struct hda_codec *codec, struct hdmi_eld *eld,
 771                          int index);
 772 void snd_hda_eld_proc_free(struct hda_codec *codec, struct hdmi_eld *eld);
 773 #else
 774 static inline int snd_hda_eld_proc_new(struct hda_codec *codec,
 775                                        struct hdmi_eld *eld,
 776                                        int index)
 777 {
 778         return 0;
 779 }
 780 static inline void snd_hda_eld_proc_free(struct hda_codec *codec,
 781                                          struct hdmi_eld *eld)
 782 {
 783 }
 784 #endif
 785
 786 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
 787 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
 788
 789 #endif /* __SOUND_HDA_LOCAL_H */