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