sound/pci/hda/hda_generic.h

   1 /*
   2  * Generic BIOS auto-parser helper functions for HD-audio
   3  *
   4  * Copyright (c) 2012 Takashi Iwai <tiwai@suse.de>
   5  *
   6  * This driver is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  */
  11
  12 #ifndef __SOUND_HDA_GENERIC_H
  13 #define __SOUND_HDA_GENERIC_H
  14
  15 /* table entry for multi-io paths */
  16 struct hda_multi_io {
  17         hda_nid_t pin;          /* multi-io widget pin NID */
  18         hda_nid_t dac;          /* DAC to be connected */
  19         unsigned int ctl_in;    /* cached input-pin control value */
  20 };
  21
  22 /* Widget connection path
  23  *
  24  * For output, stored in the order of DAC -> ... -> pin,
  25  * for input, pin -> ... -> ADC.
  26  *
  27  * idx[i] contains the source index number to select on of the widget path[i];
  28  * e.g. idx[1] is the index of the DAC (path[0]) selected by path[1] widget
  29  * multi[] indicates whether it's a selector widget with multi-connectors
  30  * (i.e. the connection selection is mandatory)
  31  * vol_ctl and mute_ctl contains the NIDs for the assigned mixers
  32  */
  33
  34 #define MAX_NID_PATH_DEPTH      10
  35
  36 enum {
  37         NID_PATH_VOL_CTL,
  38         NID_PATH_MUTE_CTL,
  39         NID_PATH_BOOST_CTL,
  40         NID_PATH_NUM_CTLS
  41 };
  42
  43 struct nid_path {
  44         int depth;
  45         hda_nid_t path[MAX_NID_PATH_DEPTH];
  46         unsigned char idx[MAX_NID_PATH_DEPTH];
  47         unsigned char multi[MAX_NID_PATH_DEPTH];
  48         unsigned int ctls[NID_PATH_NUM_CTLS]; /* NID_PATH_XXX_CTL */
  49         bool active:1;          /* activated by driver */
  50         bool pin_enabled:1;     /* pins are enabled */
  51         bool pin_fixed:1;       /* path with fixed pin */
  52         bool stream_enabled:1;  /* stream is active */
  53 };
  54
  55 /* mic/line-in auto switching entry */
  56
  57 #define MAX_AUTO_MIC_PINS       3
  58
  59 struct automic_entry {
  60         hda_nid_t pin;          /* pin */
  61         int idx;                /* imux index, -1 = invalid */
  62         unsigned int attr;      /* pin attribute (INPUT_PIN_ATTR_*) */
  63 };
  64
  65 /* active stream id */
  66 enum { STREAM_MULTI_OUT, STREAM_INDEP_HP };
  67
  68 /* PCM hook action */
  69 enum {
  70         HDA_GEN_PCM_ACT_OPEN,
  71         HDA_GEN_PCM_ACT_PREPARE,
  72         HDA_GEN_PCM_ACT_CLEANUP,
  73         HDA_GEN_PCM_ACT_CLOSE,
  74 };
  75
  76 /* DAC assignment badness table */
  77 struct badness_table {
  78         int no_primary_dac;     /* no primary DAC */
  79         int no_dac;             /* no secondary DACs */
  80         int shared_primary;     /* primary DAC is shared with main output */
  81         int shared_surr;        /* secondary DAC shared with main or primary */
  82         int shared_clfe;        /* third DAC shared with main or primary */
  83         int shared_surr_main;   /* secondary DAC sahred with main/DAC0 */
  84 };
  85
  86 extern const struct badness_table hda_main_out_badness;
  87 extern const struct badness_table hda_extra_out_badness;
  88
  89 struct hda_micmute_hook {
  90         unsigned int led_mode;
  91         unsigned int capture;
  92         unsigned int led_value;
  93         void (*update)(struct hda_codec *codec);
  94         void (*old_hook)(struct hda_codec *codec,
  95                          struct snd_kcontrol *kcontrol,
  96                          struct snd_ctl_elem_value *ucontrol);
  97 };
  98
  99 struct hda_gen_spec {
 100         char stream_name_analog[32];    /* analog PCM stream */
 101         const struct hda_pcm_stream *stream_analog_playback;
 102         const struct hda_pcm_stream *stream_analog_capture;
 103
 104         char stream_name_alt_analog[32]; /* alternative analog PCM stream */
 105         const struct hda_pcm_stream *stream_analog_alt_playback;
 106         const struct hda_pcm_stream *stream_analog_alt_capture;
 107
 108         char stream_name_digital[32];   /* digital PCM stream */
 109         const struct hda_pcm_stream *stream_digital_playback;
 110         const struct hda_pcm_stream *stream_digital_capture;
 111
 112         /* PCM */
 113         unsigned int active_streams;
 114         struct mutex pcm_mutex;
 115
 116         /* playback */
 117         struct hda_multi_out multiout;  /* playback set-up
 118                                          * max_channels, dacs must be set
 119                                          * dig_out_nid and hp_nid are optional
 120                                          */
 121         hda_nid_t alt_dac_nid;
 122         hda_nid_t slave_dig_outs[3];    /* optional - for auto-parsing */
 123         int dig_out_type;
 124
 125         /* capture */
 126         unsigned int num_adc_nids;
 127         hda_nid_t adc_nids[AUTO_CFG_MAX_INS];
 128         hda_nid_t dig_in_nid;           /* digital-in NID; optional */
 129         hda_nid_t mixer_nid;            /* analog-mixer NID */
 130         hda_nid_t mixer_merge_nid;      /* aamix merge-point NID (optional) */
 131         const char *input_labels[HDA_MAX_NUM_INPUTS];
 132         int input_label_idxs[HDA_MAX_NUM_INPUTS];
 133
 134         /* capture setup for dynamic dual-adc switch */
 135         hda_nid_t cur_adc;
 136         unsigned int cur_adc_stream_tag;
 137         unsigned int cur_adc_format;
 138
 139         /* capture source */
 140         struct hda_input_mux input_mux;
 141         unsigned int cur_mux[3];
 142
 143         /* channel model */
 144         /* min_channel_count contains the minimum channel count for primary
 145          * outputs.  When multi_ios is set, the channels can be configured
 146          * between min_channel_count and (min_channel_count + multi_ios * 2).
 147          *
 148          * ext_channel_count contains the current channel count of the primary
 149          * out.  This varies in the range above.
 150          *
 151          * Meanwhile, const_channel_count is the channel count for all outputs
 152          * including headphone and speakers.  It's a constant value, and the
 153          * PCM is set up as max(ext_channel_count, const_channel_count).
 154          */
 155         int min_channel_count;          /* min. channel count for primary out */
 156         int ext_channel_count;          /* current channel count for primary */
 157         int const_channel_count;        /* channel count for all */
 158
 159         /* PCM information */
 160         struct hda_pcm *pcm_rec[3];     /* used in build_pcms() */
 161
 162         /* dynamic controls, init_verbs and input_mux */
 163         struct auto_pin_cfg autocfg;
 164         struct snd_array kctls;
 165         hda_nid_t private_dac_nids[AUTO_CFG_MAX_OUTS];
 166         hda_nid_t imux_pins[HDA_MAX_NUM_INPUTS];
 167         unsigned int dyn_adc_idx[HDA_MAX_NUM_INPUTS];
 168         /* shared hp/mic */
 169         hda_nid_t shared_mic_vref_pin;
 170         hda_nid_t hp_mic_pin;
 171         int hp_mic_mux_idx;
 172
 173         /* DAC/ADC lists */
 174         int num_all_dacs;
 175         hda_nid_t all_dacs[16];
 176         int num_all_adcs;
 177         hda_nid_t all_adcs[AUTO_CFG_MAX_INS];
 178
 179         /* path list */
 180         struct snd_array paths;
 181
 182         /* path indices */
 183         int out_paths[AUTO_CFG_MAX_OUTS];
 184         int hp_paths[AUTO_CFG_MAX_OUTS];
 185         int speaker_paths[AUTO_CFG_MAX_OUTS];
 186         int aamix_out_paths[3];
 187         int digout_paths[AUTO_CFG_MAX_OUTS];
 188         int input_paths[HDA_MAX_NUM_INPUTS][AUTO_CFG_MAX_INS];
 189         int loopback_paths[HDA_MAX_NUM_INPUTS];
 190         int loopback_merge_path;
 191         int digin_path;
 192
 193         /* auto-mic stuff */
 194         int am_num_entries;
 195         struct automic_entry am_entry[MAX_AUTO_MIC_PINS];
 196
 197         /* for pin sensing */
 198         /* current status; set in hda_geneic.c */
 199         unsigned int hp_jack_present:1;
 200         unsigned int line_jack_present:1;
 201         unsigned int speaker_muted:1; /* current status of speaker mute */
 202         unsigned int line_out_muted:1; /* current status of LO mute */
 203
 204         /* internal states of automute / autoswitch behavior */
 205         unsigned int auto_mic:1;
 206         unsigned int automute_speaker:1; /* automute speaker outputs */
 207         unsigned int automute_lo:1; /* automute LO outputs */
 208
 209         /* capabilities detected by parser */
 210         unsigned int detect_hp:1;       /* Headphone detection enabled */
 211         unsigned int detect_lo:1;       /* Line-out detection enabled */
 212         unsigned int automute_speaker_possible:1; /* there are speakers and either LO or HP */
 213         unsigned int automute_lo_possible:1;      /* there are line outs and HP */
 214
 215         /* additional parameters set by codec drivers */
 216         unsigned int master_mute:1;     /* master mute over all */
 217         unsigned int keep_vref_in_automute:1; /* Don't clear VREF in automute */
 218         unsigned int line_in_auto_switch:1; /* allow line-in auto switch */
 219         unsigned int auto_mute_via_amp:1; /* auto-mute via amp instead of pinctl */
 220
 221         /* parser behavior flags; set before snd_hda_gen_parse_auto_config() */
 222         unsigned int suppress_auto_mute:1; /* suppress input jack auto mute */
 223         unsigned int suppress_auto_mic:1; /* suppress input jack auto switch */
 224
 225         /* other parse behavior flags */
 226         unsigned int need_dac_fix:1; /* need to limit DACs for multi channels */
 227         unsigned int hp_mic:1; /* Allow HP as a mic-in */
 228         unsigned int suppress_hp_mic_detect:1; /* Don't detect HP/mic */
 229         unsigned int no_primary_hp:1; /* Don't prefer HP pins to speaker pins */
 230         unsigned int no_multi_io:1; /* Don't try multi I/O config */
 231         unsigned int multi_cap_vol:1; /* allow multiple capture xxx volumes */
 232         unsigned int inv_dmic_split:1; /* inverted dmic w/a for conexant */
 233         unsigned int own_eapd_ctl:1; /* set EAPD by own function */
 234         unsigned int keep_eapd_on:1; /* don't turn off EAPD automatically */
 235         unsigned int vmaster_mute_enum:1; /* add vmaster mute mode enum */
 236         unsigned int indep_hp:1; /* independent HP supported */
 237         unsigned int prefer_hp_amp:1; /* enable HP amp for speaker if any */
 238         unsigned int add_stereo_mix_input:2; /* add aamix as a capture src */
 239         unsigned int add_jack_modes:1; /* add i/o jack mode enum ctls */
 240         unsigned int power_down_unused:1; /* power down unused widgets */
 241         unsigned int dac_min_mute:1; /* minimal = mute for DACs */
 242         unsigned int suppress_vmaster:1; /* don't create vmaster kctls */
 243
 244         /* other internal flags */
 245         unsigned int no_analog:1; /* digital I/O only */
 246         unsigned int dyn_adc_switch:1; /* switch ADCs (for ALC275) */
 247         unsigned int indep_hp_enabled:1; /* independent HP enabled */
 248         unsigned int have_aamix_ctl:1;
 249         unsigned int hp_mic_jack_modes:1;
 250         unsigned int skip_verbs:1; /* don't apply verbs at snd_hda_gen_init() */
 251
 252         /* additional mute flags (only effective with auto_mute_via_amp=1) */
 253         u64 mute_bits;
 254
 255         /* bitmask for skipping volume controls */
 256         u64 out_vol_mask;
 257
 258         /* badness tables for output path evaluations */
 259         const struct badness_table *main_out_badness;
 260         const struct badness_table *extra_out_badness;
 261
 262         /* preferred pin/DAC pairs; an array of paired NIDs */
 263         const hda_nid_t *preferred_dacs;
 264
 265         /* loopback mixing mode */
 266         bool aamix_mode;
 267
 268         /* digital beep */
 269         hda_nid_t beep_nid;
 270
 271         /* for virtual master */
 272         hda_nid_t vmaster_nid;
 273         unsigned int vmaster_tlv[4];
 274         struct hda_vmaster_mute_hook vmaster_mute;
 275
 276         struct hda_loopback_check loopback;
 277         struct snd_array loopback_list;
 278
 279         /* multi-io */
 280         int multi_ios;
 281         struct hda_multi_io multi_io[4];
 282
 283         /* hooks */
 284         void (*init_hook)(struct hda_codec *codec);
 285         void (*automute_hook)(struct hda_codec *codec);
 286         void (*cap_sync_hook)(struct hda_codec *codec,
 287                               struct snd_kcontrol *kcontrol,
 288                               struct snd_ctl_elem_value *ucontrol);
 289
 290         /* mic mute LED hook; called via cap_sync_hook */
 291         struct hda_micmute_hook micmute_led;
 292
 293         /* PCM hooks */
 294         void (*pcm_playback_hook)(struct hda_pcm_stream *hinfo,
 295                                   struct hda_codec *codec,
 296                                   struct snd_pcm_substream *substream,
 297                                   int action);
 298         void (*pcm_capture_hook)(struct hda_pcm_stream *hinfo,
 299                                  struct hda_codec *codec,
 300                                  struct snd_pcm_substream *substream,
 301                                  int action);
 302
 303         /* automute / autoswitch hooks */
 304         void (*hp_automute_hook)(struct hda_codec *codec,
 305                                  struct hda_jack_callback *cb);
 306         void (*line_automute_hook)(struct hda_codec *codec,
 307                                    struct hda_jack_callback *cb);
 308         void (*mic_autoswitch_hook)(struct hda_codec *codec,
 309                                     struct hda_jack_callback *cb);
 310 };
 311
 312 /* values for add_stereo_mix_input flag */
 313 enum {
 314         HDA_HINT_STEREO_MIX_DISABLE,    /* No stereo mix input */
 315         HDA_HINT_STEREO_MIX_ENABLE,     /* Add stereo mix input */
 316         HDA_HINT_STEREO_MIX_AUTO,       /* Add only if auto-mic is disabled */
 317 };
 318
 319 int snd_hda_gen_spec_init(struct hda_gen_spec *spec);
 320
 321 int snd_hda_gen_init(struct hda_codec *codec);
 322 void snd_hda_gen_free(struct hda_codec *codec);
 323
 324 int snd_hda_get_path_idx(struct hda_codec *codec, struct nid_path *path);
 325 struct nid_path *snd_hda_get_path_from_idx(struct hda_codec *codec, int idx);
 326 struct nid_path *
 327 snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid,
 328                      hda_nid_t to_nid, int anchor_nid);
 329 void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path,
 330                            bool enable, bool add_aamix);
 331
 332 struct snd_kcontrol_new *
 333 snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name,
 334                      const struct snd_kcontrol_new *temp);
 335
 336 int snd_hda_gen_parse_auto_config(struct hda_codec *codec,
 337                                   struct auto_pin_cfg *cfg);
 338 int snd_hda_gen_build_controls(struct hda_codec *codec);
 339 int snd_hda_gen_build_pcms(struct hda_codec *codec);
 340 void snd_hda_gen_reboot_notify(struct hda_codec *codec);
 341
 342 /* standard jack event callbacks */
 343 void snd_hda_gen_hp_automute(struct hda_codec *codec,
 344                              struct hda_jack_callback *jack);
 345 void snd_hda_gen_line_automute(struct hda_codec *codec,
 346                                struct hda_jack_callback *jack);
 347 void snd_hda_gen_mic_autoswitch(struct hda_codec *codec,
 348                                 struct hda_jack_callback *jack);
 349 void snd_hda_gen_update_outputs(struct hda_codec *codec);
 350
 351 #ifdef CONFIG_PM
 352 int snd_hda_gen_check_power_status(struct hda_codec *codec, hda_nid_t nid);
 353 #endif
 354 unsigned int snd_hda_gen_path_power_filter(struct hda_codec *codec,
 355                                            hda_nid_t nid,
 356                                            unsigned int power_state);
 357 void snd_hda_gen_stream_pm(struct hda_codec *codec, hda_nid_t nid, bool on);
 358 int snd_hda_gen_fix_pin_power(struct hda_codec *codec, hda_nid_t pin);
 359
 360 int snd_hda_gen_add_micmute_led(struct hda_codec *codec,
 361                                 void (*hook)(struct hda_codec *));
 362
 363 #endif /* __SOUND_HDA_GENERIC_H */