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