xref: /openbmc/linux/sound/pci/hda/hda_local.h (revision d0b73b48)
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 #ifdef CONFIG_PM
137 void snd_hda_codec_resume_amp(struct hda_codec *codec);
138 #endif
139 
140 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
141 			     unsigned int *tlv);
142 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
143 					    const char *name);
144 int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
145 			  unsigned int *tlv, const char * const *slaves,
146 			  const char *suffix, bool init_slave_vol,
147 			  struct snd_kcontrol **ctl_ret);
148 #define snd_hda_add_vmaster(codec, name, tlv, slaves, suffix) \
149 	__snd_hda_add_vmaster(codec, name, tlv, slaves, suffix, true, NULL)
150 int snd_hda_codec_reset(struct hda_codec *codec);
151 
152 enum {
153 	HDA_VMUTE_OFF,
154 	HDA_VMUTE_ON,
155 	HDA_VMUTE_FOLLOW_MASTER,
156 };
157 
158 struct hda_vmaster_mute_hook {
159 	/* below two fields must be filled by the caller of
160 	 * snd_hda_add_vmaster_hook() beforehand
161 	 */
162 	struct snd_kcontrol *sw_kctl;
163 	void (*hook)(void *, int);
164 	/* below are initialized automatically */
165 	unsigned int mute_mode; /* HDA_VMUTE_XXX */
166 	struct hda_codec *codec;
167 };
168 
169 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
170 			     struct hda_vmaster_mute_hook *hook,
171 			     bool expose_enum_ctl);
172 void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
173 
174 /* amp value bits */
175 #define HDA_AMP_MUTE	0x80
176 #define HDA_AMP_UNMUTE	0x00
177 #define HDA_AMP_VOLMASK	0x7f
178 
179 /* mono switch binding multiple inputs */
180 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
181 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
182 	  .info = snd_hda_mixer_amp_switch_info, \
183 	  .get = snd_hda_mixer_bind_switch_get, \
184 	  .put = snd_hda_mixer_bind_switch_put, \
185 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
186 
187 /* stereo switch binding multiple inputs */
188 #define HDA_BIND_MUTE(xname,nid,indices,dir) \
189 	HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
190 
191 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
192 				  struct snd_ctl_elem_value *ucontrol);
193 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
194 				  struct snd_ctl_elem_value *ucontrol);
195 
196 /* more generic bound controls */
197 struct hda_ctl_ops {
198 	snd_kcontrol_info_t *info;
199 	snd_kcontrol_get_t *get;
200 	snd_kcontrol_put_t *put;
201 	snd_kcontrol_tlv_rw_t *tlv;
202 };
203 
204 extern struct hda_ctl_ops snd_hda_bind_vol;	/* for bind-volume with TLV */
205 extern struct hda_ctl_ops snd_hda_bind_sw;	/* for bind-switch */
206 
207 struct hda_bind_ctls {
208 	struct hda_ctl_ops *ops;
209 	unsigned long values[];
210 };
211 
212 int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
213 				 struct snd_ctl_elem_info *uinfo);
214 int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
215 				struct snd_ctl_elem_value *ucontrol);
216 int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
217 				struct snd_ctl_elem_value *ucontrol);
218 int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
219 			   unsigned int size, unsigned int __user *tlv);
220 
221 #define HDA_BIND_VOL(xname, bindrec) \
222 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
223 	  .name = xname, \
224 	  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
225 			  SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
226 			  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
227 	  .info = snd_hda_mixer_bind_ctls_info,\
228 	  .get =  snd_hda_mixer_bind_ctls_get,\
229 	  .put = snd_hda_mixer_bind_ctls_put,\
230 	  .tlv = { .c = snd_hda_mixer_bind_tlv },\
231 	  .private_value = (long) (bindrec) }
232 #define HDA_BIND_SW(xname, bindrec) \
233 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
234 	  .name = xname, \
235 	  .info = snd_hda_mixer_bind_ctls_info,\
236 	  .get =  snd_hda_mixer_bind_ctls_get,\
237 	  .put = snd_hda_mixer_bind_ctls_put,\
238 	  .private_value = (long) (bindrec) }
239 
240 /*
241  * SPDIF I/O
242  */
243 int snd_hda_create_dig_out_ctls(struct hda_codec *codec,
244 				hda_nid_t associated_nid,
245 				hda_nid_t cvt_nid, int type);
246 #define snd_hda_create_spdif_out_ctls(codec, anid, cnid) \
247 	snd_hda_create_dig_out_ctls(codec, anid, cnid, HDA_PCM_TYPE_SPDIF)
248 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
249 
250 /*
251  * input MUX helper
252  */
253 #define HDA_MAX_NUM_INPUTS	16
254 struct hda_input_mux_item {
255 	char label[32];
256 	unsigned int index;
257 };
258 struct hda_input_mux {
259 	unsigned int num_items;
260 	struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
261 };
262 
263 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
264 			   struct snd_ctl_elem_info *uinfo);
265 int snd_hda_input_mux_put(struct hda_codec *codec,
266 			  const struct hda_input_mux *imux,
267 			  struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
268 			  unsigned int *cur_val);
269 int snd_hda_add_imux_item(struct hda_input_mux *imux, const char *label,
270 			  int index, int *type_index_ret);
271 
272 /*
273  * Channel mode helper
274  */
275 struct hda_channel_mode {
276 	int channels;
277 	const struct hda_verb *sequence;
278 };
279 
280 int snd_hda_ch_mode_info(struct hda_codec *codec,
281 			 struct snd_ctl_elem_info *uinfo,
282 			 const struct hda_channel_mode *chmode,
283 			 int num_chmodes);
284 int snd_hda_ch_mode_get(struct hda_codec *codec,
285 			struct snd_ctl_elem_value *ucontrol,
286 			const struct hda_channel_mode *chmode,
287 			int num_chmodes,
288 			int max_channels);
289 int snd_hda_ch_mode_put(struct hda_codec *codec,
290 			struct snd_ctl_elem_value *ucontrol,
291 			const struct hda_channel_mode *chmode,
292 			int num_chmodes,
293 			int *max_channelsp);
294 
295 /*
296  * Multi-channel / digital-out PCM helper
297  */
298 
299 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
300 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
301 
302 #define HDA_MAX_OUTS	5
303 
304 struct hda_multi_out {
305 	int num_dacs;		/* # of DACs, must be more than 1 */
306 	const hda_nid_t *dac_nids;	/* DAC list */
307 	hda_nid_t hp_nid;	/* optional DAC for HP, 0 when not exists */
308 	hda_nid_t hp_out_nid[HDA_MAX_OUTS];	/* DACs for multiple HPs */
309 	hda_nid_t extra_out_nid[HDA_MAX_OUTS];	/* other (e.g. speaker) DACs */
310 	hda_nid_t dig_out_nid;	/* digital out audio widget */
311 	const hda_nid_t *slave_dig_outs;
312 	int max_channels;	/* currently supported analog channels */
313 	int dig_out_used;	/* current usage of digital out (HDA_DIG_XXX) */
314 	int no_share_stream;	/* don't share a stream with multiple pins */
315 	int share_spdif;	/* share SPDIF pin */
316 	/* PCM information for both analog and SPDIF DACs */
317 	unsigned int analog_rates;
318 	unsigned int analog_maxbps;
319 	u64 analog_formats;
320 	unsigned int spdif_rates;
321 	unsigned int spdif_maxbps;
322 	u64 spdif_formats;
323 };
324 
325 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
326 				  struct hda_multi_out *mout);
327 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
328 			       struct hda_multi_out *mout);
329 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
330 				struct hda_multi_out *mout);
331 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
332 				  struct hda_multi_out *mout,
333 				  unsigned int stream_tag,
334 				  unsigned int format,
335 				  struct snd_pcm_substream *substream);
336 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
337 				  struct hda_multi_out *mout);
338 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
339 				  struct hda_multi_out *mout,
340 				  struct snd_pcm_substream *substream,
341 				  struct hda_pcm_stream *hinfo);
342 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
343 				     struct hda_multi_out *mout,
344 				     unsigned int stream_tag,
345 				     unsigned int format,
346 				     struct snd_pcm_substream *substream);
347 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
348 				     struct hda_multi_out *mout);
349 
350 /*
351  * generic codec parser
352  */
353 #ifdef CONFIG_SND_HDA_GENERIC
354 int snd_hda_parse_generic_codec(struct hda_codec *codec);
355 #else
356 static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
357 {
358 	return -ENODEV;
359 }
360 #endif
361 
362 /*
363  * generic proc interface
364  */
365 #ifdef CONFIG_PROC_FS
366 int snd_hda_codec_proc_new(struct hda_codec *codec);
367 #else
368 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
369 #endif
370 
371 #define SND_PRINT_BITS_ADVISED_BUFSIZE	16
372 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
373 
374 /*
375  * Misc
376  */
377 int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
378 			       const char * const *modelnames,
379 			       const struct snd_pci_quirk *pci_list);
380 int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
381                                int num_configs, const char * const *models,
382                                const struct snd_pci_quirk *tbl);
383 int snd_hda_add_new_ctls(struct hda_codec *codec,
384 			 const struct snd_kcontrol_new *knew);
385 
386 /*
387  * unsolicited event handler
388  */
389 
390 #define HDA_UNSOL_QUEUE_SIZE	64
391 
392 struct hda_bus_unsolicited {
393 	/* ring buffer */
394 	u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
395 	unsigned int rp, wp;
396 
397 	/* workqueue */
398 	struct work_struct work;
399 	struct hda_bus *bus;
400 };
401 
402 /* helper macros to retrieve pin default-config values */
403 #define get_defcfg_connect(cfg) \
404 	((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
405 #define get_defcfg_association(cfg) \
406 	((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
407 #define get_defcfg_location(cfg) \
408 	((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
409 #define get_defcfg_sequence(cfg) \
410 	(cfg & AC_DEFCFG_SEQUENCE)
411 #define get_defcfg_device(cfg) \
412 	((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
413 #define get_defcfg_misc(cfg) \
414 	((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
415 
416 /* amp values */
417 #define AMP_IN_MUTE(idx)	(0x7080 | ((idx)<<8))
418 #define AMP_IN_UNMUTE(idx)	(0x7000 | ((idx)<<8))
419 #define AMP_OUT_MUTE		0xb080
420 #define AMP_OUT_UNMUTE		0xb000
421 #define AMP_OUT_ZERO		0xb000
422 /* pinctl values */
423 #define PIN_IN			(AC_PINCTL_IN_EN)
424 #define PIN_VREFHIZ		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
425 #define PIN_VREF50		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
426 #define PIN_VREFGRD		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
427 #define PIN_VREF80		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
428 #define PIN_VREF100		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
429 #define PIN_OUT			(AC_PINCTL_OUT_EN)
430 #define PIN_HP			(AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
431 #define PIN_HP_AMP		(AC_PINCTL_HP_EN)
432 
433 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
434 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
435 			 unsigned int val, bool cached);
436 
437 /**
438  * _snd_hda_set_pin_ctl - Set a pin-control value safely
439  * @codec: the codec instance
440  * @pin: the pin NID to set the control
441  * @val: the pin-control value (AC_PINCTL_* bits)
442  *
443  * This function sets the pin-control value to the given pin, but
444  * filters out the invalid pin-control bits when the pin has no such
445  * capabilities.  For example, when PIN_HP is passed but the pin has no
446  * HP-drive capability, the HP bit is omitted.
447  *
448  * The function doesn't check the input VREF capability bits, though.
449  * Use snd_hda_get_default_vref() to guess the right value.
450  * Also, this function is only for analog pins, not for HDMI pins.
451  */
452 static inline int
453 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
454 {
455 	return _snd_hda_set_pin_ctl(codec, pin, val, false);
456 }
457 
458 /**
459  * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
460  * @codec: the codec instance
461  * @pin: the pin NID to set the control
462  * @val: the pin-control value (AC_PINCTL_* bits)
463  *
464  * Just like snd_hda_set_pin_ctl() but write to cache as well.
465  */
466 static inline int
467 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
468 			  unsigned int val)
469 {
470 	return _snd_hda_set_pin_ctl(codec, pin, val, true);
471 }
472 
473 /*
474  * get widget capabilities
475  */
476 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
477 {
478 	if (nid < codec->start_nid ||
479 	    nid >= codec->start_nid + codec->num_nodes)
480 		return 0;
481 	return codec->wcaps[nid - codec->start_nid];
482 }
483 
484 /* get the widget type from widget capability bits */
485 static inline int get_wcaps_type(unsigned int wcaps)
486 {
487 	if (!wcaps)
488 		return -1; /* invalid type */
489 	return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
490 }
491 
492 static inline unsigned int get_wcaps_channels(u32 wcaps)
493 {
494 	unsigned int chans;
495 
496 	chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
497 	chans = ((chans << 1) | 1) + 1;
498 
499 	return chans;
500 }
501 
502 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
503 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
504 			      unsigned int caps);
505 u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
506 int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
507 			      unsigned int caps);
508 
509 /* flags for hda_nid_item */
510 #define HDA_NID_ITEM_AMP	(1<<0)
511 
512 struct hda_nid_item {
513 	struct snd_kcontrol *kctl;
514 	unsigned int index;
515 	hda_nid_t nid;
516 	unsigned short flags;
517 };
518 
519 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
520 		    struct snd_kcontrol *kctl);
521 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
522 		    unsigned int index, hda_nid_t nid);
523 void snd_hda_ctls_clear(struct hda_codec *codec);
524 
525 /*
526  * hwdep interface
527  */
528 #ifdef CONFIG_SND_HDA_HWDEP
529 int snd_hda_create_hwdep(struct hda_codec *codec);
530 #else
531 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
532 #endif
533 
534 #if defined(CONFIG_PM) && defined(CONFIG_SND_HDA_HWDEP)
535 int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec);
536 #else
537 static inline int snd_hda_hwdep_add_power_sysfs(struct hda_codec *codec)
538 {
539 	return 0;
540 }
541 #endif
542 
543 #ifdef CONFIG_SND_HDA_RECONFIG
544 int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
545 #else
546 static inline int snd_hda_hwdep_add_sysfs(struct hda_codec *codec)
547 {
548 	return 0;
549 }
550 #endif
551 
552 #ifdef CONFIG_SND_HDA_RECONFIG
553 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
554 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
555 #else
556 static inline
557 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
558 {
559 	return NULL;
560 }
561 
562 static inline
563 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
564 {
565 	return -ENOENT;
566 }
567 #endif
568 
569 /*
570  * power-management
571  */
572 
573 void snd_hda_schedule_power_save(struct hda_codec *codec);
574 
575 struct hda_amp_list {
576 	hda_nid_t nid;
577 	unsigned char dir;
578 	unsigned char idx;
579 };
580 
581 struct hda_loopback_check {
582 	const struct hda_amp_list *amplist;
583 	int power_on;
584 };
585 
586 int snd_hda_check_amp_list_power(struct hda_codec *codec,
587 				 struct hda_loopback_check *check,
588 				 hda_nid_t nid);
589 
590 /*
591  * AMP control callbacks
592  */
593 /* retrieve parameters from private_value */
594 #define get_amp_nid_(pv)	((pv) & 0xffff)
595 #define get_amp_nid(kc)		get_amp_nid_((kc)->private_value)
596 #define get_amp_channels(kc)	(((kc)->private_value >> 16) & 0x3)
597 #define get_amp_direction_(pv)	(((pv) >> 18) & 0x1)
598 #define get_amp_direction(kc)	get_amp_direction_((kc)->private_value)
599 #define get_amp_index(kc)	(((kc)->private_value >> 19) & 0xf)
600 #define get_amp_offset(kc)	(((kc)->private_value >> 23) & 0x3f)
601 #define get_amp_min_mute(kc)	(((kc)->private_value >> 29) & 0x1)
602 
603 /*
604  * enum control helper
605  */
606 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
607 			     struct snd_ctl_elem_info *uinfo,
608 			     int num_entries, const char * const *texts);
609 #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
610 	snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
611 
612 /*
613  * CEA Short Audio Descriptor data
614  */
615 struct cea_sad {
616 	int	channels;
617 	int	format;		/* (format == 0) indicates invalid SAD */
618 	int	rates;
619 	int	sample_bits;	/* for LPCM */
620 	int	max_bitrate;	/* for AC3...ATRAC */
621 	int	profile;	/* for WMAPRO */
622 };
623 
624 #define ELD_FIXED_BYTES	20
625 #define ELD_MAX_SIZE    256
626 #define ELD_MAX_MNL	16
627 #define ELD_MAX_SAD	16
628 
629 /*
630  * ELD: EDID Like Data
631  */
632 struct hdmi_eld {
633 	bool	monitor_present;
634 	bool	eld_valid;
635 	int	eld_size;
636 	int	baseline_len;
637 	int	eld_ver;
638 	int	cea_edid_ver;
639 	char	monitor_name[ELD_MAX_MNL + 1];
640 	int	manufacture_id;
641 	int	product_id;
642 	u64	port_id;
643 	int	support_hdcp;
644 	int	support_ai;
645 	int	conn_type;
646 	int	aud_synch_delay;
647 	int	spk_alloc;
648 	int	sad_count;
649 	struct cea_sad sad[ELD_MAX_SAD];
650 	/*
651 	 * all fields above eld_buffer will be cleared before updating ELD
652 	 */
653 	char    eld_buffer[ELD_MAX_SIZE];
654 #ifdef CONFIG_PROC_FS
655 	struct snd_info_entry *proc_entry;
656 #endif
657 };
658 
659 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
660 int snd_hdmi_get_eld(struct hdmi_eld *, struct hda_codec *, hda_nid_t);
661 void snd_hdmi_show_eld(struct hdmi_eld *eld);
662 void snd_hdmi_eld_update_pcm_info(struct hdmi_eld *eld,
663 			      struct hda_pcm_stream *hinfo);
664 
665 #ifdef CONFIG_PROC_FS
666 int snd_hda_eld_proc_new(struct hda_codec *codec, struct hdmi_eld *eld,
667 			 int index);
668 void snd_hda_eld_proc_free(struct hda_codec *codec, struct hdmi_eld *eld);
669 #else
670 static inline int snd_hda_eld_proc_new(struct hda_codec *codec,
671 				       struct hdmi_eld *eld,
672 				       int index)
673 {
674 	return 0;
675 }
676 static inline void snd_hda_eld_proc_free(struct hda_codec *codec,
677 					 struct hdmi_eld *eld)
678 {
679 }
680 #endif
681 
682 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
683 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
684 
685 #endif /* __SOUND_HDA_LOCAL_H */
686