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 */ 16struct 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 36enum { 37 NID_PATH_VOL_CTL, 38 NID_PATH_MUTE_CTL, 39 NID_PATH_BOOST_CTL, 40 NID_PATH_NUM_CTLS 41}; 42 43struct 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 59struct 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 */ 66enum { STREAM_MULTI_OUT, STREAM_INDEP_HP }; 67 68/* PCM hook action */ 69enum { 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 */ 77struct 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 86extern const struct badness_table hda_main_out_badness; 87extern const struct badness_table hda_extra_out_badness; 88 89struct 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 233 /* other internal flags */ 234 unsigned int no_analog:1; /* digital I/O only */ 235 unsigned int dyn_adc_switch:1; /* switch ADCs (for ALC275) */ 236 unsigned int indep_hp_enabled:1; /* independent HP enabled */ 237 unsigned int have_aamix_ctl:1; 238 unsigned int hp_mic_jack_modes:1; 239 240 /* additional mute flags (only effective with auto_mute_via_amp=1) */ 241 u64 mute_bits; 242 243 /* bitmask for skipping volume controls */ 244 u64 out_vol_mask; 245 246 /* badness tables for output path evaluations */ 247 const struct badness_table *main_out_badness; 248 const struct badness_table *extra_out_badness; 249 250 /* preferred pin/DAC pairs; an array of paired NIDs */ 251 const hda_nid_t *preferred_dacs; 252 253 /* loopback mixing mode */ 254 bool aamix_mode; 255 256 /* digital beep */ 257 hda_nid_t beep_nid; 258 259 /* for virtual master */ 260 hda_nid_t vmaster_nid; 261 unsigned int vmaster_tlv[4]; 262 struct hda_vmaster_mute_hook vmaster_mute; 263 264 struct hda_loopback_check loopback; 265 struct snd_array loopback_list; 266 267 /* multi-io */ 268 int multi_ios; 269 struct hda_multi_io multi_io[4]; 270 271 /* hooks */ 272 void (*init_hook)(struct hda_codec *codec); 273 void (*automute_hook)(struct hda_codec *codec); 274 void (*cap_sync_hook)(struct hda_codec *codec, 275 struct snd_kcontrol *kcontrol, 276 struct snd_ctl_elem_value *ucontrol); 277 278 /* PCM hooks */ 279 void (*pcm_playback_hook)(struct hda_pcm_stream *hinfo, 280 struct hda_codec *codec, 281 struct snd_pcm_substream *substream, 282 int action); 283 void (*pcm_capture_hook)(struct hda_pcm_stream *hinfo, 284 struct hda_codec *codec, 285 struct snd_pcm_substream *substream, 286 int action); 287 288 /* automute / autoswitch hooks */ 289 void (*hp_automute_hook)(struct hda_codec *codec, 290 struct hda_jack_callback *cb); 291 void (*line_automute_hook)(struct hda_codec *codec, 292 struct hda_jack_callback *cb); 293 void (*mic_autoswitch_hook)(struct hda_codec *codec, 294 struct hda_jack_callback *cb); 295}; 296 297/* values for add_stereo_mix_input flag */ 298enum { 299 HDA_HINT_STEREO_MIX_DISABLE, /* No stereo mix input */ 300 HDA_HINT_STEREO_MIX_ENABLE, /* Add stereo mix input */ 301 HDA_HINT_STEREO_MIX_AUTO, /* Add only if auto-mic is disabled */ 302}; 303 304int snd_hda_gen_spec_init(struct hda_gen_spec *spec); 305 306int snd_hda_gen_init(struct hda_codec *codec); 307void snd_hda_gen_free(struct hda_codec *codec); 308 309struct nid_path *snd_hda_get_nid_path(struct hda_codec *codec, 310 hda_nid_t from_nid, hda_nid_t to_nid); 311int snd_hda_get_path_idx(struct hda_codec *codec, struct nid_path *path); 312struct nid_path *snd_hda_get_path_from_idx(struct hda_codec *codec, int idx); 313bool snd_hda_parse_nid_path(struct hda_codec *codec, hda_nid_t from_nid, 314 hda_nid_t to_nid, int anchor_nid, 315 struct nid_path *path); 316struct nid_path * 317snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid, 318 hda_nid_t to_nid, int anchor_nid); 319void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path, 320 bool enable, bool add_aamix); 321 322struct snd_kcontrol_new * 323snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name, 324 const struct snd_kcontrol_new *temp); 325 326int snd_hda_gen_parse_auto_config(struct hda_codec *codec, 327 struct auto_pin_cfg *cfg); 328int snd_hda_gen_build_controls(struct hda_codec *codec); 329int snd_hda_gen_build_pcms(struct hda_codec *codec); 330 331/* standard jack event callbacks */ 332void snd_hda_gen_hp_automute(struct hda_codec *codec, 333 struct hda_jack_callback *jack); 334void snd_hda_gen_line_automute(struct hda_codec *codec, 335 struct hda_jack_callback *jack); 336void snd_hda_gen_mic_autoswitch(struct hda_codec *codec, 337 struct hda_jack_callback *jack); 338void snd_hda_gen_update_outputs(struct hda_codec *codec); 339 340#ifdef CONFIG_PM 341int snd_hda_gen_check_power_status(struct hda_codec *codec, hda_nid_t nid); 342#endif 343unsigned int snd_hda_gen_path_power_filter(struct hda_codec *codec, 344 hda_nid_t nid, 345 unsigned int power_state); 346void snd_hda_gen_stream_pm(struct hda_codec *codec, hda_nid_t nid, bool on); 347int snd_hda_gen_fix_pin_power(struct hda_codec *codec, hda_nid_t pin); 348 349#endif /* __SOUND_HDA_GENERIC_H */ 350