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