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