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