Commit | Line | Data |
---|---|---|
62810dbd | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
352f7f91 TI |
2 | /* |
3 | * Generic BIOS auto-parser helper functions for HD-audio | |
4 | * | |
5 | * Copyright (c) 2012 Takashi Iwai <tiwai@suse.de> | |
352f7f91 TI |
6 | */ |
7 | ||
8 | #ifndef __SOUND_HDA_GENERIC_H | |
9 | #define __SOUND_HDA_GENERIC_H | |
10 | ||
7cdf8c49 | 11 | #include <linux/leds.h> |
64e05321 RF |
12 | #include "hda_auto_parser.h" |
13 | ||
14 | struct hda_jack_callback; | |
7cdf8c49 | 15 | |
352f7f91 TI |
16 | /* table entry for multi-io paths */ |
17 | struct hda_multi_io { | |
18 | hda_nid_t pin; /* multi-io widget pin NID */ | |
19 | hda_nid_t dac; /* DAC to be connected */ | |
20 | unsigned int ctl_in; /* cached input-pin control value */ | |
21 | }; | |
22 | ||
23 | /* Widget connection path | |
24 | * | |
25 | * For output, stored in the order of DAC -> ... -> pin, | |
26 | * for input, pin -> ... -> ADC. | |
27 | * | |
28 | * idx[i] contains the source index number to select on of the widget path[i]; | |
29 | * e.g. idx[1] is the index of the DAC (path[0]) selected by path[1] widget | |
30 | * multi[] indicates whether it's a selector widget with multi-connectors | |
31 | * (i.e. the connection selection is mandatory) | |
32 | * vol_ctl and mute_ctl contains the NIDs for the assigned mixers | |
33 | */ | |
34 | ||
d94ddd85 | 35 | #define MAX_NID_PATH_DEPTH 10 |
352f7f91 TI |
36 | |
37 | enum { | |
38 | NID_PATH_VOL_CTL, | |
39 | NID_PATH_MUTE_CTL, | |
40 | NID_PATH_BOOST_CTL, | |
41 | NID_PATH_NUM_CTLS | |
42 | }; | |
43 | ||
44 | struct nid_path { | |
45 | int depth; | |
46 | hda_nid_t path[MAX_NID_PATH_DEPTH]; | |
47 | unsigned char idx[MAX_NID_PATH_DEPTH]; | |
48 | unsigned char multi[MAX_NID_PATH_DEPTH]; | |
49 | unsigned int ctls[NID_PATH_NUM_CTLS]; /* NID_PATH_XXX_CTL */ | |
e6feb5d0 TI |
50 | bool active:1; /* activated by driver */ |
51 | bool pin_enabled:1; /* pins are enabled */ | |
6b275b14 | 52 | bool pin_fixed:1; /* path with fixed pin */ |
e6feb5d0 | 53 | bool stream_enabled:1; /* stream is active */ |
352f7f91 TI |
54 | }; |
55 | ||
56 | /* mic/line-in auto switching entry */ | |
57 | ||
58 | #define MAX_AUTO_MIC_PINS 3 | |
59 | ||
60 | struct automic_entry { | |
61 | hda_nid_t pin; /* pin */ | |
62 | int idx; /* imux index, -1 = invalid */ | |
63 | unsigned int attr; /* pin attribute (INPUT_PIN_ATTR_*) */ | |
64 | }; | |
65 | ||
38cf6f1a TI |
66 | /* active stream id */ |
67 | enum { STREAM_MULTI_OUT, STREAM_INDEP_HP }; | |
68 | ||
e6b85f3c TI |
69 | /* PCM hook action */ |
70 | enum { | |
71 | HDA_GEN_PCM_ACT_OPEN, | |
72 | HDA_GEN_PCM_ACT_PREPARE, | |
73 | HDA_GEN_PCM_ACT_CLEANUP, | |
74 | HDA_GEN_PCM_ACT_CLOSE, | |
75 | }; | |
76 | ||
98bd1115 TI |
77 | /* DAC assignment badness table */ |
78 | struct badness_table { | |
79 | int no_primary_dac; /* no primary DAC */ | |
80 | int no_dac; /* no secondary DACs */ | |
81 | int shared_primary; /* primary DAC is shared with main output */ | |
82 | int shared_surr; /* secondary DAC shared with main or primary */ | |
83 | int shared_clfe; /* third DAC shared with main or primary */ | |
84 | int shared_surr_main; /* secondary DAC sahred with main/DAC0 */ | |
85 | }; | |
86 | ||
87 | extern const struct badness_table hda_main_out_badness; | |
88 | extern const struct badness_table hda_extra_out_badness; | |
89 | ||
352f7f91 TI |
90 | struct hda_gen_spec { |
91 | char stream_name_analog[32]; /* analog PCM stream */ | |
92 | const struct hda_pcm_stream *stream_analog_playback; | |
93 | const struct hda_pcm_stream *stream_analog_capture; | |
a607148f TI |
94 | |
95 | char stream_name_alt_analog[32]; /* alternative analog PCM stream */ | |
352f7f91 TI |
96 | const struct hda_pcm_stream *stream_analog_alt_playback; |
97 | const struct hda_pcm_stream *stream_analog_alt_capture; | |
98 | ||
99 | char stream_name_digital[32]; /* digital PCM stream */ | |
100 | const struct hda_pcm_stream *stream_digital_playback; | |
101 | const struct hda_pcm_stream *stream_digital_capture; | |
102 | ||
38cf6f1a TI |
103 | /* PCM */ |
104 | unsigned int active_streams; | |
105 | struct mutex pcm_mutex; | |
106 | ||
352f7f91 TI |
107 | /* playback */ |
108 | struct hda_multi_out multiout; /* playback set-up | |
109 | * max_channels, dacs must be set | |
110 | * dig_out_nid and hp_nid are optional | |
111 | */ | |
112 | hda_nid_t alt_dac_nid; | |
9ab0cb30 | 113 | hda_nid_t follower_dig_outs[3]; /* optional - for auto-parsing */ |
352f7f91 TI |
114 | int dig_out_type; |
115 | ||
116 | /* capture */ | |
117 | unsigned int num_adc_nids; | |
cf799aa3 | 118 | hda_nid_t adc_nids[AUTO_CFG_MAX_INS]; |
352f7f91 TI |
119 | hda_nid_t dig_in_nid; /* digital-in NID; optional */ |
120 | hda_nid_t mixer_nid; /* analog-mixer NID */ | |
e4a395e7 | 121 | hda_nid_t mixer_merge_nid; /* aamix merge-point NID (optional) */ |
cf799aa3 TI |
122 | const char *input_labels[HDA_MAX_NUM_INPUTS]; |
123 | int input_label_idxs[HDA_MAX_NUM_INPUTS]; | |
352f7f91 TI |
124 | |
125 | /* capture setup for dynamic dual-adc switch */ | |
126 | hda_nid_t cur_adc; | |
127 | unsigned int cur_adc_stream_tag; | |
128 | unsigned int cur_adc_format; | |
129 | ||
130 | /* capture source */ | |
131 | struct hda_input_mux input_mux; | |
132 | unsigned int cur_mux[3]; | |
133 | ||
134 | /* channel model */ | |
a07a949b TI |
135 | /* min_channel_count contains the minimum channel count for primary |
136 | * outputs. When multi_ios is set, the channels can be configured | |
137 | * between min_channel_count and (min_channel_count + multi_ios * 2). | |
138 | * | |
139 | * ext_channel_count contains the current channel count of the primary | |
140 | * out. This varies in the range above. | |
141 | * | |
142 | * Meanwhile, const_channel_count is the channel count for all outputs | |
143 | * including headphone and speakers. It's a constant value, and the | |
144 | * PCM is set up as max(ext_channel_count, const_channel_count). | |
145 | */ | |
146 | int min_channel_count; /* min. channel count for primary out */ | |
147 | int ext_channel_count; /* current channel count for primary */ | |
148 | int const_channel_count; /* channel count for all */ | |
352f7f91 TI |
149 | |
150 | /* PCM information */ | |
bbbc7e85 | 151 | struct hda_pcm *pcm_rec[3]; /* used in build_pcms() */ |
352f7f91 TI |
152 | |
153 | /* dynamic controls, init_verbs and input_mux */ | |
154 | struct auto_pin_cfg autocfg; | |
155 | struct snd_array kctls; | |
156 | hda_nid_t private_dac_nids[AUTO_CFG_MAX_OUTS]; | |
157 | hda_nid_t imux_pins[HDA_MAX_NUM_INPUTS]; | |
158 | unsigned int dyn_adc_idx[HDA_MAX_NUM_INPUTS]; | |
967303da | 159 | /* shared hp/mic */ |
352f7f91 | 160 | hda_nid_t shared_mic_vref_pin; |
967303da TI |
161 | hda_nid_t hp_mic_pin; |
162 | int hp_mic_mux_idx; | |
352f7f91 | 163 | |
0ffd534e | 164 | /* DAC/ADC lists */ |
352f7f91 TI |
165 | int num_all_dacs; |
166 | hda_nid_t all_dacs[16]; | |
0ffd534e | 167 | int num_all_adcs; |
cf799aa3 | 168 | hda_nid_t all_adcs[AUTO_CFG_MAX_INS]; |
352f7f91 TI |
169 | |
170 | /* path list */ | |
171 | struct snd_array paths; | |
172 | ||
196c1766 TI |
173 | /* path indices */ |
174 | int out_paths[AUTO_CFG_MAX_OUTS]; | |
175 | int hp_paths[AUTO_CFG_MAX_OUTS]; | |
176 | int speaker_paths[AUTO_CFG_MAX_OUTS]; | |
c30aa7b2 | 177 | int aamix_out_paths[3]; |
196c1766 | 178 | int digout_paths[AUTO_CFG_MAX_OUTS]; |
d3d982f7 | 179 | int input_paths[HDA_MAX_NUM_INPUTS][AUTO_CFG_MAX_INS]; |
196c1766 | 180 | int loopback_paths[HDA_MAX_NUM_INPUTS]; |
e4a395e7 | 181 | int loopback_merge_path; |
2430d7b7 | 182 | int digin_path; |
196c1766 | 183 | |
352f7f91 TI |
184 | /* auto-mic stuff */ |
185 | int am_num_entries; | |
186 | struct automic_entry am_entry[MAX_AUTO_MIC_PINS]; | |
187 | ||
188 | /* for pin sensing */ | |
d13a8f6d | 189 | /* current status; set in hda_generic.c */ |
352f7f91 TI |
190 | unsigned int hp_jack_present:1; |
191 | unsigned int line_jack_present:1; | |
acc47aaf TI |
192 | unsigned int speaker_muted:1; /* current status of speaker mute */ |
193 | unsigned int line_out_muted:1; /* current status of LO mute */ | |
194 | ||
195 | /* internal states of automute / autoswitch behavior */ | |
352f7f91 TI |
196 | unsigned int auto_mic:1; |
197 | unsigned int automute_speaker:1; /* automute speaker outputs */ | |
198 | unsigned int automute_lo:1; /* automute LO outputs */ | |
acc47aaf TI |
199 | |
200 | /* capabilities detected by parser */ | |
352f7f91 TI |
201 | unsigned int detect_hp:1; /* Headphone detection enabled */ |
202 | unsigned int detect_lo:1; /* Line-out detection enabled */ | |
203 | unsigned int automute_speaker_possible:1; /* there are speakers and either LO or HP */ | |
204 | unsigned int automute_lo_possible:1; /* there are line outs and HP */ | |
acc47aaf TI |
205 | |
206 | /* additional parameters set by codec drivers */ | |
207 | unsigned int master_mute:1; /* master mute over all */ | |
352f7f91 | 208 | unsigned int keep_vref_in_automute:1; /* Don't clear VREF in automute */ |
acc47aaf | 209 | unsigned int line_in_auto_switch:1; /* allow line-in auto switch */ |
7eebffd3 | 210 | unsigned int auto_mute_via_amp:1; /* auto-mute via amp instead of pinctl */ |
acc47aaf TI |
211 | |
212 | /* parser behavior flags; set before snd_hda_gen_parse_auto_config() */ | |
f72706be | 213 | unsigned int suppress_auto_mute:1; /* suppress input jack auto mute */ |
d12daf6f | 214 | unsigned int suppress_auto_mic:1; /* suppress input jack auto switch */ |
352f7f91 | 215 | |
acc47aaf | 216 | /* other parse behavior flags */ |
352f7f91 | 217 | unsigned int need_dac_fix:1; /* need to limit DACs for multi channels */ |
967303da TI |
218 | unsigned int hp_mic:1; /* Allow HP as a mic-in */ |
219 | unsigned int suppress_hp_mic_detect:1; /* Don't detect HP/mic */ | |
352f7f91 | 220 | unsigned int no_primary_hp:1; /* Don't prefer HP pins to speaker pins */ |
da96fb5b | 221 | unsigned int no_multi_io:1; /* Don't try multi I/O config */ |
352f7f91 TI |
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 */ | |
731dc301 | 224 | unsigned int own_eapd_ctl:1; /* set EAPD by own function */ |
05909d5c | 225 | unsigned int keep_eapd_on:1; /* don't turn off EAPD automatically */ |
e65bf997 JK |
226 | unsigned int vmaster_mute_led:1; /* add SPK-LED flag to vmaster mute switch */ |
227 | unsigned int mic_mute_led:1; /* add MIC-LED flag to capture mute switch */ | |
38cf6f1a | 228 | unsigned int indep_hp:1; /* independent HP supported */ |
ea46c3c8 | 229 | unsigned int prefer_hp_amp:1; /* enable HP amp for speaker if any */ |
74f14b36 | 230 | unsigned int add_stereo_mix_input:2; /* add aamix as a capture src */ |
f811c3cf | 231 | unsigned int add_jack_modes:1; /* add i/o jack mode enum ctls */ |
55196fff | 232 | unsigned int power_down_unused:1; /* power down unused widgets */ |
d89c6c0c | 233 | unsigned int dac_min_mute:1; /* minimal = mute for DACs */ |
7480316c | 234 | unsigned int suppress_vmaster:1; /* don't create vmaster kctls */ |
242d990c | 235 | unsigned int obey_preferred_dacs:1; /* obey preferred_dacs assignment */ |
352f7f91 | 236 | |
acc47aaf TI |
237 | /* other internal flags */ |
238 | unsigned int no_analog:1; /* digital I/O only */ | |
239 | unsigned int dyn_adc_switch:1; /* switch ADCs (for ALC275) */ | |
240 | unsigned int indep_hp_enabled:1; /* independent HP enabled */ | |
a1e908ed | 241 | unsigned int have_aamix_ctl:1; |
8ba955ce | 242 | unsigned int hp_mic_jack_modes:1; |
89781d08 | 243 | unsigned int skip_verbs:1; /* don't apply verbs at snd_hda_gen_init() */ |
acc47aaf | 244 | |
7eebffd3 TI |
245 | /* additional mute flags (only effective with auto_mute_via_amp=1) */ |
246 | u64 mute_bits; | |
247 | ||
a1114a8c TI |
248 | /* bitmask for skipping volume controls */ |
249 | u64 out_vol_mask; | |
250 | ||
98bd1115 TI |
251 | /* badness tables for output path evaluations */ |
252 | const struct badness_table *main_out_badness; | |
253 | const struct badness_table *extra_out_badness; | |
254 | ||
3690739b TI |
255 | /* preferred pin/DAC pairs; an array of paired NIDs */ |
256 | const hda_nid_t *preferred_dacs; | |
257 | ||
c30aa7b2 TI |
258 | /* loopback mixing mode */ |
259 | bool aamix_mode; | |
260 | ||
7504b6cd TI |
261 | /* digital beep */ |
262 | hda_nid_t beep_nid; | |
263 | ||
352f7f91 TI |
264 | /* for virtual master */ |
265 | hda_nid_t vmaster_nid; | |
7a71bbf3 | 266 | unsigned int vmaster_tlv[4]; |
352f7f91 | 267 | struct hda_vmaster_mute_hook vmaster_mute; |
46a14481 | 268 | |
352f7f91 | 269 | struct hda_loopback_check loopback; |
0186f4f4 | 270 | struct snd_array loopback_list; |
352f7f91 TI |
271 | |
272 | /* multi-io */ | |
273 | int multi_ios; | |
274 | struct hda_multi_io multi_io[4]; | |
275 | ||
352f7f91 TI |
276 | /* hooks */ |
277 | void (*init_hook)(struct hda_codec *codec); | |
278 | void (*automute_hook)(struct hda_codec *codec); | |
a90229e0 | 279 | void (*cap_sync_hook)(struct hda_codec *codec, |
7fe30711 | 280 | struct snd_kcontrol *kcontrol, |
a90229e0 | 281 | struct snd_ctl_elem_value *ucontrol); |
2e03e952 | 282 | |
ac2e8736 | 283 | /* PCM hooks */ |
e6b85f3c TI |
284 | void (*pcm_playback_hook)(struct hda_pcm_stream *hinfo, |
285 | struct hda_codec *codec, | |
286 | struct snd_pcm_substream *substream, | |
287 | int action); | |
ac2e8736 TI |
288 | void (*pcm_capture_hook)(struct hda_pcm_stream *hinfo, |
289 | struct hda_codec *codec, | |
290 | struct snd_pcm_substream *substream, | |
291 | int action); | |
e6b85f3c | 292 | |
2e03e952 TI |
293 | /* automute / autoswitch hooks */ |
294 | void (*hp_automute_hook)(struct hda_codec *codec, | |
1a4f69d5 | 295 | struct hda_jack_callback *cb); |
2e03e952 | 296 | void (*line_automute_hook)(struct hda_codec *codec, |
1a4f69d5 | 297 | struct hda_jack_callback *cb); |
2e03e952 | 298 | void (*mic_autoswitch_hook)(struct hda_codec *codec, |
1a4f69d5 | 299 | struct hda_jack_callback *cb); |
549f8ffc TI |
300 | |
301 | /* leds */ | |
302 | struct led_classdev *led_cdevs[NUM_AUDIO_LEDS]; | |
352f7f91 TI |
303 | }; |
304 | ||
74f14b36 TI |
305 | /* values for add_stereo_mix_input flag */ |
306 | enum { | |
307 | HDA_HINT_STEREO_MIX_DISABLE, /* No stereo mix input */ | |
308 | HDA_HINT_STEREO_MIX_ENABLE, /* Add stereo mix input */ | |
309 | HDA_HINT_STEREO_MIX_AUTO, /* Add only if auto-mic is disabled */ | |
310 | }; | |
311 | ||
352f7f91 | 312 | int snd_hda_gen_spec_init(struct hda_gen_spec *spec); |
352f7f91 TI |
313 | |
314 | int snd_hda_gen_init(struct hda_codec *codec); | |
fce52a3b | 315 | void snd_hda_gen_free(struct hda_codec *codec); |
352f7f91 | 316 | |
196c1766 TI |
317 | int snd_hda_get_path_idx(struct hda_codec *codec, struct nid_path *path); |
318 | struct nid_path *snd_hda_get_path_from_idx(struct hda_codec *codec, int idx); | |
352f7f91 TI |
319 | struct nid_path * |
320 | snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid, | |
3ca529d3 | 321 | hda_nid_t to_nid, int anchor_nid); |
352f7f91 TI |
322 | void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path, |
323 | bool enable, bool add_aamix); | |
324 | ||
12c93df6 TI |
325 | struct snd_kcontrol_new * |
326 | snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name, | |
327 | const struct snd_kcontrol_new *temp); | |
328 | ||
352f7f91 | 329 | int snd_hda_gen_parse_auto_config(struct hda_codec *codec, |
9eb413e5 | 330 | struct auto_pin_cfg *cfg); |
352f7f91 TI |
331 | int snd_hda_gen_build_controls(struct hda_codec *codec); |
332 | int snd_hda_gen_build_pcms(struct hda_codec *codec); | |
333 | ||
5d550e15 TI |
334 | /* standard jack event callbacks */ |
335 | void snd_hda_gen_hp_automute(struct hda_codec *codec, | |
1a4f69d5 | 336 | struct hda_jack_callback *jack); |
5d550e15 | 337 | void snd_hda_gen_line_automute(struct hda_codec *codec, |
1a4f69d5 | 338 | struct hda_jack_callback *jack); |
5d550e15 | 339 | void snd_hda_gen_mic_autoswitch(struct hda_codec *codec, |
1a4f69d5 | 340 | struct hda_jack_callback *jack); |
5d550e15 TI |
341 | void snd_hda_gen_update_outputs(struct hda_codec *codec); |
342 | ||
fce52a3b | 343 | int snd_hda_gen_check_power_status(struct hda_codec *codec, hda_nid_t nid); |
dfc6e469 TI |
344 | unsigned int snd_hda_gen_path_power_filter(struct hda_codec *codec, |
345 | hda_nid_t nid, | |
346 | unsigned int power_state); | |
e6feb5d0 | 347 | void snd_hda_gen_stream_pm(struct hda_codec *codec, hda_nid_t nid, bool on); |
6b275b14 | 348 | int snd_hda_gen_fix_pin_power(struct hda_codec *codec, hda_nid_t pin); |
fce52a3b | 349 | |
15509b63 TI |
350 | int snd_hda_gen_add_mute_led_cdev(struct hda_codec *codec, |
351 | int (*callback)(struct led_classdev *, | |
352 | enum led_brightness)); | |
7cdf8c49 TI |
353 | int snd_hda_gen_add_micmute_led_cdev(struct hda_codec *codec, |
354 | int (*callback)(struct led_classdev *, | |
355 | enum led_brightness)); | |
f567b788 | 356 | |
352f7f91 | 357 | #endif /* __SOUND_HDA_GENERIC_H */ |