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