LXR linux/sound/pci/hda/hda

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