xref: /linux/sound/pci/hda/hda_local.h (revision 3932b9ca55b0be314a36d3e84faff3e823c081f5)
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 /* We abuse kcontrol_new.subdev field to pass the NID corresponding to
27  * the given new control.  If id.subdev has a bit flag HDA_SUBDEV_NID_FLAG,
28  * snd_hda_ctl_add() takes the lower-bit subdev value as a valid NID.
29  *
30  * Note that the subdevice field is cleared again before the real registration
31  * in snd_hda_ctl_add(), so that this value won't appear in the outside.
32  */
33 #define HDA_SUBDEV_NID_FLAG	(1U << 31)
34 #define HDA_SUBDEV_AMP_FLAG	(1U << 30)
35 
36 /*
37  * for mixer controls
38  */
39 #define HDA_COMPOSE_AMP_VAL_OFS(nid,chs,idx,dir,ofs)		\
40 	((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19) | ((ofs)<<23))
41 #define HDA_AMP_VAL_MIN_MUTE (1<<29)
42 #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
43 	HDA_COMPOSE_AMP_VAL_OFS(nid, chs, idx, dir, 0)
44 /* mono volume with index (index=0,1,...) (channel=1,2) */
45 #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, dir, flags) \
46 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx,  \
47 	  .subdevice = HDA_SUBDEV_AMP_FLAG, \
48 	  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
49 	  	    SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
50 	  	    SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
51 	  .info = snd_hda_mixer_amp_volume_info, \
52 	  .get = snd_hda_mixer_amp_volume_get, \
53 	  .put = snd_hda_mixer_amp_volume_put, \
54 	  .tlv = { .c = snd_hda_mixer_amp_tlv },		\
55 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, dir) | flags }
56 /* stereo volume with index */
57 #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
58 	HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction, 0)
59 /* mono volume */
60 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
61 	HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction, 0)
62 /* stereo volume */
63 #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
64 	HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
65 /* stereo volume with min=mute */
66 #define HDA_CODEC_VOLUME_MIN_MUTE(xname, nid, xindex, direction) \
67 	HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, 3, xindex, direction, \
68 				  HDA_AMP_VAL_MIN_MUTE)
69 /* mono mute switch with index (index=0,1,...) (channel=1,2) */
70 #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
71 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
72 	  .subdevice = HDA_SUBDEV_AMP_FLAG, \
73 	  .info = snd_hda_mixer_amp_switch_info, \
74 	  .get = snd_hda_mixer_amp_switch_get, \
75 	  .put = snd_hda_mixer_amp_switch_put, \
76 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
77 /* stereo mute switch with index */
78 #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
79 	HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
80 /* mono mute switch */
81 #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
82 	HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
83 /* stereo mute switch */
84 #define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
85 	HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
86 #ifdef CONFIG_SND_HDA_INPUT_BEEP
87 /* special beep mono mute switch with index (index=0,1,...) (channel=1,2) */
88 #define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
89 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
90 	  .subdevice = HDA_SUBDEV_AMP_FLAG, \
91 	  .info = snd_hda_mixer_amp_switch_info, \
92 	  .get = snd_hda_mixer_amp_switch_get_beep, \
93 	  .put = snd_hda_mixer_amp_switch_put_beep, \
94 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
95 #else
96 /* no digital beep - just the standard one */
97 #define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, ch, xidx, dir) \
98 	HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, ch, xidx, dir)
99 #endif /* CONFIG_SND_HDA_INPUT_BEEP */
100 /* special beep mono mute switch */
101 #define HDA_CODEC_MUTE_BEEP_MONO(xname, nid, channel, xindex, direction) \
102 	HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, 0, nid, channel, xindex, direction)
103 /* special beep stereo mute switch */
104 #define HDA_CODEC_MUTE_BEEP(xname, nid, xindex, direction) \
105 	HDA_CODEC_MUTE_BEEP_MONO(xname, nid, 3, xindex, direction)
106 
107 extern const char *snd_hda_pcm_type_name[];
108 
109 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
110 				  struct snd_ctl_elem_info *uinfo);
111 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
112 				 struct snd_ctl_elem_value *ucontrol);
113 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
114 				 struct snd_ctl_elem_value *ucontrol);
115 int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
116 			  unsigned int size, unsigned int __user *tlv);
117 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
118 				  struct snd_ctl_elem_info *uinfo);
119 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
120 				 struct snd_ctl_elem_value *ucontrol);
121 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
122 				 struct snd_ctl_elem_value *ucontrol);
123 #ifdef CONFIG_SND_HDA_INPUT_BEEP
124 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
125 				      struct snd_ctl_elem_value *ucontrol);
126 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
127 				      struct snd_ctl_elem_value *ucontrol);
128 #endif
129 /* lowlevel accessor with caching; use carefully */
130 int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
131 			   int direction, int index);
132 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
133 			     int direction, int idx, int mask, int val);
134 int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
135 			     int dir, int idx, int mask, int val);
136 int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch,
137 			   int direction, int idx, int mask, int val);
138 int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid,
139 				  int dir, int idx, int mask, int val);
140 void snd_hda_codec_resume_amp(struct hda_codec *codec);
141 
142 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
143 			     unsigned int *tlv);
144 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
145 					    const char *name);
146 int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
147 			  unsigned int *tlv, const char * const *slaves,
148 			  const char *suffix, bool init_slave_vol,
149 			  struct snd_kcontrol **ctl_ret);
150 #define snd_hda_add_vmaster(codec, name, tlv, slaves, suffix) \
151 	__snd_hda_add_vmaster(codec, name, tlv, slaves, suffix, true, NULL)
152 int snd_hda_codec_reset(struct hda_codec *codec);
153 
154 enum {
155 	HDA_VMUTE_OFF,
156 	HDA_VMUTE_ON,
157 	HDA_VMUTE_FOLLOW_MASTER,
158 };
159 
160 struct hda_vmaster_mute_hook {
161 	/* below two fields must be filled by the caller of
162 	 * snd_hda_add_vmaster_hook() beforehand
163 	 */
164 	struct snd_kcontrol *sw_kctl;
165 	void (*hook)(void *, int);
166 	/* below are initialized automatically */
167 	unsigned int mute_mode; /* HDA_VMUTE_XXX */
168 	struct hda_codec *codec;
169 };
170 
171 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
172 			     struct hda_vmaster_mute_hook *hook,
173 			     bool expose_enum_ctl);
174 void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
175 
176 /* amp value bits */
177 #define HDA_AMP_MUTE	0x80
178 #define HDA_AMP_UNMUTE	0x00
179 #define HDA_AMP_VOLMASK	0x7f
180 
181 /* mono switch binding multiple inputs */
182 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
183 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
184 	  .info = snd_hda_mixer_amp_switch_info, \
185 	  .get = snd_hda_mixer_bind_switch_get, \
186 	  .put = snd_hda_mixer_bind_switch_put, \
187 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
188 
189 /* stereo switch binding multiple inputs */
190 #define HDA_BIND_MUTE(xname,nid,indices,dir) \
191 	HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
192 
193 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
194 				  struct snd_ctl_elem_value *ucontrol);
195 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
196 				  struct snd_ctl_elem_value *ucontrol);
197 
198 /* more generic bound controls */
199 struct hda_ctl_ops {
200 	snd_kcontrol_info_t *info;
201 	snd_kcontrol_get_t *get;
202 	snd_kcontrol_put_t *put;
203 	snd_kcontrol_tlv_rw_t *tlv;
204 };
205 
206 extern struct hda_ctl_ops snd_hda_bind_vol;	/* for bind-volume with TLV */
207 extern struct hda_ctl_ops snd_hda_bind_sw;	/* for bind-switch */
208 
209 struct hda_bind_ctls {
210 	struct hda_ctl_ops *ops;
211 	unsigned long values[];
212 };
213 
214 int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
215 				 struct snd_ctl_elem_info *uinfo);
216 int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
217 				struct snd_ctl_elem_value *ucontrol);
218 int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
219 				struct snd_ctl_elem_value *ucontrol);
220 int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
221 			   unsigned int size, unsigned int __user *tlv);
222 
223 #define HDA_BIND_VOL(xname, bindrec) \
224 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
225 	  .name = xname, \
226 	  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
227 			  SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
228 			  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
229 	  .info = snd_hda_mixer_bind_ctls_info,\
230 	  .get =  snd_hda_mixer_bind_ctls_get,\
231 	  .put = snd_hda_mixer_bind_ctls_put,\
232 	  .tlv = { .c = snd_hda_mixer_bind_tlv },\
233 	  .private_value = (long) (bindrec) }
234 #define HDA_BIND_SW(xname, bindrec) \
235 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
236 	  .name = xname, \
237 	  .info = snd_hda_mixer_bind_ctls_info,\
238 	  .get =  snd_hda_mixer_bind_ctls_get,\
239 	  .put = snd_hda_mixer_bind_ctls_put,\
240 	  .private_value = (long) (bindrec) }
241 
242 /*
243  * SPDIF I/O
244  */
245 int snd_hda_create_dig_out_ctls(struct hda_codec *codec,
246 				hda_nid_t associated_nid,
247 				hda_nid_t cvt_nid, int type);
248 #define snd_hda_create_spdif_out_ctls(codec, anid, cnid) \
249 	snd_hda_create_dig_out_ctls(codec, anid, cnid, HDA_PCM_TYPE_SPDIF)
250 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
251 
252 /*
253  * input MUX helper
254  */
255 #define HDA_MAX_NUM_INPUTS	16
256 struct hda_input_mux_item {
257 	char label[32];
258 	unsigned int index;
259 };
260 struct hda_input_mux {
261 	unsigned int num_items;
262 	struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
263 };
264 
265 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
266 			   struct snd_ctl_elem_info *uinfo);
267 int snd_hda_input_mux_put(struct hda_codec *codec,
268 			  const struct hda_input_mux *imux,
269 			  struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
270 			  unsigned int *cur_val);
271 int snd_hda_add_imux_item(struct hda_codec *codec,
272 			  struct hda_input_mux *imux, const char *label,
273 			  int index, int *type_index_ret);
274 
275 /*
276  * Channel mode helper
277  */
278 struct hda_channel_mode {
279 	int channels;
280 	const struct hda_verb *sequence;
281 };
282 
283 int snd_hda_ch_mode_info(struct hda_codec *codec,
284 			 struct snd_ctl_elem_info *uinfo,
285 			 const struct hda_channel_mode *chmode,
286 			 int num_chmodes);
287 int snd_hda_ch_mode_get(struct hda_codec *codec,
288 			struct snd_ctl_elem_value *ucontrol,
289 			const struct hda_channel_mode *chmode,
290 			int num_chmodes,
291 			int max_channels);
292 int snd_hda_ch_mode_put(struct hda_codec *codec,
293 			struct snd_ctl_elem_value *ucontrol,
294 			const struct hda_channel_mode *chmode,
295 			int num_chmodes,
296 			int *max_channelsp);
297 
298 /*
299  * Multi-channel / digital-out PCM helper
300  */
301 
302 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
303 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
304 
305 #define HDA_MAX_OUTS	5
306 
307 struct hda_multi_out {
308 	int num_dacs;		/* # of DACs, must be more than 1 */
309 	const hda_nid_t *dac_nids;	/* DAC list */
310 	hda_nid_t hp_nid;	/* optional DAC for HP, 0 when not exists */
311 	hda_nid_t hp_out_nid[HDA_MAX_OUTS];	/* DACs for multiple HPs */
312 	hda_nid_t extra_out_nid[HDA_MAX_OUTS];	/* other (e.g. speaker) DACs */
313 	hda_nid_t dig_out_nid;	/* digital out audio widget */
314 	const hda_nid_t *slave_dig_outs;
315 	int max_channels;	/* currently supported analog channels */
316 	int dig_out_used;	/* current usage of digital out (HDA_DIG_XXX) */
317 	int no_share_stream;	/* don't share a stream with multiple pins */
318 	int share_spdif;	/* share SPDIF pin */
319 	/* PCM information for both analog and SPDIF DACs */
320 	unsigned int analog_rates;
321 	unsigned int analog_maxbps;
322 	u64 analog_formats;
323 	unsigned int spdif_rates;
324 	unsigned int spdif_maxbps;
325 	u64 spdif_formats;
326 };
327 
328 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
329 				  struct hda_multi_out *mout);
330 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
331 			       struct hda_multi_out *mout);
332 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
333 				struct hda_multi_out *mout);
334 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
335 				  struct hda_multi_out *mout,
336 				  unsigned int stream_tag,
337 				  unsigned int format,
338 				  struct snd_pcm_substream *substream);
339 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
340 				  struct hda_multi_out *mout);
341 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
342 				  struct hda_multi_out *mout,
343 				  struct snd_pcm_substream *substream,
344 				  struct hda_pcm_stream *hinfo);
345 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
346 				     struct hda_multi_out *mout,
347 				     unsigned int stream_tag,
348 				     unsigned int format,
349 				     struct snd_pcm_substream *substream);
350 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
351 				     struct hda_multi_out *mout);
352 
353 /*
354  * generic codec parser
355  */
356 int snd_hda_parse_generic_codec(struct hda_codec *codec);
357 int snd_hda_parse_hdmi_codec(struct hda_codec *codec);
358 
359 /*
360  * generic proc interface
361  */
362 #ifdef CONFIG_PROC_FS
363 int snd_hda_codec_proc_new(struct hda_codec *codec);
364 #else
365 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
366 #endif
367 
368 #define SND_PRINT_BITS_ADVISED_BUFSIZE	16
369 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
370 
371 /*
372  * Misc
373  */
374 int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
375 			       const char * const *modelnames,
376 			       const struct snd_pci_quirk *pci_list);
377 int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
378                                int num_configs, const char * const *models,
379                                const struct snd_pci_quirk *tbl);
380 int snd_hda_add_new_ctls(struct hda_codec *codec,
381 			 const struct snd_kcontrol_new *knew);
382 
383 /*
384  * Fix-up pin default configurations and add default verbs
385  */
386 
387 struct hda_pintbl {
388 	hda_nid_t nid;
389 	u32 val;
390 };
391 
392 struct hda_model_fixup {
393 	const int id;
394 	const char *name;
395 };
396 
397 struct hda_fixup {
398 	int type;
399 	bool chained:1;		/* call the chained fixup(s) after this */
400 	bool chained_before:1;	/* call the chained fixup(s) before this */
401 	int chain_id;
402 	union {
403 		const struct hda_pintbl *pins;
404 		const struct hda_verb *verbs;
405 		void (*func)(struct hda_codec *codec,
406 			     const struct hda_fixup *fix,
407 			     int action);
408 	} v;
409 };
410 
411 struct snd_hda_pin_quirk {
412 	unsigned int codec;             /* Codec vendor/device ID */
413 	unsigned short subvendor;	/* PCI subvendor ID */
414 	const struct hda_pintbl *pins;  /* list of matching pins */
415 #ifdef CONFIG_SND_DEBUG_VERBOSE
416 	const char *name;
417 #endif
418 	int value;			/* quirk value */
419 };
420 
421 #ifdef CONFIG_SND_DEBUG_VERBOSE
422 
423 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
424 	{ .codec = _codec,\
425 	  .subvendor = _subvendor,\
426 	  .name = _name,\
427 	  .value = _value,\
428 	  .pins = (const struct hda_pintbl[]) { _pins } \
429 	}
430 #else
431 
432 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
433 	{ .codec = _codec,\
434 	  .subvendor = _subvendor,\
435 	  .value = _value,\
436 	  .pins = (const struct hda_pintbl[]) { _pins } \
437 	}
438 
439 #endif
440 
441 #define HDA_FIXUP_ID_NOT_SET -1
442 #define HDA_FIXUP_ID_NO_FIXUP -2
443 
444 /* fixup types */
445 enum {
446 	HDA_FIXUP_INVALID,
447 	HDA_FIXUP_PINS,
448 	HDA_FIXUP_VERBS,
449 	HDA_FIXUP_FUNC,
450 	HDA_FIXUP_PINCTLS,
451 };
452 
453 /* fixup action definitions */
454 enum {
455 	HDA_FIXUP_ACT_PRE_PROBE,
456 	HDA_FIXUP_ACT_PROBE,
457 	HDA_FIXUP_ACT_INIT,
458 	HDA_FIXUP_ACT_BUILD,
459 	HDA_FIXUP_ACT_FREE,
460 };
461 
462 int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
463 void snd_hda_apply_verbs(struct hda_codec *codec);
464 void snd_hda_apply_pincfgs(struct hda_codec *codec,
465 			   const struct hda_pintbl *cfg);
466 void snd_hda_apply_fixup(struct hda_codec *codec, int action);
467 void snd_hda_pick_fixup(struct hda_codec *codec,
468 			const struct hda_model_fixup *models,
469 			const struct snd_pci_quirk *quirk,
470 			const struct hda_fixup *fixlist);
471 void snd_hda_pick_pin_fixup(struct hda_codec *codec,
472 			    const struct snd_hda_pin_quirk *pin_quirk,
473 			    const struct hda_fixup *fixlist);
474 
475 
476 /*
477  * unsolicited event handler
478  */
479 
480 #define HDA_UNSOL_QUEUE_SIZE	64
481 
482 struct hda_bus_unsolicited {
483 	/* ring buffer */
484 	u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
485 	unsigned int rp, wp;
486 
487 	/* workqueue */
488 	struct work_struct work;
489 	struct hda_bus *bus;
490 };
491 
492 /* helper macros to retrieve pin default-config values */
493 #define get_defcfg_connect(cfg) \
494 	((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
495 #define get_defcfg_association(cfg) \
496 	((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
497 #define get_defcfg_location(cfg) \
498 	((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
499 #define get_defcfg_sequence(cfg) \
500 	(cfg & AC_DEFCFG_SEQUENCE)
501 #define get_defcfg_device(cfg) \
502 	((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
503 #define get_defcfg_misc(cfg) \
504 	((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
505 
506 /* amp values */
507 #define AMP_IN_MUTE(idx)	(0x7080 | ((idx)<<8))
508 #define AMP_IN_UNMUTE(idx)	(0x7000 | ((idx)<<8))
509 #define AMP_OUT_MUTE		0xb080
510 #define AMP_OUT_UNMUTE		0xb000
511 #define AMP_OUT_ZERO		0xb000
512 /* pinctl values */
513 #define PIN_IN			(AC_PINCTL_IN_EN)
514 #define PIN_VREFHIZ		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
515 #define PIN_VREF50		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
516 #define PIN_VREFGRD		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
517 #define PIN_VREF80		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
518 #define PIN_VREF100		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
519 #define PIN_OUT			(AC_PINCTL_OUT_EN)
520 #define PIN_HP			(AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
521 #define PIN_HP_AMP		(AC_PINCTL_HP_EN)
522 
523 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
524 unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
525 				     hda_nid_t pin, unsigned int val);
526 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
527 			 unsigned int val, bool cached);
528 
529 /**
530  * _snd_hda_set_pin_ctl - Set a pin-control value safely
531  * @codec: the codec instance
532  * @pin: the pin NID to set the control
533  * @val: the pin-control value (AC_PINCTL_* bits)
534  *
535  * This function sets the pin-control value to the given pin, but
536  * filters out the invalid pin-control bits when the pin has no such
537  * capabilities.  For example, when PIN_HP is passed but the pin has no
538  * HP-drive capability, the HP bit is omitted.
539  *
540  * The function doesn't check the input VREF capability bits, though.
541  * Use snd_hda_get_default_vref() to guess the right value.
542  * Also, this function is only for analog pins, not for HDMI pins.
543  */
544 static inline int
545 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
546 {
547 	return _snd_hda_set_pin_ctl(codec, pin, val, false);
548 }
549 
550 /**
551  * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
552  * @codec: the codec instance
553  * @pin: the pin NID to set the control
554  * @val: the pin-control value (AC_PINCTL_* bits)
555  *
556  * Just like snd_hda_set_pin_ctl() but write to cache as well.
557  */
558 static inline int
559 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
560 			  unsigned int val)
561 {
562 	return _snd_hda_set_pin_ctl(codec, pin, val, true);
563 }
564 
565 int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
566 int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
567 				 unsigned int val);
568 
569 /*
570  * get widget capabilities
571  */
572 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
573 {
574 	if (nid < codec->start_nid ||
575 	    nid >= codec->start_nid + codec->num_nodes)
576 		return 0;
577 	return codec->wcaps[nid - codec->start_nid];
578 }
579 
580 /* get the widget type from widget capability bits */
581 static inline int get_wcaps_type(unsigned int wcaps)
582 {
583 	if (!wcaps)
584 		return -1; /* invalid type */
585 	return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
586 }
587 
588 static inline unsigned int get_wcaps_channels(u32 wcaps)
589 {
590 	unsigned int chans;
591 
592 	chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
593 	chans = ((chans << 1) | 1) + 1;
594 
595 	return chans;
596 }
597 
598 static inline void snd_hda_override_wcaps(struct hda_codec *codec,
599 					  hda_nid_t nid, u32 val)
600 {
601 	if (nid >= codec->start_nid &&
602 	    nid < codec->start_nid + codec->num_nodes)
603 		codec->wcaps[nid - codec->start_nid] = val;
604 }
605 
606 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
607 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
608 			      unsigned int caps);
609 u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
610 int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
611 			      unsigned int caps);
612 
613 /* flags for hda_nid_item */
614 #define HDA_NID_ITEM_AMP	(1<<0)
615 
616 struct hda_nid_item {
617 	struct snd_kcontrol *kctl;
618 	unsigned int index;
619 	hda_nid_t nid;
620 	unsigned short flags;
621 };
622 
623 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
624 		    struct snd_kcontrol *kctl);
625 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
626 		    unsigned int index, hda_nid_t nid);
627 void snd_hda_ctls_clear(struct hda_codec *codec);
628 
629 /*
630  * hwdep interface
631  */
632 #ifdef CONFIG_SND_HDA_HWDEP
633 int snd_hda_create_hwdep(struct hda_codec *codec);
634 #else
635 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
636 #endif
637 
638 void snd_hda_sysfs_init(struct hda_codec *codec);
639 void snd_hda_sysfs_clear(struct hda_codec *codec);
640 
641 extern const struct attribute_group *snd_hda_dev_attr_groups[];
642 
643 #ifdef CONFIG_SND_HDA_RECONFIG
644 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
645 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
646 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
647 #else
648 static inline
649 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
650 {
651 	return NULL;
652 }
653 
654 static inline
655 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
656 {
657 	return -ENOENT;
658 }
659 
660 static inline
661 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
662 {
663 	return -ENOENT;
664 }
665 #endif
666 
667 /*
668  * power-management
669  */
670 
671 void snd_hda_schedule_power_save(struct hda_codec *codec);
672 
673 struct hda_amp_list {
674 	hda_nid_t nid;
675 	unsigned char dir;
676 	unsigned char idx;
677 };
678 
679 struct hda_loopback_check {
680 	const struct hda_amp_list *amplist;
681 	int power_on;
682 };
683 
684 int snd_hda_check_amp_list_power(struct hda_codec *codec,
685 				 struct hda_loopback_check *check,
686 				 hda_nid_t nid);
687 
688 /* check whether the actual power state matches with the target state */
689 static inline bool
690 snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
691 			  unsigned int target_state)
692 {
693 	unsigned int state = snd_hda_codec_read(codec, nid, 0,
694 						AC_VERB_GET_POWER_STATE, 0);
695 	if (state & AC_PWRST_ERROR)
696 		return true;
697 	state = (state >> 4) & 0x0f;
698 	return (state == target_state);
699 }
700 
701 unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
702 					     hda_nid_t nid,
703 					     unsigned int power_state);
704 
705 /*
706  * AMP control callbacks
707  */
708 /* retrieve parameters from private_value */
709 #define get_amp_nid_(pv)	((pv) & 0xffff)
710 #define get_amp_nid(kc)		get_amp_nid_((kc)->private_value)
711 #define get_amp_channels(kc)	(((kc)->private_value >> 16) & 0x3)
712 #define get_amp_direction_(pv)	(((pv) >> 18) & 0x1)
713 #define get_amp_direction(kc)	get_amp_direction_((kc)->private_value)
714 #define get_amp_index_(pv)	(((pv) >> 19) & 0xf)
715 #define get_amp_index(kc)	get_amp_index_((kc)->private_value)
716 #define get_amp_offset(kc)	(((kc)->private_value >> 23) & 0x3f)
717 #define get_amp_min_mute(kc)	(((kc)->private_value >> 29) & 0x1)
718 
719 /*
720  * enum control helper
721  */
722 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
723 			     struct snd_ctl_elem_info *uinfo,
724 			     int num_entries, const char * const *texts);
725 #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
726 	snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
727 
728 /*
729  * CEA Short Audio Descriptor data
730  */
731 struct cea_sad {
732 	int	channels;
733 	int	format;		/* (format == 0) indicates invalid SAD */
734 	int	rates;
735 	int	sample_bits;	/* for LPCM */
736 	int	max_bitrate;	/* for AC3...ATRAC */
737 	int	profile;	/* for WMAPRO */
738 };
739 
740 #define ELD_FIXED_BYTES	20
741 #define ELD_MAX_SIZE    256
742 #define ELD_MAX_MNL	16
743 #define ELD_MAX_SAD	16
744 
745 /*
746  * ELD: EDID Like Data
747  */
748 struct parsed_hdmi_eld {
749 	/*
750 	 * all fields will be cleared before updating ELD
751 	 */
752 	int	baseline_len;
753 	int	eld_ver;
754 	int	cea_edid_ver;
755 	char	monitor_name[ELD_MAX_MNL + 1];
756 	int	manufacture_id;
757 	int	product_id;
758 	u64	port_id;
759 	int	support_hdcp;
760 	int	support_ai;
761 	int	conn_type;
762 	int	aud_synch_delay;
763 	int	spk_alloc;
764 	int	sad_count;
765 	struct cea_sad sad[ELD_MAX_SAD];
766 };
767 
768 struct hdmi_eld {
769 	bool	monitor_present;
770 	bool	eld_valid;
771 	int	eld_size;
772 	char    eld_buffer[ELD_MAX_SIZE];
773 	struct parsed_hdmi_eld info;
774 };
775 
776 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
777 int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
778 		     unsigned char *buf, int *eld_size);
779 int snd_hdmi_parse_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e,
780 		       const unsigned char *buf, int size);
781 void snd_hdmi_show_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e);
782 void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
783 			      struct hda_pcm_stream *hinfo);
784 
785 int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
786 			 unsigned char *buf, int *eld_size,
787 			 bool rev3_or_later);
788 
789 #ifdef CONFIG_PROC_FS
790 void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
791 			     struct snd_info_buffer *buffer);
792 void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
793 			     struct snd_info_buffer *buffer);
794 #endif
795 
796 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
797 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
798 
799 /*
800  */
801 #define codec_err(codec, fmt, args...) dev_err(&(codec)->dev, fmt, ##args)
802 #define codec_warn(codec, fmt, args...) dev_warn(&(codec)->dev, fmt, ##args)
803 #define codec_info(codec, fmt, args...) dev_info(&(codec)->dev, fmt, ##args)
804 #define codec_dbg(codec, fmt, args...) dev_dbg(&(codec)->dev, fmt, ##args)
805 
806 #endif /* __SOUND_HDA_LOCAL_H */
807