xref: /openbmc/linux/sound/pci/hda/hda_generic.h (revision cfbb9be8)
1 /*
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 /* table entry for multi-io paths */
16 struct 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 
34 #define MAX_NID_PATH_DEPTH	10
35 
36 enum {
37 	NID_PATH_VOL_CTL,
38 	NID_PATH_MUTE_CTL,
39 	NID_PATH_BOOST_CTL,
40 	NID_PATH_NUM_CTLS
41 };
42 
43 struct 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:1;		/* activated by driver */
50 	bool pin_enabled:1;	/* pins are enabled */
51 	bool pin_fixed:1;	/* path with fixed pin */
52 	bool stream_enabled:1;	/* stream is active */
53 };
54 
55 /* mic/line-in auto switching entry */
56 
57 #define MAX_AUTO_MIC_PINS	3
58 
59 struct automic_entry {
60 	hda_nid_t pin;		/* pin */
61 	int idx;		/* imux index, -1 = invalid */
62 	unsigned int attr;	/* pin attribute (INPUT_PIN_ATTR_*) */
63 };
64 
65 /* active stream id */
66 enum { STREAM_MULTI_OUT, STREAM_INDEP_HP };
67 
68 /* PCM hook action */
69 enum {
70 	HDA_GEN_PCM_ACT_OPEN,
71 	HDA_GEN_PCM_ACT_PREPARE,
72 	HDA_GEN_PCM_ACT_CLEANUP,
73 	HDA_GEN_PCM_ACT_CLOSE,
74 };
75 
76 /* DAC assignment badness table */
77 struct badness_table {
78 	int no_primary_dac;	/* no primary DAC */
79 	int no_dac;		/* no secondary DACs */
80 	int shared_primary;	/* primary DAC is shared with main output */
81 	int shared_surr;	/* secondary DAC shared with main or primary */
82 	int shared_clfe;	/* third DAC shared with main or primary */
83 	int shared_surr_main;	/* secondary DAC sahred with main/DAC0 */
84 };
85 
86 extern const struct badness_table hda_main_out_badness;
87 extern const struct badness_table hda_extra_out_badness;
88 
89 struct hda_gen_spec {
90 	char stream_name_analog[32];	/* analog PCM stream */
91 	const struct hda_pcm_stream *stream_analog_playback;
92 	const struct hda_pcm_stream *stream_analog_capture;
93 
94 	char stream_name_alt_analog[32]; /* alternative analog PCM stream */
95 	const struct hda_pcm_stream *stream_analog_alt_playback;
96 	const struct hda_pcm_stream *stream_analog_alt_capture;
97 
98 	char stream_name_digital[32];	/* digital PCM stream */
99 	const struct hda_pcm_stream *stream_digital_playback;
100 	const struct hda_pcm_stream *stream_digital_capture;
101 
102 	/* PCM */
103 	unsigned int active_streams;
104 	struct mutex pcm_mutex;
105 
106 	/* playback */
107 	struct hda_multi_out multiout;	/* playback set-up
108 					 * max_channels, dacs must be set
109 					 * dig_out_nid and hp_nid are optional
110 					 */
111 	hda_nid_t alt_dac_nid;
112 	hda_nid_t slave_dig_outs[3];	/* optional - for auto-parsing */
113 	int dig_out_type;
114 
115 	/* capture */
116 	unsigned int num_adc_nids;
117 	hda_nid_t adc_nids[AUTO_CFG_MAX_INS];
118 	hda_nid_t dig_in_nid;		/* digital-in NID; optional */
119 	hda_nid_t mixer_nid;		/* analog-mixer NID */
120 	hda_nid_t mixer_merge_nid;	/* aamix merge-point NID (optional) */
121 	const char *input_labels[HDA_MAX_NUM_INPUTS];
122 	int input_label_idxs[HDA_MAX_NUM_INPUTS];
123 
124 	/* capture setup for dynamic dual-adc switch */
125 	hda_nid_t cur_adc;
126 	unsigned int cur_adc_stream_tag;
127 	unsigned int cur_adc_format;
128 
129 	/* capture source */
130 	struct hda_input_mux input_mux;
131 	unsigned int cur_mux[3];
132 
133 	/* channel model */
134 	/* min_channel_count contains the minimum channel count for primary
135 	 * outputs.  When multi_ios is set, the channels can be configured
136 	 * between min_channel_count and (min_channel_count + multi_ios * 2).
137 	 *
138 	 * ext_channel_count contains the current channel count of the primary
139 	 * out.  This varies in the range above.
140 	 *
141 	 * Meanwhile, const_channel_count is the channel count for all outputs
142 	 * including headphone and speakers.  It's a constant value, and the
143 	 * PCM is set up as max(ext_channel_count, const_channel_count).
144 	 */
145 	int min_channel_count;		/* min. channel count for primary out */
146 	int ext_channel_count;		/* current channel count for primary */
147 	int const_channel_count;	/* channel count for all */
148 
149 	/* PCM information */
150 	struct hda_pcm *pcm_rec[3];	/* used in build_pcms() */
151 
152 	/* dynamic controls, init_verbs and input_mux */
153 	struct auto_pin_cfg autocfg;
154 	struct snd_array kctls;
155 	hda_nid_t private_dac_nids[AUTO_CFG_MAX_OUTS];
156 	hda_nid_t imux_pins[HDA_MAX_NUM_INPUTS];
157 	unsigned int dyn_adc_idx[HDA_MAX_NUM_INPUTS];
158 	/* shared hp/mic */
159 	hda_nid_t shared_mic_vref_pin;
160 	hda_nid_t hp_mic_pin;
161 	int hp_mic_mux_idx;
162 
163 	/* DAC/ADC lists */
164 	int num_all_dacs;
165 	hda_nid_t all_dacs[16];
166 	int num_all_adcs;
167 	hda_nid_t all_adcs[AUTO_CFG_MAX_INS];
168 
169 	/* path list */
170 	struct snd_array paths;
171 
172 	/* path indices */
173 	int out_paths[AUTO_CFG_MAX_OUTS];
174 	int hp_paths[AUTO_CFG_MAX_OUTS];
175 	int speaker_paths[AUTO_CFG_MAX_OUTS];
176 	int aamix_out_paths[3];
177 	int digout_paths[AUTO_CFG_MAX_OUTS];
178 	int input_paths[HDA_MAX_NUM_INPUTS][AUTO_CFG_MAX_INS];
179 	int loopback_paths[HDA_MAX_NUM_INPUTS];
180 	int loopback_merge_path;
181 	int digin_path;
182 
183 	/* auto-mic stuff */
184 	int am_num_entries;
185 	struct automic_entry am_entry[MAX_AUTO_MIC_PINS];
186 
187 	/* for pin sensing */
188 	/* current status; set in hda_geneic.c */
189 	unsigned int hp_jack_present:1;
190 	unsigned int line_jack_present:1;
191 	unsigned int speaker_muted:1; /* current status of speaker mute */
192 	unsigned int line_out_muted:1; /* current status of LO mute */
193 
194 	/* internal states of automute / autoswitch behavior */
195 	unsigned int auto_mic:1;
196 	unsigned int automute_speaker:1; /* automute speaker outputs */
197 	unsigned int automute_lo:1; /* automute LO outputs */
198 
199 	/* capabilities detected by parser */
200 	unsigned int detect_hp:1;	/* Headphone detection enabled */
201 	unsigned int detect_lo:1;	/* Line-out detection enabled */
202 	unsigned int automute_speaker_possible:1; /* there are speakers and either LO or HP */
203 	unsigned int automute_lo_possible:1;	  /* there are line outs and HP */
204 
205 	/* additional parameters set by codec drivers */
206 	unsigned int master_mute:1;	/* master mute over all */
207 	unsigned int keep_vref_in_automute:1; /* Don't clear VREF in automute */
208 	unsigned int line_in_auto_switch:1; /* allow line-in auto switch */
209 	unsigned int auto_mute_via_amp:1; /* auto-mute via amp instead of pinctl */
210 
211 	/* parser behavior flags; set before snd_hda_gen_parse_auto_config() */
212 	unsigned int suppress_auto_mute:1; /* suppress input jack auto mute */
213 	unsigned int suppress_auto_mic:1; /* suppress input jack auto switch */
214 
215 	/* other parse behavior flags */
216 	unsigned int need_dac_fix:1; /* need to limit DACs for multi channels */
217 	unsigned int hp_mic:1; /* Allow HP as a mic-in */
218 	unsigned int suppress_hp_mic_detect:1; /* Don't detect HP/mic */
219 	unsigned int no_primary_hp:1; /* Don't prefer HP pins to speaker pins */
220 	unsigned int no_multi_io:1; /* Don't try multi I/O config */
221 	unsigned int multi_cap_vol:1; /* allow multiple capture xxx volumes */
222 	unsigned int inv_dmic_split:1; /* inverted dmic w/a for conexant */
223 	unsigned int own_eapd_ctl:1; /* set EAPD by own function */
224 	unsigned int keep_eapd_on:1; /* don't turn off EAPD automatically */
225 	unsigned int vmaster_mute_enum:1; /* add vmaster mute mode enum */
226 	unsigned int indep_hp:1; /* independent HP supported */
227 	unsigned int prefer_hp_amp:1; /* enable HP amp for speaker if any */
228 	unsigned int add_stereo_mix_input:2; /* add aamix as a capture src */
229 	unsigned int add_jack_modes:1; /* add i/o jack mode enum ctls */
230 	unsigned int power_down_unused:1; /* power down unused widgets */
231 	unsigned int dac_min_mute:1; /* minimal = mute for DACs */
232 	unsigned int suppress_vmaster:1; /* don't create vmaster kctls */
233 
234 	/* other internal flags */
235 	unsigned int no_analog:1; /* digital I/O only */
236 	unsigned int dyn_adc_switch:1; /* switch ADCs (for ALC275) */
237 	unsigned int indep_hp_enabled:1; /* independent HP enabled */
238 	unsigned int have_aamix_ctl:1;
239 	unsigned int hp_mic_jack_modes:1;
240 
241 	/* additional mute flags (only effective with auto_mute_via_amp=1) */
242 	u64 mute_bits;
243 
244 	/* bitmask for skipping volume controls */
245 	u64 out_vol_mask;
246 
247 	/* badness tables for output path evaluations */
248 	const struct badness_table *main_out_badness;
249 	const struct badness_table *extra_out_badness;
250 
251 	/* preferred pin/DAC pairs; an array of paired NIDs */
252 	const hda_nid_t *preferred_dacs;
253 
254 	/* loopback mixing mode */
255 	bool aamix_mode;
256 
257 	/* digital beep */
258 	hda_nid_t beep_nid;
259 
260 	/* for virtual master */
261 	hda_nid_t vmaster_nid;
262 	unsigned int vmaster_tlv[4];
263 	struct hda_vmaster_mute_hook vmaster_mute;
264 
265 	struct hda_loopback_check loopback;
266 	struct snd_array loopback_list;
267 
268 	/* multi-io */
269 	int multi_ios;
270 	struct hda_multi_io multi_io[4];
271 
272 	/* hooks */
273 	void (*init_hook)(struct hda_codec *codec);
274 	void (*automute_hook)(struct hda_codec *codec);
275 	void (*cap_sync_hook)(struct hda_codec *codec,
276 			      struct snd_kcontrol *kcontrol,
277 			      struct snd_ctl_elem_value *ucontrol);
278 
279 	/* PCM hooks */
280 	void (*pcm_playback_hook)(struct hda_pcm_stream *hinfo,
281 				  struct hda_codec *codec,
282 				  struct snd_pcm_substream *substream,
283 				  int action);
284 	void (*pcm_capture_hook)(struct hda_pcm_stream *hinfo,
285 				 struct hda_codec *codec,
286 				 struct snd_pcm_substream *substream,
287 				 int action);
288 
289 	/* automute / autoswitch hooks */
290 	void (*hp_automute_hook)(struct hda_codec *codec,
291 				 struct hda_jack_callback *cb);
292 	void (*line_automute_hook)(struct hda_codec *codec,
293 				   struct hda_jack_callback *cb);
294 	void (*mic_autoswitch_hook)(struct hda_codec *codec,
295 				    struct hda_jack_callback *cb);
296 };
297 
298 /* values for add_stereo_mix_input flag */
299 enum {
300 	HDA_HINT_STEREO_MIX_DISABLE,	/* No stereo mix input */
301 	HDA_HINT_STEREO_MIX_ENABLE,	/* Add stereo mix input */
302 	HDA_HINT_STEREO_MIX_AUTO,	/* Add only if auto-mic is disabled */
303 };
304 
305 int snd_hda_gen_spec_init(struct hda_gen_spec *spec);
306 
307 int snd_hda_gen_init(struct hda_codec *codec);
308 void snd_hda_gen_free(struct hda_codec *codec);
309 
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 struct nid_path *
313 snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid,
314 		     hda_nid_t to_nid, int anchor_nid);
315 void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path,
316 			   bool enable, bool add_aamix);
317 
318 struct snd_kcontrol_new *
319 snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name,
320 		     const struct snd_kcontrol_new *temp);
321 
322 int snd_hda_gen_parse_auto_config(struct hda_codec *codec,
323 				  struct auto_pin_cfg *cfg);
324 int snd_hda_gen_build_controls(struct hda_codec *codec);
325 int snd_hda_gen_build_pcms(struct hda_codec *codec);
326 
327 /* standard jack event callbacks */
328 void snd_hda_gen_hp_automute(struct hda_codec *codec,
329 			     struct hda_jack_callback *jack);
330 void snd_hda_gen_line_automute(struct hda_codec *codec,
331 			       struct hda_jack_callback *jack);
332 void snd_hda_gen_mic_autoswitch(struct hda_codec *codec,
333 				struct hda_jack_callback *jack);
334 void snd_hda_gen_update_outputs(struct hda_codec *codec);
335 
336 #ifdef CONFIG_PM
337 int snd_hda_gen_check_power_status(struct hda_codec *codec, hda_nid_t nid);
338 #endif
339 unsigned int snd_hda_gen_path_power_filter(struct hda_codec *codec,
340 					   hda_nid_t nid,
341 					   unsigned int power_state);
342 void snd_hda_gen_stream_pm(struct hda_codec *codec, hda_nid_t nid, bool on);
343 int snd_hda_gen_fix_pin_power(struct hda_codec *codec, hda_nid_t pin);
344 
345 #endif /* __SOUND_HDA_GENERIC_H */
346