]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - sound/pci/hda/hda_generic.h
ALSA: hda - Export snd_hda_gen_add_kctl()
[mirror_ubuntu-jammy-kernel.git] / sound / pci / hda / hda_generic.h
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 /* unsol event tags */
16 enum {
17 HDA_GEN_HP_EVENT, HDA_GEN_FRONT_EVENT, HDA_GEN_MIC_EVENT,
18 HDA_GEN_LAST_EVENT = HDA_GEN_MIC_EVENT
19 };
20
21 /* table entry for multi-io paths */
22 struct hda_multi_io {
23 hda_nid_t pin; /* multi-io widget pin NID */
24 hda_nid_t dac; /* DAC to be connected */
25 unsigned int ctl_in; /* cached input-pin control value */
26 };
27
28 /* Widget connection path
29 *
30 * For output, stored in the order of DAC -> ... -> pin,
31 * for input, pin -> ... -> ADC.
32 *
33 * idx[i] contains the source index number to select on of the widget path[i];
34 * e.g. idx[1] is the index of the DAC (path[0]) selected by path[1] widget
35 * multi[] indicates whether it's a selector widget with multi-connectors
36 * (i.e. the connection selection is mandatory)
37 * vol_ctl and mute_ctl contains the NIDs for the assigned mixers
38 */
39
40 #define MAX_NID_PATH_DEPTH 5
41
42 enum {
43 NID_PATH_VOL_CTL,
44 NID_PATH_MUTE_CTL,
45 NID_PATH_BOOST_CTL,
46 NID_PATH_NUM_CTLS
47 };
48
49 struct nid_path {
50 int depth;
51 hda_nid_t path[MAX_NID_PATH_DEPTH];
52 unsigned char idx[MAX_NID_PATH_DEPTH];
53 unsigned char multi[MAX_NID_PATH_DEPTH];
54 unsigned int ctls[NID_PATH_NUM_CTLS]; /* NID_PATH_XXX_CTL */
55 bool active;
56 };
57
58 /* mic/line-in auto switching entry */
59
60 #define MAX_AUTO_MIC_PINS 3
61
62 struct automic_entry {
63 hda_nid_t pin; /* pin */
64 int idx; /* imux index, -1 = invalid */
65 unsigned int attr; /* pin attribute (INPUT_PIN_ATTR_*) */
66 };
67
68 struct hda_gen_spec {
69 char stream_name_analog[32]; /* analog PCM stream */
70 const struct hda_pcm_stream *stream_analog_playback;
71 const struct hda_pcm_stream *stream_analog_capture;
72 const struct hda_pcm_stream *stream_analog_alt_playback;
73 const struct hda_pcm_stream *stream_analog_alt_capture;
74
75 char stream_name_digital[32]; /* digital PCM stream */
76 const struct hda_pcm_stream *stream_digital_playback;
77 const struct hda_pcm_stream *stream_digital_capture;
78
79 /* playback */
80 struct hda_multi_out multiout; /* playback set-up
81 * max_channels, dacs must be set
82 * dig_out_nid and hp_nid are optional
83 */
84 hda_nid_t alt_dac_nid;
85 hda_nid_t slave_dig_outs[3]; /* optional - for auto-parsing */
86 int dig_out_type;
87
88 /* capture */
89 unsigned int num_adc_nids;
90 hda_nid_t adc_nids[AUTO_CFG_MAX_OUTS];
91 hda_nid_t dig_in_nid; /* digital-in NID; optional */
92 hda_nid_t mixer_nid; /* analog-mixer NID */
93
94 /* capture setup for dynamic dual-adc switch */
95 hda_nid_t cur_adc;
96 unsigned int cur_adc_stream_tag;
97 unsigned int cur_adc_format;
98
99 /* capture source */
100 struct hda_input_mux input_mux;
101 unsigned int cur_mux[3];
102
103 /* channel model */
104 const struct hda_channel_mode *channel_mode;
105 int num_channel_mode;
106 int const_channel_count; /* min. channel count (for speakers) */
107 int ext_channel_count; /* current channel count for multi-io */
108
109 /* PCM information */
110 struct hda_pcm pcm_rec[3]; /* used in build_pcms() */
111
112 /* dynamic controls, init_verbs and input_mux */
113 struct auto_pin_cfg autocfg;
114 struct snd_array kctls;
115 hda_nid_t private_dac_nids[AUTO_CFG_MAX_OUTS];
116 hda_nid_t imux_pins[HDA_MAX_NUM_INPUTS];
117 unsigned int dyn_adc_idx[HDA_MAX_NUM_INPUTS];
118 hda_nid_t shared_mic_vref_pin;
119
120 /* DAC list */
121 int num_all_dacs;
122 hda_nid_t all_dacs[16];
123
124 /* path list */
125 struct snd_array paths;
126
127 /* auto-mic stuff */
128 int am_num_entries;
129 struct automic_entry am_entry[MAX_AUTO_MIC_PINS];
130
131 /* for pin sensing */
132 unsigned int hp_jack_present:1;
133 unsigned int line_jack_present:1;
134 unsigned int master_mute:1;
135 unsigned int auto_mic:1;
136 unsigned int automute_speaker:1; /* automute speaker outputs */
137 unsigned int automute_lo:1; /* automute LO outputs */
138 unsigned int detect_hp:1; /* Headphone detection enabled */
139 unsigned int detect_lo:1; /* Line-out detection enabled */
140 unsigned int automute_speaker_possible:1; /* there are speakers and either LO or HP */
141 unsigned int automute_lo_possible:1; /* there are line outs and HP */
142 unsigned int keep_vref_in_automute:1; /* Don't clear VREF in automute */
143 unsigned int line_in_auto_switch:1; /* allow line-in auto switch */
144
145 /* other flags */
146 unsigned int need_dac_fix:1; /* need to limit DACs for multi channels */
147 unsigned int no_analog:1; /* digital I/O only */
148 unsigned int dyn_adc_switch:1; /* switch ADCs (for ALC275) */
149 unsigned int shared_mic_hp:1; /* HP/Mic-in sharing */
150 unsigned int no_primary_hp:1; /* Don't prefer HP pins to speaker pins */
151 unsigned int multi_cap_vol:1; /* allow multiple capture xxx volumes */
152 unsigned int inv_dmic_split:1; /* inverted dmic w/a for conexant */
153 unsigned int own_eapd_ctl:1; /* set EAPD by own function */
154
155 unsigned int parse_flags; /* passed to snd_hda_parse_pin_defcfg() */
156
157 /* for virtual master */
158 hda_nid_t vmaster_nid;
159 struct hda_vmaster_mute_hook vmaster_mute;
160 #ifdef CONFIG_PM
161 struct hda_loopback_check loopback;
162 int num_loopbacks;
163 struct hda_amp_list loopback_list[8];
164 #endif
165
166 /* multi-io */
167 int multi_ios;
168 struct hda_multi_io multi_io[4];
169
170 /* bind volumes */
171 struct snd_array bind_ctls;
172
173 /* hooks */
174 void (*init_hook)(struct hda_codec *codec);
175 void (*automute_hook)(struct hda_codec *codec);
176 void (*cap_sync_hook)(struct hda_codec *codec);
177 };
178
179 int snd_hda_gen_spec_init(struct hda_gen_spec *spec);
180 void snd_hda_gen_spec_free(struct hda_gen_spec *spec);
181
182 int snd_hda_gen_init(struct hda_codec *codec);
183
184 struct nid_path *snd_hda_get_nid_path(struct hda_codec *codec,
185 hda_nid_t from_nid, hda_nid_t to_nid);
186 bool snd_hda_parse_nid_path(struct hda_codec *codec, hda_nid_t from_nid,
187 hda_nid_t to_nid, int with_aa_mix,
188 struct nid_path *path);
189 struct nid_path *
190 snd_hda_add_new_path(struct hda_codec *codec, hda_nid_t from_nid,
191 hda_nid_t to_nid, int with_aa_mix);
192 void snd_hda_activate_path(struct hda_codec *codec, struct nid_path *path,
193 bool enable, bool add_aamix);
194
195 struct snd_kcontrol_new *
196 snd_hda_gen_add_kctl(struct hda_gen_spec *spec, const char *name,
197 const struct snd_kcontrol_new *temp);
198
199 int snd_hda_gen_parse_auto_config(struct hda_codec *codec,
200 const hda_nid_t *ignore_nids);
201 int snd_hda_gen_build_controls(struct hda_codec *codec);
202 int snd_hda_gen_build_pcms(struct hda_codec *codec);
203
204 #endif /* __SOUND_HDA_GENERIC_H */