1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Generic BIOS auto-parser helper functions for HD-audio
5 * Copyright (c) 2012 Takashi Iwai <tiwai@suse.de>
8 #ifndef __SOUND_HDA_GENERIC_H
9 #define __SOUND_HDA_GENERIC_H
11 /* table entry for multi-io paths */
13 hda_nid_t pin
; /* multi-io widget pin NID */
14 hda_nid_t dac
; /* DAC to be connected */
15 unsigned int ctl_in
; /* cached input-pin control value */
18 /* Widget connection path
20 * For output, stored in the order of DAC -> ... -> pin,
21 * for input, pin -> ... -> ADC.
23 * idx[i] contains the source index number to select on of the widget path[i];
24 * e.g. idx[1] is the index of the DAC (path[0]) selected by path[1] widget
25 * multi[] indicates whether it's a selector widget with multi-connectors
26 * (i.e. the connection selection is mandatory)
27 * vol_ctl and mute_ctl contains the NIDs for the assigned mixers
30 #define MAX_NID_PATH_DEPTH 10
41 hda_nid_t path
[MAX_NID_PATH_DEPTH
];
42 unsigned char idx
[MAX_NID_PATH_DEPTH
];
43 unsigned char multi
[MAX_NID_PATH_DEPTH
];
44 unsigned int ctls
[NID_PATH_NUM_CTLS
]; /* NID_PATH_XXX_CTL */
45 bool active
:1; /* activated by driver */
46 bool pin_enabled
:1; /* pins are enabled */
47 bool pin_fixed
:1; /* path with fixed pin */
48 bool stream_enabled
:1; /* stream is active */
51 /* mic/line-in auto switching entry */
53 #define MAX_AUTO_MIC_PINS 3
55 struct automic_entry
{
56 hda_nid_t pin
; /* pin */
57 int idx
; /* imux index, -1 = invalid */
58 unsigned int attr
; /* pin attribute (INPUT_PIN_ATTR_*) */
61 /* active stream id */
62 enum { STREAM_MULTI_OUT
, STREAM_INDEP_HP
};
67 HDA_GEN_PCM_ACT_PREPARE
,
68 HDA_GEN_PCM_ACT_CLEANUP
,
69 HDA_GEN_PCM_ACT_CLOSE
,
72 /* DAC assignment badness table */
73 struct badness_table
{
74 int no_primary_dac
; /* no primary DAC */
75 int no_dac
; /* no secondary DACs */
76 int shared_primary
; /* primary DAC is shared with main output */
77 int shared_surr
; /* secondary DAC shared with main or primary */
78 int shared_clfe
; /* third DAC shared with main or primary */
79 int shared_surr_main
; /* secondary DAC sahred with main/DAC0 */
82 extern const struct badness_table hda_main_out_badness
;
83 extern const struct badness_table hda_extra_out_badness
;
85 struct hda_micmute_hook
{
86 unsigned int led_mode
;
88 unsigned int led_value
;
89 void (*update
)(struct hda_codec
*codec
);
90 void (*old_hook
)(struct hda_codec
*codec
,
91 struct snd_kcontrol
*kcontrol
,
92 struct snd_ctl_elem_value
*ucontrol
);
96 char stream_name_analog
[32]; /* analog PCM stream */
97 const struct hda_pcm_stream
*stream_analog_playback
;
98 const struct hda_pcm_stream
*stream_analog_capture
;
100 char stream_name_alt_analog
[32]; /* alternative analog PCM stream */
101 const struct hda_pcm_stream
*stream_analog_alt_playback
;
102 const struct hda_pcm_stream
*stream_analog_alt_capture
;
104 char stream_name_digital
[32]; /* digital PCM stream */
105 const struct hda_pcm_stream
*stream_digital_playback
;
106 const struct hda_pcm_stream
*stream_digital_capture
;
109 unsigned int active_streams
;
110 struct mutex pcm_mutex
;
113 struct hda_multi_out multiout
; /* playback set-up
114 * max_channels, dacs must be set
115 * dig_out_nid and hp_nid are optional
117 hda_nid_t alt_dac_nid
;
118 hda_nid_t slave_dig_outs
[3]; /* optional - for auto-parsing */
122 unsigned int num_adc_nids
;
123 hda_nid_t adc_nids
[AUTO_CFG_MAX_INS
];
124 hda_nid_t dig_in_nid
; /* digital-in NID; optional */
125 hda_nid_t mixer_nid
; /* analog-mixer NID */
126 hda_nid_t mixer_merge_nid
; /* aamix merge-point NID (optional) */
127 const char *input_labels
[HDA_MAX_NUM_INPUTS
];
128 int input_label_idxs
[HDA_MAX_NUM_INPUTS
];
130 /* capture setup for dynamic dual-adc switch */
132 unsigned int cur_adc_stream_tag
;
133 unsigned int cur_adc_format
;
136 struct hda_input_mux input_mux
;
137 unsigned int cur_mux
[3];
140 /* min_channel_count contains the minimum channel count for primary
141 * outputs. When multi_ios is set, the channels can be configured
142 * between min_channel_count and (min_channel_count + multi_ios * 2).
144 * ext_channel_count contains the current channel count of the primary
145 * out. This varies in the range above.
147 * Meanwhile, const_channel_count is the channel count for all outputs
148 * including headphone and speakers. It's a constant value, and the
149 * PCM is set up as max(ext_channel_count, const_channel_count).
151 int min_channel_count
; /* min. channel count for primary out */
152 int ext_channel_count
; /* current channel count for primary */
153 int const_channel_count
; /* channel count for all */
155 /* PCM information */
156 struct hda_pcm
*pcm_rec
[3]; /* used in build_pcms() */
158 /* dynamic controls, init_verbs and input_mux */
159 struct auto_pin_cfg autocfg
;
160 struct snd_array kctls
;
161 hda_nid_t private_dac_nids
[AUTO_CFG_MAX_OUTS
];
162 hda_nid_t imux_pins
[HDA_MAX_NUM_INPUTS
];
163 unsigned int dyn_adc_idx
[HDA_MAX_NUM_INPUTS
];
165 hda_nid_t shared_mic_vref_pin
;
166 hda_nid_t hp_mic_pin
;
171 hda_nid_t all_dacs
[16];
173 hda_nid_t all_adcs
[AUTO_CFG_MAX_INS
];
176 struct snd_array paths
;
179 int out_paths
[AUTO_CFG_MAX_OUTS
];
180 int hp_paths
[AUTO_CFG_MAX_OUTS
];
181 int speaker_paths
[AUTO_CFG_MAX_OUTS
];
182 int aamix_out_paths
[3];
183 int digout_paths
[AUTO_CFG_MAX_OUTS
];
184 int input_paths
[HDA_MAX_NUM_INPUTS
][AUTO_CFG_MAX_INS
];
185 int loopback_paths
[HDA_MAX_NUM_INPUTS
];
186 int loopback_merge_path
;
191 struct automic_entry am_entry
[MAX_AUTO_MIC_PINS
];
193 /* for pin sensing */
194 /* current status; set in hda_geneic.c */
195 unsigned int hp_jack_present
:1;
196 unsigned int line_jack_present
:1;
197 unsigned int speaker_muted
:1; /* current status of speaker mute */
198 unsigned int line_out_muted
:1; /* current status of LO mute */
200 /* internal states of automute / autoswitch behavior */
201 unsigned int auto_mic
:1;
202 unsigned int automute_speaker
:1; /* automute speaker outputs */
203 unsigned int automute_lo
:1; /* automute LO outputs */
205 /* capabilities detected by parser */
206 unsigned int detect_hp
:1; /* Headphone detection enabled */
207 unsigned int detect_lo
:1; /* Line-out detection enabled */
208 unsigned int automute_speaker_possible
:1; /* there are speakers and either LO or HP */
209 unsigned int automute_lo_possible
:1; /* there are line outs and HP */
211 /* additional parameters set by codec drivers */
212 unsigned int master_mute
:1; /* master mute over all */
213 unsigned int keep_vref_in_automute
:1; /* Don't clear VREF in automute */
214 unsigned int line_in_auto_switch
:1; /* allow line-in auto switch */
215 unsigned int auto_mute_via_amp
:1; /* auto-mute via amp instead of pinctl */
217 /* parser behavior flags; set before snd_hda_gen_parse_auto_config() */
218 unsigned int suppress_auto_mute
:1; /* suppress input jack auto mute */
219 unsigned int suppress_auto_mic
:1; /* suppress input jack auto switch */
221 /* other parse behavior flags */
222 unsigned int need_dac_fix
:1; /* need to limit DACs for multi channels */
223 unsigned int hp_mic
:1; /* Allow HP as a mic-in */
224 unsigned int suppress_hp_mic_detect
:1; /* Don't detect HP/mic */
225 unsigned int no_primary_hp
:1; /* Don't prefer HP pins to speaker pins */
226 unsigned int no_multi_io
:1; /* Don't try multi I/O config */
227 unsigned int multi_cap_vol
:1; /* allow multiple capture xxx volumes */
228 unsigned int inv_dmic_split
:1; /* inverted dmic w/a for conexant */
229 unsigned int own_eapd_ctl
:1; /* set EAPD by own function */
230 unsigned int keep_eapd_on
:1; /* don't turn off EAPD automatically */
231 unsigned int vmaster_mute_enum
:1; /* add vmaster mute mode enum */
232 unsigned int indep_hp
:1; /* independent HP supported */
233 unsigned int prefer_hp_amp
:1; /* enable HP amp for speaker if any */
234 unsigned int add_stereo_mix_input
:2; /* add aamix as a capture src */
235 unsigned int add_jack_modes
:1; /* add i/o jack mode enum ctls */
236 unsigned int power_down_unused
:1; /* power down unused widgets */
237 unsigned int dac_min_mute
:1; /* minimal = mute for DACs */
238 unsigned int suppress_vmaster
:1; /* don't create vmaster kctls */
240 /* other internal flags */
241 unsigned int no_analog
:1; /* digital I/O only */
242 unsigned int dyn_adc_switch
:1; /* switch ADCs (for ALC275) */
243 unsigned int indep_hp_enabled
:1; /* independent HP enabled */
244 unsigned int have_aamix_ctl
:1;
245 unsigned int hp_mic_jack_modes
:1;
247 /* additional mute flags (only effective with auto_mute_via_amp=1) */
250 /* bitmask for skipping volume controls */
253 /* badness tables for output path evaluations */
254 const struct badness_table
*main_out_badness
;
255 const struct badness_table
*extra_out_badness
;
257 /* preferred pin/DAC pairs; an array of paired NIDs */
258 const hda_nid_t
*preferred_dacs
;
260 /* loopback mixing mode */
266 /* for virtual master */
267 hda_nid_t vmaster_nid
;
268 unsigned int vmaster_tlv
[4];
269 struct hda_vmaster_mute_hook vmaster_mute
;
271 struct hda_loopback_check loopback
;
272 struct snd_array loopback_list
;
276 struct hda_multi_io multi_io
[4];
279 void (*init_hook
)(struct hda_codec
*codec
);
280 void (*automute_hook
)(struct hda_codec
*codec
);
281 void (*cap_sync_hook
)(struct hda_codec
*codec
,
282 struct snd_kcontrol
*kcontrol
,
283 struct snd_ctl_elem_value
*ucontrol
);
285 /* mic mute LED hook; called via cap_sync_hook */
286 struct hda_micmute_hook micmute_led
;
289 void (*pcm_playback_hook
)(struct hda_pcm_stream
*hinfo
,
290 struct hda_codec
*codec
,
291 struct snd_pcm_substream
*substream
,
293 void (*pcm_capture_hook
)(struct hda_pcm_stream
*hinfo
,
294 struct hda_codec
*codec
,
295 struct snd_pcm_substream
*substream
,
298 /* automute / autoswitch hooks */
299 void (*hp_automute_hook
)(struct hda_codec
*codec
,
300 struct hda_jack_callback
*cb
);
301 void (*line_automute_hook
)(struct hda_codec
*codec
,
302 struct hda_jack_callback
*cb
);
303 void (*mic_autoswitch_hook
)(struct hda_codec
*codec
,
304 struct hda_jack_callback
*cb
);
307 /* values for add_stereo_mix_input flag */
309 HDA_HINT_STEREO_MIX_DISABLE
, /* No stereo mix input */
310 HDA_HINT_STEREO_MIX_ENABLE
, /* Add stereo mix input */
311 HDA_HINT_STEREO_MIX_AUTO
, /* Add only if auto-mic is disabled */
314 int snd_hda_gen_spec_init(struct hda_gen_spec
*spec
);
316 int snd_hda_gen_init(struct hda_codec
*codec
);
317 void snd_hda_gen_free(struct hda_codec
*codec
);
319 int snd_hda_get_path_idx(struct hda_codec
*codec
, struct nid_path
*path
);
320 struct nid_path
*snd_hda_get_path_from_idx(struct hda_codec
*codec
, int idx
);
322 snd_hda_add_new_path(struct hda_codec
*codec
, hda_nid_t from_nid
,
323 hda_nid_t to_nid
, int anchor_nid
);
324 void snd_hda_activate_path(struct hda_codec
*codec
, struct nid_path
*path
,
325 bool enable
, bool add_aamix
);
327 struct snd_kcontrol_new
*
328 snd_hda_gen_add_kctl(struct hda_gen_spec
*spec
, const char *name
,
329 const struct snd_kcontrol_new
*temp
);
331 int snd_hda_gen_parse_auto_config(struct hda_codec
*codec
,
332 struct auto_pin_cfg
*cfg
);
333 int snd_hda_gen_build_controls(struct hda_codec
*codec
);
334 int snd_hda_gen_build_pcms(struct hda_codec
*codec
);
335 void snd_hda_gen_reboot_notify(struct hda_codec
*codec
);
337 /* standard jack event callbacks */
338 void snd_hda_gen_hp_automute(struct hda_codec
*codec
,
339 struct hda_jack_callback
*jack
);
340 void snd_hda_gen_line_automute(struct hda_codec
*codec
,
341 struct hda_jack_callback
*jack
);
342 void snd_hda_gen_mic_autoswitch(struct hda_codec
*codec
,
343 struct hda_jack_callback
*jack
);
344 void snd_hda_gen_update_outputs(struct hda_codec
*codec
);
347 int snd_hda_gen_check_power_status(struct hda_codec
*codec
, hda_nid_t nid
);
349 unsigned int snd_hda_gen_path_power_filter(struct hda_codec
*codec
,
351 unsigned int power_state
);
352 void snd_hda_gen_stream_pm(struct hda_codec
*codec
, hda_nid_t nid
, bool on
);
353 int snd_hda_gen_fix_pin_power(struct hda_codec
*codec
, hda_nid_t pin
);
355 int snd_hda_gen_add_micmute_led(struct hda_codec
*codec
,
356 void (*hook
)(struct hda_codec
*));
357 void snd_hda_gen_fixup_micmute_led(struct hda_codec
*codec
,
358 const struct hda_fixup
*fix
, int action
);
360 #endif /* __SOUND_HDA_GENERIC_H */