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 /* unsol event tags */
17 HDA_GEN_HP_EVENT = 1, HDA_GEN_FRONT_EVENT, HDA_GEN_MIC_EVENT,
18 HDA_GEN_LAST_EVENT = HDA_GEN_MIC_EVENT
21 /* table entry for multi-io paths */
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 */
28 /* Widget connection path
30 * For output, stored in the order of DAC -> ... -> pin,
31 * for input, pin -> ... -> ADC.
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
40 #define MAX_NID_PATH_DEPTH 10
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 */
58 /* mic/line-in auto switching entry */
60 #define MAX_AUTO_MIC_PINS 3
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_*) */
68 /* active stream id */
69 enum { STREAM_MULTI_OUT, STREAM_INDEP_HP };
74 HDA_GEN_PCM_ACT_PREPARE,
75 HDA_GEN_PCM_ACT_CLEANUP,
76 HDA_GEN_PCM_ACT_CLOSE,
80 char stream_name_analog[32]; /* analog PCM stream */
81 const struct hda_pcm_stream *stream_analog_playback;
82 const struct hda_pcm_stream *stream_analog_capture;
84 char stream_name_alt_analog[32]; /* alternative analog PCM stream */
85 const struct hda_pcm_stream *stream_analog_alt_playback;
86 const struct hda_pcm_stream *stream_analog_alt_capture;
88 char stream_name_digital[32]; /* digital PCM stream */
89 const struct hda_pcm_stream *stream_digital_playback;
90 const struct hda_pcm_stream *stream_digital_capture;
93 unsigned int active_streams;
94 struct mutex pcm_mutex;
97 struct hda_multi_out multiout; /* playback set-up
98 * max_channels, dacs must be set
99 * dig_out_nid and hp_nid are optional
101 hda_nid_t alt_dac_nid;
102 hda_nid_t slave_dig_outs[3]; /* optional - for auto-parsing */
106 unsigned int num_adc_nids;
107 hda_nid_t adc_nids[AUTO_CFG_MAX_INS];
108 hda_nid_t dig_in_nid; /* digital-in NID; optional */
109 hda_nid_t mixer_nid; /* analog-mixer NID */
110 hda_nid_t mixer_merge_nid; /* aamix merge-point NID (optional) */
111 const char *input_labels[HDA_MAX_NUM_INPUTS];
112 int input_label_idxs[HDA_MAX_NUM_INPUTS];
114 /* capture setup for dynamic dual-adc switch */
116 unsigned int cur_adc_stream_tag;
117 unsigned int cur_adc_format;
120 struct hda_input_mux input_mux;
121 unsigned int cur_mux[3];
124 /* min_channel_count contains the minimum channel count for primary
125 * outputs. When multi_ios is set, the channels can be configured
126 * between min_channel_count and (min_channel_count + multi_ios * 2).
128 * ext_channel_count contains the current channel count of the primary
129 * out. This varies in the range above.
131 * Meanwhile, const_channel_count is the channel count for all outputs
132 * including headphone and speakers. It's a constant value, and the
133 * PCM is set up as max(ext_channel_count, const_channel_count).
135 int min_channel_count; /* min. channel count for primary out */
136 int ext_channel_count; /* current channel count for primary */
137 int const_channel_count; /* channel count for all */
139 /* PCM information */
140 struct hda_pcm pcm_rec[3]; /* used in build_pcms() */
142 /* dynamic controls, init_verbs and input_mux */
143 struct auto_pin_cfg autocfg;
144 struct snd_array kctls;
145 hda_nid_t private_dac_nids[AUTO_CFG_MAX_OUTS];
146 hda_nid_t imux_pins[HDA_MAX_NUM_INPUTS];
147 unsigned int dyn_adc_idx[HDA_MAX_NUM_INPUTS];
148 hda_nid_t shared_mic_vref_pin;
152 hda_nid_t all_dacs[16];
154 hda_nid_t all_adcs[AUTO_CFG_MAX_INS];
157 struct snd_array paths;
160 int out_paths[AUTO_CFG_MAX_OUTS];
161 int hp_paths[AUTO_CFG_MAX_OUTS];
162 int speaker_paths[AUTO_CFG_MAX_OUTS];
163 int aamix_out_paths[3];
164 int digout_paths[AUTO_CFG_MAX_OUTS];
165 int input_paths[HDA_MAX_NUM_INPUTS][AUTO_CFG_MAX_INS];
166 int loopback_paths[HDA_MAX_NUM_INPUTS];
167 int loopback_merge_path;
172 struct automic_entry am_entry[MAX_AUTO_MIC_PINS];
174 /* for pin sensing */
175 /* current status; set in hda_geneic.c */
176 unsigned int hp_jack_present:1;
177 unsigned int line_jack_present:1;
178 unsigned int speaker_muted:1; /* current status of speaker mute */
179 unsigned int line_out_muted:1; /* current status of LO mute */
181 /* internal states of automute / autoswitch behavior */
182 unsigned int auto_mic:1;
183 unsigned int automute_speaker:1; /* automute speaker outputs */
184 unsigned int automute_lo:1; /* automute LO outputs */
186 /* capabilities detected by parser */
187 unsigned int detect_hp:1; /* Headphone detection enabled */
188 unsigned int detect_lo:1; /* Line-out detection enabled */
189 unsigned int automute_speaker_possible:1; /* there are speakers and either LO or HP */
190 unsigned int automute_lo_possible:1; /* there are line outs and HP */
192 /* additional parameters set by codec drivers */
193 unsigned int master_mute:1; /* master mute over all */
194 unsigned int keep_vref_in_automute:1; /* Don't clear VREF in automute */
195 unsigned int line_in_auto_switch:1; /* allow line-in auto switch */
197 /* parser behavior flags; set before snd_hda_gen_parse_auto_config() */
198 unsigned int suppress_auto_mute:1; /* suppress input jack auto mute */
199 unsigned int suppress_auto_mic:1; /* suppress input jack auto switch */
201 /* other parse behavior flags */
202 unsigned int need_dac_fix:1; /* need to limit DACs for multi channels */
203 unsigned int shared_mic_hp:1; /* HP/Mic-in sharing */
204 unsigned int no_primary_hp:1; /* Don't prefer HP pins to speaker pins */
205 unsigned int multi_cap_vol:1; /* allow multiple capture xxx volumes */
206 unsigned int inv_dmic_split:1; /* inverted dmic w/a for conexant */
207 unsigned int own_eapd_ctl:1; /* set EAPD by own function */
208 unsigned int vmaster_mute_enum:1; /* add vmaster mute mode enum */
209 unsigned int indep_hp:1; /* independent HP supported */
210 unsigned int prefer_hp_amp:1; /* enable HP amp for speaker if any */
211 unsigned int add_stereo_mix_input:1; /* add aamix as a capture src */
212 unsigned int add_out_jack_modes:1; /* add output jack mode enum ctls */
213 unsigned int add_in_jack_modes:1; /* add input jack mode enum ctls */
214 unsigned int power_down_unused:1; /* power down unused widgets */
216 /* other internal flags */
217 unsigned int no_analog:1; /* digital I/O only */
218 unsigned int dyn_adc_switch:1; /* switch ADCs (for ALC275) */
219 unsigned int indep_hp_enabled:1; /* independent HP enabled */
220 unsigned int have_aamix_ctl:1;
222 /* loopback mixing mode */
225 /* for virtual master */
226 hda_nid_t vmaster_nid;
227 unsigned int vmaster_tlv[4];
228 struct hda_vmaster_mute_hook vmaster_mute;
230 struct hda_loopback_check loopback;
232 struct hda_amp_list loopback_list[8];
236 struct hda_multi_io multi_io[4];
239 void (*init_hook)(struct hda_codec *codec);
240 void (*automute_hook)(struct hda_codec *codec);
241 void (*cap_sync_hook)(struct hda_codec *codec,
242 struct snd_ctl_elem_value *ucontrol);
245 void (*pcm_playback_hook)(struct hda_pcm_stream *hinfo,
246 struct hda_codec *codec,
247 struct snd_pcm_substream *substream,
249 void (*pcm_capture_hook)(struct hda_pcm_stream *hinfo,
250 struct hda_codec *codec,
251 struct snd_pcm_substream *substream,
254 /* automute / autoswitch hooks */
255 void (*hp_automute_hook)(struct hda_codec *codec,
256 struct hda_jack_tbl *tbl);
257 void (*line_automute_hook)(struct hda_codec *codec,
258 struct hda_jack_tbl *tbl);
259 void (*mic_autoswitch_hook)(struct hda_codec *codec,
260 struct hda_jack_tbl *tbl);
263 int snd_hda_gen_spec_init(struct hda_gen_spec *spec);
264 void snd_hda_gen_spec_free(struct hda_gen_spec *spec);
266 int snd_hda_gen_init(struct hda_codec *codec);
267 void snd_hda_gen_free(struct hda_codec *codec);
269 struct nid_path *snd_hda_get_nid_path(struct hda_codec *codec,
270 hda_nid_t from_nid, hda_nid_t to_nid);
271 int snd_hda_get_path_idx(struct hda_codec *codec, struct nid_path *path);
272 struct nid_path *snd_hda_get_path_from_idx(struct hda_codec *codec, int idx);
273 bool snd_hda_parse_nid_path(struct hda_codec *codec, hda_nid_t from_nid,
274 hda_nid_t to_nid, int anchor_nid,
275 struct nid_path *path);
277 snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid,
278 hda_nid_t to_nid, int anchor_nid);
279 void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path,
280 bool enable, bool add_aamix);
282 struct snd_kcontrol_new *
283 snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name,
284 const struct snd_kcontrol_new *temp);
286 int snd_hda_gen_parse_auto_config(struct hda_codec *codec,
287 struct auto_pin_cfg *cfg);
288 int snd_hda_gen_build_controls(struct hda_codec *codec);
289 int snd_hda_gen_build_pcms(struct hda_codec *codec);
291 /* standard jack event callbacks */
292 void snd_hda_gen_hp_automute(struct hda_codec *codec,
293 struct hda_jack_tbl *jack);
294 void snd_hda_gen_line_automute(struct hda_codec *codec,
295 struct hda_jack_tbl *jack);
296 void snd_hda_gen_mic_autoswitch(struct hda_codec *codec,
297 struct hda_jack_tbl *jack);
298 void snd_hda_gen_update_outputs(struct hda_codec *codec);
301 int snd_hda_gen_check_power_status(struct hda_codec *codec, hda_nid_t nid);
304 #endif /* __SOUND_HDA_GENERIC_H */