blob: c908afbe4d94662fcaa92cf4009efc64b2114680 [file] [log] [blame]
Takashi Iwai352f7f92012-12-19 12:52:06 +01001/*
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 */
16enum {
Takashi Iwai406b2852012-12-20 14:46:57 +010017 HDA_GEN_HP_EVENT = 1, HDA_GEN_FRONT_EVENT, HDA_GEN_MIC_EVENT,
Takashi Iwai352f7f92012-12-19 12:52:06 +010018 HDA_GEN_LAST_EVENT = HDA_GEN_MIC_EVENT
19};
20
21/* table entry for multi-io paths */
22struct 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
Takashi Iwaid94ddd82012-12-20 14:42:42 +010040#define MAX_NID_PATH_DEPTH 10
Takashi Iwai352f7f92012-12-19 12:52:06 +010041
42enum {
43 NID_PATH_VOL_CTL,
44 NID_PATH_MUTE_CTL,
45 NID_PATH_BOOST_CTL,
46 NID_PATH_NUM_CTLS
47};
48
49struct 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
62struct 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
Takashi Iwai38cf6f12012-12-21 14:09:42 +010068/* active stream id */
69enum { STREAM_MULTI_OUT, STREAM_INDEP_HP };
70
Takashi Iwaie6b85f32013-01-07 11:54:34 +010071/* PCM hook action */
72enum {
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
Takashi Iwai98bd1112013-03-22 14:53:50 +010079/* DAC assignment badness table */
80struct 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
89extern const struct badness_table hda_main_out_badness;
90extern const struct badness_table hda_extra_out_badness;
91
Takashi Iwai352f7f92012-12-19 12:52:06 +010092struct 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;
Takashi Iwaia6071482013-01-21 16:50:09 +010096
97 char stream_name_alt_analog[32]; /* alternative analog PCM stream */
Takashi Iwai352f7f92012-12-19 12:52:06 +010098 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
Takashi Iwai38cf6f12012-12-21 14:09:42 +0100105 /* PCM */
106 unsigned int active_streams;
107 struct mutex pcm_mutex;
108
Takashi Iwai352f7f92012-12-19 12:52:06 +0100109 /* 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;
Takashi Iwaicf799aa2013-01-18 16:38:08 +0100120 hda_nid_t adc_nids[AUTO_CFG_MAX_INS];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100121 hda_nid_t dig_in_nid; /* digital-in NID; optional */
122 hda_nid_t mixer_nid; /* analog-mixer NID */
Takashi Iwaie4a395e2013-01-23 17:00:31 +0100123 hda_nid_t mixer_merge_nid; /* aamix merge-point NID (optional) */
Takashi Iwaicf799aa2013-01-18 16:38:08 +0100124 const char *input_labels[HDA_MAX_NUM_INPUTS];
125 int input_label_idxs[HDA_MAX_NUM_INPUTS];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100126
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 */
Takashi Iwaia07a9492013-01-07 16:44:06 +0100137 /* 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 */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100151
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];
Takashi Iwai967303d2013-02-19 17:12:42 +0100161 /* shared hp/mic */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100162 hda_nid_t shared_mic_vref_pin;
Takashi Iwai967303d2013-02-19 17:12:42 +0100163 hda_nid_t hp_mic_pin;
164 int hp_mic_mux_idx;
Takashi Iwai352f7f92012-12-19 12:52:06 +0100165
Takashi Iwai0ffd5342013-01-17 15:53:29 +0100166 /* DAC/ADC lists */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100167 int num_all_dacs;
168 hda_nid_t all_dacs[16];
Takashi Iwai0ffd5342013-01-17 15:53:29 +0100169 int num_all_adcs;
Takashi Iwaicf799aa2013-01-18 16:38:08 +0100170 hda_nid_t all_adcs[AUTO_CFG_MAX_INS];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100171
172 /* path list */
173 struct snd_array paths;
174
Takashi Iwai196c17662013-01-04 15:01:40 +0100175 /* 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];
Takashi Iwaic30aa7b2013-01-04 16:42:48 +0100179 int aamix_out_paths[3];
Takashi Iwai196c17662013-01-04 15:01:40 +0100180 int digout_paths[AUTO_CFG_MAX_OUTS];
David Henningssond3d982f2013-01-18 15:43:01 +0100181 int input_paths[HDA_MAX_NUM_INPUTS][AUTO_CFG_MAX_INS];
Takashi Iwai196c17662013-01-04 15:01:40 +0100182 int loopback_paths[HDA_MAX_NUM_INPUTS];
Takashi Iwaie4a395e2013-01-23 17:00:31 +0100183 int loopback_merge_path;
Takashi Iwai2430d7b2013-01-04 15:09:42 +0100184 int digin_path;
Takashi Iwai196c17662013-01-04 15:01:40 +0100185
Takashi Iwai352f7f92012-12-19 12:52:06 +0100186 /* auto-mic stuff */
187 int am_num_entries;
188 struct automic_entry am_entry[MAX_AUTO_MIC_PINS];
189
190 /* for pin sensing */
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100191 /* current status; set in hda_geneic.c */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100192 unsigned int hp_jack_present:1;
193 unsigned int line_jack_present:1;
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100194 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 */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100198 unsigned int auto_mic:1;
199 unsigned int automute_speaker:1; /* automute speaker outputs */
200 unsigned int automute_lo:1; /* automute LO outputs */
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100201
202 /* capabilities detected by parser */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100203 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 */
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100207
208 /* additional parameters set by codec drivers */
209 unsigned int master_mute:1; /* master mute over all */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100210 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 */
Takashi Iwai7eebffd2013-06-24 16:00:21 +0200212 unsigned int auto_mute_via_amp:1; /* auto-mute via amp instead of pinctl */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100213
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100214 /* parser behavior flags; set before snd_hda_gen_parse_auto_config() */
215 unsigned int suppress_auto_mute:1; /* suppress input jack auto mute */
216 unsigned int suppress_auto_mic:1; /* suppress input jack auto switch */
217
218 /* other parse behavior flags */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100219 unsigned int need_dac_fix:1; /* need to limit DACs for multi channels */
Takashi Iwai967303d2013-02-19 17:12:42 +0100220 unsigned int hp_mic:1; /* Allow HP as a mic-in */
221 unsigned int suppress_hp_mic_detect:1; /* Don't detect HP/mic */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100222 unsigned int no_primary_hp:1; /* Don't prefer HP pins to speaker pins */
Takashi Iwaida96fb52013-07-29 16:54:36 +0200223 unsigned int no_multi_io:1; /* Don't try multi I/O config */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100224 unsigned int multi_cap_vol:1; /* allow multiple capture xxx volumes */
225 unsigned int inv_dmic_split:1; /* inverted dmic w/a for conexant */
Takashi Iwai731dc302012-12-19 13:01:54 +0100226 unsigned int own_eapd_ctl:1; /* set EAPD by own function */
Takashi Iwai05909d5c2013-05-31 19:55:54 +0200227 unsigned int keep_eapd_on:1; /* don't turn off EAPD automatically */
Takashi Iwaifd25a972012-12-20 14:57:18 +0100228 unsigned int vmaster_mute_enum:1; /* add vmaster mute mode enum */
Takashi Iwai38cf6f12012-12-21 14:09:42 +0100229 unsigned int indep_hp:1; /* independent HP supported */
Takashi Iwaiea46c3c2013-01-15 18:45:53 +0100230 unsigned int prefer_hp_amp:1; /* enable HP amp for speaker if any */
Takashi Iwaif3fc0b02013-01-09 09:14:23 +0100231 unsigned int add_stereo_mix_input:1; /* add aamix as a capture src */
Takashi Iwaif811c3c2013-03-07 18:32:59 +0100232 unsigned int add_jack_modes:1; /* add i/o jack mode enum ctls */
Takashi Iwai55196ff2013-01-24 17:32:56 +0100233 unsigned int power_down_unused:1; /* power down unused widgets */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100234
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100235 /* other internal flags */
236 unsigned int no_analog:1; /* digital I/O only */
237 unsigned int dyn_adc_switch:1; /* switch ADCs (for ALC275) */
238 unsigned int indep_hp_enabled:1; /* independent HP enabled */
Takashi Iwaia1e908e2013-01-21 15:11:25 +0100239 unsigned int have_aamix_ctl:1;
Takashi Iwai8ba955c2013-03-07 18:40:58 +0100240 unsigned int hp_mic_jack_modes:1;
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100241
Takashi Iwai7eebffd2013-06-24 16:00:21 +0200242 /* additional mute flags (only effective with auto_mute_via_amp=1) */
243 u64 mute_bits;
244
Takashi Iwaia1114a82013-11-04 16:32:01 +0100245 /* bitmask for skipping volume controls */
246 u64 out_vol_mask;
247
Takashi Iwai98bd1112013-03-22 14:53:50 +0100248 /* badness tables for output path evaluations */
249 const struct badness_table *main_out_badness;
250 const struct badness_table *extra_out_badness;
251
Takashi Iwai36907392013-12-10 17:29:26 +0100252 /* preferred pin/DAC pairs; an array of paired NIDs */
253 const hda_nid_t *preferred_dacs;
254
Takashi Iwaic30aa7b2013-01-04 16:42:48 +0100255 /* loopback mixing mode */
256 bool aamix_mode;
257
Takashi Iwai7504b6c2013-03-18 11:25:51 +0100258 /* digital beep */
259 hda_nid_t beep_nid;
260
Takashi Iwai352f7f92012-12-19 12:52:06 +0100261 /* for virtual master */
262 hda_nid_t vmaster_nid;
Takashi Iwai7a71bbf2013-01-17 10:25:15 +0100263 unsigned int vmaster_tlv[4];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100264 struct hda_vmaster_mute_hook vmaster_mute;
Takashi Iwai46a14482013-02-07 09:58:11 +0100265
Takashi Iwai352f7f92012-12-19 12:52:06 +0100266 struct hda_loopback_check loopback;
Takashi Iwai0186f4f2013-02-07 10:45:11 +0100267 struct snd_array loopback_list;
Takashi Iwai352f7f92012-12-19 12:52:06 +0100268
269 /* multi-io */
270 int multi_ios;
271 struct hda_multi_io multi_io[4];
272
Takashi Iwai352f7f92012-12-19 12:52:06 +0100273 /* hooks */
274 void (*init_hook)(struct hda_codec *codec);
275 void (*automute_hook)(struct hda_codec *codec);
Takashi Iwaia90229e2013-01-18 14:10:00 +0100276 void (*cap_sync_hook)(struct hda_codec *codec,
Takashi Iwai7fe30712014-01-30 17:59:02 +0100277 struct snd_kcontrol *kcontrol,
Takashi Iwaia90229e2013-01-18 14:10:00 +0100278 struct snd_ctl_elem_value *ucontrol);
Takashi Iwai2e03e952013-01-03 15:55:06 +0100279
Takashi Iwaiac2e8732013-01-17 15:57:10 +0100280 /* PCM hooks */
Takashi Iwaie6b85f32013-01-07 11:54:34 +0100281 void (*pcm_playback_hook)(struct hda_pcm_stream *hinfo,
282 struct hda_codec *codec,
283 struct snd_pcm_substream *substream,
284 int action);
Takashi Iwaiac2e8732013-01-17 15:57:10 +0100285 void (*pcm_capture_hook)(struct hda_pcm_stream *hinfo,
286 struct hda_codec *codec,
287 struct snd_pcm_substream *substream,
288 int action);
Takashi Iwaie6b85f32013-01-07 11:54:34 +0100289
Takashi Iwai2e03e952013-01-03 15:55:06 +0100290 /* automute / autoswitch hooks */
291 void (*hp_automute_hook)(struct hda_codec *codec,
292 struct hda_jack_tbl *tbl);
293 void (*line_automute_hook)(struct hda_codec *codec,
294 struct hda_jack_tbl *tbl);
295 void (*mic_autoswitch_hook)(struct hda_codec *codec,
296 struct hda_jack_tbl *tbl);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100297};
298
299int snd_hda_gen_spec_init(struct hda_gen_spec *spec);
300void snd_hda_gen_spec_free(struct hda_gen_spec *spec);
301
302int snd_hda_gen_init(struct hda_codec *codec);
Takashi Iwaifce52a32013-01-07 12:42:48 +0100303void snd_hda_gen_free(struct hda_codec *codec);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100304
305struct nid_path *snd_hda_get_nid_path(struct hda_codec *codec,
306 hda_nid_t from_nid, hda_nid_t to_nid);
Takashi Iwai196c17662013-01-04 15:01:40 +0100307int snd_hda_get_path_idx(struct hda_codec *codec, struct nid_path *path);
308struct nid_path *snd_hda_get_path_from_idx(struct hda_codec *codec, int idx);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100309bool snd_hda_parse_nid_path(struct hda_codec *codec, hda_nid_t from_nid,
Takashi Iwai3ca529d2013-01-07 17:25:08 +0100310 hda_nid_t to_nid, int anchor_nid,
Takashi Iwai352f7f92012-12-19 12:52:06 +0100311 struct nid_path *path);
312struct nid_path *
313snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid,
Takashi Iwai3ca529d2013-01-07 17:25:08 +0100314 hda_nid_t to_nid, int anchor_nid);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100315void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path,
316 bool enable, bool add_aamix);
317
Takashi Iwai12c93df2012-12-19 14:38:33 +0100318struct snd_kcontrol_new *
319snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name,
320 const struct snd_kcontrol_new *temp);
321
Takashi Iwai352f7f92012-12-19 12:52:06 +0100322int snd_hda_gen_parse_auto_config(struct hda_codec *codec,
Takashi Iwai9eb413e2012-12-19 14:41:21 +0100323 struct auto_pin_cfg *cfg);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100324int snd_hda_gen_build_controls(struct hda_codec *codec);
325int snd_hda_gen_build_pcms(struct hda_codec *codec);
326
Takashi Iwai5d550e12012-12-19 15:16:44 +0100327/* standard jack event callbacks */
328void snd_hda_gen_hp_automute(struct hda_codec *codec,
329 struct hda_jack_tbl *jack);
330void snd_hda_gen_line_automute(struct hda_codec *codec,
331 struct hda_jack_tbl *jack);
332void snd_hda_gen_mic_autoswitch(struct hda_codec *codec,
333 struct hda_jack_tbl *jack);
334void snd_hda_gen_update_outputs(struct hda_codec *codec);
335
Takashi Iwaifce52a32013-01-07 12:42:48 +0100336#ifdef CONFIG_PM
337int snd_hda_gen_check_power_status(struct hda_codec *codec, hda_nid_t nid);
338#endif
Takashi Iwaidfc6e462014-01-13 16:09:57 +0100339unsigned int snd_hda_gen_path_power_filter(struct hda_codec *codec,
340 hda_nid_t nid,
341 unsigned int power_state);
Takashi Iwaifce52a32013-01-07 12:42:48 +0100342
Takashi Iwai352f7f92012-12-19 12:52:06 +0100343#endif /* __SOUND_HDA_GENERIC_H */