xref: /openbmc/linux/sound/pci/hda/hda_local.h (revision d01ce99f)
1 /*
2  * Universal Interface for Intel High Definition Audio Codec
3  *
4  * Local helper functions
5  *
6  * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
7  *
8  *  This program is free software; you can redistribute it and/or modify it
9  *  under the terms of the GNU General Public License as published by the Free
10  *  Software Foundation; either version 2 of the License, or (at your option)
11  *  any later version.
12  *
13  *  This program is distributed in the hope that it will be useful, but WITHOUT
14  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
16  *  more details.
17  *
18  *  You should have received a copy of the GNU General Public License along with
19  *  this program; if not, write to the Free Software Foundation, Inc., 59
20  *  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  */
22 
23 #ifndef __SOUND_HDA_LOCAL_H
24 #define __SOUND_HDA_LOCAL_H
25 
26 /*
27  * for mixer controls
28  */
29 #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
30 	((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19))
31 /* mono volume with index (index=0,1,...) (channel=1,2) */
32 #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
33 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx,  \
34 	  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
35 	  	    SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
36 	  	    SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
37 	  .info = snd_hda_mixer_amp_volume_info, \
38 	  .get = snd_hda_mixer_amp_volume_get, \
39 	  .put = snd_hda_mixer_amp_volume_put, \
40 	  .tlv = { .c = snd_hda_mixer_amp_tlv },		\
41 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
42 /* stereo volume with index */
43 #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
44 	HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
45 /* mono volume */
46 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
47 	HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction)
48 /* stereo volume */
49 #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
50 	HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
51 /* mono mute switch with index (index=0,1,...) (channel=1,2) */
52 #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
53 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
54 	  .info = snd_hda_mixer_amp_switch_info, \
55 	  .get = snd_hda_mixer_amp_switch_get, \
56 	  .put = snd_hda_mixer_amp_switch_put, \
57 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
58 /* stereo mute switch with index */
59 #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
60 	HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
61 /* mono mute switch */
62 #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
63 	HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
64 /* stereo mute switch */
65 #define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
66 	HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
67 
68 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
69 				  struct snd_ctl_elem_info *uinfo);
70 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
71 				 struct snd_ctl_elem_value *ucontrol);
72 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
73 				 struct snd_ctl_elem_value *ucontrol);
74 int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
75 			  unsigned int size, unsigned int __user *tlv);
76 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
77 				  struct snd_ctl_elem_info *uinfo);
78 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
79 				 struct snd_ctl_elem_value *ucontrol);
80 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
81 				 struct snd_ctl_elem_value *ucontrol);
82 /* lowlevel accessor with caching; use carefully */
83 int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
84 			   int direction, int index);
85 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
86 			     int direction, int idx, int mask, int val);
87 
88 /* mono switch binding multiple inputs */
89 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
90 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
91 	  .info = snd_hda_mixer_amp_switch_info, \
92 	  .get = snd_hda_mixer_bind_switch_get, \
93 	  .put = snd_hda_mixer_bind_switch_put, \
94 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
95 
96 /* stereo switch binding multiple inputs */
97 #define HDA_BIND_MUTE(xname,nid,indices,dir) \
98 	HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
99 
100 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
101 				  struct snd_ctl_elem_value *ucontrol);
102 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
103 				  struct snd_ctl_elem_value *ucontrol);
104 
105 int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid);
106 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
107 
108 /*
109  * input MUX helper
110  */
111 #define HDA_MAX_NUM_INPUTS	16
112 struct hda_input_mux_item {
113 	const char *label;
114 	unsigned int index;
115 };
116 struct hda_input_mux {
117 	unsigned int num_items;
118 	struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
119 };
120 
121 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
122 			   struct snd_ctl_elem_info *uinfo);
123 int snd_hda_input_mux_put(struct hda_codec *codec,
124 			  const struct hda_input_mux *imux,
125 			  struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
126 			  unsigned int *cur_val);
127 
128 /*
129  * Channel mode helper
130  */
131 struct hda_channel_mode {
132 	int channels;
133 	const struct hda_verb *sequence;
134 };
135 
136 int snd_hda_ch_mode_info(struct hda_codec *codec,
137 			 struct snd_ctl_elem_info *uinfo,
138 			 const struct hda_channel_mode *chmode,
139 			 int num_chmodes);
140 int snd_hda_ch_mode_get(struct hda_codec *codec,
141 			struct snd_ctl_elem_value *ucontrol,
142 			const struct hda_channel_mode *chmode,
143 			int num_chmodes,
144 			int max_channels);
145 int snd_hda_ch_mode_put(struct hda_codec *codec,
146 			struct snd_ctl_elem_value *ucontrol,
147 			const struct hda_channel_mode *chmode,
148 			int num_chmodes,
149 			int *max_channelsp);
150 
151 /*
152  * Multi-channel / digital-out PCM helper
153  */
154 
155 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
156 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
157 
158 struct hda_multi_out {
159 	int num_dacs;		/* # of DACs, must be more than 1 */
160 	hda_nid_t *dac_nids;	/* DAC list */
161 	hda_nid_t hp_nid;	/* optional DAC for HP, 0 when not exists */
162 	hda_nid_t extra_out_nid[3];	/* optional DACs, 0 when not exists */
163 	hda_nid_t dig_out_nid;	/* digital out audio widget */
164 	int max_channels;	/* currently supported analog channels */
165 	int dig_out_used;	/* current usage of digital out (HDA_DIG_XXX) */
166 };
167 
168 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
169 			       struct hda_multi_out *mout);
170 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
171 				struct hda_multi_out *mout);
172 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
173 				  struct hda_multi_out *mout,
174 				  unsigned int stream_tag,
175 				  unsigned int format,
176 				  struct snd_pcm_substream *substream);
177 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
178 				  struct hda_multi_out *mout,
179 				  struct snd_pcm_substream *substream);
180 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
181 				     struct hda_multi_out *mout,
182 				     unsigned int stream_tag,
183 				     unsigned int format,
184 				     struct snd_pcm_substream *substream);
185 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
186 				     struct hda_multi_out *mout);
187 
188 /*
189  * generic codec parser
190  */
191 int snd_hda_parse_generic_codec(struct hda_codec *codec);
192 
193 /*
194  * generic proc interface
195  */
196 #ifdef CONFIG_PROC_FS
197 int snd_hda_codec_proc_new(struct hda_codec *codec);
198 #else
199 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
200 #endif
201 
202 /*
203  * Misc
204  */
205 int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
206 			       const char **modelnames,
207 			       const struct snd_pci_quirk *pci_list);
208 int snd_hda_add_new_ctls(struct hda_codec *codec,
209 			 struct snd_kcontrol_new *knew);
210 
211 /*
212  * power management
213  */
214 #ifdef CONFIG_PM
215 int snd_hda_resume_ctls(struct hda_codec *codec, struct snd_kcontrol_new *knew);
216 int snd_hda_resume_spdif_out(struct hda_codec *codec);
217 int snd_hda_resume_spdif_in(struct hda_codec *codec);
218 #endif
219 
220 /*
221  * unsolicited event handler
222  */
223 
224 #define HDA_UNSOL_QUEUE_SIZE	64
225 
226 struct hda_bus_unsolicited {
227 	/* ring buffer */
228 	u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
229 	unsigned int rp, wp;
230 
231 	/* workqueue */
232 	struct work_struct work;
233 	struct hda_bus *bus;
234 };
235 
236 /*
237  * Helper for automatic ping configuration
238  */
239 
240 enum {
241 	AUTO_PIN_MIC,
242 	AUTO_PIN_FRONT_MIC,
243 	AUTO_PIN_LINE,
244 	AUTO_PIN_FRONT_LINE,
245 	AUTO_PIN_CD,
246 	AUTO_PIN_AUX,
247 	AUTO_PIN_LAST
248 };
249 
250 enum {
251 	AUTO_PIN_LINE_OUT,
252 	AUTO_PIN_SPEAKER_OUT,
253 	AUTO_PIN_HP_OUT
254 };
255 
256 extern const char *auto_pin_cfg_labels[AUTO_PIN_LAST];
257 
258 struct auto_pin_cfg {
259 	int line_outs;
260 	hda_nid_t line_out_pins[5]; /* sorted in the order of
261 				     * Front/Surr/CLFE/Side
262 				     */
263 	int speaker_outs;
264 	hda_nid_t speaker_pins[5];
265 	int hp_outs;
266 	int line_out_type;	/* AUTO_PIN_XXX_OUT */
267 	hda_nid_t hp_pins[5];
268 	hda_nid_t input_pins[AUTO_PIN_LAST];
269 	hda_nid_t dig_out_pin;
270 	hda_nid_t dig_in_pin;
271 };
272 
273 #define get_defcfg_connect(cfg) \
274 	((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
275 #define get_defcfg_association(cfg) \
276 	((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
277 #define get_defcfg_location(cfg) \
278 	((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
279 #define get_defcfg_sequence(cfg) \
280 	(cfg & AC_DEFCFG_SEQUENCE)
281 #define get_defcfg_device(cfg) \
282 	((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
283 
284 int snd_hda_parse_pin_def_config(struct hda_codec *codec,
285 				 struct auto_pin_cfg *cfg,
286 				 hda_nid_t *ignore_nids);
287 
288 /* amp values */
289 #define AMP_IN_MUTE(idx)	(0x7080 | ((idx)<<8))
290 #define AMP_IN_UNMUTE(idx)	(0x7000 | ((idx)<<8))
291 #define AMP_OUT_MUTE	0xb080
292 #define AMP_OUT_UNMUTE	0xb000
293 #define AMP_OUT_ZERO	0xb000
294 /* pinctl values */
295 #define PIN_IN		0x20
296 #define PIN_VREF80	0x24
297 #define PIN_VREF50	0x21
298 #define PIN_OUT		0x40
299 #define PIN_HP		0xc0
300 #define PIN_HP_AMP	0x80
301 
302 /*
303  * get widget capabilities
304  */
305 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
306 {
307 	if (nid < codec->start_nid ||
308 	    nid >= codec->start_nid + codec->num_nodes)
309 		return snd_hda_param_read(codec, nid, AC_PAR_AUDIO_WIDGET_CAP);
310 	return codec->wcaps[nid - codec->start_nid];
311 }
312 
313 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
314 			      unsigned int caps);
315 
316 #endif /* __SOUND_HDA_LOCAL_H */
317