xref: /linux/sound/pci/hda/hda_local.h (revision 564eb714f5f09ac733c26860d5f0831f213fbdf1)
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_input_mux *imux, const char *label,
272 			  int index, int *type_index_ret);
273 
274 /*
275  * Channel mode helper
276  */
277 struct hda_channel_mode {
278 	int channels;
279 	const struct hda_verb *sequence;
280 };
281 
282 int snd_hda_ch_mode_info(struct hda_codec *codec,
283 			 struct snd_ctl_elem_info *uinfo,
284 			 const struct hda_channel_mode *chmode,
285 			 int num_chmodes);
286 int snd_hda_ch_mode_get(struct hda_codec *codec,
287 			struct snd_ctl_elem_value *ucontrol,
288 			const struct hda_channel_mode *chmode,
289 			int num_chmodes,
290 			int max_channels);
291 int snd_hda_ch_mode_put(struct hda_codec *codec,
292 			struct snd_ctl_elem_value *ucontrol,
293 			const struct hda_channel_mode *chmode,
294 			int num_chmodes,
295 			int *max_channelsp);
296 
297 /*
298  * Multi-channel / digital-out PCM helper
299  */
300 
301 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
302 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
303 
304 #define HDA_MAX_OUTS	5
305 
306 struct hda_multi_out {
307 	int num_dacs;		/* # of DACs, must be more than 1 */
308 	const hda_nid_t *dac_nids;	/* DAC list */
309 	hda_nid_t hp_nid;	/* optional DAC for HP, 0 when not exists */
310 	hda_nid_t hp_out_nid[HDA_MAX_OUTS];	/* DACs for multiple HPs */
311 	hda_nid_t extra_out_nid[HDA_MAX_OUTS];	/* other (e.g. speaker) DACs */
312 	hda_nid_t dig_out_nid;	/* digital out audio widget */
313 	const hda_nid_t *slave_dig_outs;
314 	int max_channels;	/* currently supported analog channels */
315 	int dig_out_used;	/* current usage of digital out (HDA_DIG_XXX) */
316 	int no_share_stream;	/* don't share a stream with multiple pins */
317 	int share_spdif;	/* share SPDIF pin */
318 	/* PCM information for both analog and SPDIF DACs */
319 	unsigned int analog_rates;
320 	unsigned int analog_maxbps;
321 	u64 analog_formats;
322 	unsigned int spdif_rates;
323 	unsigned int spdif_maxbps;
324 	u64 spdif_formats;
325 };
326 
327 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
328 				  struct hda_multi_out *mout);
329 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
330 			       struct hda_multi_out *mout);
331 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
332 				struct hda_multi_out *mout);
333 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
334 				  struct hda_multi_out *mout,
335 				  unsigned int stream_tag,
336 				  unsigned int format,
337 				  struct snd_pcm_substream *substream);
338 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
339 				  struct hda_multi_out *mout);
340 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
341 				  struct hda_multi_out *mout,
342 				  struct snd_pcm_substream *substream,
343 				  struct hda_pcm_stream *hinfo);
344 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
345 				     struct hda_multi_out *mout,
346 				     unsigned int stream_tag,
347 				     unsigned int format,
348 				     struct snd_pcm_substream *substream);
349 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
350 				     struct hda_multi_out *mout);
351 
352 /*
353  * generic codec parser
354  */
355 #ifdef CONFIG_SND_HDA_GENERIC
356 int snd_hda_parse_generic_codec(struct hda_codec *codec);
357 #else
358 static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
359 {
360 	return -ENODEV;
361 }
362 #endif
363 
364 /*
365  * generic proc interface
366  */
367 #ifdef CONFIG_PROC_FS
368 int snd_hda_codec_proc_new(struct hda_codec *codec);
369 #else
370 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
371 #endif
372 
373 #define SND_PRINT_BITS_ADVISED_BUFSIZE	16
374 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
375 
376 /*
377  * Misc
378  */
379 int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
380 			       const char * const *modelnames,
381 			       const struct snd_pci_quirk *pci_list);
382 int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
383                                int num_configs, const char * const *models,
384                                const struct snd_pci_quirk *tbl);
385 int snd_hda_add_new_ctls(struct hda_codec *codec,
386 			 const struct snd_kcontrol_new *knew);
387 
388 /*
389  * Fix-up pin default configurations and add default verbs
390  */
391 
392 struct hda_pintbl {
393 	hda_nid_t nid;
394 	u32 val;
395 };
396 
397 struct hda_model_fixup {
398 	const int id;
399 	const char *name;
400 };
401 
402 struct hda_fixup {
403 	int type;
404 	bool chained:1;		/* call the chained fixup(s) after this */
405 	bool chained_before:1;	/* call the chained fixup(s) before this */
406 	int chain_id;
407 	union {
408 		const struct hda_pintbl *pins;
409 		const struct hda_verb *verbs;
410 		void (*func)(struct hda_codec *codec,
411 			     const struct hda_fixup *fix,
412 			     int action);
413 	} v;
414 };
415 
416 /* fixup types */
417 enum {
418 	HDA_FIXUP_INVALID,
419 	HDA_FIXUP_PINS,
420 	HDA_FIXUP_VERBS,
421 	HDA_FIXUP_FUNC,
422 	HDA_FIXUP_PINCTLS,
423 };
424 
425 /* fixup action definitions */
426 enum {
427 	HDA_FIXUP_ACT_PRE_PROBE,
428 	HDA_FIXUP_ACT_PROBE,
429 	HDA_FIXUP_ACT_INIT,
430 	HDA_FIXUP_ACT_BUILD,
431 	HDA_FIXUP_ACT_FREE,
432 };
433 
434 int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
435 void snd_hda_apply_verbs(struct hda_codec *codec);
436 void snd_hda_apply_pincfgs(struct hda_codec *codec,
437 			   const struct hda_pintbl *cfg);
438 void snd_hda_apply_fixup(struct hda_codec *codec, int action);
439 void snd_hda_pick_fixup(struct hda_codec *codec,
440 			const struct hda_model_fixup *models,
441 			const struct snd_pci_quirk *quirk,
442 			const struct hda_fixup *fixlist);
443 
444 /*
445  * unsolicited event handler
446  */
447 
448 #define HDA_UNSOL_QUEUE_SIZE	64
449 
450 struct hda_bus_unsolicited {
451 	/* ring buffer */
452 	u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
453 	unsigned int rp, wp;
454 
455 	/* workqueue */
456 	struct work_struct work;
457 	struct hda_bus *bus;
458 };
459 
460 /* helper macros to retrieve pin default-config values */
461 #define get_defcfg_connect(cfg) \
462 	((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
463 #define get_defcfg_association(cfg) \
464 	((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
465 #define get_defcfg_location(cfg) \
466 	((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
467 #define get_defcfg_sequence(cfg) \
468 	(cfg & AC_DEFCFG_SEQUENCE)
469 #define get_defcfg_device(cfg) \
470 	((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
471 #define get_defcfg_misc(cfg) \
472 	((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
473 
474 /* amp values */
475 #define AMP_IN_MUTE(idx)	(0x7080 | ((idx)<<8))
476 #define AMP_IN_UNMUTE(idx)	(0x7000 | ((idx)<<8))
477 #define AMP_OUT_MUTE		0xb080
478 #define AMP_OUT_UNMUTE		0xb000
479 #define AMP_OUT_ZERO		0xb000
480 /* pinctl values */
481 #define PIN_IN			(AC_PINCTL_IN_EN)
482 #define PIN_VREFHIZ		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
483 #define PIN_VREF50		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
484 #define PIN_VREFGRD		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
485 #define PIN_VREF80		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
486 #define PIN_VREF100		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
487 #define PIN_OUT			(AC_PINCTL_OUT_EN)
488 #define PIN_HP			(AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
489 #define PIN_HP_AMP		(AC_PINCTL_HP_EN)
490 
491 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
492 unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
493 				     hda_nid_t pin, unsigned int val);
494 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
495 			 unsigned int val, bool cached);
496 
497 /**
498  * _snd_hda_set_pin_ctl - Set a pin-control value safely
499  * @codec: the codec instance
500  * @pin: the pin NID to set the control
501  * @val: the pin-control value (AC_PINCTL_* bits)
502  *
503  * This function sets the pin-control value to the given pin, but
504  * filters out the invalid pin-control bits when the pin has no such
505  * capabilities.  For example, when PIN_HP is passed but the pin has no
506  * HP-drive capability, the HP bit is omitted.
507  *
508  * The function doesn't check the input VREF capability bits, though.
509  * Use snd_hda_get_default_vref() to guess the right value.
510  * Also, this function is only for analog pins, not for HDMI pins.
511  */
512 static inline int
513 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
514 {
515 	return _snd_hda_set_pin_ctl(codec, pin, val, false);
516 }
517 
518 /**
519  * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
520  * @codec: the codec instance
521  * @pin: the pin NID to set the control
522  * @val: the pin-control value (AC_PINCTL_* bits)
523  *
524  * Just like snd_hda_set_pin_ctl() but write to cache as well.
525  */
526 static inline int
527 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
528 			  unsigned int val)
529 {
530 	return _snd_hda_set_pin_ctl(codec, pin, val, true);
531 }
532 
533 int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
534 int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
535 				 unsigned int val);
536 
537 /*
538  * get widget capabilities
539  */
540 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
541 {
542 	if (nid < codec->start_nid ||
543 	    nid >= codec->start_nid + codec->num_nodes)
544 		return 0;
545 	return codec->wcaps[nid - codec->start_nid];
546 }
547 
548 /* get the widget type from widget capability bits */
549 static inline int get_wcaps_type(unsigned int wcaps)
550 {
551 	if (!wcaps)
552 		return -1; /* invalid type */
553 	return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
554 }
555 
556 static inline unsigned int get_wcaps_channels(u32 wcaps)
557 {
558 	unsigned int chans;
559 
560 	chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
561 	chans = ((chans << 1) | 1) + 1;
562 
563 	return chans;
564 }
565 
566 static inline void snd_hda_override_wcaps(struct hda_codec *codec,
567 					  hda_nid_t nid, u32 val)
568 {
569 	if (nid >= codec->start_nid &&
570 	    nid < codec->start_nid + codec->num_nodes)
571 		codec->wcaps[nid - codec->start_nid] = val;
572 }
573 
574 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
575 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
576 			      unsigned int caps);
577 u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
578 int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
579 			      unsigned int caps);
580 
581 /* flags for hda_nid_item */
582 #define HDA_NID_ITEM_AMP	(1<<0)
583 
584 struct hda_nid_item {
585 	struct snd_kcontrol *kctl;
586 	unsigned int index;
587 	hda_nid_t nid;
588 	unsigned short flags;
589 };
590 
591 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
592 		    struct snd_kcontrol *kctl);
593 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
594 		    unsigned int index, hda_nid_t nid);
595 void snd_hda_ctls_clear(struct hda_codec *codec);
596 
597 /*
598  * hwdep interface
599  */
600 #ifdef CONFIG_SND_HDA_HWDEP
601 int snd_hda_create_hwdep(struct hda_codec *codec);
602 #else
603 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
604 #endif
605 
606 #if defined(CONFIG_PM) && defined(CONFIG_SND_HDA_HWDEP)
607 int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec);
608 #else
609 static inline int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec)
610 {
611 	return 0;
612 }
613 #endif
614 
615 #ifdef CONFIG_SND_HDA_RECONFIG
616 int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
617 #else
618 static inline int snd_hda_hwdep_add_sysfs(struct hda_codec *codec)
619 {
620 	return 0;
621 }
622 #endif
623 
624 #ifdef CONFIG_SND_HDA_RECONFIG
625 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
626 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
627 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
628 #else
629 static inline
630 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
631 {
632 	return NULL;
633 }
634 
635 static inline
636 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
637 {
638 	return -ENOENT;
639 }
640 
641 static inline
642 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
643 {
644 	return -ENOENT;
645 }
646 #endif
647 
648 /*
649  * power-management
650  */
651 
652 void snd_hda_schedule_power_save(struct hda_codec *codec);
653 
654 struct hda_amp_list {
655 	hda_nid_t nid;
656 	unsigned char dir;
657 	unsigned char idx;
658 };
659 
660 struct hda_loopback_check {
661 	const struct hda_amp_list *amplist;
662 	int power_on;
663 };
664 
665 int snd_hda_check_amp_list_power(struct hda_codec *codec,
666 				 struct hda_loopback_check *check,
667 				 hda_nid_t nid);
668 
669 /* check whether the actual power state matches with the target state */
670 static inline bool
671 snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
672 			  unsigned int target_state)
673 {
674 	unsigned int state = snd_hda_codec_read(codec, nid, 0,
675 						AC_VERB_GET_POWER_STATE, 0);
676 	if (state & AC_PWRST_ERROR)
677 		return true;
678 	state = (state >> 4) & 0x0f;
679 	return (state == target_state);
680 }
681 
682 unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
683 					     hda_nid_t nid,
684 					     unsigned int power_state);
685 
686 /*
687  * AMP control callbacks
688  */
689 /* retrieve parameters from private_value */
690 #define get_amp_nid_(pv)	((pv) & 0xffff)
691 #define get_amp_nid(kc)		get_amp_nid_((kc)->private_value)
692 #define get_amp_channels(kc)	(((kc)->private_value >> 16) & 0x3)
693 #define get_amp_direction_(pv)	(((pv) >> 18) & 0x1)
694 #define get_amp_direction(kc)	get_amp_direction_((kc)->private_value)
695 #define get_amp_index_(pv)	(((pv) >> 19) & 0xf)
696 #define get_amp_index(kc)	get_amp_index_((kc)->private_value)
697 #define get_amp_offset(kc)	(((kc)->private_value >> 23) & 0x3f)
698 #define get_amp_min_mute(kc)	(((kc)->private_value >> 29) & 0x1)
699 
700 /*
701  * enum control helper
702  */
703 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
704 			     struct snd_ctl_elem_info *uinfo,
705 			     int num_entries, const char * const *texts);
706 #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
707 	snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
708 
709 /*
710  * CEA Short Audio Descriptor data
711  */
712 struct cea_sad {
713 	int	channels;
714 	int	format;		/* (format == 0) indicates invalid SAD */
715 	int	rates;
716 	int	sample_bits;	/* for LPCM */
717 	int	max_bitrate;	/* for AC3...ATRAC */
718 	int	profile;	/* for WMAPRO */
719 };
720 
721 #define ELD_FIXED_BYTES	20
722 #define ELD_MAX_SIZE    256
723 #define ELD_MAX_MNL	16
724 #define ELD_MAX_SAD	16
725 
726 /*
727  * ELD: EDID Like Data
728  */
729 struct parsed_hdmi_eld {
730 	/*
731 	 * all fields will be cleared before updating ELD
732 	 */
733 	int	baseline_len;
734 	int	eld_ver;
735 	int	cea_edid_ver;
736 	char	monitor_name[ELD_MAX_MNL + 1];
737 	int	manufacture_id;
738 	int	product_id;
739 	u64	port_id;
740 	int	support_hdcp;
741 	int	support_ai;
742 	int	conn_type;
743 	int	aud_synch_delay;
744 	int	spk_alloc;
745 	int	sad_count;
746 	struct cea_sad sad[ELD_MAX_SAD];
747 };
748 
749 struct hdmi_eld {
750 	bool	monitor_present;
751 	bool	eld_valid;
752 	int	eld_size;
753 	char    eld_buffer[ELD_MAX_SIZE];
754 	struct parsed_hdmi_eld info;
755 };
756 
757 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
758 int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
759 		     unsigned char *buf, int *eld_size);
760 int snd_hdmi_parse_eld(struct parsed_hdmi_eld *e,
761 		       const unsigned char *buf, int size);
762 void snd_hdmi_show_eld(struct parsed_hdmi_eld *e);
763 void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
764 			      struct hda_pcm_stream *hinfo);
765 
766 int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
767 			 unsigned char *buf, int *eld_size,
768 			 bool rev3_or_later);
769 
770 #ifdef CONFIG_PROC_FS
771 void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
772 			     struct snd_info_buffer *buffer);
773 void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
774 			     struct snd_info_buffer *buffer);
775 #endif
776 
777 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
778 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
779 
780 #endif /* __SOUND_HDA_LOCAL_H */
781