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, \
  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_put_beep(struct snd_kcontrol *kcontrol,
 125                                       struct snd_ctl_elem_value *ucontrol);
 126 #endif
 127 /* lowlevel accessor with caching; use carefully */
 128 int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
 129                            int direction, int index);
 130 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
 131                              int direction, int idx, int mask, int val);
 132 int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
 133                              int dir, int idx, int mask, int val);
 134 #ifdef CONFIG_PM
 135 void snd_hda_codec_resume_amp(struct hda_codec *codec);
 136 #endif
 137
 138 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
 139                              unsigned int *tlv);
 140 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
 141                                             const char *name);
 142 int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
 143                           unsigned int *tlv, const char * const *slaves,
 144                           const char *suffix, bool init_slave_vol,
 145                           struct snd_kcontrol **ctl_ret);
 146 #define snd_hda_add_vmaster(codec, name, tlv, slaves, suffix) \
 147         __snd_hda_add_vmaster(codec, name, tlv, slaves, suffix, true, NULL)
 148 int snd_hda_codec_reset(struct hda_codec *codec);
 149
 150 enum {
 151         HDA_VMUTE_OFF,
 152         HDA_VMUTE_ON,
 153         HDA_VMUTE_FOLLOW_MASTER,
 154 };
 155
 156 struct hda_vmaster_mute_hook {
 157         /* below two fields must be filled by the caller of
 158          * snd_hda_add_vmaster_hook() beforehand
 159          */
 160         struct snd_kcontrol *sw_kctl;
 161         void (*hook)(void *, int);
 162         /* below are initialized automatically */
 163         unsigned int mute_mode; /* HDA_VMUTE_XXX */
 164         struct hda_codec *codec;
 165 };
 166
 167 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
 168                              struct hda_vmaster_mute_hook *hook,
 169                              bool expose_enum_ctl);
 170 void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
 171
 172 /* amp value bits */
 173 #define HDA_AMP_MUTE    0x80
 174 #define HDA_AMP_UNMUTE  0x00
 175 #define HDA_AMP_VOLMASK 0x7f
 176
 177 /* mono switch binding multiple inputs */
 178 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
 179         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
 180           .info = snd_hda_mixer_amp_switch_info, \
 181           .get = snd_hda_mixer_bind_switch_get, \
 182           .put = snd_hda_mixer_bind_switch_put, \
 183           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
 184
 185 /* stereo switch binding multiple inputs */
 186 #define HDA_BIND_MUTE(xname,nid,indices,dir) \
 187         HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
 188
 189 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
 190                                   struct snd_ctl_elem_value *ucontrol);
 191 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
 192                                   struct snd_ctl_elem_value *ucontrol);
 193
 194 /* more generic bound controls */
 195 struct hda_ctl_ops {
 196         snd_kcontrol_info_t *info;
 197         snd_kcontrol_get_t *get;
 198         snd_kcontrol_put_t *put;
 199         snd_kcontrol_tlv_rw_t *tlv;
 200 };
 201
 202 extern struct hda_ctl_ops snd_hda_bind_vol;     /* for bind-volume with TLV */
 203 extern struct hda_ctl_ops snd_hda_bind_sw;      /* for bind-switch */
 204
 205 struct hda_bind_ctls {
 206         struct hda_ctl_ops *ops;
 207         unsigned long values[];
 208 };
 209
 210 int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
 211                                  struct snd_ctl_elem_info *uinfo);
 212 int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
 213                                 struct snd_ctl_elem_value *ucontrol);
 214 int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
 215                                 struct snd_ctl_elem_value *ucontrol);
 216 int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 217                            unsigned int size, unsigned int __user *tlv);
 218
 219 #define HDA_BIND_VOL(xname, bindrec) \
 220         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
 221           .name = xname, \
 222           .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
 223                           SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 224                           SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
 225           .info = snd_hda_mixer_bind_ctls_info,\
 226           .get =  snd_hda_mixer_bind_ctls_get,\
 227           .put = snd_hda_mixer_bind_ctls_put,\
 228           .tlv = { .c = snd_hda_mixer_bind_tlv },\
 229           .private_value = (long) (bindrec) }
 230 #define HDA_BIND_SW(xname, bindrec) \
 231         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
 232           .name = xname, \
 233           .info = snd_hda_mixer_bind_ctls_info,\
 234           .get =  snd_hda_mixer_bind_ctls_get,\
 235           .put = snd_hda_mixer_bind_ctls_put,\
 236           .private_value = (long) (bindrec) }
 237
 238 /*
 239  * SPDIF I/O
 240  */
 241 int snd_hda_create_spdif_out_ctls(struct hda_codec *codec,
 242                                   hda_nid_t associated_nid,
 243                                   hda_nid_t cvt_nid);
 244 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
 245
 246 /*
 247  * input MUX helper
 248  */
 249 #define HDA_MAX_NUM_INPUTS      16
 250 struct hda_input_mux_item {
 251         char label[32];
 252         unsigned int index;
 253 };
 254 struct hda_input_mux {
 255         unsigned int num_items;
 256         struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
 257 };
 258
 259 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
 260                            struct snd_ctl_elem_info *uinfo);
 261 int snd_hda_input_mux_put(struct hda_codec *codec,
 262                           const struct hda_input_mux *imux,
 263                           struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
 264                           unsigned int *cur_val);
 265 int snd_hda_add_imux_item(struct hda_input_mux *imux, const char *label,
 266                           int index, int *type_index_ret);
 267
 268 /*
 269  * Channel mode helper
 270  */
 271 struct hda_channel_mode {
 272         int channels;
 273         const struct hda_verb *sequence;
 274 };
 275
 276 int snd_hda_ch_mode_info(struct hda_codec *codec,
 277                          struct snd_ctl_elem_info *uinfo,
 278                          const struct hda_channel_mode *chmode,
 279                          int num_chmodes);
 280 int snd_hda_ch_mode_get(struct hda_codec *codec,
 281                         struct snd_ctl_elem_value *ucontrol,
 282                         const struct hda_channel_mode *chmode,
 283                         int num_chmodes,
 284                         int max_channels);
 285 int snd_hda_ch_mode_put(struct hda_codec *codec,
 286                         struct snd_ctl_elem_value *ucontrol,
 287                         const struct hda_channel_mode *chmode,
 288                         int num_chmodes,
 289                         int *max_channelsp);
 290
 291 /*
 292  * Multi-channel / digital-out PCM helper
 293  */
 294
 295 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
 296 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
 297
 298 #define HDA_MAX_OUTS    5
 299
 300 struct hda_multi_out {
 301         int num_dacs;           /* # of DACs, must be more than 1 */
 302         const hda_nid_t *dac_nids;      /* DAC list */
 303         hda_nid_t hp_nid;       /* optional DAC for HP, 0 when not exists */
 304         hda_nid_t hp_out_nid[HDA_MAX_OUTS];     /* DACs for multiple HPs */
 305         hda_nid_t extra_out_nid[HDA_MAX_OUTS];  /* other (e.g. speaker) DACs */
 306         hda_nid_t dig_out_nid;  /* digital out audio widget */
 307         const hda_nid_t *slave_dig_outs;
 308         int max_channels;       /* currently supported analog channels */
 309         int dig_out_used;       /* current usage of digital out (HDA_DIG_XXX) */
 310         int no_share_stream;    /* don't share a stream with multiple pins */
 311         int share_spdif;        /* share SPDIF pin */
 312         /* PCM information for both analog and SPDIF DACs */
 313         unsigned int analog_rates;
 314         unsigned int analog_maxbps;
 315         u64 analog_formats;
 316         unsigned int spdif_rates;
 317         unsigned int spdif_maxbps;
 318         u64 spdif_formats;
 319 };
 320
 321 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
 322                                   struct hda_multi_out *mout);
 323 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
 324                                struct hda_multi_out *mout);
 325 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
 326                                 struct hda_multi_out *mout);
 327 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
 328                                   struct hda_multi_out *mout,
 329                                   unsigned int stream_tag,
 330                                   unsigned int format,
 331                                   struct snd_pcm_substream *substream);
 332 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
 333                                   struct hda_multi_out *mout);
 334 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
 335                                   struct hda_multi_out *mout,
 336                                   struct snd_pcm_substream *substream,
 337                                   struct hda_pcm_stream *hinfo);
 338 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
 339                                      struct hda_multi_out *mout,
 340                                      unsigned int stream_tag,
 341                                      unsigned int format,
 342                                      struct snd_pcm_substream *substream);
 343 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
 344                                      struct hda_multi_out *mout);
 345
 346 /*
 347  * generic codec parser
 348  */
 349 #ifdef CONFIG_SND_HDA_GENERIC
 350 int snd_hda_parse_generic_codec(struct hda_codec *codec);
 351 #else
 352 static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
 353 {
 354         return -ENODEV;
 355 }
 356 #endif
 357
 358 /*
 359  * generic proc interface
 360  */
 361 #ifdef CONFIG_PROC_FS
 362 int snd_hda_codec_proc_new(struct hda_codec *codec);
 363 #else
 364 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
 365 #endif
 366
 367 #define SND_PRINT_BITS_ADVISED_BUFSIZE  16
 368 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
 369
 370 /*
 371  * Misc
 372  */
 373 int 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);
 376 int 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);
 379 int snd_hda_add_new_ctls(struct hda_codec *codec,
 380                          const struct snd_kcontrol_new *knew);
 381
 382 /*
 383  * unsolicited event handler
 384  */
 385
 386 #define HDA_UNSOL_QUEUE_SIZE    64
 387
 388 struct hda_bus_unsolicited {
 389         /* ring buffer */
 390         u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
 391         unsigned int rp, wp;
 392
 393         /* workqueue */
 394         struct work_struct work;
 395         struct hda_bus *bus;
 396 };
 397
 398 /* helper macros to retrieve pin default-config values */
 399 #define get_defcfg_connect(cfg) \
 400         ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
 401 #define get_defcfg_association(cfg) \
 402         ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
 403 #define get_defcfg_location(cfg) \
 404         ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
 405 #define get_defcfg_sequence(cfg) \
 406         (cfg & AC_DEFCFG_SEQUENCE)
 407 #define get_defcfg_device(cfg) \
 408         ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
 409 #define get_defcfg_misc(cfg) \
 410         ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
 411
 412 /* amp values */
 413 #define AMP_IN_MUTE(idx)        (0x7080 | ((idx)<<8))
 414 #define AMP_IN_UNMUTE(idx)      (0x7000 | ((idx)<<8))
 415 #define AMP_OUT_MUTE            0xb080
 416 #define AMP_OUT_UNMUTE          0xb000
 417 #define AMP_OUT_ZERO            0xb000
 418 /* pinctl values */
 419 #define PIN_IN                  (AC_PINCTL_IN_EN)
 420 #define PIN_VREFHIZ             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
 421 #define PIN_VREF50              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
 422 #define PIN_VREFGRD             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
 423 #define PIN_VREF80              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
 424 #define PIN_VREF100             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
 425 #define PIN_OUT                 (AC_PINCTL_OUT_EN)
 426 #define PIN_HP                  (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
 427 #define PIN_HP_AMP              (AC_PINCTL_HP_EN)
 428
 429 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
 430 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
 431                          unsigned int val, bool cached);
 432
 433 /**
 434  * _snd_hda_set_pin_ctl - Set a pin-control value safely
 435  * @codec: the codec instance
 436  * @pin: the pin NID to set the control
 437  * @val: the pin-control value (AC_PINCTL_* bits)
 438  *
 439  * This function sets the pin-control value to the given pin, but
 440  * filters out the invalid pin-control bits when the pin has no such
 441  * capabilities.  For example, when PIN_HP is passed but the pin has no
 442  * HP-drive capability, the HP bit is omitted.
 443  *
 444  * The function doesn't check the input VREF capability bits, though.
 445  * Use snd_hda_get_default_vref() to guess the right value.
 446  * Also, this function is only for analog pins, not for HDMI pins.
 447  */
 448 static inline int
 449 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
 450 {
 451         return _snd_hda_set_pin_ctl(codec, pin, val, false);
 452 }
 453
 454 /**
 455  * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
 456  * @codec: the codec instance
 457  * @pin: the pin NID to set the control
 458  * @val: the pin-control value (AC_PINCTL_* bits)
 459  *
 460  * Just like snd_hda_set_pin_ctl() but write to cache as well.
 461  */
 462 static inline int
 463 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
 464                           unsigned int val)
 465 {
 466         return _snd_hda_set_pin_ctl(codec, pin, val, true);
 467 }
 468
 469 /*
 470  * get widget capabilities
 471  */
 472 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
 473 {
 474         if (nid < codec->start_nid ||
 475             nid >= codec->start_nid + codec->num_nodes)
 476                 return 0;
 477         return codec->wcaps[nid - codec->start_nid];
 478 }
 479
 480 /* get the widget type from widget capability bits */
 481 static inline int get_wcaps_type(unsigned int wcaps)
 482 {
 483         if (!wcaps)
 484                 return -1; /* invalid type */
 485         return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
 486 }
 487
 488 static inline unsigned int get_wcaps_channels(u32 wcaps)
 489 {
 490         unsigned int chans;
 491
 492         chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
 493         chans = ((chans << 1) | 1) + 1;
 494
 495         return chans;
 496 }
 497
 498 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
 499 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
 500                               unsigned int caps);
 501 u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
 502 int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
 503                               unsigned int caps);
 504
 505 /* flags for hda_nid_item */
 506 #define HDA_NID_ITEM_AMP        (1<<0)
 507
 508 struct hda_nid_item {
 509         struct snd_kcontrol *kctl;
 510         unsigned int index;
 511         hda_nid_t nid;
 512         unsigned short flags;
 513 };
 514
 515 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
 516                     struct snd_kcontrol *kctl);
 517 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
 518                     unsigned int index, hda_nid_t nid);
 519 void snd_hda_ctls_clear(struct hda_codec *codec);
 520
 521 /*
 522  * hwdep interface
 523  */
 524 #ifdef CONFIG_SND_HDA_HWDEP
 525 int snd_hda_create_hwdep(struct hda_codec *codec);
 526 #else
 527 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
 528 #endif
 529
 530 #if defined(CONFIG_SND_HDA_POWER_SAVE) && defined(CONFIG_SND_HDA_HWDEP)
 531 int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec);
 532 #else
 533 static inline int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec)
 534 {
 535         return 0;
 536 }
 537 #endif
 538
 539 #ifdef CONFIG_SND_HDA_RECONFIG
 540 int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
 541 #else
 542 static inline int snd_hda_hwdep_add_sysfs(struct hda_codec *codec)
 543 {
 544         return 0;
 545 }
 546 #endif
 547
 548 #ifdef CONFIG_SND_HDA_RECONFIG
 549 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
 550 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
 551 #else
 552 static inline
 553 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
 554 {
 555         return NULL;
 556 }
 557
 558 static inline
 559 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
 560 {
 561         return -ENOENT;
 562 }
 563 #endif
 564
 565 /*
 566  * power-management
 567  */
 568
 569 void snd_hda_schedule_power_save(struct hda_codec *codec);
 570
 571 struct hda_amp_list {
 572         hda_nid_t nid;
 573         unsigned char dir;
 574         unsigned char idx;
 575 };
 576
 577 struct hda_loopback_check {
 578         const struct hda_amp_list *amplist;
 579         int power_on;
 580 };
 581
 582 int snd_hda_check_amp_list_power(struct hda_codec *codec,
 583                                  struct hda_loopback_check *check,
 584                                  hda_nid_t nid);
 585
 586 /*
 587  * AMP control callbacks
 588  */
 589 /* retrieve parameters from private_value */
 590 #define get_amp_nid_(pv)        ((pv) & 0xffff)
 591 #define get_amp_nid(kc)         get_amp_nid_((kc)->private_value)
 592 #define get_amp_channels(kc)    (((kc)->private_value >> 16) & 0x3)
 593 #define get_amp_direction_(pv)  (((pv) >> 18) & 0x1)
 594 #define get_amp_direction(kc)   get_amp_direction_((kc)->private_value)
 595 #define get_amp_index(kc)       (((kc)->private_value >> 19) & 0xf)
 596 #define get_amp_offset(kc)      (((kc)->private_value >> 23) & 0x3f)
 597 #define get_amp_min_mute(kc)    (((kc)->private_value >> 29) & 0x1)
 598
 599 /*
 600  * CEA Short Audio Descriptor data
 601  */
 602 struct cea_sad {
 603         int     channels;
 604         int     format;         /* (format == 0) indicates invalid SAD */
 605         int     rates;
 606         int     sample_bits;    /* for LPCM */
 607         int     max_bitrate;    /* for AC3...ATRAC */
 608         int     profile;        /* for WMAPRO */
 609 };
 610
 611 #define ELD_FIXED_BYTES 20
 612 #define ELD_MAX_SIZE    256
 613 #define ELD_MAX_MNL     16
 614 #define ELD_MAX_SAD     16
 615
 616 /*
 617  * ELD: EDID Like Data
 618  */
 619 struct hdmi_eld {
 620         bool    monitor_present;
 621         bool    eld_valid;
 622         int     eld_size;
 623         int     baseline_len;
 624         int     eld_ver;
 625         int     cea_edid_ver;
 626         char    monitor_name[ELD_MAX_MNL + 1];
 627         int     manufacture_id;
 628         int     product_id;
 629         u64     port_id;
 630         int     support_hdcp;
 631         int     support_ai;
 632         int     conn_type;
 633         int     aud_synch_delay;
 634         int     spk_alloc;
 635         int     sad_count;
 636         struct cea_sad sad[ELD_MAX_SAD];
 637         /*
 638          * all fields above eld_buffer will be cleared before updating ELD
 639          */
 640         char    eld_buffer[ELD_MAX_SIZE];
 641 #ifdef CONFIG_PROC_FS
 642         struct snd_info_entry *proc_entry;
 643 #endif
 644 };
 645
 646 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
 647 int snd_hdmi_get_eld(struct hdmi_eld *, struct hda_codec *, hda_nid_t);
 648 void snd_hdmi_show_eld(struct hdmi_eld *eld);
 649 void snd_hdmi_eld_update_pcm_info(struct hdmi_eld *eld,
 650                               struct hda_pcm_stream *hinfo);
 651
 652 #ifdef CONFIG_PROC_FS
 653 int snd_hda_eld_proc_new(struct hda_codec *codec, struct hdmi_eld *eld,
 654                          int index);
 655 void snd_hda_eld_proc_free(struct hda_codec *codec, struct hdmi_eld *eld);
 656 #else
 657 static inline int snd_hda_eld_proc_new(struct hda_codec *codec,
 658                                        struct hdmi_eld *eld,
 659                                        int index)
 660 {
 661         return 0;
 662 }
 663 static inline void snd_hda_eld_proc_free(struct hda_codec *codec,
 664                                          struct hdmi_eld *eld)
 665 {
 666 }
 667 #endif
 668
 669 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
 670 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
 671
 672 #endif /* __SOUND_HDA_LOCAL_H */