blob: 3d852660443aafedf7450b39692b70aa1d59921a [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
Takashi Iwai352f7f92012-12-19 12:52:06 +010015/* table entry for multi-io paths */
16struct 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
Takashi Iwaid94ddd82012-12-20 14:42:42 +010034#define MAX_NID_PATH_DEPTH 10
Takashi Iwai352f7f92012-12-19 12:52:06 +010035
36enum {
37 NID_PATH_VOL_CTL,
38 NID_PATH_MUTE_CTL,
39 NID_PATH_BOOST_CTL,
40 NID_PATH_NUM_CTLS
41};
42
43struct 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
56struct 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
Takashi Iwai38cf6f12012-12-21 14:09:42 +010062/* active stream id */
63enum { STREAM_MULTI_OUT, STREAM_INDEP_HP };
64
Takashi Iwaie6b85f32013-01-07 11:54:34 +010065/* PCM hook action */
66enum {
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
Takashi Iwai98bd1112013-03-22 14:53:50 +010073/* DAC assignment badness table */
74struct 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
83extern const struct badness_table hda_main_out_badness;
84extern const struct badness_table hda_extra_out_badness;
85
Takashi Iwai352f7f92012-12-19 12:52:06 +010086struct 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;
Takashi Iwaia6071482013-01-21 16:50:09 +010090
91 char stream_name_alt_analog[32]; /* alternative analog PCM stream */
Takashi Iwai352f7f92012-12-19 12:52:06 +010092 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
Takashi Iwai38cf6f12012-12-21 14:09:42 +010099 /* PCM */
100 unsigned int active_streams;
101 struct mutex pcm_mutex;
102
Takashi Iwai352f7f92012-12-19 12:52:06 +0100103 /* 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;
Takashi Iwaicf799aa2013-01-18 16:38:08 +0100114 hda_nid_t adc_nids[AUTO_CFG_MAX_INS];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100115 hda_nid_t dig_in_nid; /* digital-in NID; optional */
116 hda_nid_t mixer_nid; /* analog-mixer NID */
Takashi Iwaie4a395e2013-01-23 17:00:31 +0100117 hda_nid_t mixer_merge_nid; /* aamix merge-point NID (optional) */
Takashi Iwaicf799aa2013-01-18 16:38:08 +0100118 const char *input_labels[HDA_MAX_NUM_INPUTS];
119 int input_label_idxs[HDA_MAX_NUM_INPUTS];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100120
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 */
Takashi Iwaia07a9492013-01-07 16:44:06 +0100131 /* 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 */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100145
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];
Takashi Iwai967303d2013-02-19 17:12:42 +0100155 /* shared hp/mic */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100156 hda_nid_t shared_mic_vref_pin;
Takashi Iwai967303d2013-02-19 17:12:42 +0100157 hda_nid_t hp_mic_pin;
158 int hp_mic_mux_idx;
Takashi Iwai352f7f92012-12-19 12:52:06 +0100159
Takashi Iwai0ffd5342013-01-17 15:53:29 +0100160 /* DAC/ADC lists */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100161 int num_all_dacs;
162 hda_nid_t all_dacs[16];
Takashi Iwai0ffd5342013-01-17 15:53:29 +0100163 int num_all_adcs;
Takashi Iwaicf799aa2013-01-18 16:38:08 +0100164 hda_nid_t all_adcs[AUTO_CFG_MAX_INS];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100165
166 /* path list */
167 struct snd_array paths;
168
Takashi Iwai196c17662013-01-04 15:01:40 +0100169 /* 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];
Takashi Iwaic30aa7b2013-01-04 16:42:48 +0100173 int aamix_out_paths[3];
Takashi Iwai196c17662013-01-04 15:01:40 +0100174 int digout_paths[AUTO_CFG_MAX_OUTS];
David Henningssond3d982f2013-01-18 15:43:01 +0100175 int input_paths[HDA_MAX_NUM_INPUTS][AUTO_CFG_MAX_INS];
Takashi Iwai196c17662013-01-04 15:01:40 +0100176 int loopback_paths[HDA_MAX_NUM_INPUTS];
Takashi Iwaie4a395e2013-01-23 17:00:31 +0100177 int loopback_merge_path;
Takashi Iwai2430d7b2013-01-04 15:09:42 +0100178 int digin_path;
Takashi Iwai196c17662013-01-04 15:01:40 +0100179
Takashi Iwai352f7f92012-12-19 12:52:06 +0100180 /* auto-mic stuff */
181 int am_num_entries;
182 struct automic_entry am_entry[MAX_AUTO_MIC_PINS];
183
184 /* for pin sensing */
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100185 /* current status; set in hda_geneic.c */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100186 unsigned int hp_jack_present:1;
187 unsigned int line_jack_present:1;
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100188 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 */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100192 unsigned int auto_mic:1;
193 unsigned int automute_speaker:1; /* automute speaker outputs */
194 unsigned int automute_lo:1; /* automute LO outputs */
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100195
196 /* capabilities detected by parser */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100197 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 */
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100201
202 /* additional parameters set by codec drivers */
203 unsigned int master_mute:1; /* master mute over all */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100204 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 */
Takashi Iwai7eebffd2013-06-24 16:00:21 +0200206 unsigned int auto_mute_via_amp:1; /* auto-mute via amp instead of pinctl */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100207
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100208 /* 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 */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100213 unsigned int need_dac_fix:1; /* need to limit DACs for multi channels */
Takashi Iwai967303d2013-02-19 17:12:42 +0100214 unsigned int hp_mic:1; /* Allow HP as a mic-in */
215 unsigned int suppress_hp_mic_detect:1; /* Don't detect HP/mic */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100216 unsigned int no_primary_hp:1; /* Don't prefer HP pins to speaker pins */
Takashi Iwaida96fb52013-07-29 16:54:36 +0200217 unsigned int no_multi_io:1; /* Don't try multi I/O config */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100218 unsigned int multi_cap_vol:1; /* allow multiple capture xxx volumes */
219 unsigned int inv_dmic_split:1; /* inverted dmic w/a for conexant */
Takashi Iwai731dc302012-12-19 13:01:54 +0100220 unsigned int own_eapd_ctl:1; /* set EAPD by own function */
Takashi Iwai05909d5c2013-05-31 19:55:54 +0200221 unsigned int keep_eapd_on:1; /* don't turn off EAPD automatically */
Takashi Iwaifd25a972012-12-20 14:57:18 +0100222 unsigned int vmaster_mute_enum:1; /* add vmaster mute mode enum */
Takashi Iwai38cf6f12012-12-21 14:09:42 +0100223 unsigned int indep_hp:1; /* independent HP supported */
Takashi Iwaiea46c3c2013-01-15 18:45:53 +0100224 unsigned int prefer_hp_amp:1; /* enable HP amp for speaker if any */
Takashi Iwai74f14b32014-12-15 13:43:59 +0100225 unsigned int add_stereo_mix_input:2; /* add aamix as a capture src */
Takashi Iwaif811c3c2013-03-07 18:32:59 +0100226 unsigned int add_jack_modes:1; /* add i/o jack mode enum ctls */
Takashi Iwai55196ff2013-01-24 17:32:56 +0100227 unsigned int power_down_unused:1; /* power down unused widgets */
Takashi Iwaid89c6c02014-09-01 10:07:04 +0200228 unsigned int dac_min_mute:1; /* minimal = mute for DACs */
Takashi Iwai352f7f92012-12-19 12:52:06 +0100229
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100230 /* 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 */
Takashi Iwaia1e908e2013-01-21 15:11:25 +0100234 unsigned int have_aamix_ctl:1;
Takashi Iwai8ba955c2013-03-07 18:40:58 +0100235 unsigned int hp_mic_jack_modes:1;
Takashi Iwaiacc47aa2013-01-16 18:28:38 +0100236
Takashi Iwai7eebffd2013-06-24 16:00:21 +0200237 /* additional mute flags (only effective with auto_mute_via_amp=1) */
238 u64 mute_bits;
239
Takashi Iwaia1114a82013-11-04 16:32:01 +0100240 /* bitmask for skipping volume controls */
241 u64 out_vol_mask;
242
Takashi Iwai98bd1112013-03-22 14:53:50 +0100243 /* badness tables for output path evaluations */
244 const struct badness_table *main_out_badness;
245 const struct badness_table *extra_out_badness;
246
Takashi Iwai36907392013-12-10 17:29:26 +0100247 /* preferred pin/DAC pairs; an array of paired NIDs */
248 const hda_nid_t *preferred_dacs;
249
Takashi Iwaic30aa7b2013-01-04 16:42:48 +0100250 /* loopback mixing mode */
251 bool aamix_mode;
252
Takashi Iwai7504b6c2013-03-18 11:25:51 +0100253 /* digital beep */
254 hda_nid_t beep_nid;
255
Takashi Iwai352f7f92012-12-19 12:52:06 +0100256 /* for virtual master */
257 hda_nid_t vmaster_nid;
Takashi Iwai7a71bbf2013-01-17 10:25:15 +0100258 unsigned int vmaster_tlv[4];
Takashi Iwai352f7f92012-12-19 12:52:06 +0100259 struct hda_vmaster_mute_hook vmaster_mute;
Takashi Iwai46a14482013-02-07 09:58:11 +0100260
Takashi Iwai352f7f92012-12-19 12:52:06 +0100261 struct hda_loopback_check loopback;
Takashi Iwai0186f4f2013-02-07 10:45:11 +0100262 struct snd_array loopback_list;
Takashi Iwai352f7f92012-12-19 12:52:06 +0100263
264 /* multi-io */
265 int multi_ios;
266 struct hda_multi_io multi_io[4];
267
Takashi Iwai352f7f92012-12-19 12:52:06 +0100268 /* hooks */
269 void (*init_hook)(struct hda_codec *codec);
270 void (*automute_hook)(struct hda_codec *codec);
Takashi Iwaia90229e2013-01-18 14:10:00 +0100271 void (*cap_sync_hook)(struct hda_codec *codec,
Takashi Iwai7fe30712014-01-30 17:59:02 +0100272 struct snd_kcontrol *kcontrol,
Takashi Iwaia90229e2013-01-18 14:10:00 +0100273 struct snd_ctl_elem_value *ucontrol);
Takashi Iwai2e03e952013-01-03 15:55:06 +0100274
Takashi Iwaiac2e8732013-01-17 15:57:10 +0100275 /* PCM hooks */
Takashi Iwaie6b85f32013-01-07 11:54:34 +0100276 void (*pcm_playback_hook)(struct hda_pcm_stream *hinfo,
277 struct hda_codec *codec,
278 struct snd_pcm_substream *substream,
279 int action);
Takashi Iwaiac2e8732013-01-17 15:57:10 +0100280 void (*pcm_capture_hook)(struct hda_pcm_stream *hinfo,
281 struct hda_codec *codec,
282 struct snd_pcm_substream *substream,
283 int action);
Takashi Iwaie6b85f32013-01-07 11:54:34 +0100284
Takashi Iwai2e03e952013-01-03 15:55:06 +0100285 /* automute / autoswitch hooks */
286 void (*hp_automute_hook)(struct hda_codec *codec,
Takashi Iwai1a4f69d2014-09-11 15:22:46 +0200287 struct hda_jack_callback *cb);
Takashi Iwai2e03e952013-01-03 15:55:06 +0100288 void (*line_automute_hook)(struct hda_codec *codec,
Takashi Iwai1a4f69d2014-09-11 15:22:46 +0200289 struct hda_jack_callback *cb);
Takashi Iwai2e03e952013-01-03 15:55:06 +0100290 void (*mic_autoswitch_hook)(struct hda_codec *codec,
Takashi Iwai1a4f69d2014-09-11 15:22:46 +0200291 struct hda_jack_callback *cb);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100292};
293
Takashi Iwai74f14b32014-12-15 13:43:59 +0100294/* values for add_stereo_mix_input flag */
295enum {
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
Takashi Iwai352f7f92012-12-19 12:52:06 +0100301int snd_hda_gen_spec_init(struct hda_gen_spec *spec);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100302
303int snd_hda_gen_init(struct hda_codec *codec);
Takashi Iwaifce52a32013-01-07 12:42:48 +0100304void snd_hda_gen_free(struct hda_codec *codec);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100305
306struct nid_path *snd_hda_get_nid_path(struct hda_codec *codec,
307 hda_nid_t from_nid, hda_nid_t to_nid);
Takashi Iwai196c17662013-01-04 15:01:40 +0100308int snd_hda_get_path_idx(struct hda_codec *codec, struct nid_path *path);
309struct nid_path *snd_hda_get_path_from_idx(struct hda_codec *codec, int idx);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100310bool snd_hda_parse_nid_path(struct hda_codec *codec, hda_nid_t from_nid,
Takashi Iwai3ca529d2013-01-07 17:25:08 +0100311 hda_nid_t to_nid, int anchor_nid,
Takashi Iwai352f7f92012-12-19 12:52:06 +0100312 struct nid_path *path);
313struct nid_path *
314snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid,
Takashi Iwai3ca529d2013-01-07 17:25:08 +0100315 hda_nid_t to_nid, int anchor_nid);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100316void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path,
317 bool enable, bool add_aamix);
318
Takashi Iwai12c93df2012-12-19 14:38:33 +0100319struct snd_kcontrol_new *
320snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name,
321 const struct snd_kcontrol_new *temp);
322
Takashi Iwai352f7f92012-12-19 12:52:06 +0100323int snd_hda_gen_parse_auto_config(struct hda_codec *codec,
Takashi Iwai9eb413e2012-12-19 14:41:21 +0100324 struct auto_pin_cfg *cfg);
Takashi Iwai352f7f92012-12-19 12:52:06 +0100325int snd_hda_gen_build_controls(struct hda_codec *codec);
326int snd_hda_gen_build_pcms(struct hda_codec *codec);
327
Takashi Iwai5d550e12012-12-19 15:16:44 +0100328/* standard jack event callbacks */
329void snd_hda_gen_hp_automute(struct hda_codec *codec,
Takashi Iwai1a4f69d2014-09-11 15:22:46 +0200330 struct hda_jack_callback *jack);
Takashi Iwai5d550e12012-12-19 15:16:44 +0100331void snd_hda_gen_line_automute(struct hda_codec *codec,
Takashi Iwai1a4f69d2014-09-11 15:22:46 +0200332 struct hda_jack_callback *jack);
Takashi Iwai5d550e12012-12-19 15:16:44 +0100333void snd_hda_gen_mic_autoswitch(struct hda_codec *codec,
Takashi Iwai1a4f69d2014-09-11 15:22:46 +0200334 struct hda_jack_callback *jack);
Takashi Iwai5d550e12012-12-19 15:16:44 +0100335void snd_hda_gen_update_outputs(struct hda_codec *codec);
336
Takashi Iwaifce52a32013-01-07 12:42:48 +0100337#ifdef CONFIG_PM
338int snd_hda_gen_check_power_status(struct hda_codec *codec, hda_nid_t nid);
339#endif
Takashi Iwaidfc6e462014-01-13 16:09:57 +0100340unsigned int snd_hda_gen_path_power_filter(struct hda_codec *codec,
341 hda_nid_t nid,
342 unsigned int power_state);
Takashi Iwaifce52a32013-01-07 12:42:48 +0100343
Takashi Iwai352f7f92012-12-19 12:52:06 +0100344#endif /* __SOUND_HDA_GENERIC_H */